DatabaseMigrationService / Paginator / DescribeMetadataModelChildren

DescribeMetadataModelChildren

class DatabaseMigrationService.Paginator.DescribeMetadataModelChildren

paginator = client.get_paginator('describe_metadata_model_children')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_metadata_model_children().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SelectionRules='string',
    MigrationProjectIdentifier='string',
    Origin='SOURCE'|'TARGET',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.