<a id="cli-aws-sagemaker-describe-cluster-operation"></a>

# describe-cluster-operation

## Description

Retrieves detailed information about a specific operation for a given HyperPod cluster, such as a scaling operation or a deep health check. Use the `OperationId` returned by the `ListClusterOperations` operation to identify the operation to describe.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeClusterOperation)

## Synopsis

```
  describe-cluster-operation
--cluster-name <value>
--operation-id <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-name` (string) [required]

> The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the operation.

> Constraints:

> * min: `0`
> * max: `256`
> * pattern: `((arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}))`

`--operation-id` (string) [required]

> The unique identifier (UUID) of the operation to describe. This ID can be obtained from the `ListClusterOperations` operation.

> Constraints:

> * pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`

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

OperationId -> (string)

> The unique identifier (UUID) of the operation.

> Constraints:

> * pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`

ClusterArn -> (string)

> The Amazon Resource Name (ARN) of the HyperPod cluster associated with the operation.

> Constraints:

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

Type -> (string)

> The type of the operation. Valid values are `Scaling` or `DeepHealthCheck` .

> Possible values:

> * `Scaling`
> * `DeepHealthCheck`

Status -> (string)

> The current status of the operation. Valid values are `InProgress` , `Superseded` , or `Done` .

> Possible values:

> * `InProgress`
> * `Superseded`
> * `Done`

CreationTime -> (timestamp)

> The timestamp when the operation was created.

ScalingDetails -> (list)

> The per-instance-group scaling details for the operation. This field is populated when the operation `Type` is `Scaling` .

> (structure)

> > The scaling details for a single instance group that is affected by a cluster operation.

> > InstanceGroupName -> (string)

> > > The name of the instance group being scaled.

> > Status -> (string)

> > > The status of the scaling operation for this instance group. Valid values are `InProgress` , `Superseded` , or `Done` .

> > > Possible values:

> > > * `InProgress`
> > > * `Superseded`
> > > * `Done`

> > Original -> (structure)

> > > The scaling configuration of the instance group before the scaling operation was applied, including its current, target, and minimum instance counts.

> > > CurrentCount -> (integer)

> > > > The number of instances that were in the instance group at the time of the operation.

> > > > Constraints:

> > > > * min: `0`

> > > TargetCount -> (integer)

> > > > The target number of instances for the instance group.

> > > > Constraints:

> > > > * min: `0`

> > > MinCount -> (integer)

> > > > The minimum number of instances that must be available in the instance group of a HyperPod cluster before it transitions to `InService` status.

> > > > Constraints:

> > > > * min: `0`

> > Desired -> (structure)

> > > The desired scaling configuration of the instance group for the scaling operation, including its target and minimum instance counts.

> > > CurrentCount -> (integer)

> > > > The number of instances that were in the instance group at the time of the operation.

> > > > Constraints:

> > > > * min: `0`

> > > TargetCount -> (integer)

> > > > The target number of instances for the instance group.

> > > > Constraints:

> > > > * min: `0`

> > > MinCount -> (integer)

> > > > The minimum number of instances that must be available in the instance group of a HyperPod cluster before it transitions to `InService` status.

> > > > Constraints:

> > > > * min: `0`

DeepHealthCheckDetails -> (list)

> The deep health check details for the operation. This field is populated when the operation `Type` is `DeepHealthCheck` .

> Constraints:

> * min: `1`
> * max: `99`

> (structure)

> > The configuration of deep health checks for an instance group.

> > #### NOTE
> > Overlapping deep health check configurations will be merged into a single operation.

> > InstanceGroupName -> (string) [required]

> > > The name of the instance group.

> > > Constraints:

> > > * min: `1`
> > > * max: `63`
> > > * pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*`

> > InstanceIds -> (list)

> > > A list of Amazon Elastic Compute Cloud (EC2) instance IDs on which to perform deep health checks.

> > > #### NOTE
> > > Leave this field blank to perform deep health checks on the entire instance group.

> > > Constraints:

> > > * min: `1`
> > > * max: `500`

> > > (string)

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `256`
> > > > * pattern: `i-[a-f0-9]{8}(?:[a-f0-9]{9})?`

> > DeepHealthChecks -> (list) [required]

> > > A list of deep health checks to be performed.

> > > Constraints:

> > > * min: `1`
> > > * max: `3`

> > > (string)

> > > > Possible values:

> > > > * `InstanceStress`
> > > > * `InstanceConnectivity`
> > > > * `MultiNodeTrainingValidation`