Skip to content

Commit 8ea4222

Browse files
author
awstools
committed
feat(client-osis): Add support for creating an OpenSearch Ingestion pipeline that is attached to a provided VPC. Add information about the destinations of an OpenSearch Ingestion pipeline to the GetPipeline and ListPipelines APIs.
1 parent f55b6af commit 8ea4222

17 files changed

+498
-18
lines changed

‎clients/client-osis/src/commands/CreatePipelineCommand.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
5252
* SecurityGroupIds: [ // SecurityGroupIds
5353
* "STRING_VALUE",
5454
* ],
55+
* VpcAttachmentOptions: { // VpcAttachmentOptions
56+
* AttachToVpc: true || false, // required
57+
* CidrBlock: "STRING_VALUE",
58+
* },
5559
* },
5660
* BufferOptions: { // BufferOptions
5761
* PersistentBufferEnabled: true || false, // required
@@ -101,6 +105,10 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
101105
* // SecurityGroupIds: [ // SecurityGroupIds
102106
* // "STRING_VALUE",
103107
* // ],
108+
* // VpcAttachmentOptions: { // VpcAttachmentOptions
109+
* // AttachToVpc: true || false, // required
110+
* // CidrBlock: "STRING_VALUE",
111+
* // },
104112
* // },
105113
* // },
106114
* // ],
@@ -116,6 +124,12 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
116124
* // VpcEndpointId: "STRING_VALUE",
117125
* // },
118126
* // ],
127+
* // Destinations: [ // PipelineDestinationList
128+
* // { // PipelineDestination
129+
* // ServiceName: "STRING_VALUE",
130+
* // Endpoint: "STRING_VALUE",
131+
* // },
132+
* // ],
119133
* // Tags: [ // TagList
120134
* // { // Tag
121135
* // Key: "STRING_VALUE", // required
@@ -136,6 +150,9 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
136150
* @throws {@link AccessDeniedException} (client fault)
137151
* <p>You don't have permissions to access the resource.</p>
138152
*
153+
* @throws {@link DisabledOperationException} (client fault)
154+
* <p>Exception is thrown when an operation has been disabled.</p>
155+
*
139156
* @throws {@link InternalException} (server fault)
140157
* <p>The request failed because of an unknown error, exception, or failure (the failure is
141158
* internal to the service).</p>

‎clients/client-osis/src/commands/DeletePipelineCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ export interface DeletePipelineCommandOutput extends DeletePipelineResponse, __M
5555
* @throws {@link ConflictException} (client fault)
5656
* <p>The client attempted to remove a resource that is currently in use.</p>
5757
*
58+
* @throws {@link DisabledOperationException} (client fault)
59+
* <p>Exception is thrown when an operation has been disabled.</p>
60+
*
5861
* @throws {@link InternalException} (server fault)
5962
* <p>The request failed because of an unknown error, exception, or failure (the failure is
6063
* internal to the service).</p>

‎clients/client-osis/src/commands/GetPipelineBlueprintCommand.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,20 @@ export interface GetPipelineBlueprintCommandOutput extends GetPipelineBlueprintR
3939
* const client = new OSISClient(config);
4040
* const input = { // GetPipelineBlueprintRequest
4141
* BlueprintName: "STRING_VALUE", // required
42+
* Format: "STRING_VALUE",
4243
* };
4344
* const command = new GetPipelineBlueprintCommand(input);
4445
* const response = await client.send(command);
4546
* // { // GetPipelineBlueprintResponse
4647
* // Blueprint: { // PipelineBlueprint
4748
* // BlueprintName: "STRING_VALUE",
4849
* // PipelineConfigurationBody: "STRING_VALUE",
50+
* // DisplayName: "STRING_VALUE",
51+
* // DisplayDescription: "STRING_VALUE",
52+
* // Service: "STRING_VALUE",
53+
* // UseCase: "STRING_VALUE",
4954
* // },
55+
* // Format: "STRING_VALUE",
5056
* // };
5157
*
5258
* ```
@@ -60,6 +66,9 @@ export interface GetPipelineBlueprintCommandOutput extends GetPipelineBlueprintR
6066
* @throws {@link AccessDeniedException} (client fault)
6167
* <p>You don't have permissions to access the resource.</p>
6268
*
69+
* @throws {@link DisabledOperationException} (client fault)
70+
* <p>Exception is thrown when an operation has been disabled.</p>
71+
*
6372
* @throws {@link InternalException} (server fault)
6473
* <p>The request failed because of an unknown error, exception, or failure (the failure is
6574
* internal to the service).</p>

‎clients/client-osis/src/commands/GetPipelineChangeProgressCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ export interface GetPipelineChangeProgressCommandOutput extends GetPipelineChang
7171
* @throws {@link AccessDeniedException} (client fault)
7272
* <p>You don't have permissions to access the resource.</p>
7373
*
74+
* @throws {@link DisabledOperationException} (client fault)
75+
* <p>Exception is thrown when an operation has been disabled.</p>
76+
*
7477
* @throws {@link InternalException} (server fault)
7578
* <p>The request failed because of an unknown error, exception, or failure (the failure is
7679
* internal to the service).</p>

‎clients/client-osis/src/commands/GetPipelineCommand.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
7272
* // SecurityGroupIds: [ // SecurityGroupIds
7373
* // "STRING_VALUE",
7474
* // ],
75+
* // VpcAttachmentOptions: { // VpcAttachmentOptions
76+
* // AttachToVpc: true || false, // required
77+
* // CidrBlock: "STRING_VALUE",
78+
* // },
7579
* // },
7680
* // },
7781
* // ],
@@ -87,6 +91,12 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
8791
* // VpcEndpointId: "STRING_VALUE",
8892
* // },
8993
* // ],
94+
* // Destinations: [ // PipelineDestinationList
95+
* // { // PipelineDestination
96+
* // ServiceName: "STRING_VALUE",
97+
* // Endpoint: "STRING_VALUE",
98+
* // },
99+
* // ],
90100
* // Tags: [ // TagList
91101
* // { // Tag
92102
* // Key: "STRING_VALUE", // required
@@ -107,6 +117,9 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
107117
* @throws {@link AccessDeniedException} (client fault)
108118
* <p>You don't have permissions to access the resource.</p>
109119
*
120+
* @throws {@link DisabledOperationException} (client fault)
121+
* <p>Exception is thrown when an operation has been disabled.</p>
122+
*
110123
* @throws {@link InternalException} (server fault)
111124
* <p>The request failed because of an unknown error, exception, or failure (the failure is
112125
* internal to the service).</p>

‎clients/client-osis/src/commands/ListPipelineBlueprintsCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ export interface ListPipelineBlueprintsCommandOutput extends ListPipelineBluepri
4242
* // Blueprints: [ // PipelineBlueprintsSummaryList
4343
* // { // PipelineBlueprintSummary
4444
* // BlueprintName: "STRING_VALUE",
45+
* // DisplayName: "STRING_VALUE",
46+
* // DisplayDescription: "STRING_VALUE",
47+
* // Service: "STRING_VALUE",
48+
* // UseCase: "STRING_VALUE",
4549
* // },
4650
* // ],
4751
* // };
@@ -57,6 +61,9 @@ export interface ListPipelineBlueprintsCommandOutput extends ListPipelineBluepri
5761
* @throws {@link AccessDeniedException} (client fault)
5862
* <p>You don't have permissions to access the resource.</p>
5963
*
64+
* @throws {@link DisabledOperationException} (client fault)
65+
* <p>Exception is thrown when an operation has been disabled.</p>
66+
*
6067
* @throws {@link InternalException} (server fault)
6168
* <p>The request failed because of an unknown error, exception, or failure (the failure is
6269
* internal to the service).</p>

‎clients/client-osis/src/commands/ListPipelinesCommand.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met
5555
* // MaxUnits: Number("int"),
5656
* // CreatedAt: new Date("TIMESTAMP"),
5757
* // LastUpdatedAt: new Date("TIMESTAMP"),
58+
* // Destinations: [ // PipelineDestinationList
59+
* // { // PipelineDestination
60+
* // ServiceName: "STRING_VALUE",
61+
* // Endpoint: "STRING_VALUE",
62+
* // },
63+
* // ],
5864
* // Tags: [ // TagList
5965
* // { // Tag
6066
* // Key: "STRING_VALUE", // required
@@ -76,6 +82,9 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met
7682
* @throws {@link AccessDeniedException} (client fault)
7783
* <p>You don't have permissions to access the resource.</p>
7884
*
85+
* @throws {@link DisabledOperationException} (client fault)
86+
* <p>Exception is thrown when an operation has been disabled.</p>
87+
*
7988
* @throws {@link InternalException} (server fault)
8089
* <p>The request failed because of an unknown error, exception, or failure (the failure is
8190
* internal to the service).</p>

‎clients/client-osis/src/commands/ListTagsForResourceCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
6060
* @throws {@link AccessDeniedException} (client fault)
6161
* <p>You don't have permissions to access the resource.</p>
6262
*
63+
* @throws {@link DisabledOperationException} (client fault)
64+
* <p>Exception is thrown when an operation has been disabled.</p>
65+
*
6366
* @throws {@link InternalException} (server fault)
6467
* <p>The request failed because of an unknown error, exception, or failure (the failure is
6568
* internal to the service).</p>

‎clients/client-osis/src/commands/StartPipelineCommand.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
7272
* // SecurityGroupIds: [ // SecurityGroupIds
7373
* // "STRING_VALUE",
7474
* // ],
75+
* // VpcAttachmentOptions: { // VpcAttachmentOptions
76+
* // AttachToVpc: true || false, // required
77+
* // CidrBlock: "STRING_VALUE",
78+
* // },
7579
* // },
7680
* // },
7781
* // ],
@@ -87,6 +91,12 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
8791
* // VpcEndpointId: "STRING_VALUE",
8892
* // },
8993
* // ],
94+
* // Destinations: [ // PipelineDestinationList
95+
* // { // PipelineDestination
96+
* // ServiceName: "STRING_VALUE",
97+
* // Endpoint: "STRING_VALUE",
98+
* // },
99+
* // ],
90100
* // Tags: [ // TagList
91101
* // { // Tag
92102
* // Key: "STRING_VALUE", // required
@@ -110,6 +120,9 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
110120
* @throws {@link ConflictException} (client fault)
111121
* <p>The client attempted to remove a resource that is currently in use.</p>
112122
*
123+
* @throws {@link DisabledOperationException} (client fault)
124+
* <p>Exception is thrown when an operation has been disabled.</p>
125+
*
113126
* @throws {@link InternalException} (server fault)
114127
* <p>The request failed because of an unknown error, exception, or failure (the failure is
115128
* internal to the service).</p>

‎clients/client-osis/src/commands/StopPipelineCommand.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
7272
* // SecurityGroupIds: [ // SecurityGroupIds
7373
* // "STRING_VALUE",
7474
* // ],
75+
* // VpcAttachmentOptions: { // VpcAttachmentOptions
76+
* // AttachToVpc: true || false, // required
77+
* // CidrBlock: "STRING_VALUE",
78+
* // },
7579
* // },
7680
* // },
7781
* // ],
@@ -87,6 +91,12 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
8791
* // VpcEndpointId: "STRING_VALUE",
8892
* // },
8993
* // ],
94+
* // Destinations: [ // PipelineDestinationList
95+
* // { // PipelineDestination
96+
* // ServiceName: "STRING_VALUE",
97+
* // Endpoint: "STRING_VALUE",
98+
* // },
99+
* // ],
90100
* // Tags: [ // TagList
91101
* // { // Tag
92102
* // Key: "STRING_VALUE", // required
@@ -110,6 +120,9 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
110120
* @throws {@link ConflictException} (client fault)
111121
* <p>The client attempted to remove a resource that is currently in use.</p>
112122
*
123+
* @throws {@link DisabledOperationException} (client fault)
124+
* <p>Exception is thrown when an operation has been disabled.</p>
125+
*
113126
* @throws {@link InternalException} (server fault)
114127
* <p>The request failed because of an unknown error, exception, or failure (the failure is
115128
* internal to the service).</p>

‎clients/client-osis/src/commands/TagResourceCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
5858
* @throws {@link AccessDeniedException} (client fault)
5959
* <p>You don't have permissions to access the resource.</p>
6060
*
61+
* @throws {@link DisabledOperationException} (client fault)
62+
* <p>Exception is thrown when an operation has been disabled.</p>
63+
*
6164
* @throws {@link InternalException} (server fault)
6265
* <p>The request failed because of an unknown error, exception, or failure (the failure is
6366
* internal to the service).</p>

‎clients/client-osis/src/commands/UntagResourceCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
5656
* @throws {@link AccessDeniedException} (client fault)
5757
* <p>You don't have permissions to access the resource.</p>
5858
*
59+
* @throws {@link DisabledOperationException} (client fault)
60+
* <p>Exception is thrown when an operation has been disabled.</p>
61+
*
5962
* @throws {@link InternalException} (server fault)
6063
* <p>The request failed because of an unknown error, exception, or failure (the failure is
6164
* internal to the service).</p>

‎clients/client-osis/src/commands/UpdatePipelineCommand.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
8787
* // SecurityGroupIds: [ // SecurityGroupIds
8888
* // "STRING_VALUE",
8989
* // ],
90+
* // VpcAttachmentOptions: { // VpcAttachmentOptions
91+
* // AttachToVpc: true || false, // required
92+
* // CidrBlock: "STRING_VALUE",
93+
* // },
9094
* // },
9195
* // },
9296
* // ],
@@ -102,6 +106,12 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
102106
* // VpcEndpointId: "STRING_VALUE",
103107
* // },
104108
* // ],
109+
* // Destinations: [ // PipelineDestinationList
110+
* // { // PipelineDestination
111+
* // ServiceName: "STRING_VALUE",
112+
* // Endpoint: "STRING_VALUE",
113+
* // },
114+
* // ],
105115
* // Tags: [ // TagList
106116
* // { // Tag
107117
* // Key: "STRING_VALUE", // required
@@ -125,6 +135,9 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
125135
* @throws {@link ConflictException} (client fault)
126136
* <p>The client attempted to remove a resource that is currently in use.</p>
127137
*
138+
* @throws {@link DisabledOperationException} (client fault)
139+
* <p>Exception is thrown when an operation has been disabled.</p>
140+
*
128141
* @throws {@link InternalException} (server fault)
129142
* <p>The request failed because of an unknown error, exception, or failure (the failure is
130143
* internal to the service).</p>

‎clients/client-osis/src/commands/ValidatePipelineCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ export interface ValidatePipelineCommandOutput extends ValidatePipelineResponse,
6161
* @throws {@link AccessDeniedException} (client fault)
6262
* <p>You don't have permissions to access the resource.</p>
6363
*
64+
* @throws {@link DisabledOperationException} (client fault)
65+
* <p>Exception is thrown when an operation has been disabled.</p>
66+
*
6467
* @throws {@link InternalException} (server fault)
6568
* <p>The request failed because of an unknown error, exception, or failure (the failure is
6669
* internal to the service).</p>

0 commit comments

Comments
 (0)