[ aws . appstream ]

describe-stacks

Description

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-stacks is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Stacks

Synopsis

  describe-stacks
[--names <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--names (list)

The names of the stacks to describe.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Stacks -> (list)

Information about the stacks.

(structure)

Describes a stack.

Arn -> (string)

The ARN of the stack.

Name -> (string)

The name of the stack.

Description -> (string)

The description to display.

DisplayName -> (string)

The stack name to display.

CreatedTime -> (timestamp)

The time the stack was created.

StorageConnectors -> (list)

The storage connectors to enable.

(structure)

Describes a connector that enables persistent storage for users.

ConnectorType -> (string)

The type of storage connector.

ResourceIdentifier -> (string)

The ARN of the storage connector.

Domains -> (list)

The names of the domains for the account.

(string)

GSuite domain for GDrive integration.

RedirectURL -> (string)

The URL that users are redirected to after their streaming session ends.

FeedbackURL -> (string)

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

StackErrors -> (list)

The errors for the stack.

(structure)

Describes a stack error.

ErrorCode -> (string)

The error code.

ErrorMessage -> (string)

The error message.

UserSettings -> (list)

The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

(structure)

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

Action -> (string)

The action that is enabled or disabled.

Permission -> (string)

Indicates whether the action is enabled or disabled.

ApplicationSettings -> (structure)

The persistent application settings for users of the stack.

Enabled -> (boolean)

Specifies whether persistent application settings are enabled for users during their streaming sessions.

SettingsGroup -> (string)

The path prefix for the S3 bucket where users’ persistent application settings are stored.

S3BucketName -> (string)

The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.

AccessEndpoints -> (list)

The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

(structure)

Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.

EndpointType -> (string)

The type of interface endpoint.

VpceId -> (string)

The identifier (ID) of the VPC in which the interface endpoint is used.

EmbedHostDomains -> (list)

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

(string)

Specifies a valid domain that can embed AppStream. Valid examples include: [“testorigin.tt–com”, “testingorigin.com.us”, “test.com.us”] Invalid examples include: [“test,com”, “.com”, “h*llo.com”. “”]

NextToken -> (string)

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.