Describe Update Actions

elasticache_describe_update_actions

R Documentation

Returns details of the update actions

Description

Returns details of the update actions

Usage

elasticache_describe_update_actions(ServiceUpdateName,
  ReplicationGroupIds, CacheClusterIds, Engine, ServiceUpdateStatus,
  ServiceUpdateTimeRange, UpdateActionStatus, ShowNodeLevelUpdateStatus,
  MaxRecords, Marker)

Arguments

ServiceUpdateName	The unique ID of the service update
ReplicationGroupIds	The replication group IDs
CacheClusterIds	The cache cluster IDs
Engine	The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
ServiceUpdateStatus	The status of the service update
ServiceUpdateTimeRange	The range of time specified to search for service updates that are in available status
UpdateActionStatus	The status of the update action.
ShowNodeLevelUpdateStatus	Dictates whether to include node level update status in the response
MaxRecords	The maximum number of records to include in the response
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.

Value

A list with the following syntax:

list(
  Marker = "string",
  UpdateActions = list(
    list(
      ReplicationGroupId = "string",
      CacheClusterId = "string",
      ServiceUpdateName = "string",
      ServiceUpdateReleaseDate = as.POSIXct(
        "2015-01-01"
      ),
      ServiceUpdateSeverity = "critical"|"important"|"medium"|"low",
      ServiceUpdateStatus = "available"|"cancelled"|"expired",
      ServiceUpdateRecommendedApplyByDate = as.POSIXct(
        "2015-01-01"
      ),
      ServiceUpdateType = "security-update",
      UpdateActionAvailableDate = as.POSIXct(
        "2015-01-01"
      ),
      UpdateActionStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|"scheduling"|"scheduled"|"not-applicable",
      NodesUpdated = "string",
      UpdateActionStatusModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      SlaMet = "yes"|"no"|"n/a",
      NodeGroupUpdateStatus = list(
        list(
          NodeGroupId = "string",
          NodeGroupMemberUpdateStatus = list(
            list(
              CacheClusterId = "string",
              CacheNodeId = "string",
              NodeUpdateStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete",
              NodeDeletionDate = as.POSIXct(
                "2015-01-01"
              ),
              NodeUpdateStartDate = as.POSIXct(
                "2015-01-01"
              ),
              NodeUpdateEndDate = as.POSIXct(
                "2015-01-01"
              ),
              NodeUpdateInitiatedBy = "system"|"customer",
              NodeUpdateInitiatedDate = as.POSIXct(
                "2015-01-01"
              ),
              NodeUpdateStatusModifiedDate = as.POSIXct(
                "2015-01-01"
              )
            )
          )
        )
      ),
      CacheNodeUpdateStatus = list(
        list(
          CacheNodeId = "string",
          NodeUpdateStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete",
          NodeDeletionDate = as.POSIXct(
            "2015-01-01"
          ),
          NodeUpdateStartDate = as.POSIXct(
            "2015-01-01"
          ),
          NodeUpdateEndDate = as.POSIXct(
            "2015-01-01"
          ),
          NodeUpdateInitiatedBy = "system"|"customer",
          NodeUpdateInitiatedDate = as.POSIXct(
            "2015-01-01"
          ),
          NodeUpdateStatusModifiedDate = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      EstimatedUpdateTime = "string",
      Engine = "string"
    )
  )
)

Request syntax

svc$describe_update_actions(
  ServiceUpdateName = "string",
  ReplicationGroupIds = list(
    "string"
  ),
  CacheClusterIds = list(
    "string"
  ),
  Engine = "string",
  ServiceUpdateStatus = list(
    "available"|"cancelled"|"expired"
  ),
  ServiceUpdateTimeRange = list(
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  UpdateActionStatus = list(
    "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|"scheduling"|"scheduled"|"not-applicable"
  ),
  ShowNodeLevelUpdateStatus = TRUE|FALSE,
  MaxRecords = 123,
  Marker = "string"
)