ECS / Client / describe_gateway

describe_gateway¶

ECS.Client.describe_gateway(**kwargs)¶

Describes a gateway, including its configuration, status, and the type-specific infrastructure settings that it uses.

Request Syntax

response = client.describe_gateway(
    gateway='string'
)

Parameters:

gateway (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'gateway': {
        'gatewayArn': 'string',
        'name': 'string',
        'status': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETED',
        'statusReason': 'string',
        'failures': [
            {
                'arn': 'string',
                'errors': [
                    {
                        'operation': 'string',
                        'code': 'string',
                        'message': 'string'
                    },
                ]
            },
        ],
        'infrastructureRoleArn': 'string',
        'deletionProtection': True|False,
        'configuration': {
            'hostSharedAlb': {
                'networkConfiguration': {
                    'inboundSecurityGroup': 'string',
                    'subnets': [
                        'string',
                    ],
                    'ipAddressType': 'ipv4'|'dualstack'|'dualstack-without-public-ipv4'
                },
                'scheme': 'internet-facing'|'internal',
                'accessLogs': {
                    'destination': {
                        's3': {
                            'bucket': 'string',
                            'prefix': 'string'
                        }
                    }
                },
                'webACLArn': 'string',
                'port': 123,
                'protocol': 'HTTP'|'HTTPS',
                'maxAlbCount': 123,
                'currentAlbCount': 123,
                'httpDesync': 'monitor'|'defensive'|'strictest',
                'testTrafficRules': {
                    'header': {
                        'name': 'string',
                        'values': [
                            'string',
                        ]
                    }
                }
            }
        },
        'accessType': 'PUBLIC'|'PRIVATE',
        'propagateTags': 'NONE'|'GATEWAY',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- gateway (dict) –
  
  The details of the gateway.
  - gatewayArn (string) –
    
    The Amazon Resource Name (ARN) of the gateway.
  - name (string) –
    
    The name of the gateway.
  - status (string) –
    
    The status of the gateway.
  - statusReason (string) –
    
    A human-readable explanation of the current status. This value is populated when the gateway is in a failure state, such as UPDATE_FAILED.
  - failures (list) –
    
    The per-resource failure details for asynchronous gateway processes, such as an UpdateGateway operation that couldn’t update every load balancer.
    - (dict) –
      
      The failures for a single resource that was touched by an asynchronous gateway process.
      - arn (string) –
        
        The Amazon Resource Name (ARN) of the resource that failed to update, such as a load balancer ARN.
      - errors (list) –
        
        The errors that were encountered while operating on the resource.
        
        (dict) –
        
        A single failed operation against a resource that a gateway manages.
        
        operation (string) –
        
        The IAM-style action identifier of the operation that failed, such as elasticloadbalancing:ModifyLoadBalancerAttributes.
        
        code (string) –
        
        The error code returned by the failed operation, passed through from the downstream service, such as AccessDenied.
        
        message (string) –
        
        The detailed error message.
  - infrastructureRoleArn (string) –
    
    The Amazon Resource Name (ARN) of the IAM role that the gateway uses to manage infrastructure on your behalf.
  - deletionProtection (boolean) –
    
    Specifies whether deletion protection is enabled for the gateway.
  - configuration (dict) –
    
    The type-specific configuration for the gateway.
    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 (dict) –
      
      The configuration for a host-based, shared Application Load Balancer gateway.
      - networkConfiguration (dict) –
        
        The network configuration for the load balancers that the gateway manages.
        
        inboundSecurityGroup (string) –
        
        The ID of a security group that you provide to control inbound traffic to the load balancers that the gateway manages. When you specify a security group, the gateway doesn’t create inbound rules on the security group it manages.
        
        subnets (list) –
        
        The subnets for the load balancers that the gateway manages. The default is the subnets in the default VPC.
        
        (string) –
        
        ipAddressType (string) –
        
        The IP address type for the load balancers that the gateway manages. The default is dualstack.
      - scheme (string) –
        
        Specifies whether the load balancers the gateway manages are internet-facing or internal.
      - accessLogs (dict) –
        
        The access log configuration for the load balancers that the gateway manages.
        
        destination (dict) –
        
        The destination where access logs are delivered.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: s3. 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'}
        
        s3 (dict) –
        
        The Amazon S3 destination for access logs.
        
        bucket (string) –
        
        The name of the Amazon S3 bucket where access logs are delivered.
        
        prefix (string) –
        
        The object key prefix for the access logs in the Amazon S3 bucket.
      - webACLArn (string) –
        
        The Amazon Resource Name (ARN) of the WAF web ACL associated with the load balancers that the gateway manages.
      - port (integer) –
        
        The port that the load balancer listener uses is 443. The gateway supports only HTTPS at port 443.
      - protocol (string) –
        
        The protocol for the load balancer listener is HTTPS. No other protocol is supported.
      - maxAlbCount (integer) –
        
        The maximum number of Application Load Balancers that the gateway manages.
      - currentAlbCount (integer) –
        
        The current number of Application Load Balancers that the gateway has allocated.
      - httpDesync (string) –
        
        The desync mitigation mode for the load balancers that the gateway manages.
      - testTrafficRules (dict) –
        
        The rules that route test traffic for progressive deployments.
        
        header (dict) –
        
        The header-based rule that identifies test traffic.
        
        name (string) –
        
        The name of the header to match for test traffic routing.
        
        values (list) –
        
        The header values to match for test traffic routing.
        
        (string) –
  - accessType (string) –
    
    Specifies whether the gateway is publicly accessible ( PUBLIC) or private ( PRIVATE). The gateway derives this value from its scheme when you create the gateway, and the value is immutable.
  - propagateTags (string) –
    
    Specifies whether the gateway propagates its tags to the infrastructure it manages.
  - tags (list) –
    
    The metadata applied to the gateway. Each tag consists of a key and an optional value.
    - (dict) –
      
      The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.
      
      The following basic restrictions apply to tags:
      - Maximum number of tags per resource - 50
      - For each resource, each tag key must be unique, and each tag key can have only one value.
      - Maximum key length - 128 Unicode characters in UTF-8
      - Maximum value length - 256 Unicode characters in UTF-8
      - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
      - Tag keys and values are case-sensitive.
      - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
      - key (string) –
        
        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
      - value (string) –
        
        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
  - createdAt (datetime) –
    
    The Unix timestamp for the time when the gateway was created.
  - updatedAt (datetime) –
    
    The Unix timestamp for the time when the gateway was last updated.