data_lake_namespaces

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

Overview

Name	data_lake_namespaces
Type	Resource
Id	aws.supplychain.data_lake_namespaces

Fields

The following fields are returned by SELECT queries:

get_data_lake_namespace

Name	Datatype	Description
name	string	The name of the namespace. (pattern: <code>[a-z0-9_]+</code>)
arn	string	The arn of the namespace. (pattern: <code>arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]*</code>)
created_time	string (date-time)	The creation time of the namespace.
description	string	The description of the namespace.
instance_id	string	The Amazon Web Services Supply Chain instance identifier. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
last_modified_time	string (date-time)	The last modified time of the namespace.

list_data_lake_namespaces

Name	Datatype	Description
name	string	The name of the namespace. (pattern: <code>[a-z0-9_]+</code>)
arn	string	The arn of the namespace. (pattern: <code>arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]*</code>)
created_time	string (date-time)	The creation time of the namespace.
description	string	The description of the namespace.
instance_id	string	The Amazon Web Services Supply Chain instance identifier. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
last_modified_time	string (date-time)	The last modified time of the namespace.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_lake_namespace	select	instance_id, name, region		Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.
list_data_lake_namespaces	select	instance_id, region	nextToken, maxResults	Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included.
create_data_lake_namespace	insert	instance_id, name, region		Enables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.
update_data_lake_namespace	update	instance_id, name, region		Enables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name.
delete_data_lake_namespace	delete	instance_id, name, region		Enables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name.

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
instance_id	string	The AWS Supply Chain instance identifier.
name	string	The name of the namespace. Noted you cannot delete pre-defined namespace like asc, default which are only deleted through instance deletion.
region	string	AWS region (default: us-east-1)
maxResults	integer	The max number of namespaces to fetch in this paginated request.
nextToken	string	The pagination token to fetch next page of namespaces.

SELECT examples

get_data_lake_namespace

Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.

SELECT
name,
arn,
created_time,
description,
instance_id,
last_modified_time
FROM aws.supplychain.data_lake_namespaces
WHERE instance_id = '{{ instance_id }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_data_lake_namespaces

Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included.

SELECT
name,
arn,
created_time,
description,
instance_id,
last_modified_time
FROM aws.supplychain.data_lake_namespaces
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_data_lake_namespace

Enables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.

INSERT INTO aws.supplychain.data_lake_namespaces (
description,
tags,
instance_id,
name,
region
)
SELECT 
'{{ description }}',
'{{ tags }}',
'{{ instance_id }}',
'{{ name }}',
'{{ region }}'
RETURNING
namespace
;

Manifest

# Description fields are for documentation purposes
- name: data_lake_namespaces
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the data_lake_namespaces resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the data_lake_namespaces resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_lake_namespaces resource.
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_data_lake_namespace

Enables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name.

UPDATE aws.supplychain.data_lake_namespaces
SET 
description = '{{ description }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
namespace;

DELETE examples

delete_data_lake_namespace

Enables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name.

DELETE FROM aws.supplychain.data_lake_namespaces
WHERE instance_id = '{{ instance_id }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required
;