Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

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.

[ aws . elasticache ]

batch-apply-update-action

Description

Apply the service update. For more information on service updates and applying them, see Applying Service Updates .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  batch-apply-update-action
[--replication-group-ids <value>]
[--cache-cluster-ids <value>]
--service-update-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--replication-group-ids (list)

The replication group IDs

(string)

Syntax:

"string" "string" ...

--cache-cluster-ids (list)

The cache cluster IDs

(string)

Syntax:

"string" "string" ...

--service-update-name (string)

The unique ID of the service update

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

See 'aws help' for descriptions of global parameters.

Examples

To apply a service update

The following batch-apply-update-action example applies a service update to a Redis cluster.

aws elasticache batch-apply-update-action \
    --service-update-name elc-xxxxx406-xxx \
    --replication-group-ids test-cluster

Output:

{
    "ProcessedUpdateActions": [
        {
            "ReplicationGroupId": "pat-cluster",
            "ServiceUpdateName": "elc-xxxxx406-xxx",
            "UpdateActionStatus": "waiting-to-start"
        }
    ],
    "UnprocessedUpdateActions": []
}

For more information, see Self-Service Updates in Amazon ElastiCache in the Elasticache User Guide.

Output

ProcessedUpdateActions -> (list)

Update actions that have been processed successfully

(structure)

Update action that has been processed for the corresponding apply/stop request

ReplicationGroupId -> (string)

The ID of the replication group

CacheClusterId -> (string)

The ID of the cache cluster

ServiceUpdateName -> (string)

The unique ID of the service update

UpdateActionStatus -> (string)

The status of the update action on the Redis cluster

UnprocessedUpdateActions -> (list)

Update actions that haven't been processed successfully

(structure)

Update action that has failed to be processed for the corresponding apply/stop request

ReplicationGroupId -> (string)

The replication group ID

CacheClusterId -> (string)

The ID of the cache cluster

ServiceUpdateName -> (string)

The unique ID of the service update

ErrorType -> (string)

The error type for requests that are not processed

ErrorMessage -> (string)

The error message that describes the reason the request was not processed