You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::FraudDetector::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Fraud Detector. To construct a client, you need to configure a :region and :credentials.

frauddetector = Aws::FraudDetector::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::FraudDetector::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::FraudDetector::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

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

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

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

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

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

Creates a batch of variables.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

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

    The list of variables for the batch create variable request.

Returns:

See Also:

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

Gets a batch of variables.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :names (required, Array<String>)

    The list of variable names to get.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

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

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :model_id (required, String)

    The model ID.

  • :model_type (required, String)

    The model type.

  • :description (String)

    The model version description.

Returns:

See Also:

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

Creates a rule for use with the specified detector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :rule_id (required, String)

    The rule ID.

  • :detector_id (required, String)

    The detector ID for the rule\'s parent detector.

  • :description (String)

    The rule description.

  • :expression (required, String)

    The rule expression.

  • :language (required, String)

    The language of the rule.

  • :outcomes (required, Array<String>)

    The outcome or outcomes returned when the rule expression matches.

Returns:

See Also:

#create_variable(options = {}) ⇒ Struct

Creates a variable.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :name (required, String)

    The name of the variable.

  • :data_type (required, String)

    The data type.

  • :data_source (required, String)

    The source of the data.

  • :default_value (required, String)

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

  • :description (String)

    The description.

  • :variable_type (String)

    The variable type.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_detector_version(options = {}) ⇒ Struct

Deletes the detector version.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

#delete_event(options = {}) ⇒ Struct

Deletes the specified event.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :event_id (required, String)

    The ID of the event to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_detector(options = {}) ⇒ 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

Options Hash (options):

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

#describe_model_versions(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :model_id (String)

    The model ID.

  • :model_version_number (String)

    The model version.

  • :model_type (String)

    The model type.

  • :next_token (String)

    The next token from the previous results.

  • :max_results (Integer)

    The maximum number of results to return.

Returns:

See Also:

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

Gets a particular detector version.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :detector_id (required, String)

    The detector ID.

  • :detector_version_id (required, String)

    The detector version ID.

Returns:

See Also:

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

Gets all of detectors. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

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

#get_external_models(options = {}) ⇒ Types::GetExternalModelsResult

Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

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

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

Gets a model version.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :model_id (required, String)

    The model ID.

  • :model_type (required, String)

    The model type.

  • :model_version_number (required, String)

    The model version.

Returns:

See Also:

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :model_type (String)

    The model type.

  • :model_id (String)

    The model ID.

  • :next_token (String)

    The next token for the request.

  • :max_results (Integer)

    The maximum results to return for the request.

Returns:

See Also:

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

Gets one or more outcomes. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :detector_id (required, String)

    The detector ID.

  • :detector_version_id (String)

    The detector version ID.

  • :event_id (required, String)

    The unique ID used to identify the event.

  • :event_attributes (Hash<String,String>)

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

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

    The Amazon SageMaker model endpoint input data blobs.

Returns:

See Also:

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

Gets all rules available for the specified detector.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

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

#get_variables(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

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

#put_detector(options = {}) ⇒ Struct

Creates or updates a detector.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :detector_id (required, String)

    The detector ID.

  • :description (String)

    The description of the detector.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_external_model(options = {}) ⇒ Struct

Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :model_endpoint (required, String)

    The model endpoints name.

  • :model_source (required, String)

    The source of the model.

  • :role (required, Types::Role)

    The IAM role used to invoke the model endpoint.

  • :input_configuration (required, Types::ModelInputConfiguration)

    The model endpoint input configuration.

  • :output_configuration (required, Types::ModelOutputConfiguration)

    The model endpoint output configuration.

  • :model_endpoint_status (required, String)

    The model endpoint’s status in Amazon Fraud Detector.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_model(options = {}) ⇒ Struct

Creates or updates a model.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :model_id (required, String)

    The model ID.

  • :model_type (required, String)

    The model type.

  • :description (String)

    The model description.

  • :training_data_source (required, Types::TrainingDataSource)

    The training data source location in Amazon S3.

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

    The model input variables.

  • :label_schema (required, Types::LabelSchema)

    The label schema.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#put_outcome(options = {}) ⇒ Struct

Creates or updates an outcome.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :name (required, String)

    The name of the outcome.

  • :description (String)

    The outcome description.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_detector_version(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_detector_version_metadata(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

#update_detector_version_status(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :detector_id (required, String)

    The detector ID.

  • :detector_version_id (required, String)

    The detector version ID.

  • :status (required, String)

    The new status.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_model_version(options = {}) ⇒ Struct

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

  1. Change the TRAINING_COMPLETE status to ACTIVE

  2. Change ACTIVE back to TRAINING_COMPLETE

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :model_id (required, String)

    The model ID.

  • :model_type (required, String)

    The model type.

  • :model_version_number (required, String)

    The model version.

  • :description (required, String)

    The model description.

  • :status (required, String)

    The new model status.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_rule_metadata(options = {}) ⇒ Struct

Updates a rule's metadata.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :rule (required, Types::Rule)

    The rule to update.

  • :description (required, String)

    The rule description.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

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

Updates a rule version resulting in a new rule version.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (options):

  • :rule (required, Types::Rule)

    The rule to update.

  • :description (String)

    The description.

  • :expression (required, String)

    The rule expression.

  • :language (required, String)

    The language.

  • :outcomes (required, Array<String>)

    The outcomes.

Returns:

See Also:

#update_variable(options = {}) ⇒ 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",
})

Options Hash (options):

  • :name (required, String)

    The name of the variable.

  • :default_value (String)

    The new default value of the variable.

  • :description (String)

    The new description.

  • :variable_type (String)

    The variable type.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.