describeMetadataModelChildren method

Future<DescribeMetadataModelChildrenResponse> describeMetadataModelChildren({
  1. required String migrationProjectIdentifier,
  2. required OriginTypeValue origin,
  3. required String selectionRules,
  4. String? marker,
  5. int? maxRecords,
})

Gets a list of child metadata models for the specified metadata model in the database hierarchy.

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

May throw AccessDeniedFault. May throw ResourceNotFoundFault.

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

Parameter origin : Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

Parameter selectionRules : A JSON string that identifies the metadata model whose children to retrieve. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

Usage:

  • Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider.
  • Supports only explicit rule actions.
  • Exactly one rule is allowed.

Parameter marker : Specifies the unique pagination token that indicates where the next page should start. 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 metadata model children to include in the response. If more items exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Implementation

Future<DescribeMetadataModelChildrenResponse> describeMetadataModelChildren({
  required String migrationProjectIdentifier,
  required OriginTypeValue origin,
  required String selectionRules,
  String? marker,
  int? maxRecords,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDMSv20160101.DescribeMetadataModelChildren'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'MigrationProjectIdentifier': migrationProjectIdentifier,
      'Origin': origin.value,
      'SelectionRules': selectionRules,
      if (marker != null) 'Marker': marker,
      if (maxRecords != null) 'MaxRecords': maxRecords,
    },
  );

  return DescribeMetadataModelChildrenResponse.fromJson(jsonResponse.body);
}