@aws-sdk/client-ivschat 3.296.0 → 3.298.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { IvschatServiceException as __BaseException } from "./IvschatServiceException";
 /**
+ * @public
  * <p/>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -11,11 +12,17 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ChatTokenCapability {
     DELETE_MESSAGE = "DELETE_MESSAGE",
     DISCONNECT_USER = "DISCONNECT_USER",
     SEND_MESSAGE = "SEND_MESSAGE"
 }
+/**
+ * @public
+ */
 export interface CreateChatTokenRequest {
     /**
      * <p>Identifier of the room that the client is trying to access. Currently this must be an
@@ -44,6 +51,9 @@ export interface CreateChatTokenRequest {
      */
     attributes?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface CreateChatTokenResponse {
     /**
      * <p>The issued client token, encrypted.</p>
@@ -62,6 +72,7 @@ export interface CreateChatTokenResponse {
     sessionExpirationTime?: Date;
 }
 /**
+ * @public
  * <p/>
  */
 export declare class PendingVerification extends __BaseException {
@@ -72,10 +83,14 @@ export declare class PendingVerification extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<PendingVerification, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ResourceType {
     ROOM = "ROOM"
 }
 /**
+ * @public
  * <p/>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -95,6 +110,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>This object is used in the ValidationException error.</p>
  */
 export interface ValidationExceptionField {
@@ -107,12 +123,16 @@ export interface ValidationExceptionField {
      */
     message: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ValidationExceptionReason {
     FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
     OTHER = "OTHER",
     UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
 }
 /**
+ * @public
  * <p/>
  */
 export declare class ValidationException extends __BaseException {
@@ -132,6 +152,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p/>
  */
 export declare class ConflictException extends __BaseException {
@@ -151,6 +172,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>Specifies a CloudWatch Logs location where chat logs will be stored.</p>
  */
 export interface CloudWatchLogsDestinationConfiguration {
@@ -160,6 +182,7 @@ export interface CloudWatchLogsDestinationConfiguration {
     logGroupName: string | undefined;
 }
 /**
+ * @public
  * <p>Specifies a Kinesis Firehose location where chat logs will be stored.</p>
  */
 export interface FirehoseDestinationConfiguration {
@@ -170,6 +193,7 @@ export interface FirehoseDestinationConfiguration {
     deliveryStreamName: string | undefined;
 }
 /**
+ * @public
  * <p>Specifies an S3 location where chat logs will be stored.</p>
  */
 export interface S3DestinationConfiguration {
@@ -179,11 +203,15 @@ export interface S3DestinationConfiguration {
     bucketName: string | undefined;
 }
 /**
+ * @public
  * <p>A complex type that describes a location where chat logs will be stored. Each member
  *       represents the configuration of one log destination. For logging, you define only one type of
  *       destination (for CloudWatch Logs, Kinesis Firehose, or S3).</p>
  */
 export type DestinationConfiguration = DestinationConfiguration.CloudWatchLogsMember | DestinationConfiguration.FirehoseMember | DestinationConfiguration.S3Member | DestinationConfiguration.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace DestinationConfiguration {
     /**
      * <p>An Amazon S3 destination configuration where chat activity will be logged.</p>
@@ -228,6 +256,9 @@ export declare namespace DestinationConfiguration {
     }
     const visit: <T>(value: DestinationConfiguration, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
 export interface CreateLoggingConfigurationRequest {
     /**
      * <p>Logging-configuration name. The value does not need to be unique.</p>
@@ -249,9 +280,15 @@ export interface CreateLoggingConfigurationRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum CreateLoggingConfigurationState {
     ACTIVE = "ACTIVE"
 }
+/**
+ * @public
+ */
 export interface CreateLoggingConfigurationResponse {
     /**
      * <p>Logging-configuration ARN, assigned by the system.</p>
@@ -295,6 +332,7 @@ export interface CreateLoggingConfigurationResponse {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p/>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -317,11 +355,15 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum FallbackResult {
     ALLOW = "ALLOW",
     DENY = "DENY"
 }
 /**
+ * @public
  * <p>Configuration information for optional message review.</p>
  */
 export interface MessageReviewHandler {
@@ -340,6 +382,9 @@ export interface MessageReviewHandler {
      */
     fallbackResult?: FallbackResult | string;
 }
+/**
+ * @public
+ */
 export interface CreateRoomRequest {
     /**
      * <p>Room name. The value does not need to be unique.</p>
@@ -373,6 +418,9 @@ export interface CreateRoomRequest {
      */
     loggingConfigurationIdentifiers?: string[];
 }
+/**
+ * @public
+ */
 export interface CreateRoomResponse {
     /**
      * <p>Room ARN, assigned by the system.</p>
@@ -421,12 +469,18 @@ export interface CreateRoomResponse {
      */
     loggingConfigurationIdentifiers?: string[];
 }
+/**
+ * @public
+ */
 export interface DeleteLoggingConfigurationRequest {
     /**
      * <p>Identifier of the logging configuration to be deleted.</p>
      */
     identifier: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteMessageRequest {
     /**
      * <p>Identifier of the room where the message should be deleted. Currently this must be an
@@ -444,6 +498,9 @@ export interface DeleteMessageRequest {
      */
     reason?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteMessageResponse {
     /**
      * <p>Operation identifier, generated by Amazon IVS Chat.</p>
@@ -451,6 +508,7 @@ export interface DeleteMessageResponse {
     id?: string;
 }
 /**
+ * @public
  * <p/>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -473,12 +531,18 @@ export declare class ThrottlingException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteRoomRequest {
     /**
      * <p>Identifier of the room to be deleted. Currently this must be an ARN.</p>
      */
     identifier: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DisconnectUserRequest {
     /**
      * <p>Identifier of the room from which the user's clients should be disconnected. Currently
@@ -494,14 +558,23 @@ export interface DisconnectUserRequest {
      */
     reason?: string;
 }
+/**
+ * @public
+ */
 export interface DisconnectUserResponse {
 }
+/**
+ * @public
+ */
 export interface GetLoggingConfigurationRequest {
     /**
      * <p>Identifier of the logging configuration to be retrieved.</p>
      */
     identifier: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum LoggingConfigurationState {
     ACTIVE = "ACTIVE",
     CREATE_FAILED = "CREATE_FAILED",
@@ -511,6 +584,9 @@ export declare enum LoggingConfigurationState {
     UPDATE_FAILED = "UPDATE_FAILED",
     UPDATING = "UPDATING"
 }
+/**
+ * @public
+ */
 export interface GetLoggingConfigurationResponse {
     /**
      * <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
@@ -554,6 +630,9 @@ export interface GetLoggingConfigurationResponse {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface GetRoomRequest {
     /**
      * <p>Identifier of the room for which the configuration is to be retrieved. Currently this
@@ -561,6 +640,9 @@ export interface GetRoomRequest {
      */
     identifier: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetRoomResponse {
     /**
      * <p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>
@@ -610,6 +692,9 @@ export interface GetRoomResponse {
      */
     loggingConfigurationIdentifiers?: string[];
 }
+/**
+ * @public
+ */
 export interface ListLoggingConfigurationsRequest {
     /**
      * <p>The first logging configurations to retrieve. This is used for pagination; see the
@@ -622,6 +707,7 @@ export interface ListLoggingConfigurationsRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>Summary information about a logging configuration.</p>
  */
 export interface LoggingConfigurationSummary {
@@ -667,6 +753,9 @@ export interface LoggingConfigurationSummary {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface ListLoggingConfigurationsResponse {
     /**
      * <p>List of the matching logging configurations (summary information only). There is only
@@ -680,6 +769,9 @@ export interface ListLoggingConfigurationsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListRoomsRequest {
     /**
      * <p>Filters the list to match the specified room name.</p>
@@ -704,6 +796,7 @@ export interface ListRoomsRequest {
     loggingConfigurationIdentifier?: string;
 }
 /**
+ * @public
  * <p>Summary information about a room.</p>
  */
 export interface RoomSummary {
@@ -747,6 +840,9 @@ export interface RoomSummary {
      */
     loggingConfigurationIdentifiers?: string[];
 }
+/**
+ * @public
+ */
 export interface ListRoomsResponse {
     /**
      * <p>List of the matching rooms (summary information only).</p>
@@ -759,6 +855,7 @@ export interface ListRoomsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p/>
  */
 export declare class InternalServerException extends __BaseException {
@@ -769,12 +866,18 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
@@ -782,6 +885,9 @@ export interface ListTagsForResourceResponse {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface SendEventRequest {
     /**
      * <p>Identifier of the room to which the event will be sent. Currently this must be an
@@ -798,6 +904,9 @@ export interface SendEventRequest {
      */
     attributes?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface SendEventResponse {
     /**
      * <p>An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent
@@ -805,6 +914,9 @@ export interface SendEventResponse {
      */
     id?: string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>
@@ -819,8 +931,14 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>
@@ -835,8 +953,14 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateLoggingConfigurationRequest {
     /**
      * <p>Identifier of the logging configuration to be updated.</p>
@@ -854,9 +978,15 @@ export interface UpdateLoggingConfigurationRequest {
      */
     destinationConfiguration?: DestinationConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum UpdateLoggingConfigurationState {
     ACTIVE = "ACTIVE"
 }
+/**
+ * @public
+ */
 export interface UpdateLoggingConfigurationResponse {
     /**
      * <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
@@ -900,6 +1030,9 @@ export interface UpdateLoggingConfigurationResponse {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface UpdateRoomRequest {
     /**
      * <p>Identifier of the room to be updated. Currently this must be an ARN.</p>
@@ -931,6 +1064,9 @@ export interface UpdateRoomRequest {
      */
     loggingConfigurationIdentifiers?: string[];
 }
+/**
+ * @public
+ */
 export interface UpdateRoomResponse {
     /**
      * <p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>
@@ -980,163 +1116,3 @@ export interface UpdateRoomResponse {
      */
     loggingConfigurationIdentifiers?: string[];
 }
-/**
- * @internal
- */
-export declare const CreateChatTokenRequestFilterSensitiveLog: (obj: CreateChatTokenRequest) => any;
-/**
- * @internal
- */
-export declare const CreateChatTokenResponseFilterSensitiveLog: (obj: CreateChatTokenResponse) => any;
-/**
- * @internal
- */
-export declare const ValidationExceptionFieldFilterSensitiveLog: (obj: ValidationExceptionField) => any;
-/**
- * @internal
- */
-export declare const CloudWatchLogsDestinationConfigurationFilterSensitiveLog: (obj: CloudWatchLogsDestinationConfiguration) => any;
-/**
- * @internal
- */
-export declare const FirehoseDestinationConfigurationFilterSensitiveLog: (obj: FirehoseDestinationConfiguration) => any;
-/**
- * @internal
- */
-export declare const S3DestinationConfigurationFilterSensitiveLog: (obj: S3DestinationConfiguration) => any;
-/**
- * @internal
- */
-export declare const DestinationConfigurationFilterSensitiveLog: (obj: DestinationConfiguration) => any;
-/**
- * @internal
- */
-export declare const CreateLoggingConfigurationRequestFilterSensitiveLog: (obj: CreateLoggingConfigurationRequest) => any;
-/**
- * @internal
- */
-export declare const CreateLoggingConfigurationResponseFilterSensitiveLog: (obj: CreateLoggingConfigurationResponse) => any;
-/**
- * @internal
- */
-export declare const MessageReviewHandlerFilterSensitiveLog: (obj: MessageReviewHandler) => any;
-/**
- * @internal
- */
-export declare const CreateRoomRequestFilterSensitiveLog: (obj: CreateRoomRequest) => any;
-/**
- * @internal
- */
-export declare const CreateRoomResponseFilterSensitiveLog: (obj: CreateRoomResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteLoggingConfigurationRequestFilterSensitiveLog: (obj: DeleteLoggingConfigurationRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteMessageRequestFilterSensitiveLog: (obj: DeleteMessageRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteMessageResponseFilterSensitiveLog: (obj: DeleteMessageResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteRoomRequestFilterSensitiveLog: (obj: DeleteRoomRequest) => any;
-/**
- * @internal
- */
-export declare const DisconnectUserRequestFilterSensitiveLog: (obj: DisconnectUserRequest) => any;
-/**
- * @internal
- */
-export declare const DisconnectUserResponseFilterSensitiveLog: (obj: DisconnectUserResponse) => any;
-/**
- * @internal
- */
-export declare const GetLoggingConfigurationRequestFilterSensitiveLog: (obj: GetLoggingConfigurationRequest) => any;
-/**
- * @internal
- */
-export declare const GetLoggingConfigurationResponseFilterSensitiveLog: (obj: GetLoggingConfigurationResponse) => any;
-/**
- * @internal
- */
-export declare const GetRoomRequestFilterSensitiveLog: (obj: GetRoomRequest) => any;
-/**
- * @internal
- */
-export declare const GetRoomResponseFilterSensitiveLog: (obj: GetRoomResponse) => any;
-/**
- * @internal
- */
-export declare const ListLoggingConfigurationsRequestFilterSensitiveLog: (obj: ListLoggingConfigurationsRequest) => any;
-/**
- * @internal
- */
-export declare const LoggingConfigurationSummaryFilterSensitiveLog: (obj: LoggingConfigurationSummary) => any;
-/**
- * @internal
- */
-export declare const ListLoggingConfigurationsResponseFilterSensitiveLog: (obj: ListLoggingConfigurationsResponse) => any;
-/**
- * @internal
- */
-export declare const ListRoomsRequestFilterSensitiveLog: (obj: ListRoomsRequest) => any;
-/**
- * @internal
- */
-export declare const RoomSummaryFilterSensitiveLog: (obj: RoomSummary) => any;
-/**
- * @internal
- */
-export declare const ListRoomsResponseFilterSensitiveLog: (obj: ListRoomsResponse) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
-/**
- * @internal
- */
-export declare const SendEventRequestFilterSensitiveLog: (obj: SendEventRequest) => any;
-/**
- * @internal
- */
-export declare const SendEventResponseFilterSensitiveLog: (obj: SendEventResponse) => any;
-/**
- * @internal
- */
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateLoggingConfigurationRequestFilterSensitiveLog: (obj: UpdateLoggingConfigurationRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateLoggingConfigurationResponseFilterSensitiveLog: (obj: UpdateLoggingConfigurationResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateRoomRequestFilterSensitiveLog: (obj: UpdateRoomRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateRoomResponseFilterSensitiveLog: (obj: UpdateRoomResponse) => any;

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { IvschatClient } from "../IvschatClient";
+/**
+ * @public
+ */
 export interface IvschatPaginationConfiguration extends PaginationConfiguration {
     client: IvschatClient;
 }

package/dist-types/pagination/ListLoggingConfigurationsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListLoggingConfigurationsCommandInput, ListLoggingConfigurationsCommandOutput } from "../commands/ListLoggingConfigurationsCommand";
 import { IvschatPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListLoggingConfigurations(config: IvschatPaginationConfiguration, input: ListLoggingConfigurationsCommandInput, ...additionalArguments: any): Paginator<ListLoggingConfigurationsCommandOutput>;

package/dist-types/pagination/ListRoomsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListRoomsCommandInput, ListRoomsCommandOutput } from "../commands/ListRoomsCommand";
 import { IvschatPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListRooms(config: IvschatPaginationConfiguration, input: ListRoomsCommandInput, ...additionalArguments: any): Paginator<ListRoomsCommandOutput>;