cloudworker-proxy
Version:
An api gateway for cloudflare workers
931 lines • 83.2 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class FraudDetector extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: FraudDetector.Types.ClientConfiguration)
config: Config & FraudDetector.Types.ClientConfiguration;
/**
* Creates a batch of variables.
*/
batchCreateVariable(params: FraudDetector.Types.BatchCreateVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.BatchCreateVariableResult) => void): Request<FraudDetector.Types.BatchCreateVariableResult, AWSError>;
/**
* Creates a batch of variables.
*/
batchCreateVariable(callback?: (err: AWSError, data: FraudDetector.Types.BatchCreateVariableResult) => void): Request<FraudDetector.Types.BatchCreateVariableResult, AWSError>;
/**
* Gets a batch of variables.
*/
batchGetVariable(params: FraudDetector.Types.BatchGetVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.BatchGetVariableResult) => void): Request<FraudDetector.Types.BatchGetVariableResult, AWSError>;
/**
* Gets a batch of variables.
*/
batchGetVariable(callback?: (err: AWSError, data: FraudDetector.Types.BatchGetVariableResult) => void): Request<FraudDetector.Types.BatchGetVariableResult, AWSError>;
/**
* Creates a detector version. The detector version starts in a DRAFT status.
*/
createDetectorVersion(params: FraudDetector.Types.CreateDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateDetectorVersionResult) => void): Request<FraudDetector.Types.CreateDetectorVersionResult, AWSError>;
/**
* Creates a detector version. The detector version starts in a DRAFT status.
*/
createDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.CreateDetectorVersionResult) => void): Request<FraudDetector.Types.CreateDetectorVersionResult, AWSError>;
/**
* Creates a model using the specified model type.
*/
createModel(params: FraudDetector.Types.CreateModelRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateModelResult) => void): Request<FraudDetector.Types.CreateModelResult, AWSError>;
/**
* Creates a model using the specified model type.
*/
createModel(callback?: (err: AWSError, data: FraudDetector.Types.CreateModelResult) => void): Request<FraudDetector.Types.CreateModelResult, AWSError>;
/**
* Creates a version of the model using the specified model type and model id.
*/
createModelVersion(params: FraudDetector.Types.CreateModelVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateModelVersionResult) => void): Request<FraudDetector.Types.CreateModelVersionResult, AWSError>;
/**
* Creates a version of the model using the specified model type and model id.
*/
createModelVersion(callback?: (err: AWSError, data: FraudDetector.Types.CreateModelVersionResult) => void): Request<FraudDetector.Types.CreateModelVersionResult, AWSError>;
/**
* Creates a rule for use with the specified detector.
*/
createRule(params: FraudDetector.Types.CreateRuleRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateRuleResult) => void): Request<FraudDetector.Types.CreateRuleResult, AWSError>;
/**
* Creates a rule for use with the specified detector.
*/
createRule(callback?: (err: AWSError, data: FraudDetector.Types.CreateRuleResult) => void): Request<FraudDetector.Types.CreateRuleResult, AWSError>;
/**
* Creates a variable.
*/
createVariable(params: FraudDetector.Types.CreateVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.CreateVariableResult) => void): Request<FraudDetector.Types.CreateVariableResult, AWSError>;
/**
* Creates a variable.
*/
createVariable(callback?: (err: AWSError, data: FraudDetector.Types.CreateVariableResult) => void): Request<FraudDetector.Types.CreateVariableResult, AWSError>;
/**
* Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
*/
deleteDetector(params: FraudDetector.Types.DeleteDetectorRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorResult) => void): Request<FraudDetector.Types.DeleteDetectorResult, AWSError>;
/**
* Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
*/
deleteDetector(callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorResult) => void): Request<FraudDetector.Types.DeleteDetectorResult, AWSError>;
/**
* Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.
*/
deleteDetectorVersion(params: FraudDetector.Types.DeleteDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorVersionResult) => void): Request<FraudDetector.Types.DeleteDetectorVersionResult, AWSError>;
/**
* Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.
*/
deleteDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.DeleteDetectorVersionResult) => void): Request<FraudDetector.Types.DeleteDetectorVersionResult, AWSError>;
/**
* Deletes the specified event.
*/
deleteEvent(params: FraudDetector.Types.DeleteEventRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteEventResult) => void): Request<FraudDetector.Types.DeleteEventResult, AWSError>;
/**
* Deletes the specified event.
*/
deleteEvent(callback?: (err: AWSError, data: FraudDetector.Types.DeleteEventResult) => void): Request<FraudDetector.Types.DeleteEventResult, AWSError>;
/**
* Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.
*/
deleteRule(params: FraudDetector.Types.DeleteRuleRequest, callback?: (err: AWSError, data: FraudDetector.Types.DeleteRuleResult) => void): Request<FraudDetector.Types.DeleteRuleResult, AWSError>;
/**
* Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.
*/
deleteRule(callback?: (err: AWSError, data: FraudDetector.Types.DeleteRuleResult) => void): Request<FraudDetector.Types.DeleteRuleResult, AWSError>;
/**
* Gets all versions for a specified detector.
*/
describeDetector(params: FraudDetector.Types.DescribeDetectorRequest, callback?: (err: AWSError, data: FraudDetector.Types.DescribeDetectorResult) => void): Request<FraudDetector.Types.DescribeDetectorResult, AWSError>;
/**
* Gets all versions for a specified detector.
*/
describeDetector(callback?: (err: AWSError, data: FraudDetector.Types.DescribeDetectorResult) => void): Request<FraudDetector.Types.DescribeDetectorResult, AWSError>;
/**
* 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.
*/
describeModelVersions(params: FraudDetector.Types.DescribeModelVersionsRequest, callback?: (err: AWSError, data: FraudDetector.Types.DescribeModelVersionsResult) => void): Request<FraudDetector.Types.DescribeModelVersionsResult, AWSError>;
/**
* 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.
*/
describeModelVersions(callback?: (err: AWSError, data: FraudDetector.Types.DescribeModelVersionsResult) => void): Request<FraudDetector.Types.DescribeModelVersionsResult, AWSError>;
/**
* Gets a particular detector version.
*/
getDetectorVersion(params: FraudDetector.Types.GetDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorVersionResult) => void): Request<FraudDetector.Types.GetDetectorVersionResult, AWSError>;
/**
* Gets a particular detector version.
*/
getDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorVersionResult) => void): Request<FraudDetector.Types.GetDetectorVersionResult, AWSError>;
/**
* 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.
*/
getDetectors(params: FraudDetector.Types.GetDetectorsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorsResult) => void): Request<FraudDetector.Types.GetDetectorsResult, AWSError>;
/**
* 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.
*/
getDetectors(callback?: (err: AWSError, data: FraudDetector.Types.GetDetectorsResult) => void): Request<FraudDetector.Types.GetDetectorsResult, AWSError>;
/**
* 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.
*/
getEntityTypes(params: FraudDetector.Types.GetEntityTypesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetEntityTypesResult) => void): Request<FraudDetector.Types.GetEntityTypesResult, AWSError>;
/**
* 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.
*/
getEntityTypes(callback?: (err: AWSError, data: FraudDetector.Types.GetEntityTypesResult) => void): Request<FraudDetector.Types.GetEntityTypesResult, AWSError>;
/**
* Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
*/
getEventPrediction(params: FraudDetector.Types.GetEventPredictionRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetEventPredictionResult) => void): Request<FraudDetector.Types.GetEventPredictionResult, AWSError>;
/**
* Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
*/
getEventPrediction(callback?: (err: AWSError, data: FraudDetector.Types.GetEventPredictionResult) => void): Request<FraudDetector.Types.GetEventPredictionResult, AWSError>;
/**
* 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.
*/
getEventTypes(params: FraudDetector.Types.GetEventTypesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetEventTypesResult) => void): Request<FraudDetector.Types.GetEventTypesResult, AWSError>;
/**
* 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.
*/
getEventTypes(callback?: (err: AWSError, data: FraudDetector.Types.GetEventTypesResult) => void): Request<FraudDetector.Types.GetEventTypesResult, AWSError>;
/**
* 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.
*/
getExternalModels(params: FraudDetector.Types.GetExternalModelsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetExternalModelsResult) => void): Request<FraudDetector.Types.GetExternalModelsResult, AWSError>;
/**
* 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.
*/
getExternalModels(callback?: (err: AWSError, data: FraudDetector.Types.GetExternalModelsResult) => void): Request<FraudDetector.Types.GetExternalModelsResult, AWSError>;
/**
* Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.
*/
getKMSEncryptionKey(callback?: (err: AWSError, data: FraudDetector.Types.GetKMSEncryptionKeyResult) => void): Request<FraudDetector.Types.GetKMSEncryptionKeyResult, AWSError>;
/**
* 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.
*/
getLabels(params: FraudDetector.Types.GetLabelsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetLabelsResult) => void): Request<FraudDetector.Types.GetLabelsResult, AWSError>;
/**
* 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.
*/
getLabels(callback?: (err: AWSError, data: FraudDetector.Types.GetLabelsResult) => void): Request<FraudDetector.Types.GetLabelsResult, AWSError>;
/**
* Gets the details of the specified model version.
*/
getModelVersion(params: FraudDetector.Types.GetModelVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetModelVersionResult) => void): Request<FraudDetector.Types.GetModelVersionResult, AWSError>;
/**
* Gets the details of the specified model version.
*/
getModelVersion(callback?: (err: AWSError, data: FraudDetector.Types.GetModelVersionResult) => void): Request<FraudDetector.Types.GetModelVersionResult, AWSError>;
/**
* Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS 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.
*/
getModels(params: FraudDetector.Types.GetModelsRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetModelsResult) => void): Request<FraudDetector.Types.GetModelsResult, AWSError>;
/**
* Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS 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.
*/
getModels(callback?: (err: AWSError, data: FraudDetector.Types.GetModelsResult) => void): Request<FraudDetector.Types.GetModelsResult, AWSError>;
/**
* 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.
*/
getOutcomes(params: FraudDetector.Types.GetOutcomesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetOutcomesResult) => void): Request<FraudDetector.Types.GetOutcomesResult, AWSError>;
/**
* 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.
*/
getOutcomes(callback?: (err: AWSError, data: FraudDetector.Types.GetOutcomesResult) => void): Request<FraudDetector.Types.GetOutcomesResult, AWSError>;
/**
* 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.
*/
getRules(params: FraudDetector.Types.GetRulesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetRulesResult) => void): Request<FraudDetector.Types.GetRulesResult, AWSError>;
/**
* 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.
*/
getRules(callback?: (err: AWSError, data: FraudDetector.Types.GetRulesResult) => void): Request<FraudDetector.Types.GetRulesResult, AWSError>;
/**
* 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.
*/
getVariables(params: FraudDetector.Types.GetVariablesRequest, callback?: (err: AWSError, data: FraudDetector.Types.GetVariablesResult) => void): Request<FraudDetector.Types.GetVariablesResult, AWSError>;
/**
* 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.
*/
getVariables(callback?: (err: AWSError, data: FraudDetector.Types.GetVariablesResult) => void): Request<FraudDetector.Types.GetVariablesResult, AWSError>;
/**
* 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.
*/
listTagsForResource(params: FraudDetector.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: FraudDetector.Types.ListTagsForResourceResult) => void): Request<FraudDetector.Types.ListTagsForResourceResult, AWSError>;
/**
* 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.
*/
listTagsForResource(callback?: (err: AWSError, data: FraudDetector.Types.ListTagsForResourceResult) => void): Request<FraudDetector.Types.ListTagsForResourceResult, AWSError>;
/**
* Creates or updates a detector.
*/
putDetector(params: FraudDetector.Types.PutDetectorRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutDetectorResult) => void): Request<FraudDetector.Types.PutDetectorResult, AWSError>;
/**
* Creates or updates a detector.
*/
putDetector(callback?: (err: AWSError, data: FraudDetector.Types.PutDetectorResult) => void): Request<FraudDetector.Types.PutDetectorResult, AWSError>;
/**
* 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.
*/
putEntityType(params: FraudDetector.Types.PutEntityTypeRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutEntityTypeResult) => void): Request<FraudDetector.Types.PutEntityTypeResult, AWSError>;
/**
* 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.
*/
putEntityType(callback?: (err: AWSError, data: FraudDetector.Types.PutEntityTypeResult) => void): Request<FraudDetector.Types.PutEntityTypeResult, AWSError>;
/**
* 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.
*/
putEventType(params: FraudDetector.Types.PutEventTypeRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutEventTypeResult) => void): Request<FraudDetector.Types.PutEventTypeResult, AWSError>;
/**
* 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.
*/
putEventType(callback?: (err: AWSError, data: FraudDetector.Types.PutEventTypeResult) => void): Request<FraudDetector.Types.PutEventTypeResult, AWSError>;
/**
* 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.
*/
putExternalModel(params: FraudDetector.Types.PutExternalModelRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutExternalModelResult) => void): Request<FraudDetector.Types.PutExternalModelResult, AWSError>;
/**
* 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.
*/
putExternalModel(callback?: (err: AWSError, data: FraudDetector.Types.PutExternalModelResult) => void): Request<FraudDetector.Types.PutExternalModelResult, AWSError>;
/**
* Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.
*/
putKMSEncryptionKey(params: FraudDetector.Types.PutKMSEncryptionKeyRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutKMSEncryptionKeyResult) => void): Request<FraudDetector.Types.PutKMSEncryptionKeyResult, AWSError>;
/**
* Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.
*/
putKMSEncryptionKey(callback?: (err: AWSError, data: FraudDetector.Types.PutKMSEncryptionKeyResult) => void): Request<FraudDetector.Types.PutKMSEncryptionKeyResult, AWSError>;
/**
* 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.
*/
putLabel(params: FraudDetector.Types.PutLabelRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutLabelResult) => void): Request<FraudDetector.Types.PutLabelResult, AWSError>;
/**
* 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.
*/
putLabel(callback?: (err: AWSError, data: FraudDetector.Types.PutLabelResult) => void): Request<FraudDetector.Types.PutLabelResult, AWSError>;
/**
* Creates or updates an outcome.
*/
putOutcome(params: FraudDetector.Types.PutOutcomeRequest, callback?: (err: AWSError, data: FraudDetector.Types.PutOutcomeResult) => void): Request<FraudDetector.Types.PutOutcomeResult, AWSError>;
/**
* Creates or updates an outcome.
*/
putOutcome(callback?: (err: AWSError, data: FraudDetector.Types.PutOutcomeResult) => void): Request<FraudDetector.Types.PutOutcomeResult, AWSError>;
/**
* Assigns tags to a resource.
*/
tagResource(params: FraudDetector.Types.TagResourceRequest, callback?: (err: AWSError, data: FraudDetector.Types.TagResourceResult) => void): Request<FraudDetector.Types.TagResourceResult, AWSError>;
/**
* Assigns tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: FraudDetector.Types.TagResourceResult) => void): Request<FraudDetector.Types.TagResourceResult, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(params: FraudDetector.Types.UntagResourceRequest, callback?: (err: AWSError, data: FraudDetector.Types.UntagResourceResult) => void): Request<FraudDetector.Types.UntagResourceResult, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: FraudDetector.Types.UntagResourceResult) => void): Request<FraudDetector.Types.UntagResourceResult, AWSError>;
/**
* 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.
*/
updateDetectorVersion(params: FraudDetector.Types.UpdateDetectorVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionResult, AWSError>;
/**
* 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.
*/
updateDetectorVersion(callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionResult, AWSError>;
/**
* Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).
*/
updateDetectorVersionMetadata(params: FraudDetector.Types.UpdateDetectorVersionMetadataRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionMetadataResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionMetadataResult, AWSError>;
/**
* Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).
*/
updateDetectorVersionMetadata(callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionMetadataResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionMetadataResult, AWSError>;
/**
* 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.
*/
updateDetectorVersionStatus(params: FraudDetector.Types.UpdateDetectorVersionStatusRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionStatusResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionStatusResult, AWSError>;
/**
* 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.
*/
updateDetectorVersionStatus(callback?: (err: AWSError, data: FraudDetector.Types.UpdateDetectorVersionStatusResult) => void): Request<FraudDetector.Types.UpdateDetectorVersionStatusResult, AWSError>;
/**
* Updates a model. You can update the description attribute using this action.
*/
updateModel(params: FraudDetector.Types.UpdateModelRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelResult) => void): Request<FraudDetector.Types.UpdateModelResult, AWSError>;
/**
* Updates a model. You can update the description attribute using this action.
*/
updateModel(callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelResult) => void): Request<FraudDetector.Types.UpdateModelResult, AWSError>;
/**
* 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.
*/
updateModelVersion(params: FraudDetector.Types.UpdateModelVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionResult) => void): Request<FraudDetector.Types.UpdateModelVersionResult, AWSError>;
/**
* 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.
*/
updateModelVersion(callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionResult) => void): Request<FraudDetector.Types.UpdateModelVersionResult, AWSError>;
/**
* Updates the status of a model version. You can perform the following status updates: Change the TRAINING_COMPLETE status to ACTIVE. Change ACTIVEto INACTIVE.
*/
updateModelVersionStatus(params: FraudDetector.Types.UpdateModelVersionStatusRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionStatusResult) => void): Request<FraudDetector.Types.UpdateModelVersionStatusResult, AWSError>;
/**
* Updates the status of a model version. You can perform the following status updates: Change the TRAINING_COMPLETE status to ACTIVE. Change ACTIVEto INACTIVE.
*/
updateModelVersionStatus(callback?: (err: AWSError, data: FraudDetector.Types.UpdateModelVersionStatusResult) => void): Request<FraudDetector.Types.UpdateModelVersionStatusResult, AWSError>;
/**
* Updates a rule's metadata. The description attribute can be updated.
*/
updateRuleMetadata(params: FraudDetector.Types.UpdateRuleMetadataRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleMetadataResult) => void): Request<FraudDetector.Types.UpdateRuleMetadataResult, AWSError>;
/**
* Updates a rule's metadata. The description attribute can be updated.
*/
updateRuleMetadata(callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleMetadataResult) => void): Request<FraudDetector.Types.UpdateRuleMetadataResult, AWSError>;
/**
* Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
*/
updateRuleVersion(params: FraudDetector.Types.UpdateRuleVersionRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleVersionResult) => void): Request<FraudDetector.Types.UpdateRuleVersionResult, AWSError>;
/**
* Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
*/
updateRuleVersion(callback?: (err: AWSError, data: FraudDetector.Types.UpdateRuleVersionResult) => void): Request<FraudDetector.Types.UpdateRuleVersionResult, AWSError>;
/**
* Updates a variable.
*/
updateVariable(params: FraudDetector.Types.UpdateVariableRequest, callback?: (err: AWSError, data: FraudDetector.Types.UpdateVariableResult) => void): Request<FraudDetector.Types.UpdateVariableResult, AWSError>;
/**
* Updates a variable.
*/
updateVariable(callback?: (err: AWSError, data: FraudDetector.Types.UpdateVariableResult) => void): Request<FraudDetector.Types.UpdateVariableResult, AWSError>;
}
declare namespace FraudDetector {
export interface BatchCreateVariableError {
/**
* The name.
*/
name?: string;
/**
* The error code.
*/
code?: integer;
/**
* The error message.
*/
message?: string;
}
export type BatchCreateVariableErrorList = BatchCreateVariableError[];
export interface BatchCreateVariableRequest {
/**
* The list of variables for the batch create variable request.
*/
variableEntries: VariableEntryList;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface BatchCreateVariableResult {
/**
* Provides the errors for the BatchCreateVariable request.
*/
errors?: BatchCreateVariableErrorList;
}
export interface BatchGetVariableError {
/**
* The error name.
*/
name?: string;
/**
* The error code.
*/
code?: integer;
/**
* The error message.
*/
message?: string;
}
export type BatchGetVariableErrorList = BatchGetVariableError[];
export interface BatchGetVariableRequest {
/**
* The list of variable names to get.
*/
names: NameList;
}
export interface BatchGetVariableResult {
/**
* The returned variables.
*/
variables?: VariableList;
/**
* The errors from the request.
*/
errors?: BatchGetVariableErrorList;
}
export interface CreateDetectorVersionRequest {
/**
* The ID of the detector under which you want to create a new version.
*/
detectorId: identifier;
/**
* The description of the detector version.
*/
description?: description;
/**
* The Amazon Sagemaker model endpoints to include in the detector version.
*/
externalModelEndpoints?: ListOfStrings;
/**
* The rules to include in the detector version.
*/
rules: RuleList;
/**
* The model versions to include in the detector version.
*/
modelVersions?: ListOfModelVersions;
/**
* 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 FIRST_MATCHED, 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 ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. The default behavior is FIRST_MATCHED.
*/
ruleExecutionMode?: RuleExecutionMode;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateDetectorVersionResult {
/**
* The ID for the created version's parent detector.
*/
detectorId?: identifier;
/**
* The ID for the created detector.
*/
detectorVersionId?: nonEmptyString;
/**
* The status of the detector version.
*/
status?: DetectorVersionStatus;
}
export interface CreateModelRequest {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The model description.
*/
description?: description;
/**
* The name of the event type.
*/
eventTypeName: string;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateModelResult {
}
export interface CreateModelVersionRequest {
/**
* The model ID.
*/
modelId: modelIdentifier;
/**
* The model type.
*/
modelType: ModelTypeEnum;
/**
* The training data source location in Amazon S3.
*/
trainingDataSource: TrainingDataSourceEnum;
/**
* The training data schema.
*/
trainingDataSchema: TrainingDataSchema;
/**
* Details for the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.
*/
externalEventsDetail?: ExternalEventsDetail;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateModelVersionResult {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The model version number of the model version created.
*/
modelVersionNumber?: nonEmptyString;
/**
* The model version status.
*/
status?: string;
}
export interface CreateRuleRequest {
/**
* The rule ID.
*/
ruleId: identifier;
/**
* The detector ID for the rule's parent detector.
*/
detectorId: identifier;
/**
* The rule description.
*/
description?: description;
/**
* The rule expression.
*/
expression: ruleExpression;
/**
* The language of the rule.
*/
language: Language;
/**
* The outcome or outcomes returned when the rule expression matches.
*/
outcomes: NonEmptyListOfStrings;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateRuleResult {
/**
* The created rule.
*/
rule?: Rule;
}
export interface CreateVariableRequest {
/**
* The name of the variable.
*/
name: string;
/**
* The data type.
*/
dataType: DataType;
/**
* The source of the data.
*/
dataSource: DataSource;
/**
* The default value for the variable when no value is received.
*/
defaultValue: string;
/**
* The description.
*/
description?: string;
/**
* The variable type. For more information see Variable types. Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT | SHIPPING_ZIP | USERAGENT
*/
variableType?: string;
/**
* A collection of key and value pairs.
*/
tags?: tagList;
}
export interface CreateVariableResult {
}
export type CsvIndexToVariableMap = {[key: string]: string};
export type DataSource = "EVENT"|"MODEL_SCORE"|"EXTERNAL_MODEL_SCORE"|string;
export type DataType = "STRING"|"INTEGER"|"FLOAT"|"BOOLEAN"|string;
export interface DataValidationMetrics {
/**
* The file-specific model training validation messages.
*/
fileLevelMessages?: fileValidationMessageList;
/**
* The field-specific model training validation messages.
*/
fieldLevelMessages?: fieldValidationMessageList;
}
export interface DeleteDetectorRequest {
/**
* The ID of the detector to delete.
*/
detectorId: identifier;
}
export interface DeleteDetectorResult {
}
export interface DeleteDetectorVersionRequest {
/**
* The ID of the parent detector for the detector version to delete.
*/
detectorId: identifier;
/**
* The ID of the detector version to delete.
*/
detectorVersionId: wholeNumberVersionString;
}
export interface DeleteDetectorVersionResult {
}
export interface DeleteEventRequest {
/**
* The ID of the event to delete.
*/
eventId: string;
/**
* The name of the event type.
*/
eventTypeName: string;
}
export interface DeleteEventResult {
}
export interface DeleteRuleRequest {
rule: Rule;
}
export interface DeleteRuleResult {
}
export interface DescribeDetectorRequest {
/**
* The detector ID.
*/
detectorId: identifier;
/**
* The next token from the previous response.
*/
nextToken?: string;
/**
* The maximum number of results to return for the request.
*/
maxResults?: DetectorVersionMaxResults;
}
export interface DescribeDetectorResult {
/**
* The detector ID.
*/
detectorId?: identifier;
/**
* The status and description for each detector version.
*/
detectorVersionSummaries?: DetectorVersionSummaryList;
/**
* The next token to be used for subsequent requests.
*/
nextToken?: string;
/**
* The detector ARN.
*/
arn?: fraudDetectorArn;
}
export interface DescribeModelVersionsRequest {
/**
* The model ID.
*/
modelId?: modelIdentifier;
/**
* The model version number.
*/
modelVersionNumber?: floatVersionString;
/**
* The model type.
*/
modelType?: ModelTypeEnum;
/**
* The next token from the previous results.
*/
nextToken?: string;
/**
* The maximum number of results to return.
*/
maxResults?: modelsMaxPageSize;
}
export interface DescribeModelVersionsResult {
/**
* The model version details.
*/
modelVersionDetails?: modelVersionDetailList;
/**
* The next token.
*/
nextToken?: string;
}
export interface Detector {
/**
* The detector ID.
*/
detectorId?: identifier;
/**
* The detector description.
*/
description?: description;
/**
* The name of the event type.
*/
eventTypeName?: identifier;
/**
* Timestamp of when the detector was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the detector was created.
*/
createdTime?: time;
/**
* The detector ARN.
*/
arn?: fraudDetectorArn;
}
export type DetectorList = Detector[];
export type DetectorVersionMaxResults = number;
export type DetectorVersionStatus = "DRAFT"|"ACTIVE"|"INACTIVE"|string;
export interface DetectorVersionSummary {
/**
* The detector version ID.
*/
detectorVersionId?: nonEmptyString;
/**
* The detector version status.
*/
status?: DetectorVersionStatus;
/**
* The detector version description.
*/
description?: description;
/**
* Timestamp of when the detector version was last updated.
*/
lastUpdatedTime?: time;
}
export type DetectorVersionSummaryList = DetectorVersionSummary[];
export type DetectorsMaxResults = number;
export interface Entity {
/**
* The entity type.
*/
entityType: string;
/**
* The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.
*/
entityId: identifier;
}
export interface EntityType {
/**
* The entity type name.
*/
name?: string;
/**
* The entity type description.
*/
description?: description;
/**
* Timestamp of when the entity type was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the entity type was created.
*/
createdTime?: time;
/**
* The entity type ARN.
*/
arn?: fraudDetectorArn;
}
export interface EventType {
/**
* The event type name.
*/
name?: string;
/**
* The event type description.
*/
description?: description;
/**
* The event type event variables.
*/
eventVariables?: ListOfStrings;
/**
* The event type labels.
*/
labels?: ListOfStrings;
/**
* The event type entity types.
*/
entityTypes?: NonEmptyListOfStrings;
/**
* Timestamp of when the event type was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the event type was created.
*/
createdTime?: time;
/**
* The entity type ARN.
*/
arn?: fraudDetectorArn;
}
export type EventVariableMap = {[key: string]: variableValue};
export interface ExternalEventsDetail {
/**
* The Amazon S3 bucket location for the data.
*/
dataLocation: s3BucketLocation;
/**
* The ARN of the role that provides Amazon Fraud Detector access to the data location.
*/
dataAccessRoleArn: iamRoleArn;
}
export interface ExternalModel {
/**
* The Amazon SageMaker model endpoints.
*/
modelEndpoint?: string;
/**
* The source of the model.
*/
modelSource?: ModelSource;
/**
* The role used to invoke the model.
*/
invokeModelEndpointRoleArn?: string;
/**
* The input configuration.
*/
inputConfiguration?: ModelInputConfiguration;
/**
* The output configuration.
*/
outputConfiguration?: ModelOutputConfiguration;
/**
* The Amazon Fraud Detector status for the external model endpoint
*/
modelEndpointStatus?: ModelEndpointStatus;
/**
* Timestamp of when the model was last updated.
*/
lastUpdatedTime?: time;
/**
* Timestamp of when the model was last created.
*/
createdTime?: time;
/**
* The model ARN.
*/
arn?: fraudDetectorArn;
}
export type ExternalModelEndpointDataBlobMap = {[key: string]: ModelEndpointDataBlob};
export type ExternalModelList = ExternalModel[];
export type ExternalModelsMaxResults = number;
export interface FieldValidationMessage {
/**
* The field name.
*/
fieldName?: string;
/**
* The message ID.
*/
identifier?: string;
/**
* The message title.
*/
title?: string;
/**
* The message content.
*/
content?: string;
/**
* The message type.
*/
type?: string;
}
export interface FileValidationMessage {
/**
* The message title.
*/
title?: string;
/**
* The message content.
*/
content?: string;
/**
* The message type.
*/
type?: string;
}
export interface GetDetectorV