AWS API Changes

2019/10/29 - Amazon AppStream - 3 updated api methods

Changes Adds support for providing domain names that can embed streaming sessions

CreateStack (updated)

Link ¶
Changes (request, response)
Request

{'EmbedHostDomains': ['string']}

Response

{'Stack': {'EmbedHostDomains': ['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'
    },
    Tags={
        'string': 'string'
    },
    AccessEndpoints=[
        {
            'EndpointType': 'STREAMING',
            'VpceId': 'string'
        },
    ],
    EmbedHostDomains=[
        'string',
    ]
)

type Name

string

param Name

[REQUIRED]

The name of the stack.

type Description

string

param Description

The description to display.

type DisplayName

string

param DisplayName

The stack name to display.

type StorageConnectors

list

param StorageConnectors

The storage connectors to enable.

(dict) --

Describes a connector that enables 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 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.

type Tags

dict

param Tags

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide .

(string) --
- (string) --

type AccessEndpoints

list

param AccessEndpoints

The list of interface VPC endpoint (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) -- [REQUIRED]
  
  The type of interface endpoint.
- VpceId (string) --
  
  The identifier (ID) of the VPC in which the interface endpoint is used.

type EmbedHostDomains

list

param EmbedHostDomains

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". ""]

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'
        },
        'AccessEndpoints': [
            {
                'EndpointType': 'STREAMING',
                'VpceId': 'string'
            },
        ],
        'EmbedHostDomains': [
            '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 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.
  - 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". ""]

DescribeStacks (updated)

Link ¶
Changes (response)

{'Stacks': {'EmbedHostDomains': ['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'
            },
            'AccessEndpoints': [
                {
                    'EndpointType': 'STREAMING',
                    'VpceId': 'string'
                },
            ],
            'EmbedHostDomains': [
                '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 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.
    - 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". ""]
- 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': {'EMBED_HOST_DOMAINS'}, 'EmbedHostDomains': ['string']}

Response

{'Stack': {'EmbedHostDomains': ['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'|'EMBED_HOST_DOMAINS'|'IAM_ROLE_ARN'|'ACCESS_ENDPOINTS',
    ],
    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'
    },
    AccessEndpoints=[
        {
            'EndpointType': 'STREAMING',
            'VpceId': 'string'
        },
    ],
    EmbedHostDomains=[
        'string',
    ]
)

type DisplayName

string

param DisplayName

The stack name to display.

type Description

string

param Description

The description to 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 that enables 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 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 choose 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.

type AccessEndpoints

list

param AccessEndpoints

The list of interface VPC endpoint (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) -- [REQUIRED]
  
  The type of interface endpoint.
- VpceId (string) --
  
  The identifier (ID) of the VPC in which the interface endpoint is used.

type EmbedHostDomains

list

param EmbedHostDomains

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". ""]

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'
        },
        'AccessEndpoints': [
            {
                'EndpointType': 'STREAMING',
                'VpceId': 'string'
            },
        ],
        'EmbedHostDomains': [
            '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 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.
  - 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". ""]