DescribeStacks
Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
Request Syntax
{
"Names": [ "string" ],
"NextToken": "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.
- Names
-
The names of the stacks to describe.
Type: Array of strings
Length Constraints: Minimum length of 1.
Required: No
- NextToken
-
The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
Type: String
Length Constraints: Minimum length of 1.
Required: No
Response Syntax
{
"NextToken": "string",
"Stacks": [
{
"AccessEndpoints": [
{
"EndpointType": "string",
"VpceId": "string"
}
],
"ApplicationSettings": {
"Enabled": boolean,
"S3BucketName": "string",
"SettingsGroup": "string"
},
"Arn": "string",
"CreatedTime": number,
"Description": "string",
"DisplayName": "string",
"EmbedHostDomains": [ "string" ],
"FeedbackURL": "string",
"Name": "string",
"RedirectURL": "string",
"StackErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string"
}
],
"StorageConnectors": [
{
"ConnectorType": "string",
"Domains": [ "string" ],
"DomainsRequireAdminConsent": [ "string" ],
"ResourceIdentifier": "string"
}
],
"StreamingExperienceSettings": {
"PreferredProtocol": "string"
},
"UserSettings": [
{
"Action": "string",
"MaximumLength": number,
"Permission": "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
-
The specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
