AWS API Changes

2021/03/12 - Amazon WorkSpaces - 3 new 1 updated api methods

Changes Adds API support for WorkSpaces bundle management operations.

UpdateWorkspaceBundle (new)

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.

Warning

Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

See also: AWS API Documentation

Request Syntax

client.update_workspace_bundle(
    BundleId='string',
    ImageId='string'
)

type BundleId

string

param BundleId

The identifier of the bundle.

type ImageId

string

param ImageId

The identifier of the image.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateWorkspaceBundle (new)

Link ¶

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

See also: AWS API Documentation

Request Syntax

client.create_workspace_bundle(
    BundleName='string',
    BundleDescription='string',
    ImageId='string',
    ComputeType={
        'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'
    },
    UserStorage={
        'Capacity': 'string'
    },
    RootStorage={
        'Capacity': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type BundleName

string

param BundleName

[REQUIRED]

The name of the bundle.

type BundleDescription

string

param BundleDescription

[REQUIRED]

The description of the bundle.

type ImageId

string

param ImageId

[REQUIRED]

The identifier of the image that is used to create the bundle.

type ComputeType

dict

param ComputeType

[REQUIRED]

Describes the compute type of the bundle.

Name (string) --

The compute type.

type UserStorage

dict

param UserStorage

[REQUIRED]

Describes the user volume for a WorkSpace bundle.

Capacity (string) --

The size of the user volume.

type RootStorage

dict

param RootStorage

Describes the root volume for a WorkSpace bundle.

Capacity (string) --

The size of the root volume.

type Tags

list

param Tags

The tags associated with the bundle.

Note

To add tags at the same time that you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags .

(dict) --

Describes a tag.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) --
  
  The value of the tag.

rtype

dict

returns

Response Syntax

{
    'WorkspaceBundle': {
        'BundleId': 'string',
        'Name': 'string',
        'Owner': 'string',
        'Description': 'string',
        'ImageId': 'string',
        'RootStorage': {
            'Capacity': 'string'
        },
        'UserStorage': {
            'Capacity': 'string'
        },
        'ComputeType': {
            'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'
        },
        'LastUpdatedTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- WorkspaceBundle (dict) --
  
  Describes a WorkSpace bundle.
  - BundleId (string) --
    
    The identifier of the bundle.
  - Name (string) --
    
    The name of the bundle.
  - Owner (string) --
    
    The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.
  - Description (string) --
    
    The description of the bundle.
  - ImageId (string) --
    
    The identifier of the image that was used to create the bundle.
  - RootStorage (dict) --
    
    The size of the root volume.
    - Capacity (string) --
      
      The size of the root volume.
  - UserStorage (dict) --
    
    The size of the user volume.
    - Capacity (string) --
      
      The size of the user volume.
  - ComputeType (dict) --
    
    The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
    - Name (string) --
      
      The compute type.
  - LastUpdatedTime (datetime) --
    
    The last time that the bundle was updated.
  - CreationTime (datetime) --
    
    The time when the bundle was created.

DeleteWorkspaceBundle (new)

Link ¶

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

See also: AWS API Documentation

Request Syntax

client.delete_workspace_bundle(
    BundleId='string'
)

type BundleId

string

param BundleId

The identifier of the bundle.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DescribeWorkspaceBundles (updated)

Link ¶
Changes (response)

{'Bundles': {'CreationTime': 'timestamp'}}

Retrieves a list that describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

See also: AWS API Documentation

Request Syntax

client.describe_workspace_bundles(
    BundleIds=[
        'string',
    ],
    Owner='string',
    NextToken='string'
)

type BundleIds

list

param BundleIds

The identifiers of the bundles. You cannot combine this parameter with any other filter.

(string) --

type Owner

string

param Owner

The owner of the bundles. You cannot combine this parameter with any other filter.

To describe the bundles provided by AWS, specify AMAZON . To describe the bundles that belong to your account, don't specify a value.

type NextToken

string

param NextToken

The token for the next set of results. (You received this token from a previous call.)

rtype

dict

returns

Response Syntax

{
    'Bundles': [
        {
            'BundleId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'Description': 'string',
            'ImageId': 'string',
            'RootStorage': {
                'Capacity': 'string'
            },
            'UserStorage': {
                'Capacity': 'string'
            },
            'ComputeType': {
                'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'
            },
            'LastUpdatedTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Bundles (list) --
  
  Information about the bundles.
  - (dict) --
    
    Describes a WorkSpace bundle.
    - BundleId (string) --
      
      The identifier of the bundle.
    - Name (string) --
      
      The name of the bundle.
    - Owner (string) --
      
      The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.
    - Description (string) --
      
      The description of the bundle.
    - ImageId (string) --
      
      The identifier of the image that was used to create the bundle.
    - RootStorage (dict) --
      
      The size of the root volume.
      - Capacity (string) --
        
        The size of the root volume.
    - UserStorage (dict) --
      
      The size of the user volume.
      - Capacity (string) --
        
        The size of the user volume.
    - ComputeType (dict) --
      
      The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
      - Name (string) --
        
        The compute type.
    - LastUpdatedTime (datetime) --
      
      The last time that the bundle was updated.
    - CreationTime (datetime) --
      
      The time when the bundle was created.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.