describe_contributor_insights¶
Operation¶
describe_contributor_insights
¶
describe_contributor_insights(request: DescribeContributorInsightsInput | DescribeContributorInsightsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeContributorInsightsInputDict]) -> DescribeContributorInsightsOutput
Returns information about contributor insights for a given table or global secondary index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeContributorInsightsInput | DescribeContributorInsightsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeContributorInsightsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeContributorInsightsOutput
|
An instance of |
describe_contributor_insights
async
¶
describe_contributor_insights(request: DescribeContributorInsightsInput | DescribeContributorInsightsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeContributorInsightsInputDict]) -> DescribeContributorInsightsOutput
Returns information about contributor insights for a given table or global secondary index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeContributorInsightsInput | DescribeContributorInsightsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeContributorInsightsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeContributorInsightsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DescribeContributorInsightsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeContributorInsightsOutput structure.
Attributes¶
contributor_insights_mode
class-attribute
instance-attribute
¶
contributor_insights_mode: str | None = ...
The mode of CloudWatch Contributor Insights for DynamoDB that determines which events are emitted. Can be set to track all access and throttled events or throttled events only.
contributor_insights_rule_list
class-attribute
instance-attribute
¶
List of names of the associated contributor insights rules.
contributor_insights_status
class-attribute
instance-attribute
¶
contributor_insights_status: str | None = ...
Current status of contributor insights.
failure_exception
class-attribute
instance-attribute
¶
failure_exception: FailureException | None = ...
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.
index_name
class-attribute
instance-attribute
¶
index_name: str | None = ...
The name of the global secondary index being described.
last_update_date_time
class-attribute
instance-attribute
¶
last_update_date_time: datetime | None = ...
Timestamp of the last time the status was changed.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.