DescribeContributorInsightsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, DescribeContributorInsightsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DescribeContributorInsightsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DescribeContributorInsightsInput
  TableName: "STRING_VALUE", // required
  IndexName: "STRING_VALUE",
};
const command = new DescribeContributorInsightsCommand(input);
const response = await client.send(command);
// { // DescribeContributorInsightsOutput
//   TableName: "STRING_VALUE",
//   IndexName: "STRING_VALUE",
//   ContributorInsightsRuleList: [ // ContributorInsightsRuleList
//     "STRING_VALUE",
//   ],
//   ContributorInsightsStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "FAILED",
//   LastUpdateDateTime: new Date("TIMESTAMP"),
//   FailureException: { // FailureException
//     ExceptionName: "STRING_VALUE",
//     ExceptionDescription: "STRING_VALUE",
//   },
// };

DescribeContributorInsightsCommand Input

See DescribeContributorInsightsCommandInput for more details

Parameter
Type
Description
TableName
Required
string | undefined

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

IndexName
string | undefined

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

DescribeContributorInsightsCommand Output

See DescribeContributorInsightsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ContributorInsightsRuleList
string[] | undefined

List of names of the associated contributor insights rules.

ContributorInsightsStatus
ContributorInsightsStatus | undefined

Current status of contributor insights.

FailureException
FailureException | undefined

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.

IndexName
string | undefined

The name of the global secondary index being described.

LastUpdateDateTime
Date | undefined

Timestamp of the last time the status was changed.

TableName
string | undefined

The name of the table being described.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

ResourceNotFoundException
client

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.