ApiGatewayV2 / Client / create_api_mapping

create_api_mapping¶

ApiGatewayV2.Client.create_api_mapping(**kwargs)¶

Creates an API mapping.

See also: AWS API Documentation

Request Syntax

response = client.create_api_mapping(
    ApiId='string',
    ApiMappingKey='string',
    DomainName='string',
    Stage='string'
)

Parameters:

ApiId (string) –
[REQUIRED]

The API identifier.
ApiMappingKey (string) – The API mapping key.
DomainName (string) –
[REQUIRED]

The domain name.
Stage (string) –
[REQUIRED]

The API stage.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

The request has succeeded and has resulted in the creation of a resource.
- ApiId (string) –
  
  The API identifier.
- ApiMappingId (string) –
  
  The API mapping identifier.
- ApiMappingKey (string) –
  
  The API mapping key.
- Stage (string) –
  
  The API stage.

Exceptions