CreateAgreement
Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Amazon Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.
The partner is identified with the PartnerProfileId
, and the AS2 process is identified with the LocalProfileId
.
Request Syntax
{
"AccessRole": "string
",
"BaseDirectory": "string
",
"Description": "string
",
"LocalProfileId": "string
",
"PartnerProfileId": "string
",
"ServerId": "string
",
"Status": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AccessRole
-
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 Amazon 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, theAccessRole
needs to provide read and write access to the parent directory of the file location used in theStartFileTransfer
request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send withStartFileTransfer
.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 Amazon managed key in Secrets Manager, then the role also needs thekms: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 providessecretsmanager:GetSecretValue
permission to Amazon Secrets Manager.Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:.*role/\S+
Required: Yes
- BaseDirectory
-
The landing directory (folder) for files transferred by using the AS2 protocol.
A
BaseDirectory
example is/amzn-s3-demo-bucket/home/mydirectory
.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
(|/.*)
Required: Yes
- Description
-
A name or short description 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: Yes
- 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: Yes
- ServerId
-
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
s-([0-9a-f]{17})
Required: Yes
- Status
-
The status of the agreement. The agreement can be either
ACTIVE
orINACTIVE
.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
Response Syntax
{
"AgreementId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AgreementId
-
The unique identifier for the agreement. Use this ID for deleting, or updating an agreement, as well as in any other API calls that require that you specify the agreement ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
a-([0-9a-f]{17})
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
This exception is thrown when an error occurs in the Amazon Transfer Family service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
- ResourceExistsException
-
The requested resource does not exist, or exists in a region other than the one specified for the command.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when a resource is not found by the AmazonTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AmazonTransfer Family service is not available.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
Examples
Example
The following example creates an agreement, and returns the agreement ID.
aws transfer create-agreement --server-id s-021345abcdef6789 --local-profile-id p-1234567890abcdef0 --partner-profile-id p-abcdef01234567890 --base-folder /amzn-s3-demo-bucket/AS2-files --access-role arn:aws:iam::111122223333:role/AS2-role
Sample Response
The API call returns the agreement ID for the new agreement.
{ "AgreementId": "a-11112222333344444" }
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: