Skip to content

Commit 3cf49fb

Browse files
author
awstools
committed
docs(client-ivschat): Documentation Change for IVS Chat API Reference - Doc-only update to change text/description for tags field.
1 parent 9a021ff commit 3cf49fb

File tree

5 files changed

+77
-20
lines changed

5 files changed

+77
-20
lines changed

‎clients/client-ivschat/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,21 @@ information.</p>
4444
</li>
4545
</ul>
4646
<p>
47+
<b>Tagging</b>
48+
</p>
49+
<p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
50+
comprises a <i>key</i> and a <i>value</i>, both set by you. For
51+
example, you might set a tag as <code>topic:nature</code> to label a particular video
52+
category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
53+
tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific
54+
constraints beyond what is documented there.</p>
55+
<p>Tags can help you identify and organize your AWS resources. For example, you can use the
56+
same tag for different resources to indicate that they are related. You can also use tags to
57+
manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
58+
<p>The Amazon IVS Chat API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
59+
<a>ListTagsForResource</a>. The following resource supports tagging: Room.</p>
60+
<p>At most 50 tags can be applied to a resource.</p>
61+
<p>
4762
<b>API Access Security</b>
4863
</p>
4964
<p>Your Amazon IVS Chat applications (service applications and clients) must be authenticated

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,21 @@ import { IvschatClient } from "./IvschatClient";
7171
* </li>
7272
* </ul>
7373
* <p>
74+
* <b>Tagging</b>
75+
* </p>
76+
* <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
77+
* comprises a <i>key</i> and a <i>value</i>, both set by you. For
78+
* example, you might set a tag as <code>topic:nature</code> to label a particular video
79+
* category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
80+
* tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific
81+
* constraints beyond what is documented there.</p>
82+
* <p>Tags can help you identify and organize your AWS resources. For example, you can use the
83+
* same tag for different resources to indicate that they are related. You can also use tags to
84+
* manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
85+
* <p>The Amazon IVS Chat API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
86+
* <a>ListTagsForResource</a>. The following resource supports tagging: Room.</p>
87+
* <p>At most 50 tags can be applied to a resource.</p>
88+
* <p>
7489
* <b>API Access Security</b>
7590
* </p>
7691
* <p>Your Amazon IVS Chat applications (service applications and clients) must be authenticated

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,21 @@ export interface IvschatClientResolvedConfig extends IvschatClientResolvedConfig
287287
* </li>
288288
* </ul>
289289
* <p>
290+
* <b>Tagging</b>
291+
* </p>
292+
* <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
293+
* comprises a <i>key</i> and a <i>value</i>, both set by you. For
294+
* example, you might set a tag as <code>topic:nature</code> to label a particular video
295+
* category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for more information, including restrictions that apply to
296+
* tags and "Tag naming limits and requirements"; Amazon IVS Chat has no service-specific
297+
* constraints beyond what is documented there.</p>
298+
* <p>Tags can help you identify and organize your AWS resources. For example, you can use the
299+
* same tag for different resources to indicate that they are related. You can also use tags to
300+
* manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
301+
* <p>The Amazon IVS Chat API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and
302+
* <a>ListTagsForResource</a>. The following resource supports tagging: Room.</p>
303+
* <p>At most 50 tags can be applied to a resource.</p>
304+
* <p>
290305
* <b>API Access Security</b>
291306
* </p>
292307
* <p>Your Amazon IVS Chat applications (service applications and clients) must be authenticated

‎clients/client-ivschat/src/models/models_0.ts

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,10 @@ export interface CreateRoomRequest {
267267

268268
/**
269269
* <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
270-
* (key:value)</code>. </p>
270+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
271+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
272+
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
273+
* there.</p>
271274
*/
272275
tags?: Record<string, string>;
273276
}
@@ -489,8 +492,8 @@ export interface GetRoomResponse {
489492
updateTime?: Date;
490493

491494
/**
492-
* <p>Maximum number of messages per second that can be sent to the room (by all clients). Default:
493-
* 10.</p>
495+
* <p>Maximum number of messages per second that can be sent to the room (by all clients).
496+
* Default: 10.</p>
494497
*/
495498
maximumMessageRatePerSecond?: number;
496499

@@ -574,7 +577,10 @@ export interface RoomSummary {
574577
updateTime?: Date;
575578

576579
/**
577-
* <p>Tags attached to the resource. </p>
580+
* <p>Tags attached to the resource. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
581+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
582+
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
583+
* there.</p>
578584
*/
579585
tags?: Record<string, string>;
580586
}
@@ -620,8 +626,7 @@ export interface ListTagsForResourceRequest {
620626

621627
export interface ListTagsForResourceResponse {
622628
/**
623-
* <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
624-
* (key:value)</code>.</p>
629+
* <p>Tags attached to the resource, from the request.</p>
625630
*/
626631
tags: Record<string, string> | undefined;
627632
}
@@ -660,7 +665,10 @@ export interface TagResourceRequest {
660665
resourceArn: string | undefined;
661666

662667
/**
663-
* <p>Array of tags to be added or updated.</p>
668+
* <p>Array of tags to be added or updated. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
669+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
670+
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
671+
* there.</p>
664672
*/
665673
tags: Record<string, string> | undefined;
666674
}
@@ -674,7 +682,10 @@ export interface UntagResourceRequest {
674682
resourceArn: string | undefined;
675683

676684
/**
677-
* <p>Array of tags to be removed.</p>
685+
* <p>Array of tags to be removed. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
686+
* Resources</a> for details, including restrictions that apply to tags and "Tag naming
687+
* limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented
688+
* there.</p>
678689
*/
679690
tagKeys: string[] | undefined;
680691
}
@@ -693,8 +704,8 @@ export interface UpdateRoomRequest {
693704
name?: string;
694705

695706
/**
696-
* <p>Maximum number of messages per second that can be sent to the room (by all clients). Default:
697-
* 10.</p>
707+
* <p>Maximum number of messages per second that can be sent to the room (by all clients).
708+
* Default: 10.</p>
698709
*/
699710
maximumMessageRatePerSecond?: number;
700711

@@ -743,7 +754,8 @@ export interface UpdateRoomResponse {
743754
updateTime?: Date;
744755

745756
/**
746-
* <p>Maximum number of messages per second that can be sent to the room (by all clients), from the request.</p>
757+
* <p>Maximum number of messages per second that can be sent to the room (by all clients),
758+
* from the request.</p>
747759
*/
748760
maximumMessageRatePerSecond?: number;
749761

0 commit comments

Comments
 (0)