Class: Aws::CleanRoomsML::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb

Overview

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

client = Aws::CleanRoomsML::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 Aws::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. This can be an instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :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.

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

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

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

  • :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
  • :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 Aws::ClientStubs#stub_responses. See Aws::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)

    A Bearer Token Provider. This can be an 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::CleanRoomsML::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CleanRoomsML::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.



444
445
446
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 444

def initialize(*args)
  super
end

Instance Method Details

#create_audience_model(params = {}) ⇒ Types::CreateAudienceModelResponse

Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

Examples:

Request syntax with placeholder values


resp = client.create_audience_model({
  training_data_start_time: Time.now,
  training_data_end_time: Time.now,
  name: "NameString", # required
  training_dataset_arn: "TrainingDatasetArn", # required
  kms_key_arn: "KmsKeyArn",
  tags: {
    "TagKey" => "TagValue",
  },
  description: "ResourceDescription",
})

Response structure


resp.audience_model_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :training_data_start_time (Time, DateTime, Date, Integer, String)

    The start date and time of the training window.

  • :training_data_end_time (Time, DateTime, Date, Integer, String)

    The end date and time of the training window.

  • :name (required, String)

    The name of the audience model resource.

  • :training_dataset_arn (required, String)

    The Amazon Resource Name (ARN) of the training dataset for this audience model.

  • :kms_key_arn (String)

    The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.

  • :tags (Hash<String,String>)

    The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50.

    • For each resource, each tag key must be unique, and each tag key can have only one value.

    • Maximum key length - 128 Unicode characters in UTF-8.

    • Maximum value length - 256 Unicode characters in UTF-8.

    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    • Tag keys and values are case sensitive.

    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

  • :description (String)

    The description of the audience model.

Returns:

See Also:



535
536
537
538
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 535

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

#create_configured_audience_model(params = {}) ⇒ Types::CreateConfiguredAudienceModelResponse

Defines the information necessary to create a configured audience model.

Examples:

Request syntax with placeholder values


resp = client.create_configured_audience_model({
  name: "NameString", # required
  audience_model_arn: "AudienceModelArn", # required
  output_config: { # required
    destination: { # required
      s3_destination: { # required
        s3_uri: "S3Path", # required
      },
    },
    role_arn: "IamRoleArn", # required
  },
  description: "ResourceDescription",
  shared_audience_metrics: ["ALL"], # required, accepts ALL, NONE
  min_matching_seed_size: 1,
  audience_size_config: {
    audience_size_type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
    audience_size_bins: [1], # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
  child_resource_tag_on_create_policy: "FROM_PARENT_RESOURCE", # accepts FROM_PARENT_RESOURCE, NONE
})

Response structure


resp.configured_audience_model_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the configured audience model.

  • :audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

  • :output_config (required, Types::ConfiguredAudienceModelOutputConfig)

    Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.

  • :description (String)

    The description of the configured audience model.

  • :shared_audience_metrics (required, Array<String>)

    Whether audience metrics are shared.

  • :min_matching_seed_size (Integer)

    The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.

  • :audience_size_config (Types::AudienceSizeConfig)

    Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

  • :tags (Hash<String,String>)

    The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50.

    • For each resource, each tag key must be unique, and each tag key can have only one value.

    • Maximum key length - 128 Unicode characters in UTF-8.

    • Maximum value length - 256 Unicode characters in UTF-8.

    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    • Tag keys and values are case sensitive.

    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

  • :child_resource_tag_on_create_policy (String)

    Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

    When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.

Returns:

See Also:



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

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

#create_training_dataset(params = {}) ⇒ Types::CreateTrainingDatasetResponse

Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

Examples:

Request syntax with placeholder values


resp = client.create_training_dataset({
  name: "NameString", # required
  role_arn: "IamRoleArn", # required
  training_data: [ # required
    {
      type: "INTERACTIONS", # required, accepts INTERACTIONS
      input_config: { # required
        schema: [ # required
          {
            column_name: "ColumnName", # required
            column_types: ["USER_ID"], # required, accepts USER_ID, ITEM_ID, TIMESTAMP, CATEGORICAL_FEATURE, NUMERICAL_FEATURE
          },
        ],
        data_source: { # required
          glue_data_source: { # required
            table_name: "GlueTableName", # required
            database_name: "GlueDatabaseName", # required
            catalog_id: "AccountId",
          },
        },
      },
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  description: "ResourceDescription",
})

Response structure


resp.training_dataset_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the training dataset. This name must be unique in your account and region.

  • :role_arn (required, String)

    The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the dataSource field of each dataset.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an AccessDeniedException error.

  • :training_data (required, Array<Types::Dataset>)

    An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.

  • :tags (Hash<String,String>)

    The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50.

    • For each resource, each tag key must be unique, and each tag key can have only one value.

    • Maximum key length - 128 Unicode characters in UTF-8.

    • Maximum value length - 256 Unicode characters in UTF-8.

    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    • Tag keys and values are case sensitive.

    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

  • :description (String)

    The description of the training dataset.

Returns:

See Also:



764
765
766
767
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 764

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

#delete_audience_generation_job(params = {}) ⇒ Struct

Deletes the specified audience generation job, and removes all data associated with the job.

Examples:

Request syntax with placeholder values


resp = client.delete_audience_generation_job({
  audience_generation_job_arn: "AudienceGenerationJobArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :audience_generation_job_arn (required, String)

    The Amazon Resource Name (ARN) of the audience generation job that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



788
789
790
791
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 788

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

#delete_audience_model(params = {}) ⇒ Struct

Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.

Examples:

Request syntax with placeholder values


resp = client.delete_audience_model({
  audience_model_arn: "AudienceModelArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the audience model that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



813
814
815
816
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 813

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

#delete_configured_audience_model(params = {}) ⇒ Struct

Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

Examples:

Request syntax with placeholder values


resp = client.delete_configured_audience_model({
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the configured audience model that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



840
841
842
843
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 840

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

#delete_configured_audience_model_policy(params = {}) ⇒ Struct

Deletes the specified configured audience model policy.

Examples:

Request syntax with placeholder values


resp = client.delete_configured_audience_model_policy({
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



863
864
865
866
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 863

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

#delete_training_dataset(params = {}) ⇒ Struct

Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.

Examples:

Request syntax with placeholder values


resp = client.delete_training_dataset({
  training_dataset_arn: "TrainingDatasetArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :training_dataset_arn (required, String)

    The Amazon Resource Name (ARN) of the training dataset that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



890
891
892
893
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 890

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

#get_audience_generation_job(params = {}) ⇒ Types::GetAudienceGenerationJobResponse

Returns information about an audience generation job.

Examples:

Request syntax with placeholder values


resp = client.get_audience_generation_job({
  audience_generation_job_arn: "AudienceGenerationJobArn", # required
})

Response structure


resp.create_time #=> Time
resp.update_time #=> Time
resp.audience_generation_job_arn #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.status_details.status_code #=> String
resp.status_details.message #=> String
resp.configured_audience_model_arn #=> String
resp.seed_audience.data_source.s3_uri #=> String
resp.seed_audience.role_arn #=> String
resp.seed_audience.sql_parameters.query_string #=> String
resp.seed_audience.sql_parameters.analysis_template_arn #=> String
resp.seed_audience.sql_parameters.parameters #=> Hash
resp.seed_audience.sql_parameters.parameters["ParameterKey"] #=> String
resp.include_seed_in_output #=> Boolean
resp.collaboration_id #=> String
resp.metrics.relevance_metrics #=> Array
resp.metrics.relevance_metrics[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
resp.metrics.relevance_metrics[0].audience_size.value #=> Integer
resp.metrics.relevance_metrics[0].score #=> Float
resp.metrics.recall_metric #=> Float
resp.started_by #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.protected_query_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :audience_generation_job_arn (required, String)

    The Amazon Resource Name (ARN) of the audience generation job that you are interested in.

Returns:

See Also:



958
959
960
961
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 958

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

#get_audience_model(params = {}) ⇒ Types::GetAudienceModelResponse

Returns information about an audience model

Examples:

Request syntax with placeholder values


resp = client.get_audience_model({
  audience_model_arn: "AudienceModelArn", # required
})

Response structure


resp.create_time #=> Time
resp.update_time #=> Time
resp.training_data_start_time #=> Time
resp.training_data_end_time #=> Time
resp.audience_model_arn #=> String
resp.name #=> String
resp.training_dataset_arn #=> String
resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.status_details.status_code #=> String
resp.status_details.message #=> String
resp.kms_key_arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the audience model that you are interested in.

Returns:

See Also:



1011
1012
1013
1014
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1011

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

#get_configured_audience_model(params = {}) ⇒ Types::GetConfiguredAudienceModelResponse

Returns information about a specified configured audience model.

Examples:

Request syntax with placeholder values


resp = client.get_configured_audience_model({
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
})

Response structure


resp.create_time #=> Time
resp.update_time #=> Time
resp.configured_audience_model_arn #=> String
resp.name #=> String
resp.audience_model_arn #=> String
resp.output_config.destination.s3_destination.s3_uri #=> String
resp.output_config.role_arn #=> String
resp.description #=> String
resp.status #=> String, one of "ACTIVE"
resp.shared_audience_metrics #=> Array
resp.shared_audience_metrics[0] #=> String, one of "ALL", "NONE"
resp.min_matching_seed_size #=> Integer
resp.audience_size_config.audience_size_type #=> String, one of "ABSOLUTE", "PERCENTAGE"
resp.audience_size_config.audience_size_bins #=> Array
resp.audience_size_config.audience_size_bins[0] #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.child_resource_tag_on_create_policy #=> String, one of "FROM_PARENT_RESOURCE", "NONE"

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

Returns:

See Also:



1069
1070
1071
1072
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1069

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

#get_configured_audience_model_policy(params = {}) ⇒ Types::GetConfiguredAudienceModelPolicyResponse

Returns information about a configured audience model policy.

Examples:

Request syntax with placeholder values


resp = client.get_configured_audience_model_policy({
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
})

Response structure


resp.configured_audience_model_arn #=> String
resp.configured_audience_model_policy #=> String
resp.policy_hash #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the configured audience model that you are interested in.

Returns:

See Also:



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

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

#get_training_dataset(params = {}) ⇒ Types::GetTrainingDatasetResponse

Returns information about a training dataset.

Examples:

Request syntax with placeholder values


resp = client.get_training_dataset({
  training_dataset_arn: "TrainingDatasetArn", # required
})

Response structure


resp.create_time #=> Time
resp.update_time #=> Time
resp.training_dataset_arn #=> String
resp.name #=> String
resp.training_data #=> Array
resp.training_data[0].type #=> String, one of "INTERACTIONS"
resp.training_data[0].input_config.schema #=> Array
resp.training_data[0].input_config.schema[0].column_name #=> String
resp.training_data[0].input_config.schema[0].column_types #=> Array
resp.training_data[0].input_config.schema[0].column_types[0] #=> String, one of "USER_ID", "ITEM_ID", "TIMESTAMP", "CATEGORICAL_FEATURE", "NUMERICAL_FEATURE"
resp.training_data[0].input_config.data_source.glue_data_source.table_name #=> String
resp.training_data[0].input_config.data_source.glue_data_source.database_name #=> String
resp.training_data[0].input_config.data_source.glue_data_source.catalog_id #=> String
resp.status #=> String, one of "ACTIVE"
resp.role_arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :training_dataset_arn (required, String)

    The Amazon Resource Name (ARN) of the training dataset that you are interested in.

Returns:

See Also:



1156
1157
1158
1159
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1156

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

#list_audience_export_jobs(params = {}) ⇒ Types::ListAudienceExportJobsResponse

Returns a list of the audience export jobs.

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_audience_export_jobs({
  next_token: "NextToken",
  max_results: 1,
  audience_generation_job_arn: "AudienceGenerationJobArn",
})

Response structure


resp.next_token #=> String
resp.audience_export_jobs #=> Array
resp.audience_export_jobs[0].create_time #=> Time
resp.audience_export_jobs[0].update_time #=> Time
resp.audience_export_jobs[0].name #=> String
resp.audience_export_jobs[0].audience_generation_job_arn #=> String
resp.audience_export_jobs[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
resp.audience_export_jobs[0].audience_size.value #=> Integer
resp.audience_export_jobs[0].description #=> String
resp.audience_export_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE"
resp.audience_export_jobs[0].status_details.status_code #=> String
resp.audience_export_jobs[0].status_details.message #=> String
resp.audience_export_jobs[0].output_location #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer)

    The maximum size of the results that is returned per call.

  • :audience_generation_job_arn (String)

    The Amazon Resource Name (ARN) of the audience generation job that you are interested in.

Returns:

See Also:



1209
1210
1211
1212
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1209

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

#list_audience_generation_jobs(params = {}) ⇒ Types::ListAudienceGenerationJobsResponse

Returns a list of audience generation jobs.

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_audience_generation_jobs({
  next_token: "NextToken",
  max_results: 1,
  configured_audience_model_arn: "ConfiguredAudienceModelArn",
  collaboration_id: "UUID",
})

Response structure


resp.next_token #=> String
resp.audience_generation_jobs #=> Array
resp.audience_generation_jobs[0].create_time #=> Time
resp.audience_generation_jobs[0].update_time #=> Time
resp.audience_generation_jobs[0].audience_generation_job_arn #=> String
resp.audience_generation_jobs[0].name #=> String
resp.audience_generation_jobs[0].description #=> String
resp.audience_generation_jobs[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.audience_generation_jobs[0].configured_audience_model_arn #=> String
resp.audience_generation_jobs[0].collaboration_id #=> String
resp.audience_generation_jobs[0].started_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer)

    The maximum size of the results that is returned per call.

  • :configured_audience_model_arn (String)

    The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.

  • :collaboration_id (String)

    The identifier of the collaboration that contains the audience generation jobs that you are interested in.

Returns:

See Also:



1265
1266
1267
1268
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1265

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

#list_audience_models(params = {}) ⇒ Types::ListAudienceModelsResponse

Returns a list of audience models.

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_audience_models({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.audience_models #=> Array
resp.audience_models[0].create_time #=> Time
resp.audience_models[0].update_time #=> Time
resp.audience_models[0].audience_model_arn #=> String
resp.audience_models[0].name #=> String
resp.audience_models[0].training_dataset_arn #=> String
resp.audience_models[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
resp.audience_models[0].description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer)

    The maximum size of the results that is returned per call.

Returns:

See Also:



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

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

#list_configured_audience_models(params = {}) ⇒ Types::ListConfiguredAudienceModelsResponse

Returns a list of the configured audience models.

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_configured_audience_models({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.configured_audience_models #=> Array
resp.configured_audience_models[0].create_time #=> Time
resp.configured_audience_models[0].update_time #=> Time
resp.configured_audience_models[0].name #=> String
resp.configured_audience_models[0].audience_model_arn #=> String
resp.configured_audience_models[0].output_config.destination.s3_destination.s3_uri #=> String
resp.configured_audience_models[0].output_config.role_arn #=> String
resp.configured_audience_models[0].description #=> String
resp.configured_audience_models[0].configured_audience_model_arn #=> String
resp.configured_audience_models[0].status #=> String, one of "ACTIVE"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer)

    The maximum size of the results that is returned per call.

Returns:

See Also:



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

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags for a provided resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that you are interested in.

Returns:

See Also:



1385
1386
1387
1388
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1385

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

#list_training_datasets(params = {}) ⇒ Types::ListTrainingDatasetsResponse

Returns a list of training datasets.

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_training_datasets({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.training_datasets #=> Array
resp.training_datasets[0].create_time #=> Time
resp.training_datasets[0].update_time #=> Time
resp.training_datasets[0].training_dataset_arn #=> String
resp.training_datasets[0].name #=> String
resp.training_datasets[0].status #=> String, one of "ACTIVE"
resp.training_datasets[0].description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token value retrieved from a previous call to access the next page of results.

  • :max_results (Integer)

    The maximum size of the results that is returned per call.

Returns:

See Also:



1428
1429
1430
1431
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1428

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

#put_configured_audience_model_policy(params = {}) ⇒ Types::PutConfiguredAudienceModelPolicyResponse

Create or update the resource policy for a configured audience model.

Examples:

Request syntax with placeholder values


resp = client.put_configured_audience_model_policy({
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
  configured_audience_model_policy: "ResourcePolicy", # required
  previous_policy_hash: "Hash",
  policy_existence_condition: "POLICY_MUST_EXIST", # accepts POLICY_MUST_EXIST, POLICY_MUST_NOT_EXIST
})

Response structure


resp.configured_audience_model_policy #=> String
resp.policy_hash #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.

  • :configured_audience_model_policy (required, String)

    The IAM resource policy.

  • :previous_policy_hash (String)

    A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.

  • :policy_existence_condition (String)

    Use this to prevent unexpected concurrent modification of the policy.

Returns:

See Also:



1472
1473
1474
1475
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1472

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

#start_audience_export_job(params = {}) ⇒ Struct

Export an audience of a specified size after you have generated an audience.

Examples:

Request syntax with placeholder values


resp = client.start_audience_export_job({
  name: "NameString", # required
  audience_generation_job_arn: "AudienceGenerationJobArn", # required
  audience_size: { # required
    type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
    value: 1, # required
  },
  description: "ResourceDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the audience export job.

  • :audience_generation_job_arn (required, String)

    The Amazon Resource Name (ARN) of the audience generation job that you want to export.

  • :audience_size (required, Types::AudienceSize)

    The size of the generated audience. Must match one of the sizes in the configured audience model.

  • :description (String)

    The description of the audience export job.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1512
1513
1514
1515
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1512

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

#start_audience_generation_job(params = {}) ⇒ Types::StartAudienceGenerationJobResponse

Information necessary to start the audience generation job.

Examples:

Request syntax with placeholder values


resp = client.start_audience_generation_job({
  name: "NameString", # required
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
  seed_audience: { # required
    data_source: {
      s3_uri: "S3Path", # required
    },
    role_arn: "IamRoleArn", # required
    sql_parameters: {
      query_string: "ProtectedQuerySQLParametersQueryStringString",
      analysis_template_arn: "AnalysisTemplateArn",
      parameters: {
        "ParameterKey" => "ParameterValue",
      },
    },
  },
  include_seed_in_output: false,
  collaboration_id: "UUID",
  description: "ResourceDescription",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.audience_generation_job_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the audience generation job.

  • :configured_audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.

  • :seed_audience (required, Types::AudienceGenerationJobDataSource)

    The seed audience that is used to generate the audience.

  • :include_seed_in_output (Boolean)

    Whether the seed audience is included in the audience generation output.

  • :collaboration_id (String)

    The identifier of the collaboration that contains the audience generation job.

  • :description (String)

    The description of the audience generation job.

  • :tags (Hash<String,String>)

    The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50.

    • For each resource, each tag key must be unique, and each tag key can have only one value.

    • Maximum key length - 128 Unicode characters in UTF-8.

    • Maximum value length - 256 Unicode characters in UTF-8.

    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    • Tag keys and values are case sensitive.

    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

Returns:

See Also:



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

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

#tag_resource(params = {}) ⇒ Struct

Adds metadata tags to a specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that you want to assign tags.

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

    The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50.

    • For each resource, each tag key must be unique, and each tag key can have only one value.

    • Maximum key length - 128 Unicode characters in UTF-8.

    • Maximum value length - 256 Unicode characters in UTF-8.

    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    • Tag keys and values are case sensitive.

    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1668
1669
1670
1671
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1668

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

#untag_resource(params = {}) ⇒ Struct

Removes metadata tags from a specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

  • :tag_keys (required, Array<String>)

    The key values of tags that you want to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1695
1696
1697
1698
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1695

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

#update_configured_audience_model(params = {}) ⇒ Types::UpdateConfiguredAudienceModelResponse

Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

Examples:

Request syntax with placeholder values


resp = client.update_configured_audience_model({
  configured_audience_model_arn: "ConfiguredAudienceModelArn", # required
  output_config: {
    destination: { # required
      s3_destination: { # required
        s3_uri: "S3Path", # required
      },
    },
    role_arn: "IamRoleArn", # required
  },
  audience_model_arn: "AudienceModelArn",
  shared_audience_metrics: ["ALL"], # accepts ALL, NONE
  min_matching_seed_size: 1,
  audience_size_config: {
    audience_size_type: "ABSOLUTE", # required, accepts ABSOLUTE, PERCENTAGE
    audience_size_bins: [1], # required
  },
  description: "ResourceDescription",
})

Response structure


resp.configured_audience_model_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :configured_audience_model_arn (required, String)

    The Amazon Resource Name (ARN) of the configured audience model that you want to update.

  • :output_config (Types::ConfiguredAudienceModelOutputConfig)

    The new output configuration.

  • :audience_model_arn (String)

    The Amazon Resource Name (ARN) of the new audience model that you want to use.

  • :shared_audience_metrics (Array<String>)

    The new value for whether to share audience metrics.

  • :min_matching_seed_size (Integer)

    The minimum number of users from the seed audience that must match with users in the training data of the audience model.

  • :audience_size_config (Types::AudienceSizeConfig)

    The new audience size configuration.

  • :description (String)

    The new description of the configured audience model.

Returns:

See Also:



1762
1763
1764
1765
# File 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/client.rb', line 1762

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