analysis_log_exports

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

Overview

Name	analysis_log_exports
Type	Resource
Id	aws.cleanrooms.analysis_log_exports

Fields

The following fields are returned by SELECT queries:

get_analysis_log_export

Name	Datatype	Description
analysis_id	string	The unique identifier of the protected query that the analysis logs were exported for. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
analysis_log_export_id	string	The unique identifier of the analysis log export. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
analysis_type	string	The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported. (PROTECTED_QUERY)
create_time	string (date-time)	The time the analysis log export was created.
error	object	The analysis log export error. This is present only when the export status is FAILED.
membership_id	string	The unique identifier of the membership that the analysis log export belongs to. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
result_configuration	object	Contains the details needed to write the exported analysis logs.
status	string	The status of the analysis log export. Possible values are: IN_PROGRESS – The export is currently running. SUCCESS – The export completed successfully. FAILED – The export failed. See the error field for details. (IN_PROGRESS, SUCCESS, FAILED)
update_time	string (date-time)	The time the analysis log export was last updated.

list_analysis_log_exports

Name	Datatype	Description
analysis_id	string	The unique identifier of the protected query that the analysis logs were exported for. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
analysis_log_export_id	string	The unique identifier of the analysis log export. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
analysis_type	string	The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported. (PROTECTED_QUERY)
create_time	string (date-time)	The time the analysis log export was created.
status	string	The status of the analysis log export. Possible values are: IN_PROGRESS – The export is currently running. SUCCESS – The export completed successfully. FAILED – The export failed. (IN_PROGRESS, SUCCESS, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_analysis_log_export	select	membership_identifier, analysis_log_export_identifier, region		Returns information about an analysis log export, including its current status and, if the export failed, the reason for the failure. Poll this operation until the status is SUCCESS or FAILED. An export can't be canceled after it starts.
list_analysis_log_exports	select	membership_identifier, region	analysisIdentifier, status, nextToken, maxResults	Lists analysis log exports, sorted by the most recent export. Results are paginated. Use the nextToken parameter to retrieve additional results.

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
analysis_log_export_identifier	string	The unique identifier of the analysis log export to retrieve.
membership_identifier	string	A unique identifier for the membership to list analysis log exports for. Currently accepts the membership ID.
region	string	AWS region (default: us-east-1)
analysisIdentifier	string	A filter on the unique identifier of the protected query that the analysis logs were exported for.
maxResults	integer	The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
nextToken	string	The pagination token that's used to fetch the next set of results.
status	string	A filter on the status of the analysis log export.

SELECT examples

get_analysis_log_export

Returns information about an analysis log export, including its current status and, if the export failed, the reason for the failure. Poll this operation until the status is SUCCESS or FAILED. An export can't be canceled after it starts.

SELECT
analysis_id,
analysis_log_export_id,
analysis_type,
create_time,
error,
membership_id,
result_configuration,
status,
update_time
FROM aws.cleanrooms.analysis_log_exports
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND analysis_log_export_identifier = '{{ analysis_log_export_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_analysis_log_exports

Lists analysis log exports, sorted by the most recent export. Results are paginated. Use the nextToken parameter to retrieve additional results.

SELECT
analysis_id,
analysis_log_export_id,
analysis_type,
create_time,
status
FROM aws.cleanrooms.analysis_log_exports
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
AND analysisIdentifier = '{{ analysisIdentifier }}'
AND status = '{{ status }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;