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
Description
Returns information about the schema for the specified endpoint.
This operation returns paginated results.
Synopsis
- data DescribeSchemas = DescribeSchemas' {
- marker :: Maybe Text
- maxRecords :: Maybe Int
- endpointArn :: Text
- newDescribeSchemas :: Text -> DescribeSchemas
- describeSchemas_marker :: Lens' DescribeSchemas (Maybe Text)
- describeSchemas_maxRecords :: Lens' DescribeSchemas (Maybe Int)
- describeSchemas_endpointArn :: Lens' DescribeSchemas Text
- data DescribeSchemasResponse = DescribeSchemasResponse' {}
- newDescribeSchemasResponse :: Int -> DescribeSchemasResponse
- describeSchemasResponse_marker :: Lens' DescribeSchemasResponse (Maybe Text)
- describeSchemasResponse_schemas :: Lens' DescribeSchemasResponse (Maybe [Text])
- describeSchemasResponse_httpStatus :: Lens' DescribeSchemasResponse Int
Creating a Request
data DescribeSchemas Source #
See: newDescribeSchemas
smart constructor.
Constructors
DescribeSchemas' | |
Fields
|
Instances
Arguments
:: Text | |
-> 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
|
Instances
newDescribeSchemasResponse Source #
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.