Skip to content

Commit 922a7c9

Browse files
author
awstools
committed
feat(clients): update command documentation examples as of 2024-01-25
1 parent bcb0669 commit 922a7c9

File tree

3 files changed

+72
-0
lines changed

3 files changed

+72
-0
lines changed

clients/client-rds/src/commands/CreateIntegrationCommand.ts

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,30 @@ export interface CreateIntegrationCommandOutput extends Integration, __MetadataB
110110
* @throws {@link RDSServiceException}
111111
* <p>Base exception class for all service exceptions from RDS service.</p>
112112
*
113+
* @example To create a zero-ETL integration
114+
* ```javascript
115+
* // The following example creates a zero-ETL integration with Amazon Redshift.
116+
* const input = {
117+
* "IntegrationName": "my-integration",
118+
* "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
119+
* "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
120+
* };
121+
* const command = new CreateIntegrationCommand(input);
122+
* const response = await client.send(command);
123+
* /* response ==
124+
* {
125+
* "CreateTime": "2023-12-28T17:20:20.629Z",
126+
* "IntegrationName": "my-integration",
127+
* "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
128+
* "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
129+
* "Status": "creating",
130+
* "Tags": [],
131+
* "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
132+
* }
133+
* *\/
134+
* // example id: to-create-a-zero-etl-integration-1679688377231
135+
* ```
136+
*
113137
*/
114138
export class CreateIntegrationCommand extends $Command
115139
.classBuilder<

clients/client-rds/src/commands/DeleteIntegrationCommand.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,28 @@ export interface DeleteIntegrationCommandOutput extends Integration, __MetadataB
8787
* @throws {@link RDSServiceException}
8888
* <p>Base exception class for all service exceptions from RDS service.</p>
8989
*
90+
* @example To delete a zero-ETL integration
91+
* ```javascript
92+
* // The following example deletes a zero-ETL integration with Amazon Redshift.
93+
* const input = {
94+
* "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231"
95+
* };
96+
* const command = new DeleteIntegrationCommand(input);
97+
* const response = await client.send(command);
98+
* /* response ==
99+
* {
100+
* "CreateTime": "2023-12-28T17:20:20.629Z",
101+
* "IntegrationName": "my-integration",
102+
* "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
103+
* "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
104+
* "Status": "deleting",
105+
* "Tags": [],
106+
* "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
107+
* }
108+
* *\/
109+
* // example id: to-delete-a-zero-etl-integration-1679688377231
110+
* ```
111+
*
90112
*/
91113
export class DeleteIntegrationCommand extends $Command
92114
.classBuilder<

clients/client-rds/src/commands/DescribeIntegrationsCommand.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,32 @@ export interface DescribeIntegrationsCommandOutput extends DescribeIntegrationsR
9494
* @throws {@link RDSServiceException}
9595
* <p>Base exception class for all service exceptions from RDS service.</p>
9696
*
97+
* @example To describe a zero-ETL integration
98+
* ```javascript
99+
* // The following example retrieves information about a zero-ETL integration with Amazon Redshift.
100+
* const input = {
101+
* "IntegrationIdentifier": "5b9f3d79-7392-4a3e-896c-58eaa1b53231"
102+
* };
103+
* const command = new DescribeIntegrationsCommand(input);
104+
* const response = await client.send(command);
105+
* /* response ==
106+
* {
107+
* "Integrations": [
108+
* {
109+
* "CreateTime": "2023-12-28T17:20:20.629Z",
110+
* "IntegrationName": "my-integration",
111+
* "KMSKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
112+
* "SourceArn": "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
113+
* "Status": "active",
114+
* "Tags": [],
115+
* "TargetArn": "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
116+
* }
117+
* ]
118+
* }
119+
* *\/
120+
* // example id: to-describe-a-zero-etl-integration-1679688377231
121+
* ```
122+
*
97123
*/
98124
export class DescribeIntegrationsCommand extends $Command
99125
.classBuilder<

0 commit comments

Comments
 (0)