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

get-deployment

Description

Gets information about a Deployment resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-deployment
--rest-api-id <value>
--deployment-id <value>
[--embed <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--rest-api-id (string)

[Required] The string identifier of the associated RestApi .

--deployment-id (string)

[Required] The identifier of the Deployment resource to get information about.

--embed (list)

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2 . The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary .

(string)

Syntax:

"string" "string" ...

--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 get information about a deployment

Command:

aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2

Output:

{
    "description": "myDeployment",
    "id": "ztt4m2",
    "createdDate": 1455218022
}

Output

id -> (string)

The identifier for the deployment resource.

description -> (string)

The description for the deployment resource.

createdDate -> (timestamp)

The date and time that the deployment resource was created.

apiSummary -> (map)

A summary of the RestApi at the date and time that the deployment resource was created.

key -> (string)

value -> (map)

key -> (string)

value -> (structure)

Represents a summary of a Method resource, given a particular date and time.

authorizationType -> (string)

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

apiKeyRequired -> (boolean)

Specifies whether the method requires a valid ApiKey .