DescribeUpdateActions
Returns details of the update actions
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- CacheClusterIds.member.N
-
The cache cluster IDs
Type: Array of strings
Array Members: Maximum number of 20 items.
Required: No
- Engine
-
The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
Type: String
Required: No
- Marker
-
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.Type: String
Required: No
- MaxRecords
-
The maximum number of records to include in the response
Type: Integer
Required: No
- ReplicationGroupIds.member.N
-
The replication group IDs
Type: Array of strings
Array Members: Maximum number of 20 items.
Required: No
- ServiceUpdateName
-
The unique ID of the service update
Type: String
Required: No
- ServiceUpdateStatus.member.N
-
The status of the service update
Type: Array of strings
Array Members: Maximum number of 3 items.
Valid Values:
available | cancelled | expiredRequired: No
- ServiceUpdateTimeRange
-
The range of time specified to search for service updates that are in available status
Type: TimeRangeFilter object
Required: No
- ShowNodeLevelUpdateStatus
-
Dictates whether to include node level update status in the response
Type: Boolean
Required: No
- UpdateActionStatus.member.N
-
The status of the update action.
Type: Array of strings
Array Members: Maximum number of 9 items.
Valid Values:
not-applied | waiting-to-start | in-progress | stopping | stopped | complete | scheduling | scheduled | not-applicableRequired: No
Response Elements
The following elements are returned by the service.
- Marker
-
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.Type: String
- UpdateActions.UpdateAction.N
-
Returns a list of update actions
Type: Array of UpdateAction objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterCombination
-
Two or more incompatible parameters were specified.
HTTP Status Code: 400
- InvalidParameterValue
-
The value for a parameter is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
