ECS / Client / describe_gateway_resources

describe_gateway_resources

ECS.Client.describe_gateway_resources(**kwargs)

Returns the infrastructure that a gateway has created and manages, so that you can follow the traffic path from top-level shared resources, such as load balancers, to the service-specific resources represented as gateway routes. Responses include only the Amazon Resource Names (ARNs) of gateway-managed infrastructure. For the current state of a resource, describe it with the corresponding Amazon Web Services service (Elastic Load Balancing, Amazon EC2, or Amazon Web Services Certificate Manager). The results are paginated.

See also: AWS API Documentation

Request Syntax

response = client.describe_gateway_resources(
    gateway='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • gateway (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the gateway.

  • maxResults (integer) – The maximum number of results that the operation returns in a single page. The maximum value is 20 and the default is 10.

  • nextToken (string) – The nextToken value returned from a previous paginated request.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayResources': {
        'gatewayArn': 'string',
        'resources': {
            'hostSharedAlb': [
                {
                    'loadBalancerArn': 'string',
                    'listenerArn': 'string',
                    'securityGroup': 'string',
                    'gatewayRouteArns': [
                        'string',
                    ]
                },
            ]
        }
    },
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • gatewayResources (dict) –

      The infrastructure resources that the gateway manages, grouped by gateway type.

      • gatewayArn (string) –

        The Amazon Resource Name (ARN) of the gateway.

      • resources (dict) –

        The infrastructure resources that the gateway manages.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: hostSharedAlb. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • hostSharedAlb (list) –

          The Application Load Balancer resource groups for a host-based, shared ALB gateway.

          • (dict) –

            An Application Load Balancer and its associated resources that a gateway manages.

            • loadBalancerArn (string) –

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

            • listenerArn (string) –

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

            • securityGroup (string) –

              The ID of the security group attached to the load balancer.

            • gatewayRouteArns (list) –

              The Amazon Resource Names (ARNs) of the gateway routes that use this load balancer for ingress.

              • (string) –

    • nextToken (string) –

      The nextToken value to include in a future request to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions