AWS API Changes

2017/05/25 - Amazon AppStream - 4 updated api methods

Changes Support added for persistent user storage, backed by S3.

CreateStack (updated)

Link ¶
Changes (request, response)
Request

{'StorageConnectors': [{'ConnectorType': 'HOMEFOLDERS',
                        'ResourceIdentifier': 'string'}]}

Response

{'Stack': {'StackErrors': [{'ErrorCode': 'STORAGE_CONNECTOR_ERROR | '
                                         'INTERNAL_SERVICE_ERROR',
                            'ErrorMessage': 'string'}],
           'StorageConnectors': [{'ConnectorType': 'HOMEFOLDERS',
                                  'ResourceIdentifier': 'string'}]}}

Create a new stack.

See also: AWS API Documentation

Request Syntax

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

type Name

string

param Name

[REQUIRED]

The unique identifier for this stack.

type Description

string

param Description

The description displayed to end users on the AppStream 2.0 portal.

type DisplayName

string

param DisplayName

The name displayed to end users on the AppStream 2.0 portal.

type StorageConnectors

list

param StorageConnectors

The storage connectors to be enabled for the stack.

(dict) --

Contains the parameters for a storage connector.
- ConnectorType (string) -- [REQUIRED]
  
  The type of storage connector. The possible values include: HOMEFOLDERS.
- ResourceIdentifier (string) --
  
  The ARN associated with the storage connector.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- Stack (dict) --
  
  The details for the created stack.
  - Arn (string) --
    
    The ARN of the stack.
  - Name (string) --
    
    The unique identifier of the stack.
  - Description (string) --
    
    A meaningful description for the stack.
  - DisplayName (string) --
    
    A display name for the stack.
  - CreatedTime (datetime) --
    
    The timestamp when the stack was created.
  - StorageConnectors (list) --
    
    The storage connectors to be enabled for the stack.
    - (dict) --
      
      Contains the parameters for a storage connector.
      - ConnectorType (string) --
        
        The type of storage connector. The possible values include: HOMEFOLDERS.
      - ResourceIdentifier (string) --
        
        The ARN associated with the storage connector.
  - StackErrors (list) --
    
    The list of errors associated with the stack.
    - (dict) --
      
      Contains the parameters for a stack error.
      - ErrorCode (string) --
        
        The error code of a stack error.
      - ErrorMessage (string) --
        
        The error message of a stack error.

DescribeImages (updated)

Link ¶
Changes (response)

{'Images': {'PublicBaseImageReleasedDate': 'timestamp'}}

Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.

See also: AWS API Documentation

Request Syntax

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

type Names

list

param Names

A specific list of images to describe.

(string) --

rtype

dict

returns

Response Syntax

{
    'Images': [
        {
            'Name': 'string',
            'Arn': 'string',
            'BaseImageArn': 'string',
            'DisplayName': 'string',
            'State': 'PENDING'|'AVAILABLE'|'FAILED'|'DELETING',
            'Visibility': 'PUBLIC'|'PRIVATE',
            'ImageBuilderSupported': True|False,
            'Platform': 'WINDOWS',
            'Description': 'string',
            'StateChangeReason': {
                'Code': 'INTERNAL_ERROR'|'IMAGE_BUILDER_NOT_AVAILABLE',
                '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)
        },
    ]
}

Response Structure

(dict) --
- Images (list) --
  
  The list of images.
  - (dict) --
    
    New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.
    - Name (string) --
      
      The unique identifier for the image.
    - Arn (string) --
      
      The ARN for the image.
    - BaseImageArn (string) --
      
      The source image ARN from which this image was created.
    - DisplayName (string) --
      
      The display name for the image.
    - State (string) --
      
      The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
    - Visibility (string) --
      
      The visibility of an image to the user; images can be public or private.
    - ImageBuilderSupported (boolean) --
      
      Whether an image builder can be launched from this image.
    - Platform (string) --
      
      The operating system platform of the image.
    - Description (string) --
      
      A meaningful description for the image.
    - StateChangeReason (dict) --
      
      The reason why the last state change occurred.
      - Code (string) --
        
        The state change reason code of the image.
      - Message (string) --
        
        The state change reason message to the end user.
    - Applications (list) --
      
      The applications associated with an image.
      - (dict) --
        
        An entry for a single application in the application catalog.
        
        Name (string) --
        
        The unique identifier for the application.
        
        DisplayName (string) --
        
        The name of the application shown to the end users.
        
        IconURL (string) --
        
        The URL for the application icon. This URL may be time-limited.
        
        LaunchPath (string) --
        
        The path to the application executable in the instance.
        
        LaunchParameters (string) --
        
        A list of arguments that are passed to the application at launch.
        
        Enabled (boolean) --
        
        An application can be disabled after image creation if there is a problem.
        
        Metadata (dict) --
        
        Additional attributes that describe the application.
        
        (string) --
        
        (string) --
    - CreatedTime (datetime) --
      
      The timestamp when the image was created.
    - PublicBaseImageReleasedDate (datetime) --
      
      The AWS 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.

DescribeStacks (updated)

Link ¶
Changes (response)

{'Stacks': {'StackErrors': [{'ErrorCode': 'STORAGE_CONNECTOR_ERROR | '
                                          'INTERNAL_SERVICE_ERROR',
                             'ErrorMessage': 'string'}],
            'StorageConnectors': [{'ConnectorType': 'HOMEFOLDERS',
                                   'ResourceIdentifier': 'string'}]}}

If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the nextToken value in a subsequent call to this operation to retrieve the next set of items.

See also: AWS API Documentation

Request Syntax

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

type Names

list

param Names

The stack names to describe. Use null to describe all the stacks for the AWS account.

(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'
                },
            ],
            'StackErrors': [
                {
                    'ErrorCode': 'STORAGE_CONNECTOR_ERROR'|'INTERNAL_SERVICE_ERROR',
                    'ErrorMessage': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Stacks (list) --
  
  The list of stack details.
  - (dict) --
    
    Details about a stack.
    - Arn (string) --
      
      The ARN of the stack.
    - Name (string) --
      
      The unique identifier of the stack.
    - Description (string) --
      
      A meaningful description for the stack.
    - DisplayName (string) --
      
      A display name for the stack.
    - CreatedTime (datetime) --
      
      The timestamp when the stack was created.
    - StorageConnectors (list) --
      
      The storage connectors to be enabled for the stack.
      - (dict) --
        
        Contains the parameters for a storage connector.
        
        ConnectorType (string) --
        
        The type of storage connector. The possible values include: HOMEFOLDERS.
        
        ResourceIdentifier (string) --
        
        The ARN associated with the storage connector.
    - StackErrors (list) --
      
      The list of errors associated with the stack.
      - (dict) --
        
        Contains the parameters for a stack error.
        
        ErrorCode (string) --
        
        The error code of a stack error.
        
        ErrorMessage (string) --
        
        The error message of a stack error.
- 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

{'DeleteStorageConnectors': 'boolean',
 'StorageConnectors': [{'ConnectorType': 'HOMEFOLDERS',
                        'ResourceIdentifier': 'string'}]}

Response

{'Stack': {'StackErrors': [{'ErrorCode': 'STORAGE_CONNECTOR_ERROR | '
                                         'INTERNAL_SERVICE_ERROR',
                            'ErrorMessage': 'string'}],
           'StorageConnectors': [{'ConnectorType': 'HOMEFOLDERS',
                                  'ResourceIdentifier': 'string'}]}}

Updates the specified fields in the stack with the specified name.

See also: AWS API Documentation

Request Syntax

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

type DisplayName

string

param DisplayName

The name displayed to end users on the AppStream 2.0 portal.

type Description

string

param Description

The description displayed to end users on the AppStream 2.0 portal.

type Name

string

param Name

[REQUIRED]

The name of the stack to update.

type StorageConnectors

list

param StorageConnectors

The storage connectors to be enabled for the stack.

(dict) --

Contains the parameters for a storage connector.
- ConnectorType (string) -- [REQUIRED]
  
  The type of storage connector. The possible values include: HOMEFOLDERS.
- ResourceIdentifier (string) --
  
  The ARN associated with the storage connector.

type DeleteStorageConnectors

boolean

param DeleteStorageConnectors

Remove all the storage connectors currently enabled for the stack.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- Stack (dict) --
  
  A list of stack details.
  - Arn (string) --
    
    The ARN of the stack.
  - Name (string) --
    
    The unique identifier of the stack.
  - Description (string) --
    
    A meaningful description for the stack.
  - DisplayName (string) --
    
    A display name for the stack.
  - CreatedTime (datetime) --
    
    The timestamp when the stack was created.
  - StorageConnectors (list) --
    
    The storage connectors to be enabled for the stack.
    - (dict) --
      
      Contains the parameters for a storage connector.
      - ConnectorType (string) --
        
        The type of storage connector. The possible values include: HOMEFOLDERS.
      - ResourceIdentifier (string) --
        
        The ARN associated with the storage connector.
  - StackErrors (list) --
    
    The list of errors associated with the stack.
    - (dict) --
      
      Contains the parameters for a stack error.
      - ErrorCode (string) --
        
        The error code of a stack error.
      - ErrorMessage (string) --
        
        The error message of a stack error.