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.Types.DescribedConnector

Description

Documentation

data DescribedConnector Source #

Describes the parameters for the connector, as identified by the ConnectorId.

See: newDescribedConnector smart constructor.

Constructors

DescribedConnector'

Fields

accessRole :: Maybe Text
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.
as2Config :: Maybe As2ConnectorConfig
A structure that contains the parameters for a connector object.
connectorId :: Maybe Text
The unique identifier for the connector.
loggingRole :: Maybe Text
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
tags :: Maybe (NonEmpty Tag)
Key-value pairs that can be used to group and search for connectors.
url :: Maybe Text
The URL of the partner's AS2 endpoint.
arn :: Text
The unique Amazon Resource Name (ARN) for the connector.

Instances

Instances details

FromJSON DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector Methods parseJSON :: Value -> Parser DescribedConnector # parseJSONList :: Value -> Parser [DescribedConnector] #
Generic DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector Associated Types type Rep DescribedConnector :: Type -> Type # Methods from :: DescribedConnector -> Rep DescribedConnector x # to :: Rep DescribedConnector x -> DescribedConnector #
Read DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector Methods readsPrec :: Int -> ReadS DescribedConnector # readList :: ReadS [DescribedConnector] # readPrec :: ReadPrec DescribedConnector # readListPrec :: ReadPrec [DescribedConnector] #
Show DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector Methods showsPrec :: Int -> DescribedConnector -> ShowS # show :: DescribedConnector -> String # showList :: [DescribedConnector] -> ShowS #
NFData DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector Methods rnf :: DescribedConnector -> () #
Eq DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector Methods (==) :: DescribedConnector -> DescribedConnector -> Bool # (/=) :: DescribedConnector -> DescribedConnector -> Bool #
Hashable DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector Methods hashWithSalt :: Int -> DescribedConnector -> Int # hash :: DescribedConnector -> Int #
type Rep DescribedConnector Source #
Instance details Defined in Amazonka.Transfer.Types.DescribedConnector type Rep DescribedConnector = D1 ('MetaData "DescribedConnector" "Amazonka.Transfer.Types.DescribedConnector" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribedConnector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "as2Config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe As2ConnectorConfig)) :: S1 ('MetaSel ('Just "connectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "loggingRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribedConnector Source #

Arguments

:: Text	`$sel:arn:DescribedConnector'`
-> DescribedConnector

Create a value of DescribedConnector 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:accessRole:DescribedConnector', describedConnector_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.

$sel:as2Config:DescribedConnector', describedConnector_as2Config - A structure that contains the parameters for a connector object.

$sel:connectorId:DescribedConnector', describedConnector_connectorId - The unique identifier for the connector.

$sel:loggingRole:DescribedConnector', describedConnector_loggingRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

$sel:tags:DescribedConnector', describedConnector_tags - Key-value pairs that can be used to group and search for connectors.

$sel:url:DescribedConnector', describedConnector_url - The URL of the partner's AS2 endpoint.

$sel:arn:DescribedConnector', describedConnector_arn - The unique Amazon Resource Name (ARN) for the connector.

describedConnector_accessRole :: Lens' DescribedConnector (Maybe 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.

describedConnector_as2Config :: Lens' DescribedConnector (Maybe As2ConnectorConfig) Source #

A structure that contains the parameters for a connector object.

describedConnector_connectorId :: Lens' DescribedConnector (Maybe Text) Source #

The unique identifier for the connector.

describedConnector_loggingRole :: Lens' DescribedConnector (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.

describedConnector_tags :: Lens' DescribedConnector (Maybe (NonEmpty Tag)) Source #

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

describedConnector_url :: Lens' DescribedConnector (Maybe Text) Source #

The URL of the partner's AS2 endpoint.

describedConnector_arn :: Lens' DescribedConnector Text Source #

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