Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

DescribeDeployments

Requests a description of a specified set of deployments.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Request Syntax

{
   "AppId": "string",
   "DeploymentIds": [ "string" ],
   "StackId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AppId

The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

Type: String

Required: No

DeploymentIds

An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

Type: Array of strings

Required: No

StackId

The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

Type: String

Required: No

Response Syntax

{
   "Deployments": [ 
      { 
         "AppId": "string",
         "Command": { 
            "Args": { 
               "string" : [ "string" ]
            },
            "Name": "string"
         },
         "Comment": "string",
         "CompletedAt": "string",
         "CreatedAt": "string",
         "CustomJson": "string",
         "DeploymentId": "string",
         "Duration": number,
         "IamUserArn": "string",
         "InstanceIds": [ "string" ],
         "StackId": "string",
         "Status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Deployments

An array of Deployment objects that describe the deployments.

Type: Array of Deployment objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: