DescribedAgreement - Amazon Transfer Family
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribedAgreement

Describes the properties of an agreement.

Contents

AccessRole

With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*role/.*

Required: No

AgreementId

A unique identifier for the agreement. This identifier is returned when you create an agreement.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^a-([0-9a-f]{17})$

Required: No

Arn

The unique Amazon Resource Name (ARN) for the agreement.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:.*

Required: Yes

BaseDirectory

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^$|/.*

Required: No

Description

The name or short description that's used to identify the agreement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[\p{Graph}]+

Required: No

LocalProfileId

A unique identifier for the AS2 local profile.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^p-([0-9a-f]{17})$

Required: No

PartnerProfileId

A unique identifier for the partner profile used in the agreement.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^p-([0-9a-f]{17})$

Required: No

ServerId

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^s-([0-9a-f]{17})$

Required: No

Status

The current status of the agreement, either ACTIVE or INACTIVE.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

Tags

Key-value pairs that can be used to group and search for agreements.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: