[ aws . dms ]

describe-fleet-advisor-schemas

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-fleet-advisor-schemas
[--filters <value>]
[--max-records <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--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"

(structure)

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)

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

Values -> (list)

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

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--max-records (integer)

Sets the maximum number of records returned in the response.

--next-token (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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

FleetAdvisorSchemas -> (list)

A collection of SchemaResponse objects.

(structure)

Describes a schema in a Fleet Advisor collector inventory.

CodeLineCount -> (long)

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

CodeSize -> (long)

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 -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (double)

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.