VPCLattice / Client / get_resource_gateway

get_resource_gateway

VPCLattice.Client.get_resource_gateway(**kwargs)

Retrieves information about the specified resource gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_gateway(
    resourceGatewayIdentifier='string'
)
Parameters:

resourceGatewayIdentifier (string) –

[REQUIRED]

The ID of the resource gateway.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'id': 'string',
    'arn': 'string',
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'vpcId': 'string',
    'subnetIds': [
        'string',
    ],
    'securityGroupIds': [
        'string',
    ],
    'ipAddressType': 'IPV4'|'IPV6'|'DUALSTACK',
    'ipv4AddressesPerEni': 123,
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the resource gateway.

    • id (string) –

      The ID of the resource gateway.

    • arn (string) –

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

    • status (string) –

      The status for the resource gateway.

    • vpcId (string) –

      The ID of the VPC for the resource gateway.

    • subnetIds (list) –

      The IDs of the VPC subnets for resource gateway.

      • (string) –

    • securityGroupIds (list) –

      The security group IDs associated with the resource gateway.

      • (string) –

    • ipAddressType (string) –

      The type of IP address for the resource gateway.

    • ipv4AddressesPerEni (integer) –

      The number of IPv4 addresses in each ENI for the resource gateway.

    • createdAt (datetime) –

      The date and time that the resource gateway was created, in ISO-8601 format.

    • lastUpdatedAt (datetime) –

      The date and time that the resource gateway was last updated, in ISO-8601 format.

Exceptions