Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . apigatewayv2 ]



Gets an Api resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--api-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--api-id (string)

The API identifier.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


ApiEndpoint -> (string)

The URI of the API, of the form {api-id}.execute-api.{region} The stage name is typically appended to this URI to form a complete path to a deployed API stage.

ApiId -> (string)


ApiKeySelectionExpression -> (string)

An API key selection expression. See API Key Selection Expressions .

CreatedDate -> (timestamp)

The timestamp when the API was created.

Description -> (string)

The description of the API.

DisableSchemaValidation -> (boolean)

Avoid validating models when creating a deployment.

Name -> (string)

The name of the API.

ProtocolType -> (string)

The API protocol: Currently only WEBSOCKET is supported.

RouteSelectionExpression -> (string)

The route selection expression for the API.

Version -> (string)

A version identifier for the API.

Warnings -> (list)

The warning messages reported when failonwarnings is turned on during API import.


Tags -> (map)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

key -> (string)

value -> (string)

A string with a length between [1-1600].