[ aws . dynamodb ]

describe-contributor-insights

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-contributor-insights
--table-name <value>
[--index-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--table-name (string)

The name of the table to describe.

--index-name (string)

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

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view Contributor Insights settings for a DynamoDB table

The following describe-contributor-insights example displays the Contributor Insights settings for the MusicCollection table.

aws dynamodb describe-contributor-insights \
    --table-name MusicCollection

Output:

{
    "TableName": "MusicCollection",
    "ContributorInsightsRuleList": [
        "DynamoDBContributorInsights-PKC-MusicCollection-1576629651520",
        "DynamoDBContributorInsights-SKC-MusicCollection-1576629651520",
        "DynamoDBContributorInsights-PKT-MusicCollection-1576629651520",
        "DynamoDBContributorInsights-SKT-MusicCollection-1576629651520"
    ],
    "ContributorInsightsStatus": "ENABLED",
    "LastUpdateDateTime": 1576629654.78
}

For more information, see Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB in the Amazon DynamoDB Developer Guide.

Output

TableName -> (string)

The name of the table being described.

IndexName -> (string)

The name of the global secondary index being described.

ContributorInsightsRuleList -> (list)

List of names of the associated Alpine rules.

(string)

ContributorInsightsStatus -> (string)

Current Status contributor insights.

LastUpdateDateTime -> (timestamp)

Timestamp of the last time the status was changed.

FailureException -> (structure)

Returns information about the last failure that 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.

ExceptionName -> (string)

Exception name.

ExceptionDescription -> (string)

Description of the failure.