Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeFleetAdvisorCollectors

Returns a list of the Fleet Advisor collectors in your account.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxRecords": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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"

Type: Array of Filter objects

Required: No

MaxRecords

Sets the maximum number of records returned in the response.

Type: Integer

Required: No

NextToken

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.

Type: String

Required: No

Response Syntax


{
   "Collectors": [ 
      { 
         "CollectorHealthCheck": { 
            "CollectorStatus": "string",
            "LocalCollectorS3Access": boolean,
            "WebCollectorGrantedRoleBasedAccess": boolean,
            "WebCollectorS3Access": boolean
         },
         "CollectorName": "string",
         "CollectorReferencedId": "string",
         "CollectorVersion": "string",
         "CreatedDate": "string",
         "Description": "string",
         "InventoryData": { 
            "NumberOfDatabases": number,
            "NumberOfSchemas": number
         },
         "LastDataReceived": "string",
         "ModifiedDate": "string",
         "RegisteredDate": "string",
         "S3BucketName": "string",
         "ServiceAccessRoleArn": "string",
         "VersionStatus": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Collectors

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

Type: Array of CollectorResponse objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidResourceStateFault

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

HTTP Status Code: 400