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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

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

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::FraudDetector::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::FraudDetector::EndpointParameters.

  • :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_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_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. 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.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



480
481
482
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 480

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:



530
531
532
533
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 530

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", "DATETIME"
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:



572
573
574
575
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 572

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

#cancel_batch_import_job(params = {}) ⇒ Struct

Cancels an in-progress batch import job.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of an in-progress batch import job to cancel.

    Amazon Fraud Detector will throw an error if the batch import job is in FAILED, CANCELED, or COMPLETED state.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



597
598
599
600
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 597

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



619
620
621
622
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 619

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

#create_batch_import_job(params = {}) ⇒ Struct

Creates a batch import job.

Examples:

Request syntax with placeholder values


resp = client.create_batch_import_job({
  job_id: "identifier", # required
  input_path: "s3BucketLocation", # required
  output_path: "s3BucketLocation", # required
  event_type_name: "identifier", # required
  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 import job. The ID cannot be of a past job, unless the job exists in CREATE_FAILED state.

  • :input_path (required, String) —

    The URI that points to the Amazon S3 location of your data file.

  • :output_path (required, String) —

    The URI that points to the Amazon S3 location for storing your results.

  • :event_type_name (required, String) —

    The name of the event type.

  • :iam_role_arn (required, String) —

    The ARN of the IAM role created for Amazon S3 bucket that holds your data file.

    The IAM role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.

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

    A collection of key-value pairs associated with this request.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



678
679
680
681
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 678

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

    The IAM Role must have read permissions to your input S3 bucket and write permissions to your output S3 bucket. For more information about bucket permissions, see User policy examples in the Amazon S3 User Guide.

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

    A collection of key and value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



742
743
744
745
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 742

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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_INSIGHTS
      model_version_number: "floatVersionString", # 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:



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

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

#create_list(params = {}) ⇒ Struct

Creates a list.

List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.

Examples:

Request syntax with placeholder values


resp = client.create_list({
  name: "noDashIdentifier", # required
  elements: ["Elements"],
  variable_type: "variableType",
  description: "description",
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the list.

  • :elements (Array<String>) —

    The names of the elements, if providing. You can also create an empty list and add elements later using the UpdateList API.

  • :variable_type (String) —

    The variable type of the list. You can only assign the variable type with String data type. For more information, see Variable types.

  • :description (String) —

    The description of the list.

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

    A collection of the key and value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



893
894
895
896
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 893

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



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

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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_INSIGHTS
  training_data_source: "EXTERNAL_EVENTS", # required, accepts EXTERNAL_EVENTS, INGESTED_EVENTS
  training_data_schema: { # required
    model_variables: ["string"], # required
    label_schema: {
      label_mapper: {
        "string" => ["string"],
      },
      unlabeled_events_treatment: "IGNORE", # accepts IGNORE, FRAUD, LEGIT, AUTO
    },
  },
  external_events_detail: {
    data_location: "s3BucketLocation", # required
    data_access_role_arn: "iamRoleArn", # required
  },
  ingested_events_detail: {
    ingested_events_time_window: { # required
      start_time: "time", # required
      end_time: "time", # required
    },
  },
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Response structure


resp.model_id #=> String
resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS", "ACCOUNT_TAKEOVER_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 of the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.

  • :ingested_events_detail (Types::IngestedEventsDetail) —

    Details of the ingested events data used for model version training. Required if trainingDataSource is INGESTED_EVENTS.

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

    A collection of key and value pairs.

Returns:

See Also:



1018
1019
1020
1021
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1018

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:



1077
1078
1079
1080
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1077

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, DATETIME
  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 of the variable.

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



1141
1142
1143
1144
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1141

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

#delete_batch_import_job(params = {}) ⇒ Struct

Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the batch import job to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1164
1165
1166
1167
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1164

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



1186
1187
1188
1189
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1186

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:



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

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:



1245
1246
1247
1248
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1245

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:



1273
1274
1275
1276
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1273

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. If deleteAuditHistory is True, event data is available through search for up to 30 seconds after the delete operation is completed.

Examples:

Request syntax with placeholder values


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

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.

  • :delete_audit_history (Boolean) —

    Specifies whether or not to delete any predictions associated with the event. If set to True,

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1310
1311
1312
1313
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1310

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 event type, Amazon Fraud Detector permanently deletes that event 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:



1338
1339
1340
1341
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1338

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

#delete_events_by_event_type(params = {}) ⇒ Types::DeleteEventsByEventTypeResult

Deletes all events of a particular event type.

Examples:

Request syntax with placeholder values


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

Response structure


resp.event_type_name #=> String
resp.events_deletion_status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_type_name (required, String) —

    The name of the event type.

Returns:

See Also:



1368
1369
1370
1371
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1368

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



1394
1395
1396
1397
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1394

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:



1425
1426
1427
1428
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1425

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

#delete_list(params = {}) ⇒ Struct

Deletes the list, provided it is not used in a rule.

When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.

Examples:

Request syntax with placeholder values


resp = client.delete_list({
  name: "noDashIdentifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the list to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1450
1451
1452
1453
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1450

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



1482
1483
1484
1485
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1482

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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_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:



1519
1520
1521
1522
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1519

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:



1547
1548
1549
1550
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1547

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:



1577
1578
1579
1580
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1577

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:



1610
1611
1612
1613
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1610

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:



1656
1657
1658
1659
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1656

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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_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", "TRANSACTION_FRAUD_INSIGHTS", "ACCOUNT_TAKEOVER_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", "INGESTED_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].training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT", "AUTO"
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].ingested_events_detail.ingested_events_time_window.start_time #=> String
resp.model_version_details[0].ingested_events_detail.ingested_events_time_window.end_time #=> 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].training_result.variable_importance_metrics.log_odds_metrics #=> Array
resp.model_version_details[0].training_result.variable_importance_metrics.log_odds_metrics[0].variable_name #=> String
resp.model_version_details[0].training_result.variable_importance_metrics.log_odds_metrics[0].variable_type #=> String
resp.model_version_details[0].training_result.variable_importance_metrics.log_odds_metrics[0].variable_importance #=> 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.model_version_details[0].training_result_v2.data_validation_metrics.file_level_messages #=> Array
resp.model_version_details[0].training_result_v2.data_validation_metrics.file_level_messages[0].title #=> String
resp.model_version_details[0].training_result_v2.data_validation_metrics.file_level_messages[0].content #=> String
resp.model_version_details[0].training_result_v2.data_validation_metrics.file_level_messages[0].type #=> String
resp.model_version_details[0].training_result_v2.data_validation_metrics.field_level_messages #=> Array
resp.model_version_details[0].training_result_v2.data_validation_metrics.field_level_messages[0].field_name #=> String
resp.model_version_details[0].training_result_v2.data_validation_metrics.field_level_messages[0].identifier #=> String
resp.model_version_details[0].training_result_v2.data_validation_metrics.field_level_messages[0].title #=> String
resp.model_version_details[0].training_result_v2.data_validation_metrics.field_level_messages[0].content #=> String
resp.model_version_details[0].training_result_v2.data_validation_metrics.field_level_messages[0].type #=> String
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.metric_data_points #=> Array
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.metric_data_points[0].fpr #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.metric_data_points[0].precision #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.metric_data_points[0].tpr #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.metric_data_points[0].threshold #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.model_performance.auc #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.model_performance.uncertainty_range.lower_bound_value #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ofi.model_performance.uncertainty_range.upper_bound_value #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.metric_data_points #=> Array
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.metric_data_points[0].fpr #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.metric_data_points[0].precision #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.metric_data_points[0].tpr #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.metric_data_points[0].threshold #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.model_performance.auc #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.model_performance.uncertainty_range.lower_bound_value #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.tfi.model_performance.uncertainty_range.upper_bound_value #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ati.metric_data_points #=> Array
resp.model_version_details[0].training_result_v2.training_metrics_v2.ati.metric_data_points[0].cr #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ati.metric_data_points[0].adr #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ati.metric_data_points[0].threshold #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ati.metric_data_points[0].atodr #=> Float
resp.model_version_details[0].training_result_v2.training_metrics_v2.ati.model_performance.asi #=> Float
resp.model_version_details[0].training_result_v2.variable_importance_metrics.log_odds_metrics #=> Array
resp.model_version_details[0].training_result_v2.variable_importance_metrics.log_odds_metrics[0].variable_name #=> String
resp.model_version_details[0].training_result_v2.variable_importance_metrics.log_odds_metrics[0].variable_type #=> String
resp.model_version_details[0].training_result_v2.variable_importance_metrics.log_odds_metrics[0].variable_importance #=> Float
resp.model_version_details[0].training_result_v2.aggregated_variables_importance_metrics.log_odds_metrics #=> Array
resp.model_version_details[0].training_result_v2.aggregated_variables_importance_metrics.log_odds_metrics[0].variable_names #=> Array
resp.model_version_details[0].training_result_v2.aggregated_variables_importance_metrics.log_odds_metrics[0].variable_names[0] #=> String
resp.model_version_details[0].training_result_v2.aggregated_variables_importance_metrics.log_odds_metrics[0].aggregated_variables_importance #=> Float
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:



1784
1785
1786
1787
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1784

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

#get_batch_import_jobs(params = {}) ⇒ Types::GetBatchImportJobsResult

Gets all batch import jobs or a specific job of the specified ID. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 1 and 50. To get the next page results, provide the pagination token from the GetBatchImportJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (String) —

    The ID of the batch import job to get.

  • :max_results (Integer) —

    The maximum number of objects to return for request.

  • :next_token (String) —

    The next token from the previous request.

Returns:

See Also:



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

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



1904
1905
1906
1907
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1904

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

#get_delete_events_by_event_type_status(params = {}) ⇒ Types::GetDeleteEventsByEventTypeStatusResult

Retrieves the status of a DeleteEventsByEventType action.

Examples:

Request syntax with placeholder values


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

Response structure


resp.event_type_name #=> String
resp.events_deletion_status #=> String, one of "IN_PROGRESS_INITIALIZING", "IN_PROGRESS", "CANCEL_IN_PROGRESS", "CANCELED", "COMPLETE", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :event_type_name (required, String) —

    Name of event type for which to get the deletion status.

Returns:

See Also:



1934
1935
1936
1937
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1934

def get_delete_events_by_event_type_status(params = {}, options = {})
  req = build_request(:get_delete_events_by_event_type_status, 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", "TRANSACTION_FRAUD_INSIGHTS", "ACCOUNT_TAKEOVER_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:



1994
1995
1996
1997
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 1994

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:



2046
2047
2048
2049
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2046

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:



2097
2098
2099
2100
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2097

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

#get_event(params = {}) ⇒ Types::GetEventResult

Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.

Examples:

Request syntax with placeholder values


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

Response structure


resp.event.event_id #=> String
resp.event.event_type_name #=> String
resp.event.event_timestamp #=> String
resp.event.event_variables #=> Hash
resp.event.event_variables["attributeKey"] #=> String
resp.event.current_label #=> String
resp.event.label_timestamp #=> String
resp.event.entities #=> Array
resp.event.entities[0].entity_type #=> String
resp.event.entities[0].entity_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The ID of the event to retrieve.

  • :event_type_name (required, String) —

    The event type of the event to retrieve.

Returns:

See Also:



2139
2140
2141
2142
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2139

def get_event(params = {}, options = {})
  req = build_request(:get_event, 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: "entityRestrictedString", # required
    },
  ],
  event_timestamp: "utcTimestampISO8601", # required
  event_variables: { # required
    "variableName" => "variableValue",
  },
  external_model_endpoint_data_blobs: {
    "sageMakerEndpointIdentifier" => {
      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", "TRANSACTION_FRAUD_INSIGHTS", "ACCOUNT_TAKEOVER_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
resp.external_model_outputs #=> Array
resp.external_model_outputs[0].external_model.model_endpoint #=> String
resp.external_model_outputs[0].external_model.model_source #=> String, one of "SAGEMAKER"
resp.external_model_outputs[0].outputs #=> Hash
resp.external_model_outputs[0].outputs["string"] #=> 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. The timestamp must be specified using ISO 8601 standard in UTC.

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

    You must provide at least one eventVariable

    To ensure most accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows:

    For Amazon Fraud Detector trained models:

    If a null value is provided explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable (no variable name in the eventVariables map) with calculated default mean/medians for numeric variables and with special values for categorical variables.

    For imported SageMaker models:

    If a null value is provided explicitly for a variable, the model and rules will use “null” as the value. If a variable is not provided (no variable name in the eventVariables map), model and rules will use the default value that is provided for the variable.

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

    The Amazon SageMaker model endpoint input data blobs.

Returns:

See Also:



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

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

#get_event_prediction_metadata(params = {}) ⇒ Types::GetEventPredictionMetadataResult

Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.

Examples:

Request syntax with placeholder values


resp = client.get_event_prediction_metadata({
  event_id: "identifier", # required
  event_type_name: "identifier", # required
  detector_id: "identifier", # required
  detector_version_id: "wholeNumberVersionString", # required
  prediction_timestamp: "time", # required
})

Response structure


resp.event_id #=> String
resp.event_type_name #=> String
resp.entity_id #=> String
resp.entity_type #=> String
resp.event_timestamp #=> String
resp.detector_id #=> String
resp.detector_version_id #=> String
resp.detector_version_status #=> String
resp.event_variables #=> Array
resp.event_variables[0].name #=> String
resp.event_variables[0].value #=> String
resp.event_variables[0].source #=> String
resp.rules #=> Array
resp.rules[0].rule_id #=> String
resp.rules[0].rule_version #=> String
resp.rules[0].expression #=> String
resp.rules[0].expression_with_values #=> String
resp.rules[0].outcomes #=> Array
resp.rules[0].outcomes[0] #=> String
resp.rules[0].evaluated #=> Boolean
resp.rules[0].matched #=> Boolean
resp.rule_execution_mode #=> String, one of "ALL_MATCHED", "FIRST_MATCHED"
resp.outcomes #=> Array
resp.outcomes[0] #=> String
resp.evaluated_model_versions #=> Array
resp.evaluated_model_versions[0].model_id #=> String
resp.evaluated_model_versions[0].model_version #=> String
resp.evaluated_model_versions[0].model_type #=> String
resp.evaluated_model_versions[0].evaluations #=> Array
resp.evaluated_model_versions[0].evaluations[0].output_variable_name #=> String
resp.evaluated_model_versions[0].evaluations[0].evaluation_score #=> String
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations #=> Array
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations[0].event_variable_name #=> String
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations[0].relative_impact #=> String
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.variable_impact_explanations[0].log_odds_impact #=> Float
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.aggregated_variables_impact_explanations #=> Array
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.aggregated_variables_impact_explanations[0].event_variable_names #=> Array
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.aggregated_variables_impact_explanations[0].event_variable_names[0] #=> String
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.aggregated_variables_impact_explanations[0].relative_impact #=> String
resp.evaluated_model_versions[0].evaluations[0].prediction_explanations.aggregated_variables_impact_explanations[0].log_odds_impact #=> Float
resp.evaluated_external_models #=> Array
resp.evaluated_external_models[0].model_endpoint #=> String
resp.evaluated_external_models[0].use_event_variables #=> Boolean
resp.evaluated_external_models[0].input_variables #=> Hash
resp.evaluated_external_models[0].input_variables["string"] #=> String
resp.evaluated_external_models[0].output_variables #=> Hash
resp.evaluated_external_models[0].output_variables["string"] #=> String
resp.prediction_timestamp #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The event ID.

  • :event_type_name (required, String) —

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

  • :detector_id (required, String) —

    The detector ID.

  • :detector_version_id (required, String) —

    The detector version ID.

  • :prediction_timestamp (required, String) —

    The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.

    We recommend calling ListEventPredictions first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.

Returns:

See Also:



2369
2370
2371
2372
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2369

def get_event_prediction_metadata(params = {}, options = {})
  req = build_request(:get_event_prediction_metadata, 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].event_ingestion #=> String, one of "ENABLED", "DISABLED"
resp.event_types[0].ingested_event_statistics.number_of_events #=> Integer
resp.event_types[0].ingested_event_statistics.event_data_size_in_bytes #=> Integer
resp.event_types[0].ingested_event_statistics.least_recent_event #=> String
resp.event_types[0].ingested_event_statistics.most_recent_event #=> String
resp.event_types[0].ingested_event_statistics.last_updated_time #=> String
resp.event_types[0].last_updated_time #=> String
resp.event_types[0].created_time #=> String
resp.event_types[0].arn #=> String
resp.event_types[0].event_orchestration.event_bridge_enabled #=> Boolean
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:



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

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:



2496
2497
2498
2499
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2496

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 KMS key 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:



2516
2517
2518
2519
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2516

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:



2567
2568
2569
2570
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2567

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

#get_list_elements(params = {}) ⇒ Types::GetListElementsResult

Gets all the elements in the specified list.

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

Examples:

Request syntax with placeholder values


resp = client.get_list_elements({
  name: "noDashIdentifier", # required
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.elements #=> Array
resp.elements[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the list.

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



2608
2609
2610
2611
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2608

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

#get_lists_metadata(params = {}) ⇒ Types::GetListsMetadataResult

Gets the metadata of either all the lists under the account or the specified list.

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

Examples:

Request syntax with placeholder values


resp = client.get_lists_metadata({
  name: "noDashIdentifier",
  next_token: "nextToken",
  max_results: 1,
})

Response structure


resp.lists #=> Array
resp.lists[0].name #=> String
resp.lists[0].description #=> String
resp.lists[0].variable_type #=> String
resp.lists[0].created_time #=> String
resp.lists[0].updated_time #=> String
resp.lists[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name of the list.

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



2655
2656
2657
2658
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2655

def get_lists_metadata(params = {}, options = {})
  req = build_request(:get_lists_metadata, 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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_INSIGHTS
  model_version_number: "floatVersionString", # required
})

Response structure


resp.model_id #=> String
resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS", "ACCOUNT_TAKEOVER_INSIGHTS"
resp.model_version_number #=> String
resp.training_data_source #=> String, one of "EXTERNAL_EVENTS", "INGESTED_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.training_data_schema.label_schema.unlabeled_events_treatment #=> String, one of "IGNORE", "FRAUD", "LEGIT", "AUTO"
resp.external_events_detail.data_location #=> String
resp.external_events_detail.data_access_role_arn #=> String
resp.ingested_events_detail.ingested_events_time_window.start_time #=> String
resp.ingested_events_detail.ingested_events_time_window.end_time #=> 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:



2714
2715
2716
2717
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2714

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 Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

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

Examples:

Request syntax with placeholder values


resp = client.get_models({
  model_id: "modelIdentifier",
  model_type: "ONLINE_FRAUD_INSIGHTS", # accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_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", "TRANSACTION_FRAUD_INSIGHTS", "ACCOUNT_TAKEOVER_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:



2776
2777
2778
2779
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2776

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:



2826
2827
2828
2829
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2826

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:



2894
2895
2896
2897
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2894

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", "DATETIME"
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:



2948
2949
2950
2951
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 2948

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

#list_event_predictions(params = {}) ⇒ Types::ListEventPredictionsResult

Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned.

For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” }

This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning.

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

Examples:

Request syntax with placeholder values


resp = client.list_event_predictions({
  event_id: {
    value: "filterString",
  },
  event_type: {
    value: "filterString",
  },
  detector_id: {
    value: "filterString",
  },
  detector_version_id: {
    value: "filterString",
  },
  prediction_time_range: {
    start_time: "time", # required
    end_time: "time", # required
  },
  next_token: "string",
  max_results: 1,
})

Response structure


resp.event_prediction_summaries #=> Array
resp.event_prediction_summaries[0].event_id #=> String
resp.event_prediction_summaries[0].event_type_name #=> String
resp.event_prediction_summaries[0].event_timestamp #=> String
resp.event_prediction_summaries[0].prediction_timestamp #=> String
resp.event_prediction_summaries[0].detector_id #=> String
resp.event_prediction_summaries[0].detector_version_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (Types::FilterCondition) —

    The event ID.

  • :event_type (Types::FilterCondition) —

    The event type associated with the detector.

  • :detector_id (Types::FilterCondition) —

    The detector ID.

  • :detector_version_id (Types::FilterCondition) —

    The detector version ID.

  • :prediction_time_range (Types::PredictionTimeRange) —

    The time period for when the predictions were generated.

  • :next_token (String) —

    Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

  • :max_results (Integer) —

    The maximum number of predictions to return for the request.

Returns:

See Also:



3036
3037
3038
3039
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3036

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



3081
3082
3083
3084
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3081

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:



3120
3121
3122
3123
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3120

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:



3159
3160
3161
3162
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3159

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
  event_ingestion: "ENABLED", # accepts ENABLED, DISABLED
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
  event_orchestration: {
    event_bridge_enabled: false, # 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.

  • :event_ingestion (String) —

    Specifies if ingestion is enabled or disabled.

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

    A collection of key and value pairs.

  • :event_orchestration (Types::EventOrchestration) —

    Enables or disables event orchestration. If enabled, you can send event predictions to select AWS services for downstream processing of the events.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3226
3227
3228
3229
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3226

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: "modelInputTemplate",
    csv_input_template: "modelInputTemplate",
  },
  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:



3293
3294
3295
3296
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3293

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

    The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3319
3320
3321
3322
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3319

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>) —

    A collection of key and value pairs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3356
3357
3358
3359
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3356

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:



3391
3392
3393
3394
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3391

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

#send_event(params = {}) ⇒ Struct

Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.

Examples:

Request syntax with placeholder values


resp = client.send_event({
  event_id: "identifier", # required
  event_type_name: "identifier", # required
  event_timestamp: "utcTimestampISO8601", # required
  event_variables: { # required
    "variableName" => "variableValue",
  },
  assigned_label: "identifier",
  label_timestamp: "utcTimestampISO8601",
  entities: [ # required
    {
      entity_type: "string", # required
      entity_id: "entityRestrictedString", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The event ID to upload.

  • :event_type_name (required, String) —

    The event type name of the event.

  • :event_timestamp (required, String) —

    The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

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

  • :assigned_label (String) —

    The label to associate with the event. Required if specifying labelTimestamp.

  • :label_timestamp (String) —

    The timestamp associated with the label. Required if specifying assignedLabel.

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

    An array of entities.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3452
3453
3454
3455
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3452

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



3483
3484
3485
3486
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3483

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:



3509
3510
3511
3512
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3509

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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_INSIGHTS
      model_version_number: "floatVersionString", # 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:



3584
3585
3586
3587
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3584

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

#update_detector_version_metadata(params = {}) ⇒ Struct

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).

Examples:

Request syntax with placeholder values


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



3615
3616
3617
3618
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3615

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

#update_detector_version_status(params = {}) ⇒ Struct

Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.

Examples:

Request syntax with placeholder values


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

    The only supported values are ACTIVE and INACTIVE

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3649
3650
3651
3652
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3649

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

#update_event_label(params = {}) ⇒ Struct

Updates the specified event with a new label.

Examples:

Request syntax with placeholder values


resp = client.update_event_label({
  event_id: "identifier", # required
  event_type_name: "identifier", # required
  assigned_label: "identifier", # required
  label_timestamp: "utcTimestampISO8601", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :event_id (required, String) —

    The ID of the event associated with the label to update.

  • :event_type_name (required, String) —

    The event type of the event associated with the label to update.

  • :assigned_label (required, String) —

    The new label to assign to the event.

  • :label_timestamp (required, String) —

    The timestamp associated with the label. The timestamp must be specified using ISO 8601 standard in UTC.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3684
3685
3686
3687
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3684

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

#update_list(params = {}) ⇒ Struct

Updates a list.

Examples:

Request syntax with placeholder values


resp = client.update_list({
  name: "noDashIdentifier", # required
  elements: ["Elements"],
  description: "description",
  update_mode: "REPLACE", # accepts REPLACE, APPEND, REMOVE
  variable_type: "variableType",
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the list to update.

  • :elements (Array<String>) —

    One or more list elements to add or replace. If you are providing the elements, make sure to specify the updateMode to use.

    If you are deleting all elements from the list, use REPLACE for the updateMode and provide an empty list (0 elements).

  • :description (String) —

    The new description.

  • :update_mode (String) —

    The update mode (type).

    • Use APPEND if you are adding elements to the list.

    • Use REPLACE if you replacing existing elements in the list.

    • Use REMOVE if you are removing elements from the list.

  • :variable_type (String) —

    The variable type you want to assign to the list.

    You cannot update a variable type of a list that already has a variable type assigned to it. You can assign a variable type to a list only if the list does not already have a variable type.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3738
3739
3740
3741
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3738

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

#update_model(params = {}) ⇒ Struct

Updates model description.

Examples:

Request syntax with placeholder values


resp = client.update_model({
  model_id: "modelIdentifier", # required
  model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_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:



3768
3769
3770
3771
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3768

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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_INSIGHTS
  major_version_number: "wholeNumberVersionString", # required
  external_events_detail: {
    data_location: "s3BucketLocation", # required
    data_access_role_arn: "iamRoleArn", # required
  },
  ingested_events_detail: {
    ingested_events_time_window: { # required
      start_time: "time", # required
      end_time: "time", # required
    },
  },
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
})

Response structure


resp.model_id #=> String
resp.model_type #=> String, one of "ONLINE_FRAUD_INSIGHTS", "TRANSACTION_FRAUD_INSIGHTS", "ACCOUNT_TAKEOVER_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 details of the external events data used for training the model version. Required if trainingDataSource is EXTERNAL_EVENTS.

  • :ingested_events_detail (Types::IngestedEventsDetail) —

    The details of the ingested event used for training the model version. Required if your trainingDataSource is INGESTED_EVENTS.

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

    A collection of key and value pairs.

Returns:

See Also:



3842
3843
3844
3845
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3842

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_IN_PROGRESS status to TRAINING_CANCELLED.

  2. Change the TRAINING_COMPLETE status to ACTIVE.

  3. Change ACTIVE to 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, TRANSACTION_FRAUD_INSIGHTS, ACCOUNT_TAKEOVER_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:



3884
3885
3886
3887
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3884

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.update_rule_metadata({
  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:



3914
3915
3916
3917
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3914

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

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

Updates a rule version resulting in a new rule version. 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:



3974
3975
3976
3977
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 3974

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:



4012
4013
4014
4015
 
# File 'gems/aws-sdk-frauddetector/lib/aws-sdk-frauddetector/client.rb', line 4012

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