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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    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/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials 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 or custom 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.



334
335
336
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 334

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",
    },
  ],
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

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.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

See Also:



384
385
386
387
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 384

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.variables[0].arn #=> 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:



426
427
428
429
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 426

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

#cancel_batch_prediction_job(params = {}) ⇒ Struct

Cancels the specified batch prediction job.

Examples:

Request syntax with placeholder values


resp = client.cancel_batch_prediction_job({
  job_id: "identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String)

    The ID of the batch prediction job to cancel.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



448
449
450
451
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 448

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

#create_batch_prediction_job(params = {}) ⇒ Struct

Creates a batch prediction job.

Examples:

Request syntax with placeholder values


resp = client.create_batch_prediction_job({
  job_id: "identifier", # required
  input_path: "s3BucketLocation", # required
  output_path: "s3BucketLocation", # required
  event_type_name: "identifier", # required
  detector_name: "identifier", # required
  detector_version: "wholeNumberVersionString",
  iam_role_arn: "iamRoleArn", # required
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String)

    The ID of the batch prediction job.

  • :input_path (required, String)

    The Amazon S3 location of your training file.

  • :output_path (required, String)

    The Amazon S3 location of your output file.

  • :event_type_name (required, String)

    The name of the event type.

  • :detector_name (required, String)

    The name of the detector.

  • :detector_version (String)

    The detector version.

  • :iam_role_arn (required, String)

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

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



503
504
505
506
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 503

def create_batch_prediction_job(params = {}, options = {})
  req = build_request(:create_batch_prediction_job, 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: "wholeNumberVersionString", # required
    },
  ],
  model_versions: [
    {
      model_id: "modelIdentifier", # required
      model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
      model_version_number: "nonEmptyString", # required
      arn: "fraudDetectorArn",
    },
  ],
  rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

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.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

See Also:



593
594
595
596
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 593

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

#create_model(params = {}) ⇒ Struct

Creates a model using the specified model type.

Examples:

Request syntax with placeholder values


resp = client.create_model({
  model_id: "modelIdentifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  description: "description",
  event_type_name: "string", # required
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

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.

  • :event_type_name (required, String)

    The name of the event type.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.create_model_version({
  model_id: "modelIdentifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS
  training_data_schema: { # required
    model_variables: ["string"], # required
    label_schema: { # required
      label_mapper: { # required
        "string" => ["string"],
      },
    },
  },
  external_events_detail: {
    data_location: "s3BucketLocation", # required
    data_access_role_arn: "iamRoleArn", # required
  },
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

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.

  • :training_data_source (required, String)

    The training data source location in Amazon S3.

  • :training_data_schema (required, Types::TrainingDataSchema)

    The training data schema.

  • :external_events_detail (Types::ExternalEventsDetail)

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

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

See Also:



707
708
709
710
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 707

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
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # 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.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

See Also:



766
767
768
769
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 766

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",
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

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. For more information see Variable types.

    Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#delete_batch_prediction_job(params = {}) ⇒ Struct

Deletes a batch prediction job.

Examples:

Request syntax with placeholder values


resp = client.delete_batch_prediction_job({
  job_id: "identifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String)

    The ID of the batch prediction job to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



852
853
854
855
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 852

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

When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud 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:



880
881
882
883
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 880

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.

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

Examples:

Request syntax with placeholder values


resp = client.delete_detector_version({
  detector_id: "identifier", # required
  detector_version_id: "wholeNumberVersionString", # 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:



911
912
913
914
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 911

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the entity type to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



939
940
941
942
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 939

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String)

    The ID of the event to delete.

  • :event_type_name (required, String)

    The name of the event type.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



969
970
971
972
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 969

def delete_event(params = {}, options = {})
  req = build_request(:delete_event, params)
  req.send_request(options)
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 entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the event type to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

Examples:

Request syntax with placeholder values


resp = client.delete_external_model({
  model_endpoint: "sageMakerEndpointIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :model_endpoint (required, String)

    The endpoint of the Amazon Sagemaker model to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1023
1024
1025
1026
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1023

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the label to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1054
1055
1056
1057
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1054

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

Examples:

Request syntax with placeholder values


resp = client.delete_model({
  model_id: "modelIdentifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
})

Parameters:

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

    ({})

Options Hash (params):

  • :model_id (required, String)

    The model ID of the model to delete.

  • :model_type (required, String)

    The model type of the model to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1086
1087
1088
1089
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1086

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

Examples:

Request syntax with placeholder values


resp = client.delete_model_version({
  model_id: "modelIdentifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  model_version_number: "floatVersionString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :model_id (required, String)

    The model ID of the model version to delete.

  • :model_type (required, String)

    The model type of the model version to delete.

  • :model_version_number (required, String)

    The model version number of the model version to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1123
1124
1125
1126
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1123

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the outcome to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

Examples:

Request syntax with placeholder values


resp = client.delete_rule({
  rule: { # required
    detector_id: "identifier", # required
    rule_id: "identifier", # required
    rule_version: "wholeNumberVersionString", # required
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1181
1182
1183
1184
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1181

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

Examples:

Request syntax with placeholder values


resp = client.delete_variable({
  name: "string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the variable to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1214
1215
1216
1217
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1214

def delete_variable(params = {}, options = {})
  req = build_request(:delete_variable, 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
resp.arn #=> 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:



1260
1261
1262
1263
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1260

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: "modelIdentifier",
  model_version_number: "floatVersionString",
  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].status #=> String
resp.model_version_details[0].training_data_source #=> String, one of "EXTERNAL_EVENTS"
resp.model_version_details[0].training_data_schema.model_variables #=> Array
resp.model_version_details[0].training_data_schema.model_variables[0] #=> String
resp.model_version_details[0].training_data_schema.label_schema.label_mapper #=> Hash
resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"] #=> Array
resp.model_version_details[0].training_data_schema.label_schema.label_mapper["string"][0] #=> String
resp.model_version_details[0].external_events_detail.data_location #=> String
resp.model_version_details[0].external_events_detail.data_access_role_arn #=> String
resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages #=> Array
resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].title #=> String
resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].content #=> String
resp.model_version_details[0].training_result.data_validation_metrics.file_level_messages[0].type #=> String
resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages #=> Array
resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].field_name #=> String
resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].identifier #=> String
resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].title #=> String
resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].content #=> String
resp.model_version_details[0].training_result.data_validation_metrics.field_level_messages[0].type #=> String
resp.model_version_details[0].training_result.training_metrics.auc #=> Float
resp.model_version_details[0].training_result.training_metrics.metric_data_points #=> Array
resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].fpr #=> Float
resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].precision #=> Float
resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].tpr #=> Float
resp.model_version_details[0].training_result.training_metrics.metric_data_points[0].threshold #=> Float
resp.model_version_details[0].last_updated_time #=> String
resp.model_version_details[0].created_time #=> String
resp.model_version_details[0].arn #=> 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 number.

  • :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:



1341
1342
1343
1344
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1341

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.batch_predictions #=> Array
resp.batch_predictions[0].job_id #=> String
resp.batch_predictions[0].status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"
resp.batch_predictions[0].failure_reason #=> String
resp.batch_predictions[0].start_time #=> String
resp.batch_predictions[0].completion_time #=> String
resp.batch_predictions[0].last_heartbeat_time #=> String
resp.batch_predictions[0].input_path #=> String
resp.batch_predictions[0].output_path #=> String
resp.batch_predictions[0].event_type_name #=> String
resp.batch_predictions[0].detector_name #=> String
resp.batch_predictions[0].detector_version #=> String
resp.batch_predictions[0].iam_role_arn #=> String
resp.batch_predictions[0].arn #=> String
resp.batch_predictions[0].processed_records_count #=> Integer
resp.batch_predictions[0].total_records_count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (String)

    The batch prediction job for which to get the details.

  • :max_results (Integer)

    The maximum number of objects to return for the request.

  • :next_token (String)

    The next token from the previous request.

Returns:

See Also:



1402
1403
1404
1405
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1402

def get_batch_prediction_jobs(params = {}, options = {})
  req = build_request(:get_batch_prediction_jobs, 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: "wholeNumberVersionString", # 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.model_versions[0].arn #=> 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"
resp.arn #=> String

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:



1462
1463
1464
1465
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1462

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

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].event_type_name #=> String
resp.detectors[0].last_updated_time #=> String
resp.detectors[0].created_time #=> String
resp.detectors[0].arn #=> 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:



1514
1515
1516
1517
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1514

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String)

    The name.

  • :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:



1565
1566
1567
1568
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1565

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

Examples:

Request syntax with placeholder values


resp = client.get_event_prediction({
  detector_id: "string", # required
  detector_version_id: "wholeNumberVersionString",
  event_id: "string", # required
  event_type_name: "string", # required
  entities: [ # required
    {
      entity_type: "string", # required
      entity_id: "identifier", # required
    },
  ],
  event_timestamp: "string", # required
  event_variables: { # required
    "variableName" => "variableValue",
  },
  external_model_endpoint_data_blobs: {
    "string" => {
      byte_buffer: "data",
      content_type: "contentType",
    },
  },
})

Response structure


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].model_version.arn #=> 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_type_name (required, String)

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

  • :entities (required, Array<Types::Entity>)

    The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."

  • :event_timestamp (required, String)

    Timestamp that defines when the event under evaluation occurred.

  • :event_variables (required, Hash<String,String>)

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

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

    The Amazon SageMaker model endpoint input data blobs.

Returns:

See Also:



1650
1651
1652
1653
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1650

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.event_types #=> Array
resp.event_types[0].name #=> String
resp.event_types[0].description #=> String
resp.event_types[0].event_variables #=> Array
resp.event_types[0].event_variables[0] #=> String
resp.event_types[0].labels #=> Array
resp.event_types[0].labels[0] #=> String
resp.event_types[0].entity_types #=> Array
resp.event_types[0].entity_types[0] #=> String
resp.event_types[0].last_updated_time #=> String
resp.event_types[0].created_time #=> String
resp.event_types[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String)

    The name.

  • :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:



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

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

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].invoke_model_endpoint_role_arn #=> String
resp.external_models[0].input_configuration.event_type_name #=> String
resp.external_models[0].input_configuration.format #=> String, one of "TEXT_CSV", "APPLICATION_JSON"
resp.external_models[0].input_configuration.use_event_variables #=> 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.external_models[0].arn #=> 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:



1770
1771
1772
1773
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1770

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

#get_kms_encryption_key(params = {}) ⇒ Types::GetKMSEncryptionKeyResult

Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.

Examples:

Response structure


resp.kms_key.kms_encryption_key_arn #=> String

Parameters:

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

    ({})

Returns:

See Also:



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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String)

    The name of the label or labels to get.

  • :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:



1842
1843
1844
1845
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1842

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

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

Gets the details of the specified model version.

Examples:

Request syntax with placeholder values


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

Response structure


resp.model_id #=> String
resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS"
resp.model_version_number #=> String
resp.training_data_source #=> String, one of "EXTERNAL_EVENTS"
resp.training_data_schema.model_variables #=> Array
resp.training_data_schema.model_variables[0] #=> String
resp.training_data_schema.label_schema.label_mapper #=> Hash
resp.training_data_schema.label_schema.label_mapper["string"] #=> Array
resp.training_data_schema.label_schema.label_mapper["string"][0] #=> String
resp.external_events_detail.data_location #=> String
resp.external_events_detail.data_access_role_arn #=> String
resp.status #=> String
resp.arn #=> 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 number.

Returns:

See Also:



1897
1898
1899
1900
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1897

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

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

Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

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.

Examples:

Request syntax with placeholder values


resp = client.get_models({
  model_id: "modelIdentifier",
  model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS
  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].event_type_name #=> String
resp.models[0].created_time #=> String
resp.models[0].last_updated_time #=> String
resp.models[0].arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :model_id (String)

    The model ID.

  • :model_type (String)

    The model type.

  • :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:



1959
1960
1961
1962
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1959

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

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.outcomes[0].arn #=> 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:



2009
2010
2011
2012
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2009

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

Examples:

Request syntax with placeholder values


resp = client.get_rules({
  rule_id: "identifier",
  detector_id: "identifier", # required
  rule_version: "wholeNumberVersionString",
  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.rule_details[0].arn #=> 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:



2077
2078
2079
2080
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2077

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.variables[0].arn #=> 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:



2131
2132
2133
2134
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2131

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "fraudDetectorArn", # required
  next_token: "string",
  max_results: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :next_token (String)

    The next token from the previous results.

  • :max_results (Integer)

    The maximum number of objects to return for the request.

Returns:

See Also:



2176
2177
2178
2179
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2176

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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",
  event_type_name: "identifier", # required
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :detector_id (required, String)

    The detector ID.

  • :description (String)

    The description of the detector.

  • :event_type_name (required, String)

    The name of the event type.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2215
2216
2217
2218
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2215

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

Examples:

Request syntax with placeholder values


resp = client.put_entity_type({
  name: "identifier", # required
  description: "description",
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the entity type.

  • :description (String)

    The description.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2254
2255
2256
2257
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2254

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

Examples:

Request syntax with placeholder values


resp = client.put_event_type({
  name: "identifier", # required
  description: "description",
  event_variables: ["string"], # required
  labels: ["string"],
  entity_types: ["string"], # required
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name.

  • :description (String)

    The description of the event type.

  • :event_variables (required, Array<String>)

    The event type variables.

  • :labels (Array<String>)

    The event type labels.

  • :entity_types (required, Array<String>)

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

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2309
2310
2311
2312
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2309

def put_event_type(params = {}, options = {})
  req = build_request(:put_event_type, 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: "sageMakerEndpointIdentifier", # required
  model_source: "SAGEMAKER", # required, accepts SAGEMAKER
  invoke_model_endpoint_role_arn: "string", # required
  input_configuration: { # required
    event_type_name: "identifier",
    format: "TEXT_CSV", # accepts TEXT_CSV, APPLICATION_JSON
    use_event_variables: 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
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

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.

  • :invoke_model_endpoint_role_arn (required, String)

    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.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2376
2377
2378
2379
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2376

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

#put_kms_encryption_key(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.put_kms_encryption_key({
  kms_encryption_key_arn: "KmsEncryptionKeyArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :kms_encryption_key_arn (required, String)

    The KMS encryption key ARN.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2399
2400
2401
2402
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2399

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

Examples:

Request syntax with placeholder values


resp = client.put_label({
  name: "identifier", # required
  description: "description",
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The label name.

  • :description (String)

    The label description.

  • :tags (Array<Types::Tag>)

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2435
2436
2437
2438
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2435

def put_label(params = {}, options = {})
  req = build_request(:put_label, 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",
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the outcome.

  • :description (String)

    The outcome description.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2470
2471
2472
2473
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2470

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

#tag_resource(params = {}) ⇒ Struct

Assigns tags to a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "fraudDetectorArn", # required
  tags: [ # required
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The resource ARN.

  • :tags (required, Array<Types::Tag>)

    The tags to assign to the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2501
2502
2503
2504
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2501

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "fraudDetectorArn", # required
  tag_keys: ["tagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tag_keys (required, Array<String>)

    The resource ARN.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2527
2528
2529
2530
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2527

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, 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, rule execution mode, 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: "wholeNumberVersionString", # required
  external_model_endpoints: ["string"], # required
  rules: [ # required
    {
      detector_id: "identifier", # required
      rule_id: "identifier", # required
      rule_version: "wholeNumberVersionString", # required
    },
  ],
  description: "description",
  model_versions: [
    {
      model_id: "modelIdentifier", # required
      model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
      model_version_number: "nonEmptyString", # required
      arn: "fraudDetectorArn",
    },
  ],
  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:



2602
2603
2604
2605
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2602

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.({
  detector_id: "identifier", # required
  detector_version_id: "wholeNumberVersionString", # 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:



2633
2634
2635
2636
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2633

def (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: "wholeNumberVersionString", # 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:



2665
2666
2667
2668
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2665

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

#update_model(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

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 new model description.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2696
2697
2698
2699
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2696

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

Examples:

Request syntax with placeholder values


resp = client.update_model_version({
  model_id: "modelIdentifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  major_version_number: "wholeNumberVersionString", # required
  external_events_detail: {
    data_location: "s3BucketLocation", # required
    data_access_role_arn: "iamRoleArn", # required
  },
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

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.

  • :major_version_number (required, String)

    The major version number.

  • :external_events_detail (Types::ExternalEventsDetail)

    The event details.

  • :tags (Array<Types::Tag>)

    A collection of key and value pairs.

Returns:

See Also:



2759
2760
2761
2762
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2759

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

#update_model_version_status(params = {}) ⇒ Struct

Updates the status of a model version.

You can perform the following status updates:

  1. Change the TRAINING_COMPLETE status to ACTIVE.

  2. Change ACTIVEto INACTIVE.

Examples:

Request syntax with placeholder values


resp = client.update_model_version_status({
  model_id: "modelIdentifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
  model_version_number: "floatVersionString", # required
  status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, TRAINING_CANCELLED
})

Parameters:

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

    ({})

Options Hash (params):

  • :model_id (required, String)

    The model ID of the model version to update.

  • :model_type (required, String)

    The model type.

  • :model_version_number (required, String)

    The model version number.

  • :status (required, String)

    The model version status.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2799
2800
2801
2802
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2799

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

#update_rule_metadata(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.({
  rule: { # required
    detector_id: "identifier", # required
    rule_id: "identifier", # required
    rule_version: "wholeNumberVersionString", # 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:



2829
2830
2831
2832
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2829

def (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. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

Examples:

Request syntax with placeholder values


resp = client.update_rule_version({
  rule: { # required
    detector_id: "identifier", # required
    rule_id: "identifier", # required
    rule_version: "wholeNumberVersionString", # required
  },
  description: "description",
  expression: "ruleExpression", # required
  language: "DETECTORPL", # required, accepts DETECTORPL
  outcomes: ["string"], # required
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # 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.

  • :tags (Array<Types::Tag>)

    The tags to assign to the rule version.

Returns:

See Also:



2889
2890
2891
2892
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2889

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. For more information see Variable types.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2927
2928
2929
2930
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2927

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