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 |
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
.
Synopsis
- data CreateAgreement = CreateAgreement' {
- description :: Maybe Text
- status :: Maybe AgreementStatusType
- tags :: Maybe (NonEmpty Tag)
- serverId :: Text
- localProfileId :: Text
- partnerProfileId :: Text
- baseDirectory :: Text
- accessRole :: Text
- newCreateAgreement :: Text -> Text -> Text -> Text -> Text -> CreateAgreement
- createAgreement_description :: Lens' CreateAgreement (Maybe Text)
- createAgreement_status :: Lens' CreateAgreement (Maybe AgreementStatusType)
- createAgreement_tags :: Lens' CreateAgreement (Maybe (NonEmpty Tag))
- createAgreement_serverId :: Lens' CreateAgreement Text
- createAgreement_localProfileId :: Lens' CreateAgreement Text
- createAgreement_partnerProfileId :: Lens' CreateAgreement Text
- createAgreement_baseDirectory :: Lens' CreateAgreement Text
- createAgreement_accessRole :: Lens' CreateAgreement Text
- data CreateAgreementResponse = CreateAgreementResponse' {
- httpStatus :: Int
- agreementId :: Text
- newCreateAgreementResponse :: Int -> Text -> CreateAgreementResponse
- createAgreementResponse_httpStatus :: Lens' CreateAgreementResponse Int
- createAgreementResponse_agreementId :: Lens' CreateAgreementResponse Text
Creating a Request
data CreateAgreement Source #
See: newCreateAgreement
smart constructor.
CreateAgreement' | |
|
Instances
Create a value of CreateAgreement
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:
CreateAgreement
, createAgreement_description
- A name or short description to identify the agreement.
CreateAgreement
, createAgreement_status
- The status of the agreement. The agreement can be either ACTIVE
or
INACTIVE
.
CreateAgreement
, createAgreement_tags
- Key-value pairs that can be used to group and search for agreements.
CreateAgreement
, createAgreement_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that the agreement uses.
CreateAgreement
, createAgreement_localProfileId
- A unique identifier for the AS2 local profile.
CreateAgreement
, createAgreement_partnerProfileId
- A unique identifier for the partner profile used in the agreement.
CreateAgreement
, createAgreement_baseDirectory
- The landing directory (folder) for files transferred by using the AS2
protocol.
A BaseDirectory
example is
DOC-EXAMPLE-BUCKET/home/mydirectory.
CreateAgreement
, createAgreement_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
.
Request Lenses
createAgreement_description :: Lens' CreateAgreement (Maybe Text) Source #
A name or short description to identify the agreement.
createAgreement_status :: Lens' CreateAgreement (Maybe AgreementStatusType) Source #
The status of the agreement. The agreement can be either ACTIVE
or
INACTIVE
.
createAgreement_tags :: Lens' CreateAgreement (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for agreements.
createAgreement_serverId :: Lens' CreateAgreement Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses.
createAgreement_localProfileId :: Lens' CreateAgreement Text Source #
A unique identifier for the AS2 local profile.
createAgreement_partnerProfileId :: Lens' CreateAgreement Text Source #
A unique identifier for the partner profile used in the agreement.
createAgreement_baseDirectory :: Lens' CreateAgreement Text Source #
The landing directory (folder) for files transferred by using the AS2 protocol.
A BaseDirectory
example is
DOC-EXAMPLE-BUCKET/home/mydirectory.
createAgreement_accessRole :: Lens' CreateAgreement 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
.
Destructuring the Response
data CreateAgreementResponse Source #
See: newCreateAgreementResponse
smart constructor.
CreateAgreementResponse' | |
|
Instances
newCreateAgreementResponse Source #
:: Int | |
-> Text | |
-> CreateAgreementResponse |
Create a value of CreateAgreementResponse
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:CreateAgreementResponse'
, createAgreementResponse_httpStatus
- The response's http status code.
CreateAgreementResponse
, createAgreementResponse_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.
Response Lenses
createAgreementResponse_httpStatus :: Lens' CreateAgreementResponse Int Source #
The response's http status code.
createAgreementResponse_agreementId :: Lens' CreateAgreementResponse Text Source #
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.