DatabaseMigrationService / Client / describe_fleet_advisor_schema_object_summary

describe_fleet_advisor_schema_object_summary

DatabaseMigrationService.Client.describe_fleet_advisor_schema_object_summary(**kwargs)

Warning

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Provides descriptions of the schemas discovered by your Fleet Advisor collectors.

See also: AWS API Documentation

Request Syntax

response = client.describe_fleet_advisor_schema_object_summary(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    NextToken='string'
)
Parameters:

  • Filters (list) –

    If you specify any of the following filters, the output includes information for only those schema objects that meet the filter criteria:

    • schema-id – The ID of the schema, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.

    Example: describe-fleet-advisor-schema-object-summary --filter Name="schema-id",Values="50"

    • (dict) –

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

      • Name (string) – [REQUIRED]

        The name of the filter as specified for a Describe* or similar operation.

      • Values (list) – [REQUIRED]

        The filter value, which can specify one or more values used to narrow the returned results.

        • (string) –

  • MaxRecords (integer) –

    Warning

    End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

    Sets the maximum number of records returned in the response.

  • NextToken (string) – If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Return type:

dict

Returns:

Response Syntax

{
    'FleetAdvisorSchemaObjects': [
        {
            'SchemaId': 'string',
            'ObjectType': 'string',
            'NumberOfObjects': 123,
            'CodeLineCount': 123,
            'CodeSize': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • FleetAdvisorSchemaObjects (list) –

      A collection of FleetAdvisorSchemaObjectResponse objects.

      • (dict) –

        Describes a schema object in a Fleet Advisor collector inventory.

        • SchemaId (string) –

          The ID of a schema object in a Fleet Advisor collector inventory.

        • ObjectType (string) –

          The type of the schema object, as reported by the database engine. Examples include the following:

          • function

          • trigger

          • SYSTEM_TABLE

          • QUEUE

        • NumberOfObjects (integer) –

          The number of objects in a schema object in a Fleet Advisor collector inventory.

        • CodeLineCount (integer) –

          The number of lines of code in a schema object in a Fleet Advisor collector inventory.

        • CodeSize (integer) –

          The size level of the code in a schema object in a Fleet Advisor collector inventory.

    • NextToken (string) –

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Exceptions

  • DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault