docs(client-osis): Documentation updates for OpenSearch Ingestion

aws · Apr 27, 2023 · 3699876 · 3699876
1 parent 8e370f2
commit 3699876
Show file tree

Hide file tree

Showing 14 changed files with 53 additions and 58 deletions.
diff --git a/clients/client-osis/src/commands/CreatePipelineCommand.ts b/clients/client-osis/src/commands/CreatePipelineCommand.ts
@@ -32,7 +32,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
 
 /**
  * @public
- * <p>Creates an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html">Creating and managing OpenSearch Ingestion pipelines</a>.</p>
+ * <p>Creates an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html">Creating Amazon OpenSearch Ingestion pipelines</a>.</p>
  * @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/DeletePipelineCommand.ts b/clients/client-osis/src/commands/DeletePipelineCommand.ts
@@ -32,8 +32,7 @@ export interface DeletePipelineCommandOutput extends DeletePipelineResponse, __M
 
 /**
  * @public
- * <p>Deletes an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html#delete-pipeline">Deleting
- *     pipelines</a>.</p>
+ * <p>Deletes an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/delete-pipeline.html">Deleting Amazon OpenSearch Ingestion pipelines</a>.</p>
  * @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/GetPipelineBlueprintCommand.ts b/clients/client-osis/src/commands/GetPipelineBlueprintCommand.ts
@@ -33,7 +33,9 @@ export interface GetPipelineBlueprintCommandOutput extends GetPipelineBlueprintR
 /**
  * @public
  * <p>Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are
- *    templates for the configuration needed for a <code>CreatePipeline</code> request.</p>
+ *    templates for the configuration needed for a <code>CreatePipeline</code> request. For more
+ *    information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint">Using
+ *     blueprints to create a pipeline</a>.</p>
  * @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/GetPipelineChangeProgressCommand.ts b/clients/client-osis/src/commands/GetPipelineChangeProgressCommand.ts
@@ -35,8 +35,7 @@ export interface GetPipelineChangeProgressCommandOutput extends GetPipelineChang
  * <p>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.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html">Creating and managing
- *     OpenSearch Ingestion pipelines</a>.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#get-pipeline-progress">Tracking the status of pipeline creation</a>.</p>
  * @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
@@ -32,7 +32,8 @@ export interface ListPipelineBlueprintsCommandOutput extends ListPipelineBluepri
 
 /**
  * @public
- * <p>Retrieves a list of all available blueprints for Data Prepper.</p>
+ * <p>Retrieves a list of all available blueprints for Data Prepper. For more information, see
+ *    <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint">Using blueprints to create a pipeline</a>.</p>
  * @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
@@ -33,8 +33,7 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met
 /**
  * @public
  * <p>Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For
- *    more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html">Creating and managing
- *     OpenSearch Ingestion pipelines</a>.</p>
+ *    more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.html">Viewing Amazon OpenSearch Ingestion pipelines</a>.</p>
  * @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
@@ -33,8 +33,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 /**
  * @public
  * <p>Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information,
- *    see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging
- *     OpenSearch Ingestion pipelines</a>.</p>
+ *    see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging Amazon OpenSearch Ingestion pipelines</a>.</p>
  * @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
@@ -32,8 +32,7 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
 
 /**
  * @public
- * <p>Starts an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html#start-pipeline">Starting
- *    pipelines</a>.</p>
+ * <p>Starts an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--start">Starting an OpenSearch Ingestion pipeline</a>.</p>
  * @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
@@ -32,8 +32,7 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
 
 /**
  * @public
- * <p>Stops an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html#stop-pipeline">Stopping
- *    pipelines</a>.</p>
+ * <p>Stops an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--stop">Stopping an OpenSearch Ingestion pipeline</a>.</p>
  * @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
@@ -32,8 +32,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 
 /**
  * @public
- * <p>Tags an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging OpenSearch Ingestion
- *     pipelines</a>.</p>
+ * <p>Tags an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging Amazon OpenSearch Ingestion pipelines</a>.</p>
  * @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
@@ -32,7 +32,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 
 /**
  * @public
- * <p>Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging
+ * <p>Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging Amazon
  *     OpenSearch Ingestion pipelines</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-osis/src/commands/UpdatePipelineCommand.ts b/clients/client-osis/src/commands/UpdatePipelineCommand.ts
@@ -32,8 +32,7 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
 
 /**
  * @public
- * <p>Updates an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html">Creating and managing
- *     OpenSearch Ingestion pipelines</a>.</p>
+ * <p>Updates an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/update-pipeline.html">Updating Amazon OpenSearch Ingestion pipelines</a>.</p>
  * @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/ValidatePipelineCommand.ts b/clients/client-osis/src/commands/ValidatePipelineCommand.ts
@@ -33,8 +33,8 @@ export interface ValidatePipelineCommandOutput extends ValidatePipelineResponse,
 /**
  * @public
  * <p>Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For
- *    more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/manage-pipeline.html">Creating and managing
- *     OpenSearch Ingestion pipelines</a>.</p>
+ *    more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html">Creating Amazon OpenSearch
+ *     Ingestion pipelines</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript