DescribeCommands
Describes the results of specified commands.
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 about user permissions, see Managing User Permissions.
Request Syntax
{
"CommandIds": [ "string" ],
"DeploymentId": "string",
"InstanceId": "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.
- CommandIds
-
An array of command IDs. If you include this parameter,
DescribeCommandsreturns a description of the specified commands. Otherwise, it returns a description of every command.Type: Array of strings
Required: No
- DeploymentId
-
The deployment ID. If you include this parameter,
DescribeCommandsreturns a description of the commands associated with the specified deployment.Type: String
Required: No
- InstanceId
-
The instance ID. If you include this parameter,
DescribeCommandsreturns a description of the commands associated with the specified instance.Type: String
Required: No
Response Syntax
{
"Commands": [
{
"AcknowledgedAt": "string",
"CommandId": "string",
"CompletedAt": "string",
"CreatedAt": "string",
"DeploymentId": "string",
"ExitCode": number,
"InstanceId": "string",
"LogUrl": "string",
"Status": "string",
"Type": "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.
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:
