DynamoDB / Client / describe_contributor_insights

describe_contributor_insights#

DynamoDB.Client.describe_contributor_insights(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_contributor_insights(
    TableName='string',
    IndexName='string'
)
Parameters:

  • TableName (string) –

    [REQUIRED]

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

  • IndexName (string) – The name of the global secondary index to describe, if applicable.

Return type:

dict

Returns:

Response Syntax

{
    'TableName': 'string',
    'IndexName': 'string',
    'ContributorInsightsRuleList': [
        'string',
    ],
    'ContributorInsightsStatus': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'FAILED',
    'LastUpdateDateTime': datetime(2015, 1, 1),
    'FailureException': {
        'ExceptionName': 'string',
        'ExceptionDescription': 'string'
    }
}

Response Structure

  • (dict) –

    • TableName (string) –

      The name of the table being described.

    • IndexName (string) –

      The name of the global secondary index being described.

    • ContributorInsightsRuleList (list) –

      List of names of the associated contributor insights rules.

      • (string) –

    • ContributorInsightsStatus (string) –

      Current status of contributor insights.

    • LastUpdateDateTime (datetime) –

      Timestamp of the last time the status was changed.

    • FailureException (dict) –

      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.

      • ExceptionName (string) –

        Exception name.

      • ExceptionDescription (string) –

        Description of the failure.

Exceptions

  • DynamoDB.Client.exceptions.ResourceNotFoundException

  • DynamoDB.Client.exceptions.InternalServerError