ApiGatewayV2 / Client / update_api_mapping

update_api_mapping#

ApiGatewayV2.Client.update_api_mapping(**kwargs)#

The API mapping.

See also: AWS API Documentation

Request Syntax

response = client.update_api_mapping(
    ApiId='string',
    ApiMappingId='string',
    ApiMappingKey='string',
    DomainName='string',
    Stage='string'
)
Parameters:

  • ApiId (string) –

    [REQUIRED]

    The API identifier.

  • ApiMappingId (string) –

    [REQUIRED]

    The API mapping identifier.

  • ApiMappingKey (string) – The API mapping key.

  • DomainName (string) –

    [REQUIRED]

    The domain name.

  • Stage (string) – The API stage.

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

  • ApiGatewayV2.Client.exceptions.ConflictException