Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DMS.DescribeSchemas

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the schema for the specified endpoint.

This operation returns paginated results.

Creating a Request

data DescribeSchemas Source #

See: newDescribeSchemas smart constructor.

Constructors

DescribeSchemas'

Fields

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.
endpointArn :: Text
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Instances

Instances details

ToJSON DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods toJSON :: DescribeSchemas -> Value # toEncoding :: DescribeSchemas -> Encoding # toJSONList :: [DescribeSchemas] -> Value # toEncodingList :: [DescribeSchemas] -> Encoding #
ToHeaders DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods toHeaders :: DescribeSchemas -> [Header] #
ToPath DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods toPath :: DescribeSchemas -> ByteString #
ToQuery DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods toQuery :: DescribeSchemas -> QueryString #
AWSPager DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods page :: DescribeSchemas -> AWSResponse DescribeSchemas -> Maybe DescribeSchemas #
AWSRequest DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Associated Types type AWSResponse DescribeSchemas # Methods request :: (Service -> Service) -> DescribeSchemas -> Request DescribeSchemas # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSchemas -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSchemas))) #
Generic DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Associated Types type Rep DescribeSchemas :: Type -> Type # Methods from :: DescribeSchemas -> Rep DescribeSchemas x # to :: Rep DescribeSchemas x -> DescribeSchemas #
Read DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods readsPrec :: Int -> ReadS DescribeSchemas # readList :: ReadS [DescribeSchemas] # readPrec :: ReadPrec DescribeSchemas # readListPrec :: ReadPrec [DescribeSchemas] #
Show DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods showsPrec :: Int -> DescribeSchemas -> ShowS # show :: DescribeSchemas -> String # showList :: [DescribeSchemas] -> ShowS #
NFData DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods rnf :: DescribeSchemas -> () #
Eq DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods (==) :: DescribeSchemas -> DescribeSchemas -> Bool # (/=) :: DescribeSchemas -> DescribeSchemas -> Bool #
Hashable DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods hashWithSalt :: Int -> DescribeSchemas -> Int # hash :: DescribeSchemas -> Int #
type AWSResponse DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas type AWSResponse DescribeSchemas = DescribeSchemasResponse
type Rep DescribeSchemas Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas type Rep DescribeSchemas = D1 ('MetaData "DescribeSchemas" "Amazonka.DMS.DescribeSchemas" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeSchemas'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeSchemas Source #

Arguments

:: Text	`DescribeSchemas`
-> DescribeSchemas

Create a value of DescribeSchemas 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:

DescribeSchemas, describeSchemas_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:DescribeSchemas', describeSchemas_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.

DescribeSchemas, describeSchemas_endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Request Lenses

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

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

describeSchemas_endpointArn :: Lens' DescribeSchemas Text Source #

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

Destructuring the Response

data DescribeSchemasResponse Source #

See: newDescribeSchemasResponse smart constructor.

Constructors

DescribeSchemasResponse'
Fields 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`. schemas :: Maybe [Text] The described schema. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Associated Types type Rep DescribeSchemasResponse :: Type -> Type # Methods from :: DescribeSchemasResponse -> Rep DescribeSchemasResponse x # to :: Rep DescribeSchemasResponse x -> DescribeSchemasResponse #
Read DescribeSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods readsPrec :: Int -> ReadS DescribeSchemasResponse # readList :: ReadS [DescribeSchemasResponse] # readPrec :: ReadPrec DescribeSchemasResponse # readListPrec :: ReadPrec [DescribeSchemasResponse] #
Show DescribeSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods showsPrec :: Int -> DescribeSchemasResponse -> ShowS # show :: DescribeSchemasResponse -> String # showList :: [DescribeSchemasResponse] -> ShowS #
NFData DescribeSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods rnf :: DescribeSchemasResponse -> () #
Eq DescribeSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas Methods (==) :: DescribeSchemasResponse -> DescribeSchemasResponse -> Bool # (/=) :: DescribeSchemasResponse -> DescribeSchemasResponse -> Bool #
type Rep DescribeSchemasResponse Source #
Instance details Defined in Amazonka.DMS.DescribeSchemas type Rep DescribeSchemasResponse = D1 ('MetaData "DescribeSchemasResponse" "Amazonka.DMS.DescribeSchemas" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeSchemasResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "schemas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSchemasResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSchemasResponse'`
-> DescribeSchemasResponse

Create a value of DescribeSchemasResponse 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:

DescribeSchemas, describeSchemasResponse_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:schemas:DescribeSchemasResponse', describeSchemasResponse_schemas - The described schema.

$sel:httpStatus:DescribeSchemasResponse', describeSchemasResponse_httpStatus - The response's http status code.

Response Lenses

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

describeSchemasResponse_schemas :: Lens' DescribeSchemasResponse (Maybe [Text]) Source #

The described schema.

describeSchemasResponse_httpStatus :: Lens' DescribeSchemasResponse Int Source #

The response's http status code.