DynamoDB / Client / list_contributor_insights

list_contributor_insights¶

DynamoDB.Client.list_contributor_insights(**kwargs)¶

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

Request Syntax

response = client.list_contributor_insights(
    TableName='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

TableName (string) – The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
NextToken (string) – A token to for the desired page, if there is one.
MaxResults (integer) – Maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'ContributorInsightsSummaries': [
        {
            'TableName': 'string',
            'IndexName': 'string',
            'ContributorInsightsStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'FAILED',
            'ContributorInsightsMode': 'ACCESSED_AND_THROTTLED_KEYS'|'THROTTLED_KEYS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ContributorInsightsSummaries (list) –
  
  A list of ContributorInsightsSummary.
  - (dict) –
    
    Represents a Contributor Insights summary entry.
    - TableName (string) –
      
      Name of the table associated with the summary.
    - IndexName (string) –
      
      Name of the index associated with the summary, if any.
    - ContributorInsightsStatus (string) –
      
      Describes the current status for contributor insights for the given table and index, if applicable.
    - ContributorInsightsMode (string) –
      
      Indicates the current mode of CloudWatch Contributor Insights, specifying whether it tracks all access and throttled events or throttled events only for the DynamoDB table or index.
- NextToken (string) –
  
  A token to go to the next page if there is one.

Exceptions

DynamoDB.Client.exceptions.ResourceNotFoundException
DynamoDB.Client.exceptions.InternalServerError