amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer.Types.ListedProfile

Description

 
Synopsis

Documentation

data ListedProfile Source #

Returns the properties of the profile that was specified.

See: newListedProfile smart constructor.

Constructors

ListedProfile' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the specified profile.

  • as2Id :: Maybe 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.

  • profileId :: Maybe Text

    A unique identifier for the local or partner AS2 profile.

  • profileType :: Maybe ProfileType

    Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Instances

Instances details
FromJSON ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Generic ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Associated Types

type Rep ListedProfile :: Type -> Type #

Read ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Show ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

NFData ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Methods

rnf :: ListedProfile -> () #

Eq ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

Hashable ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

type Rep ListedProfile Source # 
Instance details

Defined in Amazonka.Transfer.Types.ListedProfile

type Rep ListedProfile = D1 ('MetaData "ListedProfile" "Amazonka.Transfer.Types.ListedProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListedProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "as2Id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "profileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "profileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileType)))))

newListedProfile :: ListedProfile Source #

Create a value of ListedProfile 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:arn:ListedProfile', listedProfile_arn - The Amazon Resource Name (ARN) of the specified profile.

$sel:as2Id:ListedProfile', listedProfile_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.

$sel:profileId:ListedProfile', listedProfile_profileId - A unique identifier for the local or partner AS2 profile.

$sel:profileType:ListedProfile', listedProfile_profileType - Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

listedProfile_arn :: Lens' ListedProfile (Maybe Text) Source #

The Amazon Resource Name (ARN) of the specified profile.

listedProfile_as2Id :: Lens' ListedProfile (Maybe 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.

listedProfile_profileId :: Lens' ListedProfile (Maybe Text) Source #

A unique identifier for the local or partner AS2 profile.

listedProfile_profileType :: Lens' ListedProfile (Maybe ProfileType) Source #

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.