Data retrieval APIs for Amazon Fraud Detector
Amazon Fraud Detector provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchGetVariable | Get a batch of variables | List |
| DescribeDetector | Get all versions for a specified detector | Read |
| DescribeModelVersions | Get 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 | Read |
| GetBatchImportJobValidationReport | Get the data validation report of a specific batch import job | Read |
| GetBatchImportJobs | Get all batch import jobs or a specific job if you specify a job ID | List |
| GetBatchPredictionJobs | Get 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 | List |
| GetDeleteEventsByEventTypeStatus | Get a specific event type DeleteEventsByEventType API execution status | Read |
| GetDetectorVersion | Get a particular detector version | Read |
| GetDetectors | Get 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 | List |
| GetEntityTypes | Get 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 | List |
| GetEvent | Get the details of the specified event | Read |
| GetEventPrediction | Evaluate an event against a detector version. If a version ID is not provided, the detector's (ACTIVE) version is used | Read |
| GetEventPredictionMetadata | Get more details of a particular prediction | Read |
| GetEventTypes | Get 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 | List |
| GetExternalModels | Get 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 | List |
| GetKMSEncryptionKey | Get the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector | Read |
| GetLabels | Get 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 | List |
| GetListElements | Get elements of a list | Read |
| GetListsMetadata | Get metadata about lists | List |
| GetModelVersion | Get the details of the specified model version | Read |
| GetModels | Get one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified | List |
| GetOutcomes | Get 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 | List |
| GetRules | 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 | List |
| GetVariables | Get 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 | List |
| ListEventPredictions | Get a list of past predictions | List |
| ListTagsForResource | List 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 | Read |
