Skip to content

Commit 71e6e59

Browse files
author
awstools
committed
docs(client-ivschat): Documentation update for IVS Chat API Reference.
1 parent 226e9c6 commit 71e6e59

File tree

6 files changed

+38
-474
lines changed

6 files changed

+38
-474
lines changed

‎clients/client-ivschat/README.md

Lines changed: 9 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ API</a>, to enable users to interact with chat rooms in real time.</p>
1515
<p>The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat
1616
HTTPS service endpoints, see the Amazon IVS Chat information on the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the
1717
<i>AWS General Reference</i>. </p>
18+
<p>This document describes HTTP operations. There is a separate <i>messaging</i> API
19+
for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
20+
Reference</a>.</p>
1821
<p>
1922
<b>Notes on terminology:</b>
2023
</p>
@@ -29,16 +32,19 @@ Amazon IVS Chat Messaging API. We refer to these as <i>clients</i>. </p>
2932
</li>
3033
</ul>
3134
<p>
32-
<b>Key Concepts</b>
35+
<b>Resources</b>
3336
</p>
37+
<p>The following resources are part of Amazon IVS Chat:</p>
3438
<ul>
3539
<li>
3640
<p>
37-
<b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room.</p>
41+
<b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.</p>
3842
</li>
3943
<li>
4044
<p>
41-
<b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.</p>
45+
<b>Room</b> — The central Amazon IVS Chat resource through
46+
which clients connect to and exchange chat messages. See the Room endpoints for more
47+
information.</p>
4248
</li>
4349
</ul>
4450
<p>
@@ -107,121 +113,6 @@ the Security page of the <i>Amazon IVS User Guide</i>.</p>
107113
resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
108114
information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
109115
Reference</i>.</p>
110-
<p>
111-
<b>Messaging Endpoints</b>
112-
</p>
113-
<ul>
114-
<li>
115-
<p>
116-
<a>DeleteMessage</a> — Sends an event to a specific room which
117-
directs clients to delete a specific message; that is, unrender it from view and delete it
118-
from the client’s chat history. This event’s <code>EventName</code> is
119-
<code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
120-
DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
121-
</li>
122-
<li>
123-
<p>
124-
<a>DisconnectUser</a> — Disconnects all connections using a specified
125-
user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
126-
DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
127-
</li>
128-
<li>
129-
<p>
130-
<a>SendEvent</a> — Sends an event to a room. Use this within your
131-
application’s business logic to send events to clients of a room; e.g., to notify clients
132-
to change the way the chat UI is rendered.</p>
133-
</li>
134-
</ul>
135-
<p>
136-
<b>Chat Token Endpoint</b>
137-
</p>
138-
<ul>
139-
<li>
140-
<p>
141-
<a>CreateChatToken</a> — Creates an encrypted token that is used by a chat participant to establish an
142-
individual WebSocket chat connection to a room. When the token is used to connect to chat,
143-
the connection is valid for the session duration specified in the request. The token
144-
becomes invalid at the token-expiration timestamp included in the response.</p>
145-
</li>
146-
</ul>
147-
<p>
148-
<b>Room Endpoints</b>
149-
</p>
150-
<ul>
151-
<li>
152-
<p>
153-
<a>CreateRoom</a> — Creates a room that allows clients to connect and
154-
pass messages.</p>
155-
</li>
156-
<li>
157-
<p>
158-
<a>DeleteRoom</a> — Deletes the specified room.</p>
159-
</li>
160-
<li>
161-
<p>
162-
<a>GetRoom</a> — Gets the specified room.</p>
163-
</li>
164-
<li>
165-
<p>
166-
<a>ListRooms</a> — Gets summary information about all your rooms in
167-
the AWS region where the API request is processed. </p>
168-
</li>
169-
<li>
170-
<p>
171-
<a>UpdateRoom</a> — Updates a room’s configuration.</p>
172-
</li>
173-
</ul>
174-
<p>
175-
<b>Logging Configuration Endpoints</b>
176-
</p>
177-
<ul>
178-
<li>
179-
<p>
180-
<a>CreateLoggingConfiguration</a> — Creates a logging configuration that allows clients to store and record sent messages.</p>
181-
</li>
182-
<li>
183-
<p>
184-
<a>DeleteLoggingConfiguration</a> — Deletes the specified logging
185-
configuration.</p>
186-
</li>
187-
<li>
188-
<p>
189-
<a>GetLoggingConfiguration</a> — Gets the specified logging
190-
configuration.</p>
191-
</li>
192-
<li>
193-
<p>
194-
<a>ListLoggingConfigurations</a> — Gets summary information about all
195-
your logging configurations in the AWS region where the API request is processed.</p>
196-
</li>
197-
<li>
198-
<p>
199-
<a>UpdateLoggingConfiguration</a> — Updates a specified logging configuration.</p>
200-
</li>
201-
</ul>
202-
<p>
203-
<b>Tags Endpoints</b>
204-
</p>
205-
<ul>
206-
<li>
207-
<p>
208-
<a>ListTagsForResource</a> — Gets information about AWS tags for the
209-
specified ARN.</p>
210-
</li>
211-
<li>
212-
<p>
213-
<a>TagResource</a> — Adds or updates tags for the AWS resource with
214-
the specified ARN.</p>
215-
</li>
216-
<li>
217-
<p>
218-
<a>UntagResource</a> — Removes tags from the resource with the
219-
specified ARN.</p>
220-
</li>
221-
</ul>
222-
<p>All the above are HTTP operations. There is a separate <i>messaging</i> API
223-
for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
224-
Reference</a>.</p>
225116

226117
## Installing
227118

‎clients/client-ivschat/src/Ivschat.ts

Lines changed: 9 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,9 @@ export interface Ivschat {
325325
* <p>The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat
326326
* HTTPS service endpoints, see the Amazon IVS Chat information on the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the
327327
* <i>AWS General Reference</i>. </p>
328+
* <p>This document describes HTTP operations. There is a separate <i>messaging</i> API
329+
* for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
330+
* Reference</a>.</p>
328331
* <p>
329332
* <b>Notes on terminology:</b>
330333
* </p>
@@ -339,16 +342,19 @@ export interface Ivschat {
339342
* </li>
340343
* </ul>
341344
* <p>
342-
* <b>Key Concepts</b>
345+
* <b>Resources</b>
343346
* </p>
347+
* <p>The following resources are part of Amazon IVS Chat:</p>
344348
* <ul>
345349
* <li>
346350
* <p>
347-
* <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room.</p>
351+
* <b>LoggingConfiguration</b> — A configuration that allows customers to store and record sent messages in a chat room. See the Logging Configuration endpoints for more information.</p>
348352
* </li>
349353
* <li>
350354
* <p>
351-
* <b>Room</b> — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages.</p>
355+
* <b>Room</b> — The central Amazon IVS Chat resource through
356+
* which clients connect to and exchange chat messages. See the Room endpoints for more
357+
* information.</p>
352358
* </li>
353359
* </ul>
354360
* <p>
@@ -417,121 +423,6 @@ export interface Ivschat {
417423
* resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
418424
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
419425
* Reference</i>.</p>
420-
* <p>
421-
* <b>Messaging Endpoints</b>
422-
* </p>
423-
* <ul>
424-
* <li>
425-
* <p>
426-
* <a>DeleteMessage</a> — Sends an event to a specific room which
427-
* directs clients to delete a specific message; that is, unrender it from view and delete it
428-
* from the client’s chat history. This event’s <code>EventName</code> is
429-
* <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html">
430-
* DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
431-
* </li>
432-
* <li>
433-
* <p>
434-
* <a>DisconnectUser</a> — Disconnects all connections using a specified
435-
* user ID from a room. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html">
436-
* DisconnectUser</a> WebSocket operation in the Amazon IVS Chat Messaging API.</p>
437-
* </li>
438-
* <li>
439-
* <p>
440-
* <a>SendEvent</a> — Sends an event to a room. Use this within your
441-
* application’s business logic to send events to clients of a room; e.g., to notify clients
442-
* to change the way the chat UI is rendered.</p>
443-
* </li>
444-
* </ul>
445-
* <p>
446-
* <b>Chat Token Endpoint</b>
447-
* </p>
448-
* <ul>
449-
* <li>
450-
* <p>
451-
* <a>CreateChatToken</a> — Creates an encrypted token that is used by a chat participant to establish an
452-
* individual WebSocket chat connection to a room. When the token is used to connect to chat,
453-
* the connection is valid for the session duration specified in the request. The token
454-
* becomes invalid at the token-expiration timestamp included in the response.</p>
455-
* </li>
456-
* </ul>
457-
* <p>
458-
* <b>Room Endpoints</b>
459-
* </p>
460-
* <ul>
461-
* <li>
462-
* <p>
463-
* <a>CreateRoom</a> — Creates a room that allows clients to connect and
464-
* pass messages.</p>
465-
* </li>
466-
* <li>
467-
* <p>
468-
* <a>DeleteRoom</a> — Deletes the specified room.</p>
469-
* </li>
470-
* <li>
471-
* <p>
472-
* <a>GetRoom</a> — Gets the specified room.</p>
473-
* </li>
474-
* <li>
475-
* <p>
476-
* <a>ListRooms</a> — Gets summary information about all your rooms in
477-
* the AWS region where the API request is processed. </p>
478-
* </li>
479-
* <li>
480-
* <p>
481-
* <a>UpdateRoom</a> — Updates a room’s configuration.</p>
482-
* </li>
483-
* </ul>
484-
* <p>
485-
* <b>Logging Configuration Endpoints</b>
486-
* </p>
487-
* <ul>
488-
* <li>
489-
* <p>
490-
* <a>CreateLoggingConfiguration</a> — Creates a logging configuration that allows clients to store and record sent messages.</p>
491-
* </li>
492-
* <li>
493-
* <p>
494-
* <a>DeleteLoggingConfiguration</a> — Deletes the specified logging
495-
* configuration.</p>
496-
* </li>
497-
* <li>
498-
* <p>
499-
* <a>GetLoggingConfiguration</a> — Gets the specified logging
500-
* configuration.</p>
501-
* </li>
502-
* <li>
503-
* <p>
504-
* <a>ListLoggingConfigurations</a> — Gets summary information about all
505-
* your logging configurations in the AWS region where the API request is processed.</p>
506-
* </li>
507-
* <li>
508-
* <p>
509-
* <a>UpdateLoggingConfiguration</a> — Updates a specified logging configuration.</p>
510-
* </li>
511-
* </ul>
512-
* <p>
513-
* <b>Tags Endpoints</b>
514-
* </p>
515-
* <ul>
516-
* <li>
517-
* <p>
518-
* <a>ListTagsForResource</a> — Gets information about AWS tags for the
519-
* specified ARN.</p>
520-
* </li>
521-
* <li>
522-
* <p>
523-
* <a>TagResource</a> — Adds or updates tags for the AWS resource with
524-
* the specified ARN.</p>
525-
* </li>
526-
* <li>
527-
* <p>
528-
* <a>UntagResource</a> — Removes tags from the resource with the
529-
* specified ARN.</p>
530-
* </li>
531-
* </ul>
532-
* <p>All the above are HTTP operations. There is a separate <i>messaging</i> API
533-
* for managing Chat resources; see the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/chat-messaging-api.html"> Amazon IVS Chat Messaging API
534-
* Reference</a>.</p>
535426
* @public
536427
*/
537428
export class Ivschat extends IvschatClient implements Ivschat {}

0 commit comments

Comments
 (0)