DescribeStacks
Requests a description of one or more stacks.
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
{
"StackIds": [ "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.
- StackIds
-
An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information about all stacks,
DescribeStacksreturns a description of every stack. If the IAM policy that is attached to an IAM user limits theDescribeStacksaction to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. Otherwise,DescribeStacksreturns anAccessDeniederror.Type: Array of strings
Required: No
Response Syntax
{
"Stacks": [
{
"AgentVersion": "string",
"Arn": "string",
"Attributes": {
"string" : "string"
},
"ChefConfiguration": {
"BerkshelfVersion": "string",
"ManageBerkshelf": boolean
},
"ConfigurationManager": {
"Name": "string",
"Version": "string"
},
"CreatedAt": "string",
"CustomCookbooksSource": {
"Password": "string",
"Revision": "string",
"SshKey": "string",
"Type": "string",
"Url": "string",
"Username": "string"
},
"CustomJson": "string",
"DefaultAvailabilityZone": "string",
"DefaultInstanceProfileArn": "string",
"DefaultOs": "string",
"DefaultRootDeviceType": "string",
"DefaultSshKeyName": "string",
"DefaultSubnetId": "string",
"HostnameTheme": "string",
"Name": "string",
"Region": "string",
"ServiceRoleArn": "string",
"StackId": "string",
"UseCustomCookbooks": boolean,
"UseOpsworksSecurityGroups": boolean,
"VpcId": "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:
