APIGateway / Client / get_base_path_mapping

get_base_path_mapping#

APIGateway.Client.get_base_path_mapping(**kwargs)#

Describe a BasePathMapping resource.

See also: AWS API Documentation

Request Syntax

response = client.get_base_path_mapping(
    domainName='string',
    domainNameId='string',
    basePath='string'
)
Parameters:

  • domainName (string) –

    [REQUIRED]

    The domain name of the BasePathMapping resource to be described.

  • domainNameId (string) – The identifier for the domain name resource. Supported only for private custom domain names.

  • basePath (string) –

    [REQUIRED]

    The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify ‘(none)’ if you do not want callers to specify any base path name after the domain name.

Return type:

dict

Returns:

Response Syntax

{
    'basePath': 'string',
    'restApiId': 'string',
    'stage': 'string'
}

Response Structure

  • (dict) –

    Represents the base path that callers of the API must provide as part of the URL after the domain name.

    • basePath (string) –

      The base path name that callers of the API must provide as part of the URL after the domain name.

    • restApiId (string) –

      The string identifier of the associated RestApi.

    • stage (string) –

      The name of the associated stage.

Exceptions

  • APIGateway.Client.exceptions.BadRequestException

  • APIGateway.Client.exceptions.NotFoundException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException