Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.