feat(client-transfer): This release adds a new parameter StructuredLogDestinations to CreateServer, UpdateServer APIs.

awstools · awstools · commit 8f0033bb9e0d · 2023-06-21T18:16:15.000Z
diff --git a/clients/client-transfer/src/commands/CreateServerCommand.ts b/clients/client-transfer/src/commands/CreateServerCommand.ts
@@ -107,6 +107,9 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad
  *       },
  *     ],
  *   },
+ *   StructuredLogDestinations: [ // StructuredLogDestinations
+ *     "STRING_VALUE",
+ *   ],
  * };
  * const command = new CreateServerCommand(input);
  * const response = await client.send(command);
diff --git a/clients/client-transfer/src/commands/DescribeServerCommand.ts b/clients/client-transfer/src/commands/DescribeServerCommand.ts
@@ -118,6 +118,9 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M
  * //         },
  * //       ],
  * //     },
+ * //     StructuredLogDestinations: [ // StructuredLogDestinations
+ * //       "STRING_VALUE",
+ * //     ],
  * //   },
  * // };
  *
diff --git a/clients/client-transfer/src/commands/UpdateServerCommand.ts b/clients/client-transfer/src/commands/UpdateServerCommand.ts
@@ -100,6 +100,9 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad
  *       },
  *     ],
  *   },
+ *   StructuredLogDestinations: [ // StructuredLogDestinations
+ *     "STRING_VALUE",
+ *   ],
  * };
  * const command = new UpdateServerCommand(input);
  * const response = await client.send(command);
diff --git a/clients/client-transfer/src/models/models_0.ts b/clients/client-transfer/src/models/models_0.ts
@@ -1537,6 +1537,22 @@ export interface CreateServerRequest {
    *     while the file is still being uploaded.</p>
    */
   WorkflowDetails?: WorkflowDetails;
+
+  /**
+   * <p>Specifies the log groups to which your server logs are sent.</p>
+   *          <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
+   *          <p>
+   *             <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code>
+   *          </p>
+   *          <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code>
+   *          </p>
+   *          <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty
+   *         value for this parameter in an <code>update-server</code> call. For example:</p>
+   *          <p>
+   *             <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code>
+   *          </p>
+   */
+  StructuredLogDestinations?: string[];
 }
 
 /**
@@ -3320,6 +3336,22 @@ export interface DescribedServer {
    *     while the file is still being uploaded.</p>
    */
   WorkflowDetails?: WorkflowDetails;
+
+  /**
+   * <p>Specifies the log groups to which your server logs are sent.</p>
+   *          <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
+   *          <p>
+   *             <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code>
+   *          </p>
+   *          <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code>
+   *          </p>
+   *          <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty
+   *         value for this parameter in an <code>update-server</code> call. For example:</p>
+   *          <p>
+   *             <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code>
+   *          </p>
+   */
+  StructuredLogDestinations?: string[];
 }
 
 /**
@@ -5489,6 +5521,22 @@ export interface UpdateServerRequest {
    *          </p>
    */
   WorkflowDetails?: WorkflowDetails;
+
+  /**
+   * <p>Specifies the log groups to which your server logs are sent.</p>
+   *          <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>
+   *          <p>
+   *             <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code>
+   *          </p>
+   *          <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code>
+   *          </p>
+   *          <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty
+   *         value for this parameter in an <code>update-server</code> call. For example:</p>
+   *          <p>
+   *             <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code>
+   *          </p>
+   */
+  StructuredLogDestinations?: string[];
 }
 
 /**
diff --git a/clients/client-transfer/src/protocols/Aws_json1_1.ts b/clients/client-transfer/src/protocols/Aws_json1_1.ts
@@ -4532,6 +4532,8 @@ const se_ImportCertificateRequest = (input: ImportCertificateRequest, context: _
 
 // se_StopServerRequest omitted.
 
+// se_StructuredLogDestinations omitted.
+
 // se_SubnetIds omitted.
 
 // se_Tag omitted.
@@ -4955,6 +4957,8 @@ const de_SshPublicKeys = (output: any, context: __SerdeContext): SshPublicKey[]
 
 // de_StartFileTransferResponse omitted.
 
+// de_StructuredLogDestinations omitted.
+
 // de_SubnetIds omitted.
 
 // de_Tag omitted.
diff --git a/codegen/sdk-codegen/aws-models/transfer.json b/codegen/sdk-codegen/aws-models/transfer.json
@@ -891,6 +891,12 @@
           "traits": {
             "smithy.api#documentation": "<p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>\n         <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a\n    workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects\n    while the file is still being uploaded.</p>"
           }
+        },
+        "StructuredLogDestinations": {
+          "target": "com.amazonaws.transfer#StructuredLogDestinations",
+          "traits": {
+            "smithy.api#documentation": "<p>Specifies the log groups to which your server logs are sent.</p>\n         <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>\n         <p>\n            <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code>\n         </p>\n         <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code>\n         </p>\n         <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty\n        value for this parameter in an <code>update-server</code> call. For example:</p>\n         <p>\n            <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code>\n         </p>"
+          }
         }
       },
       "traits": {
@@ -3004,6 +3010,12 @@
           "traits": {
             "smithy.api#documentation": "<p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>\n         <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a\n    workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects\n    while the file is still being uploaded.</p>"
           }
+        },
+        "StructuredLogDestinations": {
+          "target": "com.amazonaws.transfer#StructuredLogDestinations",
+          "traits": {
+            "smithy.api#documentation": "<p>Specifies the log groups to which your server logs are sent.</p>\n         <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>\n         <p>\n            <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code>\n         </p>\n         <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code>\n         </p>\n         <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty\n        value for this parameter in an <code>update-server</code> call. For example:</p>\n         <p>\n            <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code>\n         </p>"
+          }
         }
       },
       "traits": {
@@ -6657,6 +6669,18 @@
         "smithy.api#input": {}
       }
     },
+    "com.amazonaws.transfer#StructuredLogDestinations": {
+      "type": "list",
+      "member": {
+        "target": "com.amazonaws.transfer#Arn"
+      },
+      "traits": {
+        "smithy.api#length": {
+          "min": 0,
+          "max": 1
+        }
+      }
+    },
     "com.amazonaws.transfer#SubnetId": {
       "type": "string"
     },
@@ -8853,6 +8877,12 @@
           "traits": {
             "smithy.api#documentation": "<p>Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.</p>\n         <p>In addition to a workflow to execute when a file is uploaded completely, <code>WorkflowDetails</code> can also contain a\n    workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects\n    while the file is still being uploaded.</p>\n         <p>To remove an associated workflow from a server, you can provide an empty <code>OnUpload</code> object, as in the following example.</p>\n         <p>\n            <code>aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'</code>\n         </p>"
           }
+        },
+        "StructuredLogDestinations": {
+          "target": "com.amazonaws.transfer#StructuredLogDestinations",
+          "traits": {
+            "smithy.api#documentation": "<p>Specifies the log groups to which your server logs are sent.</p>\n         <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p>\n         <p>\n            <code>arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*</code>\n         </p>\n         <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code>\n         </p>\n         <p>If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty\n        value for this parameter in an <code>update-server</code> call. For example:</p>\n         <p>\n            <code>update-server --server-id s-1234567890abcdef0 --structured-log-destinations</code>\n         </p>"
+          }
         }
       },
       "traits": {
