DatabaseMigrationService / Client / describe_metadata_model_children

describe_metadata_model_children

DatabaseMigrationService.Client.describe_metadata_model_children(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_metadata_model_children(
    SelectionRules='string',
    MigrationProjectIdentifier='string',
    Origin='SOURCE'|'TARGET',
    Marker='string',
    MaxRecords=123
)
Parameters:

  • SelectionRules (string) –

    [REQUIRED]

    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.

  • MigrationProjectIdentifier (string) –

    [REQUIRED]

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

  • Origin (string) –

    [REQUIRED]

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

  • Marker (string) – 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.

  • MaxRecords (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'MetadataModelChildren': [
        {
            'MetadataModelName': 'string',
            'SelectionRules': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      Specifies the unique pagination token that makes it possible to display the next page of metadata model children. If a marker is returned, there are more metadata model children available.

    • MetadataModelChildren (list) –

      A list of child metadata models.

      • (dict) –

        A reference to a metadata model, including its name and selection rules for location identification.

        • MetadataModelName (string) –

          The name of the metadata model.

        • SelectionRules (string) –

          A JSON string that identifies this metadata model in the metadata tree. For the selection rule format, see Selection rules in DMS Schema Conversion.

          Usage:

          • You can pass this value as the SelectionRules parameter to any operation that accepts selection rules, such as DescribeMetadataModel, StartMetadataModelConversion, and others.

Exceptions