IoTSiteWise / Client / describe_workspace

describe_workspace¶

IoTSiteWise.Client.describe_workspace(**kwargs)¶

Retrieves information about a workspace.

Request Syntax

response = client.describe_workspace(
    workspaceName='string'
)

Parameters:

workspaceName (string) –

[REQUIRED]

The name of the workspace.

Return type:

dict

Returns:

Response Syntax

{
    'workspaceArn': 'string',
    'workspaceName': 'string',
    'workspaceDescription': 'string',
    'workspaceStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    },
    'encryptionConfiguration': {
        'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
        'kmsKeyArn': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- workspaceArn (string) –
  
  The ARN of the workspace.
- workspaceName (string) –
  
  The name of the workspace.
- workspaceDescription (string) –
  
  The description of the workspace.
- workspaceStatus (dict) –
  
  The status of the workspace, which contains the state and any error message.
  - state (string) –
    
    The current state of the workspace.
  - error (dict) –
    
    Contains associated error information, if any.
    - code (string) –
      
      The error code.
    - message (string) –
      
      The error message.
- encryptionConfiguration (dict) –
  
  The encryption configuration information for the workspace.
  - encryptionType (string) –
    
    The type of encryption used for the workspace.
  - kmsKeyArn (string) –
    
    The key ARN of the KMS key used for KMS encryption if encryptionType is KMS_BASED_ENCRYPTION.
- createdAt (datetime) –
  
  The date the workspace was created, in Unix epoch time.
- updatedAt (datetime) –
  
  The date the workspace was last updated, in Unix epoch time.

Exceptions

IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ThrottlingException
IoTSiteWise.Client.exceptions.InternalFailureException