FraudDetector

public struct FraudDetector

Client object for interacting with AWS FraudDetector service.

This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.

Member variables

Initialization

  • Initialize the FraudDetector client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Creates a batch of variables.

    Declaration

    Swift

    public func batchCreateVariable(_ input: BatchCreateVariableRequest) -> EventLoopFuture<BatchCreateVariableResult>

  • Gets a batch of variables.

    Declaration

    Swift

    public func batchGetVariable(_ input: BatchGetVariableRequest) -> EventLoopFuture<BatchGetVariableResult>

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

    Declaration

    Swift

    public func createDetectorVersion(_ input: CreateDetectorVersionRequest) -> EventLoopFuture<CreateDetectorVersionResult>

  • Creates a model using the specified model type.

    Declaration

    Swift

    public func createModel(_ input: CreateModelRequest) -> EventLoopFuture<CreateModelResult>

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

    Declaration

    Swift

    public func createModelVersion(_ input: CreateModelVersionRequest) -> EventLoopFuture<CreateModelVersionResult>

  • Creates a rule for use with the specified detector.

    Declaration

    Swift

    public func createRule(_ input: CreateRuleRequest) -> EventLoopFuture<CreateRuleResult>

  • Creates a variable.

    Declaration

    Swift

    public func createVariable(_ input: CreateVariableRequest) -> EventLoopFuture<CreateVariableResult>

  • Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.

    Declaration

    Swift

    public func deleteDetector(_ input: DeleteDetectorRequest) -> EventLoopFuture<DeleteDetectorResult>

  • Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.

    Declaration

    Swift

    public func deleteDetectorVersion(_ input: DeleteDetectorVersionRequest) -> EventLoopFuture<DeleteDetectorVersionResult>

  • Deletes the specified event.

    Declaration

    Swift

    public func deleteEvent(_ input: DeleteEventRequest) -> EventLoopFuture<DeleteEventResult>

  • Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.

    Declaration

    Swift

    public func deleteRule(_ input: DeleteRuleRequest) -> EventLoopFuture<DeleteRuleResult>

  • Gets all versions for a specified detector.

    Declaration

    Swift

    public func describeDetector(_ input: DescribeDetectorRequest) -> EventLoopFuture<DescribeDetectorResult>

  • 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.

    Declaration

    Swift

    public func describeModelVersions(_ input: DescribeModelVersionsRequest) -> EventLoopFuture<DescribeModelVersionsResult>

  • Gets a particular detector version.

    Declaration

    Swift

    public func getDetectorVersion(_ input: GetDetectorVersionRequest) -> EventLoopFuture<GetDetectorVersionResult>

  • 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.

    Declaration

    Swift

    public func getDetectors(_ input: GetDetectorsRequest) -> EventLoopFuture<GetDetectorsResult>

  • 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.

    Declaration

    Swift

    public func getEntityTypes(_ input: GetEntityTypesRequest) -> EventLoopFuture<GetEntityTypesResult>

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

    Declaration

    Swift

    public func getEventPrediction(_ input: GetEventPredictionRequest) -> EventLoopFuture<GetEventPredictionResult>

  • 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.

    Declaration

    Swift

    public func getEventTypes(_ input: GetEventTypesRequest) -> EventLoopFuture<GetEventTypesResult>

  • 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.

    Declaration

    Swift

    public func getExternalModels(_ input: GetExternalModelsRequest) -> EventLoopFuture<GetExternalModelsResult>

  • 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.

    Declaration

    Swift

    public func getKMSEncryptionKey() -> EventLoopFuture<GetKMSEncryptionKeyResult>

  • 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.

    Declaration

    Swift

    public func getLabels(_ input: GetLabelsRequest) -> EventLoopFuture<GetLabelsResult>

  • Gets the details of the specified model version.

    Declaration

    Swift

    public func getModelVersion(_ input: GetModelVersionRequest) -> EventLoopFuture<GetModelVersionResult>

  • 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.

    Declaration

    Swift

    public func getModels(_ input: GetModelsRequest) -> EventLoopFuture<GetModelsResult>

  • 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.

    Declaration

    Swift

    public func getOutcomes(_ input: GetOutcomesRequest) -> EventLoopFuture<GetOutcomesResult>

  • 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.

    Declaration

    Swift

    public func getRules(_ input: GetRulesRequest) -> EventLoopFuture<GetRulesResult>

  • 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.

    Declaration

    Swift

    public func getVariables(_ input: GetVariablesRequest) -> EventLoopFuture<GetVariablesResult>

  • 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.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResult>

  • Creates or updates a detector.

    Declaration

    Swift

    public func putDetector(_ input: PutDetectorRequest) -> EventLoopFuture<PutDetectorResult>

  • 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.

    Declaration

    Swift

    public func putEntityType(_ input: PutEntityTypeRequest) -> EventLoopFuture<PutEntityTypeResult>

  • 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.

    Declaration

    Swift

    public func putEventType(_ input: PutEventTypeRequest) -> EventLoopFuture<PutEventTypeResult>

  • 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.

    Declaration

    Swift

    public func putExternalModel(_ input: PutExternalModelRequest) -> EventLoopFuture<PutExternalModelResult>

  • Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.

    Declaration

    Swift

    public func putKMSEncryptionKey(_ input: PutKMSEncryptionKeyRequest) -> EventLoopFuture<PutKMSEncryptionKeyResult>

  • 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.

    Declaration

    Swift

    public func putLabel(_ input: PutLabelRequest) -> EventLoopFuture<PutLabelResult>

  • Creates or updates an outcome.

    Declaration

    Swift

    public func putOutcome(_ input: PutOutcomeRequest) -> EventLoopFuture<PutOutcomeResult>

  • Assigns tags to a resource.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResult>

  • Removes tags from a resource.

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResult>

  • 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.

    Declaration

    Swift

    public func updateDetectorVersion(_ input: UpdateDetectorVersionRequest) -> EventLoopFuture<UpdateDetectorVersionResult>

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

    Declaration

    Swift

    public func updateDetectorVersionMetadata(_ input: UpdateDetectorVersionMetadataRequest) -> EventLoopFuture<UpdateDetectorVersionMetadataResult>

  • 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.

    Declaration

    Swift

    public func updateDetectorVersionStatus(_ input: UpdateDetectorVersionStatusRequest) -> EventLoopFuture<UpdateDetectorVersionStatusResult>

  • Updates a model. You can update the description attribute using this action.

    Declaration

    Swift

    public func updateModel(_ input: UpdateModelRequest) -> EventLoopFuture<UpdateModelResult>

  • 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.

    Declaration

    Swift

    public func updateModelVersion(_ input: UpdateModelVersionRequest) -> EventLoopFuture<UpdateModelVersionResult>

  • Updates the status of a model version. You can perform the following status updates: Change the TRAINING_COMPLETE status to ACTIVE. Change ACTIVEto INACTIVE.

    Declaration

    Swift

    public func updateModelVersionStatus(_ input: UpdateModelVersionStatusRequest) -> EventLoopFuture<UpdateModelVersionStatusResult>

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

    Declaration

    Swift

    public func updateRuleMetadata(_ input: UpdateRuleMetadataRequest) -> EventLoopFuture<UpdateRuleMetadataResult>

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

    Declaration

    Swift

    public func updateRuleVersion(_ input: UpdateRuleVersionRequest) -> EventLoopFuture<UpdateRuleVersionResult>

  • Updates a variable.

    Declaration

    Swift

    public func updateVariable(_ input: UpdateVariableRequest) -> EventLoopFuture<UpdateVariableResult>

