DescribedAgreement

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

Type: String

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

Pattern: arn:\S+

Required: Yes

Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon Resource Name (ARN) of the AWS Identity and Access Management role to use.

For AS2 connectors

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.

If you are using Basic authentication for your AS2 connector, the access role requires the secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a customer-managed key instead of the AWS managed key in Secrets Manager, then the role also needs the kms:Decrypt permission for that key.

For SFTP connectors

Make sure that the access role provides read and write access to the parent directory of the file location that's used in the StartFileTransfer request. Additionally, make sure that the role provides secretsmanager:GetSecretValue permission to AWS Secrets Manager.

Type: String

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

Pattern: arn:.*role/\S+

Required: No

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

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: (|/.*)

Required: No

A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.

Type: CustomDirectoriesType object

Required: No

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

Determines whether or not unsigned messages from your trading partners will be accepted.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

A unique identifier for the AS2 local profile.

Type: String

Length Constraints: Fixed length of 19.

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

Required: No

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

Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

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

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

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

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