@aws-sdk/client-chime-sdk-meetings 3.295.0 → 3.297.0

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

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ChimeSDKMeetingsServiceException as __BaseException } from "./ChimeSDKMeetingsServiceException";
+/**
+ * @public
+ */
 export declare enum MediaCapabilities {
     NONE = "None",
     RECEIVE = "Receive",
@@ -7,6 +10,7 @@ export declare enum MediaCapabilities {
     SEND_RECEIVE = "SendReceive"
 }
 /**
+ * @public
  * <p>The media capabilities of an attendee: audio, video, or content. </p>
  *          <note>
  *             <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see
@@ -44,6 +48,7 @@ export interface AttendeeCapabilities {
     Content: MediaCapabilities | string | undefined;
 }
 /**
+ * @public
  * <p>An Amazon Chime SDK meeting attendee. Includes a unique
  *            <code>AttendeeId</code> and <code>JoinToken</code>. The
  *            <code>JoinToken</code>
@@ -60,7 +65,7 @@ export interface AttendeeCapabilities {
 export interface Attendee {
     /**
      * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
-     *          <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
+     *          <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
      *          </p>
      *          <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
      *             Case insensitive.</p>
@@ -100,6 +105,7 @@ export interface Attendee {
     Capabilities?: AttendeeCapabilities;
 }
 /**
+ * @public
  * <p>A structure that contains one or more attendee IDs.</p>
  */
 export interface AttendeeIdItem {
@@ -108,11 +114,15 @@ export interface AttendeeIdItem {
      */
     AttendeeId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum MeetingFeatureStatus {
     AVAILABLE = "AVAILABLE",
     UNAVAILABLE = "UNAVAILABLE"
 }
 /**
+ * @public
  * <p>An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus. </p>
  */
 export interface AudioFeatures {
@@ -122,6 +132,7 @@ export interface AudioFeatures {
     EchoReduction?: MeetingFeatureStatus | string;
 }
 /**
+ * @public
  * <p>The input parameters don't match the service's restrictions.</p>
  */
 export declare class BadRequestException extends __BaseException {
@@ -139,12 +150,13 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.</p>
  */
 export interface CreateAttendeeRequestItem {
     /**
      * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
-     *          <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
+     *          <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
      *          </p>
      *          <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
      *             Case insensitive.</p>
@@ -155,6 +167,9 @@ export interface CreateAttendeeRequestItem {
      */
     Capabilities?: AttendeeCapabilities;
 }
+/**
+ * @public
+ */
 export interface BatchCreateAttendeeRequest {
     /**
      * <p>The Amazon Chime SDK ID of the meeting to which you're adding attendees.</p>
@@ -166,12 +181,13 @@ export interface BatchCreateAttendeeRequest {
     Attendees: CreateAttendeeRequestItem[] | undefined;
 }
 /**
+ * @public
  * <p>The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.</p>
  */
 export interface CreateAttendeeError {
     /**
      * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
-     *          <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
+     *          <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
      *          </p>
      *          <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
      *             Case insensitive.</p>
@@ -186,6 +202,9 @@ export interface CreateAttendeeError {
      */
     ErrorMessage?: string;
 }
+/**
+ * @public
+ */
 export interface BatchCreateAttendeeResponse {
     /**
      * <p>The attendee information, including attendees' IDs and join tokens.</p>
@@ -197,6 +216,7 @@ export interface BatchCreateAttendeeResponse {
     Errors?: CreateAttendeeError[];
 }
 /**
+ * @public
  * <p>The client is permanently forbidden from making the request.</p>
  */
 export declare class ForbiddenException extends __BaseException {
@@ -214,6 +234,7 @@ export declare class ForbiddenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request exceeds the resource limit.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -231,6 +252,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>One or more of the resources in the request does not exist in the system.</p>
  */
 export declare class NotFoundException extends __BaseException {
@@ -248,6 +270,7 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service encountered an unexpected error.</p>
  */
 export declare class ServiceFailureException extends __BaseException {
@@ -265,6 +288,7 @@ export declare class ServiceFailureException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service is currently unavailable.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -286,6 +310,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>The number of customer requests exceeds the request rate limit.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -303,6 +328,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The user isn't authorized to request a resource.</p>
  */
 export declare class UnauthorizedException extends __BaseException {
@@ -320,6 +346,7 @@ export declare class UnauthorizedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was well-formed but was unable to be followed due to semantic errors.</p>
  */
 export declare class UnprocessableEntityException extends __BaseException {
@@ -336,6 +363,9 @@ export declare class UnprocessableEntityException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<UnprocessableEntityException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface BatchUpdateAttendeeCapabilitiesExceptRequest {
     /**
      * <p>The ID of the meeting associated with the update request.</p>
@@ -351,6 +381,7 @@ export interface BatchUpdateAttendeeCapabilitiesExceptRequest {
     Capabilities: AttendeeCapabilities | undefined;
 }
 /**
+ * @public
  * <p>Multiple instances of the same request have been made simultaneously.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -367,6 +398,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateAttendeeRequest {
     /**
      * <p>The unique ID of the meeting.</p>
@@ -374,7 +408,7 @@ export interface CreateAttendeeRequest {
     MeetingId: string | undefined;
     /**
      * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
-     *          <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
+     *          <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
      *          </p>
      *          <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that
      *             uses this prefix.</p>
@@ -406,6 +440,9 @@ export interface CreateAttendeeRequest {
      */
     Capabilities?: AttendeeCapabilities;
 }
+/**
+ * @public
+ */
 export interface CreateAttendeeResponse {
     /**
      * <p>The attendee information, including attendee ID and join token.</p>
@@ -413,6 +450,7 @@ export interface CreateAttendeeResponse {
     Attendee?: Attendee;
 }
 /**
+ * @public
  * <p>The configuration settings of the features available to a meeting.</p>
  */
 export interface MeetingFeaturesConfiguration {
@@ -422,6 +460,7 @@ export interface MeetingFeaturesConfiguration {
     Audio?: AudioFeatures;
 }
 /**
+ * @public
  * <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
  */
 export interface NotificationsConfiguration {
@@ -439,6 +478,7 @@ export interface NotificationsConfiguration {
     SqsQueueArn?: string;
 }
 /**
+ * @public
  * <p>A key-value pair that you define.</p>
  */
 export interface Tag {
@@ -451,6 +491,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateMeetingRequest {
     /**
      * <p>The unique identifier for the client request. Use a different token for different meetings.</p>
@@ -488,7 +531,7 @@ export interface CreateMeetingRequest {
     MeetingHostId?: string;
     /**
      * <p>The external meeting ID.</p>
-     *          <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
+     *          <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
      *          </p>
      *          <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
      *            Case insensitive.</p>
@@ -553,6 +596,7 @@ export interface CreateMeetingRequest {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>
  */
 export interface MediaPlacement {
@@ -590,6 +634,7 @@ export interface MediaPlacement {
     EventIngestionUrl?: string;
 }
 /**
+ * @public
  * <p>A meeting created using the Amazon Chime SDK.</p>
  */
 export interface Meeting {
@@ -603,7 +648,7 @@ export interface Meeting {
     MeetingHostId?: string;
     /**
      * <p>The external meeting ID.</p>
-     *          <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
+     *          <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
      *          </p>
      *          <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
      *             Case insensitive.</p>
@@ -640,6 +685,9 @@ export interface Meeting {
      */
     MeetingArn?: string;
 }
+/**
+ * @public
+ */
 export interface CreateMeetingResponse {
     /**
      * <p>The meeting information, including the meeting ID and
@@ -647,6 +695,9 @@ export interface CreateMeetingResponse {
      */
     Meeting?: Meeting;
 }
+/**
+ * @public
+ */
 export interface CreateMeetingWithAttendeesRequest {
     /**
      * <p>The unique identifier for the client request. Use a different token for different meetings.</p>
@@ -684,7 +735,7 @@ export interface CreateMeetingWithAttendeesRequest {
     MeetingHostId?: string;
     /**
      * <p>The external meeting ID.</p>
-     *          <p>Pattern: <code>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
+     *          <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
      *          </p>
      *          <p>Values that begin with <code>aws:</code> are reserved. You can't configure a value that uses this prefix.
      *            Case insensitive.</p>
@@ -715,6 +766,9 @@ export interface CreateMeetingWithAttendeesRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateMeetingWithAttendeesResponse {
     /**
      * <p>The meeting information, including the meeting ID and
@@ -730,6 +784,9 @@ export interface CreateMeetingWithAttendeesResponse {
      */
     Errors?: CreateAttendeeError[];
 }
+/**
+ * @public
+ */
 export interface DeleteAttendeeRequest {
     /**
      * <p>The Amazon Chime SDK meeting ID.</p>
@@ -740,12 +797,18 @@ export interface DeleteAttendeeRequest {
      */
     AttendeeId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteMeetingRequest {
     /**
      * <p>The Amazon Chime SDK meeting ID.</p>
      */
     MeetingId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetAttendeeRequest {
     /**
      * <p>The Amazon Chime SDK meeting ID.</p>
@@ -756,24 +819,36 @@ export interface GetAttendeeRequest {
      */
     AttendeeId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetAttendeeResponse {
     /**
      * <p>The Amazon Chime SDK attendee information.</p>
      */
     Attendee?: Attendee;
 }
+/**
+ * @public
+ */
 export interface GetMeetingRequest {
     /**
      * <p>The Amazon Chime SDK meeting ID.</p>
      */
     MeetingId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetMeetingResponse {
     /**
      * <p>The Amazon Chime SDK meeting information.</p>
      */
     Meeting?: Meeting;
 }
+/**
+ * @public
+ */
 export interface ListAttendeesRequest {
     /**
      * <p>The Amazon Chime SDK meeting ID.</p>
@@ -788,6 +863,9 @@ export interface ListAttendeesRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListAttendeesResponse {
     /**
      * <p>The Amazon Chime SDK attendee information.</p>
@@ -798,12 +876,18 @@ export interface ListAttendeesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the resource.</p>
      */
     ResourceARN: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tags requested for the specified resource.</p>
@@ -811,6 +895,7 @@ export interface ListTagsForResourceResponse {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>The resource that you want to tag couldn't be found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -831,12 +916,21 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum TranscribeMedicalContentIdentificationType {
     PHI = "PHI"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeMedicalLanguageCode {
     EN_US = "en-US"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeMedicalRegion {
     AP_SOUTHEAST_2 = "ap-southeast-2",
     AUTO = "auto",
@@ -846,6 +940,9 @@ export declare enum TranscribeMedicalRegion {
     US_EAST_2 = "us-east-2",
     US_WEST_2 = "us-west-2"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeMedicalSpecialty {
     CARDIOLOGY = "CARDIOLOGY",
     NEUROLOGY = "NEUROLOGY",
@@ -854,11 +951,15 @@ export declare enum TranscribeMedicalSpecialty {
     RADIOLOGY = "RADIOLOGY",
     UROLOGY = "UROLOGY"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeMedicalType {
     CONVERSATION = "CONVERSATION",
     DICTATION = "DICTATION"
 }
 /**
+ * @public
  * <p>Settings specific to the Amazon Transcribe Medical engine.</p>
  */
 export interface EngineTranscribeMedicalSettings {
@@ -887,12 +988,21 @@ export interface EngineTranscribeMedicalSettings {
      */
     ContentIdentificationType?: TranscribeMedicalContentIdentificationType | string;
 }
+/**
+ * @public
+ */
 export declare enum TranscribeContentIdentificationType {
     PII = "PII"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeContentRedactionType {
     PII = "PII"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeLanguageCode {
     DE_DE = "de-DE",
     EN_AU = "en-AU",
@@ -907,11 +1017,17 @@ export declare enum TranscribeLanguageCode {
     PT_BR = "pt-BR",
     ZH_CN = "zh-CN"
 }
+/**
+ * @public
+ */
 export declare enum TranscribePartialResultsStability {
     HIGH = "high",
     LOW = "low",
     MEDIUM = "medium"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeRegion {
     AP_NORTHEAST_1 = "ap-northeast-1",
     AP_NORTHEAST_2 = "ap-northeast-2",
@@ -927,12 +1043,16 @@ export declare enum TranscribeRegion {
     US_GOV_WEST_1 = "us-gov-west-1",
     US_WEST_2 = "us-west-2"
 }
+/**
+ * @public
+ */
 export declare enum TranscribeVocabularyFilterMethod {
     MASK = "mask",
     REMOVE = "remove",
     TAG = "tag"
 }
 /**
+ * @public
  * <p>Settings specific to the Amazon Transcribe engine.</p>
  */
 export interface EngineTranscribeSettings {
@@ -1001,6 +1121,7 @@ export interface EngineTranscribeSettings {
     PreferredLanguage?: TranscribeLanguageCode | string;
 }
 /**
+ * @public
  * <p>The configuration for the current transcription operation. Must contain <code>EngineTranscribeSettings</code> or <code>EngineTranscribeMedicalSettings</code>.</p>
  */
 export interface TranscriptionConfiguration {
@@ -1013,6 +1134,9 @@ export interface TranscriptionConfiguration {
      */
     EngineTranscribeMedicalSettings?: EngineTranscribeMedicalSettings;
 }
+/**
+ * @public
+ */
 export interface StartMeetingTranscriptionRequest {
     /**
      * <p>The unique ID of the meeting being transcribed.</p>
@@ -1024,12 +1148,18 @@ export interface StartMeetingTranscriptionRequest {
      */
     TranscriptionConfiguration: TranscriptionConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export interface StopMeetingTranscriptionRequest {
     /**
      * <p>The unique ID of the meeting for which you stop transcription.</p>
      */
     MeetingId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the resource.</p>
@@ -1040,9 +1170,13 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
 /**
+ * @public
  * <p>Too many tags were added to the specified resource.</p>
  */
 export declare class TooManyTagsException extends __BaseException {
@@ -1063,6 +1197,9 @@ export declare class TooManyTagsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the resource that you're removing tags from.</p>
@@ -1073,8 +1210,14 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateAttendeeCapabilitiesRequest {
     /**
      * <p>The ID of the meeting associated with the update request.</p>
@@ -1089,6 +1232,9 @@ export interface UpdateAttendeeCapabilitiesRequest {
      */
     Capabilities: AttendeeCapabilities | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAttendeeCapabilitiesResponse {
     /**
      * <p>The updated attendee data.</p>

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

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

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListAttendeesCommandInput, ListAttendeesCommandOutput } from "../commands/ListAttendeesCommand";
 import { ChimeSDKMeetingsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListAttendees(config: ChimeSDKMeetingsPaginationConfiguration, input: ListAttendeesCommandInput, ...additionalArguments: any): Paginator<ListAttendeesCommandOutput>;