Amazon ElastiCache Elasticache Update Action API
The Elasticache Update Action API from Amazon ElastiCache — 3 operation(s) for elasticache update action.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-elasticache:amazon-elasticache-update-action-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon ElastiCache Update Action API
version: '2015-02-02'
description: Generated from AWS's published Smithy model for Amazon ElastiCache. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://elasticache.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Update Action
paths:
/?Action=BatchApplyUpdateAction:
post:
operationId: BatchApplyUpdateAction
summary: Batch Apply Update Action
description: Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateActionResultsMessage'
'400':
description: InvalidParameterValueException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ServiceUpdateNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ServiceUpdateNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: BatchApplyUpdateAction
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/BatchApplyUpdateActionMessage'
tags:
- Update Action
/?Action=BatchStopUpdateAction:
post:
operationId: BatchStopUpdateAction
summary: Batch Stop Update Action
description: Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateActionResultsMessage'
'400':
description: InvalidParameterValueException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ServiceUpdateNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ServiceUpdateNotFoundFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: BatchStopUpdateAction
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/BatchStopUpdateActionMessage'
tags:
- Update Action
/?Action=DescribeUpdateActions:
post:
operationId: DescribeUpdateActions
summary: Describe Update Actions
description: Returns details of the update actions
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateActionsMessage'
'400':
description: InvalidParameterCombinationException; InvalidParameterValueException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidParameterCombinationException'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeUpdateActions
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/DescribeUpdateActionsMessage'
tags:
- Update Action
components:
schemas:
NodeGroupUpdateStatus:
type: object
properties:
NodeGroupId:
type: string
description: The ID of the node group
NodeGroupMemberUpdateStatus:
type: array
items:
$ref: '#/components/schemas/NodeGroupMemberUpdateStatus'
description: The status of the service update on the node group member
UpdateActionsMessage:
type: object
properties:
Marker:
type: string
description: An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
UpdateActions:
type: array
items:
$ref: '#/components/schemas/UpdateAction'
description: Returns a list of update actions
ServiceUpdateNotFoundFault:
type: object
properties:
message:
type: string
BatchApplyUpdateActionMessage:
type: object
properties:
ReplicationGroupIds:
type: array
items:
type: string
description: The replication group IDs
CacheClusterIds:
type: array
items:
type: string
description: The cache cluster IDs
ServiceUpdateName:
type: string
description: The unique ID of the service update
required:
- ServiceUpdateName
UpdateAction:
type: object
properties:
ReplicationGroupId:
type: string
description: The ID of the replication group
CacheClusterId:
type: string
description: The ID of the cache cluster
ServiceUpdateName:
type: string
description: The unique ID of the service update
ServiceUpdateReleaseDate:
type: string
format: date-time
description: The date the update is first available
ServiceUpdateSeverity:
type: string
enum:
- critical
- important
- medium
- low
description: The severity of the service update
ServiceUpdateStatus:
type: string
enum:
- available
- cancelled
- expired
description: The status of the service update
ServiceUpdateRecommendedApplyByDate:
type: string
format: date-time
description: The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
ServiceUpdateType:
type: string
enum:
- security-update
description: Reflects the nature of the service update
UpdateActionAvailableDate:
type: string
format: date-time
description: The date that the service update is available to a replication group
UpdateActionStatus:
type: string
enum:
- not-applied
- waiting-to-start
- in-progress
- stopping
- stopped
- complete
- scheduling
- scheduled
- not-applicable
description: The status of the update action
NodesUpdated:
type: string
description: The progress of the service update on the replication group
UpdateActionStatusModifiedDate:
type: string
format: date-time
description: The date when the UpdateActionStatus was last modified
SlaMet:
type: string
enum:
- 'yes'
- 'no'
- n/a
description: If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
NodeGroupUpdateStatus:
type: array
items:
$ref: '#/components/schemas/NodeGroupUpdateStatus'
description: The status of the service update on the node group
CacheNodeUpdateStatus:
type: array
items:
$ref: '#/components/schemas/CacheNodeUpdateStatus'
description: The status of the service update on the cache node
EstimatedUpdateTime:
type: string
description: The estimated length of time for the update to complete
Engine:
type: string
description: The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
CacheNodeUpdateStatus:
type: object
properties:
CacheNodeId:
type: string
description: The node ID of the cache cluster
NodeUpdateStatus:
type: string
enum:
- not-applied
- waiting-to-start
- in-progress
- stopping
- stopped
- complete
description: The update status of the node
NodeDeletionDate:
type: string
format: date-time
description: The deletion date of the node
NodeUpdateStartDate:
type: string
format: date-time
description: The start date of the update for a node
NodeUpdateEndDate:
type: string
format: date-time
description: The end date of the update for a node
NodeUpdateInitiatedBy:
type: string
enum:
- system
- customer
description: Reflects whether the update was initiated by the customer or automatically applied
NodeUpdateInitiatedDate:
type: string
format: date-time
description: The date when the update is triggered
NodeUpdateStatusModifiedDate:
type: string
format: date-time
description: The date when the NodeUpdateStatus was last modified>
NodeGroupMemberUpdateStatus:
type: object
properties:
CacheClusterId:
type: string
description: The cache cluster ID
CacheNodeId:
type: string
description: The node ID of the cache cluster
NodeUpdateStatus:
type: string
enum:
- not-applied
- waiting-to-start
- in-progress
- stopping
- stopped
- complete
description: The update status of the node
NodeDeletionDate:
type: string
format: date-time
description: The deletion date of the node
NodeUpdateStartDate:
type: string
format: date-time
description: The start date of the update for a node
NodeUpdateEndDate:
type: string
format: date-time
description: The end date of the update for a node
NodeUpdateInitiatedBy:
type: string
enum:
- system
- customer
description: Reflects whether the update was initiated by the customer or automatically applied
NodeUpdateInitiatedDate:
type: string
format: date-time
description: The date when the update is triggered
NodeUpdateStatusModifiedDate:
type: string
format: date-time
description: The date when the NodeUpdateStatus was last modified
InvalidParameterValueException:
type: object
properties:
message:
type: string
description: A parameter value is invalid.
BatchStopUpdateActionMessage:
type: object
properties:
ReplicationGroupIds:
type: array
items:
type: string
description: The replication group IDs
CacheClusterIds:
type: array
items:
type: string
description: The cache cluster IDs
ServiceUpdateName:
type: string
description: The unique ID of the service update
required:
- ServiceUpdateName
ProcessedUpdateAction:
type: object
properties:
ReplicationGroupId:
type: string
description: The ID of the replication group
CacheClusterId:
type: string
description: The ID of the cache cluster
ServiceUpdateName:
type: string
description: The unique ID of the service update
UpdateActionStatus:
type: string
enum:
- not-applied
- waiting-to-start
- in-progress
- stopping
- stopped
- complete
- scheduling
- scheduled
- not-applicable
description: The status of the update action on the Valkey or Redis OSS cluster
InvalidParameterCombinationException:
type: object
properties:
message:
type: string
description: Two or more parameters that must not be used together were used together.
TimeRangeFilter:
type: object
properties:
StartTime:
type: string
format: date-time
description: The start time of the time range filter
EndTime:
type: string
format: date-time
description: The end time of the time range filter
UpdateActionResultsMessage:
type: object
properties:
ProcessedUpdateActions:
type: array
items:
$ref: '#/components/schemas/ProcessedUpdateAction'
description: Update actions that have been processed successfully
UnprocessedUpdateActions:
type: array
items:
$ref: '#/components/schemas/UnprocessedUpdateAction'
description: Update actions that haven't been processed successfully
DescribeUpdateActionsMessage:
type: object
properties:
ServiceUpdateName:
type: string
description: The unique ID of the service update
ReplicationGroupIds:
type: array
items:
type: string
description: The replication group IDs
CacheClusterIds:
type: array
items:
type: string
description: The cache cluster IDs
Engine:
type: string
description: The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
ServiceUpdateStatus:
type: array
items:
type: string
enum:
- available
- cancelled
- expired
description: The status of the service update
ServiceUpdateTimeRange:
$ref: '#/components/schemas/TimeRangeFilter'
UpdateActionStatus:
type: array
items:
type: string
enum:
- not-applied
- waiting-to-start
- in-progress
- stopping
- stopped
- complete
- scheduling
- scheduled
- not-applicable
description: The status of the update action.
ShowNodeLevelUpdateStatus:
type: boolean
description: Dictates whether to include node level update status in the response
MaxRecords:
type: integer
description: The maximum number of records to include in the response
Marker:
type: string
description: An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
UnprocessedUpdateAction:
type: object
properties:
ReplicationGroupId:
type: string
description: The replication group ID
CacheClusterId:
type: string
description: The ID of the cache cluster
ServiceUpdateName:
type: string
description: The unique ID of the service update
ErrorType:
type: string
description: The error type for requests that are not processed
ErrorMessage:
type: string
description: The error message that describes the reason the request was not processed
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: elasticache
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/elasticache/service/2015-02-02/elasticache-2015-02-02.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)