Skip to content

aws.dms.describe_fleet_advisor_collectors

Example SQL Queries

SELECT * FROM
aws.dms.describe_fleet_advisor_collectors;

Description

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

Table Definition

Column NameColumn Data Type
filters Input Column

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"

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter as specified for a Describe* or similar operation.

filters[].values[]
max_records Input Column

Sets the maximum number of records returned in the response.

BIGINT
next_token Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
collectors

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

STRUCT(
"collector_referenced_id" VARCHAR,
"collector_name" VARCHAR,
"collector_version" VARCHAR,
"version_status" VARCHAR,
"description" VARCHAR,
"s3_bucket_name" VARCHAR,
"service_access_role_arn" VARCHAR,
"collector_health_check" STRUCT(
"collector_status" VARCHAR,
"local_collector_s3_access" BOOLEAN,
"web_collector_s3_access" BOOLEAN,
"web_collector_granted_role_based_access" BOOLEAN
),
"last_data_received" VARCHAR,
"registered_date" VARCHAR,
"created_date" VARCHAR,
"modified_date" VARCHAR,
"inventory_data" STRUCT(
"number_of_databases" BIGINT,
"number_of_schemas" BIGINT
)
)[]
Show child fields
collectors[]
Show child fields
collectors[].collector_health_check

Describes the last Fleet Advisor collector health check.

Show child fields
collectors[].collector_health_check.collector_status

The status of the Fleet Advisor collector.

collectors[].collector_health_check.local_collector_s3_access

Whether the local collector can access its Amazon S3 bucket.

collectors[].collector_health_check.web_collector_granted_role_based_access

Whether the role that you provided when creating the Fleet Advisor collector has sufficient permissions to access the Fleet Advisor web collector.

collectors[].collector_health_check.web_collector_s3_access

Whether the web collector can access its Amazon S3 bucket.

collectors[].collector_name

The name of the Fleet Advisor collector .

collectors[].collector_referenced_id

The reference ID of the Fleet Advisor collector.

collectors[].collector_version

The version of your Fleet Advisor collector, in semantic versioning format, for example 1.0.2

collectors[].created_date

The timestamp when you created the collector, in the following format: 2022-01-24T19:04:02.596113Z

collectors[].description

A summary description of the Fleet Advisor collector.

collectors[].inventory_data

Describes a Fleet Advisor collector inventory.

Show child fields
collectors[].inventory_data.number_of_databases

The number of databases in the Fleet Advisor collector inventory.

collectors[].inventory_data.number_of_schemas

The number of schemas in the Fleet Advisor collector inventory.

collectors[].last_data_received

The timestamp of the last time the collector received data, in the following format: 2022-01-24T19:04:02.596113Z

collectors[].modified_date

The timestamp when DMS last modified the collector, in the following format: 2022-01-24T19:04:02.596113Z

collectors[].registered_date

The timestamp when DMS registered the collector, in the following format: 2022-01-24T19:04:02.596113Z

collectors[].s3_bucket_name

The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.

collectors[].service_access_role_arn

The IAM role that grants permissions to access the specified Amazon S3 bucket.

collectors[].version_status

Whether the collector version is up to date.