Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-contributor-insights
[--table-name <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--table-name
(string)
The name of the table.
--next-token
(string)
A token to for the desired page, if there is one.
--max-results
(integer)
Maximum number of results to return per page.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. 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.
Example 1: To view a list of Contributor Insights summaries
The following list-contributor-insights
example displays a list of Contributor Insights summaries.
aws dynamodb list-contributor-insights
Output:
{
"ContributorInsightsSummaries": [
{
"TableName": "MusicCollection",
"IndexName": "AlbumTitle-index",
"ContributorInsightsStatus": "ENABLED"
},
{
"TableName": "ProductCatalog",
"ContributorInsightsStatus": "ENABLED"
},
{
"TableName": "Forum",
"ContributorInsightsStatus": "ENABLED"
},
{
"TableName": "Reply",
"ContributorInsightsStatus": "ENABLED"
},
{
"TableName": "Thread",
"ContributorInsightsStatus": "ENABLED"
}
]
}
For more information, see Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB in the Amazon DynamoDB Developer Guide.
Example 2: To limit the number of items returned
The following example limits the number of items returned to 4. The response includes a NextToken
value with which to retrieve the next page of results.
aws dynamodb list-contributor-insights \
--max-results 4
Output:
{
"ContributorInsightsSummaries": [
{
"TableName": "MusicCollection",
"IndexName": "AlbumTitle-index",
"ContributorInsightsStatus": "ENABLED"
},
{
"TableName": "ProductCatalog",
"ContributorInsightsStatus": "ENABLED"
},
{
"TableName": "Forum",
"ContributorInsightsStatus": "ENABLED"
}
],
"NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9"
}
For more information, see Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB in the Amazon DynamoDB Developer Guide.
Example 3: To retrieve the next page of results
The following command uses the NextToken
value from a previous call to the list-contributor-insights
command to retrieve another page of results. Since the response in this case does not include a NextToken
value, we know that we have reached the end of the results.
aws dynamodb list-contributor-insights \
--max-results 4 \
--next-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9
Output:
{
"ContributorInsightsSummaries": [
{
"TableName": "Reply",
"ContributorInsightsStatus": "ENABLED"
},
{
"TableName": "Thread",
"ContributorInsightsStatus": "ENABLED"
}
]
}
For more information, see Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB in the Amazon DynamoDB Developer Guide.
ContributorInsightsSummaries -> (list)
A list of ContributorInsightsSummary.
(structure)
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.
NextToken -> (string)
A token to go to the next page if there is one.