Skip to content
AWS for Query.Farm

aws.datasync.describe_agent

Example SQL Queries

SELECT * FROM
aws.datasync.describe_agent
WHERE
"agent_arn" = 'VALUE';

Description

Returns information about an DataSync agent, such as its name, service endpoint type, and status.

Table Definition

Column NameColumn Data Type
agent_arn Required Input Column

The ARN of the agent.

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
creation_time

The time that the agent was activated.

TIMESTAMP_S
endpoint_type

The type of service endpoint that your agent is connected to.

VARCHAR
last_connection_time

The last time that the agent was communicating with the DataSync service.

TIMESTAMP_S
name

The name of the agent.

VARCHAR
platform

The platform-related details about the agent, such as the version number.

STRUCT(
    "version" VARCHAR
)
Show child fields
platform.version

The version of the DataSync agent.

private_link_config

The network configuration that the agent uses when connecting to a VPC service endpoint.

STRUCT(
    "vpc_endpoint_id" VARCHAR,
    "private_link_endpoint" VARCHAR,
    "subnet_arns" VARCHAR[],
    "security_group_arns" VARCHAR[]
)
Show child fields
private_link_config.private_link_endpoint

Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.

private_link_config.security_group_arns[]
private_link_config.subnet_arns[]
private_link_config.vpc_endpoint_id

Specifies the ID of the VPC endpoint that your agent connects to.

status

The status of the agent.

  • If the status is ONLINE, the agent is configured properly and ready to use.

  • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline? 

VARCHAR