Amazon API Gateway REST API Reference

Deployment

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
deployment:update

Changes information about the deployment resource.

PATCH No
deployment:delete

Deletes the deployment resource.

DELETE No
deployment:stages

Gets the collection of the Stage resources of a given deployment.

GET No


Properties

{
  "id" : "String",
  "description" : "String",
  "createdDate" : "Timestamp",
  "apiSummary" : {
    "String" : {
      "String" : {
        "authorizationType" : "String",
        "apiKeyRequired" : "Boolean"
      }
    }
  }
}

  • id
  • The identifier for the deployment resource.

  • description
  • The description for the deployment resource.

  • createdDate
  • The date and time that the deployment resource was created.

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

    • authorizationType
    • 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
    • Specifies whether the method requires a valid ApiKey.

Remarks

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource ( /restapis/{restapi_id}/deployments/{deployment_id}).

See Also

RestApi, Deployments, Stage, AWS CLI, AWS SDKs