describeSchemas method

Future<DescribeSchemasResponse> describeSchemas({
  1. required String endpointArn,
  2. String? marker,
  3. int? maxRecords,
})

Returns information about the schema for the specified endpoint.

May throw InvalidResourceStateFault. May throw ResourceNotFoundFault.

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

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

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

Implementation

Future<DescribeSchemasResponse> describeSchemas({
  required String endpointArn,
  String? marker,
  int? maxRecords,
}) async {
  ArgumentError.checkNotNull(endpointArn, 'endpointArn');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDMSv20160101.DescribeSchemas'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'EndpointArn': endpointArn,
      if (marker != null) 'Marker': marker,
      if (maxRecords != null) 'MaxRecords': maxRecords,
    },
  );

  return DescribeSchemasResponse.fromJson(jsonResponse.body);
}