Lists abuse report statuses for the calling account, ordered by submission time, with optional filtering and pagination.
Use the correlationId parameter to filter results by the reporter-provided correlation ID that was specified during report submission.
Results are paginated. Use nextToken to retrieve additional results.
Parameters:
-
correlation_id
(Optional[CorrelationId], default:
None
)
–
Filters results by the reporter-provided correlation ID.
-
next_token
(Optional[NextToken], default:
None
)
–
The pagination token for retrieving the next page of results. Omit this parameter to return the first page of results.
-
max_results
(Optional[int], default:
None
)
–
The maximum number of results to return in a single page. Valid range: 1–50. The default is 50.
Raises:
-
AccessDeniedException
–
The caller does not have sufficient access to perform this operation. Verify that the caller has the specific IAM permission for the operation it is calling (for example, abuse:CreateAbuseReport, abuse:GetAbuseReportStatus, or abuse:ListAbuseReportStatuses). Grant only the actions each caller requires.
-
InternalServerException
–
An unexpected error occurred during the processing of the request. This error is retryable; check the Retry-After header before you retry.
-
ThrottlingException
–
The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
-
ValidationException
–
The input fails to satisfy the constraints specified by the service, which indicates that the request is not well-formed. Check fieldList for the specific members that failed validation.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
List abuse report statuses
>>> client.list_abuse_report_statuses()
Source code in docs_src/capo_abuse_signal/_services/abuse_signal.py
| def list_abuse_report_statuses(
self,
*,
config_overrides: Optional[AbuseSignalClientConfig] = None,
correlation_id: Optional[
"capo_abuse_signal.types.correlation_id.CorrelationId"
] = None,
next_token: Optional["capo_abuse_signal.types.next_token.NextToken"] = None,
max_results: Optional[int] = None,
) -> "capo_abuse_signal.types.list_abuse_report_statuses_response.ListAbuseReportStatusesResponse":
"""<p>Lists abuse report statuses for the calling account, ordered by submission time, with optional filtering and pagination.</p> <p>Use the <code>correlationId</code> parameter to filter results by the reporter-provided correlation ID that was specified during report submission.</p> <p>Results are paginated. Use <code>nextToken</code> to retrieve additional results.</p>
Args:
correlation_id: <p>Filters results by the reporter-provided correlation ID.</p>
next_token: <p>The pagination token for retrieving the next page of results. Omit this parameter to return the first page of results.</p>
max_results: <p>The maximum number of results to return in a single page. Valid range: 1–50. The default is 50.</p>
Raises:
capo_abuse_signal.errors.access_denied_exception.AccessDeniedException: <p>The caller does not have sufficient access to perform this operation. Verify that the caller has the specific IAM permission for the operation it is calling (for example, <code>abuse:CreateAbuseReport</code>, <code>abuse:GetAbuseReportStatus</code>, or <code>abuse:ListAbuseReportStatuses</code>). Grant only the actions each caller requires.</p>
capo_abuse_signal.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request. This error is retryable; check the <code>Retry-After</code> header before you retry.</p>
capo_abuse_signal.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. This error is retryable; retry with exponential backoff.</p>
capo_abuse_signal.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service, which indicates that the request is not well-formed. Check <code>fieldList</code> for the specific members that failed validation.</p>
capo_abuse_signal.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
List abuse report statuses
>>> client.list_abuse_report_statuses()
"""
def _handler(
req: "OperationRequest[capo_abuse_signal.types.list_abuse_report_statuses_request.ListAbuseReportStatusesRequest]",
) -> OperationResponse[
"capo_abuse_signal.types.list_abuse_report_statuses_response.ListAbuseReportStatusesResponse"
]:
import capo_abuse_signal._operations.abuse_report_api.list_abuse_report_statuses
output, http_response = (
capo_abuse_signal._operations.abuse_report_api.list_abuse_report_statuses.list_abuse_report_statuses(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAbuseReportStatuses")
)
input_: capo_abuse_signal.types.list_abuse_report_statuses_request.ListAbuseReportStatusesRequest = {}
if correlation_id is not None:
input_["correlation_id"] = correlation_id
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
|