WorkSpaces / Client / describe_workspace_bundles

describe_workspace_bundles#

WorkSpaces.Client.describe_workspace_bundles(**kwargs)#

Retrieves a list that describes the available WorkSpace bundles.

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

Request Syntax

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

Parameters:

BundleIds (list) –
The identifiers of the bundles. You cannot combine this parameter with any other filter.
- (string) –
Owner (string) –
The owner of the bundles. You cannot combine this parameter with any other filter.

To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don’t specify a value.
NextToken (string) – The token for the next set of results. (You received this token from a previous call.)

Return type:

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'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
            },
            'LastUpdatedTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1),
            'State': 'AVAILABLE'|'PENDING'|'ERROR',
            'BundleType': 'REGULAR'|'STANDBY'
        },
    ],
    '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 Amazon Web Services.
    - 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.
    - State (string) –
      
      The state of the WorkSpace bundle.
    - BundleType (string) –
      
      The type of WorkSpace bundle.
- 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.

Exceptions

WorkSpaces.Client.exceptions.InvalidParameterValuesException