| 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.UpdateConnector
Description
Updates some of the parameters for an existing connector. Provide the
ConnectorId for the connector that you want to update, along with the
new values for the parameters to update.
Synopsis
- data UpdateConnector = UpdateConnector' {}
- newUpdateConnector :: Text -> UpdateConnector
- updateConnector_accessRole :: Lens' UpdateConnector (Maybe Text)
- updateConnector_as2Config :: Lens' UpdateConnector (Maybe As2ConnectorConfig)
- updateConnector_loggingRole :: Lens' UpdateConnector (Maybe Text)
- updateConnector_url :: Lens' UpdateConnector (Maybe Text)
- updateConnector_connectorId :: Lens' UpdateConnector Text
- data UpdateConnectorResponse = UpdateConnectorResponse' {
- httpStatus :: Int
- connectorId :: Text
- newUpdateConnectorResponse :: Int -> Text -> UpdateConnectorResponse
- updateConnectorResponse_httpStatus :: Lens' UpdateConnectorResponse Int
- updateConnectorResponse_connectorId :: Lens' UpdateConnectorResponse Text
Creating a Request
data UpdateConnector Source #
See: newUpdateConnector smart constructor.
Constructors
| UpdateConnector' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> UpdateConnector |
Create a value of UpdateConnector 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:
UpdateConnector, updateConnector_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.
UpdateConnector, updateConnector_as2Config - A structure that contains the parameters for a connector object.
UpdateConnector, updateConnector_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.
UpdateConnector, updateConnector_url - The URL of the partner's AS2 endpoint.
UpdateConnector, updateConnector_connectorId - The unique identifier for the connector.
Request Lenses
updateConnector_accessRole :: Lens' UpdateConnector (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.
updateConnector_as2Config :: Lens' UpdateConnector (Maybe As2ConnectorConfig) Source #
A structure that contains the parameters for a connector object.
updateConnector_loggingRole :: Lens' UpdateConnector (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.
updateConnector_url :: Lens' UpdateConnector (Maybe Text) Source #
The URL of the partner's AS2 endpoint.
updateConnector_connectorId :: Lens' UpdateConnector Text Source #
The unique identifier for the connector.
Destructuring the Response
data UpdateConnectorResponse Source #
See: newUpdateConnectorResponse smart constructor.
Constructors
| UpdateConnectorResponse' | |
Fields
| |
Instances
newUpdateConnectorResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UpdateConnectorResponse |
Create a value of UpdateConnectorResponse 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:UpdateConnectorResponse', updateConnectorResponse_httpStatus - The response's http status code.
UpdateConnector, updateConnectorResponse_connectorId - Returns the identifier of the connector object that you are updating.
Response Lenses
updateConnectorResponse_httpStatus :: Lens' UpdateConnectorResponse Int Source #
The response's http status code.
updateConnectorResponse_connectorId :: Lens' UpdateConnectorResponse Text Source #
Returns the identifier of the connector object that you are updating.