agreements_list_only

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

Overview

Name	`agreements_list_only`
Type	Resource
Description	Resource Type definition for AWS::Transfer::Agreement
Id	`aws.transfer.agreements_list_only`

Name	Datatype	Description
`description`	`string`	A textual description for the agreement.
`server_id`	`string`	A unique identifier for the server.
`local_profile_id`	`string`	A unique identifier for the local profile.
`partner_profile_id`	`string`	A unique identifier for the partner profile.
`base_directory`	`string`	Specifies the base directory for the agreement.
`access_role`	`string`	Specifies the access role for the agreement.
`status`	`string`	Specifies the status of the agreement.
`tags`	`array`	Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
`agreement_id`	`string`	A unique identifier for the agreement.
`arn`	`string`	Specifies the unique Amazon Resource Name (ARN) for the agreement.
`region`	`string`	AWS region.

Name	Accessible by	Required Params
`list_resources`	`SELECT`	`region`

Lists all agreements in a region.

SELECT
region,
agreement_id,
server_id
FROM aws.transfer.agreements_list_only
WHERE region = 'us-east-1';

For permissions required to operate on the agreements_list_only resource, see agreements