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',
    'trustStoreConfiguration': {
        'certificateAuthorityCertificates': [
            'string',
        ]
    },
    'managedEndpointConfiguration': {
        'autoScalingGroups': {
            'autoScalingGroupNames': [
                'string',
            ],
            'roleArn': 'string'
        },
        'eksEndpoints': {
            'endpointsResourceName': 'string',
            'endpointsResourceNamespace': 'string',
            'clusterApiServerEndpointUri': 'string',
            'clusterApiServerCaCertificateChain': 'string',
            'clusterName': 'string',
            'roleArn': 'string'
        }
    },
    'gatewayId': 'string',
    'tags': {
        'string': 'string'
    },
    'activeLinksCount': 123,
    'totalLinksCount': 123,
    'inboundLinksCount': 123
}

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.

  • 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.

    • 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.

  • inboundLinksCount (integer) –

    The count of inbound links for the responder gateway.

Exceptions

• RTBFabric.Client.exceptions.ResourceNotFoundException

• RTBFabric.Client.exceptions.ThrottlingException

• RTBFabric.Client.exceptions.AccessDeniedException

• RTBFabric.Client.exceptions.InternalServerException

• RTBFabric.Client.exceptions.ValidationException