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.DescribeEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

This operation returns paginated results.

Synopsis

data DescribeEvents = DescribeEvents' {
- duration :: Maybe Int
- endTime :: Maybe ISO8601
- marker :: Maybe Text
- maxRecords :: Maybe Int
- sourceIdentifier :: Maybe Text
- sourceType :: Maybe SourceType
- startTime :: Maybe ISO8601
}
newDescribeEvents :: DescribeEvents
describeEvents_duration :: Lens' DescribeEvents (Maybe Int)
describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_marker :: Lens' DescribeEvents (Maybe Text)
describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int)
describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)
describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)
describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)
data DescribeEventsResponse = DescribeEventsResponse' {
- events :: Maybe [Event]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeEventsResponse :: Int -> DescribeEventsResponse
describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])
describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text)
describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

Creating a Request

data DescribeEvents Source #

Represents the input of a DescribeEvents operation.

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

duration :: Maybe Int
The number of minutes worth of events to retrieve.
endTime :: Maybe ISO8601
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
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. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
sourceIdentifier :: Maybe Text
The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
sourceType :: Maybe SourceType
The event source to retrieve events for. If no value is specified, all events are returned.
startTime :: Maybe ISO8601
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z

Instances

Instances details

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

newDescribeEvents :: DescribeEvents Source #

Create a value of DescribeEvents 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:

DescribeEvents, describeEvents_duration - The number of minutes worth of events to retrieve.

DescribeEvents, describeEvents_endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

DescribeEvents, describeEvents_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:DescribeEvents', describeEvents_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

DescribeEvents, describeEvents_sourceIdentifier - The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

DescribeEvents, describeEvents_sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

DescribeEvents, describeEvents_startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

Request Lenses

describeEvents_duration :: Lens' DescribeEvents (Maybe Int) Source #

The number of minutes worth of events to retrieve.

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

describeEvents_marker :: Lens' DescribeEvents (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.

describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text) Source #

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType) Source #

The event source to retrieve events for. If no value is specified, all events are returned.

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime) Source #

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

Destructuring the Response

data DescribeEventsResponse Source #

Represents the output of a DescribeEvents operation.

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'
Fields events :: Maybe [Event] A list of events. Each element in the list contains detailed information about one event. marker :: Maybe Text Provides an identifier to allow retrieval of paginated results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeEventsResponse Source #

Arguments

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

Create a value of DescribeEventsResponse 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:events:DescribeEventsResponse', describeEventsResponse_events - A list of events. Each element in the list contains detailed information about one event.

DescribeEvents, describeEventsResponse_marker - Provides an identifier to allow retrieval of paginated results.

$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

Response Lenses

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event]) Source #

A list of events. Each element in the list contains detailed information about one event.

describeEventsResponse_marker :: Lens' DescribeEventsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.