2025/01/24 - AWS Transfer Family - 3 updated api methods
Changes Added CustomDirectories as a new directory option for storing inbound AS2 messages, MDN files and Status files.
{'CustomDirectories': {'FailedFilesDirectory': 'string',
'MdnFilesDirectory': 'string',
'PayloadFilesDirectory': 'string',
'StatusFilesDirectory': 'string',
'TemporaryFilesDirectory': 'string'}}
Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an 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.
See also: AWS API Documentation
Request Syntax
client.create_agreement(
Description='string',
ServerId='string',
LocalProfileId='string',
PartnerProfileId='string',
BaseDirectory='string',
AccessRole='string',
Status='ACTIVE'|'INACTIVE',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
PreserveFilename='ENABLED'|'DISABLED',
EnforceMessageSigning='ENABLED'|'DISABLED',
CustomDirectories={
'FailedFilesDirectory': 'string',
'MdnFilesDirectory': 'string',
'PayloadFilesDirectory': 'string',
'StatusFilesDirectory': 'string',
'TemporaryFilesDirectory': 'string'
}
)
string
A name or short description to identify the agreement.
string
[REQUIRED]
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
string
[REQUIRED]
A unique identifier for the AS2 local profile.
string
[REQUIRED]
A unique identifier for the partner profile used in the agreement.
string
The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory example is /amzn-s3-demo-bucket/home/mydirectory.
string
[REQUIRED]
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 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 Amazon Web Services 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 Secrets Manager.
string
The status of the agreement. The agreement can be either ACTIVE or INACTIVE.
list
Key-value pairs that can be used to group and search for agreements.
(dict) --
Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
Key (string) -- [REQUIRED]
The name assigned to the tag that you create.
Value (string) -- [REQUIRED]
Contains one or more values that you assigned to the key name you create.
string
Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.
ENABLED: the filename provided by your trading parter is preserved when the file is saved.
DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.
string
Determines whether or not unsigned messages from your trading partners will be accepted.
ENABLED: Transfer Family rejects unsigned messages from your trading partner.
DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.
dict
A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.
Failed files
MDN files
Payload files
Status files
Temporary files
FailedFilesDirectory (string) -- [REQUIRED]
Specifies a location to store failed AS2 message files.
MdnFilesDirectory (string) -- [REQUIRED]
Specifies a location to store MDN files.
PayloadFilesDirectory (string) -- [REQUIRED]
Specifies a location to store the payload for AS2 message files.
StatusFilesDirectory (string) -- [REQUIRED]
Specifies a location to store AS2 status messages.
TemporaryFilesDirectory (string) -- [REQUIRED]
Specifies a location to store temporary AS2 message files.
dict
Response Syntax
{
'AgreementId': 'string'
}
Response Structure
(dict) --
AgreementId (string) --
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.
{'Agreement': {'CustomDirectories': {'FailedFilesDirectory': 'string',
'MdnFilesDirectory': 'string',
'PayloadFilesDirectory': 'string',
'StatusFilesDirectory': 'string',
'TemporaryFilesDirectory': 'string'}}}
Describes the agreement that's identified by the AgreementId.
See also: AWS API Documentation
Request Syntax
client.describe_agreement(
AgreementId='string',
ServerId='string'
)
string
[REQUIRED]
A unique identifier for the agreement. This identifier is returned when you create an agreement.
string
[REQUIRED]
The server identifier that's associated with the agreement.
dict
Response Syntax
{
'Agreement': {
'Arn': 'string',
'AgreementId': 'string',
'Description': 'string',
'Status': 'ACTIVE'|'INACTIVE',
'ServerId': 'string',
'LocalProfileId': 'string',
'PartnerProfileId': 'string',
'BaseDirectory': 'string',
'AccessRole': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PreserveFilename': 'ENABLED'|'DISABLED',
'EnforceMessageSigning': 'ENABLED'|'DISABLED',
'CustomDirectories': {
'FailedFilesDirectory': 'string',
'MdnFilesDirectory': 'string',
'PayloadFilesDirectory': 'string',
'StatusFilesDirectory': 'string',
'TemporaryFilesDirectory': 'string'
}
}
}
Response Structure
(dict) --
Agreement (dict) --
The details for the specified agreement, returned as a DescribedAgreement object.
Arn (string) --
The unique Amazon Resource Name (ARN) for the agreement.
AgreementId (string) --
A unique identifier for the agreement. This identifier is returned when you create an agreement.
Description (string) --
The name or short description that's used to identify the agreement.
Status (string) --
The current status of the agreement, either ACTIVE or INACTIVE.
ServerId (string) --
A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.
LocalProfileId (string) --
A unique identifier for the AS2 local profile.
PartnerProfileId (string) --
A unique identifier for the partner profile used in the agreement.
BaseDirectory (string) --
The landing directory (folder) for files that are transferred by using the AS2 protocol.
AccessRole (string) --
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 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 Amazon Web Services 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 Secrets Manager.
Tags (list) --
Key-value pairs that can be used to group and search for agreements.
(dict) --
Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
Key (string) --
The name assigned to the tag that you create.
Value (string) --
Contains one or more values that you assigned to the key name you create.
PreserveFilename (string) --
Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.
ENABLED: the filename provided by your trading parter is preserved when the file is saved.
DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.
EnforceMessageSigning (string) --
Determines whether or not unsigned messages from your trading partners will be accepted.
ENABLED: Transfer Family rejects unsigned messages from your trading partner.
DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.
CustomDirectories (dict) --
A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.
Failed files
MDN files
Payload files
Status files
Temporary files
FailedFilesDirectory (string) --
Specifies a location to store failed AS2 message files.
MdnFilesDirectory (string) --
Specifies a location to store MDN files.
PayloadFilesDirectory (string) --
Specifies a location to store the payload for AS2 message files.
StatusFilesDirectory (string) --
Specifies a location to store AS2 status messages.
TemporaryFilesDirectory (string) --
Specifies a location to store temporary AS2 message files.
{'CustomDirectories': {'FailedFilesDirectory': 'string',
'MdnFilesDirectory': 'string',
'PayloadFilesDirectory': 'string',
'StatusFilesDirectory': 'string',
'TemporaryFilesDirectory': 'string'}}
Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.
See also: AWS API Documentation
Request Syntax
client.update_agreement(
AgreementId='string',
ServerId='string',
Description='string',
Status='ACTIVE'|'INACTIVE',
LocalProfileId='string',
PartnerProfileId='string',
BaseDirectory='string',
AccessRole='string',
PreserveFilename='ENABLED'|'DISABLED',
EnforceMessageSigning='ENABLED'|'DISABLED',
CustomDirectories={
'FailedFilesDirectory': 'string',
'MdnFilesDirectory': 'string',
'PayloadFilesDirectory': 'string',
'StatusFilesDirectory': 'string',
'TemporaryFilesDirectory': 'string'
}
)
string
[REQUIRED]
A unique identifier for the agreement. This identifier is returned when you create an agreement.
string
[REQUIRED]
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
string
To replace the existing description, provide a short description for the agreement.
string
You can update the status for the agreement, either activating an inactive agreement or the reverse.
string
A unique identifier for the AS2 local profile.
To change the local profile identifier, provide a new value here.
string
A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.
string
To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want to use; for example, ``/amzn-s3-demo-bucket/home/mydirectory ``.
string
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 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 Amazon Web Services 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 Secrets Manager.
string
Determines whether or not Transfer Family appends a unique string of characters to the end of the AS2 message payload filename when saving it.
ENABLED: the filename provided by your trading parter is preserved when the file is saved.
DISABLED (default value): when Transfer Family saves the file, the filename is adjusted, as described in File names and locations.
string
Determines whether or not unsigned messages from your trading partners will be accepted.
ENABLED: Transfer Family rejects unsigned messages from your trading partner.
DISABLED (default value): Transfer Family accepts unsigned messages from your trading partner.
dict
A CustomDirectoriesType structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.
Failed files
MDN files
Payload files
Status files
Temporary files
FailedFilesDirectory (string) -- [REQUIRED]
Specifies a location to store failed AS2 message files.
MdnFilesDirectory (string) -- [REQUIRED]
Specifies a location to store MDN files.
PayloadFilesDirectory (string) -- [REQUIRED]
Specifies a location to store the payload for AS2 message files.
StatusFilesDirectory (string) -- [REQUIRED]
Specifies a location to store AS2 status messages.
TemporaryFilesDirectory (string) -- [REQUIRED]
Specifies a location to store temporary AS2 message files.
dict
Response Syntax
{
'AgreementId': 'string'
}
Response Structure
(dict) --
AgreementId (string) --
A unique identifier for the agreement. This identifier is returned when you create an agreement.