{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.frauddetector#AWSHawksNestServiceFacade": { "type": "service", "version": "2019-11-15", "operations": [ { "target": "com.amazonaws.frauddetector#BatchCreateVariable" }, { "target": "com.amazonaws.frauddetector#BatchGetVariable" }, { "target": "com.amazonaws.frauddetector#CancelBatchPredictionJob" }, { "target": "com.amazonaws.frauddetector#CreateBatchPredictionJob" }, { "target": "com.amazonaws.frauddetector#CreateDetectorVersion" }, { "target": "com.amazonaws.frauddetector#CreateModel" }, { "target": "com.amazonaws.frauddetector#CreateModelVersion" }, { "target": "com.amazonaws.frauddetector#CreateRule" }, { "target": "com.amazonaws.frauddetector#CreateVariable" }, { "target": "com.amazonaws.frauddetector#DeleteBatchPredictionJob" }, { "target": "com.amazonaws.frauddetector#DeleteDetector" }, { "target": "com.amazonaws.frauddetector#DeleteDetectorVersion" }, { "target": "com.amazonaws.frauddetector#DeleteEntityType" }, { "target": "com.amazonaws.frauddetector#DeleteEvent" }, { "target": "com.amazonaws.frauddetector#DeleteEventType" }, { "target": "com.amazonaws.frauddetector#DeleteExternalModel" }, { "target": "com.amazonaws.frauddetector#DeleteLabel" }, { "target": "com.amazonaws.frauddetector#DeleteModel" }, { "target": "com.amazonaws.frauddetector#DeleteModelVersion" }, { "target": "com.amazonaws.frauddetector#DeleteOutcome" }, { "target": "com.amazonaws.frauddetector#DeleteRule" }, { "target": "com.amazonaws.frauddetector#DeleteVariable" }, { "target": "com.amazonaws.frauddetector#DescribeDetector" }, { "target": "com.amazonaws.frauddetector#DescribeModelVersions" }, { "target": "com.amazonaws.frauddetector#GetBatchPredictionJobs" }, { "target": "com.amazonaws.frauddetector#GetDetectors" }, { "target": "com.amazonaws.frauddetector#GetDetectorVersion" }, { "target": "com.amazonaws.frauddetector#GetEntityTypes" }, { "target": "com.amazonaws.frauddetector#GetEventPrediction" }, { "target": "com.amazonaws.frauddetector#GetEventTypes" }, { "target": "com.amazonaws.frauddetector#GetExternalModels" }, { "target": "com.amazonaws.frauddetector#GetKMSEncryptionKey" }, { "target": "com.amazonaws.frauddetector#GetLabels" }, { "target": "com.amazonaws.frauddetector#GetModels" }, { "target": "com.amazonaws.frauddetector#GetModelVersion" }, { "target": "com.amazonaws.frauddetector#GetOutcomes" }, { "target": "com.amazonaws.frauddetector#GetRules" }, { "target": "com.amazonaws.frauddetector#GetVariables" }, { "target": "com.amazonaws.frauddetector#ListTagsForResource" }, { "target": "com.amazonaws.frauddetector#PutDetector" }, { "target": "com.amazonaws.frauddetector#PutEntityType" }, { "target": "com.amazonaws.frauddetector#PutEventType" }, { "target": "com.amazonaws.frauddetector#PutExternalModel" }, { "target": "com.amazonaws.frauddetector#PutKMSEncryptionKey" }, { "target": "com.amazonaws.frauddetector#PutLabel" }, { "target": "com.amazonaws.frauddetector#PutOutcome" }, { "target": "com.amazonaws.frauddetector#TagResource" }, { "target": "com.amazonaws.frauddetector#UntagResource" }, { "target": "com.amazonaws.frauddetector#UpdateDetectorVersion" }, { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionMetadata" }, { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionStatus" }, { "target": "com.amazonaws.frauddetector#UpdateModel" }, { "target": "com.amazonaws.frauddetector#UpdateModelVersion" }, { "target": "com.amazonaws.frauddetector#UpdateModelVersionStatus" }, { "target": "com.amazonaws.frauddetector#UpdateRuleMetadata" }, { "target": "com.amazonaws.frauddetector#UpdateRuleVersion" }, { "target": "com.amazonaws.frauddetector#UpdateVariable" } ], "traits": { "aws.api#service": { "sdkId": "FraudDetector", "arnNamespace": "frauddetector", "cloudFormationName": "FraudDetector", "cloudTrailEventSource": "frauddetector.amazonaws.com", "endpointPrefix": "frauddetector" }, "aws.auth#sigv4": { "name": "frauddetector" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "

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

", "smithy.api#title": "Amazon Fraud Detector", "smithy.api#xmlNamespace": { "uri": "http://hawksnest.amazonaws.com/doc/2019-11-15" } } }, "com.amazonaws.frauddetector#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.frauddetector#AsyncJobStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS_INITIALIZING", "name": "IN_PROGRESS_INITIALIZING" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "CANCEL_IN_PROGRESS", "name": "CANCEL_IN_PROGRESS" }, { "value": "CANCELED", "name": "CANCELED" }, { "value": "COMPLETE", "name": "COMPLETE" }, { "value": "FAILED", "name": "FAILED" } ] } }, "com.amazonaws.frauddetector#BatchCreateVariable": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#BatchCreateVariableRequest" }, "output": { "target": "com.amazonaws.frauddetector#BatchCreateVariableResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a batch of variables.

" } }, "com.amazonaws.frauddetector#BatchCreateVariableError": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name.

" } }, "code": { "target": "com.amazonaws.frauddetector#Integer2", "traits": { "smithy.api#documentation": "

The error code.

" } }, "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The error message.

" } } }, "traits": { "smithy.api#documentation": "

Provides the error of the batch create variable API.

" } }, "com.amazonaws.frauddetector#BatchCreateVariableErrorList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#BatchCreateVariableError" } }, "com.amazonaws.frauddetector#BatchCreateVariableRequest": { "type": "structure", "members": { "variableEntries": { "target": "com.amazonaws.frauddetector#VariableEntryList", "traits": { "smithy.api#documentation": "

The list of variables for the batch create variable request.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#BatchCreateVariableResult": { "type": "structure", "members": { "errors": { "target": "com.amazonaws.frauddetector#BatchCreateVariableErrorList", "traits": { "smithy.api#documentation": "

Provides the errors for the BatchCreateVariable request.

" } } } }, "com.amazonaws.frauddetector#BatchGetVariable": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#BatchGetVariableRequest" }, "output": { "target": "com.amazonaws.frauddetector#BatchGetVariableResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets a batch of variables.

" } }, "com.amazonaws.frauddetector#BatchGetVariableError": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The error name.

" } }, "code": { "target": "com.amazonaws.frauddetector#Integer2", "traits": { "smithy.api#documentation": "

The error code.

" } }, "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The error message.

" } } }, "traits": { "smithy.api#documentation": "

Provides the error of the batch get variable API.

" } }, "com.amazonaws.frauddetector#BatchGetVariableErrorList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#BatchGetVariableError" } }, "com.amazonaws.frauddetector#BatchGetVariableRequest": { "type": "structure", "members": { "names": { "target": "com.amazonaws.frauddetector#NameList", "traits": { "smithy.api#documentation": "

The list of variable names to get.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#BatchGetVariableResult": { "type": "structure", "members": { "variables": { "target": "com.amazonaws.frauddetector#VariableList", "traits": { "smithy.api#documentation": "

The returned variables.

" } }, "errors": { "target": "com.amazonaws.frauddetector#BatchGetVariableErrorList", "traits": { "smithy.api#documentation": "

The errors from the request.

" } } } }, "com.amazonaws.frauddetector#BatchPrediction": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The job ID for the batch prediction.

" } }, "status": { "target": "com.amazonaws.frauddetector#AsyncJobStatus", "traits": { "smithy.api#documentation": "

The batch prediction status.

" } }, "failureReason": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The reason a batch prediction job failed.

" } }, "startTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the batch prediction job started.

" } }, "completionTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the batch prediction job comleted.

" } }, "lastHeartbeatTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of most recent heartbeat indicating the batch prediction job was making progress.

" } }, "inputPath": { "target": "com.amazonaws.frauddetector#s3BucketLocation", "traits": { "smithy.api#documentation": "

The Amazon S3 location of your training file.

" } }, "outputPath": { "target": "com.amazonaws.frauddetector#s3BucketLocation", "traits": { "smithy.api#documentation": "

The Amazon S3 location of your output file.

" } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the event type.

" } }, "detectorName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the detector.

" } }, "detectorVersion": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The detector version.

" } }, "iamRoleArn": { "target": "com.amazonaws.frauddetector#iamRoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role to use for this job request.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The ARN of batch prediction job.

" } }, "processedRecordsCount": { "target": "com.amazonaws.frauddetector#Integer", "traits": { "smithy.api#documentation": "

The number of records processed by the batch prediction job.

" } }, "totalRecordsCount": { "target": "com.amazonaws.frauddetector#Integer", "traits": { "smithy.api#documentation": "

The total number of records in the batch prediction job.

" } } }, "traits": { "smithy.api#documentation": "

The batch prediction details.

" } }, "com.amazonaws.frauddetector#BatchPredictionList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#BatchPrediction" } }, "com.amazonaws.frauddetector#CancelBatchPredictionJob": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#CancelBatchPredictionJobRequest" }, "output": { "target": "com.amazonaws.frauddetector#CancelBatchPredictionJobResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Cancels the specified batch prediction job.

" } }, "com.amazonaws.frauddetector#CancelBatchPredictionJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID of the batch prediction job to cancel.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#CancelBatchPredictionJobResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

\n\t ", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.frauddetector#CreateBatchPredictionJob": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#CreateBatchPredictionJobRequest" }, "output": { "target": "com.amazonaws.frauddetector#CreateBatchPredictionJobResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a batch prediction job.

" } }, "com.amazonaws.frauddetector#CreateBatchPredictionJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID of the batch prediction job.

", "smithy.api#required": {} } }, "inputPath": { "target": "com.amazonaws.frauddetector#s3BucketLocation", "traits": { "smithy.api#documentation": "

The Amazon S3 location of your training file.

", "smithy.api#required": {} } }, "outputPath": { "target": "com.amazonaws.frauddetector#s3BucketLocation", "traits": { "smithy.api#documentation": "

The Amazon S3 location of your output file.

", "smithy.api#required": {} } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the event type.

", "smithy.api#required": {} } }, "detectorName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the detector.

", "smithy.api#required": {} } }, "detectorVersion": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The detector version.

" } }, "iamRoleArn": { "target": "com.amazonaws.frauddetector#iamRoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role to use for this job request.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#CreateBatchPredictionJobResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#CreateDetectorVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#CreateDetectorVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#CreateDetectorVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#CreateDetectorVersionRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID of the detector under which you want to create a new version.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The description of the detector version.

" } }, "externalModelEndpoints": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The Amazon Sagemaker model endpoints to include in the detector version.

" } }, "rules": { "target": "com.amazonaws.frauddetector#RuleList", "traits": { "smithy.api#documentation": "

The rules to include in the detector version.

", "smithy.api#required": {} } }, "modelVersions": { "target": "com.amazonaws.frauddetector#ListOfModelVersions", "traits": { "smithy.api#documentation": "

The model versions to include in the detector version.

" } }, "ruleExecutionMode": { "target": "com.amazonaws.frauddetector#RuleExecutionMode", "traits": { "smithy.api#documentation": "

The rule execution mode for the rules included in the detector version.

\n\t

You can define and edit the rule mode at the detector version level, when it is in draft status.

\n\t

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.

\n\t

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

\n

The default behavior is FIRST_MATCHED.

" } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#CreateDetectorVersionResult": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID for the created version's parent detector.

" } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#nonEmptyString", "traits": { "smithy.api#documentation": "

The ID for the created detector.

" } }, "status": { "target": "com.amazonaws.frauddetector#DetectorVersionStatus", "traits": { "smithy.api#documentation": "

The status of the detector version.

" } } } }, "com.amazonaws.frauddetector#CreateModel": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#CreateModelRequest" }, "output": { "target": "com.amazonaws.frauddetector#CreateModelResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a model using the specified model type.

" } }, "com.amazonaws.frauddetector#CreateModelRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The model description.

" } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the event type.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#CreateModelResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#CreateModelVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#CreateModelVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#CreateModelVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#CreateModelVersionRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, "trainingDataSource": { "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", "traits": { "smithy.api#documentation": "

The training data source location in Amazon S3.

", "smithy.api#required": {} } }, "trainingDataSchema": { "target": "com.amazonaws.frauddetector#TrainingDataSchema", "traits": { "smithy.api#documentation": "

The training data schema.

", "smithy.api#required": {} } }, "externalEventsDetail": { "target": "com.amazonaws.frauddetector#ExternalEventsDetail", "traits": { "smithy.api#documentation": "

Details for the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.

" } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#CreateModelVersionResult": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

" } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

" } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#nonEmptyString", "traits": { "smithy.api#documentation": "

The model version number of the model version created.

" } }, "status": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The model version status.

" } } } }, "com.amazonaws.frauddetector#CreateRule": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#CreateRuleRequest" }, "output": { "target": "com.amazonaws.frauddetector#CreateRuleResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a rule for use with the specified detector.

" } }, "com.amazonaws.frauddetector#CreateRuleRequest": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The rule ID.

", "smithy.api#required": {} } }, "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID for the rule's parent detector.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The rule description.

" } }, "expression": { "target": "com.amazonaws.frauddetector#ruleExpression", "traits": { "smithy.api#documentation": "

The rule expression.

", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.frauddetector#Language", "traits": { "smithy.api#documentation": "

The language of the rule.

", "smithy.api#required": {} } }, "outcomes": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { "smithy.api#documentation": "

The outcome or outcomes returned when the rule expression matches.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#CreateRuleResult": { "type": "structure", "members": { "rule": { "target": "com.amazonaws.frauddetector#Rule", "traits": { "smithy.api#documentation": "

The created rule.

" } } } }, "com.amazonaws.frauddetector#CreateVariable": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#CreateVariableRequest" }, "output": { "target": "com.amazonaws.frauddetector#CreateVariableResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a variable.

" } }, "com.amazonaws.frauddetector#CreateVariableRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable.

", "smithy.api#required": {} } }, "dataType": { "target": "com.amazonaws.frauddetector#DataType", "traits": { "smithy.api#documentation": "

The data type.

", "smithy.api#required": {} } }, "dataSource": { "target": "com.amazonaws.frauddetector#DataSource", "traits": { "smithy.api#documentation": "

The source of the data.

", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The default value for the variable when no value is received.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The description.

" } }, "variableType": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The variable type. For more information see Variable types.\n\t\t\t\t

\n

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\n

" } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#CreateVariableResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#CsvIndexToVariableMap": { "type": "map", "key": { "target": "com.amazonaws.frauddetector#string" }, "value": { "target": "com.amazonaws.frauddetector#string" } }, "com.amazonaws.frauddetector#DataSource": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EVENT", "name": "EVENT" }, { "value": "MODEL_SCORE", "name": "MODEL_SCORE" }, { "value": "EXTERNAL_MODEL_SCORE", "name": "EXTERNAL_MODEL_SCORE" } ] } }, "com.amazonaws.frauddetector#DataType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STRING", "name": "STRING" }, { "value": "INTEGER", "name": "INTEGER" }, { "value": "FLOAT", "name": "FLOAT" }, { "value": "BOOLEAN", "name": "BOOLEAN" } ] } }, "com.amazonaws.frauddetector#DataValidationMetrics": { "type": "structure", "members": { "fileLevelMessages": { "target": "com.amazonaws.frauddetector#fileValidationMessageList", "traits": { "smithy.api#documentation": "

The file-specific model training validation messages.

" } }, "fieldLevelMessages": { "target": "com.amazonaws.frauddetector#fieldValidationMessageList", "traits": { "smithy.api#documentation": "

The field-specific model training validation messages.

" } } }, "traits": { "smithy.api#documentation": "

The model training validation messages.

" } }, "com.amazonaws.frauddetector#DeleteBatchPredictionJob": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteBatchPredictionJobRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteBatchPredictionJobResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a batch prediction job.

" } }, "com.amazonaws.frauddetector#DeleteBatchPredictionJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID of the batch prediction job to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteBatchPredictionJobResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteDetector": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteDetectorRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteDetectorResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

\n\t

When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteDetectorRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID of the detector to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteDetectorResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteDetectorVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteDetectorVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteDetectorVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

\n\t \t

When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteDetectorVersionRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID of the parent detector for the detector version to delete.

", "smithy.api#required": {} } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The ID of the detector version to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteDetectorVersionResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteEntityType": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteEntityTypeRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteEntityTypeResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an entity type.

\n\t

You cannot delete an entity type that is included in an event type.

\n\t

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.

" } }, "com.amazonaws.frauddetector#DeleteEntityTypeRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the entity type to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteEntityTypeResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteEvent": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteEventRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteEventResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified event.

\n\t

When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteEventRequest": { "type": "structure", "members": { "eventId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The ID of the event to delete.

", "smithy.api#required": {} } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the event type.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteEventResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteEventType": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteEventTypeRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteEventTypeResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an event type.

\n\t

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

\n\t

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.

" } }, "com.amazonaws.frauddetector#DeleteEventTypeRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the event type to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteEventTypeResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteExternalModel": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteExternalModelRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteExternalModelResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes a SageMaker model from Amazon Fraud Detector.

\n\t

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.

" } }, "com.amazonaws.frauddetector#DeleteExternalModelRequest": { "type": "structure", "members": { "modelEndpoint": { "target": "com.amazonaws.frauddetector#sageMakerEndpointIdentifier", "traits": { "smithy.api#documentation": "

The endpoint of the Amazon Sagemaker model to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteExternalModelResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteLabel": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteLabelRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteLabelResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a label.

\n\t

You cannot delete labels that are included in an event type in Amazon Fraud Detector.

\n

You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.

\n\n

When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteLabelRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the label to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteLabelResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteModel": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteModelRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteModelResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a model.

\n\t

You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.

\n\t

When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteModelRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID of the model to delete.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type of the model to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteModelResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteModelVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteModelVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteModelVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a model version.

\n\t

You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.

\n\t

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.

" } }, "com.amazonaws.frauddetector#DeleteModelVersionRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID of the model version to delete.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type of the model version to delete.

", "smithy.api#required": {} } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The model version number of the model version to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteModelVersionResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteOutcome": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteOutcomeRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteOutcomeResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an outcome.

\n\t

You cannot delete an outcome that is used in a rule version.

\n\t

When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteOutcomeRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the outcome to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteOutcomeResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteRule": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteRuleRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteRuleResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

\n\t \t

When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteRuleRequest": { "type": "structure", "members": { "rule": { "target": "com.amazonaws.frauddetector#Rule", "traits": { "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteRuleResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DeleteVariable": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DeleteVariableRequest" }, "output": { "target": "com.amazonaws.frauddetector#DeleteVariableResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a variable.

\n\t

You can't delete variables that are included in an event type in Amazon Fraud Detector.

\n\t

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.

\n\t

When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.

" } }, "com.amazonaws.frauddetector#DeleteVariableRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#DeleteVariableResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#DescribeDetector": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DescribeDetectorRequest" }, "output": { "target": "com.amazonaws.frauddetector#DescribeDetectorResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets all versions for a specified detector.

" } }, "com.amazonaws.frauddetector#DescribeDetectorRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token from the previous response.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#DetectorVersionMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for the request.

" } } } }, "com.amazonaws.frauddetector#DescribeDetectorResult": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

" } }, "detectorVersionSummaries": { "target": "com.amazonaws.frauddetector#DetectorVersionSummaryList", "traits": { "smithy.api#documentation": "

The status and description for each detector version.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token to be used for subsequent requests.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The detector ARN.

" } } } }, "com.amazonaws.frauddetector#DescribeModelVersions": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#DescribeModelVersionsRequest" }, "output": { "target": "com.amazonaws.frauddetector#DescribeModelVersionsResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#DescribeModelVersionsRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

" } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The model version number.

" } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token from the previous results.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#modelsMaxPageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return.

" } } } }, "com.amazonaws.frauddetector#DescribeModelVersionsResult": { "type": "structure", "members": { "modelVersionDetails": { "target": "com.amazonaws.frauddetector#modelVersionDetailList", "traits": { "smithy.api#documentation": "

The model version details.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token.

" } } } }, "com.amazonaws.frauddetector#Detector": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The detector description.

" } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the event type.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the detector was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the detector was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The detector ARN.

" } } }, "traits": { "smithy.api#documentation": "

The detector.

" } }, "com.amazonaws.frauddetector#DetectorList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Detector" } }, "com.amazonaws.frauddetector#DetectorVersionMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1000, "max": 2500 } } }, "com.amazonaws.frauddetector#DetectorVersionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DRAFT", "name": "DRAFT" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" } ] } }, "com.amazonaws.frauddetector#DetectorVersionSummary": { "type": "structure", "members": { "detectorVersionId": { "target": "com.amazonaws.frauddetector#nonEmptyString", "traits": { "smithy.api#documentation": "

The detector version ID.

" } }, "status": { "target": "com.amazonaws.frauddetector#DetectorVersionStatus", "traits": { "smithy.api#documentation": "

The detector version status.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The detector version description.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the detector version was last updated.

" } } }, "traits": { "smithy.api#documentation": "

The summary of the detector version.

" } }, "com.amazonaws.frauddetector#DetectorVersionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#DetectorVersionSummary" } }, "com.amazonaws.frauddetector#DetectorsMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 10 } } }, "com.amazonaws.frauddetector#Entity": { "type": "structure", "members": { "entityType": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The entity type.

", "smithy.api#required": {} } }, "entityId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The entity details.

", "smithy.api#sensitive": {} } }, "com.amazonaws.frauddetector#EntityType": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The entity type name.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The entity type description.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the entity type was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the entity type was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The entity type ARN.

" } } }, "traits": { "smithy.api#documentation": "

The entity type details.

" } }, "com.amazonaws.frauddetector#EventType": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The event type name.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The event type description.

" } }, "eventVariables": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The event type event variables.

" } }, "labels": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The event type labels.

" } }, "entityTypes": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { "smithy.api#documentation": "

The event type entity types.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the event type was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the event type was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The entity type ARN.

" } } }, "traits": { "smithy.api#documentation": "

The event type details.

", "smithy.api#sensitive": {} } }, "com.amazonaws.frauddetector#EventVariableMap": { "type": "map", "key": { "target": "com.amazonaws.frauddetector#variableName" }, "value": { "target": "com.amazonaws.frauddetector#variableValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.frauddetector#ExternalEventsDetail": { "type": "structure", "members": { "dataLocation": { "target": "com.amazonaws.frauddetector#s3BucketLocation", "traits": { "smithy.api#documentation": "

The Amazon S3 bucket location for the data.

", "smithy.api#required": {} } }, "dataAccessRoleArn": { "target": "com.amazonaws.frauddetector#iamRoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role that provides Amazon Fraud Detector access to the data location.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details for the external events data used for model version training.

" } }, "com.amazonaws.frauddetector#ExternalModel": { "type": "structure", "members": { "modelEndpoint": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The Amazon SageMaker model endpoints.

" } }, "modelSource": { "target": "com.amazonaws.frauddetector#ModelSource", "traits": { "smithy.api#documentation": "

The source of the model.

" } }, "invokeModelEndpointRoleArn": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The role used to invoke the model.

" } }, "inputConfiguration": { "target": "com.amazonaws.frauddetector#ModelInputConfiguration", "traits": { "smithy.api#documentation": "

The input configuration.

" } }, "outputConfiguration": { "target": "com.amazonaws.frauddetector#ModelOutputConfiguration", "traits": { "smithy.api#documentation": "

The output configuration.

" } }, "modelEndpointStatus": { "target": "com.amazonaws.frauddetector#ModelEndpointStatus", "traits": { "smithy.api#documentation": "

The Amazon Fraud Detector status for the external model endpoint

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the model was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the model was last created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The model ARN.

" } } }, "traits": { "smithy.api#documentation": "

The Amazon SageMaker model.

" } }, "com.amazonaws.frauddetector#ExternalModelEndpointDataBlobMap": { "type": "map", "key": { "target": "com.amazonaws.frauddetector#string" }, "value": { "target": "com.amazonaws.frauddetector#ModelEndpointDataBlob" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.frauddetector#ExternalModelList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#ExternalModel" } }, "com.amazonaws.frauddetector#ExternalModelOutputs": { "type": "structure", "members": { "externalModel": { "target": "com.amazonaws.frauddetector#ExternalModelSummary", "traits": { "smithy.api#documentation": "

The Amazon SageMaker model.

" } }, "outputs": { "target": "com.amazonaws.frauddetector#ExternalModelPredictionMap", "traits": { "smithy.api#documentation": "

The fraud prediction scores from Amazon SageMaker model.

" } } }, "traits": { "smithy.api#documentation": "

The fraud prediction scores from Amazon SageMaker model.

" } }, "com.amazonaws.frauddetector#ExternalModelPredictionMap": { "type": "map", "key": { "target": "com.amazonaws.frauddetector#string" }, "value": { "target": "com.amazonaws.frauddetector#string" } }, "com.amazonaws.frauddetector#ExternalModelSummary": { "type": "structure", "members": { "modelEndpoint": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The endpoint of the Amazon SageMaker model.

" } }, "modelSource": { "target": "com.amazonaws.frauddetector#ModelSource", "traits": { "smithy.api#documentation": "

The source of the model.

" } } }, "traits": { "smithy.api#documentation": "

The Amazon SageMaker model.

" } }, "com.amazonaws.frauddetector#ExternalModelsMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 10 } } }, "com.amazonaws.frauddetector#FieldValidationMessage": { "type": "structure", "members": { "fieldName": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The field name.

" } }, "identifier": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The message ID.

" } }, "title": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The message title.

" } }, "content": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The message content.

" } }, "type": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The message type.

" } } }, "traits": { "smithy.api#documentation": "

The message details.

" } }, "com.amazonaws.frauddetector#FileValidationMessage": { "type": "structure", "members": { "title": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The message title.

" } }, "content": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The message content.

" } }, "type": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The message type.

" } } }, "traits": { "smithy.api#documentation": "

The message details.

" } }, "com.amazonaws.frauddetector#GetBatchPredictionJobs": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetBatchPredictionJobsRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetBatchPredictionJobsResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetBatchPredictionJobsRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The batch prediction job for which to get the details.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#batchPredictionsMaxPageSize", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token from the previous request.

" } } } }, "com.amazonaws.frauddetector#GetBatchPredictionJobsResult": { "type": "structure", "members": { "batchPredictions": { "target": "com.amazonaws.frauddetector#BatchPredictionList", "traits": { "smithy.api#documentation": "

An array containing the details of each batch prediction job.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for the subsequent request.

" } } } }, "com.amazonaws.frauddetector#GetDetectorVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetDetectorVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetDetectorVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets a particular detector version.

" } }, "com.amazonaws.frauddetector#GetDetectorVersionRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The detector version ID.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#GetDetectorVersionResult": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

" } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The detector version ID.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The detector version description.

" } }, "externalModelEndpoints": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The Amazon SageMaker model endpoints included in the detector version.

" } }, "modelVersions": { "target": "com.amazonaws.frauddetector#ListOfModelVersions", "traits": { "smithy.api#documentation": "

The model versions included in the detector version.

" } }, "rules": { "target": "com.amazonaws.frauddetector#RuleList", "traits": { "smithy.api#documentation": "

The rules included in the detector version.

" } }, "status": { "target": "com.amazonaws.frauddetector#DetectorVersionStatus", "traits": { "smithy.api#documentation": "

The status of the detector version.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp when the detector version was last updated.\n

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp when the detector version was created.

" } }, "ruleExecutionMode": { "target": "com.amazonaws.frauddetector#RuleExecutionMode", "traits": { "smithy.api#documentation": "

The execution mode of the rule in the dectector

\n\t

\n FIRST_MATCHED indicates that 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.

\n\t

\n ALL_MATCHED indicates that 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.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The detector version ARN.

" } } } }, "com.amazonaws.frauddetector#GetDetectors": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetDetectorsRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetDetectorsResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you\n provide a null maxResults, this action retrieves a maximum of 10 records\n per page. If you provide a maxResults, the value must be between 5 and 10.\n To get the next page results, provide the pagination token from the\n GetDetectorsResponse as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetDetectorsRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for the subsequent request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#DetectorsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetDetectorsResult": { "type": "structure", "members": { "detectors": { "target": "com.amazonaws.frauddetector#DetectorList", "traits": { "smithy.api#documentation": "

The detectors.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token.

" } } } }, "com.amazonaws.frauddetector#GetEntityTypes": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetEntityTypesRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetEntityTypesResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you\n provide a null maxResults, this action retrieves a maximum of 10 records\n per page. If you provide a maxResults, the value must be between 5 and 10.\n To get the next page results, provide the pagination token from the\n GetEntityTypesResponse as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetEntityTypesRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for the subsequent request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#entityTypesMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetEntityTypesResult": { "type": "structure", "members": { "entityTypes": { "target": "com.amazonaws.frauddetector#entityTypeList", "traits": { "smithy.api#documentation": "

An array of entity types.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token.

" } } } }, "com.amazonaws.frauddetector#GetEventPrediction": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetEventPredictionRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetEventPredictionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ResourceUnavailableException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#GetEventPredictionRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The detector version ID.

" } }, "eventId": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The unique ID used to identify the event.

", "smithy.api#required": {} } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The event type associated with the detector specified for the prediction.

", "smithy.api#required": {} } }, "entities": { "target": "com.amazonaws.frauddetector#listOfEntities", "traits": { "smithy.api#documentation": "

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.\"

", "smithy.api#required": {} } }, "eventTimestamp": { "target": "com.amazonaws.frauddetector#utcTimestampISO8601", "traits": { "smithy.api#documentation": "

Timestamp that defines when the event under evaluation occurred.

", "smithy.api#required": {} } }, "eventVariables": { "target": "com.amazonaws.frauddetector#EventVariableMap", "traits": { "smithy.api#documentation": "

Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and \n their corresponding values for the event you are sending for evaluation.

\n \n \n \n \n

To ensure highest possible fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows:

\n \n

\n For Amazon Fraud Detector trained models:\n

\n

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) \n with calculated default mean/medians for numeric variables and with special values for categorical variables.

\n \n

\n For External models ( for example, imported SageMaker):\n

\n

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 \n will use the default value that is provided for the variable.

", "smithy.api#required": {} } }, "externalModelEndpointDataBlobs": { "target": "com.amazonaws.frauddetector#ExternalModelEndpointDataBlobMap", "traits": { "smithy.api#documentation": "

The Amazon SageMaker model endpoint input data blobs.

" } } } }, "com.amazonaws.frauddetector#GetEventPredictionResult": { "type": "structure", "members": { "modelScores": { "target": "com.amazonaws.frauddetector#ListOfModelScores", "traits": { "smithy.api#documentation": "

The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.

" } }, "ruleResults": { "target": "com.amazonaws.frauddetector#ListOfRuleResults", "traits": { "smithy.api#documentation": "

The results from the rules.

" } }, "externalModelOutputs": { "target": "com.amazonaws.frauddetector#ListOfExternalModelOutputs", "traits": { "smithy.api#documentation": "

The model scores for Amazon SageMaker models.

" } } } }, "com.amazonaws.frauddetector#GetEventTypes": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetEventTypesRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetEventTypesResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets all event types or a specific event type if name is provided. This is a paginated API. If you\n provide a null maxResults, this action retrieves a maximum of 10 records\n per page. If you provide a maxResults, the value must be between 5 and 10.\n To get the next page results, provide the pagination token from the\n GetEventTypesResponse as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetEventTypesRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for the subsequent request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#eventTypesMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetEventTypesResult": { "type": "structure", "members": { "eventTypes": { "target": "com.amazonaws.frauddetector#eventTypeList", "traits": { "smithy.api#documentation": "

An array of event types.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token.

" } } } }, "com.amazonaws.frauddetector#GetExternalModels": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetExternalModelsRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetExternalModelsResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets the details for one or more Amazon SageMaker models that have been imported into the\n service. This is a paginated API. If you provide a null maxResults, this\n actions retrieves a maximum of 10 records per page. If you provide a\n maxResults, the value must be between 5 and 10. To get the next page\n results, provide the pagination token from the GetExternalModelsResult as part\n of your request. A null pagination token fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetExternalModelsRequest": { "type": "structure", "members": { "modelEndpoint": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The Amazon SageMaker model endpoint.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token for the request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#ExternalModelsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetExternalModelsResult": { "type": "structure", "members": { "externalModels": { "target": "com.amazonaws.frauddetector#ExternalModelList", "traits": { "smithy.api#documentation": "

Gets the Amazon SageMaker models.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token to be used in subsequent requests.

" } } } }, "com.amazonaws.frauddetector#GetKMSEncryptionKey": { "type": "operation", "output": { "target": "com.amazonaws.frauddetector#GetKMSEncryptionKeyResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.frauddetector#GetKMSEncryptionKeyResult": { "type": "structure", "members": { "kmsKey": { "target": "com.amazonaws.frauddetector#KMSKey", "traits": { "smithy.api#documentation": "

The KMS encryption key.

" } } } }, "com.amazonaws.frauddetector#GetLabels": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetLabelsRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetLabelsResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets all labels or a specific label if name is provided. This is a paginated API. If you\n provide a null maxResults, this action retrieves a maximum of 50 records\n per page. If you provide a maxResults, the value must be between 10 and 50.\n To get the next page results, provide the pagination token from the\n GetGetLabelsResponse as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetLabelsRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the label or labels to get.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for the subsequent request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#labelsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetLabelsResult": { "type": "structure", "members": { "labels": { "target": "com.amazonaws.frauddetector#labelList", "traits": { "smithy.api#documentation": "

An array of labels.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token.

" } } } }, "com.amazonaws.frauddetector#GetModelVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetModelVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetModelVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets the details of the specified model version.

" } }, "com.amazonaws.frauddetector#GetModelVersionRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The model version number.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#GetModelVersionResult": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

" } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

" } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The model version number.

" } }, "trainingDataSource": { "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", "traits": { "smithy.api#documentation": "

The training data source.

" } }, "trainingDataSchema": { "target": "com.amazonaws.frauddetector#TrainingDataSchema", "traits": { "smithy.api#documentation": "

The training data schema.

" } }, "externalEventsDetail": { "target": "com.amazonaws.frauddetector#ExternalEventsDetail", "traits": { "smithy.api#documentation": "

The event details.

" } }, "status": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The model version status.

\n\t

Possible values are:

\n\t " } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The model version ARN.

" } } } }, "com.amazonaws.frauddetector#GetModels": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetModelsRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetModelsResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

\n

This is a paginated API. If you\n provide a null maxResults, this action retrieves a maximum of 10 records\n per page. If you provide a maxResults, the value must be between 1 and 10.\n To get the next page results, provide the pagination token from the\n response as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetModelsRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

" } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for the subsequent request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#modelsMaxPageSize", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetModelsResult": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token to be used in subsequent requests.

" } }, "models": { "target": "com.amazonaws.frauddetector#modelList", "traits": { "smithy.api#documentation": "

The array of models.

" } } } }, "com.amazonaws.frauddetector#GetOutcomes": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetOutcomesRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetOutcomesResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets one or more outcomes. This is a paginated\n API. If you provide a null maxResults, this actions retrieves a maximum of\n 100 records per page. If you provide a maxResults, the value must be\n between 50 and 100. To get the next page results, provide the pagination token from the\n GetOutcomesResult as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetOutcomesRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the outcome or outcomes to get.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token for the request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#OutcomesMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetOutcomesResult": { "type": "structure", "members": { "outcomes": { "target": "com.amazonaws.frauddetector#OutcomeList", "traits": { "smithy.api#documentation": "

The outcomes.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token for subsequent requests.

" } } } }, "com.amazonaws.frauddetector#GetRules": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetRulesRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetRulesResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

\n

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.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetRulesRequest": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The rule ID.

" } }, "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, "ruleVersion": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The rule version.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#RulesMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of rules to return for the request.

" } } } }, "com.amazonaws.frauddetector#GetRulesResult": { "type": "structure", "members": { "ruleDetails": { "target": "com.amazonaws.frauddetector#RuleDetailList", "traits": { "smithy.api#documentation": "

The details of the requested rule.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token to be used in subsequent requests.

" } } } }, "com.amazonaws.frauddetector#GetVariables": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#GetVariablesRequest" }, "output": { "target": "com.amazonaws.frauddetector#GetVariablesResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets all of the variables or the specific variable. This is a\n paginated API. Providing null maxSizePerPage results in retrieving maximum of\n 100 records per page. If you provide maxSizePerPage the value must be between\n 50 and 100. To get the next page result, a provide a pagination token from\n GetVariablesResult as part of your request. Null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#GetVariablesRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token of the get variable request.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#VariablesMaxResults", "traits": { "smithy.api#documentation": "

The max size per page determined for the get variable request.

" } } } }, "com.amazonaws.frauddetector#GetVariablesResult": { "type": "structure", "members": { "variables": { "target": "com.amazonaws.frauddetector#VariableList", "traits": { "smithy.api#documentation": "

The names of the variables returned.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next page token to be used in subsequent requests.

" } } } }, "com.amazonaws.frauddetector#Integer": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.frauddetector#Integer2": { "type": "integer" }, "com.amazonaws.frauddetector#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An exception indicating an internal server error.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.frauddetector#JsonKeyToVariableMap": { "type": "map", "key": { "target": "com.amazonaws.frauddetector#string" }, "value": { "target": "com.amazonaws.frauddetector#string" } }, "com.amazonaws.frauddetector#KMSKey": { "type": "structure", "members": { "kmsEncryptionKeyArn": { "target": "com.amazonaws.frauddetector#KmsEncryptionKeyArn", "traits": { "smithy.api#documentation": "

The encryption key ARN.

" } } }, "traits": { "smithy.api#documentation": "

The KMS key details.

" } }, "com.amazonaws.frauddetector#KmsEncryptionKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 7, "max": 90 }, "smithy.api#pattern": "^DEFAULT|arn:[a-zA-Z0-9-]+:kms:[a-zA-Z0-9-]+:\\d{12}:key\\/\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}$" } }, "com.amazonaws.frauddetector#Label": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The label name.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The label description.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the label was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the event type was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The label ARN.

" } } }, "traits": { "smithy.api#documentation": "

The label details.

" } }, "com.amazonaws.frauddetector#LabelSchema": { "type": "structure", "members": { "labelMapper": { "target": "com.amazonaws.frauddetector#labelMapper", "traits": { "smithy.api#documentation": "

The label mapper maps the Amazon Fraud Detector supported model classification labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if \"FRAUD\" and \"LEGIT\" are Amazon Fraud Detector supported labels, this mapper could be: {\"FRAUD\" => [\"0\"], \"LEGIT\" => [\"1\"]} or {\"FRAUD\" => [\"false\"], \"LEGIT\" => [\"true\"]} or {\"FRAUD\" => [\"fraud\", \"abuse\"], \"LEGIT\" => [\"legit\", \"safe\"]}. The value part of the mapper is a list, because you may have multiple label variants from your event type for a single Amazon Fraud Detector label.\n

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The label schema.

" } }, "com.amazonaws.frauddetector#Language": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DETECTORPL", "name": "DETECTORPL" } ] } }, "com.amazonaws.frauddetector#ListOfExternalModelOutputs": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#ExternalModelOutputs" } }, "com.amazonaws.frauddetector#ListOfLogOddsMetrics": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#LogOddsMetric" } }, "com.amazonaws.frauddetector#ListOfModelScores": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#ModelScores" } }, "com.amazonaws.frauddetector#ListOfModelVersions": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#ModelVersion" } }, "com.amazonaws.frauddetector#ListOfRuleResults": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#RuleResult" } }, "com.amazonaws.frauddetector#ListOfStrings": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#string" } }, "com.amazonaws.frauddetector#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.frauddetector#ListTagsForResourceResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the\n response as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.frauddetector#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceARN": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token from the previous results.

" } }, "maxResults": { "target": "com.amazonaws.frauddetector#TagsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of objects to return for the request.

" } } } }, "com.amazonaws.frauddetector#ListTagsForResourceResult": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } }, "nextToken": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The next token for subsequent requests.

" } } } }, "com.amazonaws.frauddetector#LogOddsMetric": { "type": "structure", "members": { "variableName": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable.

", "smithy.api#required": {} } }, "variableType": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The type of variable.

", "smithy.api#required": {} } }, "variableImportance": { "target": "com.amazonaws.frauddetector#float", "traits": { "smithy.api#documentation": "

The relative importance of the variable. For more information, see Model variable importance.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The log odds metric details.

" } }, "com.amazonaws.frauddetector#MetricDataPoint": { "type": "structure", "members": { "fpr": { "target": "com.amazonaws.frauddetector#float", "traits": { "smithy.api#documentation": "

The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.

" } }, "precision": { "target": "com.amazonaws.frauddetector#float", "traits": { "smithy.api#documentation": "

The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.

" } }, "tpr": { "target": "com.amazonaws.frauddetector#float", "traits": { "smithy.api#documentation": "

The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.

" } }, "threshold": { "target": "com.amazonaws.frauddetector#float", "traits": { "smithy.api#documentation": "

The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.

" } } }, "traits": { "smithy.api#documentation": "

Model performance metrics data points.

" } }, "com.amazonaws.frauddetector#Model": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

" } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The model description.

" } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the event type.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of when the model was created.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of last time the model was updated.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The ARN of the model.

" } } }, "traits": { "smithy.api#documentation": "

The model.

" } }, "com.amazonaws.frauddetector#ModelEndpointDataBlob": { "type": "structure", "members": { "byteBuffer": { "target": "com.amazonaws.frauddetector#blob", "traits": { "smithy.api#documentation": "

The byte buffer of the Amazon SageMaker model endpoint input data blob.

" } }, "contentType": { "target": "com.amazonaws.frauddetector#contentType", "traits": { "smithy.api#documentation": "

The content type of the Amazon SageMaker model endpoint input data blob.

" } } }, "traits": { "smithy.api#documentation": "

A pre-formed Amazon SageMaker model input you can include if your detector version includes an imported Amazon SageMaker model endpoint with pass-through input configuration.

" } }, "com.amazonaws.frauddetector#ModelEndpointStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ASSOCIATED", "name": "ASSOCIATED" }, { "value": "DISSOCIATED", "name": "DISSOCIATED" } ] } }, "com.amazonaws.frauddetector#ModelInputConfiguration": { "type": "structure", "members": { "eventTypeName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The event type name.

" } }, "format": { "target": "com.amazonaws.frauddetector#ModelInputDataFormat", "traits": { "smithy.api#documentation": "

The format of the model input configuration. The format differs depending on if it is\n passed through to SageMaker or constructed by Amazon Fraud Detector.

" } }, "useEventVariables": { "target": "com.amazonaws.frauddetector#UseEventVariables", "traits": { "smithy.api#documentation": "

The event variables.

", "smithy.api#required": {} } }, "jsonInputTemplate": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

Template for constructing the JSON input-data sent to SageMaker. At event-evaluation,\n the placeholders for variable names in the template will be replaced with the variable\n values before being sent to SageMaker.

" } }, "csvInputTemplate": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

Template for constructing the CSV input-data sent to SageMaker. At event-evaluation,\n the placeholders for variable-names in the template will be replaced with the variable\n values before being sent to SageMaker.

" } } }, "traits": { "smithy.api#documentation": "

The Amazon SageMaker model input configuration.

" } }, "com.amazonaws.frauddetector#ModelInputDataFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TEXT_CSV", "name": "CSV" }, { "value": "APPLICATION_JSON", "name": "JSON" } ] } }, "com.amazonaws.frauddetector#ModelOutputConfiguration": { "type": "structure", "members": { "format": { "target": "com.amazonaws.frauddetector#ModelOutputDataFormat", "traits": { "smithy.api#documentation": "

The format of the model output configuration.

", "smithy.api#required": {} } }, "jsonKeyToVariableMap": { "target": "com.amazonaws.frauddetector#JsonKeyToVariableMap", "traits": { "smithy.api#documentation": "

A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.

" } }, "csvIndexToVariableMap": { "target": "com.amazonaws.frauddetector#CsvIndexToVariableMap", "traits": { "smithy.api#documentation": "

A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.

" } } }, "traits": { "smithy.api#documentation": "

Provides the Amazon Sagemaker model output configuration.

" } }, "com.amazonaws.frauddetector#ModelOutputDataFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TEXT_CSV", "name": "CSV" }, { "value": "APPLICATION_JSONLINES", "name": "JSONLINES" } ] } }, "com.amazonaws.frauddetector#ModelPredictionMap": { "type": "map", "key": { "target": "com.amazonaws.frauddetector#string" }, "value": { "target": "com.amazonaws.frauddetector#float" } }, "com.amazonaws.frauddetector#ModelScores": { "type": "structure", "members": { "modelVersion": { "target": "com.amazonaws.frauddetector#ModelVersion", "traits": { "smithy.api#documentation": "

The model version.

" } }, "scores": { "target": "com.amazonaws.frauddetector#ModelPredictionMap", "traits": { "smithy.api#documentation": "

The model's fraud prediction scores.

" } } }, "traits": { "smithy.api#documentation": "

The fraud prediction scores.

" } }, "com.amazonaws.frauddetector#ModelSource": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SAGEMAKER", "name": "SAGEMAKER" } ] } }, "com.amazonaws.frauddetector#ModelTypeEnum": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ONLINE_FRAUD_INSIGHTS", "name": "ONLINE_FRAUD_INSIGHTS" } ] } }, "com.amazonaws.frauddetector#ModelVersion": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#nonEmptyString", "traits": { "smithy.api#documentation": "

The model version number.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The model version ARN.

" } } }, "traits": { "smithy.api#documentation": "

The model version.

" } }, "com.amazonaws.frauddetector#ModelVersionDetail": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

" } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

" } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The model version number.

" } }, "status": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The status of the model version.

" } }, "trainingDataSource": { "target": "com.amazonaws.frauddetector#TrainingDataSourceEnum", "traits": { "smithy.api#documentation": "

The model version training data source.

" } }, "trainingDataSchema": { "target": "com.amazonaws.frauddetector#TrainingDataSchema", "traits": { "smithy.api#documentation": "

The training data schema.

" } }, "externalEventsDetail": { "target": "com.amazonaws.frauddetector#ExternalEventsDetail", "traits": { "smithy.api#documentation": "

The event details.

" } }, "trainingResult": { "target": "com.amazonaws.frauddetector#TrainingResult", "traits": { "smithy.api#documentation": "

The training results.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp when the model was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp when the model was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The model version ARN.

" } } }, "traits": { "smithy.api#documentation": "

The details of the model version.

" } }, "com.amazonaws.frauddetector#ModelVersionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" }, { "value": "TRAINING_CANCELLED", "name": "TRAINING_CANCELLED" } ] } }, "com.amazonaws.frauddetector#NameList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#string" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.frauddetector#NonEmptyListOfStrings": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#string" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.frauddetector#Outcome": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The outcome name.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The outcome description.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp when the outcome was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp when the outcome was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The outcome ARN.

" } } }, "traits": { "smithy.api#documentation": "

The outcome.

" } }, "com.amazonaws.frauddetector#OutcomeList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Outcome" } }, "com.amazonaws.frauddetector#OutcomesMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 100 } } }, "com.amazonaws.frauddetector#PutDetector": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#PutDetectorRequest" }, "output": { "target": "com.amazonaws.frauddetector#PutDetectorResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates or updates a detector.

" } }, "com.amazonaws.frauddetector#PutDetectorRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The description of the detector.

" } }, "eventTypeName": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the event type.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#PutDetectorResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#PutEntityType": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#PutEntityTypeRequest" }, "output": { "target": "com.amazonaws.frauddetector#PutEntityTypeResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.frauddetector#PutEntityTypeRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the entity type.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The description.

" } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#PutEntityTypeResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#PutEventType": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#PutEventTypeRequest" }, "output": { "target": "com.amazonaws.frauddetector#PutEventTypeResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.frauddetector#PutEventTypeRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The description of the event type.

" } }, "eventVariables": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { "smithy.api#documentation": "

The event type variables.

", "smithy.api#required": {} } }, "labels": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The event type labels.

" } }, "entityTypes": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { "smithy.api#documentation": "

The entity type for the event type. Example entity types: customer, merchant, account.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#PutEventTypeResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#PutExternalModel": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#PutExternalModelRequest" }, "output": { "target": "com.amazonaws.frauddetector#PutExternalModelResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.frauddetector#PutExternalModelRequest": { "type": "structure", "members": { "modelEndpoint": { "target": "com.amazonaws.frauddetector#sageMakerEndpointIdentifier", "traits": { "smithy.api#documentation": "

The model endpoints name.

", "smithy.api#required": {} } }, "modelSource": { "target": "com.amazonaws.frauddetector#ModelSource", "traits": { "smithy.api#documentation": "

The source of the model.

", "smithy.api#required": {} } }, "invokeModelEndpointRoleArn": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The IAM role used to invoke the model endpoint.

", "smithy.api#required": {} } }, "inputConfiguration": { "target": "com.amazonaws.frauddetector#ModelInputConfiguration", "traits": { "smithy.api#documentation": "

The model endpoint input configuration.

", "smithy.api#required": {} } }, "outputConfiguration": { "target": "com.amazonaws.frauddetector#ModelOutputConfiguration", "traits": { "smithy.api#documentation": "

The model endpoint output configuration.

", "smithy.api#required": {} } }, "modelEndpointStatus": { "target": "com.amazonaws.frauddetector#ModelEndpointStatus", "traits": { "smithy.api#documentation": "

The model endpoint’s status in Amazon Fraud Detector.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#PutExternalModelResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#PutKMSEncryptionKey": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#PutKMSEncryptionKeyRequest" }, "output": { "target": "com.amazonaws.frauddetector#PutKMSEncryptionKeyResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#PutKMSEncryptionKeyRequest": { "type": "structure", "members": { "kmsEncryptionKeyArn": { "target": "com.amazonaws.frauddetector#KmsEncryptionKeyArn", "traits": { "smithy.api#documentation": "

The KMS encryption key ARN.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#PutKMSEncryptionKeyResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#PutLabel": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#PutLabelRequest" }, "output": { "target": "com.amazonaws.frauddetector#PutLabelResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.frauddetector#PutLabelRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The label name.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The label description.

" } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

" } } } }, "com.amazonaws.frauddetector#PutLabelResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#PutOutcome": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#PutOutcomeRequest" }, "output": { "target": "com.amazonaws.frauddetector#PutOutcomeResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates or updates an outcome.

" } }, "com.amazonaws.frauddetector#PutOutcomeRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The name of the outcome.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The outcome description.

" } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#PutOutcomeResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An exception indicating the specified resource was not found. This can occur if you submit a request, such as CreateBatchPredictionJob, but the detector name or version does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.frauddetector#ResourceUnavailableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.frauddetector#string" } }, "traits": { "smithy.api#documentation": "

\n An exception indicating that the attached customer-owned (external) model threw an exception when Amazon Fraud Detector invoked the model. \n

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.frauddetector#Rule": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector for which the rule is associated.

", "smithy.api#required": {} } }, "ruleId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The rule ID.

", "smithy.api#required": {} } }, "ruleVersion": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The rule version.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A rule.

" } }, "com.amazonaws.frauddetector#RuleDetail": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The rule ID.

" } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The rule description.

" } }, "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector for which the rule is associated.

" } }, "ruleVersion": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The rule version.

" } }, "expression": { "target": "com.amazonaws.frauddetector#ruleExpression", "traits": { "smithy.api#documentation": "

The rule expression.

" } }, "language": { "target": "com.amazonaws.frauddetector#Language", "traits": { "smithy.api#documentation": "

The rule language.

" } }, "outcomes": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { "smithy.api#documentation": "

The rule outcomes.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

Timestamp of the last time the rule was updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The timestamp of when the rule was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The rule ARN.

" } } }, "traits": { "smithy.api#documentation": "

The details of the rule.

" } }, "com.amazonaws.frauddetector#RuleDetailList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#RuleDetail" } }, "com.amazonaws.frauddetector#RuleExecutionMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ALL_MATCHED", "name": "ALL_MATCHED" }, { "value": "FIRST_MATCHED", "name": "FIRST_MATCHED" } ] } }, "com.amazonaws.frauddetector#RuleList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Rule" } }, "com.amazonaws.frauddetector#RuleResult": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The rule ID that was matched, based on the rule execution mode.

" } }, "outcomes": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The outcomes of the matched rule, based on the rule execution mode.

" } } }, "traits": { "smithy.api#documentation": "

The rule results.

" } }, "com.amazonaws.frauddetector#RulesMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 100 } } }, "com.amazonaws.frauddetector#Tag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.frauddetector#tagKey", "traits": { "smithy.api#documentation": "

A tag key.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.frauddetector#tagValue", "traits": { "smithy.api#documentation": "

A value assigned to a tag key.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A key and value pair.

" } }, "com.amazonaws.frauddetector#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#TagResourceRequest" }, "output": { "target": "com.amazonaws.frauddetector#TagResourceResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Assigns tags to a resource.

" } }, "com.amazonaws.frauddetector#TagResourceRequest": { "type": "structure", "members": { "resourceARN": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The resource ARN.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

The tags to assign to the resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#TagResourceResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#TagsMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 50 } } }, "com.amazonaws.frauddetector#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An exception indicating a throttling error.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.frauddetector#TrainingDataSchema": { "type": "structure", "members": { "modelVariables": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The training data schema variables.

", "smithy.api#required": {} } }, "labelSchema": { "target": "com.amazonaws.frauddetector#LabelSchema", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The training data schema.

" } }, "com.amazonaws.frauddetector#TrainingDataSourceEnum": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "EXTERNAL_EVENTS", "name": "EXTERNAL_EVENTS" } ] } }, "com.amazonaws.frauddetector#TrainingMetrics": { "type": "structure", "members": { "auc": { "target": "com.amazonaws.frauddetector#float", "traits": { "smithy.api#documentation": "

The area under the curve. This summarizes true positive rate (TPR) and false positive rate (FPR) across all possible model score thresholds. A model with no predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0.

" } }, "metricDataPoints": { "target": "com.amazonaws.frauddetector#metricDataPointsList", "traits": { "smithy.api#documentation": "

The data points details.

" } } }, "traits": { "smithy.api#documentation": "

The training metric details.

" } }, "com.amazonaws.frauddetector#TrainingResult": { "type": "structure", "members": { "dataValidationMetrics": { "target": "com.amazonaws.frauddetector#DataValidationMetrics", "traits": { "smithy.api#documentation": "

The validation metrics.

" } }, "trainingMetrics": { "target": "com.amazonaws.frauddetector#TrainingMetrics", "traits": { "smithy.api#documentation": "

The training metric details.

" } }, "variableImportanceMetrics": { "target": "com.amazonaws.frauddetector#VariableImportanceMetrics", "traits": { "smithy.api#documentation": "

The variable importance metrics.

" } } }, "traits": { "smithy.api#documentation": "

The training result details.

" } }, "com.amazonaws.frauddetector#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UntagResourceRequest" }, "output": { "target": "com.amazonaws.frauddetector#UntagResourceResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes tags from a resource.

" } }, "com.amazonaws.frauddetector#UntagResourceRequest": { "type": "structure", "members": { "resourceARN": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The ARN of the resource from which to remove the tag.

", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.frauddetector#tagKeyList", "traits": { "smithy.api#documentation": "

The resource ARN.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#UntagResourceResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UpdateDetectorVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.frauddetector#UpdateDetectorVersionMetadata": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionMetadataRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionMetadataResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#UpdateDetectorVersionMetadataRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The detector version ID.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The description.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#UpdateDetectorVersionMetadataResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UpdateDetectorVersionRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The parent detector ID for the detector version you want to update.

", "smithy.api#required": {} } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The detector version ID.

", "smithy.api#required": {} } }, "externalModelEndpoints": { "target": "com.amazonaws.frauddetector#ListOfStrings", "traits": { "smithy.api#documentation": "

The Amazon SageMaker model endpoints to include in the detector version.

", "smithy.api#required": {} } }, "rules": { "target": "com.amazonaws.frauddetector#RuleList", "traits": { "smithy.api#documentation": "

The rules to include in the detector version.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The detector version description.

" } }, "modelVersions": { "target": "com.amazonaws.frauddetector#ListOfModelVersions", "traits": { "smithy.api#documentation": "

The model versions to include in the detector version.

" } }, "ruleExecutionMode": { "target": "com.amazonaws.frauddetector#RuleExecutionMode", "traits": { "smithy.api#documentation": "

The rule execution mode to add to the detector.

\n\t

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.

\n\t

If you specifiy ALL_MATCHED, 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.

\n

The default behavior is FIRST_MATCHED.

" } } } }, "com.amazonaws.frauddetector#UpdateDetectorVersionResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UpdateDetectorVersionStatus": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionStatusRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateDetectorVersionStatusResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the detector version’s status. You can perform the following promotions or\n demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.

" } }, "com.amazonaws.frauddetector#UpdateDetectorVersionStatusRequest": { "type": "structure", "members": { "detectorId": { "target": "com.amazonaws.frauddetector#identifier", "traits": { "smithy.api#documentation": "

The detector ID.

", "smithy.api#required": {} } }, "detectorVersionId": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The detector version ID.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.frauddetector#DetectorVersionStatus", "traits": { "smithy.api#documentation": "

The new status.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#UpdateDetectorVersionStatusResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UpdateModel": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateModelRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateModelResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#UpdateModelRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The new model description.

" } } } }, "com.amazonaws.frauddetector#UpdateModelResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UpdateModelVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateModelVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateModelVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

" } }, "com.amazonaws.frauddetector#UpdateModelVersionRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, "majorVersionNumber": { "target": "com.amazonaws.frauddetector#wholeNumberVersionString", "traits": { "smithy.api#documentation": "

The major version number.

", "smithy.api#required": {} } }, "externalEventsDetail": { "target": "com.amazonaws.frauddetector#ExternalEventsDetail", "traits": { "smithy.api#documentation": "

The event details.

" } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

A collection of key and value pairs.

" } } } }, "com.amazonaws.frauddetector#UpdateModelVersionResult": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID.

" } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

" } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The model version number of the model version updated.

" } }, "status": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The status of the updated model version.

" } } } }, "com.amazonaws.frauddetector#UpdateModelVersionStatus": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateModelVersionStatusRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateModelVersionStatusResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the status of a model version.

\n

You can perform the following status updates:

\n
    \n
  1. \n

    Change the TRAINING_COMPLETE status to ACTIVE.

    \n
    2. \n
  2. \n

    Change ACTIVEto INACTIVE.

    \n
    3. \n
" } }, "com.amazonaws.frauddetector#UpdateModelVersionStatusRequest": { "type": "structure", "members": { "modelId": { "target": "com.amazonaws.frauddetector#modelIdentifier", "traits": { "smithy.api#documentation": "

The model ID of the model version to update.

", "smithy.api#required": {} } }, "modelType": { "target": "com.amazonaws.frauddetector#ModelTypeEnum", "traits": { "smithy.api#documentation": "

The model type.

", "smithy.api#required": {} } }, "modelVersionNumber": { "target": "com.amazonaws.frauddetector#floatVersionString", "traits": { "smithy.api#documentation": "

The model version number.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.frauddetector#ModelVersionStatus", "traits": { "smithy.api#documentation": "

The model version status.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#UpdateModelVersionStatusResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UpdateRuleMetadata": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateRuleMetadataRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateRuleMetadataResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#UpdateRuleMetadataRequest": { "type": "structure", "members": { "rule": { "target": "com.amazonaws.frauddetector#Rule", "traits": { "smithy.api#documentation": "

The rule to update.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The rule description.

", "smithy.api#required": {} } } } }, "com.amazonaws.frauddetector#UpdateRuleMetadataResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UpdateRuleVersion": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateRuleVersionRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateRuleVersionResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.frauddetector#UpdateRuleVersionRequest": { "type": "structure", "members": { "rule": { "target": "com.amazonaws.frauddetector#Rule", "traits": { "smithy.api#documentation": "

The rule to update.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.frauddetector#description", "traits": { "smithy.api#documentation": "

The description.

" } }, "expression": { "target": "com.amazonaws.frauddetector#ruleExpression", "traits": { "smithy.api#documentation": "

The rule expression.

", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.frauddetector#Language", "traits": { "smithy.api#documentation": "

The language.

", "smithy.api#required": {} } }, "outcomes": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings", "traits": { "smithy.api#documentation": "

The outcomes.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.frauddetector#tagList", "traits": { "smithy.api#documentation": "

The tags to assign to the rule version.

" } } } }, "com.amazonaws.frauddetector#UpdateRuleVersionResult": { "type": "structure", "members": { "rule": { "target": "com.amazonaws.frauddetector#Rule", "traits": { "smithy.api#documentation": "

The new rule version that was created.

" } } } }, "com.amazonaws.frauddetector#UpdateVariable": { "type": "operation", "input": { "target": "com.amazonaws.frauddetector#UpdateVariableRequest" }, "output": { "target": "com.amazonaws.frauddetector#UpdateVariableResult" }, "errors": [ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, { "target": "com.amazonaws.frauddetector#ConflictException" }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a variable.

" } }, "com.amazonaws.frauddetector#UpdateVariableRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable.

", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The new default value of the variable.

" } }, "description": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The new description.

" } }, "variableType": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The variable type. For more information see Variable types.

" } } } }, "com.amazonaws.frauddetector#UpdateVariableResult": { "type": "structure", "members": {} }, "com.amazonaws.frauddetector#UseEventVariables": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.frauddetector#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An exception indicating a specified value is not allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.frauddetector#Variable": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable.

" } }, "dataType": { "target": "com.amazonaws.frauddetector#DataType", "traits": { "smithy.api#documentation": "

The data type of the variable. For more information see Variable types.

" } }, "dataSource": { "target": "com.amazonaws.frauddetector#DataSource", "traits": { "smithy.api#documentation": "

The data source of the variable.

" } }, "defaultValue": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The default value of the variable.

" } }, "description": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The description of the variable.

" } }, "variableType": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The variable type of the variable.

\n

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 \n

" } }, "lastUpdatedTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The time when variable was last updated.

" } }, "createdTime": { "target": "com.amazonaws.frauddetector#time", "traits": { "smithy.api#documentation": "

The time when the variable was created.

" } }, "arn": { "target": "com.amazonaws.frauddetector#fraudDetectorArn", "traits": { "smithy.api#documentation": "

The ARN of the variable.

" } } }, "traits": { "smithy.api#documentation": "

The variable.

" } }, "com.amazonaws.frauddetector#VariableEntry": { "type": "structure", "members": { "name": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The name of the variable.

" } }, "dataType": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The data type of the variable.

" } }, "dataSource": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The data source of the variable.

" } }, "defaultValue": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The default value of the variable.

" } }, "description": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The description of the variable.

" } }, "variableType": { "target": "com.amazonaws.frauddetector#string", "traits": { "smithy.api#documentation": "

The type of the variable. For more information see Variable types.

\n

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 \n

" } } }, "traits": { "smithy.api#documentation": "

A variable in the list of variables for the batch create variable request.

" } }, "com.amazonaws.frauddetector#VariableEntryList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#VariableEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.frauddetector#VariableImportanceMetrics": { "type": "structure", "members": { "logOddsMetrics": { "target": "com.amazonaws.frauddetector#ListOfLogOddsMetrics", "traits": { "smithy.api#documentation": "

List of variable metrics.

" } } }, "traits": { "smithy.api#documentation": "

The variable importance metrics details.

" } }, "com.amazonaws.frauddetector#VariableList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Variable" } }, "com.amazonaws.frauddetector#VariablesMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 50, "max": 100 } } }, "com.amazonaws.frauddetector#batchPredictionsMaxPageSize": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.frauddetector#blob": { "type": "blob" }, "com.amazonaws.frauddetector#contentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.frauddetector#description": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.frauddetector#entityTypeList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#EntityType" } }, "com.amazonaws.frauddetector#entityTypesMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 10 } } }, "com.amazonaws.frauddetector#eventTypeList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#EventType" } }, "com.amazonaws.frauddetector#eventTypesMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 5, "max": 10 } } }, "com.amazonaws.frauddetector#fieldValidationMessageList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#FieldValidationMessage" } }, "com.amazonaws.frauddetector#fileValidationMessageList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#FileValidationMessage" } }, "com.amazonaws.frauddetector#float": { "type": "float", "traits": { "smithy.api#box": {} } }, "com.amazonaws.frauddetector#floatVersionString": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 7 }, "smithy.api#pattern": "^[1-9][0-9]{0,3}\\.[0-9]{1,2}$" } }, "com.amazonaws.frauddetector#fraudDetectorArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn\\:aws[a-z-]{0,15}\\:frauddetector\\:[a-z0-9-]{3,20}\\:[0-9]{12}\\:[^\\s]{2,128}$" } }, "com.amazonaws.frauddetector#iamRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^arn\\:aws[a-z-]{0,15}\\:iam\\:\\:[0-9]{12}\\:role\\/[^\\s]{2,64}$" } }, "com.amazonaws.frauddetector#identifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[0-9a-z_-]+$" } }, "com.amazonaws.frauddetector#labelList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Label" } }, "com.amazonaws.frauddetector#labelMapper": { "type": "map", "key": { "target": "com.amazonaws.frauddetector#string" }, "value": { "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings" } }, "com.amazonaws.frauddetector#labelsMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 10, "max": 50 } } }, "com.amazonaws.frauddetector#listOfEntities": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Entity" } }, "com.amazonaws.frauddetector#metricDataPointsList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#MetricDataPoint" } }, "com.amazonaws.frauddetector#modelIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[0-9a-z_]+$" } }, "com.amazonaws.frauddetector#modelList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Model" } }, "com.amazonaws.frauddetector#modelVersionDetailList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#ModelVersionDetail" } }, "com.amazonaws.frauddetector#modelsMaxPageSize": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.frauddetector#nonEmptyString": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.frauddetector#ruleExpression": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.frauddetector#s3BucketLocation": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^s3:\\/\\/(.+)$" } }, "com.amazonaws.frauddetector#sageMakerEndpointIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[0-9A-Za-z_-]+$" } }, "com.amazonaws.frauddetector#string": { "type": "string" }, "com.amazonaws.frauddetector#tagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.frauddetector#tagKeyList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#tagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.frauddetector#tagList": { "type": "list", "member": { "target": "com.amazonaws.frauddetector#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.frauddetector#tagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.frauddetector#time": { "type": "string", "traits": { "smithy.api#length": { "min": 11, "max": 30 } } }, "com.amazonaws.frauddetector#utcTimestampISO8601": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 30 } } }, "com.amazonaws.frauddetector#variableName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.frauddetector#variableValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#sensitive": {} } }, "com.amazonaws.frauddetector#wholeNumberVersionString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#pattern": "^([1-9][0-9]*)$" } } } }