Network.AWS.DMS.DescribeSchemas

Returns information about the schema for the specified endpoint.

This operation returns paginated results.

Creating a Request

describeSchemas

Arguments

:: Text

dsEndpointARN

-> DescribeSchemas

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

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

• dsMarker - 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 .
• dsMaxRecords - 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.
• dsEndpointARN - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

data DescribeSchemas

See: describeSchemas smart constructor.

Instances

Eq DescribeSchemas

Methods

(==) :: DescribeSchemas -> DescribeSchemas -> Bool

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

Data DescribeSchemas

Methods

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

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

toConstr :: DescribeSchemas -> Constr

dataTypeOf :: DescribeSchemas -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeSchemas -> DescribeSchemas

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

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

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

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

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

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

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

Read DescribeSchemas

Methods

readsPrec :: Int -> ReadS DescribeSchemas

readList :: ReadS [DescribeSchemas]

readPrec :: ReadPrec DescribeSchemas

readListPrec :: ReadPrec [DescribeSchemas]

Show DescribeSchemas

Methods

showsPrec :: Int -> DescribeSchemas -> ShowS

show :: DescribeSchemas -> String

showList :: [DescribeSchemas] -> ShowS

Generic DescribeSchemas

Associated Types

type Rep DescribeSchemas :: * -> *

Methods

from :: DescribeSchemas -> Rep DescribeSchemas x

to :: Rep DescribeSchemas x -> DescribeSchemas

Hashable DescribeSchemas

Methods

hashWithSalt :: Int -> DescribeSchemas -> Int

hash :: DescribeSchemas -> Int

ToJSON DescribeSchemas

Methods

toJSON :: DescribeSchemas -> Value

toEncoding :: DescribeSchemas -> Encoding

toJSONList :: [DescribeSchemas] -> Value

toEncodingList :: [DescribeSchemas] -> Encoding

NFData DescribeSchemas

Methods

rnf :: DescribeSchemas -> ()

AWSPager DescribeSchemas

Methods

page :: DescribeSchemas -> Rs DescribeSchemas -> Maybe DescribeSchemas

AWSRequest DescribeSchemas

Associated Types

type Rs DescribeSchemas :: *

Methods

request :: DescribeSchemas -> Request DescribeSchemas

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeSchemas -> ClientResponse -> m (Response DescribeSchemas)

ToHeaders DescribeSchemas

Methods

toHeaders :: DescribeSchemas -> [Header]

ToPath DescribeSchemas

Methods

toPath :: DescribeSchemas -> ByteString

ToQuery DescribeSchemas

Methods

toQuery :: DescribeSchemas -> QueryString

type Rep DescribeSchemas

type Rep DescribeSchemas = D1 * (MetaData "DescribeSchemas" "Network.AWS.DMS.DescribeSchemas" "amazonka-dms-1.6.0-5NfGace4mZbInPCIHEPoQz" False) (C1 * (MetaCons "DescribeSchemas'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_dsEndpointARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs DescribeSchemas

type Rs DescribeSchemas = DescribeSchemasResponse

Request Lenses

dsMarker :: Lens' DescribeSchemas (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 .

dsMaxRecords :: Lens' DescribeSchemas (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.

dsEndpointARN :: Lens' DescribeSchemas Text

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Destructuring the Response

describeSchemasResponse

Arguments

:: Int

dsrsResponseStatus

-> DescribeSchemasResponse

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

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

• dsrsSchemas - The described schema.
• dsrsMarker - 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 .
• dsrsResponseStatus - -- | The response status code.

data DescribeSchemasResponse

See: describeSchemasResponse smart constructor.

Instances

Eq DescribeSchemasResponse

Methods

(==) :: DescribeSchemasResponse -> DescribeSchemasResponse -> Bool

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

Data DescribeSchemasResponse

Methods

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

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

toConstr :: DescribeSchemasResponse -> Constr

dataTypeOf :: DescribeSchemasResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeSchemasResponse -> DescribeSchemasResponse

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

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

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

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

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

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

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

Read DescribeSchemasResponse

Methods

readsPrec :: Int -> ReadS DescribeSchemasResponse

readList :: ReadS [DescribeSchemasResponse]

readPrec :: ReadPrec DescribeSchemasResponse

readListPrec :: ReadPrec [DescribeSchemasResponse]

Show DescribeSchemasResponse

Methods

showsPrec :: Int -> DescribeSchemasResponse -> ShowS

show :: DescribeSchemasResponse -> String

showList :: [DescribeSchemasResponse] -> ShowS

Generic DescribeSchemasResponse

Associated Types

type Rep DescribeSchemasResponse :: * -> *

Methods

from :: DescribeSchemasResponse -> Rep DescribeSchemasResponse x

to :: Rep DescribeSchemasResponse x -> DescribeSchemasResponse

NFData DescribeSchemasResponse

Methods

rnf :: DescribeSchemasResponse -> ()

type Rep DescribeSchemasResponse

type Rep DescribeSchemasResponse = D1 * (MetaData "DescribeSchemasResponse" "Network.AWS.DMS.DescribeSchemas" "amazonka-dms-1.6.0-5NfGace4mZbInPCIHEPoQz" False) (C1 * (MetaCons "DescribeSchemasResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsrsSchemas") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dsrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dsrsSchemas :: Lens' DescribeSchemasResponse [Text]

The described schema.

dsrsMarker :: Lens' DescribeSchemasResponse (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 .

dsrsResponseStatus :: Lens' DescribeSchemasResponse Int

• - | The response status code.