Skip to content

Commit

Permalink
Documentation updates for CloudTrail.
Browse files Browse the repository at this point in the history
Documentation updates for AW Transfer Family
This release adds instanceType to GetRunTask & ListRunTasks responses.
Add additional InvalidRequestException to list of possible exceptions for ListSecret.
This release adds APIs to provision agents that are global / available in multiple AWS regions and distribute them across these regions by percentage.
This release enables configuring security groups for Network Load Balancers
  • Loading branch information
aws-sdk-cpp-automation committed Aug 10, 2023
1 parent f89779d commit 49636a1
Show file tree
Hide file tree
Showing 83 changed files with 5,416 additions and 1,654 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.11.138
1.11.139
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,15 @@ namespace Transfer
}

/**
* <p>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 <a
* <p>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 <a
* href="https://docs.aws.amazon.com/transfer/latest/userguide/create-b2b-server.html#configure-as2-connector">Create
* AS2 connectors</a>.</p> <p>You must specify exactly one configuration
* AS2 connectors</a> and <a
* href="https://docs.aws.amazon.com/transfer/latest/userguide/configure-sftp-connector.html">Create
* SFTP connectors</a>.</p> <p>You must specify exactly one configuration
* object: either for AS2 (<code>As2Config</code>) or SFTP
* (<code>SftpConfig</code>).</p> <p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateConnector">AWS
Expand Down Expand Up @@ -1300,7 +1303,7 @@ namespace Transfer
* file transfer can be either outbound or inbound. In both cases, you specify the
* <code>ConnectorId</code>. Depending on the direction of the transfer, you also
* specify the following items:</p> <ul> <li> <p>If you are transferring file from
* a partner's SFTP server to a Transfer Family server, you specify one or more
* a partner's SFTP server to Amazon Web Services storage, you specify one or more
* <code>RetreiveFilePaths</code> to identify the files you want to transfer, and a
* <code>LocalDirectoryPath</code> to specify the destination folder.</p> </li>
* <li> <p>If you are transferring file to a partner's SFTP server from Amazon Web
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,9 +267,12 @@ namespace Model


/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -282,14 +285,22 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline const Aws::String& GetAccessRole() const{ return m_accessRole; }

/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -302,14 +313,22 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline bool AccessRoleHasBeenSet() const { return m_accessRoleHasBeenSet; }

/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -322,14 +341,22 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline void SetAccessRole(const Aws::String& value) { m_accessRoleHasBeenSet = true; m_accessRole = value; }

/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -342,14 +369,22 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline void SetAccessRole(Aws::String&& value) { m_accessRoleHasBeenSet = true; m_accessRole = std::move(value); }

/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -362,14 +397,22 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline void SetAccessRole(const char* value) { m_accessRoleHasBeenSet = true; m_accessRole.assign(value); }

/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -382,14 +425,22 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline CreateAgreementRequest& WithAccessRole(const Aws::String& value) { SetAccessRole(value); return *this;}

/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -402,14 +453,22 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline CreateAgreementRequest& WithAccessRole(Aws::String&& value) { SetAccessRole(std::move(value)); return *this;}

/**
* <p>With AS2, you can send files by calling <code>StartFileTransfer</code> and
* specifying the file paths in the request parameter, <code>SendFilePaths</code>.
* We use the file’s parent directory (for example, for <code>--send-file-paths
* <p>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.</p> <p> <b>For AS2 connectors</b> </p> <p>With
* AS2, you can send files by calling <code>StartFileTransfer</code> and specifying
* the file paths in the request parameter, <code>SendFilePaths</code>. We use the
* file’s parent directory (for example, for <code>--send-file-paths
* /bucket/dir/file.txt</code>, parent directory is <code>/bucket/dir/</code>) 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
Expand All @@ -422,7 +481,12 @@ namespace Model
* <code>secretsmanager:GetSecretValue</code> 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
* <code>kms:Decrypt</code> permission for that key.</p>
* <code>kms:Decrypt</code> permission for that key.</p> <p> <b>For SFTP
* connectors</b> </p> <p>Make sure that the access role provides read and write
* access to the parent directory of the file location that's used in the
* <code>StartFileTransfer</code> request. Additionally, make sure that the role
* provides <code>secretsmanager:GetSecretValue</code> permission to Secrets
* Manager.</p>
*/
inline CreateAgreementRequest& WithAccessRole(const char* value) { SetAccessRole(value); return *this;}

Expand Down
Loading

0 comments on commit 49636a1

Please sign in to comment.