Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-contributor-insights
--table-name <value>
[--index-name <value>]
--contributor-insights-action <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--table-name
(string)
The name of the table.
--index-name
(string)
The global secondary index name, if applicable.
--contributor-insights-action
(string)
Represents the contributor insights action.
Possible values:
ENABLE
DISABLE
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To enable Contributor Insights on a table
The following update-contributor-insights
example enables Contributor Insights on the MusicCollection
table and the AlbumTitle-index
global secondary index.
aws dynamodb update-contributor-insights \
--table-name MusicCollection \
--index-name AlbumTitle-index \
--contributor-insights-action ENABLE
Output:
{
"TableName": "MusicCollection",
"IndexName": "AlbumTitle-index",
"ContributorInsightsStatus": "ENABLING"
}
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.
IndexName -> (string)
The name of the global secondary index, if applicable.
ContributorInsightsStatus -> (string)
The status of contributor insights