From 31ee1f55e6f443bb46b8449211edb096db2202b3 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 13 Sep 2023 18:15:02 +0000 Subject: [PATCH] docs(client-ivs-realtime): Doc only update that changes description for ParticipantToken. --- .../src/models/models_0.ts | 21 +++++++++++-------- .../sdk-codegen/aws-models/ivs-realtime.json | 8 +++---- 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/clients/client-ivs-realtime/src/models/models_0.ts b/clients/client-ivs-realtime/src/models/models_0.ts index 3b03e753d562..92d7ea04537c 100644 --- a/clients/client-ivs-realtime/src/models/models_0.ts +++ b/clients/client-ivs-realtime/src/models/models_0.ts @@ -89,6 +89,9 @@ export interface CreateParticipantTokenRequest { /** * @public *

Object specifying a participant token in a stage.

+ *

+ * Important: Treat tokens as opaque; i.e., do not build functionality + * based on token contents. The format of tokens could change in the future.

*/ export interface ParticipantToken { /** @@ -124,7 +127,8 @@ export interface ParticipantToken { /** * @public - *

Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

+ *

Duration (in minutes), after which the participant token expires. Default: 720 (12 + * hours).

*/ duration?: number; @@ -728,14 +732,13 @@ export interface Event { * @public *

If the event is an error event, the error code is provided to give insight into the * specific error that occurred. If the event is not an error event, this field is null. - * INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the - * participant’s token is not allowed to do. For more information about participant - * capabilities, see the capabilities field in CreateParticipantToken. - * QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a - * stage exceeds the quota; for more information, see Service Quotas. - * PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher - * that doesn’t exist. - *

+ * INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an + * action that the participant’s token is not allowed to do. For more information about + * participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the + * number of participants who want to publish/subscribe to a stage exceeds the quota; for more + * information, see Service Quotas. + * PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a + * publisher that doesn’t exist.

*/ errorCode?: EventErrorCode | string; } diff --git a/codegen/sdk-codegen/aws-models/ivs-realtime.json b/codegen/sdk-codegen/aws-models/ivs-realtime.json index 8958cfdbdd9b..f6b04d00035e 100644 --- a/codegen/sdk-codegen/aws-models/ivs-realtime.json +++ b/codegen/sdk-codegen/aws-models/ivs-realtime.json @@ -1080,7 +1080,7 @@ "errorCode": { "target": "com.amazonaws.ivsrealtime#EventErrorCode", "traits": { - "smithy.api#documentation": "

If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the\n participant’s token is not allowed to do. For more information about participant\n capabilities, see the capabilities field in CreateParticipantToken. \n\t\t QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a \n\t\t stage exceeds the quota; for more information, see Service Quotas.\n\t\t PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher\n\t\t that doesn’t exist. \n

" + "smithy.api#documentation": "

If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an\n action that the participant’s token is not allowed to do. For more information about\n participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see Service Quotas.\n PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a\n publisher that doesn’t exist.

" } } }, @@ -1955,7 +1955,7 @@ "target": "com.amazonaws.ivsrealtime#ParticipantTokenDurationMinutes", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

" + "smithy.api#documentation": "

Duration (in minutes), after which the participant token expires. Default: 720 (12\n hours).

" } }, "capabilities": { @@ -1972,7 +1972,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object specifying a participant token in a stage.

" + "smithy.api#documentation": "

Object specifying a participant token in a stage.

\n

\n Important: Treat tokens as opaque; i.e., do not build functionality\n based on token contents. The format of tokens could change in the future.

" } }, "com.amazonaws.ivsrealtime#ParticipantTokenAttributes": { @@ -2568,4 +2568,4 @@ "type": "string" } } -} \ No newline at end of file +}