get-api-mappings¶

Description¶

Gets API mappings.

Synopsis¶

  get-api-mappings
--domain-name <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--domain-name (string)

The domain name.

--max-results (string)

The maximum number of elements to be returned for this resource.

--next-token (string)

The next page of elements from this collection. Not valid for the last element of the collection.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get API mappings for a custom domain name

The following get-api-mappings example displays a list of all of the API mappings for the api.example.com custom domain name.

aws apigatewayv2 get-api-mappings \
    --domain-name api.example.com

Output:

{
    "Items": [
        {
            "ApiId": "a1b2c3d4",
            "ApiMappingId": "a1b2c3d5",
            "ApiMappingKey": "myTestApi"
            "Stage": "test"
        },
        {
            "ApiId": "a5b6c7d8",
            "ApiMappingId": "a1b2c3d6",
            "ApiMappingKey": "myDevApi"
            "Stage": "dev"
        },
    ]
}

For more information, see Setting up a regional custom domain name in API Gateway in the Amazon API Gateway Developer Guide.

Output¶

Items -> (list)

The elements from this collection.

(structure)

Represents an API mapping.

ApiId -> (string)

The API identifier.

ApiMappingId -> (string)

The API mapping identifier.

ApiMappingKey -> (string)

The API mapping key.

Stage -> (string)

The API stage.

NextToken -> (string)