Amazonka.DAX.DescribeEvents

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.

Creating a Request

data DescribeEvents

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

• duration :: Maybe Int

  The number of minutes' worth of events to retrieve.

• endTime :: Maybe POSIX

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

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

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

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

• sourceType :: Maybe SourceType

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

• startTime :: Maybe POSIX

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

Instances

ToJSON DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

toJSON :: DescribeEvents -> Value

toEncoding :: DescribeEvents -> Encoding

toJSONList :: [DescribeEvents] -> Value

toEncodingList :: [DescribeEvents] -> Encoding

ToHeaders DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

toHeaders :: DescribeEvents -> [Header]

ToPath DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

toPath :: DescribeEvents -> ByteString

ToQuery DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

toQuery :: DescribeEvents -> QueryString

AWSPager DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents

AWSRequest DescribeEvents

Defined in Amazonka.DAX.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

Defined in Amazonka.DAX.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type

Methods

from :: DescribeEvents -> Rep DescribeEvents x

to :: Rep DescribeEvents x -> DescribeEvents

Read DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

readsPrec :: Int -> ReadS DescribeEvents

readList :: ReadS [DescribeEvents]

readPrec :: ReadPrec DescribeEvents

readListPrec :: ReadPrec [DescribeEvents]

Show DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

showsPrec :: Int -> DescribeEvents -> ShowS

show :: DescribeEvents -> String

showList :: [DescribeEvents] -> ShowS

NFData DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

rnf :: DescribeEvents -> ()

Eq DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

(==) :: DescribeEvents -> DescribeEvents -> Bool

(/=) :: DescribeEvents -> DescribeEvents -> Bool

Hashable DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

Methods

hashWithSalt :: Int -> DescribeEvents -> Int

hash :: DescribeEvents -> Int

type AWSResponse DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

type AWSResponse DescribeEvents = DescribeEventsResponse

type Rep DescribeEvents

Defined in Amazonka.DAX.DescribeEvents

type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.DAX.DescribeEvents" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" '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 POSIX)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceName") '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 POSIX))))))

newDescribeEvents :: DescribeEvents

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:duration:DescribeEvents', describeEvents_duration - The number of minutes' worth of events to retrieve.

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

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

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.

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.

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

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

Request Lenses

describeEvents_duration :: Lens' DescribeEvents (Maybe Int)

The number of minutes' worth of events to retrieve.

describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)

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

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

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

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

describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)

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

describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)

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

Destructuring the Response

data DescribeEventsResponse

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'

Fields

• events :: Maybe [Event]

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

• nextToken :: Maybe Text

  Provides an identifier to allow retrieval of paginated results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeEventsResponse

Defined in Amazonka.DAX.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type

Methods

from :: DescribeEventsResponse -> Rep DescribeEventsResponse x

to :: Rep DescribeEventsResponse x -> DescribeEventsResponse

Read DescribeEventsResponse

Defined in Amazonka.DAX.DescribeEvents

Methods

readsPrec :: Int -> ReadS DescribeEventsResponse

readList :: ReadS [DescribeEventsResponse]

readPrec :: ReadPrec DescribeEventsResponse

readListPrec :: ReadPrec [DescribeEventsResponse]

Show DescribeEventsResponse

Defined in Amazonka.DAX.DescribeEvents

Methods

showsPrec :: Int -> DescribeEventsResponse -> ShowS

show :: DescribeEventsResponse -> String

showList :: [DescribeEventsResponse] -> ShowS

NFData DescribeEventsResponse

Defined in Amazonka.DAX.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> ()

Eq DescribeEventsResponse

Defined in Amazonka.DAX.DescribeEvents

Methods

(==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

(/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool

type Rep DescribeEventsResponse

Defined in Amazonka.DAX.DescribeEvents

type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.DAX.DescribeEvents" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Event])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse

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 - An array of events. Each element in the array represents one event.

DescribeEvents, describeEventsResponse_nextToken - 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])

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

describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (Maybe Text)

Provides an identifier to allow retrieval of paginated results.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int

The response's http status code.