diff --git a/clients/client-transfer/src/commands/CreateConnectorCommand.ts b/clients/client-transfer/src/commands/CreateConnectorCommand.ts index 17c97efa3d77c..044e2654ac399 100644 --- a/clients/client-transfer/src/commands/CreateConnectorCommand.ts +++ b/clients/client-transfer/src/commands/CreateConnectorCommand.ts @@ -36,9 +36,9 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _ /** * @public - *
Creates the connector, which captures the parameters for an outbound connection for the - * AS2 or SFTP protocol. The connector is required for sending files to an externally hosted AS2 or SFTP server. - * For more details about AS2 connectors, see Create AS2 connectors.
+ *Creates the connector, which captures the parameters for a connection for the + * AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. + * For more details about connectors, see Create AS2 connectors and Create SFTP connectors.
*You must specify exactly one configuration object: either for AS2 (As2Config
) or SFTP (SftpConfig
).
If you are transferring file from a partner's SFTP server to a Transfer Family
- * server, you specify one or more RetreiveFilePaths
to identify the files
+ *
If you are transferring file from a partner's SFTP server to Amazon Web Services
+ * storage, you specify one or more RetreiveFilePaths
to identify the files
* you want to transfer, and a LocalDirectoryPath
to specify the destination
* folder.
With AS2, you can send files by calling StartFileTransfer
and specifying the
+ *
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, + * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
+ *+ * For AS2 connectors + *
+ *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
+ * 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
.
StartFileTransfer
.
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using
* a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt
permission for that key.
+ * For SFTP connectors + *
+ *Make sure that the access role provides
+ * read and write access to the parent directory of the file location
+ * that's used in the StartFileTransfer
request.
+ * Additionally, make sure that the role provides
+ * secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the
+ *
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, + * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
+ *+ * For AS2 connectors + *
+ *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
+ * 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
.
StartFileTransfer
.
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using
* a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt
permission for that key.
+ * For SFTP connectors + *
+ *Make sure that the access role provides
+ * read and write access to the parent directory of the file location
+ * that's used in the StartFileTransfer
request.
+ * Additionally, make sure that the role provides
+ * secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the
+ *
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, + * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
+ *+ * For AS2 connectors + *
+ *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
+ * 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
.
StartFileTransfer
.
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using
* a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt
permission for that key.
+ * For SFTP connectors + *
+ *Make sure that the access role provides
+ * read and write access to the parent directory of the file location
+ * that's used in the StartFileTransfer
request.
+ * Additionally, make sure that the role provides
+ * secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the
+ *
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, + * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
+ *+ * For AS2 connectors + *
+ *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
+ * 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
.
StartFileTransfer
.
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using
* a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt
permission for that key.
+ * For SFTP connectors + *
+ *Make sure that the access role provides
+ * read and write access to the parent directory of the file location
+ * that's used in the StartFileTransfer
request.
+ * Additionally, make sure that the role provides
+ * secretsmanager:GetSecretValue
permission to Secrets Manager.
One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example,
- * One or more source paths for the Transfer Family server. Each string represents a source
+ * file path for one outbound file transfer. For example,
+ * Replace With AS2, you can send files by calling Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,
+ * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
+ * For AS2 connectors
+ * With AS2, you can send files by calling
+ *
* DOC-EXAMPLE-BUCKET/myfile.txt
*
.
+ * DOC-EXAMPLE-BUCKET
+ *
with one of your actual buckets.StartFileTransfer
and specifying the
+ * 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
+ * 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
.StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using
* a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt
permission for that key.
+ * For SFTP connectors + *
+ *Make sure that the access role provides
+ * read and write access to the parent directory of the file location
+ * that's used in the StartFileTransfer
request.
+ * Additionally, make sure that the role provides
+ * secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the
+ *
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, + * provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
+ *+ * For AS2 connectors + *
+ *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
+ * 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
.
StartFileTransfer
.
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using
* a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt
permission for that key.
+ * For SFTP connectors + *
+ *Make sure that the access role provides
+ * read and write access to the parent directory of the file location
+ * that's used in the StartFileTransfer
request.
+ * Additionally, make sure that the role provides
+ * secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer
request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue
permission to Secrets Manager.
Creates the connector, which captures the parameters for an outbound connection for the\n AS2 or SFTP protocol. The connector is required for sending files to an externally hosted AS2 or SFTP server.\n For more details about AS2 connectors, see Create AS2 connectors.
\nYou must specify exactly one configuration object: either for AS2 (As2Config
) or SFTP (SftpConfig
).
Creates the connector, which captures the parameters for a connection for the\n AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server.\n For more details about connectors, see Create AS2 connectors and Create SFTP connectors.
\nYou must specify exactly one configuration object: either for AS2 (As2Config
) or SFTP (SftpConfig
).
With AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer
request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer
request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer
request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue
permission to Secrets Manager.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId
and one or more SendFilePaths
to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId
. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to a Transfer Family\n server, you specify one or more RetreiveFilePaths
to identify the files\n you want to transfer, and a LocalDirectoryPath
to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths
to identify the files you\n want to transfer, and a RemoteDirectoryPath
to specify the destination\n folder.
Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.
\nFor an AS2 connector, you specify the ConnectorId
and one or more SendFilePaths
to identify the files\n you want to transfer.
For an SFTP connector, the file transfer can be either outbound or inbound. In both\n cases, you specify the ConnectorId
. Depending on the direction of the transfer,\n you also specify the following items:
If you are transferring file from a partner's SFTP server to Amazon Web Services\n storage, you specify one or more RetreiveFilePaths
to identify the files\n you want to transfer, and a LocalDirectoryPath
to specify the destination\n folder.
If you are transferring file to a partner's SFTP server from Amazon Web Services\n storage, you specify one or more SendFilePaths
to identify the files you\n want to transfer, and a RemoteDirectoryPath
to specify the destination\n folder.
One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example,\n \n DOC-EXAMPLE-BUCKET/myfile.txt\n
.
One or more source paths for the Transfer Family server. Each string represents a source\n file path for one outbound file transfer. For example,\n \n DOC-EXAMPLE-BUCKET/myfile.txt\n
.
Replace \n DOC-EXAMPLE-BUCKET\n
with one of your actual buckets.
With AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer
request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue
permission to Secrets Manager.
With AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
Connectors are used to send files using either the AS2 or SFTP protocol. For the access role,\n provide the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
\n\n For AS2 connectors\n
\nWith AS2, you can send files by calling StartFileTransfer
and specifying the\n file paths in the request parameter, SendFilePaths
. We use the file’s parent\n directory (for example, for --send-file-paths /bucket/dir/file.txt
, parent\n directory is /bucket/dir/
) to temporarily store a processed AS2 message file,\n store the MDN when we receive them from the partner, and write a final JSON file containing\n relevant metadata of the transmission. So, the AccessRole
needs to provide read\n and write access to the parent directory of the file location used in the\n StartFileTransfer
request. Additionally, you need to provide read and write\n access to the parent directory of the files that you intend to send with\n StartFileTransfer
.
If you are using Basic authentication for your AS2 connector, the access role requires the\n secretsmanager:GetSecretValue
permission for the secret. If the secret is encrypted using\n a customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also\n needs the kms:Decrypt
permission for that key.
\n For SFTP connectors\n
\nMake sure that the access role provides\n read and write access to the parent directory of the file location\n that's used in the StartFileTransfer
request.\n Additionally, make sure that the role provides\n secretsmanager:GetSecretValue
permission to Secrets Manager.