describeMetadataModelExportsAsScript method

Future<DescribeMetadataModelExportsAsScriptResponse> describeMetadataModelExportsAsScript({
  1. required String migrationProjectIdentifier,
  2. List<Filter>? filters,
  3. String? marker,
  4. int? maxRecords,
})

Returns a paginated list of metadata model export requests for a migration project, initiated by StartMetadataModelExportAsScript.

Required permissions: dms:ListMetadataModelExports. For more information, see Actions, resources, and condition keys for Database Migration Service.

May throw ResourceNotFoundFault.

Parameter migrationProjectIdentifier : The migration project name or Amazon Resource Name (ARN).

Parameter filters : The filters to apply to the metadata model export requests.

The following filter names are supported:

  • request-id – The request identifier.
  • status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED.

Parameter marker : Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.

Implementation

Future<DescribeMetadataModelExportsAsScriptResponse>
    describeMetadataModelExportsAsScript({
  required String migrationProjectIdentifier,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDMSv20160101.DescribeMetadataModelExportsAsScript'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'MigrationProjectIdentifier': migrationProjectIdentifier,
      if (filters != null) 'Filters': filters,
      if (marker != null) 'Marker': marker,
      if (maxRecords != null) 'MaxRecords': maxRecords,
    },
  );

  return DescribeMetadataModelExportsAsScriptResponse.fromJson(
      jsonResponse.body);
}