ElastiCache / Client / batch_stop_update_action

batch_stop_update_action#

ElastiCache.Client.batch_stop_update_action(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.batch_stop_update_action(
    ReplicationGroupIds=[
        'string',
    ],
    CacheClusterIds=[
        'string',
    ],
    ServiceUpdateName='string'
)
Parameters:

  • ReplicationGroupIds (list) –

    The replication group IDs

    • (string) –

  • CacheClusterIds (list) –

    The cache cluster IDs

    • (string) –

  • ServiceUpdateName (string) –

    [REQUIRED]

    The unique ID of the service update

Return type:

dict

Returns:

Response Syntax

{
    'ProcessedUpdateActions': [
        {
            'ReplicationGroupId': 'string',
            'CacheClusterId': 'string',
            'ServiceUpdateName': 'string',
            'UpdateActionStatus': 'not-applied'|'waiting-to-start'|'in-progress'|'stopping'|'stopped'|'complete'|'scheduling'|'scheduled'|'not-applicable'
        },
    ],
    'UnprocessedUpdateActions': [
        {
            'ReplicationGroupId': 'string',
            'CacheClusterId': 'string',
            'ServiceUpdateName': 'string',
            'ErrorType': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ProcessedUpdateActions (list) –

      Update actions that have been processed successfully

      • (dict) –

        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 Valkey or Redis OSS cluster

    • UnprocessedUpdateActions (list) –

      Update actions that haven’t been processed successfully

      • (dict) –

        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

Exceptions