DescribeFleetAdvisorCollectorsCommand

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 the Fleet Advisor collectors in your account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DatabaseMigrationServiceClient, DescribeFleetAdvisorCollectorsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import
// const { DatabaseMigrationServiceClient, DescribeFleetAdvisorCollectorsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import
const client = new DatabaseMigrationServiceClient(config);
const input = { // DescribeFleetAdvisorCollectorsRequest
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeFleetAdvisorCollectorsCommand(input);
const response = await client.send(command);
// { // DescribeFleetAdvisorCollectorsResponse
//   Collectors: [ // CollectorResponses
//     { // CollectorResponse
//       CollectorReferencedId: "STRING_VALUE",
//       CollectorName: "STRING_VALUE",
//       CollectorVersion: "STRING_VALUE",
//       VersionStatus: "UP_TO_DATE" || "OUTDATED" || "UNSUPPORTED",
//       Description: "STRING_VALUE",
//       S3BucketName: "STRING_VALUE",
//       ServiceAccessRoleArn: "STRING_VALUE",
//       CollectorHealthCheck: { // CollectorHealthCheck
//         CollectorStatus: "UNREGISTERED" || "ACTIVE",
//         LocalCollectorS3Access: true || false,
//         WebCollectorS3Access: true || false,
//         WebCollectorGrantedRoleBasedAccess: true || false,
//       },
//       LastDataReceived: "STRING_VALUE",
//       RegisteredDate: "STRING_VALUE",
//       CreatedDate: "STRING_VALUE",
//       ModifiedDate: "STRING_VALUE",
//       InventoryData: { // InventoryData
//         NumberOfDatabases: Number("int"),
//         NumberOfSchemas: Number("int"),
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeFleetAdvisorCollectorsCommand Input

Parameter
Type
Description
Filters
Filter[] | undefined

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

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

  • collector-name – The name of the collector agent.

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

MaxRecords
number | undefined

Sets the maximum number of records returned in the response.

NextToken
string | undefined

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.

DescribeFleetAdvisorCollectorsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Collectors
CollectorResponse[] | undefined

Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.

NextToken
string | undefined

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.

Throws

Name
Fault
Details
InvalidResourceStateFault
client

The resource is in a state that prevents it from being used for database migration.

DatabaseMigrationServiceServiceException
Base exception class for all service exceptions from DatabaseMigrationService service.