UpdateContributorInsights
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 AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
Request Syntax
{
"ContributorInsightsAction": "string
",
"IndexName": "string
",
"TableName": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- ContributorInsightsAction
-
Represents the contributor insights action.
Type: String
Valid Values:
ENABLE | DISABLE
Required: Yes
- TableName
-
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- IndexName
-
The global secondary index name, if applicable.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
Response Syntax
{
"ContributorInsightsStatus": "string",
"IndexName": "string",
"TableName": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ContributorInsightsStatus
-
The status of contributor insights
Type: String
Valid Values:
ENABLING | ENABLED | DISABLING | DISABLED | FAILED
- IndexName
-
The name of the global secondary index, if applicable.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
- TableName
-
The name of the table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: