IoTTwinMaker / Client / get_workspace

get_workspace#

IoTTwinMaker.Client.get_workspace(**kwargs)#

Retrieves information about a workspace.

Request Syntax

response = client.get_workspace(
    workspaceId='string'
)

Parameters:

workspaceId (string) –

[REQUIRED]

The ID of the workspace.

Return type:

dict

Returns:

Response Syntax

{
    'workspaceId': 'string',
    'arn': 'string',
    'description': 'string',
    'linkedServices': [
        'string',
    ],
    's3Location': 'string',
    'role': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'updateDateTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- workspaceId (string) –
  
  The ID of the workspace.
- arn (string) –
  
  The ARN of the workspace.
- description (string) –
  
  The description of the workspace.
- linkedServices (list) –
  
  A list of services that are linked to the workspace.
  - (string) –
- s3Location (string) –
  
  The ARN of the S3 bucket where resources associated with the workspace are stored.
- role (string) –
  
  The ARN of the execution role associated with the workspace.
- creationDateTime (datetime) –
  
  The date and time when the workspace was created.
- updateDateTime (datetime) –
  
  The date and time when the workspace was last updated.

Exceptions

IoTTwinMaker.Client.exceptions.InternalServerException
IoTTwinMaker.Client.exceptions.ResourceNotFoundException
IoTTwinMaker.Client.exceptions.ThrottlingException
IoTTwinMaker.Client.exceptions.ValidationException
IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException