Frauddetector

This page documents function available when using the Frauddetector module, created with @service Frauddetector.

Index

Documentation

Main.Frauddetector.batch_create_variableMethod
batch_create_variable(variable_entries)
batch_create_variable(variable_entries, params::Dict{String,<:Any})

Creates a batch of variables.

Arguments

  • variable_entries: The list of variables for the batch create variable request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.cancel_batch_import_jobMethod
cancel_batch_import_job(job_id)
cancel_batch_import_job(job_id, params::Dict{String,<:Any})

Cancels an in-progress batch import job.

Arguments

  • job_id: The ID of an in-progress batch import job to cancel. Amazon Fraud Detector will throw an error if the batch import job is in FAILED, CANCELED, or COMPLETED state.
source
Main.Frauddetector.cancel_batch_prediction_jobMethod
cancel_batch_prediction_job(job_id)
cancel_batch_prediction_job(job_id, params::Dict{String,<:Any})

Cancels the specified batch prediction job.

Arguments

  • job_id: The ID of the batch prediction job to cancel.
source
Main.Frauddetector.create_batch_import_jobMethod
create_batch_import_job(event_type_name, iam_role_arn, input_path, job_id, output_path)
create_batch_import_job(event_type_name, iam_role_arn, input_path, job_id, output_path, params::Dict{String,<:Any})

Creates a batch import job.

Arguments

  • event_type_name: The name of the event type.
  • iam_role_arn: The ARN of the IAM role created for Amazon S3 bucket that holds your data file. The IAM role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.
  • input_path: The URI that points to the Amazon S3 location of your data file.
  • job_id: The ID of the batch import job. The ID cannot be of a past job, unless the job exists in CREATE_FAILED state.
  • output_path: The URI that points to the Amazon S3 location for storing your results.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": A collection of key-value pairs associated with this request.
source
Main.Frauddetector.create_batch_prediction_jobMethod
create_batch_prediction_job(detector_name, event_type_name, iam_role_arn, input_path, job_id, output_path)
create_batch_prediction_job(detector_name, event_type_name, iam_role_arn, input_path, job_id, output_path, params::Dict{String,<:Any})

Creates a batch prediction job.

Arguments

  • detector_name: The name of the detector.
  • event_type_name: The name of the event type.
  • iam_role_arn: The ARN of the IAM role to use for this job request. The IAM Role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.
  • input_path: The Amazon S3 location of your training file.
  • job_id: The ID of the batch prediction job.
  • output_path: The Amazon S3 location of your output file.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "detectorVersion": The detector version.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.create_detector_versionMethod
create_detector_version(detector_id, rules)
create_detector_version(detector_id, rules, params::Dict{String,<:Any})

Creates a detector version. The detector version starts in a DRAFT status.

Arguments

  • detector_id: The ID of the detector under which you want to create a new version.
  • rules: The rules to include in the detector version.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the detector version.
  • "externalModelEndpoints": The Amazon Sagemaker model endpoints to include in the detector version.
  • "modelVersions": The model versions to include in the detector version.
  • "ruleExecutionMode": The rule execution mode for the rules included in the detector version. You can define and edit the rule mode at the detector version level, when it is in draft status. If you specify FIRSTMATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. If you specifiy ALLMATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. The default behavior is FIRST_MATCHED.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.create_modelMethod
create_model(event_type_name, model_id, model_type)
create_model(event_type_name, model_id, model_type, params::Dict{String,<:Any})

Creates a model using the specified model type.

Arguments

  • event_type_name: The name of the event type.
  • model_id: The model ID.
  • model_type: The model type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The model description.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.create_model_versionMethod
create_model_version(model_id, model_type, training_data_schema, training_data_source)
create_model_version(model_id, model_type, training_data_schema, training_data_source, params::Dict{String,<:Any})

Creates a version of the model using the specified model type and model id.

