agreement_tags

Expands all tag keys and values for agreements in a region

Overview

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

Fields

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.
agreement_id	string	A unique identifier for the agreement.
arn	string	Specifies the unique Amazon Resource Name (ARN) for the agreement.
tag_key	string	Tag key.
tag_value	string	Tag value.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Expands tags for all agreements in a region.

SELECT
region,
description,
server_id,
local_profile_id,
partner_profile_id,
base_directory,
access_role,
status,
agreement_id,
arn,
tag_key,
tag_value
FROM aws.transfer.agreement_tags
WHERE region = 'us-east-1';

Permissions

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