From 58830f4b24b1a3dbc7f495d325f257bd5e2389f9 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 13 Sep 2024 18:12:06 +0000 Subject: [PATCH] docs(client-ivschat): Updates to all tags descriptions. --- clients/client-ivschat/README.md | 7 +++--- clients/client-ivschat/src/Ivschat.ts | 7 +++--- clients/client-ivschat/src/IvschatClient.ts | 7 +++--- clients/client-ivschat/src/index.ts | 7 +++--- clients/client-ivschat/src/models/models_0.ts | 24 +++++-------------- codegen/sdk-codegen/aws-models/ivschat.json | 14 +++++------ 6 files changed, 25 insertions(+), 41 deletions(-) diff --git a/clients/client-ivschat/README.md b/clients/client-ivschat/README.md index 56989454dd32..2b8aaddee50f 100644 --- a/clients/client-ivschat/README.md +++ b/clients/client-ivschat/README.md @@ -53,13 +53,12 @@ information.

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video -category. See Tagging AWS Resources for more information, including restrictions that apply to -tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific +category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

-

The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and +

The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.

At most 50 tags can be applied to a resource.

@@ -81,7 +80,7 @@ to have permissions for Amazon IVS Chat API requests.

Users (viewers) connect to a room using secure access tokens that you create using the -CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for +CreateChatToken operation through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.

diff --git a/clients/client-ivschat/src/Ivschat.ts b/clients/client-ivschat/src/Ivschat.ts index fff41c0ce9f4..e4815383cbf4 100644 --- a/clients/client-ivschat/src/Ivschat.ts +++ b/clients/client-ivschat/src/Ivschat.ts @@ -363,13 +363,12 @@ export interface Ivschat { *

A tag is a metadata label that you assign to an AWS resource. A tag * comprises a key and a value, both set by you. For * example, you might set a tag as topic:nature to label a particular video - * category. See Tagging AWS Resources for more information, including restrictions that apply to - * tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific + * category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific * constraints beyond what is documented there.

*

Tags can help you identify and organize your AWS resources. For example, you can use the * same tag for different resources to indicate that they are related. You can also use tags to * manage access (see Access Tags).

- *

The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and + *

The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and * ListTagsForResource. The following resource supports tagging: Room.

*

At most 50 tags can be applied to a resource.

*

@@ -391,7 +390,7 @@ export interface Ivschat { * * *

Users (viewers) connect to a room using secure access tokens that you create using the - * CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for + * CreateChatToken operation through the AWS SDK. You call CreateChatToken for * every user’s chat session, passing identity and authorization information about the * user.

*

diff --git a/clients/client-ivschat/src/IvschatClient.ts b/clients/client-ivschat/src/IvschatClient.ts index 89d7df6e652b..0b142d784b1a 100644 --- a/clients/client-ivschat/src/IvschatClient.ts +++ b/clients/client-ivschat/src/IvschatClient.ts @@ -362,13 +362,12 @@ export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfig *

A tag is a metadata label that you assign to an AWS resource. A tag * comprises a key and a value, both set by you. For * example, you might set a tag as topic:nature to label a particular video - * category. See Tagging AWS Resources for more information, including restrictions that apply to - * tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific + * category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific * constraints beyond what is documented there.

*

Tags can help you identify and organize your AWS resources. For example, you can use the * same tag for different resources to indicate that they are related. You can also use tags to * manage access (see Access Tags).

- *

The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and + *

The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and * ListTagsForResource. The following resource supports tagging: Room.

*

At most 50 tags can be applied to a resource.

*

@@ -390,7 +389,7 @@ export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfig * * *

Users (viewers) connect to a room using secure access tokens that you create using the - * CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for + * CreateChatToken operation through the AWS SDK. You call CreateChatToken for * every user’s chat session, passing identity and authorization information about the * user.

*

diff --git a/clients/client-ivschat/src/index.ts b/clients/client-ivschat/src/index.ts index 44e8ea354343..439d0458363c 100644 --- a/clients/client-ivschat/src/index.ts +++ b/clients/client-ivschat/src/index.ts @@ -48,13 +48,12 @@ *

A tag is a metadata label that you assign to an AWS resource. A tag * comprises a key and a value, both set by you. For * example, you might set a tag as topic:nature to label a particular video - * category. See Tagging AWS Resources for more information, including restrictions that apply to - * tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific + * category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific * constraints beyond what is documented there.

*

Tags can help you identify and organize your AWS resources. For example, you can use the * same tag for different resources to indicate that they are related. You can also use tags to * manage access (see Access Tags).

- *

The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and + *

The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and * ListTagsForResource. The following resource supports tagging: Room.

*

At most 50 tags can be applied to a resource.

*

@@ -76,7 +75,7 @@ * * *

Users (viewers) connect to a room using secure access tokens that you create using the - * CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for + * CreateChatToken operation through the AWS SDK. You call CreateChatToken for * every user’s chat session, passing identity and authorization information about the * user.

*

diff --git a/clients/client-ivschat/src/models/models_0.ts b/clients/client-ivschat/src/models/models_0.ts index d2f8f870490c..0cba46c1fadc 100644 --- a/clients/client-ivschat/src/models/models_0.ts +++ b/clients/client-ivschat/src/models/models_0.ts @@ -407,9 +407,7 @@ export interface CreateLoggingConfigurationRequest { /** *

Tags to attach to the resource. Array of maps, each of the form string:string - * (key:value). See Tagging AWS - * Resources for details, including restrictions that apply to tags and "Tag naming - * limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is + * (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is * documented there.

* @public */ @@ -603,9 +601,7 @@ export interface CreateRoomRequest { /** *

Tags to attach to the resource. Array of maps, each of the form string:string - * (key:value). See Tagging AWS - * Resources for details, including restrictions that apply to tags and "Tag naming - * limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented + * (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented * there.

* @public */ @@ -1066,9 +1062,7 @@ export interface LoggingConfigurationSummary { /** *

Tags to attach to the resource. Array of maps, each of the form string:string - * (key:value). See Tagging AWS - * Resources for details, including restrictions that apply to tags and "Tag naming - * limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented + * (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented * there.

* @public */ @@ -1177,9 +1171,7 @@ export interface RoomSummary { /** *

Tags attached to the resource. Array of maps, each of the form string:string - * (key:value). See Tagging AWS - * Resources for details, including restrictions that apply to tags and "Tag naming - * limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented + * (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented * there.

* @public */ @@ -1302,9 +1294,7 @@ export interface TagResourceRequest { /** *

Array of tags to be added or updated. Array of maps, each of the form - * string:string (key:value). See Tagging AWS - * Resources for details, including restrictions that apply to tags and "Tag naming - * limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented + * string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented * there.

* @public */ @@ -1328,9 +1318,7 @@ export interface UntagResourceRequest { /** *

Array of tags to be removed. Array of maps, each of the form string:string - * (key:value). See Tagging AWS - * Resources for details, including restrictions that apply to tags and "Tag naming - * limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented + * (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented * there.

* @public */ diff --git a/codegen/sdk-codegen/aws-models/ivschat.json b/codegen/sdk-codegen/aws-models/ivschat.json index 350eee4485ae..3e2344276fe3 100644 --- a/codegen/sdk-codegen/aws-models/ivschat.json +++ b/codegen/sdk-codegen/aws-models/ivschat.json @@ -103,7 +103,7 @@ "date" ] }, - "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat\n resources. You also need to integrate with the Amazon IVS Chat Messaging\n API, to enable users to interact with chat rooms in real time.

\n

The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat\n HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the\n AWS General Reference.

\n

This document describes HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\n Reference.

\n

\n Notes on terminology:\n

\n \n

\n Resources\n

\n

The following resources are part of Amazon IVS Chat:

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS Resources for more information, including restrictions that apply to\n tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific\n constraints beyond what is documented there.

\n

Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).

\n

The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Room.

\n

At most 50 tags can be applied to a resource.

\n

\n API Access Security\n

\n

Your Amazon IVS Chat applications (service applications and clients) must be authenticated\n and authorized to access Amazon IVS Chat resources. Note the differences between these\n concepts:

\n \n

Users (viewers) connect to a room using secure access tokens that you create using the\n CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for\n every user’s chat session, passing identity and authorization information about the\n user.

\n

\n Signing API Requests\n

\n

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security\n credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the\n underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API\n directly, it’s your responsibility to sign the requests.

\n

You generate a signature using valid AWS credentials for an IAM role that has permission\n to perform the requested action. For example, DeleteMessage requests must be made using an IAM\n role that has the ivschat:DeleteMessage permission.

\n

For more information:

\n \n

\n Amazon Resource Names (ARNs)\n

\n

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a\n resource unambiguously across all of AWS, such as in IAM policies and API calls. For more\n information, see Amazon Resource Names in the AWS General\n Reference.

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

\n Introduction\n

\n

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat\n resources. You also need to integrate with the Amazon IVS Chat Messaging\n API, to enable users to interact with chat rooms in real time.

\n

The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat\n HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the\n AWS General Reference.

\n

This document describes HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\n Reference.

\n

\n Notes on terminology:\n

\n \n

\n Resources\n

\n

The following resources are part of Amazon IVS Chat:

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific\n constraints beyond what is documented there.

\n

Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).

\n

The Amazon IVS Chat API has these tag-related operations: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Room.

\n

At most 50 tags can be applied to a resource.

\n

\n API Access Security\n

\n

Your Amazon IVS Chat applications (service applications and clients) must be authenticated\n and authorized to access Amazon IVS Chat resources. Note the differences between these\n concepts:

\n \n

Users (viewers) connect to a room using secure access tokens that you create using the\n CreateChatToken operation through the AWS SDK. You call CreateChatToken for\n every user’s chat session, passing identity and authorization information about the\n user.

\n

\n Signing API Requests\n

\n

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security\n credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the\n underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API\n directly, it’s your responsibility to sign the requests.

\n

You generate a signature using valid AWS credentials for an IAM role that has permission\n to perform the requested action. For example, DeleteMessage requests must be made using an IAM\n role that has the ivschat:DeleteMessage permission.

\n

For more information:

\n \n

\n Amazon Resource Names (ARNs)\n

\n

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a\n resource unambiguously across all of AWS, such as in IAM policies and API calls. For more\n information, see Amazon Resource Names in the AWS General\n Reference.

", "smithy.api#title": "Amazon Interactive Video Service Chat", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1004,7 +1004,7 @@ "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { - "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is\n documented there.

" + "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is\n documented there.

" } } } @@ -1139,7 +1139,7 @@ "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { - "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

" + "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

" } }, "loggingConfigurationIdentifiers": { @@ -2118,7 +2118,7 @@ "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { - "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is documented\n there.

" + "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints on tags beyond what is documented\n there.

" } } }, @@ -2370,7 +2370,7 @@ "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { - "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

" + "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

" } }, "loggingConfigurationIdentifiers": { @@ -2580,7 +2580,7 @@ "tags": { "target": "com.amazonaws.ivschat#Tags", "traits": { - "smithy.api#documentation": "

Array of tags to be added or updated. Array of maps, each of the form\n string:string (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

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

Array of tags to be added or updated. Array of maps, each of the form\n string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

", "smithy.api#required": {} } } @@ -2700,7 +2700,7 @@ "tagKeys": { "target": "com.amazonaws.ivschat#TagKeyList", "traits": { - "smithy.api#documentation": "

Array of tags to be removed. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

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

Array of tags to be removed. Array of maps, each of the form string:string\n (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented\n there.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} }