[ aws . sagemaker ]

describe-cluster-extension

Description

Retrieves information about an extension installed on a SageMaker HyperPod cluster. The information includes the extension’s version, configuration, and status, and a summary of how many cluster nodes are running the current version and configuration of the extension.

See also: AWS API Documentation

Synopsis

  describe-cluster-extension
--cluster-arn <value>
--extension-arn <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--cluster-arn (string) [required]

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.

Constraints:

• min: 0
• max: 256
• pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}

--extension-arn (string) [required]

The Amazon Resource Name (ARN) of the extension to describe. CreateClusterExtension returns this ARN, and ListClusterExtensions lists it. If you delete an extension and create it again, the new extension has a new ARN.

Constraints:

• min: 1
• max: 256
• pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:extension/(sagemaker|eks|pcs)-[a-z0-9-]+/[a-z0-9-]+/[a-z0-9]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--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.

• json
• text
• table
• yaml
• yaml-stream
• off

--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.

• on
• off
• auto

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

--help (boolean)

Display help for the command/subcommand.

Output

ExtensionDetails -> (structure)

The details of the extension.

ClusterArn -> (string) [required]

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.

Constraints:

• min: 0
• max: 256
• pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}

ExtensionArn -> (string) [required]

The Amazon Resource Name (ARN) of the extension.

Constraints:

• min: 1
• max: 256
• pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:extension/(sagemaker|eks|pcs)-[a-z0-9-]+/[a-z0-9-]+/[a-z0-9]+

ExtensionName -> (string) [required]

The name of the extension.

Constraints:

• min: 1
• max: 128
• pattern: [a-z]([a-z0-9]|-[a-z0-9])*

ExtensionVersion -> (string) [required]

The version of the extension. While SageMaker HyperPod creates or updates the extension, some nodes might still run a different version. To see how many nodes run this version, see NodeSummary .

Constraints:

• min: 1
• max: 64
• pattern: [0-9]+\.[0-9]+\.[0-9]+

Status -> (string) [required]

The status of the extension can be one of the following values:

Creating

SageMaker HyperPod is installing the extension on the cluster’s nodes.

Active

The extension runs its current version and configuration on all of the cluster’s nodes.

Updating

SageMaker HyperPod is applying a configuration change or version update to the cluster’s nodes.

Degraded

The extension runs its current version and configuration on some of the cluster’s nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.

CreateFailed

SageMaker HyperPod couldn’t install the extension on any of the cluster’s nodes.

UpdateFailed

SageMaker HyperPod couldn’t apply the update on any of the cluster’s nodes.

Deleting

SageMaker HyperPod is removing the extension from the cluster’s nodes.

DeleteFailed

SageMaker HyperPod couldn’t remove the extension from any of the cluster’s nodes.

Possible values:

• Creating
• Active
• CreateFailed
• Updating
• Deleting
• DeleteFailed
• Degraded
• UpdateFailed

ConfigurationValues -> (string)

The configuration of the extension, as a JSON object serialized as a string. The configuration includes the default value of every setting that you didn’t specify.

Constraints:

• min: 1
• max: 10240

CreationTime -> (timestamp)

The time when the extension was created.

LastModifiedTime -> (timestamp)

The time when the extension was last updated.

NodeSummary -> (structure)

A summary of how many nodes in your cluster the extension targets, and how many of them run the extension’s current version and configuration.

TotalCount -> (integer) [required]

The number of nodes in your cluster that the extension targets. SageMaker HyperPod targets every running node in your cluster, including nodes that you add after you create the extension.

Constraints:

• min: 0

ActiveCount -> (integer) [required]

The number of nodes that are running the extension’s current version and configuration. While SageMaker HyperPod creates or updates the extension, ActiveCount is lower than TotalCount .

Constraints:

• min: 0