Class: Aws::FraudDetector::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



315
316
317
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 315

def initialize(*args)
  super
end

Instance Method Details

#batch_create_variable(params = {}) ⇒ Types::BatchCreateVariableResult

Creates a batch of variables.

Examples:

Request syntax with placeholder values


resp = client.batch_create_variable({
  variable_entries: [ # required
    {
      name: "string",
      data_type: "string",
      data_source: "string",
      default_value: "string",
      description: "string",
      variable_type: "string",
    },
  ],
})

Response structure


resp.errors #=> Array
resp.errors[0].name #=> String
resp.errors[0].code #=> Integer
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :variable_entries (required, Array<Types::VariableEntry>) —

    The list of variables for the batch create variable request.

Returns:

See Also:



356
357
358
359
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 356

def batch_create_variable(params = {}, options = {})
  req = build_request(:batch_create_variable, params)
  req.send_request(options)
end

#batch_get_variable(params = {}) ⇒ Types::BatchGetVariableResult

Gets a batch of variables.

Examples:

Request syntax with placeholder values


resp = client.batch_get_variable({
  names: ["string"], # required
})

Response structure


resp.variables #=> Array
resp.variables[0].name #=> String
resp.variables[0].data_type #=> String, one of "STRING", "INTEGER", "FLOAT", "BOOLEAN"
resp.variables[0].data_source #=> String, one of "EVENT", "MODEL_SCORE", "EXTERNAL_MODEL_SCORE"
resp.variables[0].default_value #=> String
resp.variables[0].description #=> String
resp.variables[0].variable_type #=> String
resp.variables[0].last_updated_time #=> String
resp.variables[0].created_time #=> String
resp.errors #=> Array
resp.errors[0].name #=> String
resp.errors[0].code #=> Integer
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :names (required, Array<String>) —

    The list of variable names to get.

Returns:

See Also:



397
398
399
400
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 397

def batch_get_variable(params = {}, options = {})
  req = build_request(:batch_get_variable, params)
  req.send_request(options)
end

#create_detector_version(params = {}) ⇒ Types::CreateDetectorVersionResult

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

Examples:

Request syntax with placeholder values


resp = client.create_detector_version({
  detector_id: "identifier", # required
  description: "description",
  external_model_endpoints: ["string"],
  rules: [ # required
    {
      detector_id: "identifier", # required
      rule_id: "identifier", # required
      rule_version: "nonEmptyString", # required
    },
  ],
  model_versions: [
    {
      model_id: "identifier", # required
      model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
      model_version_number: "nonEmptyString", # required
    },
  ],
  rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
})

Response structure


resp.detector_id #=> String
resp.detector_version_id #=> String
resp.status #=> String, one of "DRAFT", "ACTIVE", "INACTIVE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

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

  • :description (String) —

    The description of the detector version.

  • :external_model_endpoints (Array<String>) —

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

  • :rules (required, Array<Types::Rule>) —

    The rules to include in the detector version.

  • :model_versions (Array<Types::ModelVersion>) —

    The model versions to include in the detector version.

  • :rule_execution_mode (String) —

    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.

Returns:

See Also:



477
478
479
480
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 477

def create_detector_version(params = {}, options = {})
  req = build_request(:create_detector_version, params)
  req.send_request(options)
end

#create_model_version(params = {}) ⇒ Types::CreateModelVersionResult

Creates a version of the model using the specified model type.

Examples:

Request syntax with placeholder values


resp = client.create_model_version({
  model_id: "identifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  description: "description",
})

Response structure


resp.model_id #=> String
resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
resp.model_version_number #=> String
resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_id (required, String) —

    The model ID.

  • :model_type (required, String) —

    The model type.

  • :description (String) —

    The model version description.

Returns:

See Also:



519
520
521
522
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 519

def create_model_version(params = {}, options = {})
  req = build_request(:create_model_version, params)
  req.send_request(options)
end

#create_rule(params = {}) ⇒ Types::CreateRuleResult

Creates a rule for use with the specified detector.

Examples:

Request syntax with placeholder values


