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 the local or partner profile to use for AS2 transfers.
Synopsis
- data CreateProfile = CreateProfile' {
- certificateIds :: Maybe [Text]
- tags :: Maybe (NonEmpty Tag)
- as2Id :: Text
- profileType :: ProfileType
- newCreateProfile :: Text -> ProfileType -> CreateProfile
- createProfile_certificateIds :: Lens' CreateProfile (Maybe [Text])
- createProfile_tags :: Lens' CreateProfile (Maybe (NonEmpty Tag))
- createProfile_as2Id :: Lens' CreateProfile Text
- createProfile_profileType :: Lens' CreateProfile ProfileType
- data CreateProfileResponse = CreateProfileResponse' {
- httpStatus :: Int
- profileId :: Text
- newCreateProfileResponse :: Int -> Text -> CreateProfileResponse
- createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int
- createProfileResponse_profileId :: Lens' CreateProfileResponse Text
Creating a Request
data CreateProfile Source #
See: newCreateProfile
smart constructor.
CreateProfile' | |
|
Instances
Create a value of CreateProfile
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:
CreateProfile
, createProfile_certificateIds
- An array of identifiers for the imported certificates. You use this
identifier for working with profiles and partner profiles.
CreateProfile
, createProfile_tags
- Key-value pairs that can be used to group and search for AS2 profiles.
CreateProfile
, createProfile_as2Id
- The As2Id
is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From
header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To
header for
the AS2 messages sent to the partner using the StartFileTransfer
API
operation. This ID cannot include spaces.
CreateProfile
, createProfile_profileType
- Determines the type of profile to create:
- Specify
LOCAL
to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party. - Specify
PARTNER
to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.
Request Lenses
createProfile_certificateIds :: Lens' CreateProfile (Maybe [Text]) Source #
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
createProfile_tags :: Lens' CreateProfile (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for AS2 profiles.
createProfile_as2Id :: Lens' CreateProfile Text Source #
The As2Id
is the AS2-name, as defined in the
RFC 4130. For inbound
transfers, this is the AS2-From
header for the AS2 messages sent from
the partner. For outbound connectors, this is the AS2-To
header for
the AS2 messages sent to the partner using the StartFileTransfer
API
operation. This ID cannot include spaces.
createProfile_profileType :: Lens' CreateProfile ProfileType Source #
Determines the type of profile to create:
- Specify
LOCAL
to create a local profile. A local profile represents the AS2-enabled Transfer Family server organization or party. - Specify
PARTNER
to create a partner profile. A partner profile represents a remote organization, external to Transfer Family.
Destructuring the Response
data CreateProfileResponse Source #
See: newCreateProfileResponse
smart constructor.
CreateProfileResponse' | |
|
Instances
newCreateProfileResponse Source #
Create a value of CreateProfileResponse
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:CreateProfileResponse'
, createProfileResponse_httpStatus
- The response's http status code.
CreateProfileResponse
, createProfileResponse_profileId
- The unique identifier for the AS2 profile, returned after the API call
succeeds.
Response Lenses
createProfileResponse_httpStatus :: Lens' CreateProfileResponse Int Source #
The response's http status code.
createProfileResponse_profileId :: Lens' CreateProfileResponse Text Source #
The unique identifier for the AS2 profile, returned after the API call succeeds.