Paginators

  • 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.

    Declaration

    Swift

    public func describeModelVersionsPaginator(_ input: DescribeModelVersionsRequest, onPage: @escaping (DescribeModelVersionsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getDetectorsPaginator(_ input: GetDetectorsRequest, onPage: @escaping (GetDetectorsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getEntityTypesPaginator(_ input: GetEntityTypesRequest, onPage: @escaping (GetEntityTypesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getEventTypesPaginator(_ input: GetEventTypesRequest, onPage: @escaping (GetEventTypesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getExternalModelsPaginator(_ input: GetExternalModelsRequest, onPage: @escaping (GetExternalModelsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getLabelsPaginator(_ input: GetLabelsRequest, onPage: @escaping (GetLabelsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getModelsPaginator(_ input: GetModelsRequest, onPage: @escaping (GetModelsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getOutcomesPaginator(_ input: GetOutcomesRequest, onPage: @escaping (GetOutcomesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getRulesPaginator(_ input: GetRulesRequest, onPage: @escaping (GetRulesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getVariablesPaginator(_ input: GetVariablesRequest, onPage: @escaping (GetVariablesResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func listTagsForResourcePaginator(_ input: ListTagsForResourceRequest, onPage: @escaping (ListTagsForResourceResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum DataSource : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum DataType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum DetectorVersionStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Language : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ModelEndpointStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ModelInputDataFormat : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ModelOutputDataFormat : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ModelSource : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ModelTypeEnum : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ModelVersionStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum RuleExecutionMode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TrainingDataSourceEnum : String, CustomStringConvertible, Codable