From 7b321a2043c9e2a514d6b03f294cdd056d8de681 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 2 Apr 2024 18:59:55 +0000 Subject: [PATCH] docs(client-ivschat): Doc-only update. Changed "Resources" to "Key Concepts" in docs and updated text. --- clients/client-ivschat/README.md | 9 +++------ clients/client-ivschat/src/Ivschat.ts | 9 +++------ clients/client-ivschat/src/IvschatClient.ts | 9 +++------ clients/client-ivschat/src/index.ts | 9 +++------ codegen/sdk-codegen/aws-models/ivschat.json | 2 +- 5 files changed, 13 insertions(+), 25 deletions(-) diff --git a/clients/client-ivschat/README.md b/clients/client-ivschat/README.md index 1ce00b491171..17e53499c7e9 100644 --- a/clients/client-ivschat/README.md +++ b/clients/client-ivschat/README.md @@ -29,19 +29,16 @@ Amazon IVS Chat Messaging API. We refer to these as clients.

-Resources +Key Concepts

-

The following resources are part of Amazon IVS Chat:

diff --git a/clients/client-ivschat/src/Ivschat.ts b/clients/client-ivschat/src/Ivschat.ts index 1adcbeba0d64..d44a8e43d9b0 100644 --- a/clients/client-ivschat/src/Ivschat.ts +++ b/clients/client-ivschat/src/Ivschat.ts @@ -339,19 +339,16 @@ export interface Ivschat { * * *

- * Resources + * Key Concepts *

- *

The following resources are part of Amazon IVS Chat:

* *

diff --git a/clients/client-ivschat/src/IvschatClient.ts b/clients/client-ivschat/src/IvschatClient.ts index bf55b009f119..c3c0af04f8b6 100644 --- a/clients/client-ivschat/src/IvschatClient.ts +++ b/clients/client-ivschat/src/IvschatClient.ts @@ -338,19 +338,16 @@ export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfig * * *

- * Resources + * Key Concepts *

- *

The following resources are part of Amazon IVS Chat:

* *

diff --git a/clients/client-ivschat/src/index.ts b/clients/client-ivschat/src/index.ts index 975b1de67354..a200ab68afb9 100644 --- a/clients/client-ivschat/src/index.ts +++ b/clients/client-ivschat/src/index.ts @@ -24,19 +24,16 @@ * * *

- * Resources + * Key Concepts *

- *

The following resources are part of Amazon IVS Chat:

* *

diff --git a/codegen/sdk-codegen/aws-models/ivschat.json b/codegen/sdk-codegen/aws-models/ivschat.json index f7c09266d401..a7b3cf3ee817 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

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

\n

\n Messaging Endpoints\n

\n \n

\n Chat Token Endpoint\n

\n \n

\n Room Endpoints\n

\n \n

\n Logging Configuration Endpoints\n

\n \n

\n Tags Endpoints\n

\n \n

All the above are HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\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

\n Notes on terminology:\n

\n \n

\n Key Concepts\n

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

\n

\n Messaging Endpoints\n

\n \n

\n Chat Token Endpoint\n

\n \n

\n Room Endpoints\n

\n \n

\n Logging Configuration Endpoints\n

\n \n

\n Tags Endpoints\n

\n \n

All the above are HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\n Reference.

", "smithy.api#title": "Amazon Interactive Video Service Chat", "smithy.rules#endpointRuleSet": { "version": "1.0",