describeSourceRegions method

Future<SourceRegionMessage> describeSourceRegions({
  1. List<Filter>? filters,
  2. String? marker,
  3. int? maxRecords,
  4. String? regionName,
})

Returns a list of the source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

Parameter filters : This parameter isn't currently supported.

Parameter marker : An optional pagination token provided by a previous DescribeSourceRegions 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Parameter regionName : The source AWS Region name. For example, us-east-1.

Constraints:

  • Must specify a valid AWS Region name.

Implementation

Future<SourceRegionMessage> describeSourceRegions({
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
  String? regionName,
}) async {
  final $request = <String, dynamic>{};
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  regionName?.also((arg) => $request['RegionName'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeSourceRegions',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeSourceRegionsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeSourceRegionsResult',
  );
  return SourceRegionMessage.fromXml($result);
}