AWS API Changes

2018/09/05 - Amazon AppStream - 3 updated api methods

Changes Added support for enabling persistent application settings for a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

CreateStack (updated)

Link ¶
Changes (request, response)
Request

{'ApplicationSettings': {'Enabled': 'boolean', 'SettingsGroup': 'string'}}

Response

{'Stack': {'ApplicationSettings': {'Enabled': 'boolean',
                                   'S3BucketName': 'string',
                                   'SettingsGroup': 'string'}}}

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

See also: AWS API Documentation

Request Syntax

client.create_stack(
    Name='string',
    Description='string',
    DisplayName='string',
    StorageConnectors=[
        {
            'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
            'ResourceIdentifier': 'string',
            'Domains': [
                'string',
            ]
        },
    ],
    RedirectURL='string',
    FeedbackURL='string',
    UserSettings=[
        {
            'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
            'Permission': 'ENABLED'|'DISABLED'
        },
    ],
    ApplicationSettings={
        'Enabled': True|False,
        'SettingsGroup': '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 connector to enable persistent storage for users.
- ConnectorType (string) -- [REQUIRED]
  
  The type of storage connector.
- ResourceIdentifier (string) --
  
  The ARN of the storage connector.
- Domains (list) --
  
  The names of the domains for the G Suite account.
  - (string) -- GSuite domain for GDrive integration.

type RedirectURL

string

param RedirectURL

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

type FeedbackURL

string

param FeedbackURL

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.

type UserSettings

list

param UserSettings

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) -- [REQUIRED]
  
  The action that is enabled or disabled.
- Permission (string) -- [REQUIRED]
  
  Indicates whether the action is enabled or disabled.

type ApplicationSettings

dict

param ApplicationSettings

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

Enabled (boolean) -- [REQUIRED]

Enables or disables persistent application settings for users during their streaming sessions.
SettingsGroup (string) --

The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.

rtype

dict

returns

Response Syntax

{
    'Stack': {
        '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',
                'Permission': 'ENABLED'|'DISABLED'
            },
        ],
        'ApplicationSettings': {
            'Enabled': True|False,
            'SettingsGroup': 'string',
            'S3BucketName': '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 connector to enable 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 G Suite 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.
  - 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.

DescribeStacks (updated)

Link ¶
Changes (response)

{'Stacks': {'ApplicationSettings': {'Enabled': 'boolean',
                                    'S3BucketName': 'string',
                                    'SettingsGroup': 'string'}}}

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

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'|'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',
                    'Permission': 'ENABLED'|'DISABLED'
                },
            ],
            'ApplicationSettings': {
                'Enabled': True|False,
                'SettingsGroup': 'string',
                'S3BucketName': '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 connector to enable 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 G Suite 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.
    - 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.
- 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

{'ApplicationSettings': {'Enabled': 'boolean', 'SettingsGroup': 'string'}}

Response

{'Stack': {'ApplicationSettings': {'Enabled': 'boolean',
                                   'S3BucketName': 'string',
                                   'SettingsGroup': 'string'}}}

Updates the specified fields for the specified stack.

See also: AWS API Documentation

Request Syntax

client.update_stack(
    DisplayName='string',
    Description='string',
    Name='string',
    StorageConnectors=[
        {
            'ConnectorType': 'HOMEFOLDERS'|'GOOGLE_DRIVE'|'ONE_DRIVE',
            'ResourceIdentifier': 'string',
            'Domains': [
                'string',
            ]
        },
    ],
    DeleteStorageConnectors=True|False,
    RedirectURL='string',
    FeedbackURL='string',
    AttributesToDelete=[
        'STORAGE_CONNECTORS'|'STORAGE_CONNECTOR_HOMEFOLDERS'|'STORAGE_CONNECTOR_GOOGLE_DRIVE'|'STORAGE_CONNECTOR_ONE_DRIVE'|'REDIRECT_URL'|'FEEDBACK_URL'|'THEME_NAME'|'USER_SETTINGS',
    ],
    UserSettings=[
        {
            'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'FILE_UPLOAD'|'FILE_DOWNLOAD'|'PRINTING_TO_LOCAL_DEVICE',
            'Permission': 'ENABLED'|'DISABLED'
        },
    ],
    ApplicationSettings={
        'Enabled': True|False,
        'SettingsGroup': 'string'
    }
)

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 connector to enable persistent storage for users.
- ConnectorType (string) -- [REQUIRED]
  
  The type of storage connector.
- ResourceIdentifier (string) --
  
  The ARN of the storage connector.
- Domains (list) --
  
  The names of the domains for the G Suite account.
  - (string) -- GSuite domain for GDrive integration.

type DeleteStorageConnectors

boolean

param DeleteStorageConnectors

Deletes the storage connectors currently enabled for the stack.

type RedirectURL

string

param RedirectURL

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

type FeedbackURL

string

param FeedbackURL

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.

type AttributesToDelete

list

param AttributesToDelete

The stack attributes to delete.

(string) --

type UserSettings

list

param UserSettings

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) -- [REQUIRED]
  
  The action that is enabled or disabled.
- Permission (string) -- [REQUIRED]
  
  Indicates whether the action is enabled or disabled.

type ApplicationSettings

dict

param ApplicationSettings

Enabled (boolean) -- [REQUIRED]

Enables or disables persistent application settings for users during their streaming sessions.
SettingsGroup (string) --

The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.

rtype

dict

returns

Response Syntax

{
    'Stack': {
        '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',
                'Permission': 'ENABLED'|'DISABLED'
            },
        ],
        'ApplicationSettings': {
            'Enabled': True|False,
            'SettingsGroup': 'string',
            'S3BucketName': '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 connector to enable 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 G Suite 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.
  - 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.