Skip to content

describe_fleet_advisor_schemas

describe_fleet_advisor_schemas(
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    next_token: Optional[String] = None,
) -> DescribeFleetAdvisorSchemasResponse

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.

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

Parameters:

  • filters (Optional[FilterList], default: None ) –

    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"

  • max_records (Optional[IntegerOptional], default: None ) –

    Sets the maximum number of records returned in the response.

  • next_token (Optional[String], default: None ) –

    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.

Raises:

Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def describe_fleet_advisor_schemas(
    self,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    filters: Optional[
        "capo_database_migration_service.types.filter_list.FilterList"
    ] = None,
    max_records: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    next_token: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
) -> "capo_database_migration_service.types.describe_fleet_advisor_schemas_response.DescribeFleetAdvisorSchemasResponse":
    """<important> <p> 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 <a href="https://docs.aws.amazon.com/dms/latest/userguide/dms_fleet.advisor-end-of-support.html">Amazon Web Services DMS Fleet Advisor end of support</a>. </p> </important> <p>Returns a list of schemas detected by Fleet Advisor Collectors in your account.</p>

    Args:
        filters: <p> If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:</p> <ul> <li> <p> <code>complexity</code> – The schema's complexity, for example <code>Simple</code>.</p> </li> <li> <p> <code>database-id</code> – The ID of the schema's database.</p> </li> <li> <p> <code>database-ip-address</code> – The IP address of the schema's database.</p> </li> <li> <p> <code>database-name</code> – The name of the schema's database.</p> </li> <li> <p> <code>database-engine</code> – The name of the schema database's engine.</p> </li> <li> <p> <code>original-schema-name</code> – The name of the schema's database's main schema.</p> </li> <li> <p> <code>schema-id</code> – The ID of the schema, for example <code>15</code>.</p> </li> <li> <p> <code>schema-name</code> – The name of the schema.</p> </li> <li> <p> <code>server-ip-address</code> – The IP address of the schema database's server.</p> </li> </ul> <p>An example is: <code>describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"</code> </p>
        max_records: <p>Sets the maximum number of records returned in the response.</p>
        next_token: <p>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> 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. </p>

    Raises:
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.describe_fleet_advisor_schemas_request.DescribeFleetAdvisorSchemasRequest]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.describe_fleet_advisor_schemas_response.DescribeFleetAdvisorSchemasResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_fleet_advisor_schemas

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.describe_fleet_advisor_schemas.describe_fleet_advisor_schemas(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFleetAdvisorSchemas")
    )
    input_: capo_database_migration_service.types.describe_fleet_advisor_schemas_request.DescribeFleetAdvisorSchemasRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output