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.
Links
| 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
NONEfor open access,AWS_IAMfor using AWS IAM permissions,CUSTOMfor using a custom authorizer, orCOGNITO_USER_POOLSfor using a Cognito user pool.- apiKeyRequired
Specifies whether the method requires a valid ApiKey.
Remarks
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}).
