update_workspace `async` ¶

update_workspace(
    workspace_name: WorkspaceName,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    workspace_description: Optional[Description] = None,
    encryption_configuration: Optional[WorkspaceEncryptionConfiguration] = None,
    client_token: Optional[ClientToken] = None,
) -> UpdateWorkspaceResponse

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.

Parameters:

workspace_name (WorkspaceName) –

The name of the workspace to update.
workspace_description (Optional[Description], default: None ) –

A new description for the workspace.
encryption_configuration (Optional[WorkspaceEncryptionConfiguration], default: None ) –

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.
client_token (Optional[ClientToken], default: None ) –

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.

Raises:

AccessDeniedException –

Access is denied.
ConflictingOperationException –

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py

async def update_workspace(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    workspace_description: Optional[
        "capo_iotsitewise.types.description.Description"
    ] = None,
    encryption_configuration: Optional[
        "capo_iotsitewise.types.workspace_encryption_configuration.WorkspaceEncryptionConfiguration"
    ] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.update_workspace_response.UpdateWorkspaceResponse":
    """<p>Updates a workspace. You can update only workspaces in the <code>ACTIVE</code> or <code>FAILED</code> state. Fields that you omit from the request are left unchanged. To recover a workspace in the <code>FAILED</code> state, call this operation and supply its encryption configuration again.</p>

    Args:
        workspace_name: <p>The name of the workspace to update.</p>
        workspace_description: <p>A new description for the workspace.</p>
        encryption_configuration: <p>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.</p>
        client_token: <p>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.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.update_workspace_request.UpdateWorkspaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.update_workspace_response.UpdateWorkspaceResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.update_workspace

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.update_workspace.async_update_workspace(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWorkspace")
    )
    input_: capo_iotsitewise.types.update_workspace_request.UpdateWorkspaceRequest = {
        "workspace_name": workspace_name
    }
    if workspace_description is not None:
        input_["workspace_description"] = workspace_description
    if encryption_configuration is not None:
        input_["encryption_configuration"] = encryption_configuration
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_workspace async ¶

update_workspace `async` ¶