UpdateAgreement
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.
Request Syntax
{
"AccessRole": "string
",
"AgreementId": "string
",
"BaseDirectory": "string
",
"Description": "string
",
"LocalProfileId": "string
",
"PartnerProfileId": "string
",
"ServerId": "string
",
"Status": "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: 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: Yes
- BaseDirectory
-
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
.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
(|/.*)
Required: No
- Description
-
To replace the existing description, provide a short description for 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.
To change the local profile identifier, provide a new value here.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
p-([0-9a-f]{17})
Required: No
- PartnerProfileId
-
A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.
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 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
-
You can update the status for the agreement, either activating an inactive agreement or the reverse.
Type: String
Valid Values:
ACTIVE | INACTIVE
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
-
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})
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
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: