Skip to content

describe_namespace async

describe_namespace(
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    namespace_name: Optional[NamespaceName] = None,
) -> DescribeNamespaceResponse

Gets the latest version of the user's namespace and the public version that it is tracking.

Parameters:

  • namespace_name (Optional[NamespaceName], default: None ) –

    The name of the user's namespace. Set this to aws to get the public namespace.

Raises:

Source code in docs_src/capo_iotthingsgraph/_services/async_io_t_things_graph.py
async def describe_namespace(
    self,
    *,
    config_overrides: Optional[AsyncIoTThingsGraphClientConfig] = None,
    namespace_name: Optional[
        "capo_iotthingsgraph.types.namespace_name.NamespaceName"
    ] = None,
) -> "capo_iotthingsgraph.types.describe_namespace_response.DescribeNamespaceResponse":
    """<p>Gets the latest version of the user's namespace and the public version that it is tracking.</p>

    Args:
        namespace_name: <p>The name of the user's namespace. Set this to <code>aws</code> to get the public namespace.</p>

    Raises:
        capo_iotthingsgraph.errors.internal_failure_exception.InternalFailureException: <p></p>
        capo_iotthingsgraph.errors.invalid_request_exception.InvalidRequestException: <p></p>
        capo_iotthingsgraph.errors.resource_not_found_exception.ResourceNotFoundException: <p></p>
        capo_iotthingsgraph.errors.throttling_exception.ThrottlingException: <p></p>
        capo_iotthingsgraph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotthingsgraph.types.describe_namespace_request.DescribeNamespaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotthingsgraph.types.describe_namespace_response.DescribeNamespaceResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.describe_namespace

        (
            output,
            http_response,
        ) = await capo_iotthingsgraph._operations.iot_things_graph_front_end_service.describe_namespace.async_describe_namespace(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeNamespace")
    )
    input_: capo_iotthingsgraph.types.describe_namespace_request.DescribeNamespaceRequest = {}
    if namespace_name is not None:
        input_["namespace_name"] = namespace_name

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