Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data UpdateAgreement = UpdateAgreement' {}
- newUpdateAgreement :: Text -> Text -> UpdateAgreement
- updateAgreement_accessRole :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_baseDirectory :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_description :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_localProfileId :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_partnerProfileId :: Lens' UpdateAgreement (Maybe Text)
- updateAgreement_status :: Lens' UpdateAgreement (Maybe AgreementStatusType)
- updateAgreement_agreementId :: Lens' UpdateAgreement Text
- updateAgreement_serverId :: Lens' UpdateAgreement Text
- data UpdateAgreementResponse = UpdateAgreementResponse' {
- httpStatus :: Int
- agreementId :: Text
- newUpdateAgreementResponse :: Int -> Text -> UpdateAgreementResponse
- updateAgreementResponse_httpStatus :: Lens' UpdateAgreementResponse Int
- updateAgreementResponse_agreementId :: Lens' UpdateAgreementResponse Text
Creating a Request
data UpdateAgreement Source #
See: newUpdateAgreement
smart constructor.
UpdateAgreement' | |
|
Instances
Create a value of UpdateAgreement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAgreement
, updateAgreement_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
.
UpdateAgreement
, updateAgreement_baseDirectory
- To change the landing directory (folder) for files that are transferred,
provide the bucket folder that you want to use; for example,
/
DOC-EXAMPLE-BUCKET
/
home
/
mydirectory
.
UpdateAgreement
, updateAgreement_description
- To replace the existing description, provide a short description for the
agreement.
UpdateAgreement
, updateAgreement_localProfileId
- A unique identifier for the AS2 local profile.
To change the local profile identifier, provide a new value here.
UpdateAgreement
, updateAgreement_partnerProfileId
- A unique identifier for the partner profile. To change the partner
profile identifier, provide a new value here.
UpdateAgreement
, updateAgreement_status
- You can update the status for the agreement, either activating an
inactive agreement or the reverse.
UpdateAgreement
, updateAgreement_agreementId
- A unique identifier for the agreement. This identifier is returned when
you create an agreement.
UpdateAgreement
, updateAgreement_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
Request Lenses
updateAgreement_accessRole :: Lens' UpdateAgreement (Maybe Text) Source #
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
.
updateAgreement_baseDirectory :: Lens' UpdateAgreement (Maybe Text) Source #
To change the landing directory (folder) for files that are transferred,
provide the bucket folder that you want to use; for example,
/
DOC-EXAMPLE-BUCKET
/
home
/
mydirectory
.
updateAgreement_description :: Lens' UpdateAgreement (Maybe Text) Source #
To replace the existing description, provide a short description for the agreement.
updateAgreement_localProfileId :: Lens' UpdateAgreement (Maybe Text) Source #
A unique identifier for the AS2 local profile.
To change the local profile identifier, provide a new value here.
updateAgreement_partnerProfileId :: Lens' UpdateAgreement (Maybe Text) Source #
A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here.
updateAgreement_status :: Lens' UpdateAgreement (Maybe AgreementStatusType) Source #
You can update the status for the agreement, either activating an inactive agreement or the reverse.
updateAgreement_agreementId :: Lens' UpdateAgreement Text Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.
updateAgreement_serverId :: Lens' UpdateAgreement Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
Destructuring the Response
data UpdateAgreementResponse Source #
See: newUpdateAgreementResponse
smart constructor.
UpdateAgreementResponse' | |
|
Instances
newUpdateAgreementResponse Source #
Create a value of UpdateAgreementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAgreementResponse'
, updateAgreementResponse_httpStatus
- The response's http status code.
UpdateAgreement
, updateAgreementResponse_agreementId
- A unique identifier for the agreement. This identifier is returned when
you create an agreement.
Response Lenses
updateAgreementResponse_httpStatus :: Lens' UpdateAgreementResponse Int Source #
The response's http status code.
updateAgreementResponse_agreementId :: Lens' UpdateAgreementResponse Text Source #
A unique identifier for the agreement. This identifier is returned when you create an agreement.