IoTThingsGraph / Client / describe_namespace

describe_namespace#

IoTThingsGraph.Client.describe_namespace(**kwargs)#

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.describe_namespace(
    namespaceName='string'
)

Parameters:

namespaceName (string) – The name of the user’s namespace. Set this to aws to get the public namespace.

Return type:

dict

Returns:

Response Syntax

{
    'namespaceArn': 'string',
    'namespaceName': 'string',
    'trackingNamespaceName': 'string',
    'trackingNamespaceVersion': 123,
    'namespaceVersion': 123
}

Response Structure

(dict) –
- namespaceArn (string) –
  
  The ARN of the namespace.
- namespaceName (string) –
  
  The name of the namespace.
- trackingNamespaceName (string) –
  
  The name of the public namespace that the latest namespace version is tracking.
- trackingNamespaceVersion (integer) –
  
  The version of the public namespace that the latest version is tracking.
- namespaceVersion (integer) –
  
  The version of the user’s namespace to describe.

Exceptions

IoTThingsGraph.Client.exceptions.ResourceNotFoundException
IoTThingsGraph.Client.exceptions.InvalidRequestException
IoTThingsGraph.Client.exceptions.InternalFailureException
IoTThingsGraph.Client.exceptions.ThrottlingException