[ aws . dms ]

describe-fleet-advisor-databases

Description

Returns a list of Fleet Advisor databases in your account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-fleet-advisor-databases
[--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 databases that meet the filter criteria:

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

• database-name – The name of the database.

• database-engine – The name of the database engine.

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

• database-ip-address – The IP address of the database.

• collector-name – The name of the associated Fleet Advisor collector.

An example is: describe-fleet-advisor-databases --filter Name="database-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"

(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

Databases -> (list)

Provides descriptions of the Fleet Advisor collector databases, including the database’s collector, ID, and name.

(structure)

Describes a database 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.

IpAddress -> (string)

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

NumberOfSchemas -> (long)

The number of schemas in a Fleet Advisor collector inventory database.

Server -> (structure)

The server name of a database 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.

SoftwareDetails -> (structure)

The software details of a database in a Fleet Advisor collector inventory, such as database engine and version.

Engine -> (string)

The database engine of a database in a Fleet Advisor collector inventory, for example Microsoft SQL Server .

EngineVersion -> (string)

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

EngineEdition -> (string)

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

ServicePack -> (string)

The service pack level of the database.

SupportLevel -> (string)

The support level of the database, for example Mainstream support .

OsArchitecture -> (integer)

The operating system architecture of the database.

Tooltip -> (string)

Information about the database engine software, for example Mainstream support ends on November 14th, 2024 .

Collectors -> (list)

A list of collectors associated with the database.

(structure)

Briefly describes a Fleet Advisor collector.

CollectorReferencedId -> (string)

The reference ID of the Fleet Advisor collector.

CollectorName -> (string)

The name of the Fleet Advisor collector.

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.