[ aws . abuse-signal ]

create-abuse-report

Description

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

This operation is idempotent within a time window. If you provide a clientToken , duplicate requests within 24 hours return the existing report ID. If you omit it, the service generates a token scoped to 5 minutes.

Warning

Cross-Region data residency: By submitting a report, you instruct Amazon Web Services to store it in all supported Regions (us-east-1 , us-west-2 , and eu-west-2 ), including across the United States and Europe. If data must remain in a single Region, do not include it in the report.

See also: AWS API Documentation

create-abuse-report uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  create-abuse-report
--report <value>
[--correlation-id <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--report (tagged union structure) [required]

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: xarf.

xarf -> (document)

A JSON object that conforms to the XARF v4 specification. At a minimum, the document must include the XARF core fields, including the required category and type fields that classify the report (for example, category content with type phishing ). For the XARF core fields and detailed schema definitions of each report type, see the XARF v4 Technical Specification on the XARF website .

Note

Never include images, video, or copies of child sexual abuse or child sexual exploitation material in a report, in any field and for any report type. Send URLs, hash values, and reference identifiers only.

If you suspect that activity is illegal, use the XARF description field to explain why and name the laws concerned.

Testing your integration

To test your integration, add the tag lifecycle:test to the report. Amazon Web Services validates test reports and returns a report ID and status in the same way as other reports, but doesn’t process them as abuse reports. Amazon Web Services deletes test reports shortly after submission.

Use test values only, such as example.com and the IP address ranges reserved for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24). Don’t add this tag to a real abuse report.

Tag keys that begin with aws: are reserved.

JSON Syntax:

{
  "xarf": {...}
}

--correlation-id (string)

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 .

Constraints:

  • min: 1
  • max: 256
  • pattern: [a-zA-Z0-9-_]{1,256}

--client-token (string)

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.

Constraints:

  • min: 1
  • max: 128
  • pattern: [\x21-\x7E]{1,128}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

reportId -> (string)

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

Constraints:

  • min: 20
  • max: 64
  • pattern: [a-zA-Z0-9]{20,64}

correlationId -> (string)

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

Constraints:

  • min: 1
  • max: 256
  • pattern: [a-zA-Z0-9-_]{1,256}