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

Contents

Description

Returns information about the endpoints for your account in the current region.

This operation returns paginated results.

Synopsis

Creating a Request

describeEndpoints :: DescribeEndpoints #

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

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

  • desFilters - Filters applied to the describe action. Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
  • desMarker - 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 .
  • desMaxRecords - 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.

data DescribeEndpoints #

See: describeEndpoints smart constructor.

Instances

Eq DescribeEndpoints # 
Data DescribeEndpoints # 

Methods

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

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

toConstr :: DescribeEndpoints -> Constr #

dataTypeOf :: DescribeEndpoints -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeEndpoints # 
Show DescribeEndpoints # 
Generic DescribeEndpoints # 
Hashable DescribeEndpoints # 
ToJSON DescribeEndpoints # 
NFData DescribeEndpoints # 

Methods

rnf :: DescribeEndpoints -> () #

AWSPager DescribeEndpoints # 
AWSRequest DescribeEndpoints # 
ToHeaders DescribeEndpoints # 
ToPath DescribeEndpoints # 
ToQuery DescribeEndpoints # 
type Rep DescribeEndpoints # 
type Rep DescribeEndpoints = D1 * (MetaData "DescribeEndpoints" "Network.AWS.DMS.DescribeEndpoints" "amazonka-dms-1.6.0-GqH7kuM5kL3HMlibDeDmZp" False) (C1 * (MetaCons "DescribeEndpoints'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_desFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_desMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_desMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))
type Rs DescribeEndpoints # 

Request Lenses

desFilters :: Lens' DescribeEndpoints [Filter] #

Filters applied to the describe action. Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

desMarker :: Lens' DescribeEndpoints (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 .

desMaxRecords :: Lens' DescribeEndpoints (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.

Destructuring the Response

describeEndpointsResponse #

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

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

  • dersMarker - 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 .
  • dersEndpoints - Endpoint description.
  • dersResponseStatus - -- | The response status code.

data DescribeEndpointsResponse #

See: describeEndpointsResponse smart constructor.

Instances

Eq DescribeEndpointsResponse # 
Data DescribeEndpointsResponse # 

Methods

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

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

toConstr :: DescribeEndpointsResponse -> Constr #

dataTypeOf :: DescribeEndpointsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Show DescribeEndpointsResponse # 
Generic DescribeEndpointsResponse # 
NFData DescribeEndpointsResponse # 
type Rep DescribeEndpointsResponse # 
type Rep DescribeEndpointsResponse = D1 * (MetaData "DescribeEndpointsResponse" "Network.AWS.DMS.DescribeEndpoints" "amazonka-dms-1.6.0-GqH7kuM5kL3HMlibDeDmZp" False) (C1 * (MetaCons "DescribeEndpointsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dersMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dersEndpoints") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Endpoint]))) (S1 * (MetaSel (Just Symbol "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dersMarker :: Lens' DescribeEndpointsResponse (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 .

dersResponseStatus :: Lens' DescribeEndpointsResponse Int #

  • - | The response status code.