AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
describe-cluster
--cluster-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--cluster-name
(string)
The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
ClusterArn -> (string)
The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
ClusterName -> (string)
The name of the SageMaker HyperPod cluster.
ClusterStatus -> (string)
The status of the SageMaker HyperPod cluster.
CreationTime -> (timestamp)
The time when the SageMaker Cluster is created.
FailureMessage -> (string)
The failure message of the SageMaker HyperPod cluster.
InstanceGroups -> (list)
The instance groups of the SageMaker HyperPod cluster.
(structure)
Details of an instance group in a SageMaker HyperPod cluster.
CurrentCount -> (integer)
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.TargetCount -> (integer)
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.InstanceGroupName -> (string)
The name of the instance group of a SageMaker HyperPod cluster.InstanceType -> (string)
The instance type of the instance group of a SageMaker HyperPod cluster.LifeCycleConfig -> (structure)
Details of LifeCycle configuration for the instance group.
SourceS3Uri -> (string)
An Amazon S3 bucket path where your lifecycle scripts are stored.
Warning
Make sure that the S3 bucket path starts withs3://sagemaker-
. The IAM role for SageMaker HyperPod has the managed `AmazonSageMakerClusterInstanceRolePolicy
https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-cluster.html`__ attached, which allows access to S3 buckets with the specific prefixsagemaker-
.OnCreate -> (string)
The file name of the entrypoint script of lifecycle scripts underSourceS3Uri
. This entrypoint script runs during cluster creation.ExecutionRole -> (string)
The execution role for the instance group to assume.ThreadsPerCore -> (integer)
The number you specified toTreadsPerCore
inCreateCluster
for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide .InstanceStorageConfigs -> (list)
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
(tagged union structure)
Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024 .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:EbsVolumeConfig
.EbsVolumeConfig -> (structure)
Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to
/opt/sagemaker
.VolumeSizeInGB -> (integer)
The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to/opt/sagemaker
.OnStartDeepHealthChecks -> (list)
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
(string)
VpcConfig -> (structure)
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC .
SecurityGroupIds -> (list)
The VPC security group IDs, in the form
sg-xxxxxxxx
. Specify the security groups for the VPC that is specified in theSubnets
field.(string)
Subnets -> (list)
The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones .
(string)
Orchestrator -> (structure)
The type of orchestrator used for the SageMaker HyperPod cluster.
Eks -> (structure)
The Amazon EKS cluster used as the orchestrator for the SageMaker HyperPod cluster.
ClusterArn -> (string)
The Amazon Resource Name (ARN) of the Amazon EKS cluster associated with the SageMaker HyperPod cluster.
NodeRecovery -> (string)
The node recovery mode configured for the SageMaker HyperPod cluster.