aws-sdk-cleanroomsml 1.2.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cleanroomsml/client.rb +85 -65
- data/lib/aws-sdk-cleanroomsml/client_api.rb +1 -12
- data/lib/aws-sdk-cleanroomsml/types.rb +38 -46
- data/lib/aws-sdk-cleanroomsml.rb +1 -1
- data/sig/client.rbs +0 -1
- data/sig/types.rbs +1 -8
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1c72e8be393892ebb2bd2d89a39634932ba0028ddefe9b77efdac57ebcabc12f
|
4
|
+
data.tar.gz: 695f6134b89b87aaeb2dbdb7ec9f2bcdb7b7a32dcd8cfd56401bfcf72be78ffd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f46f979610294ca9348aed78219051ac52c6776ad82457768d577f1b1447da536f7d54947f2584c23e5bf5e911d86b467badccc5b16290ecca29e5eff43bee53
|
7
|
+
data.tar.gz: ee9bafdb0acc00a37543769bc9ca8d363ec4e91eef43d050aa9782c159e8010f6ec1425771af2e07dbc8a7508b7508938fc96ad4efe80d7a1914428527609035
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.4.0 (2024-04-25)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.3.0 (2024-04-03)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - The release includes a public SDK for AWS Clean Rooms ML APIs, making them globally available to developers worldwide.
|
13
|
+
|
4
14
|
1.2.0 (2024-01-26)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.4.0
|
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
|
22
22
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
23
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
24
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id.rb'
|
25
26
|
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
27
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
28
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
@@ -72,6 +73,7 @@ module Aws::CleanRoomsML
|
|
72
73
|
add_plugin(Aws::Plugins::ResponsePaging)
|
73
74
|
add_plugin(Aws::Plugins::StubResponses)
|
74
75
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
76
|
+
add_plugin(Aws::Plugins::InvocationId)
|
75
77
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
76
78
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
77
79
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
@@ -196,10 +198,17 @@ module Aws::CleanRoomsML
|
|
196
198
|
# When set to 'true' the request body will not be compressed
|
197
199
|
# for supported operations.
|
198
200
|
#
|
199
|
-
# @option options [String] :endpoint
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
201
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
202
|
+
# Normally you should not configure the `:endpoint` option
|
203
|
+
# directly. This is normally constructed from the `:region`
|
204
|
+
# option. Configuring `:endpoint` is normally reserved for
|
205
|
+
# connecting to test or custom endpoints. The endpoint should
|
206
|
+
# be a URI formatted like:
|
207
|
+
#
|
208
|
+
# 'http://example.com'
|
209
|
+
# 'https://example.com'
|
210
|
+
# 'http://example.com:123'
|
211
|
+
#
|
203
212
|
#
|
204
213
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
214
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -337,50 +346,65 @@ module Aws::CleanRoomsML
|
|
337
346
|
# @option options [Aws::CleanRoomsML::EndpointProvider] :endpoint_provider
|
338
347
|
# 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`
|
339
348
|
#
|
340
|
-
# @option options [
|
341
|
-
#
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
# @option options [Float] :
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
349
|
+
# @option options [Float] :http_continue_timeout (1)
|
350
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
351
|
+
# request body. This option has no effect unless the request has "Expect"
|
352
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
353
|
+
# behaviour. This value can safely be set per request on the session.
|
354
|
+
#
|
355
|
+
# @option options [Float] :http_idle_timeout (5)
|
356
|
+
# The number of seconds a connection is allowed to sit idle before it
|
357
|
+
# is considered stale. Stale connections are closed and removed from the
|
358
|
+
# pool before making a request.
|
359
|
+
#
|
360
|
+
# @option options [Float] :http_open_timeout (15)
|
361
|
+
# The default number of seconds to wait for response data.
|
362
|
+
# This value can safely be set per-request on the session.
|
363
|
+
#
|
364
|
+
# @option options [URI::HTTP,String] :http_proxy
|
365
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
366
|
+
#
|
367
|
+
# @option options [Float] :http_read_timeout (60)
|
368
|
+
# The default number of seconds to wait for response data.
|
369
|
+
# This value can safely be set per-request on the session.
|
370
|
+
#
|
371
|
+
# @option options [Boolean] :http_wire_trace (false)
|
372
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
373
|
+
#
|
374
|
+
# @option options [Proc] :on_chunk_received
|
375
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
376
|
+
# of the response body is received. It provides three arguments: the chunk,
|
377
|
+
# the number of bytes received, and the total number of
|
378
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
379
|
+
#
|
380
|
+
# @option options [Proc] :on_chunk_sent
|
381
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
382
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
383
|
+
# the number of bytes read from the body, and the total number of
|
384
|
+
# bytes in the body.
|
385
|
+
#
|
386
|
+
# @option options [Boolean] :raise_response_errors (true)
|
387
|
+
# When `true`, response errors are raised.
|
388
|
+
#
|
389
|
+
# @option options [String] :ssl_ca_bundle
|
390
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
391
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
392
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
393
|
+
#
|
394
|
+
# @option options [String] :ssl_ca_directory
|
395
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
396
|
+
# authority files for verifying peer certificates. If you do
|
397
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
398
|
+
# default will be used if available.
|
368
399
|
#
|
369
|
-
# @option options [
|
370
|
-
#
|
371
|
-
# connection.
|
400
|
+
# @option options [String] :ssl_ca_store
|
401
|
+
# Sets the X509::Store to verify peer certificate.
|
372
402
|
#
|
373
|
-
# @option options [
|
374
|
-
#
|
375
|
-
# verifying peer certificates. If you do not pass
|
376
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
377
|
-
# will be used if available.
|
403
|
+
# @option options [Float] :ssl_timeout
|
404
|
+
# Sets the SSL timeout in seconds
|
378
405
|
#
|
379
|
-
# @option options [
|
380
|
-
#
|
381
|
-
# authority files for verifying peer certificates. If you do
|
382
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
383
|
-
# system default will be used if available.
|
406
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
407
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
384
408
|
#
|
385
409
|
def initialize(*args)
|
386
410
|
super
|
@@ -432,8 +456,8 @@ module Aws::CleanRoomsML
|
|
432
456
|
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
433
457
|
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
434
458
|
# or delete tag keys with this prefix. Values can have this prefix. If
|
435
|
-
# a tag value has aws as its prefix but the key does not, then
|
436
|
-
#
|
459
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
460
|
+
# Rooms ML considers it to be a user tag and will count against the
|
437
461
|
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
438
462
|
# against your tags per resource limit.
|
439
463
|
#
|
@@ -512,7 +536,8 @@ module Aws::CleanRoomsML
|
|
512
536
|
#
|
513
537
|
# @option params [Integer] :min_matching_seed_size
|
514
538
|
# The minimum number of users from the seed audience that must match
|
515
|
-
# with users in the training data of the audience model.
|
539
|
+
# with users in the training data of the audience model. The default
|
540
|
+
# value is 500.
|
516
541
|
#
|
517
542
|
# @option params [required, String] :name
|
518
543
|
# The name of the configured audience model.
|
@@ -555,8 +580,8 @@ module Aws::CleanRoomsML
|
|
555
580
|
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
556
581
|
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
557
582
|
# or delete tag keys with this prefix. Values can have this prefix. If
|
558
|
-
# a tag value has aws as its prefix but the key does not, then
|
559
|
-
#
|
583
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
584
|
+
# Rooms ML considers it to be a user tag and will count against the
|
560
585
|
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
561
586
|
# against your tags per resource limit.
|
562
587
|
#
|
@@ -603,10 +628,9 @@ module Aws::CleanRoomsML
|
|
603
628
|
req.send_request(options)
|
604
629
|
end
|
605
630
|
|
606
|
-
# Defines the information necessary to create a training dataset
|
607
|
-
#
|
608
|
-
#
|
609
|
-
# creation.
|
631
|
+
# Defines the information necessary to create a training dataset. In
|
632
|
+
# Clean Rooms ML, the `TrainingDataset` is metadata that points to a
|
633
|
+
# Glue table, which is read only during `AudienceModel` creation.
|
610
634
|
#
|
611
635
|
# @option params [String] :description
|
612
636
|
# The description of the training dataset.
|
@@ -870,6 +894,7 @@ module Aws::CleanRoomsML
|
|
870
894
|
# resp.create_time #=> Time
|
871
895
|
# resp.description #=> String
|
872
896
|
# resp.include_seed_in_output #=> Boolean
|
897
|
+
# resp.metrics.recall_metric #=> Float
|
873
898
|
# resp.metrics.relevance_metrics #=> Array
|
874
899
|
# resp.metrics.relevance_metrics[0].audience_size.type #=> String, one of "ABSOLUTE", "PERCENTAGE"
|
875
900
|
# resp.metrics.relevance_metrics[0].audience_size.value #=> Integer
|
@@ -906,7 +931,6 @@ module Aws::CleanRoomsML
|
|
906
931
|
# * {Types::GetAudienceModelResponse#create_time #create_time} => Time
|
907
932
|
# * {Types::GetAudienceModelResponse#description #description} => String
|
908
933
|
# * {Types::GetAudienceModelResponse#kms_key_arn #kms_key_arn} => String
|
909
|
-
# * {Types::GetAudienceModelResponse#metrics #metrics} => Array<Types::AudienceModelMetric>
|
910
934
|
# * {Types::GetAudienceModelResponse#name #name} => String
|
911
935
|
# * {Types::GetAudienceModelResponse#status #status} => String
|
912
936
|
# * {Types::GetAudienceModelResponse#status_details #status_details} => Types::StatusDetails
|
@@ -928,10 +952,6 @@ module Aws::CleanRoomsML
|
|
928
952
|
# resp.create_time #=> Time
|
929
953
|
# resp.description #=> String
|
930
954
|
# resp.kms_key_arn #=> String
|
931
|
-
# resp.metrics #=> Array
|
932
|
-
# resp.metrics[0].for_top_k_item_predictions #=> Integer
|
933
|
-
# resp.metrics[0].type #=> String, one of "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN", "MEAN_RECIPROCAL_RANK", "PRECISION", "RECALL"
|
934
|
-
# resp.metrics[0].value #=> Float
|
935
955
|
# resp.name #=> String
|
936
956
|
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_FAILED"
|
937
957
|
# resp.status_details.message #=> String
|
@@ -1503,8 +1523,8 @@ module Aws::CleanRoomsML
|
|
1503
1523
|
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
1504
1524
|
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
1505
1525
|
# or delete tag keys with this prefix. Values can have this prefix. If
|
1506
|
-
# a tag value has aws as its prefix but the key does not, then
|
1507
|
-
#
|
1526
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
1527
|
+
# Rooms ML considers it to be a user tag and will count against the
|
1508
1528
|
# limit of 50 tags. Tags with only the key prefix of aws do not count
|
1509
1529
|
# against your tags per resource limit.
|
1510
1530
|
#
|
@@ -1577,9 +1597,9 @@ module Aws::CleanRoomsML
|
|
1577
1597
|
# * Do not use aws:, AWS:, or any upper or lowercase combination of such
|
1578
1598
|
# as a prefix for keys as it is reserved for AWS use. You cannot edit
|
1579
1599
|
# or delete tag keys with this prefix. Values can have this prefix. If
|
1580
|
-
# a tag value has aws as its prefix but the key does not, then
|
1581
|
-
#
|
1582
|
-
#
|
1600
|
+
# a tag value has aws as its prefix but the key does not, then Clean
|
1601
|
+
# Rooms considers it to be a user tag and will count against the limit
|
1602
|
+
# of 50 tags. Tags with only the key prefix of aws do not count
|
1583
1603
|
# against your tags per resource limit.
|
1584
1604
|
#
|
1585
1605
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -1709,7 +1729,7 @@ module Aws::CleanRoomsML
|
|
1709
1729
|
params: params,
|
1710
1730
|
config: config)
|
1711
1731
|
context[:gem_name] = 'aws-sdk-cleanroomsml'
|
1712
|
-
context[:gem_version] = '1.
|
1732
|
+
context[:gem_version] = '1.4.0'
|
1713
1733
|
Seahorse::Client::Request.new(handlers, context)
|
1714
1734
|
end
|
1715
1735
|
|
@@ -26,9 +26,6 @@ module Aws::CleanRoomsML
|
|
26
26
|
AudienceGenerationJobSummary = Shapes::StructureShape.new(name: 'AudienceGenerationJobSummary')
|
27
27
|
AudienceModelArn = Shapes::StringShape.new(name: 'AudienceModelArn')
|
28
28
|
AudienceModelList = Shapes::ListShape.new(name: 'AudienceModelList')
|
29
|
-
AudienceModelMetric = Shapes::StructureShape.new(name: 'AudienceModelMetric')
|
30
|
-
AudienceModelMetricType = Shapes::StringShape.new(name: 'AudienceModelMetricType')
|
31
|
-
AudienceModelMetrics = Shapes::ListShape.new(name: 'AudienceModelMetrics')
|
32
29
|
AudienceModelStatus = Shapes::StringShape.new(name: 'AudienceModelStatus')
|
33
30
|
AudienceModelSummary = Shapes::StructureShape.new(name: 'AudienceModelSummary')
|
34
31
|
AudienceQualityMetrics = Shapes::StructureShape.new(name: 'AudienceQualityMetrics')
|
@@ -82,7 +79,6 @@ module Aws::CleanRoomsML
|
|
82
79
|
GlueTableName = Shapes::StringShape.new(name: 'GlueTableName')
|
83
80
|
Hash = Shapes::StringShape.new(name: 'Hash')
|
84
81
|
IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
|
85
|
-
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
86
82
|
KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
|
87
83
|
ListAudienceExportJobsRequest = Shapes::StructureShape.new(name: 'ListAudienceExportJobsRequest')
|
88
84
|
ListAudienceExportJobsResponse = Shapes::StructureShape.new(name: 'ListAudienceExportJobsResponse')
|
@@ -176,13 +172,6 @@ module Aws::CleanRoomsML
|
|
176
172
|
|
177
173
|
AudienceModelList.member = Shapes::ShapeRef.new(shape: AudienceModelSummary)
|
178
174
|
|
179
|
-
AudienceModelMetric.add_member(:for_top_k_item_predictions, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "forTopKItemPredictions"))
|
180
|
-
AudienceModelMetric.add_member(:type, Shapes::ShapeRef.new(shape: AudienceModelMetricType, required: true, location_name: "type"))
|
181
|
-
AudienceModelMetric.add_member(:value, Shapes::ShapeRef.new(shape: Double, required: true, location_name: "value"))
|
182
|
-
AudienceModelMetric.struct_class = Types::AudienceModelMetric
|
183
|
-
|
184
|
-
AudienceModelMetrics.member = Shapes::ShapeRef.new(shape: AudienceModelMetric)
|
185
|
-
|
186
175
|
AudienceModelSummary.add_member(:audience_model_arn, Shapes::ShapeRef.new(shape: AudienceModelArn, required: true, location_name: "audienceModelArn"))
|
187
176
|
AudienceModelSummary.add_member(:create_time, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, required: true, location_name: "createTime"))
|
188
177
|
AudienceModelSummary.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "description"))
|
@@ -192,6 +181,7 @@ module Aws::CleanRoomsML
|
|
192
181
|
AudienceModelSummary.add_member(:update_time, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, required: true, location_name: "updateTime"))
|
193
182
|
AudienceModelSummary.struct_class = Types::AudienceModelSummary
|
194
183
|
|
184
|
+
AudienceQualityMetrics.add_member(:recall_metric, Shapes::ShapeRef.new(shape: Double, location_name: "recallMetric"))
|
195
185
|
AudienceQualityMetrics.add_member(:relevance_metrics, Shapes::ShapeRef.new(shape: RelevanceMetrics, required: true, location_name: "relevanceMetrics"))
|
196
186
|
AudienceQualityMetrics.struct_class = Types::AudienceQualityMetrics
|
197
187
|
|
@@ -324,7 +314,6 @@ module Aws::CleanRoomsML
|
|
324
314
|
GetAudienceModelResponse.add_member(:create_time, Shapes::ShapeRef.new(shape: SyntheticTimestamp_date_time, required: true, location_name: "createTime"))
|
325
315
|
GetAudienceModelResponse.add_member(:description, Shapes::ShapeRef.new(shape: ResourceDescription, location_name: "description"))
|
326
316
|
GetAudienceModelResponse.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn"))
|
327
|
-
GetAudienceModelResponse.add_member(:metrics, Shapes::ShapeRef.new(shape: AudienceModelMetrics, location_name: "metrics"))
|
328
317
|
GetAudienceModelResponse.add_member(:name, Shapes::ShapeRef.new(shape: NameString, required: true, location_name: "name"))
|
329
318
|
GetAudienceModelResponse.add_member(:status, Shapes::ShapeRef.new(shape: AudienceModelStatus, required: true, location_name: "status"))
|
330
319
|
GetAudienceModelResponse.add_member(:status_details, Shapes::ShapeRef.new(shape: StatusDetails, location_name: "statusDetails"))
|
@@ -93,12 +93,19 @@ module Aws::CleanRoomsML
|
|
93
93
|
include Aws::Structure
|
94
94
|
end
|
95
95
|
|
96
|
-
# Defines the Amazon S3 bucket where the
|
97
|
-
#
|
96
|
+
# Defines the Amazon S3 bucket where the seed audience for the
|
97
|
+
# generating audience is stored.
|
98
98
|
#
|
99
99
|
# @!attribute [rw] data_source
|
100
|
-
#
|
101
|
-
# audience is stored.
|
100
|
+
# Defines the Amazon S3 bucket where the seed audience for the
|
101
|
+
# generating audience is stored. A valid data source is a JSON line
|
102
|
+
# file in the following format:
|
103
|
+
#
|
104
|
+
# `\{"user_id": "111111"\}`
|
105
|
+
#
|
106
|
+
# `\{"user_id": "222222"\}`
|
107
|
+
#
|
108
|
+
# `...`
|
102
109
|
# @return [Types::S3ConfigMap]
|
103
110
|
#
|
104
111
|
# @!attribute [rw] role_arn
|
@@ -172,30 +179,6 @@ module Aws::CleanRoomsML
|
|
172
179
|
include Aws::Structure
|
173
180
|
end
|
174
181
|
|
175
|
-
# The audience model metrics.
|
176
|
-
#
|
177
|
-
# @!attribute [rw] for_top_k_item_predictions
|
178
|
-
# The number of users that were used to generate these model metrics.
|
179
|
-
# @return [Integer]
|
180
|
-
#
|
181
|
-
# @!attribute [rw] type
|
182
|
-
# The audience model metric.
|
183
|
-
# @return [String]
|
184
|
-
#
|
185
|
-
# @!attribute [rw] value
|
186
|
-
# The value of the audience model metric
|
187
|
-
# @return [Float]
|
188
|
-
#
|
189
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceModelMetric AWS API Documentation
|
190
|
-
#
|
191
|
-
class AudienceModelMetric < Struct.new(
|
192
|
-
:for_top_k_item_predictions,
|
193
|
-
:type,
|
194
|
-
:value)
|
195
|
-
SENSITIVE = []
|
196
|
-
include Aws::Structure
|
197
|
-
end
|
198
|
-
|
199
182
|
# Information about the audience model.
|
200
183
|
#
|
201
184
|
# @!attribute [rw] audience_model_arn
|
@@ -243,6 +226,16 @@ module Aws::CleanRoomsML
|
|
243
226
|
|
244
227
|
# Metrics that describe the quality of the generated audience.
|
245
228
|
#
|
229
|
+
# @!attribute [rw] recall_metric
|
230
|
+
# The recall score of the generated audience. Recall is the percentage
|
231
|
+
# of the most similar users (by default, the most similar 20%) from a
|
232
|
+
# sample of the training data that are included in the seed audience
|
233
|
+
# by the audience generation job. Values range from 0-1, larger values
|
234
|
+
# indicate a better audience. A recall value approximately equal to
|
235
|
+
# the maximum bin size indicates that the audience model is equivalent
|
236
|
+
# to random selection.
|
237
|
+
# @return [Float]
|
238
|
+
#
|
246
239
|
# @!attribute [rw] relevance_metrics
|
247
240
|
# The relevance scores of the generated audience.
|
248
241
|
# @return [Array<Types::RelevanceMetric>]
|
@@ -250,6 +243,7 @@ module Aws::CleanRoomsML
|
|
250
243
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/AudienceQualityMetrics AWS API Documentation
|
251
244
|
#
|
252
245
|
class AudienceQualityMetrics < Struct.new(
|
246
|
+
:recall_metric,
|
253
247
|
:relevance_metrics)
|
254
248
|
SENSITIVE = []
|
255
249
|
include Aws::Structure
|
@@ -397,7 +391,8 @@ module Aws::CleanRoomsML
|
|
397
391
|
include Aws::Structure
|
398
392
|
end
|
399
393
|
|
400
|
-
#
|
394
|
+
# You can't complete this action because another resource depends on
|
395
|
+
# this resource.
|
401
396
|
#
|
402
397
|
# @!attribute [rw] message
|
403
398
|
# @return [String]
|
@@ -452,9 +447,9 @@ module Aws::CleanRoomsML
|
|
452
447
|
# such as a prefix for keys as it is reserved for AWS use. You
|
453
448
|
# cannot edit or delete tag keys with this prefix. Values can have
|
454
449
|
# this prefix. If a tag value has aws as its prefix but the key does
|
455
|
-
# not, then
|
456
|
-
# against the limit of 50 tags. Tags with only the key prefix
|
457
|
-
# do not count against your tags per resource limit.
|
450
|
+
# not, then Clean Rooms ML considers it to be a user tag and will
|
451
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
452
|
+
# of aws do not count against your tags per resource limit.
|
458
453
|
# @return [Hash<String,String>]
|
459
454
|
#
|
460
455
|
# @!attribute [rw] training_data_end_time
|
@@ -531,7 +526,8 @@ module Aws::CleanRoomsML
|
|
531
526
|
#
|
532
527
|
# @!attribute [rw] min_matching_seed_size
|
533
528
|
# The minimum number of users from the seed audience that must match
|
534
|
-
# with users in the training data of the audience model.
|
529
|
+
# with users in the training data of the audience model. The default
|
530
|
+
# value is 500.
|
535
531
|
# @return [Integer]
|
536
532
|
#
|
537
533
|
# @!attribute [rw] name
|
@@ -579,9 +575,9 @@ module Aws::CleanRoomsML
|
|
579
575
|
# such as a prefix for keys as it is reserved for AWS use. You
|
580
576
|
# cannot edit or delete tag keys with this prefix. Values can have
|
581
577
|
# this prefix. If a tag value has aws as its prefix but the key does
|
582
|
-
# not, then
|
583
|
-
# against the limit of 50 tags. Tags with only the key prefix
|
584
|
-
# do not count against your tags per resource limit.
|
578
|
+
# not, then Clean Rooms ML considers it to be a user tag and will
|
579
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
580
|
+
# of aws do not count against your tags per resource limit.
|
585
581
|
# @return [Hash<String,String>]
|
586
582
|
#
|
587
583
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredAudienceModelRequest AWS API Documentation
|
@@ -861,7 +857,8 @@ module Aws::CleanRoomsML
|
|
861
857
|
# @return [Boolean]
|
862
858
|
#
|
863
859
|
# @!attribute [rw] metrics
|
864
|
-
# The relevance scores for different audience sizes
|
860
|
+
# The relevance scores for different audience sizes and the recall
|
861
|
+
# score of the generated audience.
|
865
862
|
# @return [Types::AudienceQualityMetrics]
|
866
863
|
#
|
867
864
|
# @!attribute [rw] name
|
@@ -945,10 +942,6 @@ module Aws::CleanRoomsML
|
|
945
942
|
# The KMS key ARN used for the audience model.
|
946
943
|
# @return [String]
|
947
944
|
#
|
948
|
-
# @!attribute [rw] metrics
|
949
|
-
# Accuracy metrics for the model.
|
950
|
-
# @return [Array<Types::AudienceModelMetric>]
|
951
|
-
#
|
952
945
|
# @!attribute [rw] name
|
953
946
|
# The name of the audience model.
|
954
947
|
# @return [String]
|
@@ -989,7 +982,6 @@ module Aws::CleanRoomsML
|
|
989
982
|
:create_time,
|
990
983
|
:description,
|
991
984
|
:kms_key_arn,
|
992
|
-
:metrics,
|
993
985
|
:name,
|
994
986
|
:status,
|
995
987
|
:status_details,
|
@@ -1639,9 +1631,9 @@ module Aws::CleanRoomsML
|
|
1639
1631
|
# such as a prefix for keys as it is reserved for AWS use. You
|
1640
1632
|
# cannot edit or delete tag keys with this prefix. Values can have
|
1641
1633
|
# this prefix. If a tag value has aws as its prefix but the key does
|
1642
|
-
# not, then
|
1643
|
-
# against the limit of 50 tags. Tags with only the key prefix
|
1644
|
-
# do not count against your tags per resource limit.
|
1634
|
+
# not, then Clean Rooms ML considers it to be a user tag and will
|
1635
|
+
# count against the limit of 50 tags. Tags with only the key prefix
|
1636
|
+
# of aws do not count against your tags per resource limit.
|
1645
1637
|
# @return [Hash<String,String>]
|
1646
1638
|
#
|
1647
1639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceGenerationJobRequest AWS API Documentation
|
@@ -1726,7 +1718,7 @@ module Aws::CleanRoomsML
|
|
1726
1718
|
# such as a prefix for keys as it is reserved for AWS use. You
|
1727
1719
|
# cannot edit or delete tag keys with this prefix. Values can have
|
1728
1720
|
# this prefix. If a tag value has aws as its prefix but the key does
|
1729
|
-
# not, then
|
1721
|
+
# not, then Clean Rooms considers it to be a user tag and will count
|
1730
1722
|
# against the limit of 50 tags. Tags with only the key prefix of aws
|
1731
1723
|
# do not count against your tags per resource limit.
|
1732
1724
|
# @return [Hash<String,String>]
|
data/lib/aws-sdk-cleanroomsml.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -208,7 +208,6 @@ module Aws
|
|
208
208
|
def create_time: () -> ::Time
|
209
209
|
def description: () -> ::String
|
210
210
|
def kms_key_arn: () -> ::String
|
211
|
-
def metrics: () -> ::Array[Types::AudienceModelMetric]
|
212
211
|
def name: () -> ::String
|
213
212
|
def status: () -> ("CREATE_PENDING" | "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_PENDING" | "DELETE_IN_PROGRESS" | "DELETE_FAILED")
|
214
213
|
def status_details: () -> Types::StatusDetails
|
data/sig/types.rbs
CHANGED
@@ -50,13 +50,6 @@ module Aws::CleanRoomsML
|
|
50
50
|
SENSITIVE: []
|
51
51
|
end
|
52
52
|
|
53
|
-
class AudienceModelMetric
|
54
|
-
attr_accessor for_top_k_item_predictions: ::Integer
|
55
|
-
attr_accessor type: ("NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN" | "MEAN_RECIPROCAL_RANK" | "PRECISION" | "RECALL")
|
56
|
-
attr_accessor value: ::Float
|
57
|
-
SENSITIVE: []
|
58
|
-
end
|
59
|
-
|
60
53
|
class AudienceModelSummary
|
61
54
|
attr_accessor audience_model_arn: ::String
|
62
55
|
attr_accessor create_time: ::Time
|
@@ -69,6 +62,7 @@ module Aws::CleanRoomsML
|
|
69
62
|
end
|
70
63
|
|
71
64
|
class AudienceQualityMetrics
|
65
|
+
attr_accessor recall_metric: ::Float
|
72
66
|
attr_accessor relevance_metrics: ::Array[Types::RelevanceMetric]
|
73
67
|
SENSITIVE: []
|
74
68
|
end
|
@@ -237,7 +231,6 @@ module Aws::CleanRoomsML
|
|
237
231
|
attr_accessor create_time: ::Time
|
238
232
|
attr_accessor description: ::String
|
239
233
|
attr_accessor kms_key_arn: ::String
|
240
|
-
attr_accessor metrics: ::Array[Types::AudienceModelMetric]
|
241
234
|
attr_accessor name: ::String
|
242
235
|
attr_accessor status: ("CREATE_PENDING" | "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_PENDING" | "DELETE_IN_PROGRESS" | "DELETE_FAILED")
|
243
236
|
attr_accessor status_details: Types::StatusDetails
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cleanroomsml
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-04-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.193.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.193.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|