CmdID

CmdID / aws / aws apigateway

aws apigateway get-base-path-mapping

Describe a BasePathMapping resource. AWS CLI reference

1 example 3 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

To get the base path mapping for a custom domain name

The following get-base-path-mapping example gets the base path mapping for a custom domain name.

aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1Identify
--domain-nameThe domain name of the BasePathMapping resource to be described.
--base-pathThe base path name that callers of the API must provide as part of the URL after the domain name.
Its output
{
    "basePath": "v1",
    "restApiId": "1234w4321e",
    "stage": "api"
}

For more information, see Use API mappings to connect API stages to a custom domain name for REST APIs in the Amazon API Gateway Developer Guide.

Options

3 in the AWS CLI reference
--base-pathThe base path name that callers of the API must provide as part of the URL after the domain name.
--domain-name-idThe identifier for the domain name resource.
--domain-nameThe domain name of the BasePathMapping resource to be described.