| 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.CreateConnector
Description
Creates the connector, which captures the parameters for an outbound connection for the AS2 protocol. The connector is required for sending files to an externally hosted AS2 server. For more details about connectors, see Create AS2 connectors.
Synopsis
- data CreateConnector = CreateConnector' {
- loggingRole :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- url :: Text
- as2Config :: As2ConnectorConfig
- accessRole :: Text
- newCreateConnector :: Text -> As2ConnectorConfig -> Text -> CreateConnector
- createConnector_loggingRole :: Lens' CreateConnector (Maybe Text)
- createConnector_tags :: Lens' CreateConnector (Maybe (NonEmpty Tag))
- createConnector_url :: Lens' CreateConnector Text
- createConnector_as2Config :: Lens' CreateConnector As2ConnectorConfig
- createConnector_accessRole :: Lens' CreateConnector Text
- data CreateConnectorResponse = CreateConnectorResponse' {
- httpStatus :: Int
- connectorId :: Text
- newCreateConnectorResponse :: Int -> Text -> CreateConnectorResponse
- createConnectorResponse_httpStatus :: Lens' CreateConnectorResponse Int
- createConnectorResponse_connectorId :: Lens' CreateConnectorResponse Text
Creating a Request
data CreateConnector Source #
See: newCreateConnector smart constructor.
Constructors
| CreateConnector' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> As2ConnectorConfig | |
| -> Text | |
| -> CreateConnector |
Create a value of CreateConnector 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:
CreateConnector, createConnector_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.
CreateConnector, createConnector_tags - Key-value pairs that can be used to group and search for connectors.
Tags are metadata attached to connectors for any purpose.
CreateConnector, createConnector_url - The URL of the partner's AS2 endpoint.
CreateConnector, createConnector_as2Config - A structure that contains the parameters for a connector object.
CreateConnector, createConnector_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.
Request Lenses
createConnector_loggingRole :: Lens' CreateConnector (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.
createConnector_tags :: Lens' CreateConnector (Maybe (NonEmpty Tag)) Source #
Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
createConnector_url :: Lens' CreateConnector Text Source #
The URL of the partner's AS2 endpoint.
createConnector_as2Config :: Lens' CreateConnector As2ConnectorConfig Source #
A structure that contains the parameters for a connector object.
createConnector_accessRole :: Lens' CreateConnector 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.
Destructuring the Response
data CreateConnectorResponse Source #
See: newCreateConnectorResponse smart constructor.
Constructors
| CreateConnectorResponse' | |
Fields
| |
Instances
newCreateConnectorResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateConnectorResponse |
Create a value of CreateConnectorResponse 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:CreateConnectorResponse', createConnectorResponse_httpStatus - The response's http status code.
CreateConnectorResponse, createConnectorResponse_connectorId - The unique identifier for the connector, returned after the API call
succeeds.
Response Lenses
createConnectorResponse_httpStatus :: Lens' CreateConnectorResponse Int Source #
The response's http status code.
createConnectorResponse_connectorId :: Lens' CreateConnectorResponse Text Source #
The unique identifier for the connector, returned after the API call succeeds.