spaces

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

Overview

Name	spaces
Type	Resource
Id	aws.quicksight.spaces

Fields

The following fields are returned by SELECT queries:

describe_space

Name	Datatype	Description
contributors	array	A list of contributors to the space.
request_id	string	The Amazon Web Services request ID for this operation.
space	object	The details of the space.
space_arn	string	The ARN of the space. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
space_id	string	The ID of the space. (pattern: <code>[0-9a-zA-Z-_=.+]+</code>)

search_spaces

Name	Datatype	Description
next_token	string	The token for the next set of results, or null if there are no more results.
request_id	string	The Amazon Web Services request ID for this operation.
space_summaries	array	A list of space summaries that match the search criteria.
space_arn	string	The ARN of the space. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
space_id	string	The ID of the space. (pattern: <code>[0-9a-zA-Z-_=.+]+</code>)

list_spaces

Name	Datatype	Description
next_token	string	The token for the next set of results, or null if there are no more results.
request_id	string	The Amazon Web Services request ID for this operation.
space_summaries	array	A list of space summaries.
space_arn	string	The ARN of the space. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
space_id	string	The ID of the space. (pattern: <code>[0-9a-zA-Z-_=.+]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_space	select	aws_account_id, space_id, region	maxContributors	Describes an Amazon QuickSight space.
search_spaces	select	aws_account_id, region		Searches for Amazon QuickSight spaces that match the specified filters.
list_spaces	select	aws_account_id, region	next-token, max-results	Lists all Amazon QuickSight spaces in an Amazon Web Services account.
create_space	insert	aws_account_id, region, SpaceId, Name		Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.
update_space	update	aws_account_id, space_id, region		Updates the metadata of an Amazon QuickSight space.
delete_space	delete	aws_account_id, space_id, region		Deletes an Amazon QuickSight space.

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 of the Amazon Web Services account that contains the space.
region	string	AWS region (default: us-east-1)
space_id	string	The ID of the space that you want to delete.
max-results	integer	The maximum number of results to return.
maxContributors	integer	The maximum number of contributors to include in the response.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_space

Describes an Amazon QuickSight space.

SELECT
contributors,
request_id,
space,
space_arn,
space_id
FROM aws.quicksight.spaces
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND space_id = '{{ space_id }}' -- required
AND region = '{{ region }}' -- required
AND maxContributors = '{{ maxContributors }}'
;

search_spaces

Searches for Amazon QuickSight spaces that match the specified filters.

SELECT
next_token,
request_id,
space_summaries,
space_arn,
space_id
FROM aws.quicksight.spaces
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_spaces

Lists all Amazon QuickSight spaces in an Amazon Web Services account.

SELECT
next_token,
request_id,
space_summaries,
space_arn,
space_id
FROM aws.quicksight.spaces
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_space

Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.

INSERT INTO aws.quicksight.spaces (
SpaceId,
Name,
Description,
aws_account_id,
region
)
SELECT 
'{{ SpaceId }}' /* required */,
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
request_id,
space_arn,
space_id
;

Manifest

# Description fields are for documentation purposes
- name: spaces
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the spaces resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the spaces resource.
  - name: SpaceId
    value: "{{ SpaceId }}"
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"

UPDATE examples

update_space

Updates the metadata of an Amazon QuickSight space.

UPDATE aws.quicksight.spaces
SET 
Name = '{{ Name }}',
Description = '{{ Description }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND space_id = '{{ space_id }}' --required
AND region = '{{ region }}' --required
RETURNING
request_id,
space_arn,
space_id;

DELETE examples

delete_space

Deletes an Amazon QuickSight space.

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