Class: Aws::FraudDetector::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::FraudDetector::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb
Overview
An API client for FraudDetector. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::FraudDetector::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_create_variable(params = {}) ⇒ Types::BatchCreateVariableResult
Creates a batch of variables.
-
#batch_get_variable(params = {}) ⇒ Types::BatchGetVariableResult
Gets a batch of variables.
-
#cancel_batch_import_job(params = {}) ⇒ Struct
Cancels an in-progress batch import job.
-
#cancel_batch_prediction_job(params = {}) ⇒ Struct
Cancels the specified batch prediction job.
-
#create_batch_import_job(params = {}) ⇒ Struct
Creates a batch import job.
-
#create_batch_prediction_job(params = {}) ⇒ Struct
Creates a batch prediction job.
-
#create_detector_version(params = {}) ⇒ Types::CreateDetectorVersionResult
Creates a detector version.
-
#create_list(params = {}) ⇒ Struct
Creates a list.
-
#create_model(params = {}) ⇒ Struct
Creates a model using the specified model type.
-
#create_model_version(params = {}) ⇒ Types::CreateModelVersionResult
Creates a version of the model using the specified model type and model id.
-
#create_rule(params = {}) ⇒ Types::CreateRuleResult
Creates a rule for use with the specified detector.
-
#create_variable(params = {}) ⇒ Struct
Creates a variable.
-
#delete_batch_import_job(params = {}) ⇒ Struct
Deletes the specified batch import job ID record.
-
#delete_batch_prediction_job(params = {}) ⇒ Struct
Deletes a batch prediction job.
-
#delete_detector(params = {}) ⇒ Struct
Deletes the detector.
-
#delete_detector_version(params = {}) ⇒ Struct
Deletes the detector version.
-
#delete_entity_type(params = {}) ⇒ Struct
Deletes an entity type.
-
#delete_event(params = {}) ⇒ Struct
Deletes the specified event.
-
#delete_event_type(params = {}) ⇒ Struct
Deletes an event type.
-
#delete_events_by_event_type(params = {}) ⇒ Types::DeleteEventsByEventTypeResult
Deletes all events of a particular event type.
-
#delete_external_model(params = {}) ⇒ Struct
Removes a SageMaker model from Amazon Fraud Detector.
-
#delete_label(params = {}) ⇒ Struct
Deletes a label.
-
#delete_list(params = {}) ⇒ Struct
Deletes the list, provided it is not used in a rule.
-
#delete_model(params = {}) ⇒ Struct
Deletes a model.
-
#delete_model_version(params = {}) ⇒ Struct
Deletes a model version.
-
#delete_outcome(params = {}) ⇒ Struct
Deletes an outcome.
-
#delete_rule(params = {}) ⇒ Struct
Deletes the rule.
-
#delete_variable(params = {}) ⇒ Struct
Deletes a variable.
-
#describe_detector(params = {}) ⇒ Types::DescribeDetectorResult
Gets all versions for a specified detector.
-
#describe_model_versions(params = {}) ⇒ Types::DescribeModelVersionsResult
Gets all of the model versions for the specified model type or for the specified model type and model ID.
-
#get_batch_import_jobs(params = {}) ⇒ Types::GetBatchImportJobsResult
Gets all batch import jobs or a specific job of the specified ID.
-
#get_batch_prediction_jobs(params = {}) ⇒ Types::GetBatchPredictionJobsResult
Gets all batch prediction jobs or a specific job if you specify a job ID.
-
#get_delete_events_by_event_type_status(params = {}) ⇒ Types::GetDeleteEventsByEventTypeStatusResult
Retrieves the status of a
DeleteEventsByEventType
action. -
#get_detector_version(params = {}) ⇒ Types::GetDetectorVersionResult
Gets a particular detector version.
-
#get_detectors(params = {}) ⇒ Types::GetDetectorsResult
Gets all detectors or a single detector if a
detectorId
is specified. -
#get_entity_types(params = {}) ⇒ Types::GetEntityTypesResult
Gets all entity types or a specific entity type if a name is specified.
-
#get_event(params = {}) ⇒ Types::GetEventResult
Retrieves details of events stored with Amazon Fraud Detector.
-
#get_event_prediction(params = {}) ⇒ Types::GetEventPredictionResult
Evaluates an event against a detector version.
-
#get_event_prediction_metadata(params = {}) ⇒ Types::GetEventPredictionMetadataResult
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.
-
#get_event_types(params = {}) ⇒ Types::GetEventTypesResult
Gets all event types or a specific event type if name is provided.
-
#get_external_models(params = {}) ⇒ Types::GetExternalModelsResult
Gets the details for one or more Amazon SageMaker models that have been imported into the service.
-
#get_kms_encryption_key(params = {}) ⇒ Types::GetKMSEncryptionKeyResult
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
-
#get_labels(params = {}) ⇒ Types::GetLabelsResult
Gets all labels or a specific label if name is provided.
-
#get_list_elements(params = {}) ⇒ Types::GetListElementsResult
Gets all the elements in the specified list.
-
#get_lists_metadata(params = {}) ⇒ Types::GetListsMetadataResult
Gets the metadata of either all the lists under the account or the specified list.
-
#get_model_version(params = {}) ⇒ Types::GetModelVersionResult
Gets the details of the specified model version.
-
#get_models(params = {}) ⇒ Types::GetModelsResult
Gets one or more models.
-
#get_outcomes(params = {}) ⇒ Types::GetOutcomesResult
Gets one or more outcomes.
-
#get_rules(params = {}) ⇒ Types::GetRulesResult
Get all rules for a detector (paginated) if
ruleId
andruleVersion
are not specified. -
#get_variables(params = {}) ⇒ Types::GetVariablesResult
Gets all of the variables or the specific variable.
-
#list_event_predictions(params = {}) ⇒ Types::ListEventPredictionsResult
Gets a list of past predictions.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Lists all tags associated with the resource.
-
#put_detector(params = {}) ⇒ Struct
Creates or updates a detector.
-
#put_entity_type(params = {}) ⇒ Struct
Creates or updates an entity type.
-
#put_event_type(params = {}) ⇒ Struct
Creates or updates an event type.
-
#put_external_model(params = {}) ⇒ Struct
Creates or updates an Amazon SageMaker model endpoint.
-
#put_kms_encryption_key(params = {}) ⇒ Struct
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
-
#put_label(params = {}) ⇒ Struct
Creates or updates label.
-
#put_outcome(params = {}) ⇒ Struct
Creates or updates an outcome.
-
#send_event(params = {}) ⇒ Struct
Stores events in Amazon Fraud Detector without generating fraud predictions for those events.
-
#tag_resource(params = {}) ⇒ Struct
Assigns tags to a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_detector_version(params = {}) ⇒ Struct
Updates a detector version.
-
#update_detector_version_metadata(params = {}) ⇒ Struct
Updates the detector version's description.
-
#update_detector_version_status(params = {}) ⇒ Struct
Updates the detector version’s status.
-
#update_event_label(params = {}) ⇒ Struct
Updates the specified event with a new label.
-
#update_list(params = {}) ⇒ Struct
Updates a list.
-
#update_model(params = {}) ⇒ Struct
Updates model description.
-
#update_model_version(params = {}) ⇒ Types::UpdateModelVersionResult
Updates a model version.
-
#update_model_version_status(params = {}) ⇒ Struct
Updates the status of a model version.
-
#update_rule_metadata(params = {}) ⇒ Struct
Updates a rule's metadata.
-
#update_rule_version(params = {}) ⇒ Types::UpdateRuleVersionResult
Updates a rule version resulting in a new rule version.
-
#update_variable(params = {}) ⇒ Struct
Updates a variable.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#batch_create_variable(params = {}) ⇒ Types::BatchCreateVariableResult
Creates a batch of variables.
445 446 447 448 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 445 def batch_create_variable(params = {}, = {}) req = build_request(:batch_create_variable, params) req.send_request() end |
#batch_get_variable(params = {}) ⇒ Types::BatchGetVariableResult
Gets a batch of variables.
487 488 489 490 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 487 def batch_get_variable(params = {}, = {}) req = build_request(:batch_get_variable, params) req.send_request() end |
#cancel_batch_import_job(params = {}) ⇒ Struct
Cancels an in-progress batch import job.
512 513 514 515 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 512 def cancel_batch_import_job(params = {}, = {}) req = build_request(:cancel_batch_import_job, params) req.send_request() end |
#cancel_batch_prediction_job(params = {}) ⇒ Struct
Cancels the specified batch prediction job.
534 535 536 537 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 534 def cancel_batch_prediction_job(params = {}, = {}) req = build_request(:cancel_batch_prediction_job, params) req.send_request() end |
#create_batch_import_job(params = {}) ⇒ Struct
Creates a batch import job.
593 594 595 596 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 593 def create_batch_import_job(params = {}, = {}) req = build_request(:create_batch_import_job, params) req.send_request() end |
#create_batch_prediction_job(params = {}) ⇒ Struct
Creates a batch prediction job.
657 658 659 660 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 657 def create_batch_prediction_job(params = {}, = {}) req = build_request(:create_batch_prediction_job, params) req.send_request() end |
#create_detector_version(params = {}) ⇒ Types::CreateDetectorVersionResult
Creates a detector version. The detector version starts in a DRAFT
status.
747 748 749 750 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 747 def create_detector_version(params = {}, = {}) req = build_request(:create_detector_version, params) req.send_request() end |
#create_list(params = {}) ⇒ Struct
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.
808 809 810 811 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 808 def create_list(params = {}, = {}) req = build_request(:create_list, params) req.send_request() end |
#create_model(params = {}) ⇒ Struct
Creates a model using the specified model type.
851 852 853 854 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 851 def create_model(params = {}, = {}) req = build_request(:create_model, params) req.send_request() end |
#create_model_version(params = {}) ⇒ Types::CreateModelVersionResult
Creates a version of the model using the specified model type and model id.
933 934 935 936 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 933 def create_model_version(params = {}, = {}) req = build_request(:create_model_version, params) req.send_request() end |
#create_rule(params = {}) ⇒ Types::CreateRuleResult
Creates a rule for use with the specified detector.
992 993 994 995 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 992 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#create_variable(params = {}) ⇒ Struct
Creates a variable.
1056 1057 1058 1059 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1056 def create_variable(params = {}, = {}) req = build_request(:create_variable, params) req.send_request() end |
#delete_batch_import_job(params = {}) ⇒ Struct
Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1079 def delete_batch_import_job(params = {}, = {}) req = build_request(:delete_batch_import_job, params) req.send_request() end |
#delete_batch_prediction_job(params = {}) ⇒ Struct
Deletes a batch prediction job.
1101 1102 1103 1104 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1101 def delete_batch_prediction_job(params = {}, = {}) req = build_request(:delete_batch_prediction_job, params) req.send_request() end |
#delete_detector(params = {}) ⇒ Struct
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.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1129 def delete_detector(params = {}, = {}) req = build_request(:delete_detector, params) req.send_request() end |
#delete_detector_version(params = {}) ⇒ Struct
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.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1160 def delete_detector_version(params = {}, = {}) req = build_request(:delete_detector_version, params) req.send_request() end |
#delete_entity_type(params = {}) ⇒ Struct
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.
1188 1189 1190 1191 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1188 def delete_entity_type(params = {}, = {}) req = build_request(:delete_entity_type, params) req.send_request() end |
#delete_event(params = {}) ⇒ Struct
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.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1225 def delete_event(params = {}, = {}) req = build_request(:delete_event, params) req.send_request() end |
#delete_event_type(params = {}) ⇒ Struct
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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1253 def delete_event_type(params = {}, = {}) req = build_request(:delete_event_type, params) req.send_request() end |
#delete_events_by_event_type(params = {}) ⇒ Types::DeleteEventsByEventTypeResult
Deletes all events of a particular event type.
1283 1284 1285 1286 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1283 def delete_events_by_event_type(params = {}, = {}) req = build_request(:delete_events_by_event_type, params) req.send_request() end |
#delete_external_model(params = {}) ⇒ Struct
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.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1309 def delete_external_model(params = {}, = {}) req = build_request(:delete_external_model, params) req.send_request() end |
#delete_label(params = {}) ⇒ Struct
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.
1340 1341 1342 1343 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1340 def delete_label(params = {}, = {}) req = build_request(:delete_label, params) req.send_request() end |
#delete_list(params = {}) ⇒ Struct
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.
1365 1366 1367 1368 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1365 def delete_list(params = {}, = {}) req = build_request(:delete_list, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
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.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1397 def delete_model(params = {}, = {}) req = build_request(:delete_model, params) req.send_request() end |
#delete_model_version(params = {}) ⇒ Struct
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.
1434 1435 1436 1437 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1434 def delete_model_version(params = {}, = {}) req = build_request(:delete_model_version, params) req.send_request() end |
#delete_outcome(params = {}) ⇒ Struct
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.
1462 1463 1464 1465 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1462 def delete_outcome(params = {}, = {}) req = build_request(:delete_outcome, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Struct
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.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1492 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_variable(params = {}) ⇒ Struct
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.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1525 def delete_variable(params = {}, = {}) req = build_request(:delete_variable, params) req.send_request() end |
#describe_detector(params = {}) ⇒ Types::DescribeDetectorResult
Gets all versions for a specified detector.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1571 def describe_detector(params = {}, = {}) req = build_request(:describe_detector, params) req.send_request() end |
#describe_model_versions(params = {}) ⇒ Types::DescribeModelVersionsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1699 1700 1701 1702 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1699 def describe_model_versions(params = {}, = {}) req = build_request(:describe_model_versions, params) req.send_request() end |
#get_batch_import_jobs(params = {}) ⇒ Types::GetBatchImportJobsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1758 1759 1760 1761 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1758 def get_batch_import_jobs(params = {}, = {}) req = build_request(:get_batch_import_jobs, params) req.send_request() end |
#get_batch_prediction_jobs(params = {}) ⇒ Types::GetBatchPredictionJobsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1819 def get_batch_prediction_jobs(params = {}, = {}) req = build_request(:get_batch_prediction_jobs, params) req.send_request() end |
#get_delete_events_by_event_type_status(params = {}) ⇒ Types::GetDeleteEventsByEventTypeStatusResult
Retrieves the status of a DeleteEventsByEventType
action.
1849 1850 1851 1852 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1849 def get_delete_events_by_event_type_status(params = {}, = {}) req = build_request(:get_delete_events_by_event_type_status, params) req.send_request() end |
#get_detector_version(params = {}) ⇒ Types::GetDetectorVersionResult
Gets a particular detector version.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1909 def get_detector_version(params = {}, = {}) req = build_request(:get_detector_version, params) req.send_request() end |
#get_detectors(params = {}) ⇒ Types::GetDetectorsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1961 1962 1963 1964 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1961 def get_detectors(params = {}, = {}) req = build_request(:get_detectors, params) req.send_request() end |
#get_entity_types(params = {}) ⇒ Types::GetEntityTypesResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2012 def get_entity_types(params = {}, = {}) req = build_request(:get_entity_types, params) req.send_request() end |
#get_event(params = {}) ⇒ Types::GetEventResult
Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2054 def get_event(params = {}, = {}) req = build_request(:get_event, params) req.send_request() end |
#get_event_prediction(params = {}) ⇒ Types::GetEventPredictionResult
Evaluates an event against a detector version. If a version ID is not
provided, the detector’s (ACTIVE
) version is used.
2167 2168 2169 2170 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2167 def get_event_prediction(params = {}, = {}) req = build_request(:get_event_prediction, params) req.send_request() end |
#get_event_prediction_metadata(params = {}) ⇒ Types::GetEventPredictionMetadataResult
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.
2284 2285 2286 2287 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2284 def (params = {}, = {}) req = build_request(:get_event_prediction_metadata, params) req.send_request() end |
#get_event_types(params = {}) ⇒ Types::GetEventTypesResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2348 2349 2350 2351 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2348 def get_event_types(params = {}, = {}) req = build_request(:get_event_types, params) req.send_request() end |
#get_external_models(params = {}) ⇒ Types::GetExternalModelsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2411 2412 2413 2414 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2411 def get_external_models(params = {}, = {}) req = build_request(:get_external_models, params) req.send_request() end |
#get_kms_encryption_key(params = {}) ⇒ Types::GetKMSEncryptionKeyResult
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
2431 2432 2433 2434 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2431 def get_kms_encryption_key(params = {}, = {}) req = build_request(:get_kms_encryption_key, params) req.send_request() end |
#get_labels(params = {}) ⇒ Types::GetLabelsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2482 2483 2484 2485 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2482 def get_labels(params = {}, = {}) req = build_request(:get_labels, params) req.send_request() end |
#get_list_elements(params = {}) ⇒ Types::GetListElementsResult
Gets all the elements in the specified list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2523 2524 2525 2526 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2523 def get_list_elements(params = {}, = {}) req = build_request(:get_list_elements, params) req.send_request() end |
#get_lists_metadata(params = {}) ⇒ Types::GetListsMetadataResult
Gets the metadata of either all the lists under the account or the specified list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2570 2571 2572 2573 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2570 def (params = {}, = {}) req = build_request(:get_lists_metadata, params) req.send_request() end |
#get_model_version(params = {}) ⇒ Types::GetModelVersionResult
Gets the details of the specified model version.
2629 2630 2631 2632 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2629 def get_model_version(params = {}, = {}) req = build_request(:get_model_version, params) req.send_request() end |
#get_models(params = {}) ⇒ Types::GetModelsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2691 2692 2693 2694 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2691 def get_models(params = {}, = {}) req = build_request(:get_models, params) req.send_request() end |
#get_outcomes(params = {}) ⇒ Types::GetOutcomesResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2741 2742 2743 2744 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2741 def get_outcomes(params = {}, = {}) req = build_request(:get_outcomes, params) req.send_request() end |
#get_rules(params = {}) ⇒ Types::GetRulesResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2809 2810 2811 2812 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2809 def get_rules(params = {}, = {}) req = build_request(:get_rules, params) req.send_request() end |
#get_variables(params = {}) ⇒ Types::GetVariablesResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2863 2864 2865 2866 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2863 def get_variables(params = {}, = {}) req = build_request(:get_variables, params) req.send_request() end |
#list_event_predictions(params = {}) ⇒ Types::ListEventPredictionsResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2951 2952 2953 2954 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2951 def list_event_predictions(params = {}, = {}) req = build_request(:list_event_predictions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2996 2997 2998 2999 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2996 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_detector(params = {}) ⇒ Struct
Creates or updates a detector.
3035 3036 3037 3038 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3035 def put_detector(params = {}, = {}) req = build_request(:put_detector, params) req.send_request() end |
#put_entity_type(params = {}) ⇒ Struct
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.
3074 3075 3076 3077 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3074 def put_entity_type(params = {}, = {}) req = build_request(:put_entity_type, params) req.send_request() end |
#put_event_type(params = {}) ⇒ Struct
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.
3141 3142 3143 3144 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3141 def put_event_type(params = {}, = {}) req = build_request(:put_event_type, params) req.send_request() end |
#put_external_model(params = {}) ⇒ Struct
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.
3208 3209 3210 3211 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3208 def put_external_model(params = {}, = {}) req = build_request(:put_external_model, params) req.send_request() end |
#put_kms_encryption_key(params = {}) ⇒ Struct
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
3234 3235 3236 3237 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3234 def put_kms_encryption_key(params = {}, = {}) req = build_request(:put_kms_encryption_key, params) req.send_request() end |
#put_label(params = {}) ⇒ Struct
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.
3271 3272 3273 3274 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3271 def put_label(params = {}, = {}) req = build_request(:put_label, params) req.send_request() end |
#put_outcome(params = {}) ⇒ Struct
Creates or updates an outcome.
3306 3307 3308 3309 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3306 def put_outcome(params = {}, = {}) req = build_request(:put_outcome, params) req.send_request() end |
#send_event(params = {}) ⇒ Struct
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.
3367 3368 3369 3370 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3367 def send_event(params = {}, = {}) req = build_request(:send_event, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns tags to a resource.
3398 3399 3400 3401 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3398 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
3424 3425 3426 3427 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3424 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_detector_version(params = {}) ⇒ Struct
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.
3499 3500 3501 3502 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3499 def update_detector_version(params = {}, = {}) req = build_request(:update_detector_version, params) req.send_request() end |
#update_detector_version_metadata(params = {}) ⇒ Struct
Updates the detector version's description. You can update the
metadata for any detector version (DRAFT, ACTIVE,
or INACTIVE
).
3530 3531 3532 3533 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3530 def (params = {}, = {}) req = build_request(:update_detector_version_metadata, params) req.send_request() end |
#update_detector_version_status(params = {}) ⇒ Struct
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
.
3564 3565 3566 3567 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3564 def update_detector_version_status(params = {}, = {}) req = build_request(:update_detector_version_status, params) req.send_request() end |
#update_event_label(params = {}) ⇒ Struct
Updates the specified event with a new label.
3599 3600 3601 3602 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3599 def update_event_label(params = {}, = {}) req = build_request(:update_event_label, params) req.send_request() end |
#update_list(params = {}) ⇒ Struct
Updates a list.
3653 3654 3655 3656 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3653 def update_list(params = {}, = {}) req = build_request(:update_list, params) req.send_request() end |
#update_model(params = {}) ⇒ Struct
Updates model description.
3683 3684 3685 3686 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3683 def update_model(params = {}, = {}) req = build_request(:update_model, params) req.send_request() end |
#update_model_version(params = {}) ⇒ Types::UpdateModelVersionResult
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.
3757 3758 3759 3760 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3757 def update_model_version(params = {}, = {}) req = build_request(:update_model_version, params) req.send_request() end |
#update_model_version_status(params = {}) ⇒ Struct
Updates the status of a model version.
You can perform the following status updates:
Change the
TRAINING_IN_PROGRESS
status toTRAINING_CANCELLED
.Change the
TRAINING_COMPLETE
status toACTIVE
.Change
ACTIVE
toINACTIVE
.
3799 3800 3801 3802 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3799 def update_model_version_status(params = {}, = {}) req = build_request(:update_model_version_status, params) req.send_request() end |
#update_rule_metadata(params = {}) ⇒ Struct
Updates a rule's metadata. The description attribute can be updated.
3829 3830 3831 3832 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3829 def (params = {}, = {}) req = build_request(:update_rule_metadata, params) req.send_request() end |
#update_rule_version(params = {}) ⇒ Types::UpdateRuleVersionResult
Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
3889 3890 3891 3892 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3889 def update_rule_version(params = {}, = {}) req = build_request(:update_rule_version, params) req.send_request() end |
#update_variable(params = {}) ⇒ Struct
Updates a variable.
3927 3928 3929 3930 |
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3927 def update_variable(params = {}, = {}) req = build_request(:update_variable, params) req.send_request() end |