[ aws . iotthingsgraph ]

describe-namespace

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-namespace
[--namespace-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--namespace-name (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get a description of your namespace

The following describe-namespace example gets a description of your namespace.

aws iotthingsgraph describe-namespace

Output:

{
    "namespaceName": "us-west-2/123456789012/default",
    "trackingNamespaceName": "aws",
    "trackingNamespaceVersion": 1,
    "namespaceVersion": 5
}

For more information, see Namespaces in the AWS IoT Things Graph User Guide.

Output

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 -> (long)

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

namespaceVersion -> (long)

The version of the user’s namespace to describe.