@aws-sdk/client-ivs-realtime 3.1135.0 → 3.1137.0

package/dist-types/commands/StartParticipantReplicationCommand.d.ts

@@ -63,25 +63,25 @@ declare const StartParticipantReplicationCommand_base: {
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p/>
+ *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p/>
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p/>
+ *  <p>Unexpected error during processing of request.</p>
  *
  * @throws {@link PendingVerification} (client fault)
- *  <p/>
+ *  <p>Your account is pending verification.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p/>
+ *  <p>Request references a resource which does not exist.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p/>
+ *  <p>Request would cause a service quota to be exceeded.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p/>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link IVSRealTimeServiceException}
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>

package/dist-types/commands/StopCompositionCommand.d.ts

@@ -24,8 +24,7 @@ declare const StopCompositionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * <p>Stops and deletes a Composition resource. Any broadcast from the Composition resource
- *          is stopped.</p>
+ * <p>Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -50,22 +49,22 @@ declare const StopCompositionCommand_base: {
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p/>
+ *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p/>
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p/>
+ *  <p>Unexpected error during processing of request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p/>
+ *  <p>Request references a resource which does not exist.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p/>
+ *  <p>Request would cause a service quota to be exceeded.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p/>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link IVSRealTimeServiceException}
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>

package/dist-types/commands/StopParticipantReplicationCommand.d.ts

@@ -59,16 +59,16 @@ declare const StopParticipantReplicationCommand_base: {
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p/>
+ *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p/>
+ *  <p>Unexpected error during processing of request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p/>
+ *  <p>Request references a resource which does not exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p/>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link IVSRealTimeServiceException}
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>

package/dist-types/commands/TagResourceCommand.d.ts

@@ -52,13 +52,13 @@ declare const TagResourceCommand_base: {
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p/>
+ *  <p>Unexpected error during processing of request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p/>
+ *  <p>Request references a resource which does not exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p/>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link IVSRealTimeServiceException}
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -52,13 +52,13 @@ declare const UntagResourceCommand_base: {
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p/>
+ *  <p>Unexpected error during processing of request.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p/>
+ *  <p>Request references a resource which does not exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p/>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link IVSRealTimeServiceException}
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>

package/dist-types/commands/UpdateIngestConfigurationCommand.d.ts

@@ -41,6 +41,13 @@ declare const UpdateIngestConfigurationCommand_base: {
  * const command = new UpdateIngestConfigurationCommand(input);
  * const response = await client.send(command);
  * // { // UpdateIngestConfigurationResponse
+ * //   accessControlAllowOrigin: "STRING_VALUE",
+ * //   accessControlExposeHeaders: "STRING_VALUE",
+ * //   cacheControl: "STRING_VALUE",
+ * //   contentSecurityPolicy: "STRING_VALUE",
+ * //   strictTransportSecurity: "STRING_VALUE",
+ * //   xContentTypeOptions: "STRING_VALUE",
+ * //   xFrameOptions: "STRING_VALUE",
  * //   ingestConfiguration: { // IngestConfiguration
  * //     name: "STRING_VALUE",
  * //     arn: "STRING_VALUE", // required
@@ -75,19 +82,19 @@ declare const UpdateIngestConfigurationCommand_base: {
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p/>
+ *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p/>
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
  *
  * @throws {@link PendingVerification} (client fault)
- *  <p/>
+ *  <p>Your account is pending verification.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p/>
+ *  <p>Request references a resource which does not exist.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p/>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link IVSRealTimeServiceException}
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>

package/dist-types/commands/UpdateStageCommand.d.ts

@@ -101,22 +101,22 @@ declare const UpdateStageCommand_base: {
  * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p/>
+ *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p/>
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
  *
  * @throws {@link PendingVerification} (client fault)
- *  <p/>
+ *  <p>Your account is pending verification.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
- *  <p/>
+ *  <p>Request references a resource which does not exist.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p/>
+ *  <p>Request would cause a service quota to be exceeded.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p/>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link IVSRealTimeServiceException}
  * <p>Base exception class for all service exceptions from IVSRealTime service.</p>

package/dist-types/index.d.ts

@@ -1,82 +1,5 @@
 /**
- * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP
- * 	  API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses,
- * 	  including errors.
- *     </p>
- *          <p>
- *             <b>Key Concepts</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <b>Stage</b> — A virtual space where participants can exchange video in real time.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <b>Participant object</b> — Represents participants (people) in the stage and
- *             contains information about them. When a token is created, it includes a participant ID;
- *             when a participant uses that token to join a stage, the participant is associated with
- *             that participant ID. There is a 1:1 mapping between participant tokens and
- *             participants.</p>
- *             </li>
- *          </ul>
- *          <p>For server-side composition:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <b>Composition process</b> — Composites participants
- *             of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels).
- *             Composition operations support this process.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <b>Composition</b> — Controls the look of the outputs,
- *             including how participants are positioned in the video.</p>
- *             </li>
- *          </ul>
- *          <p>For participant replication:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for
- * 			replication.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <b>Destination stage</b> — The stage to which the participant is replicated.
- * 				</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages.
- * 				</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage
- * 			(the source stage).</p>
- *             </li>
- *          </ul>
- *          <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p>
- *          <p>
- *             <b>Tagging</b>
- *          </p>
- *          <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
- *       comprises a <i>key</i> and a <i>value</i>, both set by you. For
- *       example, you might set a tag as <code>topic:nature</code> to label a particular video
- *       category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a>
- *       in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
- *       limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p>
- *          <p>Tags can help you identify and organize your AWS resources. For example, you can use the
- *       same tag for different resources to indicate that they are related. You can also use tags to
- *       manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p>
- *          <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and
- *       <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p>
- *          <p>At most 50 tags can be applied to a resource.</p>
+ * <p>The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. </p> <p> <b>Key Concepts</b> </p> <ul> <li> <p> <b>Stage</b> — A virtual space where participants can exchange video in real time.</p> </li> <li> <p> <b>Participant token</b> — A token that authenticates a participant when they join a stage.</p> </li> <li> <p> <b>Participant object</b> — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.</p> </li> </ul> <p>For server-side composition:</p> <ul> <li> <p> <b>Composition process</b> — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.</p> </li> <li> <p> <b>Composition</b> — Controls the look of the outputs, including how participants are positioned in the video.</p> </li> </ul> <p>For participant replication:</p> <ul> <li> <p> <b>Source stage</b> — The stage where the participant originally joined, which is used as the source for replication.</p> </li> <li> <p> <b>Destination stage</b> — The stage to which the participant is replicated. </p> </li> <li> <p> <b>Replicated participant</b> — A participant in a stage that is replicated to one or more destination stages. </p> </li> <li> <p> <b>Replica participant</b> — A participant in a destination stage that is replicated from another stage (the source stage).</p> </li> </ul> <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html">Getting Started with Amazon IVS Real-Time Streaming</a>.</p> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.</p> <p>Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Access Tags</a>).</p> <p>The Amazon IVS real-time API has these tag-related operations: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resource supports tagging: Stage.</p> <p>At most 50 tags can be applied to a resource.</p>
  *
  * @packageDocumentation
  */

package/dist-types/models/errors.d.ts

@@ -1,7 +1,7 @@
 import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
 import { IVSRealTimeServiceException as __BaseException } from "./IVSRealTimeServiceException";
 /**
- * <p/>
+ * <p>User does not have sufficient access to perform this action.</p>
  * @public
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -58,7 +58,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
- * <p/>
+ * <p>Updating or deleting a resource can cause an inconsistent state.</p>
  * @public
  */
 export declare class ConflictException extends __BaseException {
@@ -115,7 +115,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
- * <p/>
+ * <p>Unexpected error during processing of request.</p>
  * @public
  */
 export declare class InternalServerException extends __BaseException {
@@ -172,7 +172,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
- * <p/>
+ * <p>Your account is pending verification.</p>
  * @public
  */
 export declare class PendingVerification extends __BaseException {
@@ -229,7 +229,7 @@ export declare class PendingVerification extends __BaseException {
     constructor(opts: __ExceptionOptionType<PendingVerification, __BaseException>);
 }
 /**
- * <p/>
+ * <p>Request references a resource which does not exist.</p>
  * @public
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -286,7 +286,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
- * <p/>
+ * <p>Request would cause a service quota to be exceeded.</p>
  * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -343,7 +343,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
- * <p/>
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  * @public
  */
 export declare class ValidationException extends __BaseException {