ingestions

Creates, updates, deletes, gets or lists an ingestions resource.

Overview

Name	ingestions
Type	Resource
Id	aws.quicksight.ingestions

Fields

The following fields are returned by SELECT queries:

describe_ingestion

Name	Datatype	Description
ingestion	object	Information about the ingestion.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

list_ingestions

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the resource.
created_time	string (date-time)	The time that this ingestion started.
error_info	object	Error information for this ingestion.
ingestion_id	string	Ingestion ID. (pattern: <code>^[a-zA-Z0-9-_]+$</code>)
ingestion_size_in_bytes	integer (int64)	The size of the data ingested, in bytes.
ingestion_status	string	Ingestion status. (INITIALIZED, QUEUED, RUNNING, FAILED, COMPLETED, CANCELLED)
ingestion_time_in_seconds	integer (int64)	The time that this ingestion took, measured in seconds.
queue_info	object	Information about a queued dataset SPICE ingestion.
request_source	string	Event source for this ingestion. (MANUAL, SCHEDULED)
request_type	string	Type of this ingestion. (INITIAL_INGESTION, EDIT, INCREMENTAL_REFRESH, FULL_REFRESH)
row_info	object	Information about rows for a data set SPICE ingestion.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ingestion	select	aws_account_id, data_set_id, ingestion_id, region		Describes a SPICE ingestion.
list_ingestions	select	data_set_id, aws_account_id, region	next-token, max-results	Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
create_ingestion	insert	data_set_id, ingestion_id, aws_account_id, region		Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
cancel_ingestion	exec	aws_account_id, data_set_id, ingestion_id, region		Cancels an ongoing ingestion of data into SPICE.

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 Amazon Web Services account ID.
data_set_id	string	The ID of the dataset used in the ingestion.
ingestion_id	string	An ID for the ingestion.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_ingestion

Describes a SPICE ingestion.

SELECT
ingestion,
request_id,
status
FROM aws.quicksight.ingestions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND data_set_id = '{{ data_set_id }}' -- required
AND ingestion_id = '{{ ingestion_id }}' -- required
AND region = '{{ region }}' -- required
;

list_ingestions

Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.

SELECT
arn,
created_time,
error_info,
ingestion_id,
ingestion_size_in_bytes,
ingestion_status,
ingestion_time_in_seconds,
queue_info,
request_source,
request_type,
row_info
FROM aws.quicksight.ingestions
WHERE data_set_id = '{{ data_set_id }}' -- required
AND aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_ingestion

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

INSERT INTO aws.quicksight.ingestions (
IngestionType,
data_set_id,
ingestion_id,
aws_account_id,
region
)
SELECT 
'{{ IngestionType }}',
'{{ data_set_id }}',
'{{ ingestion_id }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
ingestion_id,
ingestion_status,
request_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: ingestions
props:
  - name: data_set_id
    value: "{{ data_set_id }}"
    description: Required parameter for the ingestions resource.
  - name: ingestion_id
    value: "{{ ingestion_id }}"
    description: Required parameter for the ingestions resource.
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the ingestions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ingestions resource.
  - name: IngestionType
    value: "{{ IngestionType }}"
    description: |
      This defines the type of ingestion user wants to trigger. This is part of create ingestion request.
    valid_values: ['INCREMENTAL_REFRESH', 'FULL_REFRESH']

Lifecycle Methods

cancel_ingestion

Cancels an ongoing ingestion of data into SPICE.

EXEC aws.quicksight.ingestions.cancel_ingestion 
@aws_account_id='{{ aws_account_id }}' --required, 
@data_set_id='{{ data_set_id }}' --required, 
@ingestion_id='{{ ingestion_id }}' --required, 
@region='{{ region }}' --required
;