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

Amazonka.Transfer.CreateProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates the local or partner profile to use for AS2 transfers.

Synopsis

Creating a Request

data CreateProfile Source #

See: newCreateProfile smart constructor.

Constructors

CreateProfile'

Fields

certificateIds :: Maybe [Text]
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
tags :: Maybe (NonEmpty Tag)
Key-value pairs that can be used to group and search for AS2 profiles.
as2Id :: Text
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.
profileType :: 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.

Instances

Instances details

ToJSON CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods toJSON :: CreateProfile -> Value # toEncoding :: CreateProfile -> Encoding # toJSONList :: [CreateProfile] -> Value # toEncodingList :: [CreateProfile] -> Encoding #
ToHeaders CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods toHeaders :: CreateProfile -> [Header] #
ToPath CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods toPath :: CreateProfile -> ByteString #
ToQuery CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods toQuery :: CreateProfile -> QueryString #
AWSRequest CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Associated Types type AWSResponse CreateProfile # Methods request :: (Service -> Service) -> CreateProfile -> Request CreateProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProfile))) #
Generic CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Associated Types type Rep CreateProfile :: Type -> Type # Methods from :: CreateProfile -> Rep CreateProfile x # to :: Rep CreateProfile x -> CreateProfile #
Read CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods readsPrec :: Int -> ReadS CreateProfile # readList :: ReadS [CreateProfile] # readPrec :: ReadPrec CreateProfile # readListPrec :: ReadPrec [CreateProfile] #
Show CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods showsPrec :: Int -> CreateProfile -> ShowS # show :: CreateProfile -> String # showList :: [CreateProfile] -> ShowS #
NFData CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods rnf :: CreateProfile -> () #
Eq CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods (==) :: CreateProfile -> CreateProfile -> Bool # (/=) :: CreateProfile -> CreateProfile -> Bool #
Hashable CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods hashWithSalt :: Int -> CreateProfile -> Int # hash :: CreateProfile -> Int #
type AWSResponse CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile type AWSResponse CreateProfile = CreateProfileResponse
type Rep CreateProfile Source #
Instance details Defined in Amazonka.Transfer.CreateProfile type Rep CreateProfile = D1 ('MetaData "CreateProfile" "Amazonka.Transfer.CreateProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "as2Id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "profileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProfileType))))

newCreateProfile Source #

Arguments

:: Text	`CreateProfile`
-> ProfileType	`CreateProfile`
-> CreateProfile

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.

Constructors

CreateProfileResponse'
Fields httpStatus :: Int The response's http status code. profileId :: Text The unique identifier for the AS2 profile, returned after the API call succeeds.

Instances

Instances details

Generic CreateProfileResponse Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Associated Types type Rep CreateProfileResponse :: Type -> Type # Methods from :: CreateProfileResponse -> Rep CreateProfileResponse x # to :: Rep CreateProfileResponse x -> CreateProfileResponse #
Read CreateProfileResponse Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods readsPrec :: Int -> ReadS CreateProfileResponse # readList :: ReadS [CreateProfileResponse] # readPrec :: ReadPrec CreateProfileResponse # readListPrec :: ReadPrec [CreateProfileResponse] #
Show CreateProfileResponse Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods showsPrec :: Int -> CreateProfileResponse -> ShowS # show :: CreateProfileResponse -> String # showList :: [CreateProfileResponse] -> ShowS #
NFData CreateProfileResponse Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods rnf :: CreateProfileResponse -> () #
Eq CreateProfileResponse Source #
Instance details Defined in Amazonka.Transfer.CreateProfile Methods (==) :: CreateProfileResponse -> CreateProfileResponse -> Bool # (/=) :: CreateProfileResponse -> CreateProfileResponse -> Bool #
type Rep CreateProfileResponse Source #
Instance details Defined in Amazonka.Transfer.CreateProfile type Rep CreateProfileResponse = D1 ('MetaData "CreateProfileResponse" "Amazonka.Transfer.CreateProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "CreateProfileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateProfileResponse'`
-> Text	`CreateProfileResponse`
-> CreateProfileResponse

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.