View Source AWS.FraudDetector (aws-elixir v1.0.4)
This is the Amazon Fraud Detector API Reference.
This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP
verb GET or POST and a Query parameter Action. AWS SDK provides libraries,
sample code, tutorials, and other resources for software developers who prefer
to build applications using language-specific APIs instead of submitting a
request over
HTTP or HTTPS. These libraries provide basic functions that automatically take
care of tasks such as cryptographically signing your requests, retrying
requests, and
handling error responses, so that it is easier for you to get started. For more
information about the AWS SDKs, go to Tools to build on AWS page,
scroll down to the SDK section, and choose plus (+) sign to expand the
section.
Link to this section Summary
Functions
Creates a batch of variables.
Gets a batch of variables.
Cancels an in-progress batch import job.
Cancels the specified batch prediction job.
Creates a batch import job.
Creates a batch prediction job.
Creates a detector version.
Creates a list.
Creates a model using the specified model type.
Creates a version of the model using the specified model type and model id.
Creates a rule for use with the specified detector.
Creates a variable.
Deletes the specified batch import job ID record.
Deletes a batch prediction job.
Deletes the detector.
Deletes the detector version.
Deletes an entity type.
Deletes the specified event.
Deletes an event type.
Deletes all events of a particular event type.
Removes a SageMaker model from Amazon Fraud Detector.
Deletes a label.
Deletes the list, provided it is not used in a rule.
Deletes a model.
Deletes a model version.
Deletes an outcome.
Deletes the rule.
Deletes a variable.
Gets all versions for a specified detector.
Gets all of the model versions for the specified model type or for the specified model type and model ID.
Gets all batch import jobs or a specific job of the specified ID.
Gets all batch prediction jobs or a specific job if you specify a job ID.
Retrieves the status of a DeleteEventsByEventType action.
Gets a particular detector version.
Gets all detectors or a single detector if a detectorId is specified.
Gets all entity types or a specific entity type if a name is specified.
Retrieves details of events stored with Amazon Fraud Detector.
Evaluates an event against a detector version.
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
Gets all event types or a specific event type if name is provided.
Gets the details for one or more Amazon SageMaker models that have been imported into the service.
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
Gets all labels or a specific label if name is provided.
Gets all the elements in the specified list.
Gets the metadata of either all the lists under the account or the specified list.
Gets the details of the specified model version.
Gets one or more models.
Gets one or more outcomes.
Get all rules for a detector (paginated) if ruleId and ruleVersion are not
specified.
Gets all of the variables or the specific variable.
Gets a list of past predictions.
Lists all tags associated with the resource.
Creates or updates a detector.
Creates or updates an entity type.
Creates or updates an event type.
Creates or updates an Amazon SageMaker model endpoint.
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
Creates or updates label.
Creates or updates an outcome.
Stores events in Amazon Fraud Detector without generating fraud predictions for those events.
Assigns tags to a resource.
Removes tags from a resource.
Updates a detector version.
Updates the detector version's description.
Updates the detector version’s status.
Updates the specified event with a new label.
Updates a list.
Updates model description.
Updates a model version.
Updates the status of a model version.
Updates a rule's metadata.
Updates a rule version resulting in a new rule version.
Updates a variable.
Link to this section Functions
Creates a batch of variables.
Gets a batch of variables.
Cancels an in-progress batch import job.
Cancels the specified batch prediction job.
Creates a batch import job.
Creates a batch prediction job.
Creates a detector version.
The detector version starts in a DRAFT status.
Creates a list.
List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.
Creates a model using the specified model type.
Creates a version of the model using the specified model type and model id.
Creates a rule for use with the specified detector.
Creates a variable.
Deletes the specified batch import job ID record.
This action does not delete the data that was batch imported.
Deletes a batch prediction job.
Deletes the detector.
Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
Deletes the detector version.
You cannot delete detector versions that are in ACTIVE status.
When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
Deletes an entity type.
You cannot delete an entity type that is included in an event type.
When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.
Deletes the specified event.
When you delete an event, Amazon Fraud Detector permanently deletes that event
and the event data is no longer stored in Amazon Fraud Detector.
If deleteAuditHistory is True, event data is available through search for up
to 30 seconds after the delete operation is completed.
Deletes an event type.
You cannot delete an event type that is used in a detector or a model.
When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.
Deletes all events of a particular event type.
Removes a SageMaker model from Amazon Fraud Detector.
You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.
Deletes a label.
You cannot delete labels that are included in an event type in Amazon Fraud Detector.
You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.
When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.
Deletes the list, provided it is not used in a rule.
When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.
Deletes a model.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.
Deletes a model version.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.
Deletes an outcome.
You cannot delete an outcome that is used in a rule version.
When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.
Deletes the rule.
You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector
version.
When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.
Deletes a variable.
You can't delete variables that are included in an event type in Amazon Fraud Detector.
Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually.
When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.
Gets all versions for a specified detector.
Gets all of the model versions for the specified model type or for the specified model type and model ID.
You can also get details for a single, specified model version.
Gets all batch import jobs or a specific job of the specified ID.
This is a paginated API. If you provide a null maxResults,
this action retrieves a maximum of 50 records per page. If you provide a
maxResults, the value must be between 1 and 50.
To get the next page results, provide the pagination token from the
GetBatchImportJobsResponse as part of your request.
A null pagination token fetches the records from the beginning.
Gets all batch prediction jobs or a specific job if you specify a job ID.
This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.
get_delete_events_by_event_type_status(client, input, options \\ [])
View SourceRetrieves the status of a DeleteEventsByEventType action.
Gets a particular detector version.
Gets all detectors or a single detector if a detectorId is specified.
This is a paginated API. If you
provide a null maxResults, this action retrieves a maximum of 10 records
per page. If you provide a maxResults, the value must be between 5 and 10.
To get the next page results, provide the pagination token from the
GetDetectorsResponse as part of your request. A null pagination token
fetches the records from the beginning.
Gets all entity types or a specific entity type if a name is specified.
This is a paginated API. If you
provide a null maxResults, this action retrieves a maximum of 10 records
per page. If you provide a maxResults, the value must be between 5 and 10.
To get the next page results, provide the pagination token from the
GetEntityTypesResponse as part of your request. A null pagination token
fetches the records from the beginning.
Retrieves details of events stored with Amazon Fraud Detector.
This action does not retrieve prediction results.
Evaluates an event against a detector version.
If a version ID is not provided, the detector’s (ACTIVE) version is used.
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
Gets all event types or a specific event type if name is provided.
This is a paginated API. If you
provide a null maxResults, this action retrieves a maximum of 10 records
per page. If you provide a maxResults, the value must be between 5 and 10.
To get the next page results, provide the pagination token from the
GetEventTypesResponse as part of your request. A null pagination token
fetches the records from the beginning.
Gets the details for one or more Amazon SageMaker models that have been imported into the service.
This is a paginated API. If you provide a null maxResults, this
actions retrieves a maximum of 10 records per page. If you provide a
maxResults, the value must be between 5 and 10. To get the next page
results, provide the pagination token from the GetExternalModelsResult as part
of your request. A null pagination token fetches the records from the beginning.
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
Gets all labels or a specific label if name is provided.
This is a paginated API. If you
provide a null maxResults, this action retrieves a maximum of 50 records
per page. If you provide a maxResults, the value must be between 10 and 50.
To get the next page results, provide the pagination token from the
GetGetLabelsResponse as part of your request. A null pagination token
fetches the records from the beginning.
Gets all the elements in the specified list.
Gets the metadata of either all the lists under the account or the specified list.
Gets the details of the specified model version.
Gets one or more models.
Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.
This is a paginated API. If you
provide a null maxResults, this action retrieves a maximum of 10 records
per page. If you provide a maxResults, the value must be between 1 and 10.
To get the next page results, provide the pagination token from the
response as part of your request. A null pagination token
fetches the records from the beginning.
Gets one or more outcomes.
This is a paginated
API. If you provide a null maxResults, this actions retrieves a maximum of
100 records per page. If you provide a maxResults, the value must be
between 50 and 100. To get the next page results, provide the pagination token
from the
GetOutcomesResult as part of your request. A null pagination token
fetches the records from the beginning.
Get all rules for a detector (paginated) if ruleId and ruleVersion are not
specified.
Gets all rules for the detector and the ruleId if present (paginated). Gets a
specific rule if both the ruleId and the ruleVersion are specified.
This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
Gets all of the variables or the specific variable.
This is a
paginated API. Providing null maxSizePerPage results in retrieving maximum of
100 records per page. If you provide maxSizePerPage the value must be between
50 and 100. To get the next page result, a provide a pagination token from
GetVariablesResult as part of your request. Null pagination token
fetches the records from the beginning.
Gets a list of past predictions.
The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.
For example, the following filter lists all past predictions for xyz event
type -
{
"eventType":{
"value": "xyz" }”
}This is a paginated API. If you provide a null maxResults, this action will
retrieve a maximum of 10 records per page.
If you provide a maxResults, the value must be between 50 and 100. To get the
next page results, provide
the nextToken from the response as part of your request. A null nextToken
fetches the records from the beginning.
Lists all tags associated with the resource.
This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
Creates or updates a detector.
Creates or updates an entity type.
An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.
Creates or updates an event type.
An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
Creates or updates an Amazon SageMaker model endpoint.
You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
Creates or updates label.
A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.
Creates or updates an outcome.
Stores events in Amazon Fraud Detector without generating fraud predictions for those events.
For example, you can use SendEvent to upload a historical dataset, which you
can then later use to train a model.
Assigns tags to a resource.
Removes tags from a resource.
Updates a detector version.
The detector version attributes that you can update include models, external
model endpoints, rules, rule execution mode, and description. You can only
update a DRAFT detector version.
Updates the detector version's description.
You can update the metadata for any detector version (DRAFT, ACTIVE, or
INACTIVE).
Updates the detector version’s status.
You can perform the following promotions or
demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to
INACTIVE, and INACTIVE to ACTIVE.
Updates the specified event with a new label.
Updates a list.
Updates model description.
Updates a model version.
Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.
Updates the status of a model version.
You can perform the following status updates:
1.
Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED.
2.
Change the TRAINING_COMPLETE status to ACTIVE.
3.
Change ACTIVE to INACTIVE.
Updates a rule's metadata.
The description attribute can be updated.
Updates a rule version resulting in a new rule version.
Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
Updates a variable.