batch-stop-update-action¶

Description¶

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates .

Synopsis¶

  batch-stop-update-action
[--replication-group-ids <value>]
[--cache-cluster-ids <value>]
--service-update-name <value>
[--cli-input-json | --cli-input-yaml]
[--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 | --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.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To stop a service update

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

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

Output:

{
    "ProcessedUpdateActions": [
        {
            "ReplicationGroupId": "pat-cluster",
            "ServiceUpdateName": "elc-xxxxx406-xxx",
            "UpdateActionStatus": "stopping"
        }
    ],
    "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

Table of Contents

Feedback

User Guide