Table Of Contents

Feedback

User Guide

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

[ aws . apigatewayv2 ]

create-deployment

Description

Creates a Deployment for an API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-deployment
--api-id <value>
[--description <value>]
[--stage-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

--description (string)

The description for the deployment resource.

--stage-name (string)

The name of the Stage resource for the Deployment resource to create.

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

Output

CreatedDate -> (timestamp)

The date and time when the Deployment resource was created.

DeploymentId -> (string)

The identifier for the deployment.

DeploymentStatus -> (string)

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

DeploymentStatusMessage -> (string)

May contain additional feedback on the status of an API deployment.

Description -> (string)

The description for the deployment.