Interface AbuseSignalClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic AbuseSignalClientBuilderbuilder()Create a builder that can be used to configure and create aAbuseSignalClient.static AbuseSignalClientcreate()Create aAbuseSignalClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAbuseReportResponsecreateAbuseReport(Consumer<CreateAbuseReportRequest.Builder> createAbuseReportRequest) Submits a structured report.default CreateAbuseReportResponsecreateAbuseReport(CreateAbuseReportRequest createAbuseReportRequest) Submits a structured report.default GetAbuseReportStatusResponsegetAbuseReportStatus(Consumer<GetAbuseReportStatusRequest.Builder> getAbuseReportStatusRequest) Retrieves the current processing status of a previously submitted abuse report, including the status, submission timestamp, and last-update time.default GetAbuseReportStatusResponsegetAbuseReportStatus(GetAbuseReportStatusRequest getAbuseReportStatusRequest) Retrieves the current processing status of a previously submitted abuse report, including the status, submission timestamp, and last-update time.default ListAbuseReportStatusesResponselistAbuseReportStatuses(Consumer<ListAbuseReportStatusesRequest.Builder> listAbuseReportStatusesRequest) Lists abuse report statuses for the calling account, ordered by submission time, with optional filtering and pagination.default ListAbuseReportStatusesResponselistAbuseReportStatuses(ListAbuseReportStatusesRequest listAbuseReportStatusesRequest) Lists abuse report statuses for the calling account, ordered by submission time, with optional filtering and pagination.default ListAbuseReportStatusesIterablelistAbuseReportStatusesPaginator(Consumer<ListAbuseReportStatusesRequest.Builder> listAbuseReportStatusesRequest) This is a variant oflistAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest)operation.default ListAbuseReportStatusesIterablelistAbuseReportStatusesPaginator(ListAbuseReportStatusesRequest listAbuseReportStatusesRequest) This is a variant oflistAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault AbuseSignalWaiterwaiter()Create an instance ofAbuseSignalWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createAbuseReport
default CreateAbuseReportResponse createAbuseReport(CreateAbuseReportRequest createAbuseReportRequest) throws ThrottlingException, SubmissionRequirementException, AccessDeniedException, InternalServerException, ValidationException, ConflictException, AwsServiceException, SdkClientException, AbuseSignalException 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, andeu-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:
- Result of the CreateAbuseReport operation returned by the service.
- See Also:
-
createAbuseReport
default CreateAbuseReportResponse createAbuseReport(Consumer<CreateAbuseReportRequest.Builder> createAbuseReportRequest) throws ThrottlingException, SubmissionRequirementException, AccessDeniedException, InternalServerException, ValidationException, ConflictException, AwsServiceException, SdkClientException, AbuseSignalException 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, andeu-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.Builderavoiding the need to create one manually viaCreateAbuseReportRequest.builder()- Parameters:
createAbuseReportRequest- AConsumerthat will call methods onCreateAbuseReportRequest.Builderto 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:
- Result of the CreateAbuseReport operation returned by the service.
- See Also:
-
getAbuseReportStatus
default GetAbuseReportStatusResponse getAbuseReportStatus(GetAbuseReportStatusRequest getAbuseReportStatusRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, AbuseSignalException 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.
PROCESSINGconfirms that Amazon Web Services received your report and is processing it.COMPLETEDmeans Amazon Web Services finished resolving the report, and the response includes areasonCode. The time to reachCOMPLETEDmay vary and can take up to several days depending on the scope and complexity of the suspected abuse.COMPLETEDis the only terminal status. To wait for a report, use theReportProcessingwaiter, which succeeds when the report reachesPROCESSINGorCOMPLETED. 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:
- Result of the GetAbuseReportStatus operation returned by the service.
- See Also:
-
getAbuseReportStatus
default GetAbuseReportStatusResponse getAbuseReportStatus(Consumer<GetAbuseReportStatusRequest.Builder> getAbuseReportStatusRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, AbuseSignalException 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.
PROCESSINGconfirms that Amazon Web Services received your report and is processing it.COMPLETEDmeans Amazon Web Services finished resolving the report, and the response includes areasonCode. The time to reachCOMPLETEDmay vary and can take up to several days depending on the scope and complexity of the suspected abuse.COMPLETEDis the only terminal status. To wait for a report, use theReportProcessingwaiter, which succeeds when the report reachesPROCESSINGorCOMPLETED. If you poll this operation yourself, wait 1–5 seconds between calls.
This is a convenience which creates an instance of the
GetAbuseReportStatusRequest.Builderavoiding the need to create one manually viaGetAbuseReportStatusRequest.builder()- Parameters:
getAbuseReportStatusRequest- AConsumerthat will call methods onGetAbuseReportStatusRequest.Builderto create a request. The input for a GetAbuseReportStatus request. Identifies the abuse report whose status you want to retrieve.- Returns:
- Result of the GetAbuseReportStatus operation returned by the service.
- See Also:
-
listAbuseReportStatuses
default ListAbuseReportStatusesResponse listAbuseReportStatuses(ListAbuseReportStatusesRequest listAbuseReportStatusesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, AbuseSignalException Lists abuse report statuses for the calling account, ordered by submission time, with optional filtering and pagination.
Use the
correlationIdparameter to filter results by the reporter-provided correlation ID that was specified during report submission.Results are paginated. Use
nextTokento 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:
- Result of the ListAbuseReportStatuses operation returned by the service.
- See Also:
-
listAbuseReportStatuses
default ListAbuseReportStatusesResponse listAbuseReportStatuses(Consumer<ListAbuseReportStatusesRequest.Builder> listAbuseReportStatusesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, AbuseSignalException Lists abuse report statuses for the calling account, ordered by submission time, with optional filtering and pagination.
Use the
correlationIdparameter to filter results by the reporter-provided correlation ID that was specified during report submission.Results are paginated. Use
nextTokento retrieve additional results.
This is a convenience which creates an instance of the
ListAbuseReportStatusesRequest.Builderavoiding the need to create one manually viaListAbuseReportStatusesRequest.builder()- Parameters:
listAbuseReportStatusesRequest- AConsumerthat will call methods onListAbuseReportStatusesRequest.Builderto create a request. The input for a ListAbuseReportStatuses request. Use it to filter results by correlation ID and to page through them.- Returns:
- Result of the ListAbuseReportStatuses operation returned by the service.
- See Also:
-
listAbuseReportStatusesPaginator
default ListAbuseReportStatusesIterable listAbuseReportStatusesPaginator(ListAbuseReportStatusesRequest listAbuseReportStatusesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, AbuseSignalException This is a variant of
listAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesIterable responses = client.listAbuseReportStatusesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesIterable responses = client .listAbuseReportStatusesPaginator(request); for (software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesIterable responses = client.listAbuseReportStatusesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listAbuseReportStatusesPaginator
default ListAbuseReportStatusesIterable listAbuseReportStatusesPaginator(Consumer<ListAbuseReportStatusesRequest.Builder> listAbuseReportStatusesRequest) throws ThrottlingException, AccessDeniedException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, AbuseSignalException This is a variant of
listAbuseReportStatuses(software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesIterable responses = client.listAbuseReportStatusesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesIterable responses = client .listAbuseReportStatusesPaginator(request); for (software.amazon.awssdk.services.abusesignal.model.ListAbuseReportStatusesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.abusesignal.paginators.ListAbuseReportStatusesIterable responses = client.listAbuseReportStatusesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListAbuseReportStatusesRequest.builder()- Parameters:
listAbuseReportStatusesRequest- AConsumerthat will call methods onListAbuseReportStatusesRequest.Builderto 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 iterable that can be used to iterate through all the response pages.
- See Also:
-
waiter
Create an instance ofAbuseSignalWaiterusing 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
AbuseSignalWaiter
-
create
Create aAbuseSignalClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aAbuseSignalClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-