list_contributor_insights ¶

list_contributor_insights(
    *,
    config_overrides: Optional[DynamoDBClientConfig] = None,
    table_name: Optional[TableArn] = None,
    next_token: Optional[NextTokenString] = None,
    max_results: Optional[ListContributorInsightsLimit] = None,
) -> ListContributorInsightsOutput

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

Parameters:

table_name (Optional[TableArn], default: None ) –

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
next_token (Optional[NextTokenString], default: None ) –

A token to for the desired page, if there is one.
max_results (Optional[ListContributorInsightsLimit], default: None ) –

Maximum number of results to return per page.

Raises:

InternalServerError –

An error occurred on the server side.
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.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_dynamodb/_services/dynamo_db.py

def list_contributor_insights(
    self,
    *,
    config_overrides: Optional[DynamoDBClientConfig] = None,
    table_name: Optional["capo_dynamodb.types.table_arn.TableArn"] = None,
    next_token: Optional[
        "capo_dynamodb.types.next_token_string.NextTokenString"
    ] = None,
    max_results: Optional[
        "capo_dynamodb.types.list_contributor_insights_limit.ListContributorInsightsLimit"
    ] = None,
) -> "capo_dynamodb.types.list_contributor_insights_output.ListContributorInsightsOutput":
    """<p>Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.</p>

    Args:
        table_name: <p>The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
        next_token: <p>A token to for the desired page, if there is one.</p>
        max_results: <p>Maximum number of results to return per page.</p>

    Raises:
        capo_dynamodb.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_dynamodb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
        capo_dynamodb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_dynamodb.types.list_contributor_insights_input.ListContributorInsightsInput]",
    ) -> OperationResponse[
        "capo_dynamodb.types.list_contributor_insights_output.ListContributorInsightsOutput"
    ]:
        import capo_dynamodb._operations.dynamo_db_20120810.list_contributor_insights

        output, http_response = (
            capo_dynamodb._operations.dynamo_db_20120810.list_contributor_insights.list_contributor_insights(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListContributorInsights")
    )
    input_: capo_dynamodb.types.list_contributor_insights_input.ListContributorInsightsInput = {}
    if table_name is not None:
        input_["table_name"] = table_name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output