Amazon AppStream

2018/02/08 - Amazon AppStream - 3 updated api methods

Changes  Adds support for allowing customers to provide a redirect URL for a stack. Users will be redirected to the link provided by the admin at the end of their streaming session.

CreateStack (updated) Link ¶
Changes (request, response)
Request 
{'RedirectURL': 'string'}
Response 
{'Stack': {'RedirectURL': 'string'}}

Creates a stack.

See also: AWS API Documentation

Request Syntax

client.create_stack(
    Name='string',
    Description='string',
    DisplayName='string',
    StorageConnectors=[
        {
            'ConnectorType': 'HOMEFOLDERS',
            'ResourceIdentifier': 'string'
        },
    ],
    RedirectURL='string'
)
type Name

string

param Name

[REQUIRED]

The name of the stack.

type Description

string

param Description

The description for display.

type DisplayName

string

param DisplayName

The stack name for display.

type StorageConnectors

list

param StorageConnectors

The storage connectors to enable.

  • (dict) --

    Describes a storage connector.

    • ConnectorType (string) -- [REQUIRED]

      The type of storage connector.

    • ResourceIdentifier (string) --

      The ARN of the storage connector.

type RedirectURL

string

param RedirectURL

The URL the user is redirected to after the streaming session ends.

rtype

dict

returns

Response Syntax

{
    'Stack': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'StorageConnectors': [
            {
                'ConnectorType': 'HOMEFOLDERS',
                'ResourceIdentifier': 'string'
            },
        ],
        'RedirectURL': 'string',
        'StackErrors': [
            {
                'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Stack (dict) --

      Information about the stack.

      • Arn (string) --

        The ARN of the stack.

      • Name (string) --

        The name of the stack.

      • Description (string) --

        The description for display.

      • DisplayName (string) --

        The stack name for display.

      • CreatedTime (datetime) --

        The time the stack was created.

      • StorageConnectors (list) --

        The storage connectors to enable.

        • (dict) --

          Describes a storage connector.

          • ConnectorType (string) --

            The type of storage connector.

          • ResourceIdentifier (string) --

            The ARN of the storage connector.

      • RedirectURL (string) --

        The URL the user is redirected to after the streaming session ends.

      • StackErrors (list) --

        The errors for the stack.

        • (dict) --

          Describes a stack error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

DescribeStacks (updated) Link ¶
Changes (response) 
{'Stacks': {'RedirectURL': 'string'}}

Describes the specified stacks or all stacks in the account.

See also: AWS API Documentation

Request Syntax

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

list

param Names

The names of the stacks to describe.

  • (string) --

type NextToken

string

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

rtype

dict

returns

Response Syntax

{
    'Stacks': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'DisplayName': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'StorageConnectors': [
                {
                    'ConnectorType': 'HOMEFOLDERS',
                    'ResourceIdentifier': 'string'
                },
            ],
            'RedirectURL': 'string',
            'StackErrors': [
                {
                    'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string'
                },
            ]
        },
    ],
    '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 for display.

        • DisplayName (string) --

          The stack name for display.

        • CreatedTime (datetime) --

          The time the stack was created.

        • StorageConnectors (list) --

          The storage connectors to enable.

          • (dict) --

            Describes a storage connector.

            • ConnectorType (string) --

              The type of storage connector.

            • ResourceIdentifier (string) --

              The ARN of the storage connector.

        • RedirectURL (string) --

          The URL the user is redirected to after the streaming session ends.

        • StackErrors (list) --

          The errors for the stack.

          • (dict) --

            Describes a stack error.

            • ErrorCode (string) --

              The error code.

            • ErrorMessage (string) --

              The error message.

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

UpdateStack (updated) Link ¶
Changes (request, response)
Request 
{'AttributesToDelete': ['STORAGE_CONNECTORS | REDIRECT_URL'],
 'RedirectURL': 'string'}
Response 
{'Stack': {'RedirectURL': 'string'}}

Updates the specified stack.

See also: AWS API Documentation

Request Syntax

client.update_stack(
    DisplayName='string',
    Description='string',
    Name='string',
    StorageConnectors=[
        {
            'ConnectorType': 'HOMEFOLDERS',
            'ResourceIdentifier': 'string'
        },
    ],
    DeleteStorageConnectors=True|False,
    RedirectURL='string',
    AttributesToDelete=[
        'STORAGE_CONNECTORS'|'REDIRECT_URL',
    ]
)
type DisplayName

string

param DisplayName

The stack name for display.

type Description

string

param Description

The description for display.

type Name

string

param Name

[REQUIRED]

The name of the stack.

type StorageConnectors

list

param StorageConnectors

The storage connectors to enable.

  • (dict) --

    Describes a storage connector.

    • ConnectorType (string) -- [REQUIRED]

      The type of storage connector.

    • ResourceIdentifier (string) --

      The ARN of the storage connector.

type DeleteStorageConnectors

boolean

param DeleteStorageConnectors

Deletes the storage connectors currently enabled for the stack.

type RedirectURL

string

param RedirectURL

The URL the user is redirected to after the streaming session ends.

type AttributesToDelete

list

param AttributesToDelete

The stack attributes to delete.

  • (string) --

rtype

dict

returns

Response Syntax

{
    'Stack': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'DisplayName': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'StorageConnectors': [
            {
                'ConnectorType': 'HOMEFOLDERS',
                'ResourceIdentifier': 'string'
            },
        ],
        'RedirectURL': 'string',
        'StackErrors': [
            {
                'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                'ErrorMessage': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Stack (dict) --

      Information about the stack.

      • Arn (string) --

        The ARN of the stack.

      • Name (string) --

        The name of the stack.

      • Description (string) --

        The description for display.

      • DisplayName (string) --

        The stack name for display.

      • CreatedTime (datetime) --

        The time the stack was created.

      • StorageConnectors (list) --

        The storage connectors to enable.

        • (dict) --

          Describes a storage connector.

          • ConnectorType (string) --

            The type of storage connector.

          • ResourceIdentifier (string) --

            The ARN of the storage connector.

      • RedirectURL (string) --

        The URL the user is redirected to after the streaming session ends.

      • StackErrors (list) --

        The errors for the stack.

        • (dict) --

          Describes a stack error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.