Skip to content

DescribeContributorInsightsOutput

Source code in docs_src/capo_dynamodb/types/describe_contributor_insights_output.py
class DescribeContributorInsightsOutput(TypedDict, closed=True):
    table_name: NotRequired["capo_dynamodb.types.table_name.TableName"]
    """<p>The name of the table being described.</p>"""
    index_name: NotRequired["capo_dynamodb.types.index_name.IndexName"]
    """<p>The name of the global secondary index being described.</p>"""
    contributor_insights_rule_list: NotRequired[
        "capo_dynamodb.types.contributor_insights_rule_list.ContributorInsightsRuleList"
    ]
    """<p>List of names of the associated contributor insights rules.</p>"""
    contributor_insights_status: NotRequired[
        "capo_dynamodb.types.contributor_insights_status.ContributorInsightsStatus"
    ]
    """<p>Current status of contributor insights.</p>"""
    last_update_date_time: NotRequired[
        "capo_dynamodb.types.last_update_date_time.LastUpdateDateTime"
    ]
    """<p>Timestamp of the last time the status was changed.</p>"""
    failure_exception: NotRequired[
        "capo_dynamodb.types.failure_exception.FailureException"
    ]
    """<p>Returns information about the last failure that was encountered.</p> <p>The most common exceptions for a FAILED status are:</p> <ul> <li> <p>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.</p> </li> <li> <p>AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.</p> </li> <li> <p>AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.</p> </li> <li> <p>InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.</p> </li> </ul>"""
    contributor_insights_mode: NotRequired[
        "capo_dynamodb.types.contributor_insights_mode.ContributorInsightsMode"
    ]
    """<p>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.</p>"""

contributor_insights_mode instance-attribute

contributor_insights_mode: NotRequired[ContributorInsightsMode]

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 instance-attribute

contributor_insights_rule_list: NotRequired[ContributorInsightsRuleList]

List of names of the associated contributor insights rules.

contributor_insights_status instance-attribute

contributor_insights_status: NotRequired[ContributorInsightsStatus]

Current status of contributor insights.

failure_exception instance-attribute

failure_exception: NotRequired[FailureException]

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 instance-attribute

index_name: NotRequired[IndexName]

The name of the global secondary index being described.

last_update_date_time instance-attribute

last_update_date_time: NotRequired[LastUpdateDateTime]

Timestamp of the last time the status was changed.

table_name instance-attribute

table_name: NotRequired[TableName]

The name of the table being described.