fleet_advisor_collectors

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

Overview

Name	fleet_advisor_collectors
Type	Resource
Id	aws.dms.fleet_advisor_collectors

Fields

The following fields are returned by SELECT queries:

describe_fleet_advisor_collectors

Name	Datatype	Description
collectors	array	Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.
next_token	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fleet_advisor_collectors	select	region		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.
create_fleet_advisor_collector	insert	region, CollectorName, ServiceAccessRoleArn, S3BucketName		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. Creates a Fleet Advisor collector using the specified parameters.
delete_fleet_advisor_collector	delete	region		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. Deletes the specified Fleet Advisor collector.

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)

SELECT examples

describe_fleet_advisor_collectors

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.

SELECT
collectors,
next_token
FROM aws.dms.fleet_advisor_collectors
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_fleet_advisor_collector

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. Creates a Fleet Advisor collector using the specified parameters.

INSERT INTO aws.dms.fleet_advisor_collectors (
CollectorName,
Description,
ServiceAccessRoleArn,
S3BucketName,
region
)
SELECT 
'{{ CollectorName }}' /* required */,
'{{ Description }}',
'{{ ServiceAccessRoleArn }}' /* required */,
'{{ S3BucketName }}' /* required */,
'{{ region }}'
RETURNING
collector_name,
collector_referenced_id,
description,
s3_bucket_name,
service_access_role_arn
;

Manifest

# Description fields are for documentation purposes
- name: fleet_advisor_collectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the fleet_advisor_collectors resource.
  - name: CollectorName
    value: "{{ CollectorName }}"
    description: |
      The name of your Fleet Advisor collector (for example, sample-collector).
  - name: Description
    value: "{{ Description }}"
    description: |
      A summary description of your Fleet Advisor collector.
  - name: ServiceAccessRoleArn
    value: "{{ ServiceAccessRoleArn }}"
    description: |
      The IAM role that grants permissions to access the specified Amazon S3 bucket.
  - name: S3BucketName
    value: "{{ S3BucketName }}"
    description: |
      The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.

DELETE examples

delete_fleet_advisor_collector

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. Deletes the specified Fleet Advisor collector.

DELETE FROM aws.dms.fleet_advisor_collectors
WHERE region = '{{ region }}' --required
;