VPCLattice / Client / list_resource_gateways

list_resource_gateways

VPCLattice.Client.list_resource_gateways(**kwargs)

Lists the resource gateways that you own or that were shared with you.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_gateways(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum page size.

  • nextToken (string) – If there are additional results, a pagination token for the next page of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • items (list) –

      Information about the resource gateways.

      • (dict) –

        Summary information about a resource gateway.

        • 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 name of the resource gateway.

        • vpcIdentifier (string) –

          The ID of the VPC for the resource gateway.

        • subnetIds (list) –

          The IDs of the VPC subnets for the resource gateway.

          • (string) –

        • securityGroupIds (list) –

          The IDs of the security groups applied to the resource gateway.

          • (string) –

        • ipAddressType (string) –

          The type of IP address used by 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 VPC endpoint association was created, in ISO-8601 format.

        • lastUpdatedAt (datetime) –

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

    • nextToken (string) –

      If there are additional results, a pagination token for the next page of results.

Exceptions