Skip to content

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer

Description

Describes the specified listeners or the listeners for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load balancer or one or more listeners.

Usage

elbv2_describe_listeners(LoadBalancerArn, ListenerArns, Marker,
  PageSize)

Arguments

  • LoadBalancerArn

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

  • ListenerArns

    The Amazon Resource Names (ARN) of the listeners.

  • 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(
  Listeners = list(
    list(
      ListenerArn = "string",
      LoadBalancerArn = "string",
      Port = 123,
      Protocol = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|"GENEVE"|"QUIC"|"TCP_QUIC",
      Certificates = list(
        list(
          CertificateArn = "string",
          IsDefault = TRUE|FALSE
        )
      ),
      SslPolicy = "string",
      DefaultActions = list(
        list(
          Type = "forward"|"authenticate-oidc"|"authenticate-cognito"|"redirect"|"fixed-response"|"jwt-validation",
          TargetGroupArn = "string",
          AuthenticateOidcConfig = list(
            Issuer = "string",
            AuthorizationEndpoint = "string",
            TokenEndpoint = "string",
            UserInfoEndpoint = "string",
            ClientId = "string",
            ClientSecret = "string",
            SessionCookieName = "string",
            Scope = "string",
            SessionTimeout = 123,
            AuthenticationRequestExtraParams = list(
              "string"
            ),
            OnUnauthenticatedRequest = "deny"|"allow"|"authenticate",
            UseExistingClientSecret = TRUE|FALSE
          ),
          AuthenticateCognitoConfig = list(
            UserPoolArn = "string",
            UserPoolClientId = "string",
            UserPoolDomain = "string",
            SessionCookieName = "string",
            Scope = "string",
            SessionTimeout = 123,
            AuthenticationRequestExtraParams = list(
              "string"
            ),
            OnUnauthenticatedRequest = "deny"|"allow"|"authenticate"
          ),
          Order = 123,
          RedirectConfig = list(
            Protocol = "string",
            Port = "string",
            Host = "string",
            Path = "string",
            Query = "string",
            StatusCode = "HTTP_301"|"HTTP_302"
          ),
          FixedResponseConfig = list(
            MessageBody = "string",
            StatusCode = "string",
            ContentType = "string"
          ),
          ForwardConfig = list(
            TargetGroups = list(
              list(
                TargetGroupArn = "string",
                Weight = 123
              )
            ),
            TargetGroupStickinessConfig = list(
              Enabled = TRUE|FALSE,
              DurationSeconds = 123
            )
          ),
          JwtValidationConfig = list(
            JwksEndpoint = "string",
            Issuer = "string",
            AdditionalClaims = list(
              list(
                Format = "single-string"|"string-array"|"space-separated-values",
                Name = "string",
                Values = list(
                  "string"
                )
              )
            )
          )
        )
      ),
      AlpnPolicy = list(
        "string"
      ),
      MutualAuthentication = list(
        Mode = "string",
        TrustStoreArn = "string",
        IgnoreClientCertificateExpiry = TRUE|FALSE,
        TrustStoreAssociationStatus = "active"|"removed",
        AdvertiseTrustStoreCaNames = "on"|"off"
      )
    )
  ),
  NextMarker = "string"
)

Request syntax

svc$describe_listeners(
  LoadBalancerArn = "string",
  ListenerArns = list(
    "string"
  ),
  Marker = "string",
  PageSize = 123
)

Examples

# This example describes the specified listener.
svc$describe_listeners(
  ListenerArns = list(
    "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-lo..."
  )
)