@aws-sdk/client-chime-sdk-identity 3.296.0 → 3.298.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 (118) hide show
  1. package/README.md +48 -0
  2. package/dist-cjs/ChimeSDKIdentity.js +90 -0
  3. package/dist-cjs/commands/CreateAppInstanceAdminCommand.js +1 -1
  4. package/dist-cjs/commands/CreateAppInstanceBotCommand.js +46 -0
  5. package/dist-cjs/commands/CreateAppInstanceCommand.js +1 -1
  6. package/dist-cjs/commands/CreateAppInstanceUserCommand.js +1 -1
  7. package/dist-cjs/commands/DeleteAppInstanceAdminCommand.js +2 -3
  8. package/dist-cjs/commands/DeleteAppInstanceBotCommand.js +45 -0
  9. package/dist-cjs/commands/DeleteAppInstanceCommand.js +2 -3
  10. package/dist-cjs/commands/DeleteAppInstanceUserCommand.js +2 -3
  11. package/dist-cjs/commands/DeregisterAppInstanceUserEndpointCommand.js +1 -1
  12. package/dist-cjs/commands/DescribeAppInstanceAdminCommand.js +1 -1
  13. package/dist-cjs/commands/DescribeAppInstanceBotCommand.js +46 -0
  14. package/dist-cjs/commands/DescribeAppInstanceCommand.js +1 -1
  15. package/dist-cjs/commands/DescribeAppInstanceUserCommand.js +1 -1
  16. package/dist-cjs/commands/GetAppInstanceRetentionSettingsCommand.js +2 -3
  17. package/dist-cjs/commands/ListAppInstanceBotsCommand.js +46 -0
  18. package/dist-cjs/commands/ListTagsForResourceCommand.js +1 -1
  19. package/dist-cjs/commands/PutAppInstanceRetentionSettingsCommand.js +2 -3
  20. package/dist-cjs/commands/PutAppInstanceUserExpirationSettingsCommand.js +45 -0
  21. package/dist-cjs/commands/TagResourceCommand.js +1 -1
  22. package/dist-cjs/commands/UntagResourceCommand.js +1 -1
  23. package/dist-cjs/commands/UpdateAppInstanceBotCommand.js +46 -0
  24. package/dist-cjs/commands/UpdateAppInstanceCommand.js +1 -1
  25. package/dist-cjs/commands/UpdateAppInstanceUserCommand.js +1 -1
  26. package/dist-cjs/commands/index.js +6 -0
  27. package/dist-cjs/endpoint/ruleset.js +3 -3
  28. package/dist-cjs/models/models_0.js +62 -77
  29. package/dist-cjs/pagination/ListAppInstanceBotsPaginator.js +29 -0
  30. package/dist-cjs/pagination/index.js +1 -0
  31. package/dist-cjs/protocols/Aws_restJson1.js +552 -1
  32. package/dist-es/ChimeSDKIdentity.js +90 -0
  33. package/dist-es/commands/CreateAppInstanceAdminCommand.js +2 -2
  34. package/dist-es/commands/CreateAppInstanceBotCommand.js +42 -0
  35. package/dist-es/commands/CreateAppInstanceCommand.js +2 -2
  36. package/dist-es/commands/CreateAppInstanceUserCommand.js +2 -2
  37. package/dist-es/commands/DeleteAppInstanceAdminCommand.js +2 -3
  38. package/dist-es/commands/DeleteAppInstanceBotCommand.js +41 -0
  39. package/dist-es/commands/DeleteAppInstanceCommand.js +2 -3
  40. package/dist-es/commands/DeleteAppInstanceUserCommand.js +2 -3
  41. package/dist-es/commands/DeregisterAppInstanceUserEndpointCommand.js +1 -1
  42. package/dist-es/commands/DescribeAppInstanceAdminCommand.js +2 -2
  43. package/dist-es/commands/DescribeAppInstanceBotCommand.js +42 -0
  44. package/dist-es/commands/DescribeAppInstanceCommand.js +2 -2
  45. package/dist-es/commands/DescribeAppInstanceUserCommand.js +2 -2
  46. package/dist-es/commands/GetAppInstanceRetentionSettingsCommand.js +2 -3
  47. package/dist-es/commands/ListAppInstanceBotsCommand.js +42 -0
  48. package/dist-es/commands/ListTagsForResourceCommand.js +2 -2
  49. package/dist-es/commands/PutAppInstanceRetentionSettingsCommand.js +2 -3
  50. package/dist-es/commands/PutAppInstanceUserExpirationSettingsCommand.js +41 -0
  51. package/dist-es/commands/TagResourceCommand.js +1 -1
  52. package/dist-es/commands/UntagResourceCommand.js +1 -1
  53. package/dist-es/commands/UpdateAppInstanceBotCommand.js +42 -0
  54. package/dist-es/commands/UpdateAppInstanceCommand.js +2 -2
  55. package/dist-es/commands/UpdateAppInstanceUserCommand.js +2 -2
  56. package/dist-es/commands/index.js +6 -0
  57. package/dist-es/endpoint/ruleset.js +3 -3
  58. package/dist-es/models/models_0.js +51 -55
  59. package/dist-es/pagination/ListAppInstanceBotsPaginator.js +25 -0
  60. package/dist-es/pagination/index.js +1 -0
  61. package/dist-es/protocols/Aws_restJson1.js +539 -1
  62. package/dist-types/ChimeSDKIdentity.d.ts +86 -6
  63. package/dist-types/ChimeSDKIdentityClient.d.ts +32 -6
  64. package/dist-types/commands/CreateAppInstanceAdminCommand.d.ts +20 -5
  65. package/dist-types/commands/CreateAppInstanceBotCommand.d.ts +86 -0
  66. package/dist-types/commands/CreateAppInstanceCommand.d.ts +16 -0
  67. package/dist-types/commands/CreateAppInstanceUserCommand.d.ts +16 -0
  68. package/dist-types/commands/DeleteAppInstanceAdminCommand.d.ts +18 -1
  69. package/dist-types/commands/DeleteAppInstanceBotCommand.d.ts +85 -0
  70. package/dist-types/commands/DeleteAppInstanceCommand.d.ts +16 -0
  71. package/dist-types/commands/DeleteAppInstanceUserCommand.d.ts +16 -0
  72. package/dist-types/commands/DeregisterAppInstanceUserEndpointCommand.d.ts +16 -0
  73. package/dist-types/commands/DescribeAppInstanceAdminCommand.d.ts +16 -0
  74. package/dist-types/commands/DescribeAppInstanceBotCommand.d.ts +81 -0
  75. package/dist-types/commands/DescribeAppInstanceCommand.d.ts +16 -0
  76. package/dist-types/commands/DescribeAppInstanceUserCommand.d.ts +16 -0
  77. package/dist-types/commands/DescribeAppInstanceUserEndpointCommand.d.ts +16 -0
  78. package/dist-types/commands/GetAppInstanceRetentionSettingsCommand.d.ts +16 -0
  79. package/dist-types/commands/ListAppInstanceAdminsCommand.d.ts +16 -0
  80. package/dist-types/commands/ListAppInstanceBotsCommand.d.ts +81 -0
  81. package/dist-types/commands/ListAppInstanceUserEndpointsCommand.d.ts +16 -0
  82. package/dist-types/commands/ListAppInstanceUsersCommand.d.ts +16 -0
  83. package/dist-types/commands/ListAppInstancesCommand.d.ts +16 -0
  84. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  85. package/dist-types/commands/PutAppInstanceRetentionSettingsCommand.d.ts +16 -0
  86. package/dist-types/commands/PutAppInstanceUserExpirationSettingsCommand.d.ts +88 -0
  87. package/dist-types/commands/RegisterAppInstanceUserEndpointCommand.d.ts +16 -0
  88. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  89. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  90. package/dist-types/commands/UpdateAppInstanceBotCommand.d.ts +85 -0
  91. package/dist-types/commands/UpdateAppInstanceCommand.d.ts +16 -0
  92. package/dist-types/commands/UpdateAppInstanceUserCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateAppInstanceUserEndpointCommand.d.ts +16 -0
  94. package/dist-types/commands/index.d.ts +6 -0
  95. package/dist-types/models/ChimeSDKIdentityServiceException.d.ts +2 -0
  96. package/dist-types/models/models_0.d.ts +465 -66
  97. package/dist-types/pagination/Interfaces.d.ts +3 -0
  98. package/dist-types/pagination/ListAppInstanceAdminsPaginator.d.ts +3 -0
  99. package/dist-types/pagination/ListAppInstanceBotsPaginator.d.ts +7 -0
  100. package/dist-types/pagination/ListAppInstanceUserEndpointsPaginator.d.ts +3 -0
  101. package/dist-types/pagination/ListAppInstanceUsersPaginator.d.ts +3 -0
  102. package/dist-types/pagination/ListAppInstancesPaginator.d.ts +3 -0
  103. package/dist-types/pagination/index.d.ts +1 -0
  104. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  105. package/dist-types/ts3.4/ChimeSDKIdentity.d.ts +108 -0
  106. package/dist-types/ts3.4/ChimeSDKIdentityClient.d.ts +36 -0
  107. package/dist-types/ts3.4/commands/CreateAppInstanceBotCommand.d.ts +41 -0
  108. package/dist-types/ts3.4/commands/DeleteAppInstanceBotCommand.d.ts +36 -0
  109. package/dist-types/ts3.4/commands/DescribeAppInstanceBotCommand.d.ts +41 -0
  110. package/dist-types/ts3.4/commands/ListAppInstanceBotsCommand.d.ts +38 -0
  111. package/dist-types/ts3.4/commands/PutAppInstanceUserExpirationSettingsCommand.d.ts +41 -0
  112. package/dist-types/ts3.4/commands/UpdateAppInstanceBotCommand.d.ts +41 -0
  113. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  114. package/dist-types/ts3.4/models/models_0.d.ts +106 -55
  115. package/dist-types/ts3.4/pagination/ListAppInstanceBotsPaginator.d.ts +11 -0
  116. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  117. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
  118. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { GetAppInstanceRetentionSettingsRequest, GetAppInstanceRetentionSettingsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAppInstanceRetentionSettingsCommand}.
8
10
  */
9
11
  export interface GetAppInstanceRetentionSettingsCommandInput extends GetAppInstanceRetentionSettingsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAppInstanceRetentionSettingsCommand}.
13
17
  */
14
18
  export interface GetAppInstanceRetentionSettingsCommandOutput extends GetAppInstanceRetentionSettingsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the retention settings for an <code>AppInstance</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 GetAppInstanceRetentionSettingsCommandOutput extends GetAppInst
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetAppInstanceRetentionSettingsCommandInput - {@link GetAppInstanceRetentionSettingsCommandInput}
34
+ * @returns {@link GetAppInstanceRetentionSettingsCommandOutput}
28
35
  * @see {@link GetAppInstanceRetentionSettingsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetAppInstanceRetentionSettingsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -52,11 +59,20 @@ export interface GetAppInstanceRetentionSettingsCommandOutput extends GetAppInst
52
59
  export declare class GetAppInstanceRetentionSettingsCommand extends $Command<GetAppInstanceRetentionSettingsCommandInput, GetAppInstanceRetentionSettingsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
53
60
  readonly input: GetAppInstanceRetentionSettingsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetAppInstanceRetentionSettingsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAppInstanceRetentionSettingsCommandInput, GetAppInstanceRetentionSettingsCommandOutput>;
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 { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { ListAppInstanceAdminsRequest, ListAppInstanceAdminsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAppInstanceAdminsCommand}.
8
10
  */
9
11
  export interface ListAppInstanceAdminsCommandInput extends ListAppInstanceAdminsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAppInstanceAdminsCommand}.
13
17
  */
14
18
  export interface ListAppInstanceAdminsCommandOutput extends ListAppInstanceAdminsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of the administrators in the <code>AppInstance</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 ListAppInstanceAdminsCommandOutput extends ListAppInstanceAdmin
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListAppInstanceAdminsCommandInput - {@link ListAppInstanceAdminsCommandInput}
34
+ * @returns {@link ListAppInstanceAdminsCommandOutput}
28
35
  * @see {@link ListAppInstanceAdminsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListAppInstanceAdminsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -55,11 +62,20 @@ export interface ListAppInstanceAdminsCommandOutput extends ListAppInstanceAdmin
55
62
  export declare class ListAppInstanceAdminsCommand extends $Command<ListAppInstanceAdminsCommandInput, ListAppInstanceAdminsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
56
63
  readonly input: ListAppInstanceAdminsCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: ListAppInstanceAdminsCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAppInstanceAdminsCommandInput, ListAppInstanceAdminsCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -0,0 +1,81 @@
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 { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
+ import { ListAppInstanceBotsRequest, ListAppInstanceBotsResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link ListAppInstanceBotsCommand}.
10
+ */
11
+ export interface ListAppInstanceBotsCommandInput extends ListAppInstanceBotsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link ListAppInstanceBotsCommand}.
17
+ */
18
+ export interface ListAppInstanceBotsCommandOutput extends ListAppInstanceBotsResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Lists all <code>AppInstanceBots</code> created under a single <code>AppInstance</code>.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { ChimeSDKIdentityClient, ListAppInstanceBotsCommand } from "@aws-sdk/client-chime-sdk-identity"; // ES Modules import
27
+ * // const { ChimeSDKIdentityClient, ListAppInstanceBotsCommand } = require("@aws-sdk/client-chime-sdk-identity"); // CommonJS import
28
+ * const client = new ChimeSDKIdentityClient(config);
29
+ * const command = new ListAppInstanceBotsCommand(input);
30
+ * const response = await client.send(command);
31
+ * ```
32
+ *
33
+ * @param ListAppInstanceBotsCommandInput - {@link ListAppInstanceBotsCommandInput}
34
+ * @returns {@link ListAppInstanceBotsCommandOutput}
35
+ * @see {@link ListAppInstanceBotsCommandInput} for command's `input` shape.
36
+ * @see {@link ListAppInstanceBotsCommandOutput} for command's `response` shape.
37
+ * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
38
+ *
39
+ * @throws {@link BadRequestException} (client fault)
40
+ * <p>The input parameters don't match the service's restrictions.</p>
41
+ *
42
+ * @throws {@link ForbiddenException} (client fault)
43
+ * <p>The client is permanently forbidden from making the request.</p>
44
+ *
45
+ * @throws {@link ResourceLimitExceededException} (client fault)
46
+ * <p>The request exceeds the resource limit.</p>
47
+ *
48
+ * @throws {@link ServiceFailureException} (server fault)
49
+ * <p>The service encountered an unexpected error.</p>
50
+ *
51
+ * @throws {@link ServiceUnavailableException} (server fault)
52
+ * <p>The service is currently unavailable.</p>
53
+ *
54
+ * @throws {@link ThrottledClientException} (client fault)
55
+ * <p>The client exceeded its request rate limit.</p>
56
+ *
57
+ * @throws {@link UnauthorizedClientException} (client fault)
58
+ * <p>The client is not currently authorized to make the request.</p>
59
+ *
60
+ *
61
+ */
62
+ export declare class ListAppInstanceBotsCommand extends $Command<ListAppInstanceBotsCommandInput, ListAppInstanceBotsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
63
+ readonly input: ListAppInstanceBotsCommandInput;
64
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
68
+ constructor(input: ListAppInstanceBotsCommandInput);
69
+ /**
70
+ * @internal
71
+ */
72
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAppInstanceBotsCommandInput, ListAppInstanceBotsCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
76
+ private serialize;
77
+ /**
78
+ * @internal
79
+ */
80
+ private deserialize;
81
+ }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { ListAppInstanceUserEndpointsRequest, ListAppInstanceUserEndpointsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAppInstanceUserEndpointsCommand}.
8
10
  */
9
11
  export interface ListAppInstanceUserEndpointsCommandInput extends ListAppInstanceUserEndpointsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAppInstanceUserEndpointsCommand}.
13
17
  */
14
18
  export interface ListAppInstanceUserEndpointsCommandOutput extends ListAppInstanceUserEndpointsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all the <code>AppInstanceUserEndpoints</code> created under a single <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 ListAppInstanceUserEndpointsCommandOutput extends ListAppInstan
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListAppInstanceUserEndpointsCommandInput - {@link ListAppInstanceUserEndpointsCommandInput}
34
+ * @returns {@link ListAppInstanceUserEndpointsCommandOutput}
28
35
  * @see {@link ListAppInstanceUserEndpointsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListAppInstanceUserEndpointsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListAppInstanceUserEndpointsCommandOutput extends ListAppInstan
52
59
  export declare class ListAppInstanceUserEndpointsCommand extends $Command<ListAppInstanceUserEndpointsCommandInput, ListAppInstanceUserEndpointsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
53
60
  readonly input: ListAppInstanceUserEndpointsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListAppInstanceUserEndpointsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAppInstanceUserEndpointsCommandInput, ListAppInstanceUserEndpointsCommandOutput>;
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 { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { ListAppInstanceUsersRequest, ListAppInstanceUsersResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAppInstanceUsersCommand}.
8
10
  */
9
11
  export interface ListAppInstanceUsersCommandInput extends ListAppInstanceUsersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAppInstanceUsersCommand}.
13
17
  */
14
18
  export interface ListAppInstanceUsersCommandOutput extends ListAppInstanceUsersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all <code>AppInstanceUsers</code> created under a single
18
23
  * <code>AppInstance</code>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListAppInstanceUsersCommandOutput extends ListAppInstanceUsersR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListAppInstanceUsersCommandInput - {@link ListAppInstanceUsersCommandInput}
35
+ * @returns {@link ListAppInstanceUsersCommandOutput}
29
36
  * @see {@link ListAppInstanceUsersCommandInput} for command's `input` shape.
30
37
  * @see {@link ListAppInstanceUsersCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -53,11 +60,20 @@ export interface ListAppInstanceUsersCommandOutput extends ListAppInstanceUsersR
53
60
  export declare class ListAppInstanceUsersCommand extends $Command<ListAppInstanceUsersCommandInput, ListAppInstanceUsersCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
54
61
  readonly input: ListAppInstanceUsersCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: ListAppInstanceUsersCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAppInstanceUsersCommandInput, ListAppInstanceUsersCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { ListAppInstancesRequest, ListAppInstancesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAppInstancesCommand}.
8
10
  */
9
11
  export interface ListAppInstancesCommandInput extends ListAppInstancesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAppInstancesCommand}.
13
17
  */
14
18
  export interface ListAppInstancesCommandOutput extends ListAppInstancesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS
18
23
  * account.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListAppInstancesCommandOutput extends ListAppInstancesResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListAppInstancesCommandInput - {@link ListAppInstancesCommandInput}
35
+ * @returns {@link ListAppInstancesCommandOutput}
29
36
  * @see {@link ListAppInstancesCommandInput} for command's `input` shape.
30
37
  * @see {@link ListAppInstancesCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -53,11 +60,20 @@ export interface ListAppInstancesCommandOutput extends ListAppInstancesResponse,
53
60
  export declare class ListAppInstancesCommand extends $Command<ListAppInstancesCommandInput, ListAppInstancesCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
54
61
  readonly input: ListAppInstancesCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: ListAppInstancesCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAppInstancesCommandInput, ListAppInstancesCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the tags applied to an Amazon Chime SDK identity resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
52
59
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
53
60
  readonly input: ListTagsForResourceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListTagsForResourceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
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 { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { PutAppInstanceRetentionSettingsRequest, PutAppInstanceRetentionSettingsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutAppInstanceRetentionSettingsCommand}.
8
10
  */
9
11
  export interface PutAppInstanceRetentionSettingsCommandInput extends PutAppInstanceRetentionSettingsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutAppInstanceRetentionSettingsCommand}.
13
17
  */
14
18
  export interface PutAppInstanceRetentionSettingsCommandOutput extends PutAppInstanceRetentionSettingsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sets the amount of time in days that a given <code>AppInstance</code> retains
18
23
  * data.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface PutAppInstanceRetentionSettingsCommandOutput extends PutAppInst
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param PutAppInstanceRetentionSettingsCommandInput - {@link PutAppInstanceRetentionSettingsCommandInput}
35
+ * @returns {@link PutAppInstanceRetentionSettingsCommandOutput}
29
36
  * @see {@link PutAppInstanceRetentionSettingsCommandInput} for command's `input` shape.
30
37
  * @see {@link PutAppInstanceRetentionSettingsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -53,11 +60,20 @@ export interface PutAppInstanceRetentionSettingsCommandOutput extends PutAppInst
53
60
  export declare class PutAppInstanceRetentionSettingsCommand extends $Command<PutAppInstanceRetentionSettingsCommandInput, PutAppInstanceRetentionSettingsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
54
61
  readonly input: PutAppInstanceRetentionSettingsCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: PutAppInstanceRetentionSettingsCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAppInstanceRetentionSettingsCommandInput, PutAppInstanceRetentionSettingsCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -0,0 +1,88 @@
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 { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
+ import { PutAppInstanceUserExpirationSettingsRequest, PutAppInstanceUserExpirationSettingsResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link PutAppInstanceUserExpirationSettingsCommand}.
10
+ */
11
+ export interface PutAppInstanceUserExpirationSettingsCommandInput extends PutAppInstanceUserExpirationSettingsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link PutAppInstanceUserExpirationSettingsCommand}.
17
+ */
18
+ export interface PutAppInstanceUserExpirationSettingsCommandOutput extends PutAppInstanceUserExpirationSettingsResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Sets the number of days before the <code>AppInstanceUser</code> is automatically deleted.</p>
23
+ * <note>
24
+ * <p>A background process deletes expired <code>AppInstanceUsers</code> within 6 hours of expiration.
25
+ * Actual deletion times may vary.</p>
26
+ * <p>Expired <code>AppInstanceUsers</code> that have not yet been deleted appear as active, and you can update
27
+ * their expiration settings. The system honors the new settings.</p>
28
+ * </note>
29
+ * @example
30
+ * Use a bare-bones client and the command you need to make an API call.
31
+ * ```javascript
32
+ * import { ChimeSDKIdentityClient, PutAppInstanceUserExpirationSettingsCommand } from "@aws-sdk/client-chime-sdk-identity"; // ES Modules import
33
+ * // const { ChimeSDKIdentityClient, PutAppInstanceUserExpirationSettingsCommand } = require("@aws-sdk/client-chime-sdk-identity"); // CommonJS import
34
+ * const client = new ChimeSDKIdentityClient(config);
35
+ * const command = new PutAppInstanceUserExpirationSettingsCommand(input);
36
+ * const response = await client.send(command);
37
+ * ```
38
+ *
39
+ * @param PutAppInstanceUserExpirationSettingsCommandInput - {@link PutAppInstanceUserExpirationSettingsCommandInput}
40
+ * @returns {@link PutAppInstanceUserExpirationSettingsCommandOutput}
41
+ * @see {@link PutAppInstanceUserExpirationSettingsCommandInput} for command's `input` shape.
42
+ * @see {@link PutAppInstanceUserExpirationSettingsCommandOutput} for command's `response` shape.
43
+ * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
44
+ *
45
+ * @throws {@link BadRequestException} (client fault)
46
+ * <p>The input parameters don't match the service's restrictions.</p>
47
+ *
48
+ * @throws {@link ConflictException} (client fault)
49
+ * <p>The request could not be processed because of conflict in the current state of the
50
+ * resource.</p>
51
+ *
52
+ * @throws {@link ForbiddenException} (client fault)
53
+ * <p>The client is permanently forbidden from making the request.</p>
54
+ *
55
+ * @throws {@link ServiceFailureException} (server fault)
56
+ * <p>The service encountered an unexpected error.</p>
57
+ *
58
+ * @throws {@link ServiceUnavailableException} (server fault)
59
+ * <p>The service is currently unavailable.</p>
60
+ *
61
+ * @throws {@link ThrottledClientException} (client fault)
62
+ * <p>The client exceeded its request rate limit.</p>
63
+ *
64
+ * @throws {@link UnauthorizedClientException} (client fault)
65
+ * <p>The client is not currently authorized to make the request.</p>
66
+ *
67
+ *
68
+ */
69
+ export declare class PutAppInstanceUserExpirationSettingsCommand extends $Command<PutAppInstanceUserExpirationSettingsCommandInput, PutAppInstanceUserExpirationSettingsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
70
+ readonly input: PutAppInstanceUserExpirationSettingsCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
75
+ constructor(input: PutAppInstanceUserExpirationSettingsCommandInput);
76
+ /**
77
+ * @internal
78
+ */
79
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAppInstanceUserExpirationSettingsCommandInput, PutAppInstanceUserExpirationSettingsCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
83
+ private serialize;
84
+ /**
85
+ * @internal
86
+ */
87
+ private deserialize;
88
+ }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKIdentityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKIdentityClient";
5
5
  import { RegisterAppInstanceUserEndpointRequest, RegisterAppInstanceUserEndpointResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RegisterAppInstanceUserEndpointCommand}.
8
10
  */
9
11
  export interface RegisterAppInstanceUserEndpointCommandInput extends RegisterAppInstanceUserEndpointRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RegisterAppInstanceUserEndpointCommand}.
13
17
  */
14
18
  export interface RegisterAppInstanceUserEndpointCommandOutput extends RegisterAppInstanceUserEndpointResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <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>
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 RegisterAppInstanceUserEndpointCommandOutput extends RegisterAp
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RegisterAppInstanceUserEndpointCommandInput - {@link RegisterAppInstanceUserEndpointCommandInput}
34
+ * @returns {@link RegisterAppInstanceUserEndpointCommandOutput}
28
35
  * @see {@link RegisterAppInstanceUserEndpointCommandInput} for command's `input` shape.
29
36
  * @see {@link RegisterAppInstanceUserEndpointCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -59,11 +66,20 @@ export interface RegisterAppInstanceUserEndpointCommandOutput extends RegisterAp
59
66
  export declare class RegisterAppInstanceUserEndpointCommand extends $Command<RegisterAppInstanceUserEndpointCommandInput, RegisterAppInstanceUserEndpointCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
60
67
  readonly input: RegisterAppInstanceUserEndpointCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: RegisterAppInstanceUserEndpointCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterAppInstanceUserEndpointCommandInput, RegisterAppInstanceUserEndpointCommandOutput>;
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 { TagResourceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Applies the specified tags to the specified Amazon Chime SDK identity resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKIdentityClientResolvedConfig | config} for ChimeSDKIdentityClient's `config` shape.
@@ -55,11 +62,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
55
62
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
56
63
  readonly input: TagResourceCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: TagResourceCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKIdentityClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }