ApiGatewayV2 / Client / get_api_mapping

get_api_mapping

ApiGatewayV2.Client.get_api_mapping(**kwargs)

Gets an API mapping.

See also: AWS API Documentation

Request Syntax

response = client.get_api_mapping(
    ApiMappingId='string',
    DomainName='string'
)

Parameters:

• ApiMappingId (string) –

  [REQUIRED]

  The API mapping identifier.

• DomainName (string) –

  [REQUIRED]

  The domain name.

Return type:

dict

Returns:

Response Syntax

{
    'ApiId': 'string',
    'ApiMappingId': 'string',
    'ApiMappingKey': 'string',
    'Stage': 'string'
}

Response Structure

• (dict) –

  Success

  • ApiId (string) –

    The API identifier.

  • ApiMappingId (string) –

    The API mapping identifier.

  • ApiMappingKey (string) –

    The API mapping key.

  • Stage (string) –

    The API stage.

Exceptions

• ApiGatewayV2.Client.exceptions.NotFoundException

• ApiGatewayV2.Client.exceptions.TooManyRequestsException

• ApiGatewayV2.Client.exceptions.BadRequestException