ingestions

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

Overview

Name	ingestions
Type	Resource
Id	aws.appfabric.ingestions

Fields

The following fields are returned by SELECT queries:

get_ingestion

Name	Datatype	Description
app	string	The name of the application.
app_bundle_arn	string	The Amazon Resource Name (ARN) of the app bundle for the ingestion. (pattern: <code>arn:.+</code>)
arn	string	The Amazon Resource Name (ARN) of the ingestion. (pattern: <code>arn:.+</code>)
created_at	string (date-time)	The timestamp of when the ingestion was created.
ingestion_type	string	The type of the ingestion. (auditLog)
state	string	The status of the ingestion. (enabled, disabled)
tenant_id	string	The ID of the application tenant.
updated_at	string (date-time)	The timestamp of when the ingestion was last updated.

list_ingestions

Name	Datatype	Description
app	string	The name of the application.
arn	string	The Amazon Resource Name (ARN) of the ingestion. (pattern: <code>arn:.+</code>)
state	string	The status of the ingestion. (enabled, disabled)
tenant_id	string	The ID of the application tenant.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ingestion	select	app_bundle_identifier, ingestion_identifier, region		Returns information about an ingestion.
list_ingestions	select	app_bundle_identifier, region	maxResults, nextToken	Returns a list of all ingestions configured for an app bundle.
create_ingestion	insert	app_bundle_identifier, region, app, tenantId, ingestionType		Creates a data ingestion for an application.
delete_ingestion	delete	app_bundle_identifier, ingestion_identifier, region		Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.

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
app_bundle_identifier	string	The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier	string	The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
nextToken	string	If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

SELECT examples

get_ingestion

Returns information about an ingestion.

SELECT
app,
app_bundle_arn,
arn,
created_at,
ingestion_type,
state,
tenant_id,
updated_at
FROM aws.appfabric.ingestions
WHERE app_bundle_identifier = '{{ app_bundle_identifier }}' -- required
AND ingestion_identifier = '{{ ingestion_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_ingestions

Returns a list of all ingestions configured for an app bundle.

SELECT
app,
arn,
state,
tenant_id
FROM aws.appfabric.ingestions
WHERE app_bundle_identifier = '{{ app_bundle_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_ingestion

Creates a data ingestion for an application.

INSERT INTO aws.appfabric.ingestions (
app,
tenantId,
ingestionType,
clientToken,
tags,
app_bundle_identifier,
region
)
SELECT 
'{{ app }}' /* required */,
'{{ tenantId }}' /* required */,
'{{ ingestionType }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ app_bundle_identifier }}',
'{{ region }}'
RETURNING
ingestion
;

Manifest

# Description fields are for documentation purposes
- name: ingestions
props:
  - name: app_bundle_identifier
    value: "{{ app_bundle_identifier }}"
    description: Required parameter for the ingestions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ingestions resource.
  - name: app
    value: "{{ app }}"
  - name: tenantId
    value: "{{ tenantId }}"
  - name: ingestionType
    value: "{{ ingestionType }}"
    valid_values: ['auditLog']
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

DELETE examples

delete_ingestion

Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.

DELETE FROM aws.appfabric.ingestions
WHERE app_bundle_identifier = '{{ app_bundle_identifier }}' --required
AND ingestion_identifier = '{{ ingestion_identifier }}' --required
AND region = '{{ region }}' --required
;