@aws-sdk/client-chime-sdk-identity 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 (34) hide show
  1. package/dist-types/ChimeSDKIdentity.d.ts +25 -0
  2. package/dist-types/ChimeSDKIdentityClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAppInstanceAdminCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAppInstanceCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateAppInstanceUserCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteAppInstanceAdminCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteAppInstanceCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteAppInstanceUserCommand.d.ts +16 -0
  9. package/dist-types/commands/DeregisterAppInstanceUserEndpointCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeAppInstanceAdminCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeAppInstanceCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeAppInstanceUserCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeAppInstanceUserEndpointCommand.d.ts +16 -0
  14. package/dist-types/commands/GetAppInstanceRetentionSettingsCommand.d.ts +16 -0
  15. package/dist-types/commands/ListAppInstanceAdminsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListAppInstanceUserEndpointsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListAppInstanceUsersCommand.d.ts +16 -0
  18. package/dist-types/commands/ListAppInstancesCommand.d.ts +16 -0
  19. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  20. package/dist-types/commands/PutAppInstanceRetentionSettingsCommand.d.ts +16 -0
  21. package/dist-types/commands/RegisterAppInstanceUserEndpointCommand.d.ts +16 -0
  22. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/UpdateAppInstanceCommand.d.ts +16 -0
  25. package/dist-types/commands/UpdateAppInstanceUserCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateAppInstanceUserEndpointCommand.d.ts +16 -0
  27. package/dist-types/models/ChimeSDKIdentityServiceException.d.ts +2 -0
  28. package/dist-types/models/models_0.d.ts +163 -0
  29. package/dist-types/pagination/Interfaces.d.ts +3 -0
  30. package/dist-types/pagination/ListAppInstanceAdminsPaginator.d.ts +3 -0
  31. package/dist-types/pagination/ListAppInstanceUserEndpointsPaginator.d.ts +3 -0
  32. package/dist-types/pagination/ListAppInstanceUsersPaginator.d.ts +3 -0
  33. package/dist-types/pagination/ListAppInstancesPaginator.d.ts +3 -0
  34. package/package.json +29 -29
@@ -25,6 +25,7 @@ import { UpdateAppInstanceCommandInput, UpdateAppInstanceCommandOutput } from ".
25
25
  import { UpdateAppInstanceUserCommandInput, UpdateAppInstanceUserCommandOutput } from "./commands/UpdateAppInstanceUserCommand";
26
26
  import { UpdateAppInstanceUserEndpointCommandInput, UpdateAppInstanceUserEndpointCommandOutput } from "./commands/UpdateAppInstanceUserEndpointCommand";
27
27
  /**
28
+ * @public
28
29
  * <p>The Amazon Chime SDK Identity APIs in this section allow software developers to create
29
30
  * and manage unique instances of their messaging applications. These APIs provide the
30
31
  * overarching framework for creating and sending messages. For more information about the
@@ -32,6 +33,7 @@ import { UpdateAppInstanceUserEndpointCommandInput, UpdateAppInstanceUserEndpoin
32
33
  */
33
34
  export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
34
35
  /**
36
+ * @public
35
37
  * <p>Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account.
36
38
  * Only SDK messaging customers use this API. <code>CreateAppInstance</code> supports
37
39
  * idempotency behavior as described in the AWS API Standard.</p>
@@ -41,6 +43,7 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
41
43
  createAppInstance(args: CreateAppInstanceCommandInput, cb: (err: any, data?: CreateAppInstanceCommandOutput) => void): void;
42
44
  createAppInstance(args: CreateAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceCommandOutput) => void): void;
43
45
  /**
46
+ * @public
44
47
  * <p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The
45
48
  * promoted user can perform the following actions. </p>
46
49
  *
@@ -63,6 +66,7 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
63
66
  createAppInstanceAdmin(args: CreateAppInstanceAdminCommandInput, cb: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void): void;
64
67
  createAppInstanceAdmin(args: CreateAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceAdminCommandOutput) => void): void;
65
68
  /**
69
+ * @public
66
70
  * <p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a
67
71
  * unique <code>appInstanceUserId</code> and <code>Name</code> for that user.</p>
68
72
  */
@@ -70,12 +74,14 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
70
74
  createAppInstanceUser(args: CreateAppInstanceUserCommandInput, cb: (err: any, data?: CreateAppInstanceUserCommandOutput) => void): void;
71
75
  createAppInstanceUser(args: CreateAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAppInstanceUserCommandOutput) => void): void;
72
76
  /**
77
+ * @public
73
78
  * <p>Deletes an <code>AppInstance</code> and all associated data asynchronously.</p>
74
79
  */
75
80
  deleteAppInstance(args: DeleteAppInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAppInstanceCommandOutput>;
76
81
  deleteAppInstance(args: DeleteAppInstanceCommandInput, cb: (err: any, data?: DeleteAppInstanceCommandOutput) => void): void;
77
82
  deleteAppInstance(args: DeleteAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceCommandOutput) => void): void;
78
83
  /**
84
+ * @public
79
85
  * <p>Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code>. This action
80
86
  * does not delete the user.</p>
81
87
  */
@@ -83,54 +89,63 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
83
89
  deleteAppInstanceAdmin(args: DeleteAppInstanceAdminCommandInput, cb: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void): void;
84
90
  deleteAppInstanceAdmin(args: DeleteAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceAdminCommandOutput) => void): void;
85
91
  /**
92
+ * @public
86
93
  * <p>Deletes an <code>AppInstanceUser</code>.</p>
87
94
  */
88
95
  deleteAppInstanceUser(args: DeleteAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAppInstanceUserCommandOutput>;
89
96
  deleteAppInstanceUser(args: DeleteAppInstanceUserCommandInput, cb: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void): void;
90
97
  deleteAppInstanceUser(args: DeleteAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppInstanceUserCommandOutput) => void): void;
91
98
  /**
99
+ * @public
92
100
  * <p>Deregisters an <code>AppInstanceUserEndpoint</code>.</p>
93
101
  */
94
102
  deregisterAppInstanceUserEndpoint(args: DeregisterAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterAppInstanceUserEndpointCommandOutput>;
95
103
  deregisterAppInstanceUserEndpoint(args: DeregisterAppInstanceUserEndpointCommandInput, cb: (err: any, data?: DeregisterAppInstanceUserEndpointCommandOutput) => void): void;
96
104
  deregisterAppInstanceUserEndpoint(args: DeregisterAppInstanceUserEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterAppInstanceUserEndpointCommandOutput) => void): void;
97
105
  /**
106
+ * @public
98
107
  * <p>Returns the full details of an <code>AppInstance</code>.</p>
99
108
  */
100
109
  describeAppInstance(args: DescribeAppInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAppInstanceCommandOutput>;
101
110
  describeAppInstance(args: DescribeAppInstanceCommandInput, cb: (err: any, data?: DescribeAppInstanceCommandOutput) => void): void;
102
111
  describeAppInstance(args: DescribeAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceCommandOutput) => void): void;
103
112
  /**
113
+ * @public
104
114
  * <p>Returns the full details of an <code>AppInstanceAdmin</code>.</p>
105
115
  */
106
116
  describeAppInstanceAdmin(args: DescribeAppInstanceAdminCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAppInstanceAdminCommandOutput>;
107
117
  describeAppInstanceAdmin(args: DescribeAppInstanceAdminCommandInput, cb: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void): void;
108
118
  describeAppInstanceAdmin(args: DescribeAppInstanceAdminCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceAdminCommandOutput) => void): void;
109
119
  /**
120
+ * @public
110
121
  * <p>Returns the full details of an <code>AppInstanceUser</code>.</p>
111
122
  */
112
123
  describeAppInstanceUser(args: DescribeAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAppInstanceUserCommandOutput>;
113
124
  describeAppInstanceUser(args: DescribeAppInstanceUserCommandInput, cb: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void): void;
114
125
  describeAppInstanceUser(args: DescribeAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceUserCommandOutput) => void): void;
115
126
  /**
127
+ * @public
116
128
  * <p>Returns the full details of an <code>AppInstanceUserEndpoint</code>.</p>
117
129
  */
118
130
  describeAppInstanceUserEndpoint(args: DescribeAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAppInstanceUserEndpointCommandOutput>;
119
131
  describeAppInstanceUserEndpoint(args: DescribeAppInstanceUserEndpointCommandInput, cb: (err: any, data?: DescribeAppInstanceUserEndpointCommandOutput) => void): void;
120
132
  describeAppInstanceUserEndpoint(args: DescribeAppInstanceUserEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppInstanceUserEndpointCommandOutput) => void): void;
121
133
  /**
134
+ * @public
122
135
  * <p>Gets the retention settings for an <code>AppInstance</code>.</p>
123
136
  */
124
137
  getAppInstanceRetentionSettings(args: GetAppInstanceRetentionSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetAppInstanceRetentionSettingsCommandOutput>;
125
138
  getAppInstanceRetentionSettings(args: GetAppInstanceRetentionSettingsCommandInput, cb: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void): void;
126
139
  getAppInstanceRetentionSettings(args: GetAppInstanceRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppInstanceRetentionSettingsCommandOutput) => void): void;
127
140
  /**
141
+ * @public
128
142
  * <p>Returns a list of the administrators in the <code>AppInstance</code>.</p>
129
143
  */
130
144
  listAppInstanceAdmins(args: ListAppInstanceAdminsCommandInput, options?: __HttpHandlerOptions): Promise<ListAppInstanceAdminsCommandOutput>;
131
145
  listAppInstanceAdmins(args: ListAppInstanceAdminsCommandInput, cb: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void): void;
132
146
  listAppInstanceAdmins(args: ListAppInstanceAdminsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceAdminsCommandOutput) => void): void;
133
147
  /**
148
+ * @public
134
149
  * <p>Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS
135
150
  * account.</p>
136
151
  */
@@ -138,12 +153,14 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
138
153
  listAppInstances(args: ListAppInstancesCommandInput, cb: (err: any, data?: ListAppInstancesCommandOutput) => void): void;
139
154
  listAppInstances(args: ListAppInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstancesCommandOutput) => void): void;
140
155
  /**
156
+ * @public
141
157
  * <p>Lists all the <code>AppInstanceUserEndpoints</code> created under a single <code>AppInstanceUser</code>.</p>
142
158
  */
143
159
  listAppInstanceUserEndpoints(args: ListAppInstanceUserEndpointsCommandInput, options?: __HttpHandlerOptions): Promise<ListAppInstanceUserEndpointsCommandOutput>;
144
160
  listAppInstanceUserEndpoints(args: ListAppInstanceUserEndpointsCommandInput, cb: (err: any, data?: ListAppInstanceUserEndpointsCommandOutput) => void): void;
145
161
  listAppInstanceUserEndpoints(args: ListAppInstanceUserEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceUserEndpointsCommandOutput) => void): void;
146
162
  /**
163
+ * @public
147
164
  * <p>List all <code>AppInstanceUsers</code> created under a single
148
165
  * <code>AppInstance</code>.</p>
149
166
  */
@@ -151,12 +168,14 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
151
168
  listAppInstanceUsers(args: ListAppInstanceUsersCommandInput, cb: (err: any, data?: ListAppInstanceUsersCommandOutput) => void): void;
152
169
  listAppInstanceUsers(args: ListAppInstanceUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppInstanceUsersCommandOutput) => void): void;
153
170
  /**
171
+ * @public
154
172
  * <p>Lists the tags applied to an Amazon Chime SDK identity resource.</p>
155
173
  */
156
174
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
157
175
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
158
176
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
159
177
  /**
178
+ * @public
160
179
  * <p>Sets the amount of time in days that a given <code>AppInstance</code> retains
161
180
  * data.</p>
162
181
  */
@@ -164,30 +183,35 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
164
183
  putAppInstanceRetentionSettings(args: PutAppInstanceRetentionSettingsCommandInput, cb: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void): void;
165
184
  putAppInstanceRetentionSettings(args: PutAppInstanceRetentionSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppInstanceRetentionSettingsCommandOutput) => void): void;
166
185
  /**
186
+ * @public
167
187
  * <p>Registers an endpoint under an Amazon Chime <code>AppInstanceUser</code>. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.</p>
168
188
  */
169
189
  registerAppInstanceUserEndpoint(args: RegisterAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions): Promise<RegisterAppInstanceUserEndpointCommandOutput>;
170
190
  registerAppInstanceUserEndpoint(args: RegisterAppInstanceUserEndpointCommandInput, cb: (err: any, data?: RegisterAppInstanceUserEndpointCommandOutput) => void): void;
171
191
  registerAppInstanceUserEndpoint(args: RegisterAppInstanceUserEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterAppInstanceUserEndpointCommandOutput) => void): void;
172
192
  /**
193
+ * @public
173
194
  * <p>Applies the specified tags to the specified Amazon Chime SDK identity resource.</p>
174
195
  */
175
196
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
176
197
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
177
198
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
178
199
  /**
200
+ * @public
179
201
  * <p>Removes the specified tags from the specified Amazon Chime SDK identity resource.</p>
180
202
  */
181
203
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
182
204
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
183
205
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
184
206
  /**
207
+ * @public
185
208
  * <p>Updates <code>AppInstance</code> metadata.</p>
186
209
  */
187
210
  updateAppInstance(args: UpdateAppInstanceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAppInstanceCommandOutput>;
188
211
  updateAppInstance(args: UpdateAppInstanceCommandInput, cb: (err: any, data?: UpdateAppInstanceCommandOutput) => void): void;
189
212
  updateAppInstance(args: UpdateAppInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceCommandOutput) => void): void;
190
213
  /**
214
+ * @public
191
215
  * <p>Updates the details of an <code>AppInstanceUser</code>. You can update names and
192
216
  * metadata.</p>
193
217
  */
@@ -195,6 +219,7 @@ export declare class ChimeSDKIdentity extends ChimeSDKIdentityClient {
195
219
  updateAppInstanceUser(args: UpdateAppInstanceUserCommandInput, cb: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void): void;
196
220
  updateAppInstanceUser(args: UpdateAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAppInstanceUserCommandOutput) => void): void;
197
221
  /**
222
+ * @public
198
223
  * <p>Updates the details of an <code>AppInstanceUserEndpoint</code>. You can update the name and <code>AllowMessage</code> values.</p>
199
224
  */
