Amazon Fraud Detector

2020/11/05 - Amazon Fraud Detector - 8 new api methods

Changes  Added support for deleting resources like Variables, ExternalModels, Outcomes, Models, ModelVersions, Labels, EventTypes and EntityTypes. Updated DeleteEvent operation to catch missing exceptions.

DeleteEntityType (new) Link ¶

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 from the evaluation history, and the data is no longer stored in Amazon Fraud Detector.

See also: AWS API Documentation

Request Syntax

client.delete_entity_type(
    name='string'
)
type name

string

param name

[REQUIRED]

The name of the entity type to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DeleteEventType (new) Link ¶

Deletes an event type.

You cannot delete an event type that is used in a detector or a model.

When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type from the evaluation history, and the data is no longer stored in Amazon Fraud Detector.

See also: AWS API Documentation

Request Syntax

client.delete_event_type(
    name='string'
)
type name

string

param name

[REQUIRED]

The name of the event type to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DeleteVariable (new) Link ¶

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 from the evaluation history, and the data is no longer stored in Amazon Fraud Detector.

See also: AWS API Documentation

Request Syntax

client.delete_variable(
    name='string'
)
type name

string

param name

[REQUIRED]

The name of the variable to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DeleteExternalModel (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.delete_external_model(
    modelEndpoint='string'
)
type modelEndpoint

string

param modelEndpoint

[REQUIRED]

The endpoint of the Amazon Sagemaker model to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DeleteModelVersion (new) Link ¶

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 from the evaluation history, and the data is no longer stored in Amazon Fraud Detector.

See also: AWS API Documentation

Request Syntax

client.delete_model_version(
    modelId='string',
    modelType='ONLINE_FRAUD_INSIGHTS',
    modelVersionNumber='string'
)
type modelId

string

param modelId

[REQUIRED]

The model ID of the model version to delete.

type modelType

string

param modelType

[REQUIRED]

The model type of the model version to delete.

type modelVersionNumber

string

param modelVersionNumber

[REQUIRED]

The model version number of the model version to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DeleteModel (new) Link ¶

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 from the evaluation history, and the data is no longer stored in Amazon Fraud Detector.

See also: AWS API Documentation

Request Syntax

client.delete_model(
    modelId='string',
    modelType='ONLINE_FRAUD_INSIGHTS'
)
type modelId

string

param modelId

[REQUIRED]

The model ID of the model to delete.

type modelType

string

param modelType

[REQUIRED]

The model type of the model to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DeleteOutcome (new) Link ¶

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 from the evaluation history, and the data is no longer stored in Amazon Fraud Detector.

See also: AWS API Documentation

Request Syntax

client.delete_outcome(
    name='string'
)
type name

string

param name

[REQUIRED]

The name of the outcome to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DeleteLabel (new) Link ¶

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 from the evaluation history, and the data is no longer stored in Amazon Fraud Detector.

See also: AWS API Documentation

Request Syntax

client.delete_label(
    name='string'
)
type name

string

param name

[REQUIRED]

The name of the label to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --