Skip to content

DescribeMetadataModelChildrenMessage

Source code in docs_src/capo_database_migration_service/types/describe_metadata_model_children_message.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class DescribeMetadataModelChildrenMessage(TypedDict, closed=True):
    selection_rules: "capo_database_migration_service.types.string.String"
    """<p>A JSON string that identifies the metadata model whose children to retrieve. For the selection rule format and examples, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/sc-selection-rules.html">Selection rules in DMS Schema Conversion</a>.</p> <p>Usage:</p> <ul> <li> <p>Accepts source or target selection rules depending on the <code>Origin</code> parameter. The <code>server-name</code> in the object locator must match the corresponding data provider.</p> </li> <li> <p>Supports only <code>explicit</code> rule actions.</p> </li> <li> <p>Exactly one rule is allowed.</p> </li> </ul>"""
    migration_project_identifier: "capo_database_migration_service.types.migration_project_identifier.MigrationProjectIdentifier"
    """<p>The migration project name or Amazon Resource Name (ARN).</p>"""
    origin: "capo_database_migration_service.types.origin_type_value.OriginTypeValue"
    """<p>Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET</p>"""
    marker: NotRequired["capo_database_migration_service.types.string.String"]
    """<p>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.</p>"""
    max_records: NotRequired[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ]
    """<p>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.</p>"""

marker instance-attribute 

marker: NotRequired[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.

max_records instance-attribute 

max_records: NotRequired[IntegerOptional]

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.

migration_project_identifier instance-attribute 

migration_project_identifier: MigrationProjectIdentifier

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

origin instance-attribute 

origin: OriginTypeValue

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

selection_rules instance-attribute 

selection_rules: String

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.