RTBFabric / Client / get_responder_gateway

get_responder_gateway

RTBFabric.Client.get_responder_gateway(**kwargs)

Retrieves information about a responder gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_responder_gateway(
    gatewayId='string'
)
Parameters:

gatewayId (string) –

[REQUIRED]

The unique identifier of the gateway.

Return type:

dict

Returns:

Response Syntax

{
    'vpcId': 'string',
    'subnetIds': [
        'string',
    ],
    'securityGroupIds': [
        'string',
    ],
    'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'domainName': 'string',
    'port': 123,
    'protocol': 'HTTP'|'HTTPS',
    'listenerConfig': {
        'protocols': [
            'HTTP'|'HTTPS',
        ]
    },
    'trustStoreConfiguration': {
        'certificateAuthorityCertificates': [
            'string',
        ]
    },
    'managedEndpointConfiguration': {
        'autoScalingGroups': {
            'autoScalingGroupNames': [
                'string',
            ],
            'roleArn': 'string',
            'healthCheckConfig': {
                'port': 123,
                'path': 'string',
                'protocol': 'HTTP'|'HTTPS',
                'timeoutMs': 123,
                'intervalSeconds': 123,
                'statusCodeMatcher': 'string',
                'healthyThresholdCount': 123,
                'unhealthyThresholdCount': 123
            }
        },
        'eksEndpoints': {
            'endpointsResourceName': 'string',
            'endpointsResourceNamespace': 'string',
            'clusterApiServerEndpointUri': 'string',
            'clusterApiServerCaCertificateChain': 'string',
            'clusterName': 'string',
            'roleArn': 'string'
        }
    },
    'gatewayId': 'string',
    'tags': {
        'string': 'string'
    },
    'activeLinksCount': 123,
    'totalLinksCount': 123,
    'linksRequestedCount': 123,
    'gatewayType': 'EXTERNAL'|'INTERNAL',
    'externalInboundEndpoint': 'string',
    'clientRoutingPolicy': 'AVAILABILITY_ZONE_AFFINITY'|'ANY_AVAILABILITY_ZONE'
}

Response Structure

  • (dict) –

    • vpcId (string) –

      The unique identifier of the Virtual Private Cloud (VPC).

    • subnetIds (list) –

      The unique identifiers of the subnets.

      • (string) –

    • securityGroupIds (list) –

      The unique identifiers of the security groups.

      • (string) –

    • status (string) –

      The status of the request.

    • description (string) –

      The description of the responder gateway.

    • createdAt (datetime) –

      The timestamp of when the responder gateway was created.

    • updatedAt (datetime) –

      The timestamp of when the responder gateway was updated.

    • domainName (string) –

      The domain name of the responder gateway.

    • port (integer) –

      The networking port.

    • protocol (string) –

      The networking protocol.

    • listenerConfig (dict) –

      The listener configuration for the responder gateway.

      • protocols (list) –

        The protocol for connections from clients to the gateway

        • (string) –

    • trustStoreConfiguration (dict) –

      The configuration of the trust store.

      • certificateAuthorityCertificates (list) –

        The certificate authority certificate.

        • (string) –

    • managedEndpointConfiguration (dict) –

      The configuration of the managed endpoint.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: autoScalingGroups, eksEndpoints. 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'}

      • autoScalingGroups (dict) –

        Describes the configuration of an auto scaling group.

        • autoScalingGroupNames (list) –

          The names of the auto scaling group.

          • (string) –

        • roleArn (string) –

          The role ARN of the auto scaling group.

        • healthCheckConfig (dict) –

          The health check configuration for the Auto Scaling group managed endpoint.

          • port (integer) –

            The port to use for health check probes. Valid range is 80 to 65535.

          • path (string) –

            The destination path for the health check request. Must start with /.

          • protocol (string) –

            The protocol to use for health check probes.

          • timeoutMs (integer) –

            The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.

          • intervalSeconds (integer) –

            The interval between health check probes, in seconds. Valid range is 5 to 60.

          • statusCodeMatcher (string) –

            The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).

          • healthyThresholdCount (integer) –

            The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.

          • unhealthyThresholdCount (integer) –

            The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.

      • eksEndpoints (dict) –

        Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.

        • endpointsResourceName (string) –

          The name of the endpoint resource.

        • endpointsResourceNamespace (string) –

          The namespace of the endpoint resource.

        • clusterApiServerEndpointUri (string) –

          The URI of the cluster API server endpoint.

        • clusterApiServerCaCertificateChain (string) –

          The CA certificate chain of the cluster API server.

        • clusterName (string) –

          The name of the cluster.

        • roleArn (string) –

          The role ARN for the cluster.

    • gatewayId (string) –

      The unique identifier of the gateway.

    • tags (dict) –

      A map of the key-value pairs for the tag or tags assigned to the specified resource.

      • (string) –

        • (string) –

    • activeLinksCount (integer) –

      The count of active links for the responder gateway.

    • totalLinksCount (integer) –

      The total count of links for the responder gateway.

    • linksRequestedCount (integer) –

      The count of requested links waiting for the responder gateway to accept or reject.

    • gatewayType (string) –

      The type of gateway. Valid values are EXTERNAL or INTERNAL.

    • externalInboundEndpoint (string) –

      The external inbound endpoint for the responder gateway.

    • clientRoutingPolicy (string) –

      The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. RTB Fabric omits this member if the gateway has never had a client routing policy. An omitted value means that the gateway uses AVAILABILITY_ZONE_AFFINITY. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.

Exceptions