namespaces

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

Overview

Name	namespaces
Type	Resource
Id	aws.quicksight.namespaces

Fields

The following fields are returned by SELECT queries:

describe_namespace

Name	Datatype	Description
namespace	object	The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

list_namespaces

Name	Datatype	Description
arn	string	The namespace ARN.
capacity_region	string	The namespace Amazon Web Services Region.
creation_status	string	The creation status of a namespace that is not yet completely created. (CREATED, CREATING, DELETING, RETRYABLE_FAILURE, NON_RETRYABLE_FAILURE)
iam_identity_center_application_arn	string	The Amazon Resource Name (ARN) for the IAM Identity Center application.
iam_identity_center_instance_arn	string	The Amazon Resource Name (ARN) for the IAM Identity Center instance.
identity_store	string	The identity store used for the namespace. (QUICKSIGHT)
name	string	The name of the error. (pattern: <code>^[a-zA-Z0-9._-]*$</code>)
namespace_error	object	An error that occurred when the namespace was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_namespace	select	aws_account_id, namespace, region		Describes the current namespace.
list_namespaces	select	aws_account_id, region	next-token, max-results	Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
create_namespace	insert	aws_account_id, region, IdentityStore		(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
delete_namespace	delete	aws_account_id, namespace, region		Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

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
aws_account_id	string	The ID for the Amazon Web Services account that you want to delete the Quick Sight namespace from.
namespace	string	The namespace that you want to delete.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return.
next-token	string	A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

SELECT examples

describe_namespace

Describes the current namespace.

SELECT
namespace,
request_id,
status
FROM aws.quicksight.namespaces
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND namespace = '{{ namespace }}' -- required
AND region = '{{ region }}' -- required
;

list_namespaces

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

SELECT
arn,
capacity_region,
creation_status,
iam_identity_center_application_arn,
iam_identity_center_instance_arn,
identity_store,
name,
namespace_error
FROM aws.quicksight.namespaces
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_namespace

(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

INSERT INTO aws.quicksight.namespaces (
Namespace,
IdentityStore,
Tags,
aws_account_id,
region
)
SELECT 
'{{ Namespace }}',
'{{ IdentityStore }}' /* required */,
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
capacity_region,
creation_status,
identity_store,
name,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: namespaces
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the namespaces resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the namespaces resource.
  - name: Namespace
    value: "{{ Namespace }}"
  - name: IdentityStore
    value: "{{ IdentityStore }}"
    valid_values: ['QUICKSIGHT']
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_namespace

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

DELETE FROM aws.quicksight.namespaces
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND namespace = '{{ namespace }}' --required
AND region = '{{ region }}' --required
;