From 36998766f18f4ee28c62c8dd3854bccadabeb6cd Mon Sep 17 00:00:00 2001
From: awstools Creates an OpenSearch Ingestion pipeline. For more information, see Creating and managing OpenSearch Ingestion pipelines. Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines. Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting
- * pipelines. Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines. Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are
- * templates for the configuration needed for a CreatePipeline
request.CreatePipeline
request. For more
+ * information, see Using
+ * blueprints to create a pipeline.
Returns progress information for the current change happening on an OpenSearch Ingestion * pipeline. Currently, this operation only returns information when a pipeline is being * created.
- *For more information, see Creating and managing - * OpenSearch Ingestion pipelines.
+ *For more information, see Tracking the status of pipeline creation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-osis/src/commands/ListPipelineBlueprintsCommand.ts b/clients/client-osis/src/commands/ListPipelineBlueprintsCommand.ts index 358ee6ad0855..d6966cd95642 100644 --- a/clients/client-osis/src/commands/ListPipelineBlueprintsCommand.ts +++ b/clients/client-osis/src/commands/ListPipelineBlueprintsCommand.ts @@ -32,7 +32,8 @@ export interface ListPipelineBlueprintsCommandOutput extends ListPipelineBluepri /** * @public - *Retrieves a list of all available blueprints for Data Prepper.
+ *Retrieves a list of all available blueprints for Data Prepper. For more information, see + * Using blueprints to create a pipeline.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-osis/src/commands/ListPipelinesCommand.ts b/clients/client-osis/src/commands/ListPipelinesCommand.ts index 9c7fa3ea3163..c156cbbd7ed1 100644 --- a/clients/client-osis/src/commands/ListPipelinesCommand.ts +++ b/clients/client-osis/src/commands/ListPipelinesCommand.ts @@ -33,8 +33,7 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met /** * @public *Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For - * more information, see Creating and managing - * OpenSearch Ingestion pipelines.
+ * more information, see Viewing Amazon OpenSearch Ingestion pipelines. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-osis/src/commands/ListTagsForResourceCommand.ts b/clients/client-osis/src/commands/ListTagsForResourceCommand.ts index d167a396239f..b50a87374736 100644 --- a/clients/client-osis/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-osis/src/commands/ListTagsForResourceCommand.ts @@ -33,8 +33,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * @public *Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, - * see Tagging - * OpenSearch Ingestion pipelines.
+ * see Tagging Amazon OpenSearch Ingestion pipelines. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-osis/src/commands/StartPipelineCommand.ts b/clients/client-osis/src/commands/StartPipelineCommand.ts index 1819d9105b5f..586cb0b1bc0b 100644 --- a/clients/client-osis/src/commands/StartPipelineCommand.ts +++ b/clients/client-osis/src/commands/StartPipelineCommand.ts @@ -32,8 +32,7 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met /** * @public - *Starts an OpenSearch Ingestion pipeline. For more information, see Starting - * pipelines.
+ *Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-osis/src/commands/StopPipelineCommand.ts b/clients/client-osis/src/commands/StopPipelineCommand.ts index dc8bcf3af835..92bb98d71257 100644 --- a/clients/client-osis/src/commands/StopPipelineCommand.ts +++ b/clients/client-osis/src/commands/StopPipelineCommand.ts @@ -32,8 +32,7 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad /** * @public - *Stops an OpenSearch Ingestion pipeline. For more information, see Stopping - * pipelines.
+ *Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-osis/src/commands/TagResourceCommand.ts b/clients/client-osis/src/commands/TagResourceCommand.ts index 8716500b32f6..088be84f1636 100644 --- a/clients/client-osis/src/commands/TagResourceCommand.ts +++ b/clients/client-osis/src/commands/TagResourceCommand.ts @@ -32,8 +32,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** * @public - *Tags an OpenSearch Ingestion pipeline. For more information, see Tagging OpenSearch Ingestion - * pipelines.
+ *Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-osis/src/commands/UntagResourceCommand.ts b/clients/client-osis/src/commands/UntagResourceCommand.ts index 3d02726db4b7..94e9c4857ed9 100644 --- a/clients/client-osis/src/commands/UntagResourceCommand.ts +++ b/clients/client-osis/src/commands/UntagResourceCommand.ts @@ -32,7 +32,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** * @public - *Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging
+ * Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon
* OpenSearch Ingestion pipelines. Updates an OpenSearch Ingestion pipeline. For more information, see Creating and managing
- * OpenSearch Ingestion pipelines. Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines. Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For
- * more information, see Creating and managing
- * OpenSearch Ingestion pipelines.
Creates an OpenSearch Ingestion pipeline. For more information, see Creating and managing OpenSearch Ingestion pipelines.
", + "smithy.api#documentation": "Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/createPipeline", @@ -1047,7 +1047,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting\n pipelines.
", + "smithy.api#documentation": "Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "DELETE", "uri": "/2022-01-01/osis/deletePipeline/{PipelineName}", @@ -1135,7 +1135,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are\n templates for the configuration needed for a CreatePipeline
request.
Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are\n templates for the configuration needed for a CreatePipeline
request. For more\n information, see Using\n blueprints to create a pipeline.
Returns progress information for the current change happening on an OpenSearch Ingestion\n pipeline. Currently, this operation only returns information when a pipeline is being\n created.
\nFor more information, see Creating and managing\n OpenSearch Ingestion pipelines.
", + "smithy.api#documentation": "Returns progress information for the current change happening on an OpenSearch Ingestion\n pipeline. Currently, this operation only returns information when a pipeline is being\n created.
\nFor more information, see Tracking the status of pipeline creation.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/getPipelineChangeProgress/{PipelineName}", @@ -1338,7 +1338,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a list of all available blueprints for Data Prepper.
", + "smithy.api#documentation": "Retrieves a list of all available blueprints for Data Prepper. For more information, see\n Using blueprints to create a pipeline.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/listPipelineBlueprints", @@ -1390,7 +1390,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For\n more information, see Creating and managing\n OpenSearch Ingestion pipelines.
", + "smithy.api#documentation": "Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For\n more information, see Viewing Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/listPipelines", @@ -1468,7 +1468,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information,\n see Tagging\n OpenSearch Ingestion pipelines.
", + "smithy.api#documentation": "Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information,\n see Tagging Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/listTagsForResource", @@ -1927,7 +1927,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an OpenSearch Ingestion pipeline. For more information, see Starting\n pipelines.
", + "smithy.api#documentation": "Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/startPipeline/{PipelineName}", @@ -1988,7 +1988,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops an OpenSearch Ingestion pipeline. For more information, see Stopping\n pipelines.
", + "smithy.api#documentation": "Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/stopPipeline/{PipelineName}", @@ -2118,7 +2118,7 @@ } ], "traits": { - "smithy.api#documentation": "Tags an OpenSearch Ingestion pipeline. For more information, see Tagging OpenSearch Ingestion\n pipelines.
", + "smithy.api#documentation": "Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/tagResource", @@ -2192,7 +2192,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging\n OpenSearch Ingestion pipelines.
", + "smithy.api#documentation": "Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon\n OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/untagResource", @@ -2256,7 +2256,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an OpenSearch Ingestion pipeline. For more information, see Creating and managing\n OpenSearch Ingestion pipelines.
", + "smithy.api#documentation": "Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/updatePipeline/{PipelineName}", @@ -2338,7 +2338,7 @@ } ], "traits": { - "smithy.api#documentation": "Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For\n more information, see Creating and managing\n OpenSearch Ingestion pipelines.
", + "smithy.api#documentation": "Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For\n more information, see Creating Amazon OpenSearch\n Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/validatePipeline",