ApiGatewayV2 / Client / get_api_mappings

get_api_mappings#

ApiGatewayV2.Client.get_api_mappings(**kwargs)#

Gets API mappings.

See also: AWS API Documentation

Request Syntax

response = client.get_api_mappings(
    DomainName='string',
    MaxResults='string',
    NextToken='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The domain name.

  • MaxResults (string) – The maximum number of elements to be returned for this resource.

  • NextToken (string) – The next page of elements from this collection. Not valid for the last element of the collection.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ApiId': 'string',
            'ApiMappingId': 'string',
            'ApiMappingKey': 'string',
            'Stage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Success

    • Items (list) –

      The elements from this collection.

      • (dict) –

        Represents an API mapping.

        • ApiId (string) –

          The API identifier.

        • ApiMappingId (string) –

          The API mapping identifier.

        • ApiMappingKey (string) –

          The API mapping key.

        • Stage (string) –

          The API stage.

    • NextToken (string) –

      The next page of elements from this collection. Not valid for the last element of the collection.

Exceptions