BatchStopUpdateActionCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ElastiCacheClient, BatchStopUpdateActionCommand } from "@aws-sdk/client-elasticache"; // ES Modules import
// const { ElastiCacheClient, BatchStopUpdateActionCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import
const client = new ElastiCacheClient(config);
const input = { // BatchStopUpdateActionMessage
  ReplicationGroupIds: [ // ReplicationGroupIdList
    "STRING_VALUE",
  ],
  CacheClusterIds: [ // CacheClusterIdList
    "STRING_VALUE",
  ],
  ServiceUpdateName: "STRING_VALUE", // required
};
const command = new BatchStopUpdateActionCommand(input);
const response = await client.send(command);
// { // UpdateActionResultsMessage
//   ProcessedUpdateActions: [ // ProcessedUpdateActionList
//     { // ProcessedUpdateAction
//       ReplicationGroupId: "STRING_VALUE",
//       CacheClusterId: "STRING_VALUE",
//       ServiceUpdateName: "STRING_VALUE",
//       UpdateActionStatus: "not-applied" || "waiting-to-start" || "in-progress" || "stopping" || "stopped" || "complete" || "scheduling" || "scheduled" || "not-applicable",
//     },
//   ],
//   UnprocessedUpdateActions: [ // UnprocessedUpdateActionList
//     { // UnprocessedUpdateAction
//       ReplicationGroupId: "STRING_VALUE",
//       CacheClusterId: "STRING_VALUE",
//       ServiceUpdateName: "STRING_VALUE",
//       ErrorType: "STRING_VALUE",
//       ErrorMessage: "STRING_VALUE",
//     },
//   ],
// };

BatchStopUpdateActionCommand Input

See BatchStopUpdateActionCommandInput for more details

Parameter
Type
Description
ServiceUpdateName
Required
string | undefined

The unique ID of the service update

CacheClusterIds
string[] | undefined

The cache cluster IDs

ReplicationGroupIds
string[] | undefined

The replication group IDs

BatchStopUpdateActionCommand Output

See BatchStopUpdateActionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ProcessedUpdateActions
ProcessedUpdateAction[] | undefined

Update actions that have been processed successfully

UnprocessedUpdateActions
UnprocessedUpdateAction[] | undefined

Update actions that haven't been processed successfully

Throws

Name
Fault
Details
InvalidParameterValueException
client

The value for a parameter is invalid.

ServiceUpdateNotFoundFault
client

The service update doesn't exist

ElastiCacheServiceException
Base exception class for all service exceptions from ElastiCache service.