AWS IoT Things Graph
API Reference (API Version 2018-09-06)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeNamespace

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

Request Syntax

{ "namespaceName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

namespaceName

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

Type: String

Length Constraints: Maximum length of 128.

Required: No

Response Syntax

{ "namespaceArn": "string", "namespaceName": "string", "namespaceVersion": number, "trackingNamespaceName": "string", "trackingNamespaceVersion": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

namespaceArn

The ARN of the namespace.

Type: String

namespaceName

The name of the namespace.

Type: String

Length Constraints: Maximum length of 128.

namespaceVersion

The version of the user's namespace to describe.

Type: Long

trackingNamespaceName

The name of the public namespace that the latest namespace version is tracking.

Type: String

Length Constraints: Maximum length of 128.

trackingNamespaceVersion

The version of the public namespace that the latest version is tracking.

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

HTTP Status Code: 500

InvalidRequestException

HTTP Status Code: 400

ResourceNotFoundException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: