feat(clients): update command documentation examples as of 2024-01-25

aws · Jan 25, 2024 · 922a7c9 · 922a7c9
1 parent bcb0669
commit 922a7c9
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 0 deletions.
diff --git a/clients/client-rds/src/commands/CreateIntegrationCommand.ts b/clients/client-rds/src/commands/CreateIntegrationCommand.ts
@@ -110,6 +110,30 @@ export interface CreateIntegrationCommandOutput extends Integration, __MetadataB
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ * @example To create a zero-ETL integration
+ * ```javascript
+ * // The following example creates a zero-ETL integration with Amazon Redshift.
+ * const input = {
+ *   "IntegrationName": "my-integration",
+ *   "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
+ *   "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
+ * };
+ * const command = new CreateIntegrationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CreateTime": "2023-12-28T17:20:20.629Z",
+ *   "IntegrationName": "my-integration",
+ *   "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
+ *   "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
+ *   "Status": "creating",
+ *   "Tags": [],
+ *   "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
+ * }
+ * *\/
+ * // example id: to-create-a-zero-etl-integration-1679688377231
+ * ```
+ *
  */
 export class CreateIntegrationCommand extends $Command
   .classBuilder<

diff --git a/clients/client-rds/src/commands/DeleteIntegrationCommand.ts b/clients/client-rds/src/commands/DeleteIntegrationCommand.ts
@@ -87,6 +87,28 @@ export interface DeleteIntegrationCommandOutput extends Integration, __MetadataB
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ * @example To delete a zero-ETL integration
+ * ```javascript
+ * // The following example deletes a zero-ETL integration with Amazon Redshift.
+ * const input = {
+ *   "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231"
+ * };
+ * const command = new DeleteIntegrationCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CreateTime": "2023-12-28T17:20:20.629Z",
+ *   "IntegrationName": "my-integration",
+ *   "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
+ *   "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
+ *   "Status": "deleting",
+ *   "Tags": [],
+ *   "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
+ * }
+ * *\/
+ * // example id: to-delete-a-zero-etl-integration-1679688377231
+ * ```
+ *
  */
 export class DeleteIntegrationCommand extends $Command
   .classBuilder<

diff --git a/clients/client-rds/src/commands/DescribeIntegrationsCommand.ts b/clients/client-rds/src/commands/DescribeIntegrationsCommand.ts
@@ -94,6 +94,32 @@ export interface DescribeIntegrationsCommandOutput extends DescribeIntegrationsR
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ * @example To describe a zero-ETL integration
+ * ```javascript
+ * // The following example retrieves information about a zero-ETL integration with Amazon Redshift.
+ * const input = {
+ *   "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231"
+ * };
+ * const command = new DescribeIntegrationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Integrations": [
+ *     {
+ *       "CreateTime": "2023-12-28T17:20:20.629Z",
+ *       "IntegrationName": "my-integration",
+ *       "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
+ *       "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
+ *       "Status": "active",
+ *       "Tags": [],
+ *       "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-zero-etl-integration-1679688377231
+ * ```
+ *
  */
 export class DescribeIntegrationsCommand extends $Command
   .classBuilder<