200
225
  updateAppInstanceUserEndpoint(args: UpdateAppInstanceUserEndpointCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAppInstanceUserEndpointCommandOutput>;
@@ -32,15 +32,24 @@ import { UpdateAppInstanceCommandInput, UpdateAppInstanceCommandOutput } from ".
32
32
  import { UpdateAppInstanceUserCommandInput, UpdateAppInstanceUserCommandOutput } from "./commands/UpdateAppInstanceUserCommand";
33
33
  import { UpdateAppInstanceUserEndpointCommandInput, UpdateAppInstanceUserEndpointCommandOutput } from "./commands/UpdateAppInstanceUserEndpointCommand";
34
34
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
35
+ /**
36
+ * @public
37
+ */
35
38
  export type ServiceInputTypes = CreateAppInstanceAdminCommandInput | CreateAppInstanceCommandInput | CreateAppInstanceUserCommandInput | DeleteAppInstanceAdminCommandInput | DeleteAppInstanceCommandInput | DeleteAppInstanceUserCommandInput | DeregisterAppInstanceUserEndpointCommandInput | DescribeAppInstanceAdminCommandInput | DescribeAppInstanceCommandInput | DescribeAppInstanceUserCommandInput | DescribeAppInstanceUserEndpointCommandInput | GetAppInstanceRetentionSettingsCommandInput | ListAppInstanceAdminsCommandInput | ListAppInstanceUserEndpointsCommandInput | ListAppInstanceUsersCommandInput | ListAppInstancesCommandInput | ListTagsForResourceCommandInput | PutAppInstanceRetentionSettingsCommandInput | RegisterAppInstanceUserEndpointCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAppInstanceCommandInput | UpdateAppInstanceUserCommandInput | UpdateAppInstanceUserEndpointCommandInput;
39
+ /**
40
+ * @public
41
+ */
36
42
  export type ServiceOutputTypes = CreateAppInstanceAdminCommandOutput | CreateAppInstanceCommandOutput | CreateAppInstanceUserCommandOutput | DeleteAppInstanceAdminCommandOutput | DeleteAppInstanceCommandOutput | DeleteAppInstanceUserCommandOutput | DeregisterAppInstanceUserEndpointCommandOutput | DescribeAppInstanceAdminCommandOutput | DescribeAppInstanceCommandOutput | DescribeAppInstanceUserCommandOutput | DescribeAppInstanceUserEndpointCommandOutput | GetAppInstanceRetentionSettingsCommandOutput | ListAppInstanceAdminsCommandOutput | ListAppInstanceUserEndpointsCommandOutput | ListAppInstanceUsersCommandOutput | ListAppInstancesCommandOutput | ListTagsForResourceCommandOutput | PutAppInstanceRetentionSettingsCommandOutput | RegisterAppInstanceUserEndpointCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAppInstanceCommandOutput | UpdateAppInstanceUserCommandOutput | UpdateAppInstanceUserEndpointCommandOutput;
43
+ /**
44
+ * @public
45
+ */
37
46
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
38
47
  /**
39
48
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
40
49
  */
41
50
  requestHandler?: __HttpHandler;
42
51
  /**
43
- * A constructor for a class implementing the {@link __Checksum} interface
52
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
44
53
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
45
54
  * @internal
46
55
  */
@@ -130,23 +139,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
130
139
  */
131
140
  logger?: __Logger;
132
141
  /**
133
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
142
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
134
143
  */
135
144
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
136
145
  }
146
+ /**
147
+ * @public
148
+ */
137
149
  type ChimeSDKIdentityClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
138
150
  /**
139
- * The configuration interface of ChimeSDKIdentityClient class constructor that set the region, credentials and other options.
151
+ * @public
152
+ *
153
+ * The configuration interface of ChimeSDKIdentityClient class constructor that set the region, credentials and other options.
140
154
  */
141
155
  export interface ChimeSDKIdentityClientConfig extends ChimeSDKIdentityClientConfigType {
142
156
  }
157
+ /**
158
+ * @public
159
+ */
143
160
  type ChimeSDKIdentityClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
144
161
  /**
145
- * The resolved configuration interface of ChimeSDKIdentityClient class. This is resolved and normalized from the {@link ChimeSDKIdentityClientConfig | constructor configuration interface}.
162
+ * @public
163
+ *
164
+ * The resolved configuration interface of ChimeSDKIdentityClient class. This is resolved and normalized from the {@link ChimeSDKIdentityClientConfig | constructor configuration interface}.
146
165
  */
147
166
  export interface ChimeSDKIdentityClientResolvedConfig extends ChimeSDKIdentityClientResolvedConfigType {
148
167
  }
149
168
  /**
169
+ * @public
150
170
  * <p>The Amazon Chime SDK Identity APIs in this section allow software developers to create
151
171
  * and manage unique instances of their messaging applications. These APIs provide the
152
172
  * overarching framework for creating and sending messages. For more information about the
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { CreateAppInstanceAdminRequest, CreateAppInstanceAdminResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAppInstanceAdminCommand}.
8
10
  */
9
11
  export interface CreateAppInstanceAdminCommandInput extends CreateAppInstanceAdminRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAppInstanceAdminCommand}.
13
17
  */
14
18
  export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAdminResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The
18
23
  * promoted user can perform the following actions. </p>
19
24
  *
@@ -41,6 +46,8 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd
41
46
  * const response = await client.send(command);
42
47
  * ```
43
48
  *
49
+ * @param CreateAppInstanceAdminCommandInput - {@link CreateAppInstanceAdminCommandInput}
50
+ * @returns {@link CreateAppInstanceAdminCommandOutput}
44
51
  * @see {@link CreateAppInstanceAdminCommandInput} for command's `input` shape.
45
52
  * @see {@link CreateAppInstanceAdminCommandOutput} for command's `response` shape.
46
53
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -75,11 +82,20 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd
75
82
  export declare class CreateAppInstanceAdminCommand extends $Command<CreateAppInstanceAdminCommandInput, CreateAppInstanceAdminCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
76
83
  readonly input: CreateAppInstanceAdminCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: CreateAppInstanceAdminCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAppInstanceAdminCommandInput, CreateAppInstanceAdminCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { CreateAppInstanceRequest, CreateAppInstanceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAppInstanceCommand}.
8
10
  */
9
11
  export interface CreateAppInstanceCommandInput extends CreateAppInstanceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAppInstanceCommand}.
13
17
  */
14
18
  export interface CreateAppInstanceCommandOutput extends CreateAppInstanceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account.
18
23
  * Only SDK messaging customers use this API. <code>CreateAppInstance</code> supports
19
24
  * idempotency behavior as described in the AWS API Standard.</p>
@@ -28,6 +33,8 @@ export interface CreateAppInstanceCommandOutput extends CreateAppInstanceRespons
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateAppInstanceCommandInput - {@link CreateAppInstanceCommandInput}
37
+ * @returns {@link CreateAppInstanceCommandOutput}
31
38
  * @see {@link CreateAppInstanceCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateAppInstanceCommandOutput} for command's `response` shape.
33
40
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -62,11 +69,20 @@ export interface CreateAppInstanceCommandOutput extends CreateAppInstanceRespons
62
69
  export declare class CreateAppInstanceCommand extends $Command<CreateAppInstanceCommandInput, CreateAppInstanceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
63
70
  readonly input: CreateAppInstanceCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: CreateAppInstanceCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAppInstanceCommandInput, CreateAppInstanceCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { CreateAppInstanceUserRequest, CreateAppInstanceUserResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAppInstanceUserCommand}.
8
10
  */
9
11
  export interface CreateAppInstanceUserCommandInput extends CreateAppInstanceUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAppInstanceUserCommand}.
13
17
  */
14
18
  export interface CreateAppInstanceUserCommandOutput extends CreateAppInstanceUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a
18
23
  * unique <code>appInstanceUserId</code> and <code>Name</code> for that user.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateAppInstanceUserCommandOutput extends CreateAppInstanceUse
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateAppInstanceUserCommandInput - {@link CreateAppInstanceUserCommandInput}
35
+ * @returns {@link CreateAppInstanceUserCommandOutput}
29
36
  * @see {@link CreateAppInstanceUserCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateAppInstanceUserCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CreateAppInstanceUserCommandOutput extends CreateAppInstanceUse
60
67
  export declare class CreateAppInstanceUserCommand extends $Command<CreateAppInstanceUserCommandInput, CreateAppInstanceUserCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
61
68
  readonly input: CreateAppInstanceUserCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CreateAppInstanceUserCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAppInstanceUserCommandInput, CreateAppInstanceUserCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { DeleteAppInstanceAdminRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAppInstanceAdminCommand}.
8
10
  */
9
11
  export interface DeleteAppInstanceAdminCommandInput extends DeleteAppInstanceAdminRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAppInstanceAdminCommand}.
13
17
  */
14
18
  export interface DeleteAppInstanceAdminCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code>. This action
18
23
  * does not delete the user.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteAppInstanceAdminCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteAppInstanceAdminCommandInput - {@link DeleteAppInstanceAdminCommandInput}
35
+ * @returns {@link DeleteAppInstanceAdminCommandOutput}
29
36
  * @see {@link DeleteAppInstanceAdminCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteAppInstanceAdminCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DeleteAppInstanceAdminCommandOutput extends __MetadataBearer {
60
67
  export declare class DeleteAppInstanceAdminCommand extends $Command<DeleteAppInstanceAdminCommandInput, DeleteAppInstanceAdminCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
61
68
  readonly input: DeleteAppInstanceAdminCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DeleteAppInstanceAdminCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAppInstanceAdminCommandInput, DeleteAppInstanceAdminCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { DeleteAppInstanceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAppInstanceCommand}.
8
10
  */
9
11
  export interface DeleteAppInstanceCommandInput extends DeleteAppInstanceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAppInstanceCommand}.
13
17
  */
14
18
  export interface DeleteAppInstanceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an <code>AppInstance</code> and all associated data asynchronously.</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 DeleteAppInstanceCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteAppInstanceCommandInput - {@link DeleteAppInstanceCommandInput}
34
+ * @returns {@link DeleteAppInstanceCommandOutput}
28
35
  * @see {@link DeleteAppInstanceCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteAppInstanceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -55,11 +62,20 @@ export interface DeleteAppInstanceCommandOutput extends __MetadataBearer {
55
62
  export declare class DeleteAppInstanceCommand extends $Command<DeleteAppInstanceCommandInput, DeleteAppInstanceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
56
63
  readonly input: DeleteAppInstanceCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: DeleteAppInstanceCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAppInstanceCommandInput, DeleteAppInstanceCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { DeleteAppInstanceUserRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAppInstanceUserCommand}.
8
10
  */
9
11
  export interface DeleteAppInstanceUserCommandInput extends DeleteAppInstanceUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAppInstanceUserCommand}.
13
17
  */
14
18
  export interface DeleteAppInstanceUserCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an <code>AppInstanceUser</code>.</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 DeleteAppInstanceUserCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteAppInstanceUserCommandInput - {@link DeleteAppInstanceUserCommandInput}
34
+ * @returns {@link DeleteAppInstanceUserCommandOutput}
28
35
  * @see {@link DeleteAppInstanceUserCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteAppInstanceUserCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DeleteAppInstanceUserCommandOutput extends __MetadataBearer {
59
66
  export declare class DeleteAppInstanceUserCommand extends $Command<DeleteAppInstanceUserCommandInput, DeleteAppInstanceUserCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
60
67
  readonly input: DeleteAppInstanceUserCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DeleteAppInstanceUserCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAppInstanceUserCommandInput, DeleteAppInstanceUserCommandOutput>;
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 { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { DeregisterAppInstanceUserEndpointRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeregisterAppInstanceUserEndpointCommand}.
8
10
  */
9
11
  export interface DeregisterAppInstanceUserEndpointCommandInput extends DeregisterAppInstanceUserEndpointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeregisterAppInstanceUserEndpointCommand}.
13
17
  */
14
18
  export interface DeregisterAppInstanceUserEndpointCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deregisters an <code>AppInstanceUserEndpoint</code>.</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 DeregisterAppInstanceUserEndpointCommandOutput extends __Metada
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeregisterAppInstanceUserEndpointCommandInput - {@link DeregisterAppInstanceUserEndpointCommandInput}
34
+ * @returns {@link DeregisterAppInstanceUserEndpointCommandOutput}
28
35
  * @see {@link DeregisterAppInstanceUserEndpointCommandInput} for command's `input` shape.
29
36
  * @see {@link DeregisterAppInstanceUserEndpointCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeregisterAppInstanceUserEndpointCommandOutput extends __Metada
52
59
  export declare class DeregisterAppInstanceUserEndpointCommand extends $Command<DeregisterAppInstanceUserEndpointCommandInput, DeregisterAppInstanceUserEndpointCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
53
60
  readonly input: DeregisterAppInstanceUserEndpointCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeregisterAppInstanceUserEndpointCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeregisterAppInstanceUserEndpointCommandInput, DeregisterAppInstanceUserEndpointCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }