Skip to main content

agents_list_only

Lists agents in a region or regions, for all properties use agents

Overview

Nameagents_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::Agent.
Idaws.datasync.agents_list_only

Fields

NameDatatypeDescription
agent_namestringThe name configured for the agent. Text reference used to identify the agent in the console.
activation_keystringActivation key of the Agent.
security_group_arnsarrayThe ARNs of the security group used to protect your data transfer task subnets.
subnet_arnsarrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
vpc_endpoint_idstringThe ID of the VPC endpoint that the agent has access to.
endpoint_typestringThe service endpoints that the agent will connect to.
tagsarrayAn array of key-value pairs to apply to this resource.
agent_arnstringThe DataSync Agent ARN.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all agents in a region.

SELECT
region,
agent_arn
FROM aws.datasync.agents_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the agents_list_only resource, see agents