Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DAX.DescribeEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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

This operation returns paginated results.

Synopsis

data DescribeEvents = DescribeEvents' {
- sourceName :: Maybe Text
- startTime :: Maybe POSIX
- sourceType :: Maybe SourceType
- nextToken :: Maybe Text
- endTime :: Maybe POSIX
- duration :: Maybe Int
- maxResults :: Maybe Int
}
newDescribeEvents :: DescribeEvents
describeEvents_sourceName :: Lens' DescribeEvents (Maybe Text)
describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)
describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text)
describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_duration :: Lens' DescribeEvents (Maybe Int)
describeEvents_maxResults :: Lens' DescribeEvents (Maybe Int)
data DescribeEventsResponse = DescribeEventsResponse' {
- nextToken :: Maybe Text
- events :: Maybe [Event]
- httpStatus :: Int
}
newDescribeEventsResponse :: Int -> DescribeEventsResponse
describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (Maybe Text)
describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])
describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

Creating a Request

data DescribeEvents Source #

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

sourceName :: Maybe Text
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
startTime :: Maybe POSIX
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
sourceType :: Maybe SourceType
The event source to retrieve events for. If no value is specified, all events are returned.
nextToken :: Maybe Text
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
endTime :: Maybe POSIX
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
duration :: Maybe Int
The number of minutes' worth of events to retrieve.
maxResults :: Maybe Int
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.

Instances

Instances details

Eq DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods (==) :: DescribeEvents -> DescribeEvents -> Bool # (/=) :: DescribeEvents -> DescribeEvents -> Bool #
Read DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEvents # readList :: ReadS [DescribeEvents] # readPrec :: ReadPrec DescribeEvents # readListPrec :: ReadPrec [DescribeEvents] #
Show DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods showsPrec :: Int -> DescribeEvents -> ShowS # show :: DescribeEvents -> String # showList :: [DescribeEvents] -> ShowS #
Generic DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Associated Types type Rep DescribeEvents :: Type -> Type # Methods from :: DescribeEvents -> Rep DescribeEvents x # to :: Rep DescribeEvents x -> DescribeEvents #
NFData DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods rnf :: DescribeEvents -> () #
Hashable DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods hashWithSalt :: Int -> DescribeEvents -> Int # hash :: DescribeEvents -> Int #
ToJSON DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods toJSON :: DescribeEvents -> Value # toEncoding :: DescribeEvents -> Encoding # toJSONList :: [DescribeEvents] -> Value # toEncodingList :: [DescribeEvents] -> Encoding #
AWSPager DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents #
AWSRequest DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Associated Types type AWSResponse DescribeEvents # Methods request :: DescribeEvents -> Request DescribeEvents # response :: MonadResource m => Logger -> Service -> Proxy DescribeEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEvents))) #
ToHeaders DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods toHeaders :: DescribeEvents -> [Header] #
ToPath DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods toPath :: DescribeEvents -> ByteString #
ToQuery DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods toQuery :: DescribeEvents -> QueryString #
type Rep DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.DAX.DescribeEvents" "libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse DescribeEvents Source #
Instance details Defined in Amazonka.DAX.DescribeEvents type AWSResponse DescribeEvents = DescribeEventsResponse

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:

$sel:sourceName:DescribeEvents', describeEvents_sourceName - The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

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

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

$sel:nextToken:DescribeEvents', describeEvents_nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

$sel:duration:DescribeEvents', describeEvents_duration - The number of minutes' worth of events to retrieve.

$sel:maxResults:DescribeEvents', describeEvents_maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Request Lenses

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

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

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

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

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

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

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

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

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

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

The number of minutes' worth of events to retrieve.

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

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

The value for MaxResults must be between 20 and 100.

Destructuring the Response

data DescribeEventsResponse Source #

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'
Fields nextToken :: Maybe Text Provides an identifier to allow retrieval of paginated results. events :: Maybe [Event] An array of events. Each element in the array represents one event. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeEventsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods (==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool # (/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool #
Read DescribeEventsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEventsResponse # readList :: ReadS [DescribeEventsResponse] # readPrec :: ReadPrec DescribeEventsResponse # readListPrec :: ReadPrec [DescribeEventsResponse] #
Show DescribeEventsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods showsPrec :: Int -> DescribeEventsResponse -> ShowS # show :: DescribeEventsResponse -> String # showList :: [DescribeEventsResponse] -> ShowS #
Generic DescribeEventsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Associated Types type Rep DescribeEventsResponse :: Type -> Type # Methods from :: DescribeEventsResponse -> Rep DescribeEventsResponse x # to :: Rep DescribeEventsResponse x -> DescribeEventsResponse #
NFData DescribeEventsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeEvents Methods rnf :: DescribeEventsResponse -> () #
type Rep DescribeEventsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeEvents type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.DAX.DescribeEvents" "libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Event])) :: 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:nextToken:DescribeEvents', describeEventsResponse_nextToken - Provides an identifier to allow retrieval of paginated results.

$sel:events:DescribeEventsResponse', describeEventsResponse_events - An array of events. Each element in the array represents one event.

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

Response Lenses

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

Provides an identifier to allow retrieval of paginated results.

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

An array of events. Each element in the array represents one event.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.