@aws-sdk/client-chime-sdk-messaging 3.295.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.
Files changed (96) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/ChimeSDKMessaging.js +45 -0
  3. package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +46 -0
  4. package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +46 -0
  5. package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +3 -3
  8. package/dist-cjs/models/models_0.js +32 -3
  9. package/dist-cjs/protocols/Aws_restJson1.js +243 -2
  10. package/dist-es/ChimeSDKMessaging.js +45 -0
  11. package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +42 -0
  12. package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +42 -0
  13. package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +42 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/endpoint/ruleset.js +3 -3
  16. package/dist-es/models/models_0.js +23 -0
  17. package/dist-es/protocols/Aws_restJson1.js +235 -0
  18. package/dist-types/ChimeSDKMessaging.d.ts +76 -40
  19. package/dist-types/ChimeSDKMessagingClient.d.ts +29 -6
  20. package/dist-types/commands/AssociateChannelFlowCommand.d.ts +16 -1
  21. package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +16 -0
  22. package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
  23. package/dist-types/commands/CreateChannelBanCommand.d.ts +16 -1
  24. package/dist-types/commands/CreateChannelCommand.d.ts +16 -2
  25. package/dist-types/commands/CreateChannelFlowCommand.d.ts +17 -3
  26. package/dist-types/commands/CreateChannelMembershipCommand.d.ts +16 -4
  27. package/dist-types/commands/CreateChannelModeratorCommand.d.ts +16 -2
  28. package/dist-types/commands/DeleteChannelBanCommand.d.ts +16 -1
  29. package/dist-types/commands/DeleteChannelCommand.d.ts +16 -1
  30. package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
  31. package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -1
  32. package/dist-types/commands/DeleteChannelMessageCommand.d.ts +16 -1
  33. package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +16 -1
  34. package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +76 -0
  35. package/dist-types/commands/DescribeChannelBanCommand.d.ts +16 -2
  36. package/dist-types/commands/DescribeChannelCommand.d.ts +16 -2
  37. package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +16 -1
  40. package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +16 -1
  41. package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
  42. package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +16 -0
  43. package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +16 -0
  44. package/dist-types/commands/GetChannelMessageCommand.d.ts +16 -1
  45. package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +16 -3
  46. package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
  47. package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +82 -0
  48. package/dist-types/commands/ListChannelBansCommand.d.ts +16 -1
  49. package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListChannelMembershipsCommand.d.ts +16 -2
  51. package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +16 -1
  52. package/dist-types/commands/ListChannelMessagesCommand.d.ts +16 -0
  53. package/dist-types/commands/ListChannelModeratorsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
  55. package/dist-types/commands/ListChannelsCommand.d.ts +16 -2
  56. package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +16 -1
  57. package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  59. package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +16 -0
  60. package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +86 -0
  61. package/dist-types/commands/RedactChannelMessageCommand.d.ts +16 -1
  62. package/dist-types/commands/SearchChannelsCommand.d.ts +16 -0
  63. package/dist-types/commands/SendChannelMessageCommand.d.ts +16 -2
  64. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  66. package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
  67. package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
  68. package/dist-types/commands/UpdateChannelMessageCommand.d.ts +16 -1
  69. package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +16 -1
  70. package/dist-types/commands/index.d.ts +3 -0
  71. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  72. package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
  73. package/dist-types/models/models_0.d.ts +430 -0
  74. package/dist-types/pagination/Interfaces.d.ts +3 -0
  75. package/dist-types/pagination/ListChannelBansPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListChannelFlowsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListChannelMembershipsForAppInstanceUserPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListChannelMembershipsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListChannelMessagesPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListChannelModeratorsPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListChannelsAssociatedWithChannelFlowPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListChannelsModeratedByAppInstanceUserPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListSubChannelsPaginator.d.ts +3 -0
  85. package/dist-types/pagination/SearchChannelsPaginator.d.ts +3 -0
  86. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  87. package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +69 -0
  88. package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +18 -0
  89. package/dist-types/ts3.4/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +37 -0
  90. package/dist-types/ts3.4/commands/GetMessagingStreamingConfigurationsCommand.d.ts +41 -0
  91. package/dist-types/ts3.4/commands/PutMessagingStreamingConfigurationsCommand.d.ts +41 -0
  92. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  93. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  94. package/dist-types/ts3.4/models/models_0.d.ts +42 -0
  95. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  96. package/package.json +29 -29
@@ -4,19 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelCommand}.
8
10
  */
9
11
  export interface DeleteChannelCommandInput extends DeleteChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelCommand}.
13
17
  */
14
18
  export interface DeleteChannelCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Immediately makes a channel and its memberships inaccessible and marks them for
18
23
  * deletion. This is an irreversible process.</p>
19
- *
20
24
  * <note>
21
25
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
26
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -32,6 +36,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
32
36
  * const response = await client.send(command);
33
37
  * ```
34
38
  *
39
+ * @param DeleteChannelCommandInput - {@link DeleteChannelCommandInput}
40
+ * @returns {@link DeleteChannelCommandOutput}
35
41
  * @see {@link DeleteChannelCommandInput} for command's `input` shape.
36
42
  * @see {@link DeleteChannelCommandOutput} for command's `response` shape.
37
43
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -59,11 +65,20 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
59
65
  export declare class DeleteChannelCommand extends $Command<DeleteChannelCommandInput, DeleteChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
60
66
  readonly input: DeleteChannelCommandInput;
61
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
62
71
  constructor(input: DeleteChannelCommandInput);
63
72
  /**
64
73
  * @internal
65
74
  */
66
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelCommandInput, DeleteChannelCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
67
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
68
83
  private deserialize;
69
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelFlowRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelFlowCommand}.
8
10
  */
9
11
  export interface DeleteChannelFlowCommandInput extends DeleteChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelFlowCommand}.
13
17
  */
14
18
  export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a channel flow, an irreversible process. This is a developer API.</p>
18
23
  * <note>
19
24
  * <p> This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the
@@ -29,6 +34,8 @@ export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteChannelFlowCommandInput - {@link DeleteChannelFlowCommandInput}
38
+ * @returns {@link DeleteChannelFlowCommandOutput}
32
39
  * @see {@link DeleteChannelFlowCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteChannelFlowCommandOutput} for command's `response` shape.
34
41
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteChannelFlowCommandOutput extends __MetadataBearer {
60
67
  export declare class DeleteChannelFlowCommand extends $Command<DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
68
  readonly input: DeleteChannelFlowCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteChannelFlowCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,18 +4,22 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelMembershipRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelMembershipCommand}.
8
10
  */
9
11
  export interface DeleteChannelMembershipCommandInput extends DeleteChannelMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelMembershipCommand}.
13
17
  */
14
18
  export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a member from a channel.</p>
18
- *
19
23
  * <note>
20
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -31,6 +35,8 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
31
35
  * const response = await client.send(command);
32
36
  * ```
33
37
  *
38
+ * @param DeleteChannelMembershipCommandInput - {@link DeleteChannelMembershipCommandInput}
39
+ * @returns {@link DeleteChannelMembershipCommandOutput}
34
40
  * @see {@link DeleteChannelMembershipCommandInput} for command's `input` shape.
35
41
  * @see {@link DeleteChannelMembershipCommandOutput} for command's `response` shape.
36
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -62,11 +68,20 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer {
62
68
  export declare class DeleteChannelMembershipCommand extends $Command<DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
63
69
  readonly input: DeleteChannelMembershipCommandInput;
64
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
65
74
  constructor(input: DeleteChannelMembershipCommandInput);
66
75
  /**
67
76
  * @internal
68
77
  */
69
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
70
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
71
86
  private deserialize;
72
87
  }
@@ -4,20 +4,24 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelMessageRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelMessageCommand}.
8
10
  */
9
11
  export interface DeleteChannelMessageCommandInput extends DeleteChannelMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelMessageCommand}.
13
17
  */
14
18
  export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
18
23
  * inaccessible immediately. A background process deletes any revisions created by
19
24
  * <code>UpdateChannelMessage</code>.</p>
20
- *
21
25
  * <note>
22
26
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
23
27
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -33,6 +37,8 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
33
37
  * const response = await client.send(command);
34
38
  * ```
35
39
  *
40
+ * @param DeleteChannelMessageCommandInput - {@link DeleteChannelMessageCommandInput}
41
+ * @returns {@link DeleteChannelMessageCommandOutput}
36
42
  * @see {@link DeleteChannelMessageCommandInput} for command's `input` shape.
37
43
  * @see {@link DeleteChannelMessageCommandOutput} for command's `response` shape.
38
44
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -60,11 +66,20 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
60
66
  export declare class DeleteChannelMessageCommand extends $Command<DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
67
  readonly input: DeleteChannelMessageCommandInput;
62
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
63
72
  constructor(input: DeleteChannelMessageCommandInput);
64
73
  /**
65
74
  * @internal
66
75
  */
67
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
68
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
69
84
  private deserialize;
70
85
  }
@@ -4,18 +4,22 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelModeratorRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelModeratorCommand}.
8
10
  */
9
11
  export interface DeleteChannelModeratorCommandInput extends DeleteChannelModeratorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelModeratorCommand}.
13
17
  */
14
18
  export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a channel moderator.</p>
18
- *
19
23
  * <note>
20
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -31,6 +35,8 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
31
35
  * const response = await client.send(command);
32
36
  * ```
33
37
  *
38
+ * @param DeleteChannelModeratorCommandInput - {@link DeleteChannelModeratorCommandInput}
39
+ * @returns {@link DeleteChannelModeratorCommandOutput}
34
40
  * @see {@link DeleteChannelModeratorCommandInput} for command's `input` shape.
35
41
  * @see {@link DeleteChannelModeratorCommandOutput} for command's `response` shape.
36
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +64,20 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
58
64
  export declare class DeleteChannelModeratorCommand extends $Command<DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
59
65
  readonly input: DeleteChannelModeratorCommandInput;
60
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
61
70
  constructor(input: DeleteChannelModeratorCommandInput);
62
71
  /**
63
72
  * @internal
64
73
  */
65
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
66
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
67
82
  private deserialize;
68
83
  }
@@ -0,0 +1,76 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
+ import { DeleteMessagingStreamingConfigurationsRequest } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link DeleteMessagingStreamingConfigurationsCommand}.
10
+ */
11
+ export interface DeleteMessagingStreamingConfigurationsCommandInput extends DeleteMessagingStreamingConfigurationsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link DeleteMessagingStreamingConfigurationsCommand}.
17
+ */
18
+ export interface DeleteMessagingStreamingConfigurationsCommandOutput extends __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Deletes the streaming configurations for an <code>AppInstance</code>. For more information, see
23
+ * <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { ChimeSDKMessagingClient, DeleteMessagingStreamingConfigurationsCommand } from "@aws-sdk/client-chime-sdk-messaging"; // ES Modules import
28
+ * // const { ChimeSDKMessagingClient, DeleteMessagingStreamingConfigurationsCommand } = require("@aws-sdk/client-chime-sdk-messaging"); // CommonJS import
29
+ * const client = new ChimeSDKMessagingClient(config);
30
+ * const command = new DeleteMessagingStreamingConfigurationsCommand(input);
31
+ * const response = await client.send(command);
32
+ * ```
33
+ *
34
+ * @param DeleteMessagingStreamingConfigurationsCommandInput - {@link DeleteMessagingStreamingConfigurationsCommandInput}
35
+ * @returns {@link DeleteMessagingStreamingConfigurationsCommandOutput}
36
+ * @see {@link DeleteMessagingStreamingConfigurationsCommandInput} for command's `input` shape.
37
+ * @see {@link DeleteMessagingStreamingConfigurationsCommandOutput} for command's `response` shape.
38
+ * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
39
+ *
40
+ * @throws {@link ForbiddenException} (client fault)
41
+ * <p>The client is permanently forbidden from making the request.</p>
42
+ *
43
+ * @throws {@link ServiceFailureException} (server fault)
44
+ * <p>The service encountered an unexpected error.</p>
45
+ *
46
+ * @throws {@link ServiceUnavailableException} (server fault)
47
+ * <p>The service is currently unavailable.</p>
48
+ *
49
+ * @throws {@link ThrottledClientException} (client fault)
50
+ * <p>The client exceeded its request rate limit.</p>
51
+ *
52
+ * @throws {@link UnauthorizedClientException} (client fault)
53
+ * <p>The client is not currently authorized to make the request.</p>
54
+ *
55
+ *
56
+ */
57
+ export declare class DeleteMessagingStreamingConfigurationsCommand extends $Command<DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
58
+ readonly input: DeleteMessagingStreamingConfigurationsCommandInput;
59
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
63
+ constructor(input: DeleteMessagingStreamingConfigurationsCommandInput);
64
+ /**
65
+ * @internal
66
+ */
67
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
71
+ private serialize;
72
+ /**
73
+ * @internal
74
+ */
75
+ private deserialize;
76
+ }
@@ -4,20 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DescribeChannelBanRequest, DescribeChannelBanResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChannelBanCommand}.
8
10
  */
9
11
  export interface DescribeChannelBanCommandInput extends DescribeChannelBanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChannelBanCommand}.
13
17
  */
14
18
  export interface DescribeChannelBanCommandOutput extends DescribeChannelBanResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the full details of a channel ban.</p>
18
- *
19
23
  * <note>
20
- *
21
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
23
26
  * the header.</p>
@@ -32,6 +35,8 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
32
35
  * const response = await client.send(command);
33
36
  * ```
34
37
  *
38
+ * @param DescribeChannelBanCommandInput - {@link DescribeChannelBanCommandInput}
39
+ * @returns {@link DescribeChannelBanCommandOutput}
35
40
  * @see {@link DescribeChannelBanCommandInput} for command's `input` shape.
36
41
  * @see {@link DescribeChannelBanCommandOutput} for command's `response` shape.
37
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -62,11 +67,20 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
62
67
  export declare class DescribeChannelBanCommand extends $Command<DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
63
68
  readonly input: DescribeChannelBanCommandInput;
64
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
65
73
  constructor(input: DescribeChannelBanCommandInput);
66
74
  /**
67
75
  * @internal
68
76
  */
69
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
70
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
71
85
  private deserialize;
72
86
  }
@@ -4,21 +4,24 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DescribeChannelRequest, DescribeChannelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChannelCommand}.
8
10
  */
9
11
  export interface DescribeChannelCommandInput extends DescribeChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChannelCommand}.
13
17
  */
14
18
  export interface DescribeChannelCommandOutput extends DescribeChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the full details of a channel in an Amazon Chime
18
23
  * <code>AppInstance</code>.</p>
19
- *
20
24
  * <note>
21
- *
22
25
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
23
26
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
24
27
  * the header.</p>
@@ -33,6 +36,8 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
33
36
  * const response = await client.send(command);
34
37
  * ```
35
38
  *
39
+ * @param DescribeChannelCommandInput - {@link DescribeChannelCommandInput}
40
+ * @returns {@link DescribeChannelCommandOutput}
36
41
  * @see {@link DescribeChannelCommandInput} for command's `input` shape.
37
42
  * @see {@link DescribeChannelCommandOutput} for command's `response` shape.
38
43
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -60,11 +65,20 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
60
65
  export declare class DescribeChannelCommand extends $Command<DescribeChannelCommandInput, DescribeChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
66
  readonly input: DescribeChannelCommandInput;
62
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
63
71
  constructor(input: DescribeChannelCommandInput);
64
72
  /**
65
73
  * @internal
66
74
  */
67
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChannelCommandInput, DescribeChannelCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
68
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
69
83
  private deserialize;
70
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DescribeChannelFlowRequest, DescribeChannelFlowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChannelFlowCommand}.
8
10
  */
9
11
  export interface DescribeChannelFlowCommandInput extends DescribeChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChannelFlowCommand}.
13
17
  */
14
18
  export interface DescribeChannelFlowCommandOutput extends DescribeChannelFlowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the full details of a channel flow in an Amazon Chime <code>AppInstance</code>. This is a developer API.</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 DescribeChannelFlowCommandOutput extends DescribeChannelFlowRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeChannelFlowCommandInput - {@link DescribeChannelFlowCommandInput}
34
+ * @returns {@link DescribeChannelFlowCommandOutput}
28
35
  * @see {@link DescribeChannelFlowCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeChannelFlowCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeChannelFlowCommandOutput extends DescribeChannelFlowRes
52
59
  export declare class DescribeChannelFlowCommand extends $Command<DescribeChannelFlowCommandInput, DescribeChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
53
60
  readonly input: DescribeChannelFlowCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeChannelFlowCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChannelFlowCommandInput, DescribeChannelFlowCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DescribeChannelMembershipRequest, DescribeChannelMembershipResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChannelMembershipCommand}.
8
10
  */
9
11
  export interface DescribeChannelMembershipCommandInput extends DescribeChannelMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChannelMembershipCommand}.
13
17
  */
14
18
  export interface DescribeChannelMembershipCommandOutput extends DescribeChannelMembershipResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the full details of a user's channel membership.</p>
18
23
  * <note>
19
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
@@ -30,6 +35,8 @@ export interface DescribeChannelMembershipCommandOutput extends DescribeChannelM
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeChannelMembershipCommandInput - {@link DescribeChannelMembershipCommandInput}
39
+ * @returns {@link DescribeChannelMembershipCommandOutput}
33
40
  * @see {@link DescribeChannelMembershipCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeChannelMembershipCommandOutput} for command's `response` shape.
35
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeChannelMembershipCommandOutput extends DescribeChannelM
60
67
  export declare class DescribeChannelMembershipCommand extends $Command<DescribeChannelMembershipCommandInput, DescribeChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
61
68
  readonly input: DescribeChannelMembershipCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeChannelMembershipCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChannelMembershipCommandInput, DescribeChannelMembershipCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,19 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DescribeChannelMembershipForAppInstanceUserRequest, DescribeChannelMembershipForAppInstanceUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeChannelMembershipForAppInstanceUserCommand}.
8
10
  */
9
11
  export interface DescribeChannelMembershipForAppInstanceUserCommandInput extends DescribeChannelMembershipForAppInstanceUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeChannelMembershipForAppInstanceUserCommand}.
13
17
  */
14
18
  export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extends DescribeChannelMembershipForAppInstanceUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Returns the details of a channel based on the membership of the specified
18
23
  * <code>AppInstanceUser</code>.</p>
19
- *
20
24
  * <note>
21
25
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
22
26
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -32,6 +36,8 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extend
32
36
  * const response = await client.send(command);
33
37
  * ```
34
38
  *
39
+ * @param DescribeChannelMembershipForAppInstanceUserCommandInput - {@link DescribeChannelMembershipForAppInstanceUserCommandInput}
40
+ * @returns {@link DescribeChannelMembershipForAppInstanceUserCommandOutput}
35
41
  * @see {@link DescribeChannelMembershipForAppInstanceUserCommandInput} for command's `input` shape.
36
42
  * @see {@link DescribeChannelMembershipForAppInstanceUserCommandOutput} for command's `response` shape.
37
43
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -59,11 +65,20 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput extend
59
65
  export declare class DescribeChannelMembershipForAppInstanceUserCommand extends $Command<DescribeChannelMembershipForAppInstanceUserCommandInput, DescribeChannelMembershipForAppInstanceUserCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
60
66
  readonly input: DescribeChannelMembershipForAppInstanceUserCommandInput;
61
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
62
71
  constructor(input: DescribeChannelMembershipForAppInstanceUserCommandInput);
63
72
  /**
64
73
  * @internal
65
74
  */
66
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeChannelMembershipForAppInstanceUserCommandInput, DescribeChannelMembershipForAppInstanceUserCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
67
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
68
83
  private deserialize;
69
84
  }