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.

awstools · awstools · commit 8ea42220e50e · 2024-05-20T18:36:46.000Z
diff --git a/clients/client-osis/src/commands/CreatePipelineCommand.ts b/clients/client-osis/src/commands/CreatePipelineCommand.ts
@@ -52,6 +52,10 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
  *     SecurityGroupIds: [ // SecurityGroupIds
  *       "STRING_VALUE",
  *     ],
+ *     VpcAttachmentOptions: { // VpcAttachmentOptions
+ *       AttachToVpc: true || false, // required
+ *       CidrBlock: "STRING_VALUE",
+ *     },
  *   },
  *   BufferOptions: { // BufferOptions
  *     PersistentBufferEnabled: true || false, // required
@@ -101,6 +105,10 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
  * //           SecurityGroupIds: [ // SecurityGroupIds
  * //             "STRING_VALUE",
  * //           ],
+ * //           VpcAttachmentOptions: { // VpcAttachmentOptions
+ * //             AttachToVpc: true || false, // required
+ * //             CidrBlock: "STRING_VALUE",
+ * //           },
  * //         },
  * //       },
  * //     ],
@@ -116,6 +124,12 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
  * //         VpcEndpointId: "STRING_VALUE",
  * //       },
  * //     ],
+ * //     Destinations: [ // PipelineDestinationList
+ * //       { // PipelineDestination
+ * //         ServiceName: "STRING_VALUE",
+ * //         Endpoint: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     Tags: [ // TagList
  * //       { // Tag
  * //         Key: "STRING_VALUE", // required
@@ -136,6 +150,9 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/DeletePipelineCommand.ts b/clients/client-osis/src/commands/DeletePipelineCommand.ts
@@ -55,6 +55,9 @@ export interface DeletePipelineCommandOutput extends DeletePipelineResponse, __M
  * @throws {@link ConflictException} (client fault)
  *  <p>The client attempted to remove a resource that is currently in use.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/GetPipelineBlueprintCommand.ts b/clients/client-osis/src/commands/GetPipelineBlueprintCommand.ts
@@ -39,14 +39,20 @@ export interface GetPipelineBlueprintCommandOutput extends GetPipelineBlueprintR
  * const client = new OSISClient(config);
  * const input = { // GetPipelineBlueprintRequest
  *   BlueprintName: "STRING_VALUE", // required
+ *   Format: "STRING_VALUE",
  * };
  * const command = new GetPipelineBlueprintCommand(input);
  * const response = await client.send(command);
  * // { // GetPipelineBlueprintResponse
  * //   Blueprint: { // PipelineBlueprint
  * //     BlueprintName: "STRING_VALUE",
  * //     PipelineConfigurationBody: "STRING_VALUE",
+ * //     DisplayName: "STRING_VALUE",
+ * //     DisplayDescription: "STRING_VALUE",
+ * //     Service: "STRING_VALUE",
+ * //     UseCase: "STRING_VALUE",
  * //   },
+ * //   Format: "STRING_VALUE",
  * // };
  *
  * ```
@@ -60,6 +66,9 @@ export interface GetPipelineBlueprintCommandOutput extends GetPipelineBlueprintR
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/GetPipelineChangeProgressCommand.ts b/clients/client-osis/src/commands/GetPipelineChangeProgressCommand.ts
@@ -71,6 +71,9 @@ export interface GetPipelineChangeProgressCommandOutput extends GetPipelineChang
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/GetPipelineCommand.ts b/clients/client-osis/src/commands/GetPipelineCommand.ts
@@ -72,6 +72,10 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
  * //           SecurityGroupIds: [ // SecurityGroupIds
  * //             "STRING_VALUE",
  * //           ],
+ * //           VpcAttachmentOptions: { // VpcAttachmentOptions
+ * //             AttachToVpc: true || false, // required
+ * //             CidrBlock: "STRING_VALUE",
+ * //           },
  * //         },
  * //       },
  * //     ],
@@ -87,6 +91,12 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
  * //         VpcEndpointId: "STRING_VALUE",
  * //       },
  * //     ],
+ * //     Destinations: [ // PipelineDestinationList
+ * //       { // PipelineDestination
+ * //         ServiceName: "STRING_VALUE",
+ * //         Endpoint: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     Tags: [ // TagList
  * //       { // Tag
  * //         Key: "STRING_VALUE", // required
@@ -107,6 +117,9 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/ListPipelineBlueprintsCommand.ts b/clients/client-osis/src/commands/ListPipelineBlueprintsCommand.ts
@@ -42,6 +42,10 @@ export interface ListPipelineBlueprintsCommandOutput extends ListPipelineBluepri
  * //   Blueprints: [ // PipelineBlueprintsSummaryList
  * //     { // PipelineBlueprintSummary
  * //       BlueprintName: "STRING_VALUE",
+ * //       DisplayName: "STRING_VALUE",
+ * //       DisplayDescription: "STRING_VALUE",
+ * //       Service: "STRING_VALUE",
+ * //       UseCase: "STRING_VALUE",
  * //     },
  * //   ],
  * // };
@@ -57,6 +61,9 @@ export interface ListPipelineBlueprintsCommandOutput extends ListPipelineBluepri
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/ListPipelinesCommand.ts b/clients/client-osis/src/commands/ListPipelinesCommand.ts
@@ -55,6 +55,12 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met
  * //       MaxUnits: Number("int"),
  * //       CreatedAt: new Date("TIMESTAMP"),
  * //       LastUpdatedAt: new Date("TIMESTAMP"),
+ * //       Destinations: [ // PipelineDestinationList
+ * //         { // PipelineDestination
+ * //           ServiceName: "STRING_VALUE",
+ * //           Endpoint: "STRING_VALUE",
+ * //         },
+ * //       ],
  * //       Tags: [ // TagList
  * //         { // Tag
  * //           Key: "STRING_VALUE", // required
@@ -76,6 +82,9 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/ListTagsForResourceCommand.ts b/clients/client-osis/src/commands/ListTagsForResourceCommand.ts
@@ -60,6 +60,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/StartPipelineCommand.ts b/clients/client-osis/src/commands/StartPipelineCommand.ts
@@ -72,6 +72,10 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
  * //           SecurityGroupIds: [ // SecurityGroupIds
  * //             "STRING_VALUE",
  * //           ],
+ * //           VpcAttachmentOptions: { // VpcAttachmentOptions
+ * //             AttachToVpc: true || false, // required
+ * //             CidrBlock: "STRING_VALUE",
+ * //           },
  * //         },
  * //       },
  * //     ],
@@ -87,6 +91,12 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
  * //         VpcEndpointId: "STRING_VALUE",
  * //       },
  * //     ],
+ * //     Destinations: [ // PipelineDestinationList
+ * //       { // PipelineDestination
+ * //         ServiceName: "STRING_VALUE",
+ * //         Endpoint: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     Tags: [ // TagList
  * //       { // Tag
  * //         Key: "STRING_VALUE", // required
@@ -110,6 +120,9 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
  * @throws {@link ConflictException} (client fault)
  *  <p>The client attempted to remove a resource that is currently in use.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/StopPipelineCommand.ts b/clients/client-osis/src/commands/StopPipelineCommand.ts
@@ -72,6 +72,10 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
  * //           SecurityGroupIds: [ // SecurityGroupIds
  * //             "STRING_VALUE",
  * //           ],
+ * //           VpcAttachmentOptions: { // VpcAttachmentOptions
+ * //             AttachToVpc: true || false, // required
+ * //             CidrBlock: "STRING_VALUE",
+ * //           },
  * //         },
  * //       },
  * //     ],
@@ -87,6 +91,12 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
  * //         VpcEndpointId: "STRING_VALUE",
  * //       },
  * //     ],
+ * //     Destinations: [ // PipelineDestinationList
+ * //       { // PipelineDestination
+ * //         ServiceName: "STRING_VALUE",
+ * //         Endpoint: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     Tags: [ // TagList
  * //       { // Tag
  * //         Key: "STRING_VALUE", // required
@@ -110,6 +120,9 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
  * @throws {@link ConflictException} (client fault)
  *  <p>The client attempted to remove a resource that is currently in use.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/TagResourceCommand.ts b/clients/client-osis/src/commands/TagResourceCommand.ts
@@ -58,6 +58,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/UntagResourceCommand.ts b/clients/client-osis/src/commands/UntagResourceCommand.ts
@@ -56,6 +56,9 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/UpdatePipelineCommand.ts b/clients/client-osis/src/commands/UpdatePipelineCommand.ts
@@ -87,6 +87,10 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
  * //           SecurityGroupIds: [ // SecurityGroupIds
  * //             "STRING_VALUE",
  * //           ],
+ * //           VpcAttachmentOptions: { // VpcAttachmentOptions
+ * //             AttachToVpc: true || false, // required
+ * //             CidrBlock: "STRING_VALUE",
+ * //           },
  * //         },
  * //       },
  * //     ],
@@ -102,6 +106,12 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
  * //         VpcEndpointId: "STRING_VALUE",
  * //       },
  * //     ],
+ * //     Destinations: [ // PipelineDestinationList
+ * //       { // PipelineDestination
+ * //         ServiceName: "STRING_VALUE",
+ * //         Endpoint: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //     Tags: [ // TagList
  * //       { // Tag
  * //         Key: "STRING_VALUE", // required
@@ -125,6 +135,9 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
  * @throws {@link ConflictException} (client fault)
  *  <p>The client attempted to remove a resource that is currently in use.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/commands/ValidatePipelineCommand.ts b/clients/client-osis/src/commands/ValidatePipelineCommand.ts
@@ -61,6 +61,9 @@ export interface ValidatePipelineCommandOutput extends ValidatePipelineResponse,
  * @throws {@link AccessDeniedException} (client fault)
  *  <p>You don't have permissions to access the resource.</p>
  *
+ * @throws {@link DisabledOperationException} (client fault)
+ *  <p>Exception is thrown when an operation has been disabled.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>The request failed because of an unknown error, exception, or failure (the failure is
  *    internal to the service).</p>
diff --git a/clients/client-osis/src/models/models_0.ts b/clients/client-osis/src/models/models_0.ts
diff --git a/clients/client-osis/src/protocols/Aws_restJson1.ts b/clients/client-osis/src/protocols/Aws_restJson1.ts
diff --git a/codegen/sdk-codegen/aws-models/osis.json b/codegen/sdk-codegen/aws-models/osis.json
