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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.

This operation returns paginated results.

Synopsis

data DescribeEvents = DescribeEvents' {
- startTime :: Maybe POSIX
- sourceType :: Maybe SourceType
- filters :: Maybe [Filter]
- sourceIdentifier :: Maybe Text
- eventCategories :: Maybe [Text]
- marker :: Maybe Text
- maxRecords :: Maybe Int
- endTime :: Maybe POSIX
- duration :: Maybe Int
}
newDescribeEvents :: DescribeEvents
describeEvents_startTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_sourceType :: Lens' DescribeEvents (Maybe SourceType)
describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter])
describeEvents_sourceIdentifier :: Lens' DescribeEvents (Maybe Text)
describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text])
describeEvents_marker :: Lens' DescribeEvents (Maybe Text)
describeEvents_maxRecords :: Lens' DescribeEvents (Maybe Int)
describeEvents_endTime :: Lens' DescribeEvents (Maybe UTCTime)
describeEvents_duration :: Lens' DescribeEvents (Maybe Int)
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 #

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents'

Fields

startTime :: Maybe POSIX
The start time for the events to be listed.
sourceType :: Maybe SourceType
The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
filters :: Maybe [Filter]
Filters applied to events.
sourceIdentifier :: Maybe Text
The identifier of an event source.
eventCategories :: Maybe [Text]
A list of event categories for the source type that you've chosen.
marker :: Maybe Text
An optional pagination token provided by a previous request. 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 pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
endTime :: Maybe POSIX
The end time for the events to be listed.
duration :: Maybe Int
The duration of the events to be listed.

Instances

Instances details

Eq DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods (==) :: DescribeEvents -> DescribeEvents -> Bool # (/=) :: DescribeEvents -> DescribeEvents -> Bool #
Read DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEvents # readList :: ReadS [DescribeEvents] # readPrec :: ReadPrec DescribeEvents # readListPrec :: ReadPrec [DescribeEvents] #
Show DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods showsPrec :: Int -> DescribeEvents -> ShowS # show :: DescribeEvents -> String # showList :: [DescribeEvents] -> ShowS #
Generic DescribeEvents Source #
Instance details Defined in Amazonka.DMS.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.DMS.DescribeEvents Methods rnf :: DescribeEvents -> () #
Hashable DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods hashWithSalt :: Int -> DescribeEvents -> Int # hash :: DescribeEvents -> Int #
ToJSON DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods toJSON :: DescribeEvents -> Value # toEncoding :: DescribeEvents -> Encoding # toJSONList :: [DescribeEvents] -> Value # toEncodingList :: [DescribeEvents] -> Encoding #
AWSPager DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods page :: DescribeEvents -> AWSResponse DescribeEvents -> Maybe DescribeEvents #
AWSRequest DescribeEvents Source #
Instance details Defined in Amazonka.DMS.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.DMS.DescribeEvents Methods toHeaders :: DescribeEvents -> [Header] #
ToPath DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods toPath :: DescribeEvents -> ByteString #
ToQuery DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods toQuery :: DescribeEvents -> QueryString #
type Rep DescribeEvents Source #
Instance details Defined in Amazonka.DMS.DescribeEvents type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.DMS.DescribeEvents" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "eventCategories") '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 "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))
type AWSResponse DescribeEvents Source #
Instance details Defined in Amazonka.DMS.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:startTime:DescribeEvents', describeEvents_startTime - The start time for the events to be listed.

$sel:sourceType:DescribeEvents', describeEvents_sourceType - The type of DMS resource that generates events.

Valid values: replication-instance | replication-task

$sel:filters:DescribeEvents', describeEvents_filters - Filters applied to events.

$sel:sourceIdentifier:DescribeEvents', describeEvents_sourceIdentifier - The identifier of an event source.

$sel:eventCategories:DescribeEvents', describeEvents_eventCategories - A list of event categories for the source type that you've chosen.

$sel:marker:DescribeEvents', describeEvents_marker - An optional pagination token provided by a previous request. 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 pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

$sel:endTime:DescribeEvents', describeEvents_endTime - The end time for the events to be listed.

$sel:duration:DescribeEvents', describeEvents_duration - The duration of the events to be listed.

Request Lenses

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

The start time for the events to be listed.

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

The type of DMS resource that generates events.

Valid values: replication-instance | replication-task

describeEvents_filters :: Lens' DescribeEvents (Maybe [Filter]) Source #

Filters applied to events.

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

The identifier of an event source.

describeEvents_eventCategories :: Lens' DescribeEvents (Maybe [Text]) Source #

A list of event categories for the source type that you've chosen.

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

An optional pagination token provided by a previous request. 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 pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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

The end time for the events to be listed.

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

The duration of the events to be listed.

Destructuring the Response

data DescribeEventsResponse Source #

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse'
Fields events :: Maybe [Event] The events described. marker :: Maybe Text An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeEventsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods (==) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool # (/=) :: DescribeEventsResponse -> DescribeEventsResponse -> Bool #
Read DescribeEventsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods readsPrec :: Int -> ReadS DescribeEventsResponse # readList :: ReadS [DescribeEventsResponse] # readPrec :: ReadPrec DescribeEventsResponse # readListPrec :: ReadPrec [DescribeEventsResponse] #
Show DescribeEventsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEvents Methods showsPrec :: Int -> DescribeEventsResponse -> ShowS # show :: DescribeEventsResponse -> String # showList :: [DescribeEventsResponse] -> ShowS #
Generic DescribeEventsResponse Source #
Instance details Defined in Amazonka.DMS.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.DMS.DescribeEvents Methods rnf :: DescribeEventsResponse -> () #
type Rep DescribeEventsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEvents type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.DMS.DescribeEvents" "libZSservicesZSamazonka-dmsZSamazonka-dms" '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 - The events described.

$sel:marker:DescribeEvents', describeEventsResponse_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

Response Lenses

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

The events described.

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

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #

The response's http status code.