AppStream / Client / describe_stacks

describe_stacks

AppStream.Client.describe_stacks(**kwargs)

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

Request Syntax

response = client.describe_stacks(
    Names=[
        'string',
    ],
    NextToken='string'
)

Parameters:

• Names (list) –

  The names of the stacks to describe.

  • (string) –

• NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Stacks': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'DisplayName': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'StorageConnectors': [
                {
                    'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
                    'ResourceIdentifier': 'string',
                    'Domains': [
                        'string',
                    ]
                },
            ],
            'RedirectURL': 'string',
            'FeedbackURL': 'string',
            'StackErrors': [
                {
                    'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string'
                },
            ],
            'UserSettings': [
                {
                    'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE'|'DOMAIN_PASSWORD_SIGNIN'|'DOMAIN_SMART_CARD_SIGNIN'|'AUTO_TIME_ZONE_REDIRECTION',
                    'Permission': 'ENABLED'|'DISABLED',
                    'MaximumLength': 123
                },
            ],
            'ApplicationSettings': {
                'Enabled': True|False,
                'SettingsGroup': 'string',
                'S3BucketName': 'string'
            },
            'AccessEndpoints': [
                {
                    'EndpointType': 'STREAMING',
                    'VpceId': 'string'
                },
            ],
            'EmbedHostDomains': [
                'string',
            ],
            'StreamingExperienceSettings': {
                'PreferredProtocol': 'TCP'|'UDP'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Stacks (list) –

    Information about the stacks.

    • (dict) –

      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 (datetime) –

        The time the stack was created.

      • StorageConnectors (list) –

        The storage connectors to enable.

        • (dict) –

          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.

        • (dict) –

          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.

        • (dict) –

          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.

          • MaximumLength (integer) –

            Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

            This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

            This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can’t be specified when the permission is DISABLED.

            The value can be between 1 and 20,971,520 (20 MB).

      • ApplicationSettings (dict) –

        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.

        • (dict) –

          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”. “”]

      • StreamingExperienceSettings (dict) –

        The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

        • PreferredProtocol (string) –

          The preferred protocol that you want to use while streaming your application.

  • 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.

Exceptions

• AppStream.Client.exceptions.ResourceNotFoundException