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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { GetMeetingRequest, GetMeetingResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetMeetingCommand}.
8
10
  */
9
11
  export interface GetMeetingCommandInput extends GetMeetingRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetMeetingCommand}.
13
17
  */
14
18
  export interface GetMeetingCommandOutput extends GetMeetingResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see
18
23
  * <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
19
24
  * in the <i>Amazon Chime Developer Guide</i>.</p>
@@ -27,6 +32,8 @@ export interface GetMeetingCommandOutput extends GetMeetingResponse, __MetadataB
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetMeetingCommandInput - {@link GetMeetingCommandInput}
36
+ * @returns {@link GetMeetingCommandOutput}
30
37
  * @see {@link GetMeetingCommandInput} for command's `input` shape.
31
38
  * @see {@link GetMeetingCommandOutput} for command's `response` shape.
32
39
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetMeetingCommandOutput extends GetMeetingResponse, __MetadataB
57
64
  export declare class GetMeetingCommand extends $Command<GetMeetingCommandInput, GetMeetingCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
58
65
  readonly input: GetMeetingCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: GetMeetingCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMeetingCommandInput, GetMeetingCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { ListAttendeesRequest, ListAttendeesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAttendeesCommand}.
8
10
  */
9
11
  export interface ListAttendeesCommandInput extends ListAttendeesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAttendeesCommand}.
13
17
  */
14
18
  export interface ListAttendeesCommandOutput extends ListAttendeesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see
19
24
  * <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a>
@@ -29,6 +34,8 @@ export interface ListAttendeesCommandOutput extends ListAttendeesResponse, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param ListAttendeesCommandInput - {@link ListAttendeesCommandInput}
38
+ * @returns {@link ListAttendeesCommandOutput}
32
39
  * @see {@link ListAttendeesCommandInput} for command's `input` shape.
33
40
  * @see {@link ListAttendeesCommandOutput} for command's `response` shape.
34
41
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ListAttendeesCommandOutput extends ListAttendeesResponse, __Met
59
66
  export declare class ListAttendeesCommand extends $Command<ListAttendeesCommandInput, ListAttendeesCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
60
67
  readonly input: ListAttendeesCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: ListAttendeesCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAttendeesCommandInput, ListAttendeesCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of the tags available for the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -37,11 +44,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
37
44
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
38
45
  readonly input: ListTagsForResourceCommandInput;
39
46
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
47
+ /**
48
+ * @public
49
+ */
40
50
  constructor(input: ListTagsForResourceCommandInput);
41
51
  /**
42
52
  * @internal
43
53
  */
44
54
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
55
+ /**
56
+ * @internal
57
+ */
45
58
  private serialize;
59
+ /**
60
+ * @internal
61
+ */
46
62
  private deserialize;
47
63
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { StartMeetingTranscriptionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartMeetingTranscriptionCommand}.
8
10
  */
9
11
  export interface StartMeetingTranscriptionCommandInput extends StartMeetingTranscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartMeetingTranscriptionCommand}.
13
17
  */
14
18
  export interface StartMeetingTranscriptionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts transcription for the specified <code>meetingId</code>. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html">
18
23
  * Using Amazon Chime SDK live transcription
19
24
  * </a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
@@ -31,6 +36,8 @@ export interface StartMeetingTranscriptionCommandOutput extends __MetadataBearer
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param StartMeetingTranscriptionCommandInput - {@link StartMeetingTranscriptionCommandInput}
40
+ * @returns {@link StartMeetingTranscriptionCommandOutput}
34
41
  * @see {@link StartMeetingTranscriptionCommandInput} for command's `input` shape.
35
42
  * @see {@link StartMeetingTranscriptionCommandOutput} for command's `response` shape.
36
43
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -67,11 +74,20 @@ export interface StartMeetingTranscriptionCommandOutput extends __MetadataBearer
67
74
  export declare class StartMeetingTranscriptionCommand extends $Command<StartMeetingTranscriptionCommandInput, StartMeetingTranscriptionCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
68
75
  readonly input: StartMeetingTranscriptionCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: StartMeetingTranscriptionCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartMeetingTranscriptionCommandInput, StartMeetingTranscriptionCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { StopMeetingTranscriptionRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopMeetingTranscriptionCommand}.
8
10
  */
9
11
  export interface StopMeetingTranscriptionCommandInput extends StopMeetingTranscriptionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopMeetingTranscriptionCommand}.
13
17
  */
14
18
  export interface StopMeetingTranscriptionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stops transcription for the specified <code>meetingId</code>. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html">
18
23
  * Using Amazon Chime SDK live transcription
19
24
  * </a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
@@ -31,6 +36,8 @@ export interface StopMeetingTranscriptionCommandOutput extends __MetadataBearer
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param StopMeetingTranscriptionCommandInput - {@link StopMeetingTranscriptionCommandInput}
40
+ * @returns {@link StopMeetingTranscriptionCommandOutput}
34
41
  * @see {@link StopMeetingTranscriptionCommandInput} for command's `input` shape.
35
42
  * @see {@link StopMeetingTranscriptionCommandOutput} for command's `response` shape.
36
43
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -64,11 +71,20 @@ export interface StopMeetingTranscriptionCommandOutput extends __MetadataBearer
64
71
  export declare class StopMeetingTranscriptionCommand extends $Command<StopMeetingTranscriptionCommandInput, StopMeetingTranscriptionCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
65
72
  readonly input: StopMeetingTranscriptionCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: StopMeetingTranscriptionCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopMeetingTranscriptionCommandInput, StopMeetingTranscriptionCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The resource that supports tags.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
43
50
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
44
51
  readonly input: TagResourceCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: TagResourceCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you
18
23
  * attempt to remove tags from a resource that were already removed. Note the following:</p>
19
24
  * <ul>
@@ -46,6 +51,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
46
51
  * const response = await client.send(command);
47
52
  * ```
48
53
  *
54
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
55
+ * @returns {@link UntagResourceCommandOutput}
49
56
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
50
57
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
51
58
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
61
68
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
62
69
  readonly input: UntagResourceCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: UntagResourceCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMeetingsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMeetingsClient";
5
5
  import { UpdateAttendeeCapabilitiesRequest, UpdateAttendeeCapabilitiesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateAttendeeCapabilitiesCommand}.
8
10
  */
9
11
  export interface UpdateAttendeeCapabilitiesCommandInput extends UpdateAttendeeCapabilitiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateAttendeeCapabilitiesCommand}.
13
17
  */
14
18
  export interface UpdateAttendeeCapabilitiesCommandOutput extends UpdateAttendeeCapabilitiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The capabilties that you want to update.</p>
18
23
  * <note>
19
24
  * <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
@@ -45,6 +50,8 @@ export interface UpdateAttendeeCapabilitiesCommandOutput extends UpdateAttendeeC
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param UpdateAttendeeCapabilitiesCommandInput - {@link UpdateAttendeeCapabilitiesCommandInput}
54
+ * @returns {@link UpdateAttendeeCapabilitiesCommandOutput}
48
55
  * @see {@link UpdateAttendeeCapabilitiesCommandInput} for command's `input` shape.
49
56
  * @see {@link UpdateAttendeeCapabilitiesCommandOutput} for command's `response` shape.
50
57
  * @see {@link ChimeSDKMeetingsClientResolvedConfig | config} for ChimeSDKMeetingsClient's `config` shape.
@@ -72,11 +79,20 @@ export interface UpdateAttendeeCapabilitiesCommandOutput extends UpdateAttendeeC
72
79
  export declare class UpdateAttendeeCapabilitiesCommand extends $Command<UpdateAttendeeCapabilitiesCommandInput, UpdateAttendeeCapabilitiesCommandOutput, ChimeSDKMeetingsClientResolvedConfig> {
73
80
  readonly input: UpdateAttendeeCapabilitiesCommandInput;
74
81
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
82
+ /**
83
+ * @public
84
+ */
75
85
  constructor(input: UpdateAttendeeCapabilitiesCommandInput);
76
86
  /**
77
87
  * @internal
78
88
  */
79
89
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMeetingsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAttendeeCapabilitiesCommandInput, UpdateAttendeeCapabilitiesCommandOutput>;
90
+ /**
91
+ * @internal
92
+ */
80
93
  private serialize;
94
+ /**
95
+ * @internal
96
+ */
81
97
  private deserialize;
82
98
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ChimeSDKMeetings service.
4
6
  */
5
7
  export declare class ChimeSDKMeetingsServiceException extends __ServiceException {