ECS / Client / describe_gateway_route

describe_gateway_route

ECS.Client.describe_gateway_route(**kwargs)

Describes a gateway route, including its status, the service it routes traffic to, and the service-specific infrastructure, such as target groups and listener rules, that the gateway manages for it.

See also: AWS API Documentation

Request Syntax

response = client.describe_gateway_route(
    gatewayRouteArn='string'
)
Parameters:

gatewayRouteArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway route to describe.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayRoute': {
        'gatewayRouteArn': 'string',
        'serviceArn': 'string',
        'serviceContainerPortName': 'string',
        'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
        'serviceUrl': 'string',
        'resources': {
            'hostSharedAlb': [
                {
                    'acmCertificateArn': 'string',
                    'loadBalancerArn': 'string',
                    'listenerArn': 'string',
                    'listenerRuleArn': 'string',
                    'testListenerRuleArns': [
                        'string',
                    ],
                    'loadBalancerSecurityGroups': [
                        {
                            'arn': 'string',
                            'ruleArns': [
                                'string',
                            ]
                        },
                    ],
                    'serviceSecurityGroupArn': 'string'
                },
            ]
        }
    }
}

Response Structure

  • (dict) –

    • gatewayRoute (dict) –

      The details of the gateway route.

      • gatewayRouteArn (string) –

        The Amazon Resource Name (ARN) of the gateway route.

      • serviceArn (string) –

        The Amazon Resource Name (ARN) of the service associated with the route.

      • serviceContainerPortName (string) –

        The task definition container port name that the route targets on the service.

      • status (string) –

        The status of the gateway route.

      • serviceUrl (string) –

        The URL for accessing the service, including the https:// scheme.

      • resources (dict) –

        The service-specific infrastructure that the gateway manages for the route, keyed by gateway type.

        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 resources for a host-based, shared ALB gateway.

          • (dict) –

            The Application Load Balancer resources that a gateway manages for a route.

            • acmCertificateArn (string) –

              The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager certificate.

            • loadBalancerArn (string) –

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

            • listenerArn (string) –

              The Amazon Resource Name (ARN) of the listener.

            • listenerRuleArn (string) –

              The Amazon Resource Name (ARN) of the listener rule for production traffic.

            • testListenerRuleArns (list) –

              The Amazon Resource Names (ARNs) of the listener rules for test traffic. There is one rule except when a test header configuration is being changed to another.

              • (string) –

            • loadBalancerSecurityGroups (list) –

              The security groups attached to the load balancer.

              • (dict) –

                A security group attached to the load balancer for a gateway route.

                • arn (string) –

                  The Amazon Resource Name (ARN) of the security group.

                • ruleArns (list) –

                  The Amazon Resource Names (ARNs) of the security group rules.

                  • (string) –

            • serviceSecurityGroupArn (string) –

              The Amazon Resource Name (ARN) of the service security group in which the gateway manages the ingress rule for this route.

Exceptions