AWS API Changes

2018/07/10 - Amazon AppStream - 4 updated api methods

Changes This API update adds pagination to the DescribeImages API to support future features and enhancements.

CreateStack (updated)

Link ¶
Changes (request, response)
Request

{'StorageConnectors': {'ConnectorType': {'ONE_DRIVE'}}}

Response

{'Stack': {'StorageConnectors': {'ConnectorType': {'ONE_DRIVE'}}}}

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'
        },
    ]
)

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.

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'
            },
        ]
    }
}

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.

DescribeImages (updated)

Link ¶
Changes (request, response)
Request

{'MaxResults': 'integer', 'NextToken': 'string'}

Response

{'NextToken': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.describe_images(
    Names=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)

type Names

list

param Names

The names of the images to describe.

(string) --

type NextToken

string

param NextToken

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

type MaxResults

integer

param MaxResults

The maximum size of each results page.

rtype

dict

returns

Response Syntax

{
    'Images': [
        {
            'Name': 'string',
            'Arn': 'string',
            'BaseImageArn': 'string',
            'DisplayName': 'string',
            'State': 'PENDING'|'AVAILABLE'|'FAILED'|'COPYING'|'DELETING',
            'Visibility': 'PUBLIC'|'PRIVATE',
            'ImageBuilderSupported': True|False,
            'Platform': 'WINDOWS',
            'Description': 'string',
            'StateChangeReason': {
                'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE'|'IMAGE_COPY_FAILURE',
                'Message': 'string'
            },
            'Applications': [
                {
                    'Name': 'string',
                    'DisplayName': 'string',
                    'IconURL': 'string',
                    'LaunchPath': 'string',
                    'LaunchParameters': 'string',
                    'Enabled': True|False,
                    'Metadata': {
                        'string': 'string'
                    }
                },
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'PublicBaseImageReleasedDate': datetime(2015, 1, 1),
            'AppstreamAgentVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Images (list) --
  
  Information about the images.
  - (dict) --
    
    Describes an image.
    - Name (string) --
      
      The name of the image.
    - Arn (string) --
      
      The ARN of the image.
    - BaseImageArn (string) --
      
      The ARN of the image from which this image was created.
    - DisplayName (string) --
      
      The image name for display.
    - State (string) --
      
      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE . If image creation fails, the state is FAILED .
    - Visibility (string) --
      
      Indicates whether the image is public or private.
    - ImageBuilderSupported (boolean) --
      
      Indicates whether an image builder can be launched from this image.
    - Platform (string) --
      
      The operating system platform of the image.
    - Description (string) --
      
      The description for display.
    - StateChangeReason (dict) --
      
      The reason why the last state change occurred.
      - Code (string) --
        
        The state change reason code.
      - Message (string) --
        
        The state change reason message.
    - Applications (list) --
      
      The applications associated with the image.
      - (dict) --
        
        Describes an application in the application catalog.
        
        Name (string) --
        
        The name of the application.
        
        DisplayName (string) --
        
        The application name for display.
        
        IconURL (string) --
        
        The URL for the application icon. This URL might be time-limited.
        
        LaunchPath (string) --
        
        The path to the application executable in the instance.
        
        LaunchParameters (string) --
        
        The arguments that are passed to the application at launch.
        
        Enabled (boolean) --
        
        If there is a problem, the application can be disabled after image creation.
        
        Metadata (dict) --
        
        Additional attributes that describe the application.
        
        (string) --
        
        (string) --
    - CreatedTime (datetime) --
      
      The time the image was created.
    - PublicBaseImageReleasedDate (datetime) --
      
      The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
    - AppstreamAgentVersion (string) --
      
      The version of the AppStream 2.0 agent to use for instances that are launched from this image.
- NextToken (string) --
  
  The pagination token used to retrieve the next page of results. If this value is empty, only the first page is retrieved.

DescribeStacks (updated)

Link ¶
Changes (response)

{'Stacks': {'StorageConnectors': {'ConnectorType': {'ONE_DRIVE'}}}}

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'
                },
            ]
        },
    ],
    '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.
- 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_CONNECTOR_ONE_DRIVE'},
 'StorageConnectors': {'ConnectorType': {'ONE_DRIVE'}}}

Response

{'Stack': {'StorageConnectors': {'ConnectorType': {'ONE_DRIVE'}}}}

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'
        },
    ]
)

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.

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'
            },
        ]
    }
}

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.