create_workspace ¶

def create_workspace(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    encryption_configuration: "capo_iotsitewise.types.workspace_encryption_configuration.WorkspaceEncryptionConfiguration",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    workspace_description: Optional[
        "capo_iotsitewise.types.description.Description"
    ] = None,
    tags: Optional["capo_iotsitewise.types.tag_map.TagMap"] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
) -> "capo_iotsitewise.types.create_workspace_response.CreateWorkspaceResponse":
    """<p>Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the <code>CREATING</code> state. Provisioning completes asynchronously, after which the workspace state is <code>ACTIVE</code>, or <code>FAILED</code> if provisioning doesn't complete.</p>

    Args:
        workspace_name: <p>The name of the workspace to create.</p>
        workspace_description: <p>A description for the workspace.</p>
        encryption_configuration: <p>The encryption configuration for the workspace.</p>
        tags: <p>A list of key-value pairs that contain metadata for the workspace. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.</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.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</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.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.create_workspace_request.CreateWorkspaceRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.create_workspace_response.CreateWorkspaceResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.create_workspace

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.create_workspace.create_workspace(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateWorkspace")
    )
    input_: capo_iotsitewise.types.create_workspace_request.CreateWorkspaceRequest = {
        "workspace_name": workspace_name,
        "encryption_configuration": encryption_configuration,
    }
    if workspace_description is not None:
        input_["workspace_description"] = workspace_description
    if tags is not None:
        input_["tags"] = tags
    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