WorkspacesInstances / Client / get_workspace_instance

get_workspace_instance

WorkspacesInstances.Client.get_workspace_instance(**kwargs)

Retrieves detailed information about a specific WorkSpace Instance.

See also: AWS API Documentation

Request Syntax

response = client.get_workspace_instance(
    WorkspaceInstanceId='string'
)
Parameters:

WorkspaceInstanceId (string) –

[REQUIRED]

Unique identifier of the WorkSpace Instance to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'WorkspaceInstanceErrors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'EC2InstanceErrors': [
        {
            'EC2ErrorCode': 'string',
            'EC2ExceptionType': 'string',
            'EC2ErrorMessage': 'string'
        },
    ],
    'ProvisionState': 'ALLOCATING'|'ALLOCATED'|'DEALLOCATING'|'DEALLOCATED'|'ERROR_ALLOCATING'|'ERROR_DEALLOCATING',
    'WorkspaceInstanceId': 'string',
    'EC2ManagedInstance': {
        'InstanceId': 'string'
    }
}

Response Structure

  • (dict) –

    Provides comprehensive details about the requested WorkSpaces Instance.

    • WorkspaceInstanceErrors (list) –

      Captures any errors specific to the WorkSpace Instance lifecycle.

      • (dict) –

        Captures errors specific to WorkSpace Instance operations.

        • ErrorCode (string) –

          Unique error code for the WorkSpace Instance error.

        • ErrorMessage (string) –

          Detailed description of the WorkSpace Instance error.

    • EC2InstanceErrors (list) –

      Includes any underlying EC2 instance errors encountered.

      • (dict) –

        Captures detailed error information for EC2 instance operations.

        • EC2ErrorCode (string) –

          Unique error code identifying the specific EC2 instance error.

        • EC2ExceptionType (string) –

          Type of exception encountered during EC2 instance operation.

        • EC2ErrorMessage (string) –

          Detailed description of the EC2 instance error.

    • ProvisionState (string) –

      Current provisioning state of the WorkSpaces Instance.

    • WorkspaceInstanceId (string) –

      Unique identifier of the retrieved WorkSpaces Instance.

    • EC2ManagedInstance (dict) –

      Details of the associated EC2 managed instance.

      • InstanceId (string) –

        Unique identifier of the managed EC2 instance.

Exceptions