ListContributorInsightsCommand

Suggest an Edit

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

Example Syntax

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

import { DynamoDBClient, ListContributorInsightsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, ListContributorInsightsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // ListContributorInsightsInput
  TableName: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListContributorInsightsCommand(input);
const response = await client.send(command);
// { // ListContributorInsightsOutput
//   ContributorInsightsSummaries: [ // ContributorInsightsSummaries
//     { // ContributorInsightsSummary
//       TableName: "STRING_VALUE",
//       IndexName: "STRING_VALUE",
//       ContributorInsightsStatus: "ENABLING" || "ENABLED" || "DISABLING" || "DISABLED" || "FAILED",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListContributorInsightsCommand Input

See ListContributorInsightsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

Maximum number of results to return per page.

NextToken
string | undefined

A token to for the desired page, if there is one.

TableName
string | undefined

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

ListContributorInsightsCommand Output

See ListContributorInsightsCommandOutput for details

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

A list of ContributorInsightsSummary.

NextToken
string | undefined

A token to go to the next page if there is one.

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.