aws-sdk-sagemaker 1.317.0 → 1.319.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sagemaker/client.rb +435 -17
- data/lib/aws-sdk-sagemaker/client_api.rb +279 -0
- data/lib/aws-sdk-sagemaker/types.rb +927 -12
- data/lib/aws-sdk-sagemaker.rb +1 -1
- data/sig/client.rbs +100 -7
- data/sig/types.rbs +217 -1
- metadata +1 -1
@@ -136,6 +136,27 @@ module Aws::SageMaker
|
|
136
136
|
include Aws::Structure
|
137
137
|
end
|
138
138
|
|
139
|
+
# Specifies an instance group and the number of nodes to add to it.
|
140
|
+
#
|
141
|
+
# @!attribute [rw] instance_group_name
|
142
|
+
# The name of the instance group to which you want to add nodes.
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] increment_target_count_by
|
146
|
+
# The number of nodes to add to the specified instance group. The
|
147
|
+
# total number of nodes across all instance groups in a single request
|
148
|
+
# cannot exceed 50.
|
149
|
+
# @return [Integer]
|
150
|
+
#
|
151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AddClusterNodeSpecification AWS API Documentation
|
152
|
+
#
|
153
|
+
class AddClusterNodeSpecification < Struct.new(
|
154
|
+
:instance_group_name,
|
155
|
+
:increment_target_count_by)
|
156
|
+
SENSITIVE = []
|
157
|
+
include Aws::Structure
|
158
|
+
end
|
159
|
+
|
139
160
|
# @!attribute [rw] resource_arn
|
140
161
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
141
162
|
# @return [String]
|
@@ -172,6 +193,22 @@ module Aws::SageMaker
|
|
172
193
|
include Aws::Structure
|
173
194
|
end
|
174
195
|
|
196
|
+
# Information about additional Elastic Network Interfaces (ENIs)
|
197
|
+
# associated with an instance.
|
198
|
+
#
|
199
|
+
# @!attribute [rw] efa_enis
|
200
|
+
# A list of Elastic Fabric Adapter (EFA) ENIs associated with the
|
201
|
+
# instance.
|
202
|
+
# @return [Array<String>]
|
203
|
+
#
|
204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AdditionalEnis AWS API Documentation
|
205
|
+
#
|
206
|
+
class AdditionalEnis < Struct.new(
|
207
|
+
:efa_enis)
|
208
|
+
SENSITIVE = []
|
209
|
+
include Aws::Structure
|
210
|
+
end
|
211
|
+
|
175
212
|
# A structure of additional Inference Specification. Additional
|
176
213
|
# Inference Specification specifies details about inference jobs that
|
177
214
|
# can be run with models based on this model package
|
@@ -1825,6 +1862,74 @@ module Aws::SageMaker
|
|
1825
1862
|
include Aws::Structure
|
1826
1863
|
end
|
1827
1864
|
|
1865
|
+
# @!attribute [rw] cluster_arn
|
1866
|
+
# The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster
|
1867
|
+
# containing the target node. Your cluster must use EKS as the
|
1868
|
+
# orchestration and be in the `InService` state.
|
1869
|
+
# @return [String]
|
1870
|
+
#
|
1871
|
+
# @!attribute [rw] node_id
|
1872
|
+
# The unique identifier of the cluster node to which you want to
|
1873
|
+
# attach the volume. The node must belong to your specified HyperPod
|
1874
|
+
# cluster and cannot be part of a Restricted Instance Group (RIG).
|
1875
|
+
# @return [String]
|
1876
|
+
#
|
1877
|
+
# @!attribute [rw] volume_id
|
1878
|
+
# The unique identifier of your EBS volume to attach. The volume must
|
1879
|
+
# be in the `available` state.
|
1880
|
+
# @return [String]
|
1881
|
+
#
|
1882
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AttachClusterNodeVolumeRequest AWS API Documentation
|
1883
|
+
#
|
1884
|
+
class AttachClusterNodeVolumeRequest < Struct.new(
|
1885
|
+
:cluster_arn,
|
1886
|
+
:node_id,
|
1887
|
+
:volume_id)
|
1888
|
+
SENSITIVE = []
|
1889
|
+
include Aws::Structure
|
1890
|
+
end
|
1891
|
+
|
1892
|
+
# @!attribute [rw] cluster_arn
|
1893
|
+
# The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster
|
1894
|
+
# where the volume attachment operation was performed.
|
1895
|
+
# @return [String]
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] node_id
|
1898
|
+
# The unique identifier of the cluster node where your volume was
|
1899
|
+
# attached.
|
1900
|
+
# @return [String]
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] volume_id
|
1903
|
+
# The unique identifier of your EBS volume that was attached.
|
1904
|
+
# @return [String]
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] attach_time
|
1907
|
+
# The timestamp when the volume attachment operation was initiated by
|
1908
|
+
# the SageMaker HyperPod service.
|
1909
|
+
# @return [Time]
|
1910
|
+
#
|
1911
|
+
# @!attribute [rw] status
|
1912
|
+
# The current status of your volume attachment operation.
|
1913
|
+
# @return [String]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] device_name
|
1916
|
+
# The device name assigned to your attached volume on the target
|
1917
|
+
# instance.
|
1918
|
+
# @return [String]
|
1919
|
+
#
|
1920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AttachClusterNodeVolumeResponse AWS API Documentation
|
1921
|
+
#
|
1922
|
+
class AttachClusterNodeVolumeResponse < Struct.new(
|
1923
|
+
:cluster_arn,
|
1924
|
+
:node_id,
|
1925
|
+
:volume_id,
|
1926
|
+
:attach_time,
|
1927
|
+
:status,
|
1928
|
+
:device_name)
|
1929
|
+
SENSITIVE = []
|
1930
|
+
include Aws::Structure
|
1931
|
+
end
|
1932
|
+
|
1828
1933
|
# Contains a presigned URL and its associated local file path for
|
1829
1934
|
# downloading hub content artifacts.
|
1830
1935
|
#
|
@@ -2975,6 +3080,93 @@ module Aws::SageMaker
|
|
2975
3080
|
include Aws::Structure
|
2976
3081
|
end
|
2977
3082
|
|
3083
|
+
# Information about an error that occurred during the node addition
|
3084
|
+
# operation.
|
3085
|
+
#
|
3086
|
+
# @!attribute [rw] instance_group_name
|
3087
|
+
# The name of the instance group for which the error occurred.
|
3088
|
+
# @return [String]
|
3089
|
+
#
|
3090
|
+
# @!attribute [rw] error_code
|
3091
|
+
# The error code associated with the failure. Possible values include
|
3092
|
+
# `InstanceGroupNotFound` and `InvalidInstanceGroupState`.
|
3093
|
+
# @return [String]
|
3094
|
+
#
|
3095
|
+
# @!attribute [rw] failed_count
|
3096
|
+
# The number of nodes that failed to be added to the specified
|
3097
|
+
# instance group.
|
3098
|
+
# @return [Integer]
|
3099
|
+
#
|
3100
|
+
# @!attribute [rw] message
|
3101
|
+
# A descriptive message providing additional details about the error.
|
3102
|
+
# @return [String]
|
3103
|
+
#
|
3104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/BatchAddClusterNodesError AWS API Documentation
|
3105
|
+
#
|
3106
|
+
class BatchAddClusterNodesError < Struct.new(
|
3107
|
+
:instance_group_name,
|
3108
|
+
:error_code,
|
3109
|
+
:failed_count,
|
3110
|
+
:message)
|
3111
|
+
SENSITIVE = []
|
3112
|
+
include Aws::Structure
|
3113
|
+
end
|
3114
|
+
|
3115
|
+
# @!attribute [rw] cluster_name
|
3116
|
+
# The name of the HyperPod cluster to which you want to add nodes.
|
3117
|
+
# @return [String]
|
3118
|
+
#
|
3119
|
+
# @!attribute [rw] client_token
|
3120
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
3121
|
+
# idempotency of the request. This token is valid for 8 hours. If you
|
3122
|
+
# retry the request with the same client token within this timeframe
|
3123
|
+
# and the same parameters, the API returns the same set of
|
3124
|
+
# `NodeLogicalIds` with their latest status.
|
3125
|
+
#
|
3126
|
+
# **A suitable default value is auto-generated.** You should normally
|
3127
|
+
# not need to pass this option.
|
3128
|
+
# @return [String]
|
3129
|
+
#
|
3130
|
+
# @!attribute [rw] nodes_to_add
|
3131
|
+
# A list of instance groups and the number of nodes to add to each.
|
3132
|
+
# You can specify up to 5 instance groups in a single request, with a
|
3133
|
+
# maximum of 50 nodes total across all instance groups.
|
3134
|
+
# @return [Array<Types::AddClusterNodeSpecification>]
|
3135
|
+
#
|
3136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/BatchAddClusterNodesRequest AWS API Documentation
|
3137
|
+
#
|
3138
|
+
class BatchAddClusterNodesRequest < Struct.new(
|
3139
|
+
:cluster_name,
|
3140
|
+
:client_token,
|
3141
|
+
:nodes_to_add)
|
3142
|
+
SENSITIVE = []
|
3143
|
+
include Aws::Structure
|
3144
|
+
end
|
3145
|
+
|
3146
|
+
# @!attribute [rw] successful
|
3147
|
+
# A list of `NodeLogicalIDs` that were successfully added to the
|
3148
|
+
# cluster. The `NodeLogicalID` is unique per cluster and does not
|
3149
|
+
# change between instance replacements. Each entry includes a
|
3150
|
+
# `NodeLogicalId` that can be used to track the node's provisioning
|
3151
|
+
# status (with `DescribeClusterNode`), the instance group name, and
|
3152
|
+
# the current status of the node.
|
3153
|
+
# @return [Array<Types::NodeAdditionResult>]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] failed
|
3156
|
+
# A list of errors that occurred during the node addition operation.
|
3157
|
+
# Each entry includes the instance group name, error code, number of
|
3158
|
+
# failed additions, and an error message.
|
3159
|
+
# @return [Array<Types::BatchAddClusterNodesError>]
|
3160
|
+
#
|
3161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/BatchAddClusterNodesResponse AWS API Documentation
|
3162
|
+
#
|
3163
|
+
class BatchAddClusterNodesResponse < Struct.new(
|
3164
|
+
:successful,
|
3165
|
+
:failed)
|
3166
|
+
SENSITIVE = []
|
3167
|
+
include Aws::Structure
|
3168
|
+
end
|
3169
|
+
|
2978
3170
|
# Configuration to control how SageMaker captures inference data for
|
2979
3171
|
# batch transform jobs.
|
2980
3172
|
#
|
@@ -3015,6 +3207,32 @@ module Aws::SageMaker
|
|
3015
3207
|
include Aws::Structure
|
3016
3208
|
end
|
3017
3209
|
|
3210
|
+
# Information about an error that occurred when attempting to delete a
|
3211
|
+
# node identified by its `NodeLogicalId`.
|
3212
|
+
#
|
3213
|
+
# @!attribute [rw] code
|
3214
|
+
# The error code associated with the failure. Possible values include
|
3215
|
+
# `NodeLogicalIdNotFound`, `InvalidNodeStatus`, and `InternalError`.
|
3216
|
+
# @return [String]
|
3217
|
+
#
|
3218
|
+
# @!attribute [rw] message
|
3219
|
+
# A descriptive message providing additional details about the error.
|
3220
|
+
# @return [String]
|
3221
|
+
#
|
3222
|
+
# @!attribute [rw] node_logical_id
|
3223
|
+
# The `NodeLogicalId` of the node that could not be deleted.
|
3224
|
+
# @return [String]
|
3225
|
+
#
|
3226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/BatchDeleteClusterNodeLogicalIdsError AWS API Documentation
|
3227
|
+
#
|
3228
|
+
class BatchDeleteClusterNodeLogicalIdsError < Struct.new(
|
3229
|
+
:code,
|
3230
|
+
:message,
|
3231
|
+
:node_logical_id)
|
3232
|
+
SENSITIVE = []
|
3233
|
+
include Aws::Structure
|
3234
|
+
end
|
3235
|
+
|
3018
3236
|
# Represents an error encountered when deleting a node from a SageMaker
|
3019
3237
|
# HyperPod cluster.
|
3020
3238
|
#
|
@@ -3068,11 +3286,19 @@ module Aws::SageMaker
|
|
3068
3286
|
# [1]: http://aws.amazon.com/contact-us/
|
3069
3287
|
# @return [Array<String>]
|
3070
3288
|
#
|
3289
|
+
# @!attribute [rw] node_logical_ids
|
3290
|
+
# A list of `NodeLogicalIds` identifying the nodes to be deleted. You
|
3291
|
+
# can specify up to 50 `NodeLogicalIds`. You must specify either
|
3292
|
+
# `NodeLogicalIds`, `InstanceIds`, or both, with a combined maximum of
|
3293
|
+
# 50 identifiers.
|
3294
|
+
# @return [Array<String>]
|
3295
|
+
#
|
3071
3296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/BatchDeleteClusterNodesRequest AWS API Documentation
|
3072
3297
|
#
|
3073
3298
|
class BatchDeleteClusterNodesRequest < Struct.new(
|
3074
3299
|
:cluster_name,
|
3075
|
-
:node_ids
|
3300
|
+
:node_ids,
|
3301
|
+
:node_logical_ids)
|
3076
3302
|
SENSITIVE = []
|
3077
3303
|
include Aws::Structure
|
3078
3304
|
end
|
@@ -3086,11 +3312,23 @@ module Aws::SageMaker
|
|
3086
3312
|
# cluster.
|
3087
3313
|
# @return [Array<String>]
|
3088
3314
|
#
|
3315
|
+
# @!attribute [rw] failed_node_logical_ids
|
3316
|
+
# A list of `NodeLogicalIds` that could not be deleted, along with
|
3317
|
+
# error information explaining why the deletion failed.
|
3318
|
+
# @return [Array<Types::BatchDeleteClusterNodeLogicalIdsError>]
|
3319
|
+
#
|
3320
|
+
# @!attribute [rw] successful_node_logical_ids
|
3321
|
+
# A list of `NodeLogicalIds` that were successfully deleted from the
|
3322
|
+
# cluster.
|
3323
|
+
# @return [Array<String>]
|
3324
|
+
#
|
3089
3325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/BatchDeleteClusterNodesResponse AWS API Documentation
|
3090
3326
|
#
|
3091
3327
|
class BatchDeleteClusterNodesResponse < Struct.new(
|
3092
3328
|
:failed,
|
3093
|
-
:successful
|
3329
|
+
:successful,
|
3330
|
+
:failed_node_logical_ids,
|
3331
|
+
:successful_node_logical_ids)
|
3094
3332
|
SENSITIVE = []
|
3095
3333
|
include Aws::Structure
|
3096
3334
|
end
|
@@ -3565,6 +3803,27 @@ module Aws::SageMaker
|
|
3565
3803
|
include Aws::Structure
|
3566
3804
|
end
|
3567
3805
|
|
3806
|
+
# Information about the Capacity Reservation used by an instance or
|
3807
|
+
# instance group.
|
3808
|
+
#
|
3809
|
+
# @!attribute [rw] arn
|
3810
|
+
# The Amazon Resource Name (ARN) of the Capacity Reservation.
|
3811
|
+
# @return [String]
|
3812
|
+
#
|
3813
|
+
# @!attribute [rw] type
|
3814
|
+
# The type of Capacity Reservation. Valid values are `ODCR` (On-Demand
|
3815
|
+
# Capacity Reservation) or `CRG` (Capacity Reservation Group).
|
3816
|
+
# @return [String]
|
3817
|
+
#
|
3818
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CapacityReservation AWS API Documentation
|
3819
|
+
#
|
3820
|
+
class CapacityReservation < Struct.new(
|
3821
|
+
:arn,
|
3822
|
+
:type)
|
3823
|
+
SENSITIVE = []
|
3824
|
+
include Aws::Structure
|
3825
|
+
end
|
3826
|
+
|
3568
3827
|
# Specifies the type and size of the endpoint capacity to activate for a
|
3569
3828
|
# blue/green deployment, a rolling deployment, or a rollback strategy.
|
3570
3829
|
# You can specify your batches as either instance count or the overall
|
@@ -4466,6 +4725,118 @@ module Aws::SageMaker
|
|
4466
4725
|
include Aws::Structure
|
4467
4726
|
end
|
4468
4727
|
|
4728
|
+
# Detailed information about a specific event in a HyperPod cluster.
|
4729
|
+
#
|
4730
|
+
# @!attribute [rw] event_id
|
4731
|
+
# The unique identifier (UUID) of the event.
|
4732
|
+
# @return [String]
|
4733
|
+
#
|
4734
|
+
# @!attribute [rw] cluster_arn
|
4735
|
+
# The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster
|
4736
|
+
# associated with the event.
|
4737
|
+
# @return [String]
|
4738
|
+
#
|
4739
|
+
# @!attribute [rw] cluster_name
|
4740
|
+
# The name of the SageMaker HyperPod cluster associated with the
|
4741
|
+
# event.
|
4742
|
+
# @return [String]
|
4743
|
+
#
|
4744
|
+
# @!attribute [rw] instance_group_name
|
4745
|
+
# The name of the instance group associated with the event, if
|
4746
|
+
# applicable.
|
4747
|
+
# @return [String]
|
4748
|
+
#
|
4749
|
+
# @!attribute [rw] instance_id
|
4750
|
+
# The EC2 instance ID associated with the event, if applicable.
|
4751
|
+
# @return [String]
|
4752
|
+
#
|
4753
|
+
# @!attribute [rw] resource_type
|
4754
|
+
# The type of resource associated with the event. Valid values are
|
4755
|
+
# "Cluster", "InstanceGroup", or "Instance".
|
4756
|
+
# @return [String]
|
4757
|
+
#
|
4758
|
+
# @!attribute [rw] event_time
|
4759
|
+
# The timestamp when the event occurred.
|
4760
|
+
# @return [Time]
|
4761
|
+
#
|
4762
|
+
# @!attribute [rw] event_details
|
4763
|
+
# Additional details about the event, including event-specific
|
4764
|
+
# metadata.
|
4765
|
+
# @return [Types::EventDetails]
|
4766
|
+
#
|
4767
|
+
# @!attribute [rw] description
|
4768
|
+
# A human-readable description of the event.
|
4769
|
+
# @return [String]
|
4770
|
+
#
|
4771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClusterEventDetail AWS API Documentation
|
4772
|
+
#
|
4773
|
+
class ClusterEventDetail < Struct.new(
|
4774
|
+
:event_id,
|
4775
|
+
:cluster_arn,
|
4776
|
+
:cluster_name,
|
4777
|
+
:instance_group_name,
|
4778
|
+
:instance_id,
|
4779
|
+
:resource_type,
|
4780
|
+
:event_time,
|
4781
|
+
:event_details,
|
4782
|
+
:description)
|
4783
|
+
SENSITIVE = []
|
4784
|
+
include Aws::Structure
|
4785
|
+
end
|
4786
|
+
|
4787
|
+
# A summary of an event in a SageMaker HyperPod cluster.
|
4788
|
+
#
|
4789
|
+
# @!attribute [rw] event_id
|
4790
|
+
# The unique identifier (UUID) of the event.
|
4791
|
+
# @return [String]
|
4792
|
+
#
|
4793
|
+
# @!attribute [rw] cluster_arn
|
4794
|
+
# The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster
|
4795
|
+
# associated with the event.
|
4796
|
+
# @return [String]
|
4797
|
+
#
|
4798
|
+
# @!attribute [rw] cluster_name
|
4799
|
+
# The name of the SageMaker HyperPod cluster associated with the
|
4800
|
+
# event.
|
4801
|
+
# @return [String]
|
4802
|
+
#
|
4803
|
+
# @!attribute [rw] instance_group_name
|
4804
|
+
# The name of the instance group associated with the event, if
|
4805
|
+
# applicable.
|
4806
|
+
# @return [String]
|
4807
|
+
#
|
4808
|
+
# @!attribute [rw] instance_id
|
4809
|
+
# The EC2 instance ID associated with the event, if applicable.
|
4810
|
+
# @return [String]
|
4811
|
+
#
|
4812
|
+
# @!attribute [rw] resource_type
|
4813
|
+
# The type of resource associated with the event. Valid values are
|
4814
|
+
# "Cluster", "InstanceGroup", or "Instance".
|
4815
|
+
# @return [String]
|
4816
|
+
#
|
4817
|
+
# @!attribute [rw] event_time
|
4818
|
+
# The timestamp when the event occurred.
|
4819
|
+
# @return [Time]
|
4820
|
+
#
|
4821
|
+
# @!attribute [rw] description
|
4822
|
+
# A brief, human-readable description of the event.
|
4823
|
+
# @return [String]
|
4824
|
+
#
|
4825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClusterEventSummary AWS API Documentation
|
4826
|
+
#
|
4827
|
+
class ClusterEventSummary < Struct.new(
|
4828
|
+
:event_id,
|
4829
|
+
:cluster_arn,
|
4830
|
+
:cluster_name,
|
4831
|
+
:instance_group_name,
|
4832
|
+
:instance_id,
|
4833
|
+
:resource_type,
|
4834
|
+
:event_time,
|
4835
|
+
:description)
|
4836
|
+
SENSITIVE = []
|
4837
|
+
include Aws::Structure
|
4838
|
+
end
|
4839
|
+
|
4469
4840
|
# Details of an instance group in a SageMaker HyperPod cluster.
|
4470
4841
|
#
|
4471
4842
|
# @!attribute [rw] current_count
|
@@ -4562,6 +4933,16 @@ module Aws::SageMaker
|
|
4562
4933
|
# updating the AMI.
|
4563
4934
|
# @return [Types::ScheduledUpdateConfig]
|
4564
4935
|
#
|
4936
|
+
# @!attribute [rw] current_image_id
|
4937
|
+
# The ID of the Amazon Machine Image (AMI) currently in use by the
|
4938
|
+
# instance group.
|
4939
|
+
# @return [String]
|
4940
|
+
#
|
4941
|
+
# @!attribute [rw] desired_image_id
|
4942
|
+
# The ID of the Amazon Machine Image (AMI) desired for the instance
|
4943
|
+
# group.
|
4944
|
+
# @return [String]
|
4945
|
+
#
|
4565
4946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClusterInstanceGroupDetails AWS API Documentation
|
4566
4947
|
#
|
4567
4948
|
class ClusterInstanceGroupDetails < Struct.new(
|
@@ -4578,7 +4959,9 @@ module Aws::SageMaker
|
|
4578
4959
|
:training_plan_arn,
|
4579
4960
|
:training_plan_status,
|
4580
4961
|
:override_vpc_config,
|
4581
|
-
:scheduled_update_config
|
4962
|
+
:scheduled_update_config,
|
4963
|
+
:current_image_id,
|
4964
|
+
:desired_image_id)
|
4582
4965
|
SENSITIVE = []
|
4583
4966
|
include Aws::Structure
|
4584
4967
|
end
|
@@ -4688,6 +5071,33 @@ module Aws::SageMaker
|
|
4688
5071
|
# update the AMI.
|
4689
5072
|
# @return [Types::ScheduledUpdateConfig]
|
4690
5073
|
#
|
5074
|
+
# @!attribute [rw] image_id
|
5075
|
+
# When configuring your HyperPod cluster, you can specify an image ID
|
5076
|
+
# using one of the following options:
|
5077
|
+
#
|
5078
|
+
# * `HyperPodPublicAmiId`: Use a HyperPod public AMI
|
5079
|
+
#
|
5080
|
+
# * `CustomAmiId`: Use your custom AMI
|
5081
|
+
#
|
5082
|
+
# * `default`: Use the default latest system image
|
5083
|
+
#
|
5084
|
+
# f you choose to use a custom AMI (`CustomAmiId`), ensure it meets
|
5085
|
+
# the following requirements:
|
5086
|
+
#
|
5087
|
+
# * Encryption: The custom AMI must be unencrypted.
|
5088
|
+
#
|
5089
|
+
# * Ownership: The custom AMI must be owned by the same Amazon Web
|
5090
|
+
# Services account that is creating the HyperPod cluster.
|
5091
|
+
#
|
5092
|
+
# * Volume support: Only the primary AMI snapshot volume is supported;
|
5093
|
+
# additional AMI volumes are not supported.
|
5094
|
+
#
|
5095
|
+
# When updating the instance group's AMI through the
|
5096
|
+
# `UpdateClusterSoftware` operation, if an instance group uses a
|
5097
|
+
# custom AMI, you must provide an `ImageId` or use the default as
|
5098
|
+
# input.
|
5099
|
+
# @return [String]
|
5100
|
+
#
|
4691
5101
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClusterInstanceGroupSpecification AWS API Documentation
|
4692
5102
|
#
|
4693
5103
|
class ClusterInstanceGroupSpecification < Struct.new(
|
@@ -4701,7 +5111,8 @@ module Aws::SageMaker
|
|
4701
5111
|
:on_start_deep_health_checks,
|
4702
5112
|
:training_plan_arn,
|
4703
5113
|
:override_vpc_config,
|
4704
|
-
:scheduled_update_config
|
5114
|
+
:scheduled_update_config,
|
5115
|
+
:image_id)
|
4705
5116
|
SENSITIVE = []
|
4706
5117
|
include Aws::Structure
|
4707
5118
|
end
|
@@ -4811,6 +5222,37 @@ module Aws::SageMaker
|
|
4811
5222
|
include Aws::Structure
|
4812
5223
|
end
|
4813
5224
|
|
5225
|
+
# Metadata information about a SageMaker HyperPod cluster showing
|
5226
|
+
# information about the cluster level operations, such as creating,
|
5227
|
+
# updating, and deleting.
|
5228
|
+
#
|
5229
|
+
# @!attribute [rw] failure_message
|
5230
|
+
# An error message describing why the cluster level operation (such as
|
5231
|
+
# creating, updating, or deleting) failed.
|
5232
|
+
# @return [String]
|
5233
|
+
#
|
5234
|
+
# @!attribute [rw] eks_role_access_entries
|
5235
|
+
# A list of Amazon EKS IAM role ARNs associated with the cluster. This
|
5236
|
+
# is created by SageMaker HyperPod on your behalf and only applies for
|
5237
|
+
# EKS-orchestrated clusters.
|
5238
|
+
# @return [Array<String>]
|
5239
|
+
#
|
5240
|
+
# @!attribute [rw] slr_access_entry
|
5241
|
+
# The Service-Linked Role (SLR) associated with the cluster. This is
|
5242
|
+
# created by SageMaker HyperPod on your behalf and only applies for
|
5243
|
+
# EKS-orchestrated clusters.
|
5244
|
+
# @return [String]
|
5245
|
+
#
|
5246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClusterMetadata AWS API Documentation
|
5247
|
+
#
|
5248
|
+
class ClusterMetadata < Struct.new(
|
5249
|
+
:failure_message,
|
5250
|
+
:eks_role_access_entries,
|
5251
|
+
:slr_access_entry)
|
5252
|
+
SENSITIVE = []
|
5253
|
+
include Aws::Structure
|
5254
|
+
end
|
5255
|
+
|
4814
5256
|
# Details of an instance (also called a *node* interchangeably) in a
|
4815
5257
|
# SageMaker HyperPod cluster.
|
4816
5258
|
#
|
@@ -4822,6 +5264,13 @@ module Aws::SageMaker
|
|
4822
5264
|
# The ID of the instance.
|
4823
5265
|
# @return [String]
|
4824
5266
|
#
|
5267
|
+
# @!attribute [rw] node_logical_id
|
5268
|
+
# A unique identifier for the node that persists throughout its
|
5269
|
+
# lifecycle, from provisioning request to termination. This identifier
|
5270
|
+
# can be used to track the node even before it has an assigned
|
5271
|
+
# `InstanceId`.
|
5272
|
+
# @return [String]
|
5273
|
+
#
|
4825
5274
|
# @!attribute [rw] instance_status
|
4826
5275
|
# The status of the instance.
|
4827
5276
|
# @return [Types::ClusterInstanceStatusDetails]
|
@@ -4879,11 +5328,21 @@ module Aws::SageMaker
|
|
4879
5328
|
# The placement details of the SageMaker HyperPod cluster node.
|
4880
5329
|
# @return [Types::ClusterInstancePlacement]
|
4881
5330
|
#
|
5331
|
+
# @!attribute [rw] current_image_id
|
5332
|
+
# The ID of the Amazon Machine Image (AMI) currently in use by the
|
5333
|
+
# node.
|
5334
|
+
# @return [String]
|
5335
|
+
#
|
5336
|
+
# @!attribute [rw] desired_image_id
|
5337
|
+
# The ID of the Amazon Machine Image (AMI) desired for the node.
|
5338
|
+
# @return [String]
|
5339
|
+
#
|
4882
5340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ClusterNodeDetails AWS API Documentation
|
4883
5341
|
#
|
4884
5342
|
class ClusterNodeDetails < Struct.new(
|
4885
5343
|
:instance_group_name,
|
4886
5344
|
:instance_id,
|
5345
|
+
:node_logical_id,
|
4887
5346
|
:instance_status,
|
4888
5347
|
:instance_type,
|
4889
5348
|
:launch_time,
|
@@ -4895,7 +5354,9 @@ module Aws::SageMaker
|
|
4895
5354
|
:private_primary_ip,
|
4896
5355
|
:private_primary_ipv_6,
|
4897
5356
|
:private_dns_hostname,
|
4898
|
-
:placement
|
5357
|
+
:placement,
|
5358
|
+
:current_image_id,
|
5359
|
+
:desired_image_id)
|
4899
5360
|
SENSITIVE = []
|
4900
5361
|
include Aws::Structure
|
4901
5362
|
end
|
@@ -4911,6 +5372,15 @@ module Aws::SageMaker
|
|
4911
5372
|
# The ID of the instance.
|
4912
5373
|
# @return [String]
|
4913
5374
|
#
|
5375
|
+
# @!attribute [rw] node_logical_id
|
5376
|
+
# A unique identifier for the node that persists throughout its
|
5377
|
+
# lifecycle, from provisioning request to termination. This identifier
|
5378
|
+
# can be used to track the node even before it has an assigned
|
5379
|
+
# `InstanceId`. This field is only included when
|
5380
|
+
# `IncludeNodeLogicalIds` is set to `True` in the `ListClusterNodes`
|
5381
|
+
# request.
|
5382
|
+
# @return [String]
|
5383
|
+
#
|
4914
5384
|
# @!attribute [rw] instance_type
|
4915
5385
|
# The type of the instance.
|
4916
5386
|
# @return [String]
|
@@ -4933,6 +5403,7 @@ module Aws::SageMaker
|
|
4933
5403
|
class ClusterNodeSummary < Struct.new(
|
4934
5404
|
:instance_group_name,
|
4935
5405
|
:instance_id,
|
5406
|
+
:node_logical_id,
|
4936
5407
|
:instance_type,
|
4937
5408
|
:launch_time,
|
4938
5409
|
:last_software_update_time,
|
@@ -6765,6 +7236,21 @@ module Aws::SageMaker
|
|
6765
7236
|
# cluster instances.
|
6766
7237
|
# @return [String]
|
6767
7238
|
#
|
7239
|
+
# @!attribute [rw] node_provisioning_mode
|
7240
|
+
# The mode for provisioning nodes in the cluster. You can specify the
|
7241
|
+
# following modes:
|
7242
|
+
#
|
7243
|
+
# * **Continuous**: Scaling behavior that enables 1) concurrent
|
7244
|
+
# operation execution within instance groups, 2) continuous retry
|
7245
|
+
# mechanisms for failed operations, 3) enhanced customer visibility
|
7246
|
+
# into cluster events through detailed event streams, 4) partial
|
7247
|
+
# provisioning capabilities. Your clusters and instance groups
|
7248
|
+
# remain `InService` while scaling. This mode is only supported for
|
7249
|
+
# EKS orchestrated clusters.
|
7250
|
+
#
|
7251
|
+
# ^
|
7252
|
+
# @return [String]
|
7253
|
+
#
|
6768
7254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateClusterRequest AWS API Documentation
|
6769
7255
|
#
|
6770
7256
|
class CreateClusterRequest < Struct.new(
|
@@ -6774,7 +7260,8 @@ module Aws::SageMaker
|
|
6774
7260
|
:vpc_config,
|
6775
7261
|
:tags,
|
6776
7262
|
:orchestrator,
|
6777
|
-
:node_recovery
|
7263
|
+
:node_recovery,
|
7264
|
+
:node_provisioning_mode)
|
6778
7265
|
SENSITIVE = []
|
6779
7266
|
include Aws::Structure
|
6780
7267
|
end
|
@@ -14323,6 +14810,39 @@ module Aws::SageMaker
|
|
14323
14810
|
include Aws::Structure
|
14324
14811
|
end
|
14325
14812
|
|
14813
|
+
# @!attribute [rw] event_id
|
14814
|
+
# The unique identifier (UUID) of the event to describe. This ID can
|
14815
|
+
# be obtained from the `ListClusterEvents` operation.
|
14816
|
+
# @return [String]
|
14817
|
+
#
|
14818
|
+
# @!attribute [rw] cluster_name
|
14819
|
+
# The name or Amazon Resource Name (ARN) of the HyperPod cluster
|
14820
|
+
# associated with the event.
|
14821
|
+
# @return [String]
|
14822
|
+
#
|
14823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeClusterEventRequest AWS API Documentation
|
14824
|
+
#
|
14825
|
+
class DescribeClusterEventRequest < Struct.new(
|
14826
|
+
:event_id,
|
14827
|
+
:cluster_name)
|
14828
|
+
SENSITIVE = []
|
14829
|
+
include Aws::Structure
|
14830
|
+
end
|
14831
|
+
|
14832
|
+
# @!attribute [rw] event_details
|
14833
|
+
# Detailed information about the requested cluster event, including
|
14834
|
+
# event metadata for various resource types such as `Cluster`,
|
14835
|
+
# `InstanceGroup`, `Instance`, and their associated attributes.
|
14836
|
+
# @return [Types::ClusterEventDetail]
|
14837
|
+
#
|
14838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeClusterEventResponse AWS API Documentation
|
14839
|
+
#
|
14840
|
+
class DescribeClusterEventResponse < Struct.new(
|
14841
|
+
:event_details)
|
14842
|
+
SENSITIVE = []
|
14843
|
+
include Aws::Structure
|
14844
|
+
end
|
14845
|
+
|
14326
14846
|
# @!attribute [rw] cluster_name
|
14327
14847
|
# The string name or the Amazon Resource Name (ARN) of the SageMaker
|
14328
14848
|
# HyperPod cluster in which the node is.
|
@@ -14332,11 +14852,19 @@ module Aws::SageMaker
|
|
14332
14852
|
# The ID of the SageMaker HyperPod cluster node.
|
14333
14853
|
# @return [String]
|
14334
14854
|
#
|
14855
|
+
# @!attribute [rw] node_logical_id
|
14856
|
+
# The logical identifier of the node to describe. You can specify
|
14857
|
+
# either `NodeLogicalId` or `InstanceId`, but not both.
|
14858
|
+
# `NodeLogicalId` can be used to describe nodes that are still being
|
14859
|
+
# provisioned and don't yet have an `InstanceId` assigned.
|
14860
|
+
# @return [String]
|
14861
|
+
#
|
14335
14862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeClusterNodeRequest AWS API Documentation
|
14336
14863
|
#
|
14337
14864
|
class DescribeClusterNodeRequest < Struct.new(
|
14338
14865
|
:cluster_name,
|
14339
|
-
:node_id
|
14866
|
+
:node_id,
|
14867
|
+
:node_logical_id)
|
14340
14868
|
SENSITIVE = []
|
14341
14869
|
include Aws::Structure
|
14342
14870
|
end
|
@@ -14416,6 +14944,10 @@ module Aws::SageMaker
|
|
14416
14944
|
# cluster.
|
14417
14945
|
# @return [String]
|
14418
14946
|
#
|
14947
|
+
# @!attribute [rw] node_provisioning_mode
|
14948
|
+
# The mode used for provisioning nodes in the cluster.
|
14949
|
+
# @return [String]
|
14950
|
+
#
|
14419
14951
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeClusterResponse AWS API Documentation
|
14420
14952
|
#
|
14421
14953
|
class DescribeClusterResponse < Struct.new(
|
@@ -14428,7 +14960,8 @@ module Aws::SageMaker
|
|
14428
14960
|
:restricted_instance_groups,
|
14429
14961
|
:vpc_config,
|
14430
14962
|
:orchestrator,
|
14431
|
-
:node_recovery
|
14963
|
+
:node_recovery,
|
14964
|
+
:node_provisioning_mode)
|
14432
14965
|
SENSITIVE = []
|
14433
14966
|
include Aws::Structure
|
14434
14967
|
end
|
@@ -20389,6 +20922,73 @@ module Aws::SageMaker
|
|
20389
20922
|
include Aws::Structure
|
20390
20923
|
end
|
20391
20924
|
|
20925
|
+
# @!attribute [rw] cluster_arn
|
20926
|
+
# The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster
|
20927
|
+
# containing the target node. Your cluster must use EKS as the
|
20928
|
+
# orchestration and be in the `InService` state.
|
20929
|
+
# @return [String]
|
20930
|
+
#
|
20931
|
+
# @!attribute [rw] node_id
|
20932
|
+
# The unique identifier of the cluster node from which you want to
|
20933
|
+
# detach the volume.
|
20934
|
+
# @return [String]
|
20935
|
+
#
|
20936
|
+
# @!attribute [rw] volume_id
|
20937
|
+
# The unique identifier of your EBS volume that you want to detach.
|
20938
|
+
# Your volume must be currently attached to the specified node.
|
20939
|
+
# @return [String]
|
20940
|
+
#
|
20941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DetachClusterNodeVolumeRequest AWS API Documentation
|
20942
|
+
#
|
20943
|
+
class DetachClusterNodeVolumeRequest < Struct.new(
|
20944
|
+
:cluster_arn,
|
20945
|
+
:node_id,
|
20946
|
+
:volume_id)
|
20947
|
+
SENSITIVE = []
|
20948
|
+
include Aws::Structure
|
20949
|
+
end
|
20950
|
+
|
20951
|
+
# @!attribute [rw] cluster_arn
|
20952
|
+
# The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster
|
20953
|
+
# where the volume detachment operation was performed.
|
20954
|
+
# @return [String]
|
20955
|
+
#
|
20956
|
+
# @!attribute [rw] node_id
|
20957
|
+
# The unique identifier of the cluster node from which your volume was
|
20958
|
+
# detached.
|
20959
|
+
# @return [String]
|
20960
|
+
#
|
20961
|
+
# @!attribute [rw] volume_id
|
20962
|
+
# The unique identifier of your EBS volume that was detached.
|
20963
|
+
# @return [String]
|
20964
|
+
#
|
20965
|
+
# @!attribute [rw] attach_time
|
20966
|
+
# The original timestamp when your volume was initially attached to
|
20967
|
+
# the node.
|
20968
|
+
# @return [Time]
|
20969
|
+
#
|
20970
|
+
# @!attribute [rw] status
|
20971
|
+
# The current status of your volume detachment operation.
|
20972
|
+
# @return [String]
|
20973
|
+
#
|
20974
|
+
# @!attribute [rw] device_name
|
20975
|
+
# The device name assigned to your attached volume on the target
|
20976
|
+
# instance.
|
20977
|
+
# @return [String]
|
20978
|
+
#
|
20979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DetachClusterNodeVolumeResponse AWS API Documentation
|
20980
|
+
#
|
20981
|
+
class DetachClusterNodeVolumeResponse < Struct.new(
|
20982
|
+
:cluster_arn,
|
20983
|
+
:node_id,
|
20984
|
+
:volume_id,
|
20985
|
+
:attach_time,
|
20986
|
+
:status,
|
20987
|
+
:device_name)
|
20988
|
+
SENSITIVE = []
|
20989
|
+
include Aws::Structure
|
20990
|
+
end
|
20991
|
+
|
20392
20992
|
# Information of a particular device.
|
20393
20993
|
#
|
20394
20994
|
# @!attribute [rw] device_name
|
@@ -22158,6 +22758,61 @@ module Aws::SageMaker
|
|
22158
22758
|
include Aws::Structure
|
22159
22759
|
end
|
22160
22760
|
|
22761
|
+
# Detailed information about a specific event, including event metadata.
|
22762
|
+
#
|
22763
|
+
# @!attribute [rw] event_metadata
|
22764
|
+
# Metadata specific to the event, which may include information about
|
22765
|
+
# the cluster, instance group, or instance involved.
|
22766
|
+
# @return [Types::EventMetadata]
|
22767
|
+
#
|
22768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/EventDetails AWS API Documentation
|
22769
|
+
#
|
22770
|
+
class EventDetails < Struct.new(
|
22771
|
+
:event_metadata)
|
22772
|
+
SENSITIVE = []
|
22773
|
+
include Aws::Structure
|
22774
|
+
end
|
22775
|
+
|
22776
|
+
# Metadata associated with a cluster event, which may include details
|
22777
|
+
# about various resource types.
|
22778
|
+
#
|
22779
|
+
# @note EventMetadata is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EventMetadata corresponding to the set member.
|
22780
|
+
#
|
22781
|
+
# @!attribute [rw] cluster
|
22782
|
+
# Metadata specific to cluster-level events.
|
22783
|
+
# @return [Types::ClusterMetadata]
|
22784
|
+
#
|
22785
|
+
# @!attribute [rw] instance_group
|
22786
|
+
# Metadata specific to instance group-level events.
|
22787
|
+
# @return [Types::InstanceGroupMetadata]
|
22788
|
+
#
|
22789
|
+
# @!attribute [rw] instance_group_scaling
|
22790
|
+
# Metadata related to instance group scaling events.
|
22791
|
+
# @return [Types::InstanceGroupScalingMetadata]
|
22792
|
+
#
|
22793
|
+
# @!attribute [rw] instance
|
22794
|
+
# Metadata specific to instance-level events.
|
22795
|
+
# @return [Types::InstanceMetadata]
|
22796
|
+
#
|
22797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/EventMetadata AWS API Documentation
|
22798
|
+
#
|
22799
|
+
class EventMetadata < Struct.new(
|
22800
|
+
:cluster,
|
22801
|
+
:instance_group,
|
22802
|
+
:instance_group_scaling,
|
22803
|
+
:instance,
|
22804
|
+
:unknown)
|
22805
|
+
SENSITIVE = []
|
22806
|
+
include Aws::Structure
|
22807
|
+
include Aws::Structure::Union
|
22808
|
+
|
22809
|
+
class Cluster < EventMetadata; end
|
22810
|
+
class InstanceGroup < EventMetadata; end
|
22811
|
+
class InstanceGroupScaling < EventMetadata; end
|
22812
|
+
class Instance < EventMetadata; end
|
22813
|
+
class Unknown < EventMetadata; end
|
22814
|
+
end
|
22815
|
+
|
22161
22816
|
# The properties of an experiment as returned by the [Search][1] API.
|
22162
22817
|
# For information about experiments, see the [CreateExperiment][2] API.
|
22163
22818
|
#
|
@@ -27396,6 +28051,117 @@ module Aws::SageMaker
|
|
27396
28051
|
include Aws::Structure
|
27397
28052
|
end
|
27398
28053
|
|
28054
|
+
# Metadata information about an instance group in a SageMaker HyperPod
|
28055
|
+
# cluster.
|
28056
|
+
#
|
28057
|
+
# @!attribute [rw] failure_message
|
28058
|
+
# An error message describing why the instance group level operation
|
28059
|
+
# (such as creating, scaling, or deleting) failed.
|
28060
|
+
# @return [String]
|
28061
|
+
#
|
28062
|
+
# @!attribute [rw] availability_zone_id
|
28063
|
+
# The ID of the Availability Zone where the instance group is located.
|
28064
|
+
# @return [String]
|
28065
|
+
#
|
28066
|
+
# @!attribute [rw] capacity_reservation
|
28067
|
+
# Information about the Capacity Reservation used by the instance
|
28068
|
+
# group.
|
28069
|
+
# @return [Types::CapacityReservation]
|
28070
|
+
#
|
28071
|
+
# @!attribute [rw] subnet_id
|
28072
|
+
# The ID of the subnet where the instance group is located.
|
28073
|
+
# @return [String]
|
28074
|
+
#
|
28075
|
+
# @!attribute [rw] security_group_ids
|
28076
|
+
# A list of security group IDs associated with the instance group.
|
28077
|
+
# @return [Array<String>]
|
28078
|
+
#
|
28079
|
+
# @!attribute [rw] ami_override
|
28080
|
+
# If you use a custom Amazon Machine Image (AMI) for the instance
|
28081
|
+
# group, this field shows the ID of the custom AMI.
|
28082
|
+
# @return [String]
|
28083
|
+
#
|
28084
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/InstanceGroupMetadata AWS API Documentation
|
28085
|
+
#
|
28086
|
+
class InstanceGroupMetadata < Struct.new(
|
28087
|
+
:failure_message,
|
28088
|
+
:availability_zone_id,
|
28089
|
+
:capacity_reservation,
|
28090
|
+
:subnet_id,
|
28091
|
+
:security_group_ids,
|
28092
|
+
:ami_override)
|
28093
|
+
SENSITIVE = []
|
28094
|
+
include Aws::Structure
|
28095
|
+
end
|
28096
|
+
|
28097
|
+
# Metadata information about scaling operations for an instance group.
|
28098
|
+
#
|
28099
|
+
# @!attribute [rw] instance_count
|
28100
|
+
# The current number of instances in the group.
|
28101
|
+
# @return [Integer]
|
28102
|
+
#
|
28103
|
+
# @!attribute [rw] target_count
|
28104
|
+
# The desired number of instances for the group after scaling.
|
28105
|
+
# @return [Integer]
|
28106
|
+
#
|
28107
|
+
# @!attribute [rw] failure_message
|
28108
|
+
# An error message describing why the scaling operation failed, if
|
28109
|
+
# applicable.
|
28110
|
+
# @return [String]
|
28111
|
+
#
|
28112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/InstanceGroupScalingMetadata AWS API Documentation
|
28113
|
+
#
|
28114
|
+
class InstanceGroupScalingMetadata < Struct.new(
|
28115
|
+
:instance_count,
|
28116
|
+
:target_count,
|
28117
|
+
:failure_message)
|
28118
|
+
SENSITIVE = []
|
28119
|
+
include Aws::Structure
|
28120
|
+
end
|
28121
|
+
|
28122
|
+
# Metadata information about an instance in a HyperPod cluster.
|
28123
|
+
#
|
28124
|
+
# @!attribute [rw] customer_eni
|
28125
|
+
# The ID of the customer-managed Elastic Network Interface (ENI)
|
28126
|
+
# associated with the instance.
|
28127
|
+
# @return [String]
|
28128
|
+
#
|
28129
|
+
# @!attribute [rw] additional_enis
|
28130
|
+
# Information about additional Elastic Network Interfaces (ENIs)
|
28131
|
+
# associated with the instance.
|
28132
|
+
# @return [Types::AdditionalEnis]
|
28133
|
+
#
|
28134
|
+
# @!attribute [rw] capacity_reservation
|
28135
|
+
# Information about the Capacity Reservation used by the instance.
|
28136
|
+
# @return [Types::CapacityReservation]
|
28137
|
+
#
|
28138
|
+
# @!attribute [rw] failure_message
|
28139
|
+
# An error message describing why the instance creation or update
|
28140
|
+
# failed, if applicable.
|
28141
|
+
# @return [String]
|
28142
|
+
#
|
28143
|
+
# @!attribute [rw] lcs_execution_state
|
28144
|
+
# The execution state of the Lifecycle Script (LCS) for the instance.
|
28145
|
+
# @return [String]
|
28146
|
+
#
|
28147
|
+
# @!attribute [rw] node_logical_id
|
28148
|
+
# The unique logical identifier of the node within the cluster. The ID
|
28149
|
+
# used here is the same object as in the `BatchAddClusterNodes` API.
|
28150
|
+
# @return [String]
|
28151
|
+
#
|
28152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/InstanceMetadata AWS API Documentation
|
28153
|
+
#
|
28154
|
+
class InstanceMetadata < Struct.new(
|
28155
|
+
:customer_eni,
|
28156
|
+
:additional_enis,
|
28157
|
+
:capacity_reservation,
|
28158
|
+
:failure_message,
|
28159
|
+
:lcs_execution_state,
|
28160
|
+
:node_logical_id)
|
28161
|
+
SENSITIVE = []
|
28162
|
+
include Aws::Structure
|
28163
|
+
end
|
28164
|
+
|
27399
28165
|
# Information on the IMDS configuration of the notebook instance
|
27400
28166
|
#
|
27401
28167
|
# @!attribute [rw] minimum_instance_metadata_service_version
|
@@ -28937,6 +29703,91 @@ module Aws::SageMaker
|
|
28937
29703
|
include Aws::Structure
|
28938
29704
|
end
|
28939
29705
|
|
29706
|
+
# @!attribute [rw] cluster_name
|
29707
|
+
# The name or Amazon Resource Name (ARN) of the HyperPod cluster for
|
29708
|
+
# which to list events.
|
29709
|
+
# @return [String]
|
29710
|
+
#
|
29711
|
+
# @!attribute [rw] instance_group_name
|
29712
|
+
# The name of the instance group to filter events. If specified, only
|
29713
|
+
# events related to this instance group are returned.
|
29714
|
+
# @return [String]
|
29715
|
+
#
|
29716
|
+
# @!attribute [rw] node_id
|
29717
|
+
# The EC2 instance ID to filter events. If specified, only events
|
29718
|
+
# related to this instance are returned.
|
29719
|
+
# @return [String]
|
29720
|
+
#
|
29721
|
+
# @!attribute [rw] event_time_after
|
29722
|
+
# The start of the time range for filtering events. Only events that
|
29723
|
+
# occurred after this time are included in the results.
|
29724
|
+
# @return [Time]
|
29725
|
+
#
|
29726
|
+
# @!attribute [rw] event_time_before
|
29727
|
+
# The end of the time range for filtering events. Only events that
|
29728
|
+
# occurred before this time are included in the results.
|
29729
|
+
# @return [Time]
|
29730
|
+
#
|
29731
|
+
# @!attribute [rw] sort_by
|
29732
|
+
# The field to use for sorting the event list. Currently, the only
|
29733
|
+
# supported value is `EventTime`.
|
29734
|
+
# @return [String]
|
29735
|
+
#
|
29736
|
+
# @!attribute [rw] sort_order
|
29737
|
+
# The order in which to sort the results. Valid values are `Ascending`
|
29738
|
+
# or `Descending` (the default is `Descending`).
|
29739
|
+
# @return [String]
|
29740
|
+
#
|
29741
|
+
# @!attribute [rw] resource_type
|
29742
|
+
# The type of resource for which to filter events. Valid values are
|
29743
|
+
# `Cluster`, `InstanceGroup`, or `Instance`.
|
29744
|
+
# @return [String]
|
29745
|
+
#
|
29746
|
+
# @!attribute [rw] max_results
|
29747
|
+
# The maximum number of events to return in the response. Valid range
|
29748
|
+
# is 1 to 100.
|
29749
|
+
# @return [Integer]
|
29750
|
+
#
|
29751
|
+
# @!attribute [rw] next_token
|
29752
|
+
# A token to retrieve the next set of results. This token is obtained
|
29753
|
+
# from the output of a previous `ListClusterEvents` call.
|
29754
|
+
# @return [String]
|
29755
|
+
#
|
29756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListClusterEventsRequest AWS API Documentation
|
29757
|
+
#
|
29758
|
+
class ListClusterEventsRequest < Struct.new(
|
29759
|
+
:cluster_name,
|
29760
|
+
:instance_group_name,
|
29761
|
+
:node_id,
|
29762
|
+
:event_time_after,
|
29763
|
+
:event_time_before,
|
29764
|
+
:sort_by,
|
29765
|
+
:sort_order,
|
29766
|
+
:resource_type,
|
29767
|
+
:max_results,
|
29768
|
+
:next_token)
|
29769
|
+
SENSITIVE = []
|
29770
|
+
include Aws::Structure
|
29771
|
+
end
|
29772
|
+
|
29773
|
+
# @!attribute [rw] next_token
|
29774
|
+
# A token to retrieve the next set of results. Include this token in
|
29775
|
+
# subsequent `ListClusterEvents` calls to fetch more events.
|
29776
|
+
# @return [String]
|
29777
|
+
#
|
29778
|
+
# @!attribute [rw] events
|
29779
|
+
# A list of event summaries matching the specified criteria.
|
29780
|
+
# @return [Array<Types::ClusterEventSummary>]
|
29781
|
+
#
|
29782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListClusterEventsResponse AWS API Documentation
|
29783
|
+
#
|
29784
|
+
class ListClusterEventsResponse < Struct.new(
|
29785
|
+
:next_token,
|
29786
|
+
:events)
|
29787
|
+
SENSITIVE = []
|
29788
|
+
include Aws::Structure
|
29789
|
+
end
|
29790
|
+
|
28940
29791
|
# @!attribute [rw] cluster_name
|
28941
29792
|
# The string name or the Amazon Resource Name (ARN) of the SageMaker
|
28942
29793
|
# HyperPod cluster in which you want to retrieve the list of nodes.
|
@@ -29005,6 +29856,13 @@ module Aws::SageMaker
|
|
29005
29856
|
# The sort order for results. The default value is `Ascending`.
|
29006
29857
|
# @return [String]
|
29007
29858
|
#
|
29859
|
+
# @!attribute [rw] include_node_logical_ids
|
29860
|
+
# Specifies whether to include nodes that are still being provisioned
|
29861
|
+
# in the response. When set to true, the response includes all nodes
|
29862
|
+
# regardless of their provisioning status. When set to `False`
|
29863
|
+
# (default), only nodes with assigned `InstanceIds` are returned.
|
29864
|
+
# @return [Boolean]
|
29865
|
+
#
|
29008
29866
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListClusterNodesRequest AWS API Documentation
|
29009
29867
|
#
|
29010
29868
|
class ListClusterNodesRequest < Struct.new(
|
@@ -29015,7 +29873,8 @@ module Aws::SageMaker
|
|
29015
29873
|
:max_results,
|
29016
29874
|
:next_token,
|
29017
29875
|
:sort_by,
|
29018
|
-
:sort_order
|
29876
|
+
:sort_order,
|
29877
|
+
:include_node_logical_ids)
|
29019
29878
|
SENSITIVE = []
|
29020
29879
|
include Aws::Structure
|
29021
29880
|
end
|
@@ -37560,6 +38419,33 @@ module Aws::SageMaker
|
|
37560
38419
|
include Aws::Structure
|
37561
38420
|
end
|
37562
38421
|
|
38422
|
+
# Information about a node that was successfully added to the cluster.
|
38423
|
+
#
|
38424
|
+
# @!attribute [rw] node_logical_id
|
38425
|
+
# A unique identifier assigned to the node that can be used to track
|
38426
|
+
# its provisioning status through the `DescribeClusterNode` operation.
|
38427
|
+
# @return [String]
|
38428
|
+
#
|
38429
|
+
# @!attribute [rw] instance_group_name
|
38430
|
+
# The name of the instance group to which the node was added.
|
38431
|
+
# @return [String]
|
38432
|
+
#
|
38433
|
+
# @!attribute [rw] status
|
38434
|
+
# The current status of the node. Possible values include `Pending`,
|
38435
|
+
# `Running`, `Failed`, `ShuttingDown`, `SystemUpdating`,
|
38436
|
+
# `DeepHealthCheckInProgress`, and `NotFound`.
|
38437
|
+
# @return [String]
|
38438
|
+
#
|
38439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/NodeAdditionResult AWS API Documentation
|
38440
|
+
#
|
38441
|
+
class NodeAdditionResult < Struct.new(
|
38442
|
+
:node_logical_id,
|
38443
|
+
:instance_group_name,
|
38444
|
+
:status)
|
38445
|
+
SENSITIVE = []
|
38446
|
+
include Aws::Structure
|
38447
|
+
end
|
38448
|
+
|
37563
38449
|
# Provides a summary of a notebook instance lifecycle configuration.
|
37564
38450
|
#
|
37565
38451
|
# @!attribute [rw] notebook_instance_lifecycle_config_name
|
@@ -48995,8 +49881,9 @@ module Aws::SageMaker
|
|
48995
49881
|
# @return [String]
|
48996
49882
|
#
|
48997
49883
|
# @!attribute [rw] single_sign_on_application_arn
|
48998
|
-
# The ARN of the application managed by
|
48999
|
-
# Unified Studio in the Amazon Web Services IAM Identity
|
49884
|
+
# The ARN of the Amazon DataZone application managed by Amazon
|
49885
|
+
# SageMaker Unified Studio in the Amazon Web Services IAM Identity
|
49886
|
+
# Center.
|
49000
49887
|
# @return [String]
|
49001
49888
|
#
|
49002
49889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UnifiedStudioSettings AWS API Documentation
|
@@ -49257,12 +50144,40 @@ module Aws::SageMaker
|
|
49257
50144
|
# The configuration to use when updating the AMI versions.
|
49258
50145
|
# @return [Types::DeploymentConfiguration]
|
49259
50146
|
#
|
50147
|
+
# @!attribute [rw] image_id
|
50148
|
+
# When configuring your HyperPod cluster, you can specify an image ID
|
50149
|
+
# using one of the following options:
|
50150
|
+
#
|
50151
|
+
# * `HyperPodPublicAmiId`: Use a HyperPod public AMI
|
50152
|
+
#
|
50153
|
+
# * `CustomAmiId`: Use your custom AMI
|
50154
|
+
#
|
50155
|
+
# * `default`: Use the default latest system image
|
50156
|
+
#
|
50157
|
+
# f you choose to use a custom AMI (`CustomAmiId`), ensure it meets
|
50158
|
+
# the following requirements:
|
50159
|
+
#
|
50160
|
+
# * Encryption: The custom AMI must be unencrypted.
|
50161
|
+
#
|
50162
|
+
# * Ownership: The custom AMI must be owned by the same Amazon Web
|
50163
|
+
# Services account that is creating the HyperPod cluster.
|
50164
|
+
#
|
50165
|
+
# * Volume support: Only the primary AMI snapshot volume is supported;
|
50166
|
+
# additional AMI volumes are not supported.
|
50167
|
+
#
|
50168
|
+
# When updating the instance group's AMI through the
|
50169
|
+
# `UpdateClusterSoftware` operation, if an instance group uses a
|
50170
|
+
# custom AMI, you must provide an `ImageId` or use the default as
|
50171
|
+
# input.
|
50172
|
+
# @return [String]
|
50173
|
+
#
|
49260
50174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateClusterSoftwareRequest AWS API Documentation
|
49261
50175
|
#
|
49262
50176
|
class UpdateClusterSoftwareRequest < Struct.new(
|
49263
50177
|
:cluster_name,
|
49264
50178
|
:instance_groups,
|
49265
|
-
:deployment_config
|
50179
|
+
:deployment_config,
|
50180
|
+
:image_id)
|
49266
50181
|
SENSITIVE = []
|
49267
50182
|
include Aws::Structure
|
49268
50183
|
end
|