Skip to content

Commit eb92132

Browse files
author
awstools
committed
feat(client-chime-sdk-messaging): Amazon Chime SDK Messaging GetMessagingSessionEndpoint API now returns dual-stack WebSocket endpoints supporting IPv4/IPv6.
1 parent b9c1896 commit eb92132

File tree

12 files changed

+93
-35
lines changed

12 files changed

+93
-35
lines changed

clients/client-chime-sdk-messaging/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ AWS SDK for JavaScript ChimeSDKMessaging Client for Node.js, Browser and React N
99
<p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
1010
and receive messages in custom messaging applications. These APIs depend on the frameworks
1111
provided by the Amazon Chime SDK identity APIs. For more information about the messaging
12-
APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
12+
APIs, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
1313

1414
## Installing
1515

clients/client-chime-sdk-messaging/src/ChimeSDKMessaging.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1135,7 +1135,7 @@ export interface ChimeSDKMessaging {
11351135
* <p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
11361136
* and receive messages in custom messaging applications. These APIs depend on the frameworks
11371137
* provided by the Amazon Chime SDK identity APIs. For more information about the messaging
1138-
* APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
1138+
* APIs, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
11391139
* @public
11401140
*/
11411141
export class ChimeSDKMessaging extends ChimeSDKMessagingClient implements ChimeSDKMessaging {}

clients/client-chime-sdk-messaging/src/ChimeSDKMessagingClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ export interface ChimeSDKMessagingClientResolvedConfig extends ChimeSDKMessaging
517517
* <p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
518518
* and receive messages in custom messaging applications. These APIs depend on the frameworks
519519
* provided by the Amazon Chime SDK identity APIs. For more information about the messaging
520-
* APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
520+
* APIs, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
521521
* @public
522522
*/
523523
export class ChimeSDKMessagingClient extends __Client<

clients/client-chime-sdk-messaging/src/commands/CreateChannelFlowCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
5454
* </ol>
5555
* <note>
5656
* <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to
57-
* <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>
57+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>
5858
* </note>
5959
* @example
6060
* Use a bare-bones client and the command you need to make an API call.

clients/client-chime-sdk-messaging/src/commands/GetMessagingSessionEndpointCommand.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ export interface GetMessagingSessionEndpointCommandOutput
4646
* // import type { ChimeSDKMessagingClientConfig } from "@aws-sdk/client-chime-sdk-messaging";
4747
* const config = {}; // type is ChimeSDKMessagingClientConfig
4848
* const client = new ChimeSDKMessagingClient(config);
49-
* const input = {};
49+
* const input = { // GetMessagingSessionEndpointRequest
50+
* NetworkType: "IPV4_ONLY" || "DUAL_STACK",
51+
* };
5052
* const command = new GetMessagingSessionEndpointCommand(input);
5153
* const response = await client.send(command);
5254
* // { // GetMessagingSessionEndpointResponse
@@ -108,7 +110,7 @@ export class GetMessagingSessionEndpointCommand extends $Command
108110
/** @internal type navigation helper, not in runtime. */
109111
protected declare static __types: {
110112
api: {
111-
input: {};
113+
input: GetMessagingSessionEndpointRequest;
112114
output: GetMessagingSessionEndpointResponse;
113115
};
114116
sdk: {

clients/client-chime-sdk-messaging/src/commands/ListChannelMembershipsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh
4444
* the header.</p>
4545
* </note>
4646
* <p>If you want to list the channels to which a specific app instance user belongs, see the
47-
* <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API.</p>
47+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API.</p>
4848
* @example
4949
* Use a bare-bones client and the command you need to make an API call.
5050
* ```javascript

clients/client-chime-sdk-messaging/src/commands/RedactChannelMessageCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface RedactChannelMessageCommandInput extends RedactChannelMessageRe
3232
export interface RedactChannelMessageCommandOutput extends RedactChannelMessageResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Redacts message content, but not metadata. The message exists in the back end, but the
35+
* <p>Redacts message content and metadata. The message exists in the back end, but the
3636
* action returns null content, and the state shows as redacted.</p>
3737
* <note>
3838
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the

clients/client-chime-sdk-messaging/src/commands/SearchChannelsCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ export interface SearchChannelsCommandOutput extends SearchChannelsResponse, __M
4343
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
4444
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
4545
* the header.</p>
46+
* <note>
47+
* <p>This operation isn't supported for <code>AppInstanceUsers</code> with a large number of memberships.</p>
48+
* </note>
4649
* @example
4750
* Use a bare-bones client and the command you need to make an API call.
4851
* ```javascript

clients/client-chime-sdk-messaging/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* <p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
55
* and receive messages in custom messaging applications. These APIs depend on the frameworks
66
* provided by the Amazon Chime SDK identity APIs. For more information about the messaging
7-
* APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
7+
* APIs, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
88
*
99
* @packageDocumentation
1010
*/

clients/client-chime-sdk-messaging/src/models/models_0.ts

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1567,7 +1567,7 @@ export interface CreateChannelRequest {
15671567
ChimeBearer: string | undefined;
15681568

15691569
/**
1570-
* <p>The ID of the channel in the request.</p>
1570+
* <p>An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.</p>
15711571
* @public
15721572
*/
15731573
ChannelId?: string | undefined;
@@ -2347,10 +2347,30 @@ export interface GetChannelMessageStatusResponse {
23472347
Status?: ChannelMessageStatusStructure | undefined;
23482348
}
23492349

2350+
/**
2351+
* @public
2352+
* @enum
2353+
*/
2354+
export const NetworkType = {
2355+
DUAL_STACK: "DUAL_STACK",
2356+
IPV4_ONLY: "IPV4_ONLY",
2357+
} as const;
2358+
2359+
/**
2360+
* @public
2361+
*/
2362+
export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
2363+
23502364
/**
23512365
* @public
23522366
*/
2353-
export interface GetMessagingSessionEndpointRequest {}
2367+
export interface GetMessagingSessionEndpointRequest {
2368+
/**
2369+
* <p>The type of network for the messaging session endpoint. Either IPv4 only or dual-stack (IPv4 and IPv6).</p>
2370+
* @public
2371+
*/
2372+
NetworkType?: NetworkType | undefined;
2373+
}
23542374

23552375
/**
23562376
* <p>The websocket endpoint used to connect to Amazon Chime SDK messaging.</p>
@@ -3241,6 +3261,9 @@ export type SearchFieldOperator = (typeof SearchFieldOperator)[keyof typeof Sear
32413261

32423262
/**
32433263
* <p>A <code>Field</code> of the channel that you want to search.</p>
3264+
* <note>
3265+
* <p>This operation isn't supported for <code>AppInstanceUsers</code> with a large number of memberships.</p>
3266+
* </note>
32443267
* @public
32453268
*/
32463269
export interface SearchField {
@@ -3254,7 +3277,7 @@ export interface SearchField {
32543277
/**
32553278
* <p>The values that you want to search for, a list of strings. The values must be <code>AppInstanceUserArns</code> specified as a list of strings.</p>
32563279
* <note>
3257-
* <p>This operation isn't supported for <code>AppInstanceUsers</code> with large number of memberships.</p>
3280+
* <p>This operation isn't supported for <code>AppInstanceUsers</code> with a large number of memberships.</p>
32583281
* </note>
32593282
* @public
32603283
*/

0 commit comments

Comments
 (0)