From 36998766f18f4ee28c62c8dd3854bccadabeb6cd Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 27 Apr 2023 18:16:21 +0000 Subject: [PATCH] docs(client-osis): Documentation updates for OpenSearch Ingestion --- .../src/commands/CreatePipelineCommand.ts | 2 +- .../src/commands/DeletePipelineCommand.ts | 3 +- .../commands/GetPipelineBlueprintCommand.ts | 4 +- .../GetPipelineChangeProgressCommand.ts | 3 +- .../commands/ListPipelineBlueprintsCommand.ts | 3 +- .../src/commands/ListPipelinesCommand.ts | 3 +- .../commands/ListTagsForResourceCommand.ts | 3 +- .../src/commands/StartPipelineCommand.ts | 3 +- .../src/commands/StopPipelineCommand.ts | 3 +- .../src/commands/TagResourceCommand.ts | 3 +- .../src/commands/UntagResourceCommand.ts | 2 +- .../src/commands/UpdatePipelineCommand.ts | 3 +- .../src/commands/ValidatePipelineCommand.ts | 4 +- codegen/sdk-codegen/aws-models/osis.json | 72 +++++++++---------- 14 files changed, 53 insertions(+), 58 deletions(-) diff --git a/clients/client-osis/src/commands/CreatePipelineCommand.ts b/clients/client-osis/src/commands/CreatePipelineCommand.ts index e76b29546cf4..87890e85905f 100644 --- 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 - *

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.

* @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 index b2d7891aac7b..7ead8a2163d2 100644 --- 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 - *

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.

* @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 index 7f621cee7415..81665211a123 100644 --- 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 *

Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are - * templates for the configuration needed for a CreatePipeline request.

+ * templates for the configuration needed for a CreatePipeline request. 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/GetPipelineChangeProgressCommand.ts b/clients/client-osis/src/commands/GetPipelineChangeProgressCommand.ts index 71b68a45951b..77ed34857911 100644 --- 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 *

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.

* @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 index 9c64e21de6b2..4e191a75c5ee 100644 --- 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 - *

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.

* @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 index 0dffbf68fa74..a936bf4376e6 100644 --- 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 *

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For - * more information, see Creating and managing - * OpenSearch Ingestion pipelines.

+ * more information, see Creating Amazon OpenSearch + * Ingestion pipelines.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/codegen/sdk-codegen/aws-models/osis.json b/codegen/sdk-codegen/aws-models/osis.json index 961739b04527..5546922bf3f0 100644 --- a/codegen/sdk-codegen/aws-models/osis.json +++ b/codegen/sdk-codegen/aws-models/osis.json @@ -466,8 +466,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": true } }, @@ -479,8 +479,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": true } }, @@ -492,8 +492,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": true, + "Region": "us-gov-east-1", "UseFIPS": false } }, @@ -505,8 +505,8 @@ } }, "params": { - "Region": "us-gov-east-1", "UseDualStack": false, + "Region": "us-gov-east-1", "UseFIPS": false } }, @@ -518,8 +518,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": true } }, @@ -531,8 +531,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": true } }, @@ -544,8 +544,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": true, + "Region": "cn-north-1", "UseFIPS": false } }, @@ -557,8 +557,8 @@ } }, "params": { - "Region": "cn-north-1", "UseDualStack": false, + "Region": "cn-north-1", "UseFIPS": false } }, @@ -568,8 +568,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": true } }, @@ -581,8 +581,8 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": true } }, @@ -592,8 +592,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", "UseDualStack": true, + "Region": "us-iso-east-1", "UseFIPS": false } }, @@ -605,8 +605,8 @@ } }, "params": { - "Region": "us-iso-east-1", "UseDualStack": false, + "Region": "us-iso-east-1", "UseFIPS": false } }, @@ -618,8 +618,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": true } }, @@ -631,8 +631,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true } }, @@ -644,8 +644,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false } }, @@ -657,8 +657,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false } }, @@ -668,8 +668,8 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-isob-east-1", "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": true } }, @@ -681,8 +681,8 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": true } }, @@ -692,8 +692,8 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-isob-east-1", "UseDualStack": true, + "Region": "us-isob-east-1", "UseFIPS": false } }, @@ -705,8 +705,8 @@ } }, "params": { - "Region": "us-isob-east-1", "UseDualStack": false, + "Region": "us-isob-east-1", "UseFIPS": false } }, @@ -718,8 +718,8 @@ } }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } @@ -730,8 +730,8 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": false, + "Region": "us-east-1", "UseFIPS": true, "Endpoint": "https://example.com" } @@ -742,8 +742,8 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", "UseDualStack": true, + "Region": "us-east-1", "UseFIPS": false, "Endpoint": "https://example.com" } @@ -945,7 +945,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/getPipelineBlueprint/{BlueprintName}", @@ -1196,7 +1196,7 @@ } ], "traits": { - "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.

\n

For 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.

\n

For 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",