Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dynamodb ]



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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--table-name <value>
[--index-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--table-name (string)

The name of the table to describe.

--index-name (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To view Contributor Insights settings for a DynamoDB table

The following describe-contributor-insights example displays the Contributor Insights settings for the MusicCollection table and the AlbumTitle-index global secondary index.

aws dynamodb describe-contributor-insights \
    --table-name MusicCollection \
    --index-name AlbumTitle-index


    "TableName": "MusicCollection",
    "IndexName": "AlbumTitle-index",
    "ContributorInsightsRuleList": [
    "ContributorInsightsStatus": "ENABLED",
    "LastUpdateDateTime": 1576629654.78

For more information, see Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB in the Amazon DynamoDB Developer Guide.


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.


ContributorInsightsStatus -> (string)

Current status of contributor insights.

LastUpdateDateTime -> (timestamp)

Timestamp of the last time the status was changed.

FailureException -> (structure)

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.