amazonka-dms-1.6.0: Amazon Database Migration Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DMS.DescribeEvents

Contents

Description

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications .

This operation returns paginated results.

Synopsis

Creating a Request

describeEvents :: DescribeEvents Source #

Creates a value of DescribeEvents with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • deStartTime - The start time for the events to be listed.
  • deSourceType - The type of AWS DMS resource that generates events. Valid values: replication-instance | migration-task
  • deFilters - Filters applied to the action.
  • deSourceIdentifier - The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.
  • deEventCategories - A list of event categories for a source type that you want to subscribe to.
  • deMarker - 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 .
  • deMaxRecords - 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.
  • deEndTime - The end time for the events to be listed.
  • deDuration - The duration of the events to be listed.

data DescribeEvents Source #

See: describeEvents smart constructor.

Instances

Eq DescribeEvents Source # 
Data DescribeEvents Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEvents -> c DescribeEvents #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEvents #

toConstr :: DescribeEvents -> Constr #

dataTypeOf :: DescribeEvents -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEvents) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEvents) #

gmapT :: (forall b. Data b => b -> b) -> DescribeEvents -> DescribeEvents #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEvents -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeEvents -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEvents -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEvents -> m DescribeEvents #

Read DescribeEvents Source # 
Show DescribeEvents Source # 
Generic DescribeEvents Source # 

Associated Types

type Rep DescribeEvents :: * -> * #

Hashable DescribeEvents Source # 
ToJSON DescribeEvents Source # 
NFData DescribeEvents Source # 

Methods

rnf :: DescribeEvents -> () #

AWSPager DescribeEvents Source # 
AWSRequest DescribeEvents Source # 
ToHeaders DescribeEvents Source # 
ToPath DescribeEvents Source # 
ToQuery DescribeEvents Source # 
type Rep DescribeEvents Source # 
type Rs DescribeEvents Source # 

Request Lenses

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

The start time for the events to be listed.

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

The type of AWS DMS resource that generates events. Valid values: replication-instance | migration-task

deFilters :: Lens' DescribeEvents [Filter] Source #

Filters applied to the action.

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

The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.

deEventCategories :: Lens' DescribeEvents [Text] Source #

A list of event categories for a source type that you want to subscribe to.

deMarker :: 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 .

deMaxRecords :: 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.

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

The end time for the events to be listed.

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

The duration of the events to be listed.

Destructuring the Response

describeEventsResponse Source #

Creates a value of DescribeEventsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • deersEvents - The events described.
  • deersMarker - 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 .
  • deersResponseStatus - -- | The response status code.

data DescribeEventsResponse Source #

See: describeEventsResponse smart constructor.

Instances

Eq DescribeEventsResponse Source # 
Data DescribeEventsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEventsResponse -> c DescribeEventsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEventsResponse #

toConstr :: DescribeEventsResponse -> Constr #

dataTypeOf :: DescribeEventsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEventsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEventsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeEventsResponse -> DescribeEventsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEventsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeEventsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEventsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEventsResponse -> m DescribeEventsResponse #

Read DescribeEventsResponse Source # 
Show DescribeEventsResponse Source # 
Generic DescribeEventsResponse Source # 
NFData DescribeEventsResponse Source # 

Methods

rnf :: DescribeEventsResponse -> () #

type Rep DescribeEventsResponse Source # 
type Rep DescribeEventsResponse = D1 * (MetaData "DescribeEventsResponse" "Network.AWS.DMS.DescribeEvents" "amazonka-dms-1.6.0-5NfGace4mZbInPCIHEPoQz" False) (C1 * (MetaCons "DescribeEventsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_deersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Event]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_deersMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_deersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

deersMarker :: 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 .