GetDeleteEventsByEventTypeStatusCommand

Suggest an Edit

Retrieves the status of a DeleteEventsByEventType action.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FraudDetectorClient, GetDeleteEventsByEventTypeStatusCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import
// const { FraudDetectorClient, GetDeleteEventsByEventTypeStatusCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import
const client = new FraudDetectorClient(config);
const input = { // GetDeleteEventsByEventTypeStatusRequest
  eventTypeName: "STRING_VALUE", // required
};
const command = new GetDeleteEventsByEventTypeStatusCommand(input);
const response = await client.send(command);
// { // GetDeleteEventsByEventTypeStatusResult
//   eventTypeName: "STRING_VALUE",
//   eventsDeletionStatus: "IN_PROGRESS_INITIALIZING" || "IN_PROGRESS" || "CANCEL_IN_PROGRESS" || "CANCELED" || "COMPLETE" || "FAILED",
// };

GetDeleteEventsByEventTypeStatusCommand Input

See GetDeleteEventsByEventTypeStatusCommandInput for more details

Parameter
Type
Description
eventTypeName
Required
string | undefined

Name of event type for which to get the deletion status.

GetDeleteEventsByEventTypeStatusCommand Output

See GetDeleteEventsByEventTypeStatusCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
eventTypeName
string | undefined

The event type name.

eventsDeletionStatus
AsyncJobStatus | undefined

The deletion status.

Throws

Name
Fault
Details
AccessDeniedException
client

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

InternalServerException
server

An exception indicating an internal server error.

ResourceNotFoundException
client

An exception indicating the specified resource was not found.

ThrottlingException
client

An exception indicating a throttling error.

ValidationException
client

An exception indicating a specified value is not allowed.

FraudDetectorServiceException
Base exception class for all service exceptions from FraudDetector service.