collectors

Creates, updates, deletes, gets or lists a collectors resource.

Overview

Name	collectors
Type	Resource
Id	aws.migrationhubstrategy.collectors

Fields

The following fields are returned by SELECT queries:

list_collectors

Name	Datatype	Description
collector_health	string	Indicates the health of a collector. (COLLECTOR_HEALTHY, COLLECTOR_UNHEALTHY)
collector_id	string	The ID of the collector. (pattern: <code>.\S.</code>)
collector_version	string	Current version of the collector that is running in the environment that you specify. (pattern: <code>.\S.</code>)
configuration_summary	object	Summary of the collector configuration.
host_name	string	Hostname of the server that is hosting the collector. (pattern: <code>.\S.</code>)
ip_address	string	IP address of the server that is hosting the collector. (pattern: <code>.\S.</code>)
last_activity_time_stamp	string	Time when the collector last pinged the service. (pattern: <code>.\S.</code>)
registered_time_stamp	string	Time when the collector registered with the service. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_collectors	select	region	maxResults, nextToken	Retrieves a list of all the installed collectors.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of items to include in the response. The maximum value is 100.
nextToken	string	The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

SELECT examples

list_collectors

Retrieves a list of all the installed collectors.

SELECT
collector_health,
collector_id,
collector_version,
configuration_summary,
host_name,
ip_address,
last_activity_time_stamp,
registered_time_stamp
FROM aws.migrationhubstrategy.collectors
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;