resp = client.create_rule({
  rule_id: "identifier", # required
  detector_id: "identifier", # required
  description: "description",
  expression: "ruleExpression", # required
  language: "DETECTORPL", # required, accepts DETECTORPL
  outcomes: ["string"], # required
})

Response structure


resp.rule.detector_id #=> String
resp.rule.rule_id #=> String
resp.rule.rule_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_id (required, String) —

    The rule ID.

  • :detector_id (required, String) —

    The detector ID for the rule's parent detector.

  • :description (String) —

    The rule description.

  • :expression (required, String) —

    The rule expression.

  • :language (required, String) —

    The language of the rule.

  • :outcomes (required, Array<String>) —

    The outcome or outcomes returned when the rule expression matches.

Returns:

See Also:



569
570
571
572
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 569

def create_rule(params = {}, options = {})
  req = build_request(:create_rule, params)
  req.send_request(options)
end

#create_variable(params = {}) ⇒ Struct

Creates a variable.

Examples:

Request syntax with placeholder values


resp = client.create_variable({
  name: "string", # required
  data_type: "STRING", # required, accepts STRING, INTEGER, FLOAT, BOOLEAN
  data_source: "EVENT", # required, accepts EVENT, MODEL_SCORE, EXTERNAL_MODEL_SCORE
  default_value: "string", # required
  description: "string",
  variable_type: "string",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the variable.

  • :data_type (required, String) —

    The data type.

  • :data_source (required, String) —

    The source of the data.

  • :default_value (required, String) —

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

  • :description (String) —

    The description.

  • :variable_type (String) —

    The variable type.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



611
612
613
614
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 611

def create_variable(params = {}, options = {})
  req = build_request(:create_variable, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_detector({
  detector_id: "identifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The ID of the detector to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



635
636
637
638
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 635

def delete_detector(params = {}, options = {})
  req = build_request(:delete_detector, params)
  req.send_request(options)
end

#delete_detector_version(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_detector_version({
  detector_id: "identifier", # required
  detector_version_id: "nonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

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

  • :detector_version_id (required, String) —

    The ID of the detector version to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



662
663
664
665
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 662

def delete_detector_version(params = {}, options = {})
  req = build_request(:delete_detector_version, params)
  req.send_request(options)
end

#delete_event(params = {}) ⇒ Struct

Deletes the specified event.

Examples:

Request syntax with placeholder values


resp = client.delete_event({
  event_id: "string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The ID of the event to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



684
685
686
687
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 684

def delete_event(params = {}, options = {})
  req = build_request(:delete_event, params)
  req.send_request(options)
end

#delete_rule_version(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_rule_version({
  detector_id: "identifier", # required
  rule_id: "identifier", # required
  rule_version: "nonEmptyString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The ID of the detector that includes the rule version to delete.

  • :rule_id (required, String) —

    The rule ID of the rule version to delete.

  • :rule_version (required, String) —

    The rule version to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



715
716
717
718
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 715

def delete_rule_version(params = {}, options = {})
  req = build_request(:delete_rule_version, params)
  req.send_request(options)
end

#describe_detector(params = {}) ⇒ Types::DescribeDetectorResult

Gets all versions for a specified detector.

Examples:

Request syntax with placeholder values


resp = client.describe_detector({
  detector_id: "identifier", # required
  next_token: "string",
  max_results: 1,
})

Response structure


resp.detector_id #=> String
resp.detector_version_summaries #=> Array
resp.detector_version_summaries[0].detector_version_id #=> String
resp.detector_version_summaries[0].status #=> String, one of "DRAFT", "ACTIVE", "INACTIVE"
resp.detector_version_summaries[0].description #=> String
resp.detector_version_summaries[0].last_updated_time #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The detector ID.

  • :next_token (String) —

    The next token from the previous response.

  • :max_results (Integer) —

    The maximum number of results to return for the request.

Returns:

See Also:



759
760
761
762
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 759

def describe_detector(params = {}, options = {})
  req = build_request(:describe_detector, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_model_versions({
  model_id: "identifier",
  model_version_number: "nonEmptyString",
  model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
  next_token: "string",
  max_results: 1,
})

Response structure


resp.model_version_details #=> Array
resp.model_version_details[0].model_id #=> String
resp.model_version_details[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
resp.model_version_details[0].model_version_number #=> String
resp.model_version_details[0].description #=> String
resp.model_version_details[0].status #=> String
resp.model_version_details[0].training_data_source.data_location #=> String
resp.model_version_details[0].training_data_source.data_access_role_arn #=> String
resp.model_version_details[0].model_variables #=> Array
resp.model_version_details[0].model_variables[0].name #=> String
resp.model_version_details[0].model_variables[0].index #=> Integer
resp.model_version_details[0].label_schema.label_key #=> String
resp.model_version_details[0].label_schema.label_mapper #=> Hash
resp.model_version_details[0].label_schema.label_mapper["string"] #=> Array
resp.model_version_details[0].label_schema.label_mapper["string"][0] #=> String
resp.model_version_details[0].validation_metrics #=> Hash
resp.model_version_details[0].validation_metrics["string"] #=> String
resp.model_version_details[0].training_metrics #=> Hash
resp.model_version_details[0].training_metrics["string"] #=> String
resp.model_version_details[0].last_updated_time #=> String
resp.model_version_details[0].created_time #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_id (String) —

    The model ID.

  • :model_version_number (String) —

    The model version.

  • :model_type (String) —

    The model type.

  • :next_token (String) —

    The next token from the previous results.

  • :max_results (Integer) —

    The maximum number of results to return.

Returns:

See Also:



829
830
831
832
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 829

def describe_model_versions(params = {}, options = {})
  req = build_request(:describe_model_versions, params)
  req.send_request(options)
end

#get_detector_version(params = {}) ⇒ Types::GetDetectorVersionResult

Gets a particular detector version.

Examples:

Request syntax with placeholder values


resp = client.get_detector_version({
  detector_id: "identifier", # required
  detector_version_id: "nonEmptyString", # required
})

Response structure


resp.detector_id #=> String
resp.detector_version_id #=> String
resp.description #=> String
resp.external_model_endpoints #=> Array
resp.external_model_endpoints[0] #=> String
resp.model_versions #=> Array
resp.model_versions[0].model_id #=> String
resp.model_versions[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
resp.model_versions[0].model_version_number #=> String
resp.rules #=> Array
resp.rules[0].detector_id #=> String
resp.rules[0].rule_id #=> String
resp.rules[0].rule_version #=> String
resp.status #=> String, one of "DRAFT", "ACTIVE", "INACTIVE"
resp.last_updated_time #=> String
resp.created_time #=> String
resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The detector ID.

  • :detector_version_id (required, String) —

    The detector version ID.

Returns:

See Also:



886
887
888
889
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 886

def get_detector_version(params = {}, options = {})
  req = build_request(:get_detector_version, params)
  req.send_request(options)
end

#get_detectors(params = {}) ⇒ Types::GetDetectorsResult

Gets all of detectors. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, 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.

Examples:

Request syntax with placeholder values


resp = client.get_detectors({
  detector_id: "identifier",
  next_token: "string",
  max_results: 1,
})

Response structure


resp.detectors #=> Array
resp.detectors[0].detector_id #=> String
resp.detectors[0].description #=> String
resp.detectors[0].last_updated_time #=> String
resp.detectors[0].created_time #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (String) —

    The detector ID.

  • :next_token (String) —

    The next token for the subsequent request.

  • :max_results (Integer) —

    The maximum number of objects to return for the request.

Returns:

See Also:



935
936
937
938
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 935

def get_detectors(params = {}, options = {})
  req = build_request(:get_detectors, params)
  req.send_request(options)
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 maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, 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.

Examples:

Request syntax with placeholder values


resp = client.get_external_models({
  model_endpoint: "string",
  next_token: "string",
  max_results: 1,
})

Response structure


resp.external_models #=> Array
resp.external_models[0].model_endpoint #=> String
resp.external_models[0].model_source #=> String, one of "SAGEMAKER"
resp.external_models[0].role.arn #=> String
resp.external_models[0].role.name #=> String
resp.external_models[0].input_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSON"
resp.external_models[0].input_configuration.is_opaque #=> Boolean
resp.external_models[0].input_configuration.json_input_template #=> String
resp.external_models[0].input_configuration.csv_input_template #=> String
resp.external_models[0].output_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSONLINES"
resp.external_models[0].output_configuration.json_key_to_variable_map #=> Hash
resp.external_models[0].output_configuration.json_key_to_variable_map["string"] #=> String
resp.external_models[0].output_configuration.csv_index_to_variable_map #=> Hash
resp.external_models[0].output_configuration.csv_index_to_variable_map["string"] #=> String
resp.external_models[0].model_endpoint_status #=> String, one of "ASSOCIATED", "DISSOCIATED"
resp.external_models[0].last_updated_time #=> String
resp.external_models[0].created_time #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_endpoint (String) —

    The Amazon SageMaker model endpoint.

  • :next_token (String) —

    The next page token for the request.

  • :max_results (Integer) —

    The maximum number of objects to return for the request.

Returns:

See Also:



998
999
1000
1001
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 998

def get_external_models(params = {}, options = {})
  req = build_request(:get_external_models, params)
  req.send_request(options)
end

#get_model_version(params = {}) ⇒ Types::GetModelVersionResult

Gets a model version.

Examples:

Request syntax with placeholder values


resp = client.get_model_version({
  model_id: "identifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  model_version_number: "nonEmptyString", # required
})

Response structure


resp.model_id #=> String
resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
resp.model_version_number #=> String
resp.description #=> String
resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_id (required, String) —

    The model ID.

  • :model_type (required, String) —

    The model type.

  • :model_version_number (required, String) —

    The model version.

Returns:

See Also:



1042
1043
1044
1045
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1042

def get_model_version(params = {}, options = {})
  req = build_request(:get_model_version, params)
  req.send_request(options)
end

#get_models(params = {}) ⇒ Types::GetModelsResult

Gets all of the models for the AWS account, or the specified model type, or gets a single model for the specified model type, model ID combination.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_models({
  model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
  model_id: "identifier",
  next_token: "string",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.models #=> Array
resp.models[0].model_id #=> String
resp.models[0].model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
resp.models[0].description #=> String
resp.models[0].training_data_source.data_location #=> String
resp.models[0].training_data_source.data_access_role_arn #=> String
resp.models[0].model_variables #=> Array
resp.models[0].model_variables[0].name #=> String
resp.models[0].model_variables[0].index #=> Integer
resp.models[0].label_schema.label_key #=> String
resp.models[0].label_schema.label_mapper #=> Hash
resp.models[0].label_schema.label_mapper["string"] #=> Array
resp.models[0].label_schema.label_mapper["string"][0] #=> String
resp.models[0].last_updated_time #=> String
resp.models[0].created_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_type (String) —

    The model type.

  • :model_id (String) —

    The model ID.

  • :next_token (String) —

    The next token for the request.

  • :max_results (Integer) —

    The maximum results to return for the request.

Returns:

See Also:



1102
1103
1104
1105
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1102

def get_models(params = {}, options = {})
  req = build_request(:get_models, params)
  req.send_request(options)
end

#get_outcomes(params = {}) ⇒ Types::GetOutcomesResult

Gets one or more outcomes. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, 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.

Examples:

Request syntax with placeholder values


resp = client.get_outcomes({
  name: "identifier",
  next_token: "string",
  max_results: 1,
})

Response structure


resp.outcomes #=> Array
resp.outcomes[0].name #=> String
resp.outcomes[0].description #=> String
resp.outcomes[0].last_updated_time #=> String
resp.outcomes[0].created_time #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

    The name of the outcome or outcomes to get.

  • :next_token (String) —

    The next page token for the request.

  • :max_results (Integer) —

    The maximum number of objects to return for the request.

Returns:

See Also:



1151
1152
1153
1154
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1151

def get_outcomes(params = {}, options = {})
  req = build_request(:get_outcomes, params)
  req.send_request(options)
end

#get_prediction(params = {}) ⇒ Types::GetPredictionResult

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

Examples:

Request syntax with placeholder values


resp = client.get_prediction({
  detector_id: "string", # required
  detector_version_id: "string",
  event_id: "string", # required
  event_attributes: {
    "attributeKey" => "attributeValue",
  },
  external_model_endpoint_data_blobs: {
    "string" => {
      byte_buffer: "data",
      content_type: "contentType",
    },
  },
})

Response structure


resp.outcomes #=> Array
resp.outcomes[0] #=> String
resp.model_scores #=> Array
resp.model_scores[0].model_version.model_id #=> String
resp.model_scores[0].model_version.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
resp.model_scores[0].model_version.model_version_number #=> String
resp.model_scores[0].scores #=> Hash
resp.model_scores[0].scores["string"] #=> Float
resp.rule_results #=> Array
resp.rule_results[0].rule_id #=> String
resp.rule_results[0].outcomes #=> Array
resp.rule_results[0].outcomes[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The detector ID.

  • :detector_version_id (String) —

    The detector version ID.

  • :event_id (required, String) —

    The unique ID used to identify the event.

  • :event_attributes (Hash<String,String>) —

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

  • :external_model_endpoint_data_blobs (Hash<String,Types::ModelEndpointDataBlob>) —

    The Amazon SageMaker model endpoint input data blobs.

Returns:

See Also:



1218
1219
1220
1221
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1218

def get_prediction(params = {}, options = {})
  req = build_request(:get_prediction, params)
  req.send_request(options)
end

#get_rules(params = {}) ⇒ Types::GetRulesResult

Gets all rules available for the specified detector.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_rules({
  rule_id: "identifier",
  detector_id: "identifier", # required
  rule_version: "nonEmptyString",
  next_token: "string",
  max_results: 1,
})

Response structure


resp.rule_details #=> Array
resp.rule_details[0].rule_id #=> String
resp.rule_details[0].description #=> String
resp.rule_details[0].detector_id #=> String
resp.rule_details[0].rule_version #=> String
resp.rule_details[0].expression #=> String
resp.rule_details[0].language #=> String, one of "DETECTORPL"
resp.rule_details[0].outcomes #=> Array
resp.rule_details[0].outcomes[0] #=> String
resp.rule_details[0].last_updated_time #=> String
resp.rule_details[0].created_time #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_id (String) —

    The rule ID.

  • :detector_id (required, String) —

    The detector ID.

  • :rule_version (String) —

    The rule version.

  • :next_token (String) —

    The next page token.

  • :max_results (Integer) —

    The maximum number of rules to return for the request.

Returns:

See Also:



1276
1277
1278
1279
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1276

def get_rules(params = {}, options = {})
  req = build_request(:get_rules, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_variables({
  name: "string",
  next_token: "string",
  max_results: 1,
})

Response structure


resp.variables #=> Array
resp.variables[0].name #=> String
resp.variables[0].data_type #=> String, one of "STRING", "INTEGER", "FLOAT", "BOOLEAN"
resp.variables[0].data_source #=> String, one of "EVENT", "MODEL_SCORE", "EXTERNAL_MODEL_SCORE"
resp.variables[0].default_value #=> String
resp.variables[0].description #=> String
resp.variables[0].variable_type #=> String
resp.variables[0].last_updated_time #=> String
resp.variables[0].created_time #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

    The name of the variable.

  • :next_token (String) —

    The next page token of the get variable request.

  • :max_results (Integer) —

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

Returns:

See Also:



1329
1330
1331
1332
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1329

def get_variables(params = {}, options = {})
  req = build_request(:get_variables, params)
  req.send_request(options)
end

#put_detector(params = {}) ⇒ Struct

Creates or updates a detector.

Examples:

Request syntax with placeholder values


resp = client.put_detector({
  detector_id: "identifier", # required
  description: "description",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The detector ID.

  • :description (String) —

    The description of the detector.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1355
1356
1357
1358
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1355

def put_detector(params = {}, options = {})
  req = build_request(:put_detector, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.put_external_model({
  model_endpoint: "string", # required
  model_source: "SAGEMAKER", # required, accepts SAGEMAKER
  role: { # required
    arn: "string", # required
    name: "string", # required
  },
  input_configuration: { # required
    format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
    is_opaque: false, # required
    json_input_template: "string",
    csv_input_template: "string",
  },
  output_configuration: { # required
    format: "TEXT_CSV", # required, accepts TEXT_CSV, APPLICATION_JSONLINES
    json_key_to_variable_map: {
      "string" => "string",
    },
    csv_index_to_variable_map: {
      "string" => "string",
    },
  },
  model_endpoint_status: "ASSOCIATED", # required, accepts ASSOCIATED, DISSOCIATED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_endpoint (required, String) —

    The model endpoints name.

  • :model_source (required, String) —

    The source of the model.

  • :role (required, Types::Role) —

    The IAM role used to invoke the model endpoint.

  • :input_configuration (required, Types::ModelInputConfiguration) —

    The model endpoint input configuration.

  • :output_configuration (required, Types::ModelOutputConfiguration) —

    The model endpoint output configuration.

  • :model_endpoint_status (required, String) —

    The model endpoint’s status in Amazon Fraud Detector.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1415
1416
1417
1418
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1415

def put_external_model(params = {}, options = {})
  req = build_request(:put_external_model, params)
  req.send_request(options)
end

#put_model(params = {}) ⇒ Struct

Creates or updates a model.

Examples:

Request syntax with placeholder values


resp = client.put_model({
  model_id: "identifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  description: "description",
  training_data_source: { # required
    data_location: "s3BucketLocation", # required
    data_access_role_arn: "iamRoleArn", # required
  },
  model_variables: [ # required
    {
      name: "string", # required
      index: 1,
    },
  ],
  label_schema: { # required
    label_key: "string", # required
    label_mapper: { # required
      "string" => ["string"],
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_id (required, String) —

    The model ID.

  • :model_type (required, String) —

    The model type.

  • :description (String) —

    The model description.

  • :training_data_source (required, Types::TrainingDataSource) —

    The training data source location in Amazon S3.

  • :model_variables (required, Array<Types::ModelVariable>) —

    The model input variables.

  • :label_schema (required, Types::LabelSchema) —

    The label schema.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1470
1471
1472
1473
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1470

def put_model(params = {}, options = {})
  req = build_request(:put_model, params)
  req.send_request(options)
end

#put_outcome(params = {}) ⇒ Struct

Creates or updates an outcome.

Examples:

Request syntax with placeholder values


resp = client.put_outcome({
  name: "identifier", # required
  description: "description",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the outcome.

  • :description (String) —

    The outcome description.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1496
1497
1498
1499
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1496

def put_outcome(params = {}, options = {})
  req = build_request(:put_outcome, params)
  req.send_request(options)
end

#update_detector_version(params = {}) ⇒ Struct

Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, and description. You can only update a DRAFT detector version.

Examples:

Request syntax with placeholder values


resp = client.update_detector_version({
  detector_id: "identifier", # required
  detector_version_id: "nonEmptyString", # required
  external_model_endpoints: ["string"], # required
  rules: [ # required
    {
      detector_id: "identifier", # required
      rule_id: "identifier", # required
      rule_version: "nonEmptyString", # required
    },
  ],
  description: "description",
  model_versions: [
    {
      model_id: "identifier", # required
      model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
      model_version_number: "nonEmptyString", # required
    },
  ],
  rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

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

  • :detector_version_id (required, String) —

    The detector version ID.

  • :external_model_endpoints (required, Array<String>) —

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

  • :rules (required, Array<Types::Rule>) —

    The rules to include in the detector version.

  • :description (String) —

    The detector version description.

  • :model_versions (Array<Types::ModelVersion>) —

    The model versions to include in the detector version.

  • :rule_execution_mode (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1569
1570
1571
1572
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1569

def update_detector_version(params = {}, options = {})
  req = build_request(:update_detector_version, params)
  req.send_request(options)
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).

Examples:

Request syntax with placeholder values


resp = client.update_detector_version_metadata({
  detector_id: "identifier", # required
  detector_version_id: "nonEmptyString", # required
  description: "description", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The detector ID.

  • :detector_version_id (required, String) —

    The detector version ID.

  • :description (required, String) —

    The description.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1600
1601
1602
1603
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1600

def update_detector_version_metadata(params = {}, options = {})
  req = build_request(:update_detector_version_metadata, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_detector_version_status({
  detector_id: "identifier", # required
  detector_version_id: "nonEmptyString", # required
  status: "DRAFT", # required, accepts DRAFT, ACTIVE, INACTIVE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :detector_id (required, String) —

    The detector ID.

  • :detector_version_id (required, String) —

    The detector version ID.

  • :status (required, String) —

    The new status.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1632
1633
1634
1635
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1632

def update_detector_version_status(params = {}, options = {})
  req = build_request(:update_detector_version_status, params)
  req.send_request(options)
end

#update_model_version(params = {}) ⇒ Struct

Updates a model version. You can update the description and status attributes using this action. You can perform the following status updates:

  1. Change the TRAINING_COMPLETE status to ACTIVE

  2. Change ACTIVE back to TRAINING_COMPLETE

Examples:

Request syntax with placeholder values


resp = client.update_model_version({
  model_id: "identifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  model_version_number: "nonEmptyString", # required
  description: "description", # required
  status: "TRAINING_IN_PROGRESS", # required, accepts TRAINING_IN_PROGRESS, TRAINING_COMPLETE, ACTIVATE_REQUESTED, ACTIVATE_IN_PROGRESS, ACTIVE, INACTIVATE_IN_PROGRESS, INACTIVE, ERROR
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :model_id (required, String) —

    The model ID.

  • :model_type (required, String) —

    The model type.

  • :model_version_number (required, String) —

    The model version.

  • :description (required, String) —

    The model description.

  • :status (required, String) —

    The new model status.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1676
1677
1678
1679
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1676

def update_model_version(params = {}, options = {})
  req = build_request(:update_model_version, params)
  req.send_request(options)
end

#update_rule_metadata(params = {}) ⇒ Struct

Updates a rule's metadata.

Examples:

Request syntax with placeholder values


resp = client.update_rule_metadata({
  rule: { # required
    detector_id: "identifier", # required
    rule_id: "identifier", # required
    rule_version: "nonEmptyString", # required
  },
  description: "description", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule (required, Types::Rule) —

    The rule to update.

  • :description (required, String) —

    The rule description.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1706
1707
1708
1709
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1706

def update_rule_metadata(params = {}, options = {})
  req = build_request(:update_rule_metadata, params)
  req.send_request(options)
end

#update_rule_version(params = {}) ⇒ Types::UpdateRuleVersionResult

Updates a rule version resulting in a new rule version.

Examples:

Request syntax with placeholder values


resp = client.update_rule_version({
  rule: { # required
    detector_id: "identifier", # required
    rule_id: "identifier", # required
    rule_version: "nonEmptyString", # required
  },
  description: "description",
  expression: "ruleExpression", # required
  language: "DETECTORPL", # required, accepts DETECTORPL
  outcomes: ["string"], # required
})

Response structure


resp.rule.detector_id #=> String
resp.rule.rule_id #=> String
resp.rule.rule_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule (required, Types::Rule) —

    The rule to update.

  • :description (String) —

    The description.

  • :expression (required, String) —

    The rule expression.

  • :language (required, String) —

    The language.

  • :outcomes (required, Array<String>) —

    The outcomes.

Returns:

See Also:



1756
1757
1758
1759
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1756

def update_rule_version(params = {}, options = {})
  req = build_request(:update_rule_version, params)
  req.send_request(options)
end

#update_variable(params = {}) ⇒ Struct

Updates a variable.

Examples:

Request syntax with placeholder values


resp = client.update_variable({
  name: "string", # required
  default_value: "string",
  description: "string",
  variable_type: "string",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the variable.

  • :default_value (String) —

    The new default value of the variable.

  • :description (String) —

    The new description.

  • :variable_type (String) —

    The variable type.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1790
1791
1792
1793
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1790

def update_variable(params = {}, options = {})
  req = build_request(:update_variable, params)
  req.send_request(options)
end