WorkSpaces / Client / create_workspace_bundle

create_workspace_bundle#

WorkSpaces.Client.create_workspace_bundle(**kwargs)#

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

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

  • BundleName (string) –

    [REQUIRED]

    The name of the bundle.

  • BundleDescription (string) –

    [REQUIRED]

    The description of the bundle.

  • ImageId (string) –

    [REQUIRED]

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

  • ComputeType (dict) –

    [REQUIRED]

    Describes the compute type of the bundle.

    • Name (string) –

      The compute type.

  • UserStorage (dict) –

    [REQUIRED]

    Describes the user volume for a WorkSpace bundle.

    • Capacity (string) – [REQUIRED]

      The size of the user volume.

  • RootStorage (dict) –

    Describes the root volume for a WorkSpace bundle.

    • Capacity (string) – [REQUIRED]

      The size of the root volume.

  • Tags (list) –

    The tags associated with the bundle.

    Note

    To add tags at the same time when 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.

Return type:

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'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
        },
        'LastUpdatedTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'State': 'AVAILABLE'|'PENDING'|'ERROR',
        'BundleType': 'REGULAR'|'STANDBY'
    }
}

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

Exceptions