This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.
The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action. AWS SDK provides libraries, sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, go to Tools to build on AWS page, scroll down to the SDK section, and choose plus (+) sign to expand the section.
Creates a batch of variables.
', 'BatchGetVariable' => 'Gets a batch of variables.
', 'CancelBatchImportJob' => 'Cancels an in-progress batch import job.
', 'CancelBatchPredictionJob' => 'Cancels the specified batch prediction job.
', 'CreateBatchImportJob' => 'Creates a batch import job.
', 'CreateBatchPredictionJob' => 'Creates a batch prediction job.
', 'CreateDetectorVersion' => 'Creates a detector version. The detector version starts in a DRAFT status.
Creates a list.
List is a set of input data for a variable in your event dataset. You use the input data in a rule that\'s associated with your detector. For more information, see Lists.
', 'CreateModel' => 'Creates a model using the specified model type.
', 'CreateModelVersion' => 'Creates a version of the model using the specified model type and model id.
', 'CreateRule' => 'Creates a rule for use with the specified detector.
', 'CreateVariable' => 'Creates a variable.
', 'DeleteBatchImportJob' => 'Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.
', 'DeleteBatchPredictionJob' => 'Deletes a batch prediction job.
', 'DeleteDetector' => 'Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.
When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteDetectorVersion' => 'Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.
When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteEntityType' => 'Deletes an entity type.
You cannot delete an entity type that is included in an event type.
When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteEvent' => 'Deletes the specified event.
When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector. If deleteAuditHistory is True, event data is available through search for up to 30 seconds after the delete operation is completed.
Deletes an event type.
You cannot delete an event type that is used in a detector or a model.
When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteEventsByEventType' => 'Deletes all events of a particular event type.
', 'DeleteExternalModel' => 'Removes a SageMaker model from Amazon Fraud Detector.
You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.
', 'DeleteLabel' => 'Deletes a label.
You cannot delete labels that are included in an event type in Amazon Fraud Detector.
You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.
When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteList' => 'Deletes the list, provided it is not used in a rule.
When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.
', 'DeleteModel' => 'Deletes a model.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteModelVersion' => 'Deletes a model version.
You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.
When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteOutcome' => 'Deletes an outcome.
You cannot delete an outcome that is used in a rule version.
When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteRule' => 'Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.
When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.
', 'DeleteVariable' => 'Deletes a variable.
You can\'t delete variables that are included in an event type in Amazon Fraud Detector.
Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can\'t delete these variables manually.
When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.
', 'DescribeDetector' => 'Gets all versions for a specified detector.
', 'DescribeModelVersions' => '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.
', 'GetBatchImportJobs' => 'Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchImportJobsResponse as part of your request. A null pagination token fetches the records from the beginning.
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.
', 'GetDeleteEventsByEventTypeStatus' => 'Retrieves the status of a DeleteEventsByEventType action.
Gets a particular detector version.
', 'GetDetectors' => 'Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.
Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
', 'GetEventPrediction' => 'Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.
', 'GetEventTypes' => 'Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
', 'GetLabels' => 'Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.
Gets all the elements in the specified list.
', 'GetListsMetadata' => 'Gets the metadata of either all the lists under the account or the specified list.
', 'GetModelVersion' => 'Gets the details of the specified model version.
', 'GetModels' => 'Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.
This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.
Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified.
This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
', 'GetVariables' => 'Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.
For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” }
This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning.
Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
', 'PutDetector' => 'Creates or updates a detector.
', 'PutEntityType' => '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.
', 'PutEventType' => '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.
', 'PutExternalModel' => '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.
', 'PutKMSEncryptionKey' => 'Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
', 'PutLabel' => '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.
', 'PutOutcome' => 'Creates or updates an outcome.
', 'SendEvent' => 'Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.
Assigns tags to a resource.
', 'UntagResource' => 'Removes tags from a resource.
', 'UpdateDetectorVersion' => ' 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.
Updates the detector version\'s description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).
Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.
Updates the specified event with a new label.
', 'UpdateList' => 'Updates a list.
', 'UpdateModel' => 'Updates model description.
', 'UpdateModelVersion' => '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.
', 'UpdateModelVersionStatus' => 'Updates the status of a model version.
You can perform the following status updates:
Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED.
Change the TRAINING_COMPLETE status to ACTIVE.
Change ACTIVE to INACTIVE.
Updates a rule\'s metadata. The description attribute can be updated.
', 'UpdateRuleVersion' => 'Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
', 'UpdateVariable' => 'Updates a variable.
', ], 'shapes' => [ 'ATIMetricDataPoint' => [ 'base' => 'The Account Takeover Insights (ATI) model performance metrics data points.
', 'refs' => [ 'ATIMetricDataPointsList$member' => NULL, ], ], 'ATIMetricDataPointsList' => [ 'base' => NULL, 'refs' => [ 'ATITrainingMetricsValue$metricDataPoints' => 'The model\'s performance metrics data points.
', ], ], 'ATIModelPerformance' => [ 'base' => 'The Account Takeover Insights (ATI) model performance score.
', 'refs' => [ 'ATITrainingMetricsValue$modelPerformance' => 'The model\'s overall performance scores.
', ], ], 'ATITrainingMetricsValue' => [ 'base' => 'The Account Takeover Insights (ATI) model training metric details.
', 'refs' => [ 'TrainingMetricsV2$ati' => 'The Account Takeover Insights (ATI) model training metric details.
', ], ], 'AccessDeniedException' => [ 'base' => '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.
The log odds metric details.
Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.
The details of the impact of aggregated variables on the prediction score.
Account Takeover Insights (ATI) model uses the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, the model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.
The details of the relative importance of the aggregated variables.
Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.
The variable importance metrics of the aggregated variables.
Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.
The metadata of a list.
', 'refs' => [ 'AllowDenyLists$member' => NULL, ], ], 'AllowDenyLists' => [ 'base' => NULL, 'refs' => [ 'GetListsMetadataResult$lists' => 'The metadata of the specified list or all lists under the account.
', ], ], 'AsyncJobStatus' => [ 'base' => NULL, 'refs' => [ 'BatchImport$status' => 'The status of the batch import job.
', 'BatchPrediction$status' => 'The batch prediction status.
', 'GetDeleteEventsByEventTypeStatusResult$eventsDeletionStatus' => 'The deletion status.
', ], ], 'BatchCreateVariableError' => [ 'base' => 'Provides the error of the batch create variable API.
', 'refs' => [ 'BatchCreateVariableErrorList$member' => NULL, ], ], 'BatchCreateVariableErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchCreateVariableResult$errors' => 'Provides the errors for the BatchCreateVariable request.
Provides the error of the batch get variable API.
', 'refs' => [ 'BatchGetVariableErrorList$member' => NULL, ], ], 'BatchGetVariableErrorList' => [ 'base' => NULL, 'refs' => [ 'BatchGetVariableResult$errors' => 'The errors from the request.
', ], ], 'BatchGetVariableRequest' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetVariableResult' => [ 'base' => NULL, 'refs' => [], ], 'BatchImport' => [ 'base' => 'The batch import job details.
', 'refs' => [ 'BatchImportList$member' => NULL, ], ], 'BatchImportList' => [ 'base' => NULL, 'refs' => [ 'GetBatchImportJobsResult$batchImports' => 'An array containing the details of each batch import job.
', ], ], 'BatchPrediction' => [ 'base' => 'The batch prediction details.
', 'refs' => [ 'BatchPredictionList$member' => NULL, ], ], 'BatchPredictionList' => [ 'base' => NULL, 'refs' => [ 'GetBatchPredictionJobsResult$batchPredictions' => 'An array containing the details of each batch prediction job.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'EvaluatedExternalModel$useEventVariables' => 'Indicates whether event variables were used to generate predictions.
', 'EvaluatedRule$evaluated' => 'Indicates whether the rule was evaluated.
', 'EvaluatedRule$matched' => 'Indicates whether the rule matched.
', 'EventOrchestration$eventBridgeEnabled' => 'Specifies if event orchestration is enabled through Amazon EventBridge.
', ], ], 'CancelBatchImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelBatchImportJobResult' => [ 'base' => NULL, 'refs' => [], ], 'CancelBatchPredictionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelBatchPredictionJobResult' => [ 'base' => NULL, 'refs' => [], ], 'ConflictException' => [ 'base' => 'An exception indicating there was a conflict during a delete operation.
', 'refs' => [], ], 'CreateBatchImportJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchImportJobResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchPredictionJobRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBatchPredictionJobResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDetectorVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDetectorVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateListRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateListResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateModelVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateRuleRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateRuleResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateVariableRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVariableResult' => [ 'base' => NULL, 'refs' => [], ], 'CsvIndexToVariableMap' => [ 'base' => NULL, 'refs' => [ 'ModelOutputConfiguration$csvIndexToVariableMap' => 'A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
', ], ], 'DataSource' => [ 'base' => NULL, 'refs' => [ 'CreateVariableRequest$dataSource' => 'The source of the data.
', 'Variable$dataSource' => 'The data source of the variable.
', ], ], 'DataType' => [ 'base' => NULL, 'refs' => [ 'CreateVariableRequest$dataType' => 'The data type of the variable.
', 'Variable$dataType' => 'The data type of the variable. For more information see Variable types.
', ], ], 'DataValidationMetrics' => [ 'base' => 'The model training data validation metrics.
', 'refs' => [ 'TrainingResult$dataValidationMetrics' => 'The validation metrics.
', 'TrainingResultV2$dataValidationMetrics' => NULL, ], ], 'DeleteAuditHistory' => [ 'base' => NULL, 'refs' => [ 'DeleteEventRequest$deleteAuditHistory' => 'Specifies whether or not to delete any predictions associated with the event. If set to True,
The detector.
', 'refs' => [ 'DetectorList$member' => NULL, ], ], 'DetectorList' => [ 'base' => NULL, 'refs' => [ 'GetDetectorsResult$detectors' => 'The detectors.
', ], ], 'DetectorVersionMaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeDetectorRequest$maxResults' => 'The maximum number of results to return for the request.
', ], ], 'DetectorVersionStatus' => [ 'base' => NULL, 'refs' => [ 'CreateDetectorVersionResult$status' => 'The status of the detector version.
', 'DetectorVersionSummary$status' => 'The detector version status.
', 'GetDetectorVersionResult$status' => 'The status of the detector version.
', 'UpdateDetectorVersionStatusRequest$status' => 'The new status.
The only supported values are ACTIVE and INACTIVE
The summary of the detector version.
', 'refs' => [ 'DetectorVersionSummaryList$member' => NULL, ], ], 'DetectorVersionSummaryList' => [ 'base' => NULL, 'refs' => [ 'DescribeDetectorResult$detectorVersionSummaries' => 'The status and description for each detector version.
', ], ], 'DetectorsMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetDetectorsRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'Elements' => [ 'base' => NULL, 'refs' => [ 'ElementsList$member' => NULL, ], ], 'ElementsList' => [ 'base' => NULL, 'refs' => [ 'CreateListRequest$elements' => 'The names of the elements, if providing. You can also create an empty list and add elements later using the UpdateList API.
', 'GetListElementsResult$elements' => 'The list elements.
', 'UpdateListRequest$elements' => ' One or more list elements to add or replace. If you are providing the elements, make sure to specify the updateMode to use.
If you are deleting all elements from the list, use REPLACE for the updateMode and provide an empty list (0 elements).
The entity details.
', 'refs' => [ 'listOfEntities$member' => NULL, ], ], 'EntityType' => [ 'base' => 'The entity type details.
', 'refs' => [ 'entityTypeList$member' => NULL, ], ], 'EvaluatedExternalModel' => [ 'base' => 'The details of the external (Amazon Sagemaker) model evaluated for generating predictions.
', 'refs' => [ 'ListOfEvaluatedExternalModels$member' => NULL, ], ], 'EvaluatedModelVersion' => [ 'base' => 'The model version evaluated for generating prediction.
', 'refs' => [ 'ListOfEvaluatedModelVersions$member' => NULL, ], ], 'EvaluatedRule' => [ 'base' => 'The details of the rule used for evaluating variable values.
', 'refs' => [ 'EvaluatedRuleList$member' => NULL, ], ], 'EvaluatedRuleList' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionMetadataResult$rules' => 'List of rules associated with the detector version that were used for evaluating variable values.
', ], ], 'Event' => [ 'base' => 'The event details.
', 'refs' => [ 'GetEventResult$event' => 'The details of the event.
', ], ], 'EventAttributeMap' => [ 'base' => NULL, 'refs' => [ 'Event$eventVariables' => 'Names of the event type\'s variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
', ], ], 'EventIngestion' => [ 'base' => NULL, 'refs' => [ 'EventType$eventIngestion' => 'If Enabled, Amazon Fraud Detector stores event data when you generate a prediction and uses that data to update calculated variables in near real-time. Amazon Fraud Detector uses this data, known as INGESTED_EVENTS, to train your model and improve fraud predictions.
Specifies if ingestion is enabled or disabled.
', ], ], 'EventOrchestration' => [ 'base' => 'The event orchestration status.
', 'refs' => [ 'EventType$eventOrchestration' => 'The event orchestration status.
', 'PutEventTypeRequest$eventOrchestration' => 'Enables or disables event orchestration. If enabled, you can send event predictions to select AWS services for downstream processing of the events.
', ], ], 'EventPredictionSummary' => [ 'base' => 'Information about the summary of an event prediction.
', 'refs' => [ 'ListOfEventPredictionSummaries$member' => NULL, ], ], 'EventPredictionsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListEventPredictionsRequest$maxResults' => 'The maximum number of predictions to return for the request.
', ], ], 'EventType' => [ 'base' => 'The event type details.
', 'refs' => [ 'eventTypeList$member' => NULL, ], ], 'EventVariableMap' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionRequest$eventVariables' => 'Names of the event type\'s variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
You must provide at least one eventVariable
To ensure most accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows:
For Amazon Fraud Detector trained models:
If a null value is provided explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable (no variable name in the eventVariables map) with calculated default mean/medians for numeric variables and with special values for categorical variables.
For imported SageMaker models:
If a null value is provided explicitly for a variable, the model and rules will use “null” as the value. If a variable is not provided (no variable name in the eventVariables map), model and rules will use the default value that is provided for the variable.
', 'SendEventRequest$eventVariables' => 'Names of the event type\'s variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
', ], ], 'EventVariableSummary' => [ 'base' => 'Information about the summary of an event variable that was evaluated for generating prediction.
', 'refs' => [ 'ListOfEventVariableSummaries$member' => NULL, ], ], 'ExternalEventsDetail' => [ 'base' => 'Details for the external events data used for model version training.
', 'refs' => [ 'CreateModelVersionRequest$externalEventsDetail' => 'Details of the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.
The details of the external events data used for training the model version. This will be populated if the trainingDataSource is EXTERNAL_EVENTS
The external events data details. This will be populated if the trainingDataSource for the model version is specified as EXTERNAL_EVENTS.
The details of the external events data used for training the model version. Required if trainingDataSource is EXTERNAL_EVENTS.
The Amazon SageMaker model.
', 'refs' => [ 'ExternalModelList$member' => NULL, ], ], 'ExternalModelEndpointDataBlobMap' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionRequest$externalModelEndpointDataBlobs' => 'The Amazon SageMaker model endpoint input data blobs.
', ], ], 'ExternalModelList' => [ 'base' => NULL, 'refs' => [ 'GetExternalModelsResult$externalModels' => 'Gets the Amazon SageMaker models.
', ], ], 'ExternalModelOutputs' => [ 'base' => 'The fraud prediction scores from Amazon SageMaker model.
', 'refs' => [ 'ListOfExternalModelOutputs$member' => NULL, ], ], 'ExternalModelPredictionMap' => [ 'base' => NULL, 'refs' => [ 'ExternalModelOutputs$outputs' => 'The fraud prediction scores from Amazon SageMaker model.
', ], ], 'ExternalModelSummary' => [ 'base' => 'The Amazon SageMaker model.
', 'refs' => [ 'ExternalModelOutputs$externalModel' => 'The Amazon SageMaker model.
', ], ], 'ExternalModelsMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetExternalModelsRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'FieldValidationMessage' => [ 'base' => 'The message details.
', 'refs' => [ 'fieldValidationMessageList$member' => NULL, ], ], 'FileValidationMessage' => [ 'base' => 'The message details.
', 'refs' => [ 'fileValidationMessageList$member' => NULL, ], ], 'FilterCondition' => [ 'base' => 'A conditional statement for filtering a list of past predictions.
', 'refs' => [ 'ListEventPredictionsRequest$eventId' => 'The event ID.
', 'ListEventPredictionsRequest$eventType' => 'The event type associated with the detector.
', 'ListEventPredictionsRequest$detectorId' => 'The detector ID.
', 'ListEventPredictionsRequest$detectorVersionId' => 'The detector version ID.
', ], ], 'GetBatchImportJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBatchImportJobsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetBatchPredictionJobsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBatchPredictionJobsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDeleteEventsByEventTypeStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDeleteEventsByEventTypeStatusResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDetectorVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDetectorVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'GetDetectorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDetectorsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetEntityTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEntityTypesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetEventPredictionMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEventPredictionMetadataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetEventPredictionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEventPredictionResult' => [ 'base' => NULL, 'refs' => [], ], 'GetEventRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEventResult' => [ 'base' => NULL, 'refs' => [], ], 'GetEventTypesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetEventTypesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetExternalModelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetExternalModelsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetKMSEncryptionKeyResult' => [ 'base' => NULL, 'refs' => [], ], 'GetLabelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLabelsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetListElementsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetListElementsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetListsMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetListsMetadataResult' => [ 'base' => NULL, 'refs' => [], ], 'GetModelVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetModelVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'GetModelsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetModelsResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOutcomesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetOutcomesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetRulesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRulesResult' => [ 'base' => NULL, 'refs' => [], ], 'GetVariablesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVariablesResult' => [ 'base' => NULL, 'refs' => [], ], 'IngestedEventStatistics' => [ 'base' => 'Data about the stored events.
', 'refs' => [ 'EventType$ingestedEventStatistics' => 'Data about the stored events.
', ], ], 'IngestedEventsDetail' => [ 'base' => 'The details of the ingested event.
', 'refs' => [ 'CreateModelVersionRequest$ingestedEventsDetail' => 'Details of the ingested events data used for model version training. Required if trainingDataSource is INGESTED_EVENTS.
The details of the ingested events data used for training the model version. This will be populated if the trainingDataSource is INGESTED_EVENTS.
The ingested events data details. This will be populated if the trainingDataSource for the model version is specified as INGESTED_EVENTS.
The details of the ingested event used for training the model version. Required if your trainingDataSource is INGESTED_EVENTS.
The start and stop time of the ingested events.
', 'refs' => [ 'IngestedEventsDetail$ingestedEventsTimeWindow' => 'The start and stop time of the ingested events.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'BatchImport$processedRecordsCount' => 'The number of records processed by batch import job.
', 'BatchImport$failedRecordsCount' => 'The number of records that failed to import.
', 'BatchImport$totalRecordsCount' => 'The total number of records in the batch import job.
', 'BatchPrediction$processedRecordsCount' => 'The number of records processed by the batch prediction job.
', 'BatchPrediction$totalRecordsCount' => 'The total number of records in the batch prediction job.
', ], ], 'InternalServerException' => [ 'base' => 'An exception indicating an internal server error.
', 'refs' => [], ], 'JsonKeyToVariableMap' => [ 'base' => NULL, 'refs' => [ 'ModelOutputConfiguration$jsonKeyToVariableMap' => 'A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
', ], ], 'KMSKey' => [ 'base' => 'The KMS key details.
', 'refs' => [ 'GetKMSEncryptionKeyResult$kmsKey' => 'The KMS encryption key.
', ], ], 'KmsEncryptionKeyArn' => [ 'base' => NULL, 'refs' => [ 'KMSKey$kmsEncryptionKeyArn' => 'The encryption key ARN.
', 'PutKMSEncryptionKeyRequest$kmsEncryptionKeyArn' => 'The KMS encryption key ARN.
The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.
', ], ], 'Label' => [ 'base' => 'The label details.
', 'refs' => [ 'labelList$member' => NULL, ], ], 'LabelSchema' => [ 'base' => 'The label schema.
', 'refs' => [ 'TrainingDataSchema$labelSchema' => NULL, ], ], 'Language' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$language' => 'The language of the rule.
', 'RuleDetail$language' => 'The rule language.
', 'UpdateRuleVersionRequest$language' => 'The language.
', ], ], 'ListEventPredictionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListEventPredictionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListOfAggregatedLogOddsMetrics' => [ 'base' => NULL, 'refs' => [ 'AggregatedVariablesImportanceMetrics$logOddsMetrics' => 'List of variables\' metrics.
', ], ], 'ListOfAggregatedVariablesImpactExplanations' => [ 'base' => NULL, 'refs' => [ 'PredictionExplanations$aggregatedVariablesImpactExplanations' => 'The details of the aggregated variables impact on the prediction score.
Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.
External (Amazon SageMaker) models that were evaluated for generating predictions.
', ], ], 'ListOfEvaluatedModelVersions' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionMetadataResult$evaluatedModelVersions' => 'Model versions that were evaluated for generating predictions.
', ], ], 'ListOfEventPredictionSummaries' => [ 'base' => NULL, 'refs' => [ 'ListEventPredictionsResult$eventPredictionSummaries' => 'The summary of the past predictions.
', ], ], 'ListOfEventVariableSummaries' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionMetadataResult$eventVariables' => 'A list of event variables that influenced the prediction scores.
', ], ], 'ListOfExternalModelOutputs' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionResult$externalModelOutputs' => 'The model scores for Amazon SageMaker models.
', ], ], 'ListOfLogOddsMetrics' => [ 'base' => NULL, 'refs' => [ 'VariableImportanceMetrics$logOddsMetrics' => 'List of variable metrics.
', ], ], 'ListOfModelScores' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionResult$modelScores' => '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.
', ], ], 'ListOfModelVersionEvaluations' => [ 'base' => NULL, 'refs' => [ 'EvaluatedModelVersion$evaluations' => 'Evaluations generated for the model version.
', ], ], 'ListOfModelVersions' => [ 'base' => NULL, 'refs' => [ 'CreateDetectorVersionRequest$modelVersions' => 'The model versions to include in the detector version.
', 'GetDetectorVersionResult$modelVersions' => 'The model versions included in the detector version.
', 'UpdateDetectorVersionRequest$modelVersions' => 'The model versions to include in the detector version.
', ], ], 'ListOfRuleResults' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionResult$ruleResults' => 'The results from the rules.
', ], ], 'ListOfStrings' => [ 'base' => NULL, 'refs' => [ 'AggregatedLogOddsMetric$variableNames' => 'The names of all the variables.
', 'AggregatedVariablesImpactExplanation$eventVariableNames' => 'The names of all the event variables that were used to derive the aggregated variables.
', 'CreateDetectorVersionRequest$externalModelEndpoints' => 'The Amazon Sagemaker model endpoints to include in the detector version.
', 'EvaluatedRule$outcomes' => 'The rule outcome.
', 'EventType$eventVariables' => 'The event type event variables.
', 'EventType$labels' => 'The event type labels.
', 'GetDetectorVersionResult$externalModelEndpoints' => 'The Amazon SageMaker model endpoints included in the detector version.
', 'GetEventPredictionMetadataResult$outcomes' => 'The outcomes of the matched rule, based on the rule execution mode.
', 'PutEventTypeRequest$labels' => 'The event type labels.
', 'RuleResult$outcomes' => 'The outcomes of the matched rule, based on the rule execution mode.
', 'TrainingDataSchema$modelVariables' => 'The training data schema variables.
', 'UpdateDetectorVersionRequest$externalModelEndpoints' => 'The Amazon SageMaker model endpoints to include in the detector version.
', 'labelMapper$value' => NULL, ], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'ListUpdateMode' => [ 'base' => NULL, 'refs' => [ 'UpdateListRequest$updateMode' => 'The update mode (type).
Use APPEND if you are adding elements to the list.
Use REPLACE if you replacing existing elements in the list.
Use REMOVE if you are removing elements from the list.
The maximum number of objects to return for the request.
', ], ], 'ListsMetadataMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetListsMetadataRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'LogOddsMetric' => [ 'base' => 'The log odds metric details.
', 'refs' => [ 'ListOfLogOddsMetrics$member' => NULL, ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'IngestedEventStatistics$numberOfEvents' => 'The number of stored events.
', 'IngestedEventStatistics$eventDataSizeInBytes' => 'The total size of the stored events.
', ], ], 'MapOfStrings' => [ 'base' => NULL, 'refs' => [ 'EvaluatedExternalModel$inputVariables' => 'Input variables use for generating predictions.
', 'EvaluatedExternalModel$outputVariables' => 'Output variables.
', ], ], 'MetricDataPoint' => [ 'base' => 'Model performance metrics data points.
', 'refs' => [ 'metricDataPointsList$member' => NULL, ], ], 'Model' => [ 'base' => 'The model.
', 'refs' => [ 'modelList$member' => NULL, ], ], 'ModelEndpointDataBlob' => [ 'base' => '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.
', 'refs' => [ 'ExternalModelEndpointDataBlobMap$value' => NULL, ], ], 'ModelEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'ExternalModel$modelEndpointStatus' => 'The Amazon Fraud Detector status for the external model endpoint
', 'PutExternalModelRequest$modelEndpointStatus' => 'The model endpoint’s status in Amazon Fraud Detector.
', ], ], 'ModelInputConfiguration' => [ 'base' => 'The Amazon SageMaker model input configuration.
', 'refs' => [ 'ExternalModel$inputConfiguration' => 'The input configuration.
', 'PutExternalModelRequest$inputConfiguration' => 'The model endpoint input configuration.
', ], ], 'ModelInputDataFormat' => [ 'base' => NULL, 'refs' => [ 'ModelInputConfiguration$format' => 'The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.
', ], ], 'ModelOutputConfiguration' => [ 'base' => 'Provides the Amazon Sagemaker model output configuration.
', 'refs' => [ 'ExternalModel$outputConfiguration' => 'The output configuration.
', 'PutExternalModelRequest$outputConfiguration' => 'The model endpoint output configuration.
', ], ], 'ModelOutputDataFormat' => [ 'base' => NULL, 'refs' => [ 'ModelOutputConfiguration$format' => 'The format of the model output configuration.
', ], ], 'ModelPredictionMap' => [ 'base' => NULL, 'refs' => [ 'ModelScores$scores' => 'The model\'s fraud prediction scores.
', ], ], 'ModelScores' => [ 'base' => 'The fraud prediction scores.
', 'refs' => [ 'ListOfModelScores$member' => NULL, ], ], 'ModelSource' => [ 'base' => NULL, 'refs' => [ 'ExternalModel$modelSource' => 'The source of the model.
', 'ExternalModelSummary$modelSource' => 'The source of the model.
', 'PutExternalModelRequest$modelSource' => 'The source of the model.
', ], ], 'ModelTypeEnum' => [ 'base' => NULL, 'refs' => [ 'CreateModelRequest$modelType' => 'The model type.
', 'CreateModelVersionRequest$modelType' => 'The model type.
', 'CreateModelVersionResult$modelType' => 'The model type.
', 'DeleteModelRequest$modelType' => 'The model type of the model to delete.
', 'DeleteModelVersionRequest$modelType' => 'The model type of the model version to delete.
', 'DescribeModelVersionsRequest$modelType' => 'The model type.
', 'GetModelVersionRequest$modelType' => 'The model type.
', 'GetModelVersionResult$modelType' => 'The model type.
', 'GetModelsRequest$modelType' => 'The model type.
', 'Model$modelType' => 'The model type.
', 'ModelVersion$modelType' => 'The model type.
', 'ModelVersionDetail$modelType' => 'The model type.
', 'UpdateModelRequest$modelType' => 'The model type.
', 'UpdateModelVersionRequest$modelType' => 'The model type.
', 'UpdateModelVersionResult$modelType' => 'The model type.
', 'UpdateModelVersionStatusRequest$modelType' => 'The model type.
', ], ], 'ModelVersion' => [ 'base' => 'The model version.
', 'refs' => [ 'ListOfModelVersions$member' => NULL, 'ModelScores$modelVersion' => 'The model version.
', ], ], 'ModelVersionDetail' => [ 'base' => 'The details of the model version.
', 'refs' => [ 'modelVersionDetailList$member' => NULL, ], ], 'ModelVersionEvaluation' => [ 'base' => 'The model version evalutions.
', 'refs' => [ 'ListOfModelVersionEvaluations$member' => NULL, ], ], 'ModelVersionStatus' => [ 'base' => NULL, 'refs' => [ 'UpdateModelVersionStatusRequest$status' => 'The model version status.
', ], ], 'NameList' => [ 'base' => NULL, 'refs' => [ 'BatchGetVariableRequest$names' => 'The list of variable names to get.
', ], ], 'NonEmptyListOfStrings' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$outcomes' => 'The outcome or outcomes returned when the rule expression matches.
', 'EventType$entityTypes' => 'The event type entity types.
', 'PutEventTypeRequest$eventVariables' => 'The event type variables.
', 'PutEventTypeRequest$entityTypes' => 'The entity type for the event type. Example entity types: customer, merchant, account.
', 'RuleDetail$outcomes' => 'The rule outcomes.
', 'UpdateRuleVersionRequest$outcomes' => 'The outcomes.
', ], ], 'OFIMetricDataPoint' => [ 'base' => 'The Online Fraud Insights (OFI) model performance metrics data points.
', 'refs' => [ 'OFIMetricDataPointsList$member' => NULL, ], ], 'OFIMetricDataPointsList' => [ 'base' => NULL, 'refs' => [ 'OFITrainingMetricsValue$metricDataPoints' => 'The model\'s performance metrics data points.
', ], ], 'OFIModelPerformance' => [ 'base' => 'The Online Fraud Insights (OFI) model performance score.
', 'refs' => [ 'OFITrainingMetricsValue$modelPerformance' => 'The model\'s overall performance score.
', ], ], 'OFITrainingMetricsValue' => [ 'base' => 'The Online Fraud Insights (OFI) model training metric details.
', 'refs' => [ 'TrainingMetricsV2$ofi' => 'The Online Fraud Insights (OFI) model training metric details.
', ], ], 'Outcome' => [ 'base' => 'The outcome.
', 'refs' => [ 'OutcomeList$member' => NULL, ], ], 'OutcomeList' => [ 'base' => NULL, 'refs' => [ 'GetOutcomesResult$outcomes' => 'The outcomes.
', ], ], 'OutcomesMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetOutcomesRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'PredictionExplanations' => [ 'base' => 'The prediction explanations that provide insight into how each event variable impacted the model version\'s fraud prediction score.
', 'refs' => [ 'ModelVersionEvaluation$predictionExplanations' => 'The prediction explanations generated for the model version.
', ], ], 'PredictionTimeRange' => [ 'base' => 'The time period for when the predictions were generated.
', 'refs' => [ 'ListEventPredictionsRequest$predictionTimeRange' => 'The time period for when the predictions were generated.
', ], ], 'PutDetectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutDetectorResult' => [ 'base' => NULL, 'refs' => [], ], 'PutEntityTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutEntityTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'PutEventTypeRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutEventTypeResult' => [ 'base' => NULL, 'refs' => [], ], 'PutExternalModelRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutExternalModelResult' => [ 'base' => NULL, 'refs' => [], ], 'PutKMSEncryptionKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutKMSEncryptionKeyResult' => [ 'base' => NULL, 'refs' => [], ], 'PutLabelRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutLabelResult' => [ 'base' => NULL, 'refs' => [], ], 'PutOutcomeRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutOutcomeResult' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'An exception indicating the specified resource was not found.
', 'refs' => [], ], 'ResourceUnavailableException' => [ 'base' => 'An exception indicating that the attached customer-owned (external) model threw an exception when Amazon Fraud Detector invoked the model.
', 'refs' => [], ], 'Rule' => [ 'base' => 'A rule.
', 'refs' => [ 'CreateRuleResult$rule' => 'The created rule.
', 'DeleteRuleRequest$rule' => NULL, 'RuleList$member' => NULL, 'UpdateRuleMetadataRequest$rule' => 'The rule to update.
', 'UpdateRuleVersionRequest$rule' => 'The rule to update.
', 'UpdateRuleVersionResult$rule' => 'The new rule version that was created.
', ], ], 'RuleDetail' => [ 'base' => 'The details of the rule.
', 'refs' => [ 'RuleDetailList$member' => NULL, ], ], 'RuleDetailList' => [ 'base' => NULL, 'refs' => [ 'GetRulesResult$ruleDetails' => 'The details of the requested rule.
', ], ], 'RuleExecutionMode' => [ 'base' => NULL, 'refs' => [ 'CreateDetectorVersionRequest$ruleExecutionMode' => 'The rule execution mode for the rules included in the detector version.
You can define and edit the rule mode at the detector version level, when it is in draft status.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.
The default behavior is FIRST_MATCHED.
The execution mode of the rule in the dectector
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.
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.
The execution mode of the rule used for evaluating variable values.
', 'UpdateDetectorVersionRequest$ruleExecutionMode' => 'The rule execution mode to add to the detector.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
The default behavior is FIRST_MATCHED.
The rules to include in the detector version.
', 'GetDetectorVersionResult$rules' => 'The rules included in the detector version.
', 'UpdateDetectorVersionRequest$rules' => 'The rules to include in the detector version.
', ], ], 'RuleResult' => [ 'base' => 'The rule results.
', 'refs' => [ 'ListOfRuleResults$member' => NULL, ], ], 'RulesMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetRulesRequest$maxResults' => 'The maximum number of rules to return for the request.
', ], ], 'SendEventRequest' => [ 'base' => NULL, 'refs' => [], ], 'SendEventResult' => [ 'base' => NULL, 'refs' => [], ], 'TFIMetricDataPoint' => [ 'base' => 'The performance metrics data points for Transaction Fraud Insights (TFI) model.
', 'refs' => [ 'TFIMetricDataPointsList$member' => NULL, ], ], 'TFIMetricDataPointsList' => [ 'base' => NULL, 'refs' => [ 'TFITrainingMetricsValue$metricDataPoints' => 'The model\'s performance metrics data points.
', ], ], 'TFIModelPerformance' => [ 'base' => 'The Transaction Fraud Insights (TFI) model performance score.
', 'refs' => [ 'TFITrainingMetricsValue$modelPerformance' => 'The model performance score.
', ], ], 'TFITrainingMetricsValue' => [ 'base' => 'The Transaction Fraud Insights (TFI) model training metric details.
', 'refs' => [ 'TrainingMetricsV2$tfi' => 'The Transaction Fraud Insights (TFI) model training metric details.
', ], ], 'Tag' => [ 'base' => 'A key and value pair.
', 'refs' => [ 'tagList$member' => NULL, ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'TagsMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'ThrottlingException' => [ 'base' => 'An exception indicating a throttling error.
', 'refs' => [], ], 'TrainingDataSchema' => [ 'base' => 'The training data schema.
', 'refs' => [ 'CreateModelVersionRequest$trainingDataSchema' => 'The training data schema.
', 'GetModelVersionResult$trainingDataSchema' => 'The training data schema.
', 'ModelVersionDetail$trainingDataSchema' => 'The training data schema.
', ], ], 'TrainingDataSourceEnum' => [ 'base' => NULL, 'refs' => [ 'CreateModelVersionRequest$trainingDataSource' => 'The training data source location in Amazon S3.
', 'GetModelVersionResult$trainingDataSource' => 'The training data source.
', 'ModelVersionDetail$trainingDataSource' => 'The model version training data source.
', ], ], 'TrainingMetrics' => [ 'base' => 'The training metric details.
', 'refs' => [ 'TrainingResult$trainingMetrics' => 'The training metric details.
', ], ], 'TrainingMetricsV2' => [ 'base' => 'The training metrics details.
', 'refs' => [ 'TrainingResultV2$trainingMetricsV2' => 'The training metric details.
', ], ], 'TrainingResult' => [ 'base' => 'The training result details.
', 'refs' => [ 'ModelVersionDetail$trainingResult' => 'The training results.
', ], ], 'TrainingResultV2' => [ 'base' => 'The training result details.
', 'refs' => [ 'ModelVersionDetail$trainingResultV2' => 'The training result details. The details include the relative importance of the variables.
', ], ], 'UncertaintyRange' => [ 'base' => 'Range of area under curve (auc) expected from the model. A range greater than 0.1 indicates higher model uncertainity. A range is the difference between upper and lower bound of auc.
', 'refs' => [ 'OFIModelPerformance$uncertaintyRange' => 'Indicates the range of area under curve (auc) expected from the OFI model. A range greater than 0.1 indicates higher model uncertainity.
', 'TFIModelPerformance$uncertaintyRange' => 'Indicates the range of area under curve (auc) expected from the TFI model. A range greater than 0.1 indicates higher model uncertainity.
', ], ], 'UnlabeledEventsTreatment' => [ 'base' => NULL, 'refs' => [ 'LabelSchema$unlabeledEventsTreatment' => 'The action to take for unlabeled events.
Use IGNORE if you want the unlabeled events to be ignored. This is recommended when the majority of the events in the dataset are labeled.
Use FRAUD if you want to categorize all unlabeled events as “Fraud”. This is recommended when most of the events in your dataset are fraudulent.
Use LEGIT if you want to categorize all unlabeled events as “Legit”. This is recommended when most of the events in your dataset are legitimate.
Use AUTO if you want Amazon Fraud Detector to decide how to use the unlabeled data. This is recommended when there is significant unlabeled events in the dataset.
By default, Amazon Fraud Detector ignores the unlabeled data.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDetectorVersionMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDetectorVersionMetadataResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDetectorVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDetectorVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDetectorVersionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDetectorVersionStatusResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventLabelRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateEventLabelResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateListRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateListResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelVersionStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateModelVersionStatusResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleMetadataResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRuleVersionResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVariableRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVariableResult' => [ 'base' => NULL, 'refs' => [], ], 'UseEventVariables' => [ 'base' => NULL, 'refs' => [ 'ModelInputConfiguration$useEventVariables' => 'The event variables.
', ], ], 'ValidationException' => [ 'base' => 'An exception indicating a specified value is not allowed.
', 'refs' => [], ], 'Variable' => [ 'base' => 'The variable.
', 'refs' => [ 'VariableList$member' => NULL, ], ], 'VariableEntry' => [ 'base' => 'A variable in the list of variables for the batch create variable request.
', 'refs' => [ 'VariableEntryList$member' => NULL, ], ], 'VariableEntryList' => [ 'base' => NULL, 'refs' => [ 'BatchCreateVariableRequest$variableEntries' => 'The list of variables for the batch create variable request.
', ], ], 'VariableImpactExplanation' => [ 'base' => 'The details of the event variable\'s impact on the prediction score.
', 'refs' => [ 'listOfVariableImpactExplanations$member' => NULL, ], ], 'VariableImportanceMetrics' => [ 'base' => 'The variable importance metrics details.
', 'refs' => [ 'TrainingResult$variableImportanceMetrics' => 'The variable importance metrics.
', 'TrainingResultV2$variableImportanceMetrics' => NULL, ], ], 'VariableList' => [ 'base' => NULL, 'refs' => [ 'BatchGetVariableResult$variables' => 'The returned variables.
', 'GetVariablesResult$variables' => 'The names of the variables returned.
', ], ], 'VariablesMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetVariablesRequest$maxResults' => 'The max size per page determined for the get variable request.
', ], ], 'attributeKey' => [ 'base' => NULL, 'refs' => [ 'EventAttributeMap$key' => NULL, ], ], 'attributeValue' => [ 'base' => NULL, 'refs' => [ 'EventAttributeMap$value' => NULL, ], ], 'batchImportsMaxPageSize' => [ 'base' => NULL, 'refs' => [ 'GetBatchImportJobsRequest$maxResults' => 'The maximum number of objects to return for request.
', ], ], 'batchPredictionsMaxPageSize' => [ 'base' => NULL, 'refs' => [ 'GetBatchPredictionJobsRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'blob' => [ 'base' => NULL, 'refs' => [ 'ModelEndpointDataBlob$byteBuffer' => 'The byte buffer of the Amazon SageMaker model endpoint input data blob.
', ], ], 'contentType' => [ 'base' => NULL, 'refs' => [ 'ModelEndpointDataBlob$contentType' => 'The content type of the Amazon SageMaker model endpoint input data blob.
', ], ], 'description' => [ 'base' => NULL, 'refs' => [ 'AllowDenyList$description' => 'The description of the list.
', 'CreateDetectorVersionRequest$description' => 'The description of the detector version.
', 'CreateListRequest$description' => 'The description of the list.
', 'CreateModelRequest$description' => 'The model description.
', 'CreateRuleRequest$description' => 'The rule description.
', 'Detector$description' => 'The detector description.
', 'DetectorVersionSummary$description' => 'The detector version description.
', 'EntityType$description' => 'The entity type description.
', 'EventType$description' => 'The event type description.
', 'GetDetectorVersionResult$description' => 'The detector version description.
', 'Label$description' => 'The label description.
', 'Model$description' => 'The model description.
', 'Outcome$description' => 'The outcome description.
', 'PutDetectorRequest$description' => 'The description of the detector.
', 'PutEntityTypeRequest$description' => 'The description.
', 'PutEventTypeRequest$description' => 'The description of the event type.
', 'PutLabelRequest$description' => 'The label description.
', 'PutOutcomeRequest$description' => 'The outcome description.
', 'RuleDetail$description' => 'The rule description.
', 'UpdateDetectorVersionMetadataRequest$description' => 'The description.
', 'UpdateDetectorVersionRequest$description' => 'The detector version description.
', 'UpdateListRequest$description' => 'The new description.
', 'UpdateModelRequest$description' => 'The new model description.
', 'UpdateRuleMetadataRequest$description' => 'The rule description.
', 'UpdateRuleVersionRequest$description' => 'The description.
', ], ], 'entityRestrictedString' => [ 'base' => NULL, 'refs' => [ 'Entity$entityId' => 'The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.
An array of entity types.
', ], ], 'entityTypesMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetEntityTypesRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'eventTypeList' => [ 'base' => NULL, 'refs' => [ 'GetEventTypesResult$eventTypes' => 'An array of event types.
', ], ], 'eventTypesMaxResults' => [ 'base' => NULL, 'refs' => [ 'GetEventTypesRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'fieldValidationMessageList' => [ 'base' => NULL, 'refs' => [ 'DataValidationMetrics$fieldLevelMessages' => 'The field-specific model training validation messages.
', ], ], 'fileValidationMessageList' => [ 'base' => NULL, 'refs' => [ 'DataValidationMetrics$fileLevelMessages' => 'The file-specific model training data validation messages.
', ], ], 'filterString' => [ 'base' => NULL, 'refs' => [ 'FilterCondition$value' => 'A statement containing a resource property and a value to specify filter condition.
', ], ], 'float' => [ 'base' => NULL, 'refs' => [ 'ATIMetricDataPoint$cr' => 'The challenge rate. This indicates the percentage of login events that the model recommends to challenge such as one-time password, multi-factor authentication, and investigations.
', 'ATIMetricDataPoint$adr' => 'The anomaly discovery rate. This metric quantifies the percentage of anomalies that can be detected by the model at the selected score threshold. A lower score threshold increases the percentage of anomalies captured by the model, but would also require challenging a larger percentage of login events, leading to a higher customer friction.
', 'ATIMetricDataPoint$threshold' => 'The model\'s 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.
', 'ATIMetricDataPoint$atodr' => 'The account takeover discovery rate. This metric quantifies the percentage of account compromise events that can be detected by the model at the selected score threshold. This metric is only available if 50 or more entities with at-least one labeled account takeover event is present in the ingested dataset.
', 'ATIModelPerformance$asi' => 'The anomaly separation index (ASI) score. This metric summarizes the overall ability of the model to separate anomalous activities from the normal behavior. Depending on the business, a large fraction of these anomalous activities can be malicious and correspond to the account takeover attacks. A model with no separability power will have the lowest possible ASI score of 0.5, whereas the a model with a high separability power will have the highest possible ASI score of 1.0
', 'AggregatedLogOddsMetric$aggregatedVariablesImportance' => 'The relative importance of the variables in the list to the other event variable.
', 'AggregatedVariablesImpactExplanation$logOddsImpact' => 'The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from -infinity to +infinity.
A positive value indicates that the variables drove the risk score up.
A negative value indicates that the variables drove the risk score down.
The relative importance of the variable. For more information, see Model variable importance.
', 'MetricDataPoint$fpr' => 'The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
', 'MetricDataPoint$precision' => 'The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
', 'MetricDataPoint$tpr' => 'The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
', 'MetricDataPoint$threshold' => '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.
', 'ModelPredictionMap$value' => NULL, 'OFIMetricDataPoint$fpr' => 'The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
', 'OFIMetricDataPoint$precision' => 'The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
', 'OFIMetricDataPoint$tpr' => 'The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
', 'OFIMetricDataPoint$threshold' => '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.
', 'OFIModelPerformance$auc' => 'The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
', 'TFIMetricDataPoint$fpr' => 'The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
', 'TFIMetricDataPoint$precision' => 'The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
', 'TFIMetricDataPoint$tpr' => 'The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
', 'TFIMetricDataPoint$threshold' => '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.
', 'TFIModelPerformance$auc' => 'The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
', 'TrainingMetrics$auc' => '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.
', 'UncertaintyRange$lowerBoundValue' => 'The lower bound value of the area under curve (auc).
', 'UncertaintyRange$upperBoundValue' => 'The upper bound value of the area under curve (auc).
', 'VariableImpactExplanation$logOddsImpact' => 'The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from - infinity to + infinity.
A positive value indicates that the variable drove the risk score up.
A negative value indicates that the variable drove the risk score down.
The detector version.
', 'CreateModelVersionResult$modelVersionNumber' => 'The model version number of the model version created.
', 'DeleteModelVersionRequest$modelVersionNumber' => 'The model version number of the model version to delete.
', 'DescribeModelVersionsRequest$modelVersionNumber' => 'The model version number.
', 'GetModelVersionRequest$modelVersionNumber' => 'The model version number.
', 'GetModelVersionResult$modelVersionNumber' => 'The model version number.
', 'ModelVersion$modelVersionNumber' => 'The model version number.
', 'ModelVersionDetail$modelVersionNumber' => 'The model version number.
', 'UpdateModelVersionResult$modelVersionNumber' => 'The model version number of the model version updated.
', 'UpdateModelVersionStatusRequest$modelVersionNumber' => 'The model version number.
', ], ], 'fraudDetectorArn' => [ 'base' => NULL, 'refs' => [ 'AllowDenyList$arn' => 'The ARN of the list.
', 'BatchImport$arn' => 'The ARN of the batch import job.
', 'BatchPrediction$arn' => 'The ARN of batch prediction job.
', 'DescribeDetectorResult$arn' => 'The detector ARN.
', 'Detector$arn' => 'The detector ARN.
', 'EntityType$arn' => 'The entity type ARN.
', 'EventType$arn' => 'The entity type ARN.
', 'ExternalModel$arn' => 'The model ARN.
', 'GetDetectorVersionResult$arn' => 'The detector version ARN.
', 'GetModelVersionResult$arn' => 'The model version ARN.
', 'Label$arn' => 'The label ARN.
', 'ListTagsForResourceRequest$resourceARN' => 'The ARN that specifies the resource whose tags you want to list.
', 'Model$arn' => 'The ARN of the model.
', 'ModelVersion$arn' => 'The model version ARN.
', 'ModelVersionDetail$arn' => 'The model version ARN.
', 'Outcome$arn' => 'The outcome ARN.
', 'RuleDetail$arn' => 'The rule ARN.
', 'TagResourceRequest$resourceARN' => 'The resource ARN.
', 'UntagResourceRequest$resourceARN' => 'The ARN of the resource from which to remove the tag.
', 'Variable$arn' => 'The ARN of the variable.
', ], ], 'iamRoleArn' => [ 'base' => NULL, 'refs' => [ 'BatchImport$iamRoleArn' => 'The ARN of the IAM role to use for this job request.
', 'BatchPrediction$iamRoleArn' => 'The ARN of the IAM role to use for this job request.
', 'CreateBatchImportJobRequest$iamRoleArn' => 'The ARN of the IAM role created for Amazon S3 bucket that holds your data file.
The IAM role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.
', 'CreateBatchPredictionJobRequest$iamRoleArn' => 'The ARN of the IAM role to use for this job request.
The IAM Role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.
', 'ExternalEventsDetail$dataAccessRoleArn' => 'The ARN of the role that provides Amazon Fraud Detector access to the data location.
', ], ], 'identifier' => [ 'base' => NULL, 'refs' => [ 'BatchImport$jobId' => 'The ID of the batch import job.
', 'BatchImport$eventTypeName' => 'The name of the event type.
', 'BatchPrediction$jobId' => 'The job ID for the batch prediction.
', 'BatchPrediction$eventTypeName' => 'The name of the event type.
', 'BatchPrediction$detectorName' => 'The name of the detector.
', 'CancelBatchImportJobRequest$jobId' => 'The ID of an in-progress batch import job to cancel.
Amazon Fraud Detector will throw an error if the batch import job is in FAILED, CANCELED, or COMPLETED state.
The ID of the batch prediction job to cancel.
', 'CreateBatchImportJobRequest$jobId' => 'The ID of the batch import job. The ID cannot be of a past job, unless the job exists in CREATE_FAILED state.
The name of the event type.
', 'CreateBatchPredictionJobRequest$jobId' => 'The ID of the batch prediction job.
', 'CreateBatchPredictionJobRequest$eventTypeName' => 'The name of the event type.
', 'CreateBatchPredictionJobRequest$detectorName' => 'The name of the detector.
', 'CreateDetectorVersionRequest$detectorId' => 'The ID of the detector under which you want to create a new version.
', 'CreateDetectorVersionResult$detectorId' => 'The ID for the created version\'s parent detector.
', 'CreateRuleRequest$ruleId' => 'The rule ID.
', 'CreateRuleRequest$detectorId' => 'The detector ID for the rule\'s parent detector.
', 'DeleteBatchImportJobRequest$jobId' => 'The ID of the batch import job to delete.
', 'DeleteBatchPredictionJobRequest$jobId' => 'The ID of the batch prediction job to delete.
', 'DeleteDetectorRequest$detectorId' => 'The ID of the detector to delete.
', 'DeleteDetectorVersionRequest$detectorId' => 'The ID of the parent detector for the detector version to delete.
', 'DeleteEntityTypeRequest$name' => 'The name of the entity type to delete.
', 'DeleteEventRequest$eventId' => 'The ID of the event to delete.
', 'DeleteEventRequest$eventTypeName' => 'The name of the event type.
', 'DeleteEventTypeRequest$name' => 'The name of the event type to delete.
', 'DeleteEventsByEventTypeRequest$eventTypeName' => 'The name of the event type.
', 'DeleteEventsByEventTypeResult$eventTypeName' => 'Name of event type for which to delete the events.
', 'DeleteLabelRequest$name' => 'The name of the label to delete.
', 'DeleteOutcomeRequest$name' => 'The name of the outcome to delete.
', 'DescribeDetectorRequest$detectorId' => 'The detector ID.
', 'DescribeDetectorResult$detectorId' => 'The detector ID.
', 'Detector$detectorId' => 'The detector ID.
', 'Detector$eventTypeName' => 'The name of the event type.
', 'EvaluatedRule$ruleId' => 'The rule ID.
', 'EventPredictionSummary$eventId' => 'The event ID.
', 'EventPredictionSummary$eventTypeName' => 'The event type.
', 'EventPredictionSummary$detectorId' => 'The detector ID.
', 'GetBatchImportJobsRequest$jobId' => 'The ID of the batch import job to get.
', 'GetBatchPredictionJobsRequest$jobId' => 'The batch prediction job for which to get the details.
', 'GetDeleteEventsByEventTypeStatusRequest$eventTypeName' => 'Name of event type for which to get the deletion status.
', 'GetDeleteEventsByEventTypeStatusResult$eventTypeName' => 'The event type name.
', 'GetDetectorVersionRequest$detectorId' => 'The detector ID.
', 'GetDetectorVersionResult$detectorId' => 'The detector ID.
', 'GetDetectorsRequest$detectorId' => 'The detector ID.
', 'GetEntityTypesRequest$name' => 'The name.
', 'GetEventPredictionMetadataRequest$eventId' => 'The event ID.
', 'GetEventPredictionMetadataRequest$eventTypeName' => 'The event type associated with the detector specified for the prediction.
', 'GetEventPredictionMetadataRequest$detectorId' => 'The detector ID.
', 'GetEventPredictionMetadataResult$eventId' => 'The event ID.
', 'GetEventPredictionMetadataResult$eventTypeName' => 'The event type associated with the detector specified for this prediction.
', 'GetEventPredictionMetadataResult$detectorId' => 'The detector ID.
', 'GetEventTypesRequest$name' => 'The name.
', 'GetLabelsRequest$name' => 'The name of the label or labels to get.
', 'GetOutcomesRequest$name' => 'The name of the outcome or outcomes to get.
', 'GetRulesRequest$ruleId' => 'The rule ID.
', 'GetRulesRequest$detectorId' => 'The detector ID.
', 'ModelInputConfiguration$eventTypeName' => 'The event type name.
', 'Outcome$name' => 'The outcome name.
', 'PutDetectorRequest$detectorId' => 'The detector ID.
', 'PutDetectorRequest$eventTypeName' => 'The name of the event type.
', 'PutEntityTypeRequest$name' => 'The name of the entity type.
', 'PutEventTypeRequest$name' => 'The name.
', 'PutLabelRequest$name' => 'The label name.
', 'PutOutcomeRequest$name' => 'The name of the outcome.
', 'Rule$detectorId' => 'The detector for which the rule is associated.
', 'Rule$ruleId' => 'The rule ID.
', 'RuleDetail$ruleId' => 'The rule ID.
', 'RuleDetail$detectorId' => 'The detector for which the rule is associated.
', 'SendEventRequest$eventId' => 'The event ID to upload.
', 'SendEventRequest$eventTypeName' => 'The event type name of the event.
', 'SendEventRequest$assignedLabel' => 'The label to associate with the event. Required if specifying labelTimestamp.
The detector ID.
', 'UpdateDetectorVersionRequest$detectorId' => 'The parent detector ID for the detector version you want to update.
', 'UpdateDetectorVersionStatusRequest$detectorId' => 'The detector ID.
', 'UpdateEventLabelRequest$eventId' => 'The ID of the event associated with the label to update.
', 'UpdateEventLabelRequest$eventTypeName' => 'The event type of the event associated with the label to update.
', 'UpdateEventLabelRequest$assignedLabel' => 'The new label to assign to the event.
', ], ], 'integer' => [ 'base' => NULL, 'refs' => [ 'BatchCreateVariableError$code' => 'The error code.
', 'BatchGetVariableError$code' => 'The error code.
', ], ], 'labelList' => [ 'base' => NULL, 'refs' => [ 'GetLabelsResult$labels' => 'An array of labels.
', ], ], 'labelMapper' => [ 'base' => NULL, 'refs' => [ 'LabelSchema$labelMapper' => '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.
The maximum number of objects to return for the request.
', ], ], 'listOfEntities' => [ 'base' => NULL, 'refs' => [ 'Event$entities' => 'The event entities.
', 'GetEventPredictionRequest$entities' => 'The entity type (associated with the detector\'s event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."
', 'SendEventRequest$entities' => 'An array of entities.
', ], ], 'listOfVariableImpactExplanations' => [ 'base' => NULL, 'refs' => [ 'PredictionExplanations$variableImpactExplanations' => 'The details of the event variable\'s impact on the prediction score.
', ], ], 'metricDataPointsList' => [ 'base' => NULL, 'refs' => [ 'TrainingMetrics$metricDataPoints' => 'The data points details.
', ], ], 'modelIdentifier' => [ 'base' => NULL, 'refs' => [ 'CreateModelRequest$modelId' => 'The model ID.
', 'CreateModelVersionRequest$modelId' => 'The model ID.
', 'CreateModelVersionResult$modelId' => 'The model ID.
', 'DeleteModelRequest$modelId' => 'The model ID of the model to delete.
', 'DeleteModelVersionRequest$modelId' => 'The model ID of the model version to delete.
', 'DescribeModelVersionsRequest$modelId' => 'The model ID.
', 'GetModelVersionRequest$modelId' => 'The model ID.
', 'GetModelVersionResult$modelId' => 'The model ID.
', 'GetModelsRequest$modelId' => 'The model ID.
', 'Model$modelId' => 'The model ID.
', 'ModelVersion$modelId' => 'The model ID.
', 'ModelVersionDetail$modelId' => 'The model ID.
', 'UpdateModelRequest$modelId' => 'The model ID.
', 'UpdateModelVersionRequest$modelId' => 'The model ID.
', 'UpdateModelVersionResult$modelId' => 'The model ID.
', 'UpdateModelVersionStatusRequest$modelId' => 'The model ID of the model version to update.
', ], ], 'modelInputTemplate' => [ 'base' => NULL, 'refs' => [ 'ModelInputConfiguration$jsonInputTemplate' => 'Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.
', 'ModelInputConfiguration$csvInputTemplate' => 'Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.
', ], ], 'modelList' => [ 'base' => NULL, 'refs' => [ 'GetModelsResult$models' => 'The array of models.
', ], ], 'modelVersionDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeModelVersionsResult$modelVersionDetails' => 'The model version details.
', ], ], 'modelsMaxPageSize' => [ 'base' => NULL, 'refs' => [ 'DescribeModelVersionsRequest$maxResults' => 'The maximum number of results to return.
', 'GetModelsRequest$maxResults' => 'The maximum number of objects to return for the request.
', ], ], 'nextToken' => [ 'base' => NULL, 'refs' => [ 'GetListElementsRequest$nextToken' => 'The next token for the subsequent request.
', 'GetListElementsResult$nextToken' => 'The next page token.
', 'GetListsMetadataRequest$nextToken' => 'The next token for the subsequent request.
', 'GetListsMetadataResult$nextToken' => 'The next page token.
', ], ], 'noDashIdentifier' => [ 'base' => NULL, 'refs' => [ 'AllowDenyList$name' => 'The name of the list.
', 'CreateListRequest$name' => 'The name of the list.
', 'DeleteListRequest$name' => 'The name of the list to delete.
', 'GetListElementsRequest$name' => 'The name of the list.
', 'GetListsMetadataRequest$name' => 'The name of the list.
', 'UpdateListRequest$name' => 'The name of the list to update.
', ], ], 'ruleExpression' => [ 'base' => NULL, 'refs' => [ 'CreateRuleRequest$expression' => 'The rule expression.
', 'RuleDetail$expression' => 'The rule expression.
', 'UpdateRuleVersionRequest$expression' => 'The rule expression.
', ], ], 's3BucketLocation' => [ 'base' => NULL, 'refs' => [ 'BatchImport$inputPath' => 'The Amazon S3 location of your data file for batch import.
', 'BatchImport$outputPath' => 'The Amazon S3 location of your output file.
', 'BatchPrediction$inputPath' => 'The Amazon S3 location of your training file.
', 'BatchPrediction$outputPath' => 'The Amazon S3 location of your output file.
', 'CreateBatchImportJobRequest$inputPath' => 'The URI that points to the Amazon S3 location of your data file.
', 'CreateBatchImportJobRequest$outputPath' => 'The URI that points to the Amazon S3 location for storing your results.
', 'CreateBatchPredictionJobRequest$inputPath' => 'The Amazon S3 location of your training file.
', 'CreateBatchPredictionJobRequest$outputPath' => 'The Amazon S3 location of your output file.
', 'ExternalEventsDetail$dataLocation' => 'The Amazon S3 bucket location for the data.
', ], ], 'sageMakerEndpointIdentifier' => [ 'base' => NULL, 'refs' => [ 'DeleteExternalModelRequest$modelEndpoint' => 'The endpoint of the Amazon Sagemaker model to delete.
', 'ExternalModelEndpointDataBlobMap$key' => NULL, 'PutExternalModelRequest$modelEndpoint' => 'The model endpoints name.
', ], ], 'sensitiveString' => [ 'base' => NULL, 'refs' => [ 'EvaluatedRule$expression' => 'The rule expression.
', 'EvaluatedRule$expressionWithValues' => 'The rule expression value.
', 'EventVariableSummary$name' => 'The event variable name.
', 'EventVariableSummary$value' => 'The value of the event variable.
', 'EventVariableSummary$source' => 'The event variable source.
', ], ], 'string' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'AggregatedVariablesImpactExplanation$relativeImpact' => 'The relative impact of the aggregated variables in terms of magnitude on the prediction scores.
', 'BatchCreateVariableError$name' => 'The name.
', 'BatchCreateVariableError$message' => 'The error message.
', 'BatchGetVariableError$name' => 'The error name.
', 'BatchGetVariableError$message' => 'The error message.
', 'BatchImport$failureReason' => 'The reason batch import job failed.
', 'BatchPrediction$failureReason' => 'The reason a batch prediction job failed.
', 'ConflictException$message' => NULL, 'CreateModelRequest$eventTypeName' => 'The name of the event type.
', 'CreateModelVersionResult$status' => 'The model version status.
', 'CreateVariableRequest$name' => 'The name of the variable.
', 'CreateVariableRequest$defaultValue' => 'The default value for the variable when no value is received.
', 'CreateVariableRequest$description' => 'The description.
', 'CreateVariableRequest$variableType' => 'The variable type. For more information see Variable types.
Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
The status of the delete request.
', 'DeleteVariableRequest$name' => 'The name of the variable to delete.
', 'DescribeDetectorRequest$nextToken' => 'The next token from the previous response.
', 'DescribeDetectorResult$nextToken' => 'The next token to be used for subsequent requests.
', 'DescribeModelVersionsRequest$nextToken' => 'The next token from the previous results.
', 'DescribeModelVersionsResult$nextToken' => 'The next token.
', 'Entity$entityType' => 'The entity type.
', 'EntityType$name' => 'The entity type name.
', 'EvaluatedExternalModel$modelEndpoint' => 'The endpoint of the external (Amazon Sagemaker) model.
', 'EvaluatedModelVersion$modelId' => 'The model ID.
', 'EvaluatedModelVersion$modelVersion' => 'The model version.
', 'EvaluatedModelVersion$modelType' => 'The model type.
Valid values: ONLINE_FRAUD_INSIGHTS | TRANSACTION_FRAUD_INSIGHTS
The event ID.
', 'Event$eventTypeName' => 'The event type.
', 'Event$eventTimestamp' => 'The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
', 'Event$currentLabel' => 'The label associated with the event.
', 'Event$labelTimestamp' => 'The timestamp associated with the label to update. The timestamp must be specified using ISO 8601 standard in UTC.
', 'EventType$name' => 'The event type name.
', 'ExternalModel$modelEndpoint' => 'The Amazon SageMaker model endpoints.
', 'ExternalModel$invokeModelEndpointRoleArn' => 'The role used to invoke the model.
', 'ExternalModelPredictionMap$key' => NULL, 'ExternalModelPredictionMap$value' => NULL, 'ExternalModelSummary$modelEndpoint' => 'The endpoint of the Amazon SageMaker model.
', 'FieldValidationMessage$fieldName' => 'The field name.
', 'FieldValidationMessage$identifier' => 'The message ID.
', 'FieldValidationMessage$title' => 'The message title.
', 'FieldValidationMessage$content' => 'The message content.
', 'FieldValidationMessage$type' => 'The message type.
', 'FileValidationMessage$title' => 'The message title.
', 'FileValidationMessage$content' => 'The message content.
', 'FileValidationMessage$type' => 'The message type.
', 'GetBatchImportJobsRequest$nextToken' => 'The next token from the previous request.
', 'GetBatchImportJobsResult$nextToken' => 'The next token for the subsequent resquest.
', 'GetBatchPredictionJobsRequest$nextToken' => 'The next token from the previous request.
', 'GetBatchPredictionJobsResult$nextToken' => 'The next token for the subsequent request.
', 'GetDetectorsRequest$nextToken' => 'The next token for the subsequent request.
', 'GetDetectorsResult$nextToken' => 'The next page token.
', 'GetEntityTypesRequest$nextToken' => 'The next token for the subsequent request.
', 'GetEntityTypesResult$nextToken' => 'The next page token.
', 'GetEventPredictionMetadataResult$entityId' => 'The entity ID.
', 'GetEventPredictionMetadataResult$entityType' => 'The entity type.
', 'GetEventPredictionMetadataResult$detectorVersionStatus' => 'The status of the detector version.
', 'GetEventPredictionRequest$detectorId' => 'The detector ID.
', 'GetEventPredictionRequest$eventId' => 'The unique ID used to identify the event.
', 'GetEventPredictionRequest$eventTypeName' => 'The event type associated with the detector specified for the prediction.
', 'GetEventRequest$eventId' => 'The ID of the event to retrieve.
', 'GetEventRequest$eventTypeName' => 'The event type of the event to retrieve.
', 'GetEventTypesRequest$nextToken' => 'The next token for the subsequent request.
', 'GetEventTypesResult$nextToken' => 'The next page token.
', 'GetExternalModelsRequest$modelEndpoint' => 'The Amazon SageMaker model endpoint.
', 'GetExternalModelsRequest$nextToken' => 'The next page token for the request.
', 'GetExternalModelsResult$nextToken' => 'The next page token to be used in subsequent requests.
', 'GetLabelsRequest$nextToken' => 'The next token for the subsequent request.
', 'GetLabelsResult$nextToken' => 'The next page token.
', 'GetModelVersionResult$status' => 'The model version status.
Possible values are:
TRAINING_IN_PROGRESS
TRAINING_COMPLETE
ACTIVATE_REQUESTED
ACTIVATE_IN_PROGRESS
ACTIVE
INACTIVATE_REQUESTED
INACTIVATE_IN_PROGRESS
INACTIVE
ERROR
The next token for the subsequent request.
', 'GetModelsResult$nextToken' => 'The next page token to be used in subsequent requests.
', 'GetOutcomesRequest$nextToken' => 'The next page token for the request.
', 'GetOutcomesResult$nextToken' => 'The next page token for subsequent requests.
', 'GetRulesRequest$nextToken' => 'The next page token.
', 'GetRulesResult$nextToken' => 'The next page token to be used in subsequent requests.
', 'GetVariablesRequest$name' => 'The name of the variable.
', 'GetVariablesRequest$nextToken' => 'The next page token of the get variable request.
', 'GetVariablesResult$nextToken' => 'The next page token to be used in subsequent requests.
', 'InternalServerException$message' => NULL, 'JsonKeyToVariableMap$key' => NULL, 'JsonKeyToVariableMap$value' => NULL, 'Label$name' => 'The label name.
', 'ListEventPredictionsRequest$nextToken' => 'Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
', 'ListEventPredictionsResult$nextToken' => 'Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
', 'ListOfStrings$member' => NULL, 'ListTagsForResourceRequest$nextToken' => 'The next token from the previous results.
', 'ListTagsForResourceResult$nextToken' => 'The next token for subsequent requests.
', 'LogOddsMetric$variableName' => 'The name of the variable.
', 'LogOddsMetric$variableType' => 'The type of variable.
', 'MapOfStrings$key' => NULL, 'MapOfStrings$value' => NULL, 'Model$eventTypeName' => 'The name of the event type.
', 'ModelPredictionMap$key' => NULL, 'ModelVersionDetail$status' => 'The status of the model version.
', 'ModelVersionEvaluation$outputVariableName' => 'The output variable name.
', 'ModelVersionEvaluation$evaluationScore' => 'The evaluation score generated for the model version.
', 'NameList$member' => NULL, 'NonEmptyListOfStrings$member' => NULL, 'PutExternalModelRequest$invokeModelEndpointRoleArn' => 'The IAM role used to invoke the model endpoint.
', 'ResourceNotFoundException$message' => NULL, 'ResourceUnavailableException$message' => NULL, 'RuleResult$ruleId' => 'The rule ID that was matched, based on the rule execution mode.
', 'ThrottlingException$message' => NULL, 'UpdateModelVersionResult$status' => 'The status of the updated model version.
', 'UpdateVariableRequest$name' => 'The name of the variable.
', 'UpdateVariableRequest$defaultValue' => 'The new default value of the variable.
', 'UpdateVariableRequest$description' => 'The new description.
', 'UpdateVariableRequest$variableType' => 'The variable type. For more information see Variable types.
', 'ValidationException$message' => NULL, 'Variable$name' => 'The name of the variable.
', 'Variable$defaultValue' => 'The default value of the variable.
', 'Variable$description' => 'The description of the variable.
', 'Variable$variableType' => 'The variable type of the variable.
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
The name of the variable.
', 'VariableEntry$dataType' => 'The data type of the variable.
', 'VariableEntry$dataSource' => 'The data source of the variable.
', 'VariableEntry$defaultValue' => 'The default value of the variable.
', 'VariableEntry$description' => 'The description of the variable.
', 'VariableEntry$variableType' => 'The type of the variable. For more information see Variable types.
Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
The event variable name.
', 'VariableImpactExplanation$relativeImpact' => 'The event variable\'s relative impact in terms of magnitude on the prediction scores. The relative impact values consist of a numerical rating (0-5, 5 being the highest) and direction (increased/decreased) impact of the fraud risk.
', 'labelMapper$key' => NULL, ], ], 'tagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'A tag key.
', 'tagKeyList$member' => NULL, ], ], 'tagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => 'The resource ARN.
', ], ], 'tagList' => [ 'base' => NULL, 'refs' => [ 'BatchCreateVariableRequest$tags' => 'A collection of key and value pairs.
', 'CreateBatchImportJobRequest$tags' => 'A collection of key-value pairs associated with this request.
', 'CreateBatchPredictionJobRequest$tags' => 'A collection of key and value pairs.
', 'CreateDetectorVersionRequest$tags' => 'A collection of key and value pairs.
', 'CreateListRequest$tags' => 'A collection of the key and value pairs.
', 'CreateModelRequest$tags' => 'A collection of key and value pairs.
', 'CreateModelVersionRequest$tags' => 'A collection of key and value pairs.
', 'CreateRuleRequest$tags' => 'A collection of key and value pairs.
', 'CreateVariableRequest$tags' => 'A collection of key and value pairs.
', 'ListTagsForResourceResult$tags' => 'A collection of key and value pairs.
', 'PutDetectorRequest$tags' => 'A collection of key and value pairs.
', 'PutEntityTypeRequest$tags' => 'A collection of key and value pairs.
', 'PutEventTypeRequest$tags' => 'A collection of key and value pairs.
', 'PutExternalModelRequest$tags' => 'A collection of key and value pairs.
', 'PutLabelRequest$tags' => 'A collection of key and value pairs.
', 'PutOutcomeRequest$tags' => 'A collection of key and value pairs.
', 'TagResourceRequest$tags' => 'The tags to assign to the resource.
', 'UpdateModelVersionRequest$tags' => 'A collection of key and value pairs.
', 'UpdateRuleVersionRequest$tags' => 'The tags to assign to the rule version.
', ], ], 'tagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'A value assigned to a tag key.
', ], ], 'time' => [ 'base' => NULL, 'refs' => [ 'AllowDenyList$createdTime' => 'The time the list was created.
', 'AllowDenyList$updatedTime' => 'The time the list was last updated.
', 'BatchImport$startTime' => 'Timestamp of when the batch import job started.
', 'BatchImport$completionTime' => 'Timestamp of when batch import job completed.
', 'BatchPrediction$startTime' => 'Timestamp of when the batch prediction job started.
', 'BatchPrediction$completionTime' => 'Timestamp of when the batch prediction job completed.
', 'BatchPrediction$lastHeartbeatTime' => 'Timestamp of most recent heartbeat indicating the batch prediction job was making progress.
', 'Detector$lastUpdatedTime' => 'Timestamp of when the detector was last updated.
', 'Detector$createdTime' => 'Timestamp of when the detector was created.
', 'DetectorVersionSummary$lastUpdatedTime' => 'Timestamp of when the detector version was last updated.
', 'EntityType$lastUpdatedTime' => 'Timestamp of when the entity type was last updated.
', 'EntityType$createdTime' => 'Timestamp of when the entity type was created.
', 'EventPredictionSummary$eventTimestamp' => 'The timestamp of the event.
', 'EventPredictionSummary$predictionTimestamp' => 'The timestamp when the prediction was generated.
', 'EventType$lastUpdatedTime' => 'Timestamp of when the event type was last updated.
', 'EventType$createdTime' => 'Timestamp of when the event type was created.
', 'ExternalModel$lastUpdatedTime' => 'Timestamp of when the model was last updated.
', 'ExternalModel$createdTime' => 'Timestamp of when the model was last created.
', 'GetDetectorVersionResult$lastUpdatedTime' => 'The timestamp when the detector version was last updated.
', 'GetDetectorVersionResult$createdTime' => 'The timestamp when the detector version was created.
', 'GetEventPredictionMetadataRequest$predictionTimestamp' => 'The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.
We recommend calling ListEventPredictions first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.
The timestamp for when the prediction was generated for the associated event ID.
', 'GetEventPredictionMetadataResult$predictionTimestamp' => 'The timestamp that defines when the prediction was generated.
', 'IngestedEventStatistics$leastRecentEvent' => 'The oldest stored event.
', 'IngestedEventStatistics$mostRecentEvent' => 'The newest stored event.
', 'IngestedEventStatistics$lastUpdatedTime' => 'Timestamp of when the stored event was last updated.
', 'IngestedEventsTimeWindow$startTime' => 'Timestamp of the first ingensted event.
', 'IngestedEventsTimeWindow$endTime' => 'Timestamp of the final ingested event.
', 'Label$lastUpdatedTime' => 'Timestamp of when the label was last updated.
', 'Label$createdTime' => 'Timestamp of when the event type was created.
', 'Model$createdTime' => 'Timestamp of when the model was created.
', 'Model$lastUpdatedTime' => 'Timestamp of last time the model was updated.
', 'ModelVersionDetail$lastUpdatedTime' => 'The timestamp when the model was last updated.
', 'ModelVersionDetail$createdTime' => 'The timestamp when the model was created.
', 'Outcome$lastUpdatedTime' => 'The timestamp when the outcome was last updated.
', 'Outcome$createdTime' => 'The timestamp when the outcome was created.
', 'PredictionTimeRange$startTime' => 'The start time of the time period for when the predictions were generated.
', 'PredictionTimeRange$endTime' => 'The end time of the time period for when the predictions were generated.
', 'RuleDetail$lastUpdatedTime' => 'Timestamp of the last time the rule was updated.
', 'RuleDetail$createdTime' => 'The timestamp of when the rule was created.
', 'Variable$lastUpdatedTime' => 'The time when variable was last updated.
', 'Variable$createdTime' => 'The time when the variable was created.
', ], ], 'utcTimestampISO8601' => [ 'base' => NULL, 'refs' => [ 'GetEventPredictionRequest$eventTimestamp' => 'Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
', 'SendEventRequest$eventTimestamp' => 'The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
', 'SendEventRequest$labelTimestamp' => 'The timestamp associated with the label. Required if specifying assignedLabel.
The timestamp associated with the label. The timestamp must be specified using ISO 8601 standard in UTC.
', ], ], 'variableName' => [ 'base' => NULL, 'refs' => [ 'EventVariableMap$key' => NULL, ], ], 'variableType' => [ 'base' => NULL, 'refs' => [ 'AllowDenyList$variableType' => 'The variable type of the list.
', 'CreateListRequest$variableType' => 'The variable type of the list. You can only assign the variable type with String data type. For more information, see Variable types.
', 'UpdateListRequest$variableType' => 'The variable type you want to assign to the list.
You cannot update a variable type of a list that already has a variable type assigned to it. You can assign a variable type to a list only if the list does not already have a variable type.
The detector version.
', 'CreateDetectorVersionResult$detectorVersionId' => 'The ID for the created detector.
', 'DeleteDetectorVersionRequest$detectorVersionId' => 'The ID of the detector version to delete.
', 'DetectorVersionSummary$detectorVersionId' => 'The detector version ID.
', 'EvaluatedRule$ruleVersion' => 'The rule version.
', 'EventPredictionSummary$detectorVersionId' => 'The detector version ID.
', 'GetDetectorVersionRequest$detectorVersionId' => 'The detector version ID.
', 'GetDetectorVersionResult$detectorVersionId' => 'The detector version ID.
', 'GetEventPredictionMetadataRequest$detectorVersionId' => 'The detector version ID.
', 'GetEventPredictionMetadataResult$detectorVersionId' => 'The detector version ID.
', 'GetEventPredictionRequest$detectorVersionId' => 'The detector version ID.
', 'GetRulesRequest$ruleVersion' => 'The rule version.
', 'Rule$ruleVersion' => 'The rule version.
', 'RuleDetail$ruleVersion' => 'The rule version.
', 'UpdateDetectorVersionMetadataRequest$detectorVersionId' => 'The detector version ID.
', 'UpdateDetectorVersionRequest$detectorVersionId' => 'The detector version ID.
', 'UpdateDetectorVersionStatusRequest$detectorVersionId' => 'The detector version ID.
', 'UpdateModelVersionRequest$majorVersionNumber' => 'The major version number.
', ], ], ],];