namespaces

Creates, updates, deletes, gets or lists a namespaces resource.

Overview

Name	namespaces
Type	Resource
Id	aws.iotthingsgraph.namespaces

Fields

The following fields are returned by SELECT queries:

describe_namespace

Name	Datatype	Description
namespace_arn	string	The ARN of the namespace.
namespace_name	string	The name of the namespace.
namespace_version	integer (int64)	The version of the user's namespace to describe.
tracking_namespace_name	string	The name of the public namespace that the latest namespace version is tracking.
tracking_namespace_version	integer (int64)	The version of the public namespace that the latest version is tracking.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_namespace	select	region		Gets the latest version of the user's namespace and the public version that it is tracking.
delete_namespace	delete	region		Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_namespace

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

SELECT
namespace_arn,
namespace_name,
namespace_version,
tracking_namespace_name,
tracking_namespace_version
FROM aws.iotthingsgraph.namespaces
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_namespace

Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no request parameters.

DELETE FROM aws.iotthingsgraph.namespaces
WHERE region = '{{ region }}' --required
;