[ aws . elasticache ]
Returns details of the update actions
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-update-actions
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: UpdateActions
describe-update-actions
[--service-update-name <value>]
[--replication-group-ids <value>]
[--cache-cluster-ids <value>]
[--engine <value>]
[--service-update-status <value>]
[--service-update-time-range <value>]
[--update-action-status <value>]
[--show-node-level-update-status | --no-show-node-level-update-status]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--service-update-name
(string)
The unique ID of the service update
--replication-group-ids
(list)
The replication group IDs
(string)
Syntax:
"string" "string" ...
--cache-cluster-ids
(list)
The cache cluster IDs
(string)
Syntax:
"string" "string" ...
--engine
(string)
The Elasticache engine to which the update applies. Either Redis or Memcached
--service-update-status
(list)
The status of the service update
(string)
Syntax:
"string" "string" ...
Where valid values are:
available
cancelled
expired
--service-update-time-range
(structure)
The range of time specified to search for service updates that are in available status
StartTime -> (timestamp)
The start time of the time range filter
EndTime -> (timestamp)
The end time of the time range filter
Shorthand Syntax:
StartTime=timestamp,EndTime=timestamp
JSON Syntax:
{
"StartTime": timestamp,
"EndTime": timestamp
}
--update-action-status
(list)
The status of the update action.
(string)
Syntax:
"string" "string" ...
Where valid values are:
not-applied
waiting-to-start
in-progress
stopping
stopped
complete
scheduling
scheduled
not-applicable
--show-node-level-update-status
| --no-show-node-level-update-status
(boolean)
Dictates whether to include node level update status in the response
--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
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
See ‘aws help’ for descriptions of global parameters.
To describe update actions
The following describe-update-actions
example returns details of update actions.
aws elasticache describe-update-actions
Output:
{
"UpdateActions": [
{
"ReplicationGroupId": "mycluster",
"ServiceUpdateName": "elc-20191007-001",
"ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z",
"ServiceUpdateSeverity": "important",
"ServiceUpdateStatus": "available",
"ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z",
"ServiceUpdateType": "security-update",
"UpdateActionAvailableDate": "2019-12-05T19:15:19.995Z",
"UpdateActionStatus": "complete",
"NodesUpdated": "9/9",
"UpdateActionStatusModifiedDate": "2019-12-05T19:15:20.461Z",
"SlaMet": "n/a",
"Engine": "redis"
},
{
"CacheClusterId": "my-memcached-cluster",
"ServiceUpdateName": "elc-20191007-001",
"ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z",
"ServiceUpdateSeverity": "important",
"ServiceUpdateStatus": "available",
"ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z",
"ServiceUpdateType": "security-update",
"UpdateActionAvailableDate": "2019-12-04T18:26:05.349Z",
"UpdateActionStatus": "complete",
"NodesUpdated": "1/1",
"UpdateActionStatusModifiedDate": "2019-12-04T18:26:05.352Z",
"SlaMet": "n/a",
"Engine": "redis"
},
{
"ReplicationGroupId": "my-cluster",
"ServiceUpdateName": "elc-20191007-001",
"ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z",
"ServiceUpdateSeverity": "important",
"ServiceUpdateStatus": "available",
"ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z",
"ServiceUpdateType": "security-update",
"UpdateActionAvailableDate": "2019-11-26T03:36:26.320Z",
"UpdateActionStatus": "complete",
"NodesUpdated": "4/4",
"UpdateActionStatusModifiedDate": "2019-12-04T22:11:12.664Z",
"SlaMet": "n/a",
"Engine": "redis"
},
{
"ReplicationGroupId": "my-cluster2",
"ServiceUpdateName": "elc-20191007-001",
"ServiceUpdateReleaseDate": "2019-10-09T16:00:00Z",
"ServiceUpdateSeverity": "important",
"ServiceUpdateStatus": "available",
"ServiceUpdateRecommendedApplyByDate": "2019-11-08T15:59:59Z",
"ServiceUpdateType": "security-update",
"UpdateActionAvailableDate": "2019-11-26T01:26:01.617Z",
"UpdateActionStatus": "complete",
"NodesUpdated": "3/3",
"UpdateActionStatusModifiedDate": "2019-11-26T01:26:01.753Z",
"SlaMet": "n/a",
"Engine": "redis"
}
]
}
For more information, see Self-Service Updates in Amazon ElastiCache in the Elasticache User Guide.
Marker -> (string)
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 -> (list)
Returns a list of update actions
(structure)
The status of the service update for a specific replication group
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
ServiceUpdateReleaseDate -> (timestamp)
The date the update is first available
ServiceUpdateSeverity -> (string)
The severity of the service update
ServiceUpdateStatus -> (string)
The status of the service update
ServiceUpdateRecommendedApplyByDate -> (timestamp)
The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance .
ServiceUpdateType -> (string)
Reflects the nature of the service update
UpdateActionAvailableDate -> (timestamp)
The date that the service update is available to a replication group
UpdateActionStatus -> (string)
The status of the update action
NodesUpdated -> (string)
The progress of the service update on the replication group
UpdateActionStatusModifiedDate -> (timestamp)
The date when the UpdateActionStatus was last modified
SlaMet -> (string)
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 -> (list)
The status of the service update on the node group
(structure)
The status of the service update on the node group
NodeGroupId -> (string)
The ID of the node group
NodeGroupMemberUpdateStatus -> (list)
The status of the service update on the node group member
(structure)
The status of the service update on the node group member
CacheClusterId -> (string)
The cache cluster ID
CacheNodeId -> (string)
The node ID of the cache cluster
NodeUpdateStatus -> (string)
The update status of the node
NodeDeletionDate -> (timestamp)
The deletion date of the node
NodeUpdateStartDate -> (timestamp)
The start date of the update for a node
NodeUpdateEndDate -> (timestamp)
The end date of the update for a node
NodeUpdateInitiatedBy -> (string)
Reflects whether the update was initiated by the customer or automatically applied
NodeUpdateInitiatedDate -> (timestamp)
The date when the update is triggered
NodeUpdateStatusModifiedDate -> (timestamp)
The date when the NodeUpdateStatus was last modified
CacheNodeUpdateStatus -> (list)
The status of the service update on the cache node
(structure)
The status of the service update on the cache node
CacheNodeId -> (string)
The node ID of the cache cluster
NodeUpdateStatus -> (string)
The update status of the node
NodeDeletionDate -> (timestamp)
The deletion date of the node
NodeUpdateStartDate -> (timestamp)
The start date of the update for a node
NodeUpdateEndDate -> (timestamp)
The end date of the update for a node
NodeUpdateInitiatedBy -> (string)
Reflects whether the update was initiated by the customer or automatically applied
NodeUpdateInitiatedDate -> (timestamp)
The date when the update is triggered
NodeUpdateStatusModifiedDate -> (timestamp)
The date when the NodeUpdateStatus was last modified>
EstimatedUpdateTime -> (string)
The estimated length of time for the update to complete
Engine -> (string)
The Elasticache engine to which the update applies. Either Redis or Memcached