View a markdown version of this page

CreateAbuseReport - AWS Abuse Signal API

CreateAbuseReport

Submits a structured report. AWS validates it and returns a report ID. A successful response confirms that AWS received your report. It doesn't mean that AWS has reached an outcome. Use GetAbuseReportStatus with the report ID to check the report's status and outcome.

Request Syntax

POST /v1/abuse HTTP/1.1 Content-type: application/json { "clientToken": "string", "correlationId": "string", "report": { ... } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\x21-\x7E]{1,128}

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9-_]{1,256}

Required: No

report

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

Type: ReportData object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax

HTTP/1.1 202 Content-type: application/json { "correlationId": "string", "reportId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

correlationId

The correlation ID that you provided in the request, if any. The service echoes this value back in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9-_]{1,256}

reportId

The unique identifier assigned to the submitted abuse report. Use this ID with GetAbuseReportStatus to track processing.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 64.

Pattern: [a-zA-Z0-9]{20,64}

Errors

For information about the errors that are common to all actions, see Common Error Types.

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.

message

A description of the access-denied error.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. For example, an idempotency token was reused with a different payload.

message

A description of the conflict.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of the request. This error is retryable; check the Retry-After header before you retry.

message

A description of the error.

retryAfterSeconds

The number of seconds to wait before you retry the request. The service also returns this value in the Retry-After HTTP header.

HTTP Status Code: 500

SubmissionRequirementException

The report is well-formed and satisfies the XARF schema, but it does not meet one or more submission requirements (for example, the submission lookback window or source_identifier restrictions). This error is distinct from ValidationException (HTTP 400), which indicates that the report is not well-formed. Retrying the same report will not succeed; the report content must change.

message

A summary of the unmet submission requirements.

unmetRequirements

A list of the specific submission requirements that the report did not meet.

HTTP Status Code: 422

ThrottlingException

The request was denied due to request throttling. This error is retryable; retry with exponential backoff.

message

A description of the throttling error.

quotaCode

The code for the service quota that was exceeded.

retryAfterSeconds

The number of seconds to wait before you retry the request. The service also returns this value in the Retry-After HTTP header.

serviceCode

The code for the AWS service that is associated with the quota that was exceeded.

HTTP Status Code: 429

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.

fieldList

A list of the specific input fields that failed validation.

message

A summary of the validation failure.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: