WorkSpaces / Client / create_workspace_image

create_workspace_image#

WorkSpaces.Client.create_workspace_image(**kwargs)#

Creates a new WorkSpace image from an existing WorkSpace.

See also: AWS API Documentation

Request Syntax

response = client.create_workspace_image(
    Name='string',
    Description='string',
    WorkspaceId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the new WorkSpace image.

  • Description (string) –

    [REQUIRED]

    The description of the new WorkSpace image.

  • WorkspaceId (string) –

    [REQUIRED]

    The identifier of the source WorkSpace

  • Tags (list) –

    The tags that you want to add to the new WorkSpace image. To add tags when you’re creating the image, you must create an IAM policy that grants your IAM user permission 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

{
    'ImageId': 'string',
    'Name': 'string',
    'Description': 'string',
    'OperatingSystem': {
        'Type': 'WINDOWS'|'LINUX'
    },
    'State': 'AVAILABLE'|'PENDING'|'ERROR',
    'RequiredTenancy': 'DEFAULT'|'DEDICATED',
    'Created': datetime(2015, 1, 1),
    'OwnerAccountId': 'string'
}

Response Structure

  • (dict) –

    • ImageId (string) –

      The identifier of the new WorkSpace image.

    • Name (string) –

      The name of the image.

    • Description (string) –

      The description of the image.

    • OperatingSystem (dict) –

      The operating system that the image is running.

      • Type (string) –

        The operating system.

    • State (string) –

      The availability status of the image.

    • RequiredTenancy (string) –

      Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..

    • Created (datetime) –

      The date when the image was created.

    • OwnerAccountId (string) –

      The identifier of the Amazon Web Services account that owns the image.

Exceptions