agreement

Gets an individual agreement resource

Overview

Name	agreement
Type	Resource
Description	agreement
Id	awscc.transfer.agreement

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.
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.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
description,
server_id,
local_profile_id,
partner_profile_id,
base_directory,
access_role,
status,
tags,
agreement_id,
arn
FROM awscc.transfer.agreement
WHERE data__Identifier = '<AgreementId>|<ServerId>';

Permissions

To operate on the agreement resource, the following permissions are required:

Read

transfer:DescribeAgreement

Update

transfer:UpdateAgreement,
transfer:UnTagResource,
transfer:TagResource,
iam:PassRole

Delete

transfer:DeleteAgreement