contributor_insights

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

Overview

Name	contributor_insights
Type	Resource
Id	aws.dynamodb.contributor_insights

Fields

The following fields are returned by SELECT queries:

describe_contributor_insights

Name	Datatype	Description
contributor_insights_mode	string	The mode of CloudWatch Contributor Insights for DynamoDB that determines which events are emitted. Can be set to track all access and throttled events or throttled events only. (ACCESSED_AND_THROTTLED_KEYS, THROTTLED_KEYS)
contributor_insights_rule_list	array	List of names of the associated contributor insights rules.
contributor_insights_status	string	Current status of contributor insights. (ENABLING, ENABLED, DISABLING, DISABLED, FAILED)
failure_exception	object	Returns information about the last failure that was encountered. The most common exceptions for a FAILED status are: LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying. AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions. AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions. InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
index_name	string	The name of the global secondary index being described. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
last_update_date_time	string (date-time)	Timestamp of the last time the status was changed.
table_name	string	The name of the table being described. (pattern: <code>[a-zA-Z0-9_.-]+</code>)

list_contributor_insights

Name	Datatype	Description
contributor_insights_summaries	array	A list of ContributorInsightsSummary.
next_token	string	A token to go to the next page if there is one.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_contributor_insights	select	region		Returns information about contributor insights for a given table or global secondary index.
list_contributor_insights	select	region		Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
update_contributor_insights	update	region, TableName, ContributorInsightsAction		Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_contributor_insights

Returns information about contributor insights for a given table or global secondary index.

SELECT
contributor_insights_mode,
contributor_insights_rule_list,
contributor_insights_status,
failure_exception,
index_name,
last_update_date_time,
table_name
FROM aws.dynamodb.contributor_insights
WHERE region = '{{ region }}' -- required
;

list_contributor_insights

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

SELECT
contributor_insights_summaries,
next_token
FROM aws.dynamodb.contributor_insights
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_contributor_insights

Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.

UPDATE aws.dynamodb.contributor_insights
SET 
TableName = '{{ TableName }}',
IndexName = '{{ IndexName }}',
ContributorInsightsAction = '{{ ContributorInsightsAction }}',
ContributorInsightsMode = '{{ ContributorInsightsMode }}'
WHERE 
region = '{{ region }}' --required
AND TableName = '{{ TableName }}' --required
AND ContributorInsightsAction = '{{ ContributorInsightsAction }}' --required
RETURNING
contributor_insights_mode,
contributor_insights_status,
index_name,
table_name;