describe_workspace ¶

describe_workspace(
    workspace_name: WorkspaceName,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
) -> DescribeWorkspaceResponse

Retrieves information about a workspace.

Parameters:

workspace_name (WorkspaceName) –

The name of the workspace.

Raises:

AccessDeniedException –

Access is denied.
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/io_t_site_wise.py

def describe_workspace(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
) -> "capo_iotsitewise.types.describe_workspace_response.DescribeWorkspaceResponse":
    """<p>Retrieves information about a workspace.</p>

    Args:
        workspace_name: <p>The name of the workspace.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</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.describe_workspace_request.DescribeWorkspaceRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.describe_workspace_response.DescribeWorkspaceResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.describe_workspace

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkspace")
    )
    input_: capo_iotsitewise.types.describe_workspace_request.DescribeWorkspaceRequest = {
        "workspace_name": workspace_name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output