Skip to content

Commit

Permalink
docs(client-ivs-realtime): Doc only update that changes description f…
Browse files Browse the repository at this point in the history 
…or ParticipantToken.
  • Loading branch information
awstools committed Sep 13, 2023
1 parent f212fe4 commit 31ee1f5
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 13 deletions.
21 changes: 12 additions & 9 deletions clients/client-ivs-realtime/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ export interface CreateParticipantTokenRequest {
/**
* @public
* <p>Object specifying a participant token in a stage.</p>
* <p>
* <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality
* based on token contents. The format of tokens could change in the future.</p>
*/
export interface ParticipantToken {
/**
Expand Down Expand Up @@ -124,7 +127,8 @@ export interface ParticipantToken {

/**
* @public
* <p>Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).</p>
* <p>Duration (in minutes), after which the participant token expires. Default: 720 (12
* hours).</p>
*/
duration?: number;

Expand Down Expand Up @@ -728,14 +732,13 @@ export interface Event {
* @public
* <p>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.
* <code>INSUFFICIENT_CAPABILITIES</code> 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 <code>capabilities</code> field in <a>CreateParticipantToken</a>.
* <code>QUOTA_EXCEEDED</code> indicates that the number of participants who want to publish/subscribe to a
* stage exceeds the quota; for more information, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">Service Quotas</a>.
* <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a publisher
* that doesn’t exist.
* </p>
* <code>INSUFFICIENT_CAPABILITIES</code> 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 <code>capabilities</code> field in <a>CreateParticipantToken</a>. <code>QUOTA_EXCEEDED</code> indicates that the
* number of participants who want to publish/subscribe to a stage exceeds the quota; for more
* information, see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html">Service Quotas</a>.
* <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a
* publisher that doesn’t exist. </p>
*/
errorCode?: EventErrorCode | string;
}
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/ivs-realtime.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1080,7 +1080,7 @@
"errorCode": {
"target": "com.amazonaws.ivsrealtime#EventErrorCode",
"traits": {
"smithy.api#documentation": "<p>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 <code>INSUFFICIENT_CAPABILITIES</code> 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 <code>capabilities</code> field in <a>CreateParticipantToken</a>. \n\t\t <code>QUOTA_EXCEEDED</code> indicates that the number of participants who want to publish/subscribe to a \n\t\t stage exceeds the quota; for more information, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html\">Service Quotas</a>.\n\t\t <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a publisher\n\t\t that doesn’t exist. \n</p>"
"smithy.api#documentation": "<p>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 <code>INSUFFICIENT_CAPABILITIES</code> 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 <code>capabilities</code> field in <a>CreateParticipantToken</a>. <code>QUOTA_EXCEEDED</code> indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/service-quotas.html\">Service Quotas</a>.\n <code>PUBLISHER_NOT_FOUND</code> indicates that the participant tried to subscribe to a\n publisher that doesn’t exist. </p>"
}
}
},
Expand Down Expand Up @@ -1955,7 +1955,7 @@
"target": "com.amazonaws.ivsrealtime#ParticipantTokenDurationMinutes",
"traits": {
"smithy.api#default": 0,
"smithy.api#documentation": "<p>Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).</p>"
"smithy.api#documentation": "<p>Duration (in minutes), after which the participant token expires. Default: 720 (12\n hours).</p>"
}
},
"capabilities": {
Expand All @@ -1972,7 +1972,7 @@
}
},
"traits": {
"smithy.api#documentation": "<p>Object specifying a participant token in a stage.</p>"
"smithy.api#documentation": "<p>Object specifying a participant token in a stage.</p>\n <p>\n <b>Important</b>: Treat tokens as opaque; i.e., do not build functionality\n based on token contents. The format of tokens could change in the future.</p>"
}
},
"com.amazonaws.ivsrealtime#ParticipantTokenAttributes": {
Expand Down Expand Up @@ -2568,4 +2568,4 @@
"type": "string"
}
}
}
}

0 comments on commit 31ee1f5

Please sign in to comment.