Amazonka.Transfer.Types.DescribedProfile

Documentation

data DescribedProfile

The details for a local or partner AS2 profile.

See: newDescribedProfile smart constructor.

Constructors

DescribedProfile'

Fields

• 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.

• certificateIds :: Maybe [Text]

  An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

• 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.

• tags :: Maybe (NonEmpty Tag)

  Key-value pairs that can be used to group and search for profiles.

• arn :: Text

  The unique Amazon Resource Name (ARN) for the profile.

Instances

FromJSON DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

Methods

parseJSON :: Value -> Parser DescribedProfile

parseJSONList :: Value -> Parser [DescribedProfile]

Generic DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

Associated Types

type Rep DescribedProfile :: Type -> Type

Methods

from :: DescribedProfile -> Rep DescribedProfile x

to :: Rep DescribedProfile x -> DescribedProfile

Read DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

Methods

readsPrec :: Int -> ReadS DescribedProfile

readList :: ReadS [DescribedProfile]

readPrec :: ReadPrec DescribedProfile

readListPrec :: ReadPrec [DescribedProfile]

Show DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

Methods

showsPrec :: Int -> DescribedProfile -> ShowS

show :: DescribedProfile -> String

showList :: [DescribedProfile] -> ShowS

NFData DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

Methods

rnf :: DescribedProfile -> ()

Eq DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

Methods

(==) :: DescribedProfile -> DescribedProfile -> Bool

(/=) :: DescribedProfile -> DescribedProfile -> Bool

Hashable DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

Methods

hashWithSalt :: Int -> DescribedProfile -> Int

hash :: DescribedProfile -> Int

type Rep DescribedProfile

Defined in Amazonka.Transfer.Types.DescribedProfile

type Rep DescribedProfile = D1 ('MetaData "DescribedProfile" "Amazonka.Transfer.Types.DescribedProfile" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "as2Id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "certificateIds") '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)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedProfile

Arguments

:: Text

$sel:arn:DescribedProfile'

-> DescribedProfile

Create a value of DescribedProfile 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:as2Id:DescribedProfile', describedProfile_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:certificateIds:DescribedProfile', describedProfile_certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

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

$sel:profileType:DescribedProfile', describedProfile_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.

$sel:tags:DescribedProfile', describedProfile_tags - Key-value pairs that can be used to group and search for profiles.

$sel:arn:DescribedProfile', describedProfile_arn - The unique Amazon Resource Name (ARN) for the profile.

describedProfile_as2Id :: Lens' DescribedProfile (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.

describedProfile_certificateIds :: Lens' DescribedProfile (Maybe [Text])

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

describedProfile_profileId :: Lens' DescribedProfile (Maybe Text)

A unique identifier for the local or partner AS2 profile.

describedProfile_profileType :: Lens' DescribedProfile (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.

describedProfile_tags :: Lens' DescribedProfile (Maybe (NonEmpty Tag))

Key-value pairs that can be used to group and search for profiles.

describedProfile_arn :: Lens' DescribedProfile Text

The unique Amazon Resource Name (ARN) for the profile.