Describe Target Groups

elbv2_describe_target_groups

R Documentation

Describes the specified target groups or all of your target groups

Description

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

Usage

elbv2_describe_target_groups(LoadBalancerArn, TargetGroupArns, Names,
  Marker, PageSize)

Arguments

LoadBalancerArn

The Amazon Resource Name (ARN) of the load balancer.

TargetGroupArns

The Amazon Resource Names (ARN) of the target groups.

Names

The names of the target groups.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

PageSize

The maximum number of results to return with this call.

Value

A list with the following syntax:

list(
  TargetGroups = list(
    list(
      TargetGroupArn = "string",
      TargetGroupName = "string",
      Protocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
      Port = 123,
      VpcId = "string",
      HealthCheckProtocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE",
      HealthCheckPort = "string",
      HealthCheckEnabled = TRUE|FALSE,
      HealthCheckIntervalSeconds = 123,
      HealthCheckTimeoutSeconds = 123,
      HealthyThresholdCount = 123,
      UnhealthyThresholdCount = 123,
      HealthCheckPath = "string",
      Matcher = list(
        HttpCode = "string",
        GrpcCode = "string"
      ),
      LoadBalancerArns = list(
        "string"
      ),
      TargetType = "instance"|"ip"|"lambda"|"alb",
      ProtocolVersion = "string",
      IpAddressType = "ipv4"|"ipv6"
    )
  ),
  NextMarker = "string"
)

Request syntax

svc$describe_target_groups(
  LoadBalancerArn = "string",
  TargetGroupArns = list(
    "string"
  ),
  Names = list(
    "string"
  ),
  Marker = "string",
  PageSize = 123
)

Examples

## Not run: 
# This example describes the specified target group.
svc$describe_target_groups(
  TargetGroupArns = list(
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tar..."
  )
)

## End(Not run)