Interface AbuseSignalAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface AbuseSignalAsyncClient extends AwsClient
Service client for accessing AWS Abuse Signal API asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Amazon Web Services Abuse Signal

Amazon Web Services Abuse Signal API provides programmatic means to report suspected abuse of Amazon Web Services resources. You can use the API to submit abuse reports about Amazon Web Services resources and to track the status of your reports. Amazon Web Services Trust & Safety uses the information that you provide to investigate and try to resolve the incident that you reported.

You submit reports in the eXtended Abuse Reporting Format (XARF), an open standard for structured abuse reporting. For more information, see XARF on the XARF website. Reports can cover a wide range of abuse categories, including spam, phishing, distributed denial of service (DDoS), malware distribution, and copyright infringement.

With the Amazon Web Services Abuse Signal API, you can:

  • Submit abuse reports – Create structured abuse reports by using the XARF format, with full support for all XARF v4 report types.

  • Track report status – Monitor the processing status of submitted reports, from submission through resolution.

  • List and filter reports – Retrieve the status of all reports, with optional filtering by correlation ID.

  • Retry submissions safely – Safely retry report submissions without creating duplicates by using client tokens.

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.

  • Field Details

  • Method Details

    • createAbuseReport

      default CompletableFuture<CreateAbuseReportResponse> createAbuseReport(CreateAbuseReportRequest createAbuseReportRequest)

      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.

      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.

      Parameters:
      createAbuseReportRequest - The input for a CreateAbuseReport request. Provide the report in XARF format, and optionally your own correlation ID and idempotency token.
      Returns:
      A Java Future containing the result of the CreateAbuseReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • 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.
      • 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.
      • ConflictException The request conflicts with the current state of the resource. For example, an idempotency token was reused with a different payload.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • createAbuseReport

      default CompletableFuture<CreateAbuseReportResponse> createAbuseReport(Consumer<CreateAbuseReportRequest.Builder> createAbuseReportRequest)

      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.

      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.


      This is a convenience which creates an instance of the CreateAbuseReportRequest.Builder avoiding the need to create one manually via CreateAbuseReportRequest.builder()

      Parameters:
      createAbuseReportRequest - A Consumer that will call methods on CreateAbuseReportRequest.Builder to create a request. The input for a CreateAbuseReport request. Provide the report in XARF format, and optionally your own correlation ID and idempotency token.
      Returns:
      A Java Future containing the result of the CreateAbuseReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • 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.
      • 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.
      • ConflictException The request conflicts with the current state of the resource. For example, an idempotency token was reused with a different payload.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getAbuseReportStatus

      default CompletableFuture<GetAbuseReportStatusResponse> getAbuseReportStatus(GetAbuseReportStatusRequest getAbuseReportStatusRequest)

      Retrieves the current processing status of a previously submitted abuse report, including the status, submission timestamp, and last-update time.

      You can poll this operation to track the report's status. PROCESSING confirms that Amazon Web Services received your report and is processing it. COMPLETED means Amazon Web Services finished resolving the report, and the response includes a reasonCode. The time to reach COMPLETED may vary and can take up to several days depending on the scope and complexity of the suspected abuse.

      COMPLETED is the only terminal status. To wait for a report, use the ReportProcessing waiter, which succeeds when the report reaches PROCESSING or COMPLETED. If you poll this operation yourself, wait 1–5 seconds between calls.

      Parameters:
      getAbuseReportStatusRequest - The input for a GetAbuseReportStatus request. Identifies the abuse report whose status you want to retrieve.
      Returns:
      A Java Future containing the result of the GetAbuseReportStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • ResourceNotFoundException The specified resource was not found. Verify that the reportId is correct.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • getAbuseReportStatus

      default CompletableFuture<GetAbuseReportStatusResponse> getAbuseReportStatus(Consumer<GetAbuseReportStatusRequest.Builder> getAbuseReportStatusRequest)

      Retrieves the current processing status of a previously submitted abuse report, including the status, submission timestamp, and last-update time.

      You can poll this operation to track the report's status. PROCESSING confirms that Amazon Web Services received your report and is processing it. COMPLETED means Amazon Web Services finished resolving the report, and the response includes a reasonCode. The time to reach COMPLETED may vary and can take up to several days depending on the scope and complexity of the suspected abuse.

      COMPLETED is the only terminal status. To wait for a report, use the ReportProcessing waiter, which succeeds when the report reaches PROCESSING or COMPLETED. If you poll this operation yourself, wait 1–5 seconds between calls.


      This is a convenience which creates an instance of the GetAbuseReportStatusRequest.Builder avoiding the need to create one manually via GetAbuseReportStatusRequest.builder()

      Parameters:
      getAbuseReportStatusRequest - A Consumer that will call methods on GetAbuseReportStatusRequest.Builder to create a request. The input for a GetAbuseReportStatus request. Identifies the abuse report whose status you want to retrieve.
      Returns:
      A Java Future containing the result of the GetAbuseReportStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • ResourceNotFoundException The specified resource was not found. Verify that the reportId is correct.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAbuseReportStatuses

      default CompletableFuture<ListAbuseReportStatusesResponse> listAbuseReportStatuses(ListAbuseReportStatusesRequest listAbuseReportStatusesRequest)

      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:
      listAbuseReportStatusesRequest - The input for a ListAbuseReportStatuses request. Use it to filter results by correlation ID and to page through them.
      Returns:
      A Java Future containing the result of the ListAbuseReportStatuses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAbuseReportStatuses

      default CompletableFuture<ListAbuseReportStatusesResponse> listAbuseReportStatuses(Consumer<ListAbuseReportStatusesRequest.Builder> listAbuseReportStatusesRequest)

      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.


      This is a convenience which creates an instance of the ListAbuseReportStatusesRequest.Builder avoiding the need to create one manually via ListAbuseReportStatusesRequest.builder()

      Parameters:
      listAbuseReportStatusesRequest - A Consumer that will call methods on ListAbuseReportStatusesRequest.Builder to create a request. The input for a ListAbuseReportStatuses request. Use it to filter results by correlation ID and to page through them.
      Returns:
      A Java Future containing the result of the ListAbuseReportStatuses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAbuseReportStatusesPaginator

      default ListAbuseReportStatusesPublisher listAbuseReportStatusesPaginator(ListAbuseReportStatusesRequest listAbuseReportStatusesRequest)

      This is a variant of listAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesPublisher publisher = client.listAbuseReportStatusesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesPublisher publisher = client.listAbuseReportStatusesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest) operation.

      Parameters:
      listAbuseReportStatusesRequest - The input for a ListAbuseReportStatuses request. Use it to filter results by correlation ID and to page through them.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • listAbuseReportStatusesPaginator

      default ListAbuseReportStatusesPublisher listAbuseReportStatusesPaginator(Consumer<ListAbuseReportStatusesRequest.Builder> listAbuseReportStatusesRequest)

      This is a variant of listAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method
       
       software.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesPublisher publisher = client.listAbuseReportStatusesPaginator(request);
       CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
       future.get();
       
       
      2) Using a custom subscriber
       
       software.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesPublisher publisher = client.listAbuseReportStatusesPaginator(request);
       publisher.subscribe(new Subscriber<software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesResponse>() {
       
       public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
       
       
       public void onNext(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesResponse response) { //... };
       });
       
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest) operation.


      This is a convenience which creates an instance of the ListAbuseReportStatusesRequest.Builder avoiding the need to create one manually via ListAbuseReportStatusesRequest.builder()

      Parameters:
      listAbuseReportStatusesRequest - A Consumer that will call methods on ListAbuseReportStatusesRequest.Builder to create a request. The input for a ListAbuseReportStatuses request. Use it to filter results by correlation ID and to page through them.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottlingException The request was denied due to request throttling. This error is retryable; retry with exponential backoff.
      • 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.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AbuseSignalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:
    • waiter

      default AbuseSignalAsyncWaiter waiter()
      Create an instance of AbuseSignalAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of AbuseSignalAsyncWaiter
    • serviceClientConfiguration

      default AbuseSignalServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration
    • create

      static AbuseSignalAsyncClient create()
      Create a AbuseSignalAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
    • builder

      Create a builder that can be used to configure and create a AbuseSignalAsyncClient.