get-base-path-mapping¶

Description¶

Describe a BasePathMapping resource.

Synopsis¶

  get-base-path-mapping
--domain-name <value>
--base-path <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--domain-name (string)

The domain name of the BasePathMapping resource to be described.

--base-path (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get the base path mapping for a custom domain name

Command:

aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1

Output:

{
    "basePath": "v1",
    "restApiId": "1234w4321e",
    "stage": "api"
}

Output¶

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.

Table of Contents

Feedback

User Guide