Skip to content

CreateAbuseReportRequest

Source code in docs_src/capo_abuse_signal/types/create_abuse_report_request.py
class CreateAbuseReportRequest(TypedDict, closed=True):
    report: "capo_abuse_signal.types.report_data.ReportData"
    """<p>The abuse report data in XARF format. Provide the report under the <code>xarf</code> key.</p>"""
    correlation_id: NotRequired["capo_abuse_signal.types.correlation_id.CorrelationId"]
    """<p>An optional correlation ID for tracking the report in the reporter's system. The service echoes this value back in responses, and you can use it to filter reports with <a>ListAbuseReportStatuses</a>.</p>"""
    client_token: NotRequired["capo_abuse_signal.types.client_token.ClientToken"]
    """<p>An optional, client-provided idempotency token that ensures the operation completes no more than once. If the token matches a previous request within 24 hours, the service returns the existing report ID instead of creating a new report. When you omit this token, the service automatically generates one that is scoped to a 5-minute window.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

An optional, client-provided idempotency token that ensures the operation completes no more than once. If the token matches a previous request within 24 hours, the service returns the existing report ID instead of creating a new report. When you omit this token, the service automatically generates one that is scoped to a 5-minute window.

correlation_id instance-attribute

correlation_id: NotRequired[CorrelationId]

An optional correlation ID for tracking the report in the reporter's system. The service echoes this value back in responses, and you can use it to filter reports with ListAbuseReportStatuses.

report instance-attribute

report: ReportData

The abuse report data in XARF format. Provide the report under the xarf key.