<a id="cli-aws-sagemaker-update-cluster-software"></a>

# update-cluster-software

## Description

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see [Update the SageMaker HyperPod platform software of a cluster](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software) .

#### WARNING
The `UpgradeClusterSoftware` API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.

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

## Synopsis

```
  update-cluster-software
--cluster-name <value>
[--instance-groups <value>]
[--deployment-config <value>]
[--image-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]

> Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

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

`--instance-groups` (list)

> The array of instance groups for which to update AMI versions.

> Constraints:

> * min: `1`
> * max: `100`

> (structure)

> > The configuration that describes specifications of the instance groups to update.

> > InstanceGroupName -> (string) [required]

> > > The name of the instance group to update.

> > > Constraints:

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

> > ImageReleaseVersion -> (string)

> > > The version of the HyperPod-managed AMI to update to for the instance group. Uses semantic versioning in the format `MAJOR.MINOR.PATCH` .

> > > Constraints:

> > > * min: `0`
> > > * max: `64`
> > > * pattern: `[0-9]+\.[0-9]+\.[0-9]+`

Shorthand Syntax:

```
InstanceGroupName=string,ImageReleaseVersion=string ...
```

JSON Syntax:

```json
[
  {
    "InstanceGroupName": "string",
    "ImageReleaseVersion": "string"
  }
  ...
]
```

`--deployment-config` (structure)

> The configuration to use when updating the AMI versions.

> RollingUpdatePolicy -> (structure)

> > The policy that SageMaker uses when updating the AMI versions of the cluster.

> > MaximumBatchSize -> (structure) [required]

> > > The maximum amount of instances in the cluster that SageMaker can update at a time.

> > > Type -> (string) [required]

> > > > Specifies whether SageMaker should process the update by amount or percentage of instances.

> > > > Possible values:

> > > > * `INSTANCE_COUNT`
> > > > * `CAPACITY_PERCENTAGE`

> > > Value -> (integer) [required]

> > > > Specifies the amount or percentage of instances SageMaker updates at a time.

> > > > Constraints:

> > > > * min: `1`

> > RollbackMaximumBatchSize -> (structure)

> > > The maximum amount of instances in the cluster that SageMaker can roll back at a time.

> > > Type -> (string) [required]

> > > > Specifies whether SageMaker should process the update by amount or percentage of instances.

> > > > Possible values:

> > > > * `INSTANCE_COUNT`
> > > > * `CAPACITY_PERCENTAGE`

> > > Value -> (integer) [required]

> > > > Specifies the amount or percentage of instances SageMaker updates at a time.

> > > > Constraints:

> > > > * min: `1`

> WaitIntervalInSeconds -> (integer)

> > The duration in seconds that SageMaker waits before updating more instances in the cluster.

> > Constraints:

> > * min: `0`
> > * max: `3600`

> AutoRollbackConfiguration -> (list)

> > An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.

> > Constraints:

> > * min: `1`
> > * max: `10`

> > (structure)

> > > The details of the alarm to monitor during the AMI update.

> > > AlarmName -> (string) [required]

> > > > The name of the alarm.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `255`
> > > > * pattern: `(?!\s*$).+`

Shorthand Syntax:

```
RollingUpdatePolicy={MaximumBatchSize={Type=string,Value=integer},RollbackMaximumBatchSize={Type=string,Value=integer}},WaitIntervalInSeconds=integer,AutoRollbackConfiguration=[{AlarmName=string},{AlarmName=string}]
```

JSON Syntax:

```json
{
  "RollingUpdatePolicy": {
    "MaximumBatchSize": {
      "Type": "INSTANCE_COUNT"|"CAPACITY_PERCENTAGE",
      "Value": integer
    },
    "RollbackMaximumBatchSize": {
      "Type": "INSTANCE_COUNT"|"CAPACITY_PERCENTAGE",
      "Value": integer
    }
  },
  "WaitIntervalInSeconds": integer,
  "AutoRollbackConfiguration": [
    {
      "AlarmName": "string"
    }
    ...
  ]
}
```

`--image-id` (string)

> When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

> * `HyperPodPublicAmiId` : Use a HyperPod public AMI
> * `CustomAmiId` : Use your custom AMI
> * `default` : Use the default latest system image

> If you choose to use a custom AMI (`CustomAmiId` ), ensure it meets the following requirements:

> * Encryption: The custom AMI must be unencrypted.
> * Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.
> * Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

> When updating the instance group’s AMI through the `UpdateClusterSoftware` operation, if an instance group uses a custom AMI, you must provide an `ImageId` or use the default as input. Note that if you don’t specify an instance group in your `UpdateClusterSoftware` request, then all of the instance groups are patched with the specified image.

> Constraints:

> * min: `7`
> * max: `21`
> * pattern: `(ami-[0-9a-fA-F]{8,17}|default)`

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

ClusterArn -> (string)

> The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.

> Constraints:

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