RTBFabric / Client / get_requester_gateway

get_requester_gateway

RTBFabric.Client.get_requester_gateway(**kwargs)

Retrieves information about a requester gateway.

See also: AWS API Documentation

Request Syntax

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

gatewayId (string) –

[REQUIRED]

The unique identifier of the gateway.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'PENDING_CREATION'|'ACTIVE'|'PENDING_DELETION'|'DELETED'|'ERROR'|'PENDING_UPDATE'|'ISOLATED'|'PENDING_ISOLATION'|'PENDING_RESTORATION',
    'domainName': 'string',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'vpcId': 'string',
    'subnetIds': [
        'string',
    ],
    'securityGroupIds': [
        'string',
    ],
    'gatewayId': 'string',
    'tags': {
        'string': 'string'
    },
    'activeLinksCount': 123,
    'totalLinksCount': 123
}

Response Structure

  • (dict) –

    • status (string) –

      The status of the request.

    • domainName (string) –

      The domain name of the requester gateway.

    • description (string) –

      The description of the requester gateway.

    • createdAt (datetime) –

      The timestamp of when the requester gateway was created.

    • updatedAt (datetime) –

      The timestamp of when the requester gateway was updated.

    • 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) –

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

    • totalLinksCount (integer) –

      The total count of links for the requester gateway.

Exceptions