Arguments

  • model_id: The model ID.
  • model_type: The model type.
  • training_data_schema: The training data schema.
  • training_data_source: The training data source location in Amazon S3.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "externalEventsDetail": Details of the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.
  • "ingestedEventsDetail": Details of the ingested events data used for model version training. Required if trainingDataSource is INGESTED_EVENTS.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.create_ruleMethod
create_rule(detector_id, expression, language, outcomes, rule_id)
create_rule(detector_id, expression, language, outcomes, rule_id, params::Dict{String,<:Any})

Creates a rule for use with the specified detector.

Arguments

  • detector_id: The detector ID for the rule's parent detector.
  • expression: The rule expression.
  • language: The language of the rule.
  • outcomes: The outcome or outcomes returned when the rule expression matches.
  • rule_id: The rule ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The rule description.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.create_variableMethod
create_variable(data_source, data_type, default_value, name)
create_variable(data_source, data_type, default_value, name, params::Dict{String,<:Any})

Creates a variable.

Arguments

  • data_source: The source of the data.
  • data_type: The data type.
  • default_value: The default value for the variable when no value is received.
  • name: The name of the variable.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description.
  • "tags": A collection of key and value pairs.
  • "variableType": The variable type. For more information see Variable types. Valid Values: AUTHCODE | AVS | BILLINGADDRESSL1 | BILLINGADDRESSL2 | BILLINGCITY | BILLINGCOUNTRY | BILLINGNAME | BILLINGPHONE | BILLINGSTATE | BILLINGZIP | CARDBIN | CATEGORICAL | CURRENCYCODE | EMAILADDRESS | FINGERPRINT | FRAUDLABEL | FREEFORMTEXT | IPADDRESS | NUMERIC | ORDERID | PAYMENTTYPE | PHONENUMBER | PRICE | PRODUCTCATEGORY | SHIPPINGADDRESSL1 | SHIPPINGADDRESSL2 | SHIPPINGCITY | SHIPPINGCOUNTRY | SHIPPINGNAME | SHIPPINGPHONE | SHIPPINGSTATE | SHIPPINGZIP | USERAGENT
source
Main.Frauddetector.delete_batch_import_jobMethod
delete_batch_import_job(job_id)
delete_batch_import_job(job_id, params::Dict{String,<:Any})

Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.

Arguments

  • job_id: The ID of the batch import job to delete.
source
Main.Frauddetector.delete_detectorMethod
delete_detector(detector_id)
delete_detector(detector_id, params::Dict{String,<:Any})

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.

Arguments

  • detector_id: The ID of the detector to delete.
source
Main.Frauddetector.delete_detector_versionMethod
delete_detector_version(detector_id, detector_version_id)
delete_detector_version(detector_id, detector_version_id, params::Dict{String,<:Any})

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.

Arguments

  • detector_id: The ID of the parent detector for the detector version to delete.
  • detector_version_id: The ID of the detector version to delete.
source
Main.Frauddetector.delete_entity_typeMethod
delete_entity_type(name)
delete_entity_type(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the entity type to delete.
source
Main.Frauddetector.delete_eventMethod
delete_event(event_id, event_type_name)
delete_event(event_id, event_type_name, params::Dict{String,<:Any})

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.

Arguments

  • event_id: The ID of the event to delete.
  • event_type_name: The name of the event type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deleteAuditHistory": Specifies whether or not to delete any predictions associated with the event.
source
Main.Frauddetector.delete_event_typeMethod
delete_event_type(name)
delete_event_type(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the event type to delete.
source
Main.Frauddetector.delete_events_by_event_typeMethod
delete_events_by_event_type(event_type_name)
delete_events_by_event_type(event_type_name, params::Dict{String,<:Any})

Deletes all events of a particular event type.

Arguments

  • event_type_name: The name of the event type.
source
Main.Frauddetector.delete_external_modelMethod
delete_external_model(model_endpoint)
delete_external_model(model_endpoint, params::Dict{String,<:Any})

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.

Arguments

  • model_endpoint: The endpoint of the Amazon Sagemaker model to delete.
source
Main.Frauddetector.delete_labelMethod
delete_label(name)
delete_label(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the label to delete.
source
Main.Frauddetector.delete_modelMethod
delete_model(model_id, model_type)
delete_model(model_id, model_type, params::Dict{String,<:Any})

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.

Arguments

  • model_id: The model ID of the model to delete.
  • model_type: The model type of the model to delete.
source
Main.Frauddetector.delete_model_versionMethod
delete_model_version(model_id, model_type, model_version_number)
delete_model_version(model_id, model_type, model_version_number, params::Dict{String,<:Any})

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.

Arguments

  • model_id: The model ID of the model version to delete.
  • model_type: The model type of the model version to delete.
  • model_version_number: The model version number of the model version to delete.
source
Main.Frauddetector.delete_outcomeMethod
delete_outcome(name)
delete_outcome(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the outcome to delete.
source
Main.Frauddetector.delete_ruleMethod
delete_rule(rule)
delete_rule(rule, params::Dict{String,<:Any})

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.

Arguments

  • rule:
source
Main.Frauddetector.delete_variableMethod
delete_variable(name)
delete_variable(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the variable to delete.
source
Main.Frauddetector.describe_detectorMethod
describe_detector(detector_id)
describe_detector(detector_id, params::Dict{String,<:Any})

Gets all versions for a specified detector.

Arguments

  • detector_id: The detector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return for the request.
  • "nextToken": The next token from the previous response.
source
Main.Frauddetector.describe_model_versionsMethod
describe_model_versions()
describe_model_versions(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "modelId": The model ID.
  • "modelType": The model type.
  • "modelVersionNumber": The model version number.
  • "nextToken": The next token from the previous results.
source
Main.Frauddetector.get_batch_import_jobsMethod
get_batch_import_jobs()
get_batch_import_jobs(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "jobId": The ID of the batch import job to get.
  • "maxResults": The maximum number of objects to return for request.
  • "nextToken": The next token from the previous request.
source
Main.Frauddetector.get_batch_prediction_jobsMethod
get_batch_prediction_jobs()
get_batch_prediction_jobs(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "jobId": The batch prediction job for which to get the details.
  • "maxResults": The maximum number of objects to return for the request.
  • "nextToken": The next token from the previous request.
source
Main.Frauddetector.get_delete_events_by_event_type_statusMethod
get_delete_events_by_event_type_status(event_type_name)
get_delete_events_by_event_type_status(event_type_name, params::Dict{String,<:Any})

Retrieves the status of a DeleteEventsByEventType action.

Arguments

  • event_type_name: Name of event type for which to get the deletion status.
source
Main.Frauddetector.get_detector_versionMethod
get_detector_version(detector_id, detector_version_id)
get_detector_version(detector_id, detector_version_id, params::Dict{String,<:Any})

Gets a particular detector version.

Arguments

  • detector_id: The detector ID.
  • detector_version_id: The detector version ID.
source
Main.Frauddetector.get_detectorsMethod
get_detectors()
get_detectors(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "detectorId": The detector ID.
  • "maxResults": The maximum number of objects to return for the request.
  • "nextToken": The next token for the subsequent request.
source
Main.Frauddetector.get_entity_typesMethod
get_entity_types()
get_entity_types(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of objects to return for the request.
  • "name": The name.
  • "nextToken": The next token for the subsequent request.
source
Main.Frauddetector.get_eventMethod
get_event(event_id, event_type_name)
get_event(event_id, event_type_name, params::Dict{String,<:Any})

Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.

Arguments

  • event_id: The ID of the event to retrieve.
  • event_type_name: The event type of the event to retrieve.
source
Main.Frauddetector.get_event_predictionMethod
get_event_prediction(detector_id, entities, event_id, event_timestamp, event_type_name, event_variables)
get_event_prediction(detector_id, entities, event_id, event_timestamp, event_type_name, event_variables, params::Dict{String,<:Any})

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

Arguments

  • detector_id: The detector ID.
  • entities: The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."
  • event_id: The unique ID used to identify the event.
  • event_timestamp: Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
  • event_type_name: The event type associated with the detector specified for the prediction.
  • event_variables: Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation. You must provide at least one eventVariable To ensure most accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows: For Amazon Fraud Detector trained models: If a null value is provided explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable (no variable name in the eventVariables map) with calculated default mean/medians for numeric variables and with special values for categorical variables. For imported SageMaker models: If a null value is provided explicitly for a variable, the model and rules will use “null” as the value. If a variable is not provided (no variable name in the eventVariables map), model and rules will use the default value that is provided for the variable.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "detectorVersionId": The detector version ID.
  • "externalModelEndpointDataBlobs": The Amazon SageMaker model endpoint input data blobs.
source
Main.Frauddetector.get_event_prediction_metadataMethod
get_event_prediction_metadata(detector_id, detector_version_id, event_id, event_type_name, prediction_timestamp)
get_event_prediction_metadata(detector_id, detector_version_id, event_id, event_type_name, prediction_timestamp, params::Dict{String,<:Any})

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.

Arguments

  • detector_id: The detector ID.
  • detector_version_id: The detector version ID.
  • event_id: The event ID.
  • event_type_name: The event type associated with the detector specified for the prediction.
  • prediction_timestamp: The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC. We recommend calling ListEventPredictions first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.
source
Main.Frauddetector.get_event_typesMethod
get_event_types()
get_event_types(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of objects to return for the request.
  • "name": The name.
  • "nextToken": The next token for the subsequent request.
source
Main.Frauddetector.get_external_modelsMethod
get_external_models()
get_external_models(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of objects to return for the request.
  • "modelEndpoint": The Amazon SageMaker model endpoint.
  • "nextToken": The next page token for the request.
source
Main.Frauddetector.get_kmsencryption_keyMethod
get_kmsencryption_key()
get_kmsencryption_key(params::Dict{String,<:Any})

Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.

source
Main.Frauddetector.get_labelsMethod
get_labels()
get_labels(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of objects to return for the request.
  • "name": The name of the label or labels to get.
  • "nextToken": The next token for the subsequent request.
source
Main.Frauddetector.get_model_versionMethod
get_model_version(model_id, model_type, model_version_number)
get_model_version(model_id, model_type, model_version_number, params::Dict{String,<:Any})

Gets the details of the specified model version.

Arguments

  • model_id: The model ID.
  • model_type: The model type.
  • model_version_number: The model version number.
source
Main.Frauddetector.get_modelsMethod
get_models()
get_models(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of objects to return for the request.
  • "modelId": The model ID.
  • "modelType": The model type.
  • "nextToken": The next token for the subsequent request.
source
Main.Frauddetector.get_outcomesMethod
get_outcomes()
get_outcomes(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of objects to return for the request.
  • "name": The name of the outcome or outcomes to get.
  • "nextToken": The next page token for the request.
source
Main.Frauddetector.get_rulesMethod
get_rules(detector_id)
get_rules(detector_id, params::Dict{String,<:Any})

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.

Arguments

  • detector_id: The detector ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of rules to return for the request.
  • "nextToken": The next page token.
  • "ruleId": The rule ID.
  • "ruleVersion": The rule version.
source
Main.Frauddetector.get_variablesMethod
get_variables()
get_variables(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The max size per page determined for the get variable request.
  • "name": The name of the variable.
  • "nextToken": The next page token of the get variable request.
source
Main.Frauddetector.list_event_predictionsMethod
list_event_predictions()
list_event_predictions(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "detectorId": The detector ID.
  • "detectorVersionId": The detector version ID.
  • "eventId": The event ID.
  • "eventType": The event type associated with the detector.
  • "maxResults": The maximum number of predictions to return for the request.
  • "nextToken": Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
  • "predictionTimeRange": The time period for when the predictions were generated.
source
Main.Frauddetector.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The ARN that specifies the resource whose tags you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of objects to return for the request.
  • "nextToken": The next token from the previous results.
source
Main.Frauddetector.put_detectorMethod
put_detector(detector_id, event_type_name)
put_detector(detector_id, event_type_name, params::Dict{String,<:Any})

Creates or updates a detector.

Arguments

  • detector_id: The detector ID.
  • event_type_name: The name of the event type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the detector.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.put_entity_typeMethod
put_entity_type(name)
put_entity_type(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the entity type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.put_event_typeMethod
put_event_type(entity_types, event_variables, name)
put_event_type(entity_types, event_variables, name, params::Dict{String,<:Any})

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.

Arguments

  • entity_types: The entity type for the event type. Example entity types: customer, merchant, account.
  • event_variables: The event type variables.
  • name: The name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the event type.
  • "eventIngestion": Specifies if ingenstion is enabled or disabled.
  • "labels": The event type labels.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.put_external_modelMethod
put_external_model(input_configuration, invoke_model_endpoint_role_arn, model_endpoint, model_endpoint_status, model_source, output_configuration)
put_external_model(input_configuration, invoke_model_endpoint_role_arn, model_endpoint, model_endpoint_status, model_source, output_configuration, params::Dict{String,<:Any})

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.

Arguments

  • input_configuration: The model endpoint input configuration.
  • invoke_model_endpoint_role_arn: The IAM role used to invoke the model endpoint.
  • model_endpoint: The model endpoints name.
  • model_endpoint_status: The model endpoint’s status in Amazon Fraud Detector.
  • model_source: The source of the model.
  • output_configuration: The model endpoint output configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.put_kmsencryption_keyMethod
put_kmsencryption_key(kms_encryption_key_arn)
put_kmsencryption_key(kms_encryption_key_arn, params::Dict{String,<:Any})

Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.

Arguments

  • kms_encryption_key_arn: The KMS encryption key ARN. The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.
source
Main.Frauddetector.put_labelMethod
put_label(name)
put_label(name, params::Dict{String,<:Any})

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.

Arguments

  • name: The label name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The label description.
  • "tags":
source
Main.Frauddetector.put_outcomeMethod
put_outcome(name)
put_outcome(name, params::Dict{String,<:Any})

Creates or updates an outcome.

Arguments

  • name: The name of the outcome.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The outcome description.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.send_eventMethod
send_event(entities, event_id, event_timestamp, event_type_name, event_variables)
send_event(entities, event_id, event_timestamp, event_type_name, event_variables, params::Dict{String,<:Any})

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.

Arguments

  • entities: An array of entities.
  • event_id: The event ID to upload.
  • event_timestamp: The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
  • event_type_name: The event type name of the event.
  • event_variables: Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "assignedLabel": The label to associate with the event. Required if specifying labelTimestamp.
  • "labelTimestamp": The timestamp associated with the label. Required if specifying assignedLabel.
source
Main.Frauddetector.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Assigns tags to a resource.

Arguments

  • resource_arn: The resource ARN.
  • tags: The tags to assign to the resource.
source
Main.Frauddetector.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from a resource.

Arguments

  • resource_arn: The ARN of the resource from which to remove the tag.
  • tag_keys: The resource ARN.
source
Main.Frauddetector.update_detector_versionMethod
update_detector_version(detector_id, detector_version_id, external_model_endpoints, rules)
update_detector_version(detector_id, detector_version_id, external_model_endpoints, rules, params::Dict{String,<:Any})

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.

Arguments

  • detector_id: The parent detector ID for the detector version you want to update.
  • detector_version_id: The detector version ID.
  • external_model_endpoints: The Amazon SageMaker model endpoints to include in the detector version.
  • rules: The rules to include in the detector version.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The detector version description.
  • "modelVersions": The model versions to include in the detector version.
  • "ruleExecutionMode": The rule execution mode to add to the detector. If you specify FIRSTMATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule. If you specifiy ALLMATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status. The default behavior is FIRST_MATCHED.
source
Main.Frauddetector.update_detector_version_metadataMethod
update_detector_version_metadata(description, detector_id, detector_version_id)
update_detector_version_metadata(description, detector_id, detector_version_id, params::Dict{String,<:Any})

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).

Arguments

  • description: The description.
  • detector_id: The detector ID.
  • detector_version_id: The detector version ID.
source
Main.Frauddetector.update_detector_version_statusMethod
update_detector_version_status(detector_id, detector_version_id, status)
update_detector_version_status(detector_id, detector_version_id, status, params::Dict{String,<:Any})

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.

Arguments

  • detector_id: The detector ID.
  • detector_version_id: The detector version ID.
  • status: The new status. The only supported values are ACTIVE and INACTIVE
source
Main.Frauddetector.update_event_labelMethod
update_event_label(assigned_label, event_id, event_type_name, label_timestamp)
update_event_label(assigned_label, event_id, event_type_name, label_timestamp, params::Dict{String,<:Any})

Updates the specified event with a new label.

Arguments

  • assigned_label: The new label to assign to the event.
  • event_id: The ID of the event associated with the label to update.
  • event_type_name: The event type of the event associated with the label to update.
  • label_timestamp: The timestamp associated with the label. The timestamp must be specified using ISO 8601 standard in UTC.
source
Main.Frauddetector.update_modelMethod
update_model(model_id, model_type)
update_model(model_id, model_type, params::Dict{String,<:Any})

Updates model description.

Arguments

  • model_id: The model ID.
  • model_type: The model type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The new model description.
source
Main.Frauddetector.update_model_versionMethod
update_model_version(major_version_number, model_id, model_type)
update_model_version(major_version_number, model_id, model_type, params::Dict{String,<:Any})

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.

Arguments

  • major_version_number: The major version number.
  • model_id: The model ID.
  • model_type: The model type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "externalEventsDetail": The details of the external events data used for training the model version. Required if trainingDataSource is EXTERNAL_EVENTS.
  • "ingestedEventsDetail": The details of the ingested event used for training the model version. Required if your trainingDataSource is INGESTED_EVENTS.
  • "tags": A collection of key and value pairs.
source
Main.Frauddetector.update_model_version_statusMethod
update_model_version_status(model_id, model_type, model_version_number, status)
update_model_version_status(model_id, model_type, model_version_number, status, params::Dict{String,<:Any})

Updates the status of a model version. You can perform the following status updates: Change the TRAININGINPROGRESS status to TRAININGCANCELLED. Change the TRAININGCOMPLETE status to ACTIVE. Change ACTIVE to INACTIVE.

Arguments

  • model_id: The model ID of the model version to update.
  • model_type: The model type.
  • model_version_number: The model version number.
  • status: The model version status.
source
Main.Frauddetector.update_rule_metadataMethod
update_rule_metadata(description, rule)
update_rule_metadata(description, rule, params::Dict{String,<:Any})

Updates a rule's metadata. The description attribute can be updated.

Arguments

  • description: The rule description.
  • rule: The rule to update.
source
Main.Frauddetector.update_rule_versionMethod
update_rule_version(expression, language, outcomes, rule)
update_rule_version(expression, language, outcomes, rule, params::Dict{String,<:Any})

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

Arguments

  • expression: The rule expression.
  • language: The language.
  • outcomes: The outcomes.
  • rule: The rule to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description.
  • "tags": The tags to assign to the rule version.
source
Main.Frauddetector.update_variableMethod
update_variable(name)
update_variable(name, params::Dict{String,<:Any})

Updates a variable.

Arguments

  • name: The name of the variable.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "defaultValue": The new default value of the variable.
  • "description": The new description.
  • "variableType": The variable type. For more information see Variable types.
source