Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . apigatewayv2 ]

update-api

Description

Updates an Api resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-api
--api-id <value>
[--api-key-selection-expression <value>]
[--cors-configuration <value>]
[--credentials-arn <value>]
[--description <value>]
[--disable-schema-validation | --no-disable-schema-validation]
[--disable-execute-api-endpoint | --no-disable-execute-api-endpoint]
[--name <value>]
[--route-key <value>]
[--route-selection-expression <value>]
[--target <value>]
[--api-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

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

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .

--cors-configuration (structure)

A CORS configuration. Supported only for HTTP APIs.

AllowCredentials -> (boolean)

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

AllowHeaders -> (list)

Represents a collection of allowed headers. Supported only for HTTP APIs.

(string)

AllowMethods -> (list)

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

(string)

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

AllowOrigins -> (list)

Represents a collection of allowed origins. Supported only for HTTP APIs.

(string)

ExposeHeaders -> (list)

Represents a collection of exposed headers. Supported only for HTTP APIs.

(string)

MaxAge -> (integer)

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

Shorthand Syntax:

AllowCredentials=boolean,AllowHeaders=string,string,AllowMethods=string,string,AllowOrigins=string,string,ExposeHeaders=string,string,MaxAge=integer

JSON Syntax:

{
  "AllowCredentials": true|false,
  "AllowHeaders": ["string", ...],
  "AllowMethods": ["string", ...],
  "AllowOrigins": ["string", ...],
  "ExposeHeaders": ["string", ...],
  "MaxAge": integer
}

--credentials-arn (string)

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

--description (string)

The description of the API.

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

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

--disable-execute-api-endpoint | --no-disable-execute-api-endpoint (boolean)

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

--name (string)

The name of the API.

--route-key (string)

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

--route-selection-expression (string)

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

--target (string)

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

--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 enable CORS for an HTTP API

The following update-api example updates the specified API's CORS configuration to allow requests from https://www.example.com.

aws apigatewayv2 update-api \
    --api-id a1b2c3d4 \
    --cors-configuration AllowOrigins=https://www.example.com

Output:

{
    "ApiEndpoint": "https://a1b2c3d4.execute-api.us-west-2.amazonaws.com",
    "ApiId": "a1b2c3d4",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "CorsConfiguration": {
        "AllowCredentials": false,
        "AllowHeaders": [
            "header1",
            "header2"
        ],
        "AllowMethods": [
            "GET",
            "OPTIONS"
        ],
        "AllowOrigins": [
            "https://www.example.com"
        ]
    },
    "CreatedDate": "2020-04-08T18:39:37+00:00",
    "Name": "my-http-api",
    "ProtocolType": "HTTP",
    "RouteSelectionExpression": "$request.method $request.path",
    "Tags": {},
    "Version": "v1.0"
}

For more information, see Configuring CORS for an HTTP API 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.

ApiGatewayManaged -> (boolean)

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

ApiId -> (string)

The API ID.

ApiKeySelectionExpression -> (string)

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .

CorsConfiguration -> (structure)

A CORS configuration. Supported only for HTTP APIs.

AllowCredentials -> (boolean)

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

AllowHeaders -> (list)

Represents a collection of allowed headers. Supported only for HTTP APIs.

(string)

AllowMethods -> (list)

Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.

(string)

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

AllowOrigins -> (list)

Represents a collection of allowed origins. Supported only for HTTP APIs.

(string)

ExposeHeaders -> (list)

Represents a collection of exposed headers. Supported only for HTTP APIs.

(string)

MaxAge -> (integer)

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

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. Supported only for WebSocket APIs.

DisableExecuteApiEndpoint -> (boolean)

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

ImportInfo -> (list)

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

(string)

Name -> (string)

The name of the API.

ProtocolType -> (string)

The API protocol.

RouteSelectionExpression -> (string)

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Tags -> (map)

A collection of tags associated with the API.

key -> (string)

value -> (string)

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

Version -> (string)

A version identifier for the API.

Warnings -> (list)

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

(string)