Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

DescribeStacks

If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. To retrieve the next set of items, pass the nextToken value in a subsequent call to this operation.

Request Syntax

Copy
{ "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 stack names to describe. Use null to describe all the stacks for the AWS account.

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

Copy
{ "NextToken": "string", "Stacks": [ { "Arn": "string", "CreatedTime": number, "Description": "string", "DisplayName": "string", "Name": "string", "StackErrors": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "StorageConnectors": [ { "ConnectorType": "string", "ResourceIdentifier": "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.

NextToken

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

Length Constraints: Minimum length of 1.

Stacks

The list of stack details.

Type: Array of Stack objects

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: