aws-sdk-sagemakermetrics 1.22.0 → 1.23.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sagemakermetrics/client.rb +58 -8
- data/lib/aws-sdk-sagemakermetrics/client_api.rb +52 -0
- data/lib/aws-sdk-sagemakermetrics/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-sagemakermetrics/endpoints.rb +11 -0
- data/lib/aws-sdk-sagemakermetrics/plugins/endpoints.rb +10 -5
- data/lib/aws-sdk-sagemakermetrics/types.rb +99 -1
- data/lib/aws-sdk-sagemakermetrics.rb +2 -2
- data/sig/client.rbs +21 -0
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +29 -0
- 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: d2744146186844322a54d402c8d97c535ad46378336b1c0508ecdf27ff200dbb
|
4
|
+
data.tar.gz: ab1231e3c8be2c77138ef4473759bf76a9deb33c61a756112bb7c19370fe0b3c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 58606906e0b972188fadec0b372706b59425afc359f3aefa4b302addc4b26901360e4b03da6dd2381f060e0a30add85b641f53e556108452064786e95b37a6a4
|
7
|
+
data.tar.gz: 82d2c4d4f1de52e9dd596ef6ac123b3e36aa0c9eb49552a1ddc0e9936c3584f620b7f048f24fbb3395501fa223985e1b9b8d957bb52fc6b8e55361e1633c5091
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.23.0
|
@@ -130,13 +130,15 @@ module Aws::SageMakerMetrics
|
|
130
130
|
# locations will be searched for credentials:
|
131
131
|
#
|
132
132
|
# * `Aws.config[:credentials]`
|
133
|
-
# * The `:access_key_id`, `:secret_access_key`,
|
134
|
-
#
|
133
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
134
|
+
# `:account_id` options.
|
135
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
|
136
|
+
# ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
|
135
137
|
# * `~/.aws/credentials`
|
136
138
|
# * `~/.aws/config`
|
137
139
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
138
140
|
# are very aggressive. Construct and pass an instance of
|
139
|
-
# `Aws::
|
141
|
+
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
140
142
|
# enable retries and extended timeouts. Instance profile credential
|
141
143
|
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
142
144
|
# to true.
|
@@ -155,6 +157,8 @@ module Aws::SageMakerMetrics
|
|
155
157
|
#
|
156
158
|
# @option options [String] :access_key_id
|
157
159
|
#
|
160
|
+
# @option options [String] :account_id
|
161
|
+
#
|
158
162
|
# @option options [Boolean] :active_endpoint_cache (false)
|
159
163
|
# When set to `true`, a thread polling for endpoints will be running in
|
160
164
|
# the background every 60 secs (default). Defaults to `false`.
|
@@ -369,7 +373,9 @@ module Aws::SageMakerMetrics
|
|
369
373
|
# sending the request.
|
370
374
|
#
|
371
375
|
# @option options [Aws::SageMakerMetrics::EndpointProvider] :endpoint_provider
|
372
|
-
# The endpoint provider used to resolve endpoints. Any object that responds to
|
376
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
377
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
378
|
+
# `Aws::SageMakerMetrics::EndpointParameters`.
|
373
379
|
#
|
374
380
|
# @option options [Float] :http_continue_timeout (1)
|
375
381
|
# The number of seconds to wait for a 100-continue response before sending the
|
@@ -443,12 +449,56 @@ module Aws::SageMakerMetrics
|
|
443
449
|
|
444
450
|
# @!group API Operations
|
445
451
|
|
452
|
+
# Used to retrieve training metrics from SageMaker.
|
453
|
+
#
|
454
|
+
# @option params [required, Array<Types::MetricQuery>] :metric_queries
|
455
|
+
# Queries made to retrieve training metrics from SageMaker.
|
456
|
+
#
|
457
|
+
# @return [Types::BatchGetMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
458
|
+
#
|
459
|
+
# * {Types::BatchGetMetricsResponse#metric_query_results #metric_query_results} => Array<Types::MetricQueryResult>
|
460
|
+
#
|
461
|
+
# @example Request syntax with placeholder values
|
462
|
+
#
|
463
|
+
# resp = client.batch_get_metrics({
|
464
|
+
# metric_queries: [ # required
|
465
|
+
# {
|
466
|
+
# metric_name: "MetricName", # required
|
467
|
+
# resource_arn: "SageMakerResourceArn", # required
|
468
|
+
# metric_stat: "Min", # required, accepts Min, Max, Avg, Count, StdDev, Last
|
469
|
+
# period: "OneMinute", # required, accepts OneMinute, FiveMinute, OneHour, IterationNumber
|
470
|
+
# x_axis_type: "IterationNumber", # required, accepts IterationNumber, Timestamp
|
471
|
+
# start: 1,
|
472
|
+
# end: 1,
|
473
|
+
# },
|
474
|
+
# ],
|
475
|
+
# })
|
476
|
+
#
|
477
|
+
# @example Response structure
|
478
|
+
#
|
479
|
+
# resp.metric_query_results #=> Array
|
480
|
+
# resp.metric_query_results[0].status #=> String, one of "Complete", "Truncated", "InternalError", "ValidationError"
|
481
|
+
# resp.metric_query_results[0].message #=> String
|
482
|
+
# resp.metric_query_results[0].x_axis_values #=> Array
|
483
|
+
# resp.metric_query_results[0].x_axis_values[0] #=> Integer
|
484
|
+
# resp.metric_query_results[0].metric_values #=> Array
|
485
|
+
# resp.metric_query_results[0].metric_values[0] #=> Float
|
486
|
+
#
|
487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/BatchGetMetrics AWS API Documentation
|
488
|
+
#
|
489
|
+
# @overload batch_get_metrics(params = {})
|
490
|
+
# @param [Hash] params ({})
|
491
|
+
def batch_get_metrics(params = {}, options = {})
|
492
|
+
req = build_request(:batch_get_metrics, params)
|
493
|
+
req.send_request(options)
|
494
|
+
end
|
495
|
+
|
446
496
|
# Used to ingest training metrics into SageMaker. These metrics can be
|
447
|
-
# visualized in SageMaker Studio
|
448
|
-
# API.
|
497
|
+
# visualized in SageMaker Studio.
|
449
498
|
#
|
450
499
|
# @option params [required, String] :trial_component_name
|
451
|
-
# The name of the Trial Component to associate with the metrics.
|
500
|
+
# The name of the Trial Component to associate with the metrics. The
|
501
|
+
# Trial Component name must be entirely lowercase.
|
452
502
|
#
|
453
503
|
# @option params [required, Array<Types::RawMetricData>] :metric_data
|
454
504
|
# A list of raw metric values to put.
|
@@ -504,7 +554,7 @@ module Aws::SageMakerMetrics
|
|
504
554
|
tracer: tracer
|
505
555
|
)
|
506
556
|
context[:gem_name] = 'aws-sdk-sagemakermetrics'
|
507
|
-
context[:gem_version] = '1.
|
557
|
+
context[:gem_version] = '1.23.0'
|
508
558
|
Seahorse::Client::Request.new(handlers, context)
|
509
559
|
end
|
510
560
|
|
@@ -13,6 +13,8 @@ module Aws::SageMakerMetrics
|
|
13
13
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
|
+
BatchGetMetricsRequest = Shapes::StructureShape.new(name: 'BatchGetMetricsRequest')
|
17
|
+
BatchGetMetricsResponse = Shapes::StructureShape.new(name: 'BatchGetMetricsResponse')
|
16
18
|
BatchPutMetricsError = Shapes::StructureShape.new(name: 'BatchPutMetricsError')
|
17
19
|
BatchPutMetricsErrorList = Shapes::ListShape.new(name: 'BatchPutMetricsErrorList')
|
18
20
|
BatchPutMetricsRequest = Shapes::StructureShape.new(name: 'BatchPutMetricsRequest')
|
@@ -20,12 +22,31 @@ module Aws::SageMakerMetrics
|
|
20
22
|
Double = Shapes::FloatShape.new(name: 'Double')
|
21
23
|
ExperimentEntityName = Shapes::StringShape.new(name: 'ExperimentEntityName')
|
22
24
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
25
|
+
Long = Shapes::IntegerShape.new(name: 'Long')
|
26
|
+
Message = Shapes::StringShape.new(name: 'Message')
|
23
27
|
MetricName = Shapes::StringShape.new(name: 'MetricName')
|
28
|
+
MetricQuery = Shapes::StructureShape.new(name: 'MetricQuery')
|
29
|
+
MetricQueryList = Shapes::ListShape.new(name: 'MetricQueryList')
|
30
|
+
MetricQueryResult = Shapes::StructureShape.new(name: 'MetricQueryResult')
|
31
|
+
MetricQueryResultList = Shapes::ListShape.new(name: 'MetricQueryResultList')
|
32
|
+
MetricQueryResultStatus = Shapes::StringShape.new(name: 'MetricQueryResultStatus')
|
33
|
+
MetricStatistic = Shapes::StringShape.new(name: 'MetricStatistic')
|
34
|
+
MetricValues = Shapes::ListShape.new(name: 'MetricValues')
|
35
|
+
Period = Shapes::StringShape.new(name: 'Period')
|
24
36
|
PutMetricsErrorCode = Shapes::StringShape.new(name: 'PutMetricsErrorCode')
|
25
37
|
RawMetricData = Shapes::StructureShape.new(name: 'RawMetricData')
|
26
38
|
RawMetricDataList = Shapes::ListShape.new(name: 'RawMetricDataList')
|
39
|
+
SageMakerResourceArn = Shapes::StringShape.new(name: 'SageMakerResourceArn')
|
27
40
|
Step = Shapes::IntegerShape.new(name: 'Step')
|
28
41
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
42
|
+
XAxisType = Shapes::StringShape.new(name: 'XAxisType')
|
43
|
+
XAxisValues = Shapes::ListShape.new(name: 'XAxisValues')
|
44
|
+
|
45
|
+
BatchGetMetricsRequest.add_member(:metric_queries, Shapes::ShapeRef.new(shape: MetricQueryList, required: true, location_name: "MetricQueries"))
|
46
|
+
BatchGetMetricsRequest.struct_class = Types::BatchGetMetricsRequest
|
47
|
+
|
48
|
+
BatchGetMetricsResponse.add_member(:metric_query_results, Shapes::ShapeRef.new(shape: MetricQueryResultList, location_name: "MetricQueryResults"))
|
49
|
+
BatchGetMetricsResponse.struct_class = Types::BatchGetMetricsResponse
|
29
50
|
|
30
51
|
BatchPutMetricsError.add_member(:code, Shapes::ShapeRef.new(shape: PutMetricsErrorCode, location_name: "Code"))
|
31
52
|
BatchPutMetricsError.add_member(:metric_index, Shapes::ShapeRef.new(shape: Integer, location_name: "MetricIndex"))
|
@@ -40,6 +61,27 @@ module Aws::SageMakerMetrics
|
|
40
61
|
BatchPutMetricsResponse.add_member(:errors, Shapes::ShapeRef.new(shape: BatchPutMetricsErrorList, location_name: "Errors"))
|
41
62
|
BatchPutMetricsResponse.struct_class = Types::BatchPutMetricsResponse
|
42
63
|
|
64
|
+
MetricQuery.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "MetricName"))
|
65
|
+
MetricQuery.add_member(:resource_arn, Shapes::ShapeRef.new(shape: SageMakerResourceArn, required: true, location_name: "ResourceArn"))
|
66
|
+
MetricQuery.add_member(:metric_stat, Shapes::ShapeRef.new(shape: MetricStatistic, required: true, location_name: "MetricStat"))
|
67
|
+
MetricQuery.add_member(:period, Shapes::ShapeRef.new(shape: Period, required: true, location_name: "Period"))
|
68
|
+
MetricQuery.add_member(:x_axis_type, Shapes::ShapeRef.new(shape: XAxisType, required: true, location_name: "XAxisType"))
|
69
|
+
MetricQuery.add_member(:start, Shapes::ShapeRef.new(shape: Long, location_name: "Start", metadata: {"box"=>true}))
|
70
|
+
MetricQuery.add_member(:end, Shapes::ShapeRef.new(shape: Long, location_name: "End", metadata: {"box"=>true}))
|
71
|
+
MetricQuery.struct_class = Types::MetricQuery
|
72
|
+
|
73
|
+
MetricQueryList.member = Shapes::ShapeRef.new(shape: MetricQuery)
|
74
|
+
|
75
|
+
MetricQueryResult.add_member(:status, Shapes::ShapeRef.new(shape: MetricQueryResultStatus, required: true, location_name: "Status"))
|
76
|
+
MetricQueryResult.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
77
|
+
MetricQueryResult.add_member(:x_axis_values, Shapes::ShapeRef.new(shape: XAxisValues, required: true, location_name: "XAxisValues"))
|
78
|
+
MetricQueryResult.add_member(:metric_values, Shapes::ShapeRef.new(shape: MetricValues, required: true, location_name: "MetricValues"))
|
79
|
+
MetricQueryResult.struct_class = Types::MetricQueryResult
|
80
|
+
|
81
|
+
MetricQueryResultList.member = Shapes::ShapeRef.new(shape: MetricQueryResult)
|
82
|
+
|
83
|
+
MetricValues.member = Shapes::ShapeRef.new(shape: Double)
|
84
|
+
|
43
85
|
RawMetricData.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "MetricName"))
|
44
86
|
RawMetricData.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "Timestamp"))
|
45
87
|
RawMetricData.add_member(:step, Shapes::ShapeRef.new(shape: Step, location_name: "Step"))
|
@@ -48,6 +90,8 @@ module Aws::SageMakerMetrics
|
|
48
90
|
|
49
91
|
RawMetricDataList.member = Shapes::ShapeRef.new(shape: RawMetricData)
|
50
92
|
|
93
|
+
XAxisValues.member = Shapes::ShapeRef.new(shape: Long)
|
94
|
+
|
51
95
|
|
52
96
|
# @api private
|
53
97
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -68,6 +112,14 @@ module Aws::SageMakerMetrics
|
|
68
112
|
"uid" => "sagemaker-metrics-2022-09-30",
|
69
113
|
}
|
70
114
|
|
115
|
+
api.add_operation(:batch_get_metrics, Seahorse::Model::Operation.new.tap do |o|
|
116
|
+
o.name = "BatchGetMetrics"
|
117
|
+
o.http_method = "POST"
|
118
|
+
o.http_request_uri = "/BatchGetMetrics"
|
119
|
+
o.input = Shapes::ShapeRef.new(shape: BatchGetMetricsRequest)
|
120
|
+
o.output = Shapes::ShapeRef.new(shape: BatchGetMetricsResponse)
|
121
|
+
end)
|
122
|
+
|
71
123
|
api.add_operation(:batch_put_metrics, Seahorse::Model::Operation.new.tap do |o|
|
72
124
|
o.name = "BatchPutMetrics"
|
73
125
|
o.http_method = "PUT"
|
@@ -32,7 +32,7 @@ module Aws::SageMakerMetrics
|
|
32
32
|
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
33
33
|
end
|
34
34
|
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
35
|
-
if Aws::Endpoints::Matchers.boolean_equals?(
|
35
|
+
if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
|
36
36
|
return Aws::Endpoints::Endpoint.new(url: "https://metrics.sagemaker-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
37
37
|
end
|
38
38
|
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
@@ -12,6 +12,17 @@ module Aws::SageMakerMetrics
|
|
12
12
|
# @api private
|
13
13
|
module Endpoints
|
14
14
|
|
15
|
+
class BatchGetMetrics
|
16
|
+
def self.build(context)
|
17
|
+
Aws::SageMakerMetrics::EndpointParameters.new(
|
18
|
+
region: context.config.region,
|
19
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
20
|
+
use_fips: context.config.use_fips_endpoint,
|
21
|
+
endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s,
|
22
|
+
)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
15
26
|
class BatchPutMetrics
|
16
27
|
def self.build(context)
|
17
28
|
Aws::SageMakerMetrics::EndpointParameters.new(
|
@@ -15,11 +15,11 @@ module Aws::SageMakerMetrics
|
|
15
15
|
:endpoint_provider,
|
16
16
|
doc_type: 'Aws::SageMakerMetrics::EndpointProvider',
|
17
17
|
rbs_type: 'untyped',
|
18
|
-
docstring:
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
18
|
+
docstring: <<~DOCS) do |_cfg|
|
19
|
+
The endpoint provider used to resolve endpoints. Any object that responds to
|
20
|
+
`#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
21
|
+
`Aws::SageMakerMetrics::EndpointParameters`.
|
22
|
+
DOCS
|
23
23
|
Aws::SageMakerMetrics::EndpointProvider.new
|
24
24
|
end
|
25
25
|
|
@@ -51,6 +51,9 @@ module Aws::SageMakerMetrics
|
|
51
51
|
if context[:auth_scheme] && context[:auth_scheme]['name'] == 'sigv4a'
|
52
52
|
metrics << 'SIGV4A_SIGNING'
|
53
53
|
end
|
54
|
+
if context.config.credentials&.credentials&.account_id
|
55
|
+
metrics << 'RESOLVED_ACCOUNT_ID'
|
56
|
+
end
|
54
57
|
Aws::Plugins::UserAgent.metric(*metrics, &block)
|
55
58
|
end
|
56
59
|
|
@@ -67,6 +70,8 @@ module Aws::SageMakerMetrics
|
|
67
70
|
|
68
71
|
def parameters_for_operation(context)
|
69
72
|
case context.operation_name
|
73
|
+
when :batch_get_metrics
|
74
|
+
Aws::SageMakerMetrics::Endpoints::BatchGetMetrics.build(context)
|
70
75
|
when :batch_put_metrics
|
71
76
|
Aws::SageMakerMetrics::Endpoints::BatchPutMetrics.build(context)
|
72
77
|
end
|
@@ -10,6 +10,30 @@
|
|
10
10
|
module Aws::SageMakerMetrics
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# @!attribute [rw] metric_queries
|
14
|
+
# Queries made to retrieve training metrics from SageMaker.
|
15
|
+
# @return [Array<Types::MetricQuery>]
|
16
|
+
#
|
17
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/BatchGetMetricsRequest AWS API Documentation
|
18
|
+
#
|
19
|
+
class BatchGetMetricsRequest < Struct.new(
|
20
|
+
:metric_queries)
|
21
|
+
SENSITIVE = []
|
22
|
+
include Aws::Structure
|
23
|
+
end
|
24
|
+
|
25
|
+
# @!attribute [rw] metric_query_results
|
26
|
+
# The results of a query to retrieve training metrics from SageMaker.
|
27
|
+
# @return [Array<Types::MetricQueryResult>]
|
28
|
+
#
|
29
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/BatchGetMetricsResponse AWS API Documentation
|
30
|
+
#
|
31
|
+
class BatchGetMetricsResponse < Struct.new(
|
32
|
+
:metric_query_results)
|
33
|
+
SENSITIVE = []
|
34
|
+
include Aws::Structure
|
35
|
+
end
|
36
|
+
|
13
37
|
# An error that occured when putting the metric data.
|
14
38
|
#
|
15
39
|
# @!attribute [rw] code
|
@@ -41,7 +65,8 @@ module Aws::SageMakerMetrics
|
|
41
65
|
end
|
42
66
|
|
43
67
|
# @!attribute [rw] trial_component_name
|
44
|
-
# The name of the Trial Component to associate with the metrics.
|
68
|
+
# The name of the Trial Component to associate with the metrics. The
|
69
|
+
# Trial Component name must be entirely lowercase.
|
45
70
|
# @return [String]
|
46
71
|
#
|
47
72
|
# @!attribute [rw] metric_data
|
@@ -69,6 +94,79 @@ module Aws::SageMakerMetrics
|
|
69
94
|
include Aws::Structure
|
70
95
|
end
|
71
96
|
|
97
|
+
# Specifies a query to retrieve training metrics from SageMaker.
|
98
|
+
#
|
99
|
+
# @!attribute [rw] metric_name
|
100
|
+
# The name of the metric to retrieve.
|
101
|
+
# @return [String]
|
102
|
+
#
|
103
|
+
# @!attribute [rw] resource_arn
|
104
|
+
# The ARN of the SageMaker resource to retrieve metrics for.
|
105
|
+
# @return [String]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] metric_stat
|
108
|
+
# The metrics stat type of metrics to retrieve.
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @!attribute [rw] period
|
112
|
+
# The time period of metrics to retrieve.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] x_axis_type
|
116
|
+
# The x-axis type of metrics to retrieve.
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] start
|
120
|
+
# The start time of metrics to retrieve.
|
121
|
+
# @return [Integer]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] end
|
124
|
+
# The end time of metrics to retrieve.
|
125
|
+
# @return [Integer]
|
126
|
+
#
|
127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/MetricQuery AWS API Documentation
|
128
|
+
#
|
129
|
+
class MetricQuery < Struct.new(
|
130
|
+
:metric_name,
|
131
|
+
:resource_arn,
|
132
|
+
:metric_stat,
|
133
|
+
:period,
|
134
|
+
:x_axis_type,
|
135
|
+
:start,
|
136
|
+
:end)
|
137
|
+
SENSITIVE = []
|
138
|
+
include Aws::Structure
|
139
|
+
end
|
140
|
+
|
141
|
+
# The result of a query to retrieve training metrics from SageMaker.
|
142
|
+
#
|
143
|
+
# @!attribute [rw] status
|
144
|
+
# The status of the metric query.
|
145
|
+
# @return [String]
|
146
|
+
#
|
147
|
+
# @!attribute [rw] message
|
148
|
+
# A message describing the status of the metric query.
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] x_axis_values
|
152
|
+
# The values for the x-axis of the metrics.
|
153
|
+
# @return [Array<Integer>]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] metric_values
|
156
|
+
# The metric values retrieved by the query.
|
157
|
+
# @return [Array<Float>]
|
158
|
+
#
|
159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-metrics-2022-09-30/MetricQueryResult AWS API Documentation
|
160
|
+
#
|
161
|
+
class MetricQueryResult < Struct.new(
|
162
|
+
:status,
|
163
|
+
:message,
|
164
|
+
:x_axis_values,
|
165
|
+
:metric_values)
|
166
|
+
SENSITIVE = []
|
167
|
+
include Aws::Structure
|
168
|
+
end
|
169
|
+
|
72
170
|
# The raw metric data to associate with the resource.
|
73
171
|
#
|
74
172
|
# @!attribute [rw] metric_name
|
@@ -32,7 +32,7 @@ require_relative 'aws-sdk-sagemakermetrics/customizations'
|
|
32
32
|
# structure.
|
33
33
|
#
|
34
34
|
# sage_maker_metrics = Aws::SageMakerMetrics::Client.new
|
35
|
-
# resp = sage_maker_metrics.
|
35
|
+
# resp = sage_maker_metrics.batch_get_metrics(params)
|
36
36
|
#
|
37
37
|
# See {Client} for more information.
|
38
38
|
#
|
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-sagemakermetrics/customizations'
|
|
52
52
|
# @!group service
|
53
53
|
module Aws::SageMakerMetrics
|
54
54
|
|
55
|
-
GEM_VERSION = '1.
|
55
|
+
GEM_VERSION = '1.23.0'
|
56
56
|
|
57
57
|
end
|
data/sig/client.rbs
CHANGED
@@ -15,6 +15,7 @@ module Aws
|
|
15
15
|
?credentials: untyped,
|
16
16
|
?region: String,
|
17
17
|
?access_key_id: String,
|
18
|
+
?account_id: String,
|
18
19
|
?active_endpoint_cache: bool,
|
19
20
|
?adaptive_retry_wait_to_fill: bool,
|
20
21
|
?client_side_monitoring: bool,
|
@@ -74,6 +75,26 @@ module Aws
|
|
74
75
|
| (?Hash[Symbol, untyped]) -> instance
|
75
76
|
|
76
77
|
|
78
|
+
interface _BatchGetMetricsResponseSuccess
|
79
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetMetricsResponse]
|
80
|
+
def metric_query_results: () -> ::Array[Types::MetricQueryResult]
|
81
|
+
end
|
82
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SageMakerMetrics/Client.html#batch_get_metrics-instance_method
|
83
|
+
def batch_get_metrics: (
|
84
|
+
metric_queries: Array[
|
85
|
+
{
|
86
|
+
metric_name: ::String,
|
87
|
+
resource_arn: ::String,
|
88
|
+
metric_stat: ("Min" | "Max" | "Avg" | "Count" | "StdDev" | "Last"),
|
89
|
+
period: ("OneMinute" | "FiveMinute" | "OneHour" | "IterationNumber"),
|
90
|
+
x_axis_type: ("IterationNumber" | "Timestamp"),
|
91
|
+
start: ::Integer?,
|
92
|
+
end: ::Integer?
|
93
|
+
},
|
94
|
+
]
|
95
|
+
) -> _BatchGetMetricsResponseSuccess
|
96
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchGetMetricsResponseSuccess
|
97
|
+
|
77
98
|
interface _BatchPutMetricsResponseSuccess
|
78
99
|
include ::Seahorse::Client::_ResponseSuccess[Types::BatchPutMetricsResponse]
|
79
100
|
def errors: () -> ::Array[Types::BatchPutMetricsError]
|
data/sig/resource.rbs
CHANGED
data/sig/types.rbs
CHANGED
@@ -8,6 +8,16 @@
|
|
8
8
|
module Aws::SageMakerMetrics
|
9
9
|
module Types
|
10
10
|
|
11
|
+
class BatchGetMetricsRequest
|
12
|
+
attr_accessor metric_queries: ::Array[Types::MetricQuery]
|
13
|
+
SENSITIVE: []
|
14
|
+
end
|
15
|
+
|
16
|
+
class BatchGetMetricsResponse
|
17
|
+
attr_accessor metric_query_results: ::Array[Types::MetricQueryResult]
|
18
|
+
SENSITIVE: []
|
19
|
+
end
|
20
|
+
|
11
21
|
class BatchPutMetricsError
|
12
22
|
attr_accessor code: ("METRIC_LIMIT_EXCEEDED" | "INTERNAL_ERROR" | "VALIDATION_ERROR" | "CONFLICT_ERROR")
|
13
23
|
attr_accessor metric_index: ::Integer
|
@@ -25,6 +35,25 @@ module Aws::SageMakerMetrics
|
|
25
35
|
SENSITIVE: []
|
26
36
|
end
|
27
37
|
|
38
|
+
class MetricQuery
|
39
|
+
attr_accessor metric_name: ::String
|
40
|
+
attr_accessor resource_arn: ::String
|
41
|
+
attr_accessor metric_stat: ("Min" | "Max" | "Avg" | "Count" | "StdDev" | "Last")
|
42
|
+
attr_accessor period: ("OneMinute" | "FiveMinute" | "OneHour" | "IterationNumber")
|
43
|
+
attr_accessor x_axis_type: ("IterationNumber" | "Timestamp")
|
44
|
+
attr_accessor start: ::Integer
|
45
|
+
attr_accessor end: ::Integer
|
46
|
+
SENSITIVE: []
|
47
|
+
end
|
48
|
+
|
49
|
+
class MetricQueryResult
|
50
|
+
attr_accessor status: ("Complete" | "Truncated" | "InternalError" | "ValidationError")
|
51
|
+
attr_accessor message: ::String
|
52
|
+
attr_accessor x_axis_values: ::Array[::Integer]
|
53
|
+
attr_accessor metric_values: ::Array[::Float]
|
54
|
+
SENSITIVE: []
|
55
|
+
end
|
56
|
+
|
28
57
|
class RawMetricData
|
29
58
|
attr_accessor metric_name: ::String
|
30
59
|
attr_accessor timestamp: ::Time
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-sagemakermetrics
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.23.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-09-
|
11
|
+
date: 2024-09-20 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.207.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.207.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|