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

Fields

Name	Datatype	Description
server_id	string	A unique identifier for the server.
agreement_id	string	A unique identifier for the agreement.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all agreements in a region.

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

Permissions

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