Table Of Contents

Feedback

User Guide

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

[ aws . apigatewayv2 ]

create-api

Description

Creates an Api resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-api
[--api-key-selection-expression <value>]
[--description <value>]
[--disable-schema-validation | --no-disable-schema-validation]
--name <value>
--protocol-type <value>
--route-selection-expression <value>
[--tags <value>]
[--api-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--api-key-selection-expression (string)

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

--description (string)

The description of the API.

--disable-schema-validation | --no-disable-schema-validation (boolean)

Avoid validating models when creating a deployment.

--name (string)

The name of the API.

--protocol-type (string)

The API protocol: Currently only WEBSOCKET is supported.

Possible values:

  • WEBSOCKET

--route-selection-expression (string)

The route selection expression for the API.

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

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--api-version (string)

A version identifier for the API.

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

Examples

To create a WebSocket API

The following create-api example creates a WebSocket API with the specified name.

aws apigatewayv2 create-api \
    --name "myWebSocketApi" \
    --protocol-type WEBSOCKET \
    --route-selection-expression '$request.body.action'

Output:

{
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "Name": "myWebSocketApi",
    "CreatedDate": "2018-11-15T06:23:51Z",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "'$request.body.action'",
    "ApiId": "aabbccddee"
}

For more information, see Create a WebSocket API in API Gateway in the Amazon API Gateway Developer Guide.

Output

ApiEndpoint -> (string)

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

ApiId -> (string)

The API ID.

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.

(string)

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