IoTSiteWise / Client / update_workspace

update_workspace

IoTSiteWise.Client.update_workspace(**kwargs)

Updates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a workspace in the FAILED state, call this operation and supply its encryption configuration again.

See also: AWS API Documentation

Request Syntax

response = client.update_workspace(
    workspaceName='string',
    workspaceDescription='string',
    encryptionConfiguration={
        'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
        'kmsKeyId': 'string'
    },
    clientToken='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace to update.

  • workspaceDescription (string) – A new description for the workspace.

  • encryptionConfiguration (dict) –

    The encryption configuration for the workspace. Omit this field to leave encryption unchanged. After a customer managed key configuration becomes active, the key can’t be changed; supplying the same key is accepted.

    • encryptionType (string) – [REQUIRED]

      The encryption scheme for the workspace. SITEWISE_DEFAULT_ENCRYPTION encrypts data with the IoT SiteWise default key. KMS_BASED_ENCRYPTION encrypts data with the customer managed KMS key identified by kmsKeyId.

    • kmsKeyId (string) –

      The customer managed KMS key used when encryptionType is KMS_BASED_ENCRYPTION. Accepts a key ID, key ARN, or key alias. Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION. After a workspace’s customer managed key configuration becomes active, the key can’t be changed.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'workspaceStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • workspaceStatus (dict) –

      The status of the workspace after the update, which is UPDATING when the operation returns.

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

Exceptions