update_workspace ¶

def update_workspace(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = 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.
    """

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

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.update_workspace.update_workspace(
                req.options, req.input
            )
        )
        return OperationResponse(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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output