Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElastiCache.DescribeUpdateActions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns details of the update actions

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeUpdateActions Source #

See: newDescribeUpdateActions smart constructor.

Constructors

DescribeUpdateActions'

Fields

cacheClusterIds :: Maybe [Text]
The cache cluster IDs
engine :: Maybe Text
The Elasticache engine to which the update applies. Either Redis or Memcached
marker :: Maybe Text
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.
maxRecords :: Maybe Int
The maximum number of records to include in the response
replicationGroupIds :: Maybe [Text]
The replication group IDs
serviceUpdateName :: Maybe Text
The unique ID of the service update
serviceUpdateStatus :: Maybe [ServiceUpdateStatus]
The status of the service update
serviceUpdateTimeRange :: Maybe TimeRangeFilter
The range of time specified to search for service updates that are in available status
showNodeLevelUpdateStatus :: Maybe Bool
Dictates whether to include node level update status in the response
updateActionStatus :: Maybe [UpdateActionStatus]
The status of the update action.

Instances

Instances details

ToHeaders DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods toHeaders :: DescribeUpdateActions -> [Header] #
ToPath DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods toPath :: DescribeUpdateActions -> ByteString #
ToQuery DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods toQuery :: DescribeUpdateActions -> QueryString #
AWSPager DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods page :: DescribeUpdateActions -> AWSResponse DescribeUpdateActions -> Maybe DescribeUpdateActions #
AWSRequest DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Associated Types type AWSResponse DescribeUpdateActions # Methods request :: (Service -> Service) -> DescribeUpdateActions -> Request DescribeUpdateActions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUpdateActions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUpdateActions))) #
Generic DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Associated Types type Rep DescribeUpdateActions :: Type -> Type # Methods from :: DescribeUpdateActions -> Rep DescribeUpdateActions x # to :: Rep DescribeUpdateActions x -> DescribeUpdateActions #
Read DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods readsPrec :: Int -> ReadS DescribeUpdateActions # readList :: ReadS [DescribeUpdateActions] # readPrec :: ReadPrec DescribeUpdateActions # readListPrec :: ReadPrec [DescribeUpdateActions] #
Show DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods showsPrec :: Int -> DescribeUpdateActions -> ShowS # show :: DescribeUpdateActions -> String # showList :: [DescribeUpdateActions] -> ShowS #
NFData DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods rnf :: DescribeUpdateActions -> () #
Eq DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods (==) :: DescribeUpdateActions -> DescribeUpdateActions -> Bool # (/=) :: DescribeUpdateActions -> DescribeUpdateActions -> Bool #
Hashable DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods hashWithSalt :: Int -> DescribeUpdateActions -> Int # hash :: DescribeUpdateActions -> Int #
type AWSResponse DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions type AWSResponse DescribeUpdateActions = DescribeUpdateActionsResponse
type Rep DescribeUpdateActions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions type Rep DescribeUpdateActions = D1 ('MetaData "DescribeUpdateActions" "Amazonka.ElastiCache.DescribeUpdateActions" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeUpdateActions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheClusterIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "replicationGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "serviceUpdateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceUpdateStatus]))) :: (S1 ('MetaSel ('Just "serviceUpdateTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRangeFilter)) :: (S1 ('MetaSel ('Just "showNodeLevelUpdateStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "updateActionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpdateActionStatus])))))))

newDescribeUpdateActions :: DescribeUpdateActions Source #

Create a value of DescribeUpdateActions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheClusterIds:DescribeUpdateActions', describeUpdateActions_cacheClusterIds - The cache cluster IDs

DescribeUpdateActions, describeUpdateActions_engine - The Elasticache engine to which the update applies. Either Redis or Memcached

DescribeUpdateActions, describeUpdateActions_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.

$sel:maxRecords:DescribeUpdateActions', describeUpdateActions_maxRecords - The maximum number of records to include in the response

$sel:replicationGroupIds:DescribeUpdateActions', describeUpdateActions_replicationGroupIds - The replication group IDs

DescribeUpdateActions, describeUpdateActions_serviceUpdateName - The unique ID of the service update

DescribeUpdateActions, describeUpdateActions_serviceUpdateStatus - The status of the service update

$sel:serviceUpdateTimeRange:DescribeUpdateActions', describeUpdateActions_serviceUpdateTimeRange - The range of time specified to search for service updates that are in available status

$sel:showNodeLevelUpdateStatus:DescribeUpdateActions', describeUpdateActions_showNodeLevelUpdateStatus - Dictates whether to include node level update status in the response

DescribeUpdateActions, describeUpdateActions_updateActionStatus - The status of the update action.

Request Lenses

describeUpdateActions_cacheClusterIds :: Lens' DescribeUpdateActions (Maybe [Text]) Source #

The cache cluster IDs

describeUpdateActions_engine :: Lens' DescribeUpdateActions (Maybe Text) Source #

The Elasticache engine to which the update applies. Either Redis or Memcached

describeUpdateActions_marker :: Lens' DescribeUpdateActions (Maybe Text) Source #

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.

describeUpdateActions_maxRecords :: Lens' DescribeUpdateActions (Maybe Int) Source #

The maximum number of records to include in the response

describeUpdateActions_replicationGroupIds :: Lens' DescribeUpdateActions (Maybe [Text]) Source #

The replication group IDs

describeUpdateActions_serviceUpdateName :: Lens' DescribeUpdateActions (Maybe Text) Source #

The unique ID of the service update

describeUpdateActions_serviceUpdateStatus :: Lens' DescribeUpdateActions (Maybe [ServiceUpdateStatus]) Source #

The status of the service update

describeUpdateActions_serviceUpdateTimeRange :: Lens' DescribeUpdateActions (Maybe TimeRangeFilter) Source #

The range of time specified to search for service updates that are in available status

describeUpdateActions_showNodeLevelUpdateStatus :: Lens' DescribeUpdateActions (Maybe Bool) Source #

Dictates whether to include node level update status in the response

describeUpdateActions_updateActionStatus :: Lens' DescribeUpdateActions (Maybe [UpdateActionStatus]) Source #

The status of the update action.

Destructuring the Response

data DescribeUpdateActionsResponse Source #

See: newDescribeUpdateActionsResponse smart constructor.

Constructors

DescribeUpdateActionsResponse'
Fields marker :: Maybe Text 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 :: Maybe [UpdateAction] Returns a list of update actions httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeUpdateActionsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Associated Types type Rep DescribeUpdateActionsResponse :: Type -> Type # Methods from :: DescribeUpdateActionsResponse -> Rep DescribeUpdateActionsResponse x # to :: Rep DescribeUpdateActionsResponse x -> DescribeUpdateActionsResponse #
Read DescribeUpdateActionsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods readsPrec :: Int -> ReadS DescribeUpdateActionsResponse # readList :: ReadS [DescribeUpdateActionsResponse] # readPrec :: ReadPrec DescribeUpdateActionsResponse # readListPrec :: ReadPrec [DescribeUpdateActionsResponse] #
Show DescribeUpdateActionsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods showsPrec :: Int -> DescribeUpdateActionsResponse -> ShowS # show :: DescribeUpdateActionsResponse -> String # showList :: [DescribeUpdateActionsResponse] -> ShowS #
NFData DescribeUpdateActionsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods rnf :: DescribeUpdateActionsResponse -> () #
Eq DescribeUpdateActionsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions Methods (==) :: DescribeUpdateActionsResponse -> DescribeUpdateActionsResponse -> Bool # (/=) :: DescribeUpdateActionsResponse -> DescribeUpdateActionsResponse -> Bool #
type Rep DescribeUpdateActionsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUpdateActions type Rep DescribeUpdateActionsResponse = D1 ('MetaData "DescribeUpdateActionsResponse" "Amazonka.ElastiCache.DescribeUpdateActions" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeUpdateActionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "updateActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpdateAction])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUpdateActionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUpdateActionsResponse'`
-> DescribeUpdateActionsResponse

Create a value of DescribeUpdateActionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeUpdateActions, describeUpdateActionsResponse_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.

$sel:updateActions:DescribeUpdateActionsResponse', describeUpdateActionsResponse_updateActions - Returns a list of update actions

$sel:httpStatus:DescribeUpdateActionsResponse', describeUpdateActionsResponse_httpStatus - The response's http status code.

Response Lenses

describeUpdateActionsResponse_marker :: Lens' DescribeUpdateActionsResponse (Maybe Text) Source #

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.

describeUpdateActionsResponse_updateActions :: Lens' DescribeUpdateActionsResponse (Maybe [UpdateAction]) Source #

Returns a list of update actions

describeUpdateActionsResponse_httpStatus :: Lens' DescribeUpdateActionsResponse Int Source #

The response's http status code.