DatabaseMigrationService / Client / describe_fleet_advisor_schemas

describe_fleet_advisor_schemas#

DatabaseMigrationService.Client.describe_fleet_advisor_schemas(**kwargs)#

Returns a list of schemas detected by Fleet Advisor Collectors in your account.

See also: AWS API Documentation

Request Syntax

response = client.describe_fleet_advisor_schemas(
    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 schemas that meet the filter criteria:

    • complexity – The schema’s complexity, for example Simple.

    • database-id – The ID of the schema’s database.

    • database-ip-address – The IP address of the schema’s database.

    • database-name – The name of the schema’s database.

    • database-engine – The name of the schema database’s engine.

    • original-schema-name – The name of the schema’s database’s main schema.

    • schema-id – The ID of the schema, for example 15.

    • schema-name – The name of the schema.

    • server-ip-address – The IP address of the schema database’s server.

    An example is: describe-fleet-advisor-schemas --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) – 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

{
    'FleetAdvisorSchemas': [
        {
            'CodeLineCount': 123,
            'CodeSize': 123,
            'Complexity': 'string',
            'Server': {
                'ServerId': 'string',
                'IpAddress': 'string',
                'ServerName': 'string'
            },
            'DatabaseInstance': {
                'DatabaseId': 'string',
                'DatabaseName': 'string',
                'DatabaseIpAddress': 'string',
                'DatabaseEngine': 'string'
            },
            'SchemaId': 'string',
            'SchemaName': 'string',
            'OriginalSchema': {
                'SchemaId': 'string',
                'SchemaName': 'string',
                'DatabaseId': 'string',
                'DatabaseName': 'string',
                'DatabaseIpAddress': 'string'
            },
            'Similarity': 123.0
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • FleetAdvisorSchemas (list) –

      A collection of SchemaResponse objects.

      • (dict) –

        Describes a schema in a Fleet Advisor collector inventory.

        • CodeLineCount (integer) –

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

        • CodeSize (integer) –

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

        • Complexity (string) –

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

        • Server (dict) –

          The database server for a schema in a Fleet Advisor collector inventory.

          • ServerId (string) –

            The ID of a server in a Fleet Advisor collector inventory.

          • IpAddress (string) –

            The IP address of a server in a Fleet Advisor collector inventory.

          • ServerName (string) –

            The name address of a server in a Fleet Advisor collector inventory.

        • DatabaseInstance (dict) –

          The database for a schema in a Fleet Advisor collector inventory.

          • DatabaseId (string) –

            The ID of a database in a Fleet Advisor collector inventory.

          • DatabaseName (string) –

            The name of a database in a Fleet Advisor collector inventory.

          • DatabaseIpAddress (string) –

            The IP address of a database in a Fleet Advisor collector inventory.

          • DatabaseEngine (string) –

            The database engine of a database in a Fleet Advisor collector inventory, for example PostgreSQL.

        • SchemaId (string) –

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

        • SchemaName (string) –

          The name of a schema in a Fleet Advisor collector inventory.

        • OriginalSchema (dict) –

          Describes a schema in a Fleet Advisor collector inventory.

          • SchemaId (string) –

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

          • SchemaName (string) –

            The name of a schema in a Fleet Advisor collector inventory.

          • DatabaseId (string) –

            The ID of a database in a Fleet Advisor collector inventory.

          • DatabaseName (string) –

            The name of a database in a Fleet Advisor collector inventory.

          • DatabaseIpAddress (string) –

            The IP address of a database in a Fleet Advisor collector inventory.

        • Similarity (float) –

          The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value indicates that a schema is likely to be a duplicate.

    • 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