Skip to content

DynamoDB  >  Operations  >  describe_contributor_insights

describe_contributor_insights

Operation

describe_contributor_insights async 

describe_contributor_insights(input: DescribeContributorInsightsInput, plugins: list[Plugin] | None = None) -> DescribeContributorInsightsOutput

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

Parameters:

Name Type Description Default
input DescribeContributorInsightsInput

An instance of DescribeContributorInsightsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeContributorInsightsOutput

An instance of DescribeContributorInsightsOutput.

Input

DescribeContributorInsightsInput dataclass

Dataclass for DescribeContributorInsightsInput structure.

Attributes

index_name class-attribute instance-attribute 
index_name: str | None = None

The name of the global secondary index to describe, if applicable.

table_name class-attribute instance-attribute 
table_name: str | None = None

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Output

DescribeContributorInsightsOutput dataclass

Dataclass for DescribeContributorInsightsOutput structure.

Attributes

contributor_insights_mode class-attribute instance-attribute 
contributor_insights_mode: ContributorInsightsMode | None = None

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.

contributor_insights_rule_list class-attribute instance-attribute 
contributor_insights_rule_list: list[str] | None = None

List of names of the associated contributor insights rules.

contributor_insights_status class-attribute instance-attribute 
contributor_insights_status: ContributorInsightsStatus | None = None

Current status of contributor insights.

failure_exception class-attribute instance-attribute 
failure_exception: FailureException | None = None

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 class-attribute instance-attribute 
index_name: str | None = None

The name of the global secondary index being described.

last_update_date_time class-attribute instance-attribute 
last_update_date_time: datetime | None = None

Timestamp of the last time the status was changed.

table_name class-attribute instance-attribute 
table_name: str | None = None

The name of the table being described.