Skip to content

Commit 0a32aa0

Browse files
author
awstools
committed
docs(client-chime-sdk-messaging): Documentation updates for Chime Messaging SDK
1 parent db0e989 commit 0a32aa0

File tree

57 files changed

+1760
-420
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1760
-420
lines changed

‎clients/client-chime-sdk-messaging/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
"@aws-sdk/hash-node": "*",
2727
"@aws-sdk/invalid-dependency": "*",
2828
"@aws-sdk/middleware-content-length": "*",
29+
"@aws-sdk/middleware-endpoint": "*",
2930
"@aws-sdk/middleware-host-header": "*",
3031
"@aws-sdk/middleware-logger": "*",
3132
"@aws-sdk/middleware-recursion-detection": "*",

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1816,8 +1816,7 @@ export class ChimeSDKMessaging extends ChimeSDKMessagingClient {
18161816
}
18171817

18181818
/**
1819-
* <p>Allows an <code>AppInstanceUser</code> to search the channels that they belong to. The <code>AppInstanceUser</code> can search by membership or external ID.
1820-
* An <code>AppInstanceAdmin</code> can search across all channels within the <code>AppInstance</code>.</p>
1819+
* <p>Allows <code>ChimeBearer</code> to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.</p>
18211820
*/
18221821
public searchChannels(
18231822
args: SearchChannelsCommandInput,

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

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
// smithy-typescript generated code
2-
import {
3-
EndpointsInputConfig,
4-
EndpointsResolvedConfig,
5-
RegionInputConfig,
6-
RegionResolvedConfig,
7-
resolveEndpointsConfig,
8-
resolveRegionConfig,
9-
} from "@aws-sdk/config-resolver";
2+
import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@aws-sdk/config-resolver";
103
import { getContentLengthPlugin } from "@aws-sdk/middleware-content-length";
4+
import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@aws-sdk/middleware-endpoint";
115
import {
126
getHostHeaderPlugin,
137
HostHeaderInputConfig,
@@ -41,13 +35,13 @@ import {
4135
Credentials as __Credentials,
4236
Decoder as __Decoder,
4337
Encoder as __Encoder,
38+
EndpointV2 as __EndpointV2,
4439
Hash as __Hash,
4540
HashConstructor as __HashConstructor,
4641
HttpHandlerOptions as __HttpHandlerOptions,
4742
Logger as __Logger,
4843
Provider as __Provider,
4944
Provider,
50-
RegionInfoProvider,
5145
StreamCollector as __StreamCollector,
5246
UrlParser as __UrlParser,
5347
UserAgent as __UserAgent,
@@ -184,6 +178,12 @@ import {
184178
UpdateChannelReadMarkerCommandInput,
185179
UpdateChannelReadMarkerCommandOutput,
186180
} from "./commands/UpdateChannelReadMarkerCommand";
181+
import {
182+
ClientInputEndpointParameters,
183+
ClientResolvedEndpointParameters,
184+
EndpointParameters,
185+
resolveClientEndpointParameters,
186+
} from "./endpoint/EndpointParameters";
187187
import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
188188

189189
export type ServiceInputTypes =
@@ -393,12 +393,6 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
393393
*/
394394
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
395395

396-
/**
397-
* Fetch related hostname, signing name or signing region with given region.
398-
* @internal
399-
*/
400-
regionInfoProvider?: RegionInfoProvider;
401-
402396
/**
403397
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
404398
* @internal
@@ -414,11 +408,12 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
414408
type ChimeSDKMessagingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
415409
ClientDefaults &
416410
RegionInputConfig &
417-
EndpointsInputConfig &
411+
EndpointInputConfig<EndpointParameters> &
418412
RetryInputConfig &
419413
HostHeaderInputConfig &
420414
AwsAuthInputConfig &
421-
UserAgentInputConfig;
415+
UserAgentInputConfig &
416+
ClientInputEndpointParameters;
422417
/**
423418
* The configuration interface of ChimeSDKMessagingClient class constructor that set the region, credentials and other options.
424419
*/
@@ -427,11 +422,12 @@ export interface ChimeSDKMessagingClientConfig extends ChimeSDKMessagingClientCo
427422
type ChimeSDKMessagingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
428423
Required<ClientDefaults> &
429424
RegionResolvedConfig &
430-
EndpointsResolvedConfig &
425+
EndpointResolvedConfig<EndpointParameters> &
431426
RetryResolvedConfig &
432427
HostHeaderResolvedConfig &
433428
AwsAuthResolvedConfig &
434-
UserAgentResolvedConfig;
429+
UserAgentResolvedConfig &
430+
ClientResolvedEndpointParameters;
435431
/**
436432
* The resolved configuration interface of ChimeSDKMessagingClient class. This is resolved and normalized from the {@link ChimeSDKMessagingClientConfig | constructor configuration interface}.
437433
*/
@@ -456,14 +452,15 @@ export class ChimeSDKMessagingClient extends __Client<
456452

457453
constructor(configuration: ChimeSDKMessagingClientConfig) {
458454
const _config_0 = __getRuntimeConfig(configuration);
459-
const _config_1 = resolveRegionConfig(_config_0);
460-
const _config_2 = resolveEndpointsConfig(_config_1);
461-
const _config_3 = resolveRetryConfig(_config_2);
462-
const _config_4 = resolveHostHeaderConfig(_config_3);
463-
const _config_5 = resolveAwsAuthConfig(_config_4);
464-
const _config_6 = resolveUserAgentConfig(_config_5);
465-
super(_config_6);
466-
this.config = _config_6;
455+
const _config_1 = resolveClientEndpointParameters(_config_0);
456+
const _config_2 = resolveRegionConfig(_config_1);
457+
const _config_3 = resolveEndpointConfig(_config_2);
458+
const _config_4 = resolveRetryConfig(_config_3);
459+
const _config_5 = resolveHostHeaderConfig(_config_4);
460+
const _config_6 = resolveAwsAuthConfig(_config_5);
461+
const _config_7 = resolveUserAgentConfig(_config_6);
462+
super(_config_7);
463+
this.config = _config_7;
467464
this.middlewareStack.use(getRetryPlugin(this.config));
468465
this.middlewareStack.use(getContentLengthPlugin(this.config));
469466
this.middlewareStack.use(getHostHeaderPlugin(this.config));

‎clients/client-chime-sdk-messaging/src/commands/AssociateChannelFlowCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// smithy-typescript generated code
2+
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
23
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
34
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
45
import { Command as $Command } from "@aws-sdk/smithy-client";
@@ -57,6 +58,15 @@ export class AssociateChannelFlowCommand extends $Command<
5758
// Start section: command_properties
5859
// End section: command_properties
5960

61+
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
62+
return {
63+
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
64+
Endpoint: { type: "builtInParams", name: "endpoint" },
65+
Region: { type: "builtInParams", name: "region" },
66+
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
67+
};
68+
}
69+
6070
constructor(readonly input: AssociateChannelFlowCommandInput) {
6171
// Start section: command_constructor
6272
super();
@@ -72,6 +82,9 @@ export class AssociateChannelFlowCommand extends $Command<
7282
options?: __HttpHandlerOptions
7383
): Handler<AssociateChannelFlowCommandInput, AssociateChannelFlowCommandOutput> {
7484
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
85+
this.middlewareStack.use(
86+
getEndpointPlugin(configuration, AssociateChannelFlowCommand.getEndpointParameterInstructions())
87+
);
7588

7689
const stack = clientStack.concat(this.middlewareStack);
7790

‎clients/client-chime-sdk-messaging/src/commands/BatchCreateChannelMembershipCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// smithy-typescript generated code
2+
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
23
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
34
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
45
import { Command as $Command } from "@aws-sdk/smithy-client";
@@ -58,6 +59,15 @@ export class BatchCreateChannelMembershipCommand extends $Command<
5859
// Start section: command_properties
5960
// End section: command_properties
6061

62+
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
63+
return {
64+
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
65+
Endpoint: { type: "builtInParams", name: "endpoint" },
66+
Region: { type: "builtInParams", name: "region" },
67+
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
68+
};
69+
}
70+
6171
constructor(readonly input: BatchCreateChannelMembershipCommandInput) {
6272
// Start section: command_constructor
6373
super();
@@ -73,6 +83,9 @@ export class BatchCreateChannelMembershipCommand extends $Command<
7383
options?: __HttpHandlerOptions
7484
): Handler<BatchCreateChannelMembershipCommandInput, BatchCreateChannelMembershipCommandOutput> {
7585
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
86+
this.middlewareStack.use(
87+
getEndpointPlugin(configuration, BatchCreateChannelMembershipCommand.getEndpointParameterInstructions())
88+
);
7689

7790
const stack = clientStack.concat(this.middlewareStack);
7891

‎clients/client-chime-sdk-messaging/src/commands/ChannelFlowCallbackCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// smithy-typescript generated code
2+
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
23
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
34
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
45
import { Command as $Command } from "@aws-sdk/smithy-client";
@@ -68,6 +69,15 @@ export class ChannelFlowCallbackCommand extends $Command<
6869
// Start section: command_properties
6970
// End section: command_properties
7071

72+
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
73+
return {
74+
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
75+
Endpoint: { type: "builtInParams", name: "endpoint" },
76+
Region: { type: "builtInParams", name: "region" },
77+
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
78+
};
79+
}
80+
7181
constructor(readonly input: ChannelFlowCallbackCommandInput) {
7282
// Start section: command_constructor
7383
super();
@@ -83,6 +93,9 @@ export class ChannelFlowCallbackCommand extends $Command<
8393
options?: __HttpHandlerOptions
8494
): Handler<ChannelFlowCallbackCommandInput, ChannelFlowCallbackCommandOutput> {
8595
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
96+
this.middlewareStack.use(
97+
getEndpointPlugin(configuration, ChannelFlowCallbackCommand.getEndpointParameterInstructions())
98+
);
8699

87100
const stack = clientStack.concat(this.middlewareStack);
88101

‎clients/client-chime-sdk-messaging/src/commands/CreateChannelBanCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// smithy-typescript generated code
2+
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
23
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
34
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
45
import { Command as $Command } from "@aws-sdk/smithy-client";
@@ -67,6 +68,15 @@ export class CreateChannelBanCommand extends $Command<
6768
// Start section: command_properties
6869
// End section: command_properties
6970

71+
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
72+
return {
73+
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
74+
Endpoint: { type: "builtInParams", name: "endpoint" },
75+
Region: { type: "builtInParams", name: "region" },
76+
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
77+
};
78+
}
79+
7080
constructor(readonly input: CreateChannelBanCommandInput) {
7181
// Start section: command_constructor
7282
super();
@@ -82,6 +92,9 @@ export class CreateChannelBanCommand extends $Command<
8292
options?: __HttpHandlerOptions
8393
): Handler<CreateChannelBanCommandInput, CreateChannelBanCommandOutput> {
8494
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
95+
this.middlewareStack.use(
96+
getEndpointPlugin(configuration, CreateChannelBanCommand.getEndpointParameterInstructions())
97+
);
8598

8699
const stack = clientStack.concat(this.middlewareStack);
87100

‎clients/client-chime-sdk-messaging/src/commands/CreateChannelCommand.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// smithy-typescript generated code
2+
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
23
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
34
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
45
import { Command as $Command } from "@aws-sdk/smithy-client";
@@ -66,6 +67,15 @@ export class CreateChannelCommand extends $Command<
6667
// Start section: command_properties
6768
// End section: command_properties
6869

70+
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
71+
return {
72+
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
73+
Endpoint: { type: "builtInParams", name: "endpoint" },
74+
Region: { type: "builtInParams", name: "region" },
75+
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
76+
};
77+
}
78+
6979
constructor(readonly input: CreateChannelCommandInput) {
7080
// Start section: command_constructor
7181
super();
@@ -81,6 +91,7 @@ export class CreateChannelCommand extends $Command<
8191
options?: __HttpHandlerOptions
8292
): Handler<CreateChannelCommandInput, CreateChannelCommandOutput> {
8393
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
94+
this.middlewareStack.use(getEndpointPlugin(configuration, CreateChannelCommand.getEndpointParameterInstructions()));
8495

8596
const stack = clientStack.concat(this.middlewareStack);
8697

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// smithy-typescript generated code
2+
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
23
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
34
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
45
import { Command as $Command } from "@aws-sdk/smithy-client";
@@ -77,6 +78,15 @@ export class CreateChannelFlowCommand extends $Command<
7778
// Start section: command_properties
7879
// End section: command_properties
7980

81+
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
82+
return {
83+
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
84+
Endpoint: { type: "builtInParams", name: "endpoint" },
85+
Region: { type: "builtInParams", name: "region" },
86+
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
87+
};
88+
}
89+
8090
constructor(readonly input: CreateChannelFlowCommandInput) {
8191
// Start section: command_constructor
8292
super();
@@ -92,6 +102,9 @@ export class CreateChannelFlowCommand extends $Command<
92102
options?: __HttpHandlerOptions
93103
): Handler<CreateChannelFlowCommandInput, CreateChannelFlowCommandOutput> {
94104
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
105+
this.middlewareStack.use(
106+
getEndpointPlugin(configuration, CreateChannelFlowCommand.getEndpointParameterInstructions())
107+
);
95108

96109
const stack = clientStack.concat(this.middlewareStack);
97110

‎clients/client-chime-sdk-messaging/src/commands/CreateChannelMembershipCommand.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// smithy-typescript generated code
2+
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
23
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
34
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
45
import { Command as $Command } from "@aws-sdk/smithy-client";
@@ -93,6 +94,15 @@ export class CreateChannelMembershipCommand extends $Command<
9394
// Start section: command_properties
9495
// End section: command_properties
9596

97+
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
98+
return {
99+
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
100+
Endpoint: { type: "builtInParams", name: "endpoint" },
101+
Region: { type: "builtInParams", name: "region" },
102+
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
103+
};
104+
}
105+
96106
constructor(readonly input: CreateChannelMembershipCommandInput) {
97107
// Start section: command_constructor
98108
super();
@@ -108,6 +118,9 @@ export class CreateChannelMembershipCommand extends $Command<
108118
options?: __HttpHandlerOptions
109119
): Handler<CreateChannelMembershipCommandInput, CreateChannelMembershipCommandOutput> {
110120
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
121+
this.middlewareStack.use(
122+
getEndpointPlugin(configuration, CreateChannelMembershipCommand.getEndpointParameterInstructions())
123+
);
111124

112125
const stack = clientStack.concat(this.middlewareStack);
113126

0 commit comments

Comments
 (0)