@aws-sdk/client-chime-sdk-identity 3.325.0 → 3.327.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 (31) hide show
  1. package/dist-types/commands/CreateAppInstanceAdminCommand.d.ts +10 -0
  2. package/dist-types/commands/CreateAppInstanceBotCommand.d.ts +6 -0
  3. package/dist-types/commands/CreateAppInstanceCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateAppInstanceUserCommand.d.ts +6 -0
  5. package/dist-types/commands/DeleteAppInstanceAdminCommand.d.ts +4 -0
  6. package/dist-types/commands/DeleteAppInstanceBotCommand.d.ts +4 -0
  7. package/dist-types/commands/DeleteAppInstanceCommand.d.ts +4 -0
  8. package/dist-types/commands/DeleteAppInstanceUserCommand.d.ts +4 -0
  9. package/dist-types/commands/DeregisterAppInstanceUserEndpointCommand.d.ts +4 -0
  10. package/dist-types/commands/DescribeAppInstanceAdminCommand.d.ts +13 -0
  11. package/dist-types/commands/DescribeAppInstanceBotCommand.d.ts +20 -0
  12. package/dist-types/commands/DescribeAppInstanceCommand.d.ts +12 -0
  13. package/dist-types/commands/DescribeAppInstanceUserCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeAppInstanceUserEndpointCommand.d.ts +23 -0
  15. package/dist-types/commands/GetAppInstanceRetentionSettingsCommand.d.ts +11 -0
  16. package/dist-types/commands/ListAppInstanceAdminsCommand.d.ts +15 -0
  17. package/dist-types/commands/ListAppInstanceBotsCommand.d.ts +14 -0
  18. package/dist-types/commands/ListAppInstanceUserEndpointsCommand.d.ts +19 -0
  19. package/dist-types/commands/ListAppInstanceUsersCommand.d.ts +14 -0
  20. package/dist-types/commands/ListAppInstancesCommand.d.ts +13 -0
  21. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  22. package/dist-types/commands/PutAppInstanceRetentionSettingsCommand.d.ts +11 -0
  23. package/dist-types/commands/PutAppInstanceUserExpirationSettingsCommand.d.ts +10 -0
  24. package/dist-types/commands/RegisterAppInstanceUserEndpointCommand.d.ts +7 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  27. package/dist-types/commands/UpdateAppInstanceBotCommand.d.ts +6 -0
  28. package/dist-types/commands/UpdateAppInstanceCommand.d.ts +6 -0
  29. package/dist-types/commands/UpdateAppInstanceUserCommand.d.ts +6 -0
  30. package/dist-types/commands/UpdateAppInstanceUserEndpointCommand.d.ts +7 -0
  31. package/package.json +7 -7
@@ -47,6 +47,14 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd
47
47
  * };
48
48
  * const command = new CreateAppInstanceAdminCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // CreateAppInstanceAdminResponse
51
+ * // AppInstanceAdmin: { // Identity
52
+ * // Arn: "STRING_VALUE",
53
+ * // Name: "STRING_VALUE",
54
+ * // },
55
+ * // AppInstanceArn: "STRING_VALUE",
56
+ * // };
57
+ *
50
58
  * ```
51
59
  *
52
60
  * @param CreateAppInstanceAdminCommandInput - {@link CreateAppInstanceAdminCommandInput}
@@ -80,6 +88,8 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd
80
88
  * @throws {@link UnauthorizedClientException} (client fault)
81
89
  * <p>The client is not currently authorized to make the request.</p>
82
90
  *
91
+ * @throws {@link ChimeSDKIdentityServiceException}
92
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
83
93
  *
84
94
  */
85
95
  export declare class CreateAppInstanceAdminCommand extends $Command<CreateAppInstanceAdminCommandInput, CreateAppInstanceAdminCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -49,6 +49,10 @@ export interface CreateAppInstanceBotCommandOutput extends CreateAppInstanceBotR
49
49
  * };
50
50
  * const command = new CreateAppInstanceBotCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // CreateAppInstanceBotResponse
53
+ * // AppInstanceBotArn: "STRING_VALUE",
54
+ * // };
55
+ *
52
56
  * ```
53
57
  *
54
58
  * @param CreateAppInstanceBotCommandInput - {@link CreateAppInstanceBotCommandInput}
@@ -82,6 +86,8 @@ export interface CreateAppInstanceBotCommandOutput extends CreateAppInstanceBotR
82
86
  * @throws {@link UnauthorizedClientException} (client fault)
83
87
  * <p>The client is not currently authorized to make the request.</p>
84
88
  *
89
+ * @throws {@link ChimeSDKIdentityServiceException}
90
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
85
91
  *
86
92
  */
87
93
  export declare class CreateAppInstanceBotCommand extends $Command<CreateAppInstanceBotCommandInput, CreateAppInstanceBotCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -42,6 +42,10 @@ export interface CreateAppInstanceCommandOutput extends CreateAppInstanceRespons
42
42
  * };
43
43
  * const command = new CreateAppInstanceCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // CreateAppInstanceResponse
46
+ * // AppInstanceArn: "STRING_VALUE",
47
+ * // };
48
+ *
45
49
  * ```
46
50
  *
47
51
  * @param CreateAppInstanceCommandInput - {@link CreateAppInstanceCommandInput}
@@ -75,6 +79,8 @@ export interface CreateAppInstanceCommandOutput extends CreateAppInstanceRespons
75
79
  * @throws {@link UnauthorizedClientException} (client fault)
76
80
  * <p>The client is not currently authorized to make the request.</p>
77
81
  *
82
+ * @throws {@link ChimeSDKIdentityServiceException}
83
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
78
84
  *
79
85
  */
80
86
  export declare class CreateAppInstanceCommand extends $Command<CreateAppInstanceCommandInput, CreateAppInstanceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -46,6 +46,10 @@ export interface CreateAppInstanceUserCommandOutput extends CreateAppInstanceUse
46
46
  * };
47
47
  * const command = new CreateAppInstanceUserCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // CreateAppInstanceUserResponse
50
+ * // AppInstanceUserArn: "STRING_VALUE",
51
+ * // };
52
+ *
49
53
  * ```
50
54
  *
51
55
  * @param CreateAppInstanceUserCommandInput - {@link CreateAppInstanceUserCommandInput}
@@ -79,6 +83,8 @@ export interface CreateAppInstanceUserCommandOutput extends CreateAppInstanceUse
79
83
  * @throws {@link UnauthorizedClientException} (client fault)
80
84
  * <p>The client is not currently authorized to make the request.</p>
81
85
  *
86
+ * @throws {@link ChimeSDKIdentityServiceException}
87
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
82
88
  *
83
89
  */
84
90
  export declare class CreateAppInstanceUserCommand extends $Command<CreateAppInstanceUserCommandInput, CreateAppInstanceUserCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteAppInstanceAdminCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new DeleteAppInstanceAdminCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteAppInstanceAdminCommandInput - {@link DeleteAppInstanceAdminCommandInput}
@@ -67,6 +69,8 @@ export interface DeleteAppInstanceAdminCommandOutput extends __MetadataBearer {
67
69
  * @throws {@link UnauthorizedClientException} (client fault)
68
70
  * <p>The client is not currently authorized to make the request.</p>
69
71
  *
72
+ * @throws {@link ChimeSDKIdentityServiceException}
73
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
70
74
  *
71
75
  */
72
76
  export declare class DeleteAppInstanceAdminCommand extends $Command<DeleteAppInstanceAdminCommandInput, DeleteAppInstanceAdminCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteAppInstanceBotCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteAppInstanceBotCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteAppInstanceBotCommandInput - {@link DeleteAppInstanceBotCommandInput}
@@ -64,6 +66,8 @@ export interface DeleteAppInstanceBotCommandOutput extends __MetadataBearer {
64
66
  * @throws {@link UnauthorizedClientException} (client fault)
65
67
  * <p>The client is not currently authorized to make the request.</p>
66
68
  *
69
+ * @throws {@link ChimeSDKIdentityServiceException}
70
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
67
71
  *
68
72
  */
69
73
  export declare class DeleteAppInstanceBotCommand extends $Command<DeleteAppInstanceBotCommandInput, DeleteAppInstanceBotCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteAppInstanceCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteAppInstanceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteAppInstanceCommandInput - {@link DeleteAppInstanceCommandInput}
@@ -60,6 +62,8 @@ export interface DeleteAppInstanceCommandOutput extends __MetadataBearer {
60
62
  * @throws {@link UnauthorizedClientException} (client fault)
61
63
  * <p>The client is not currently authorized to make the request.</p>
62
64
  *
65
+ * @throws {@link ChimeSDKIdentityServiceException}
66
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
63
67
  *
64
68
  */
65
69
  export declare class DeleteAppInstanceCommand extends $Command<DeleteAppInstanceCommandInput, DeleteAppInstanceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteAppInstanceUserCommandOutput extends __MetadataBearer {
31
31
  * };
32
32
  * const command = new DeleteAppInstanceUserCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteAppInstanceUserCommandInput - {@link DeleteAppInstanceUserCommandInput}
@@ -64,6 +66,8 @@ export interface DeleteAppInstanceUserCommandOutput extends __MetadataBearer {
64
66
  * @throws {@link UnauthorizedClientException} (client fault)
65
67
  * <p>The client is not currently authorized to make the request.</p>
66
68
  *
69
+ * @throws {@link ChimeSDKIdentityServiceException}
70
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
67
71
  *
68
72
  */
69
73
  export declare class DeleteAppInstanceUserCommand extends $Command<DeleteAppInstanceUserCommandInput, DeleteAppInstanceUserCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeregisterAppInstanceUserEndpointCommandOutput extends __Metada
32
32
  * };
33
33
  * const command = new DeregisterAppInstanceUserEndpointCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeregisterAppInstanceUserEndpointCommandInput - {@link DeregisterAppInstanceUserEndpointCommandInput}
@@ -58,6 +60,8 @@ export interface DeregisterAppInstanceUserEndpointCommandOutput extends __Metada
58
60
  * @throws {@link UnauthorizedClientException} (client fault)
59
61
  * <p>The client is not currently authorized to make the request.</p>
60
62
  *
63
+ * @throws {@link ChimeSDKIdentityServiceException}
64
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeregisterAppInstanceUserEndpointCommand extends $Command<DeregisterAppInstanceUserEndpointCommandInput, DeregisterAppInstanceUserEndpointCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface DescribeAppInstanceAdminCommandOutput extends DescribeAppInstan
32
32
  * };
33
33
  * const command = new DescribeAppInstanceAdminCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeAppInstanceAdminResponse
36
+ * // AppInstanceAdmin: { // AppInstanceAdmin
37
+ * // Admin: { // Identity
38
+ * // Arn: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // },
41
+ * // AppInstanceArn: "STRING_VALUE",
42
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
43
+ * // },
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param DescribeAppInstanceAdminCommandInput - {@link DescribeAppInstanceAdminCommandInput}
@@ -58,6 +69,8 @@ export interface DescribeAppInstanceAdminCommandOutput extends DescribeAppInstan
58
69
  * @throws {@link UnauthorizedClientException} (client fault)
59
70
  * <p>The client is not currently authorized to make the request.</p>
60
71
  *
72
+ * @throws {@link ChimeSDKIdentityServiceException}
73
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
61
74
  *
62
75
  */
63
76
  export declare class DescribeAppInstanceAdminCommand extends $Command<DescribeAppInstanceAdminCommandInput, DescribeAppInstanceAdminCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,24 @@ export interface DescribeAppInstanceBotCommandOutput extends DescribeAppInstance
31
31
  * };
32
32
  * const command = new DescribeAppInstanceBotCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeAppInstanceBotResponse
35
+ * // AppInstanceBot: { // AppInstanceBot
36
+ * // AppInstanceBotArn: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // Configuration: { // Configuration
39
+ * // Lex: { // LexConfiguration
40
+ * // RespondsTo: "STANDARD_MESSAGES", // required
41
+ * // LexBotAliasArn: "STRING_VALUE", // required
42
+ * // LocaleId: "STRING_VALUE", // required
43
+ * // WelcomeIntent: "STRING_VALUE",
44
+ * // },
45
+ * // },
46
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
47
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
48
+ * // Metadata: "STRING_VALUE",
49
+ * // },
50
+ * // };
51
+ *
34
52
  * ```
35
53
  *
36
54
  * @param DescribeAppInstanceBotCommandInput - {@link DescribeAppInstanceBotCommandInput}
@@ -60,6 +78,8 @@ export interface DescribeAppInstanceBotCommandOutput extends DescribeAppInstance
60
78
  * @throws {@link UnauthorizedClientException} (client fault)
61
79
  * <p>The client is not currently authorized to make the request.</p>
62
80
  *
81
+ * @throws {@link ChimeSDKIdentityServiceException}
82
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
63
83
  *
64
84
  */
65
85
  export declare class DescribeAppInstanceBotCommand extends $Command<DescribeAppInstanceBotCommandInput, DescribeAppInstanceBotCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,16 @@ export interface DescribeAppInstanceCommandOutput extends DescribeAppInstanceRes
31
31
  * };
32
32
  * const command = new DescribeAppInstanceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeAppInstanceResponse
35
+ * // AppInstance: { // AppInstance
36
+ * // AppInstanceArn: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
39
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
40
+ * // Metadata: "STRING_VALUE",
41
+ * // },
42
+ * // };
43
+ *
34
44
  * ```
35
45
  *
36
46
  * @param DescribeAppInstanceCommandInput - {@link DescribeAppInstanceCommandInput}
@@ -57,6 +67,8 @@ export interface DescribeAppInstanceCommandOutput extends DescribeAppInstanceRes
57
67
  * @throws {@link UnauthorizedClientException} (client fault)
58
68
  * <p>The client is not currently authorized to make the request.</p>
59
69
  *
70
+ * @throws {@link ChimeSDKIdentityServiceException}
71
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
60
72
  *
61
73
  */
62
74
  export declare class DescribeAppInstanceCommand extends $Command<DescribeAppInstanceCommandInput, DescribeAppInstanceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,20 @@ export interface DescribeAppInstanceUserCommandOutput extends DescribeAppInstanc
31
31
  * };
32
32
  * const command = new DescribeAppInstanceUserCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeAppInstanceUserResponse
35
+ * // AppInstanceUser: { // AppInstanceUser
36
+ * // AppInstanceUserArn: "STRING_VALUE",
37
+ * // Name: "STRING_VALUE",
38
+ * // Metadata: "STRING_VALUE",
39
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
40
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
41
+ * // ExpirationSettings: { // ExpirationSettings
42
+ * // ExpirationDays: Number("int"), // required
43
+ * // ExpirationCriterion: "CREATED_TIMESTAMP", // required
44
+ * // },
45
+ * // },
46
+ * // };
47
+ *
34
48
  * ```
35
49
  *
36
50
  * @param DescribeAppInstanceUserCommandInput - {@link DescribeAppInstanceUserCommandInput}
@@ -57,6 +71,8 @@ export interface DescribeAppInstanceUserCommandOutput extends DescribeAppInstanc
57
71
  * @throws {@link UnauthorizedClientException} (client fault)
58
72
  * <p>The client is not currently authorized to make the request.</p>
59
73
  *
74
+ * @throws {@link ChimeSDKIdentityServiceException}
75
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
60
76
  *
61
77
  */
62
78
  export declare class DescribeAppInstanceUserCommand extends $Command<DescribeAppInstanceUserCommandInput, DescribeAppInstanceUserCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -32,6 +32,27 @@ export interface DescribeAppInstanceUserEndpointCommandOutput extends DescribeAp
32
32
  * };
33
33
  * const command = new DescribeAppInstanceUserEndpointCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeAppInstanceUserEndpointResponse
36
+ * // AppInstanceUserEndpoint: { // AppInstanceUserEndpoint
37
+ * // AppInstanceUserArn: "STRING_VALUE",
38
+ * // EndpointId: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // Type: "APNS" || "APNS_SANDBOX" || "GCM",
41
+ * // ResourceArn: "STRING_VALUE",
42
+ * // EndpointAttributes: { // EndpointAttributes
43
+ * // DeviceToken: "STRING_VALUE", // required
44
+ * // VoipDeviceToken: "STRING_VALUE",
45
+ * // },
46
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
47
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
48
+ * // AllowMessages: "ALL" || "NONE",
49
+ * // EndpointState: { // EndpointState
50
+ * // Status: "ACTIVE" || "INACTIVE", // required
51
+ * // StatusReason: "INVALID_DEVICE_TOKEN" || "INVALID_PINPOINT_ARN",
52
+ * // },
53
+ * // },
54
+ * // };
55
+ *
35
56
  * ```
36
57
  *
37
58
  * @param DescribeAppInstanceUserEndpointCommandInput - {@link DescribeAppInstanceUserEndpointCommandInput}
@@ -58,6 +79,8 @@ export interface DescribeAppInstanceUserEndpointCommandOutput extends DescribeAp
58
79
  * @throws {@link UnauthorizedClientException} (client fault)
59
80
  * <p>The client is not currently authorized to make the request.</p>
60
81
  *
82
+ * @throws {@link ChimeSDKIdentityServiceException}
83
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
61
84
  *
62
85
  */
63
86
  export declare class DescribeAppInstanceUserEndpointCommand extends $Command<DescribeAppInstanceUserEndpointCommandInput, DescribeAppInstanceUserEndpointCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,15 @@ export interface GetAppInstanceRetentionSettingsCommandOutput extends GetAppInst
31
31
  * };
32
32
  * const command = new GetAppInstanceRetentionSettingsCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetAppInstanceRetentionSettingsResponse
35
+ * // AppInstanceRetentionSettings: { // AppInstanceRetentionSettings
36
+ * // ChannelRetentionSettings: { // ChannelRetentionSettings
37
+ * // RetentionDays: Number("int"),
38
+ * // },
39
+ * // },
40
+ * // InitiateDeletionTimestamp: new Date("TIMESTAMP"),
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param GetAppInstanceRetentionSettingsCommandInput - {@link GetAppInstanceRetentionSettingsCommandInput}
@@ -57,6 +66,8 @@ export interface GetAppInstanceRetentionSettingsCommandOutput extends GetAppInst
57
66
  * @throws {@link UnauthorizedClientException} (client fault)
58
67
  * <p>The client is not currently authorized to make the request.</p>
59
68
  *
69
+ * @throws {@link ChimeSDKIdentityServiceException}
70
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
60
71
  *
61
72
  */
62
73
  export declare class GetAppInstanceRetentionSettingsCommand extends $Command<GetAppInstanceRetentionSettingsCommandInput, GetAppInstanceRetentionSettingsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -33,6 +33,19 @@ export interface ListAppInstanceAdminsCommandOutput extends ListAppInstanceAdmin
33
33
  * };
34
34
  * const command = new ListAppInstanceAdminsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListAppInstanceAdminsResponse
37
+ * // AppInstanceArn: "STRING_VALUE",
38
+ * // AppInstanceAdmins: [ // AppInstanceAdminList
39
+ * // { // AppInstanceAdminSummary
40
+ * // Admin: { // Identity
41
+ * // Arn: "STRING_VALUE",
42
+ * // Name: "STRING_VALUE",
43
+ * // },
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
36
49
  * ```
37
50
  *
38
51
  * @param ListAppInstanceAdminsCommandInput - {@link ListAppInstanceAdminsCommandInput}
@@ -62,6 +75,8 @@ export interface ListAppInstanceAdminsCommandOutput extends ListAppInstanceAdmin
62
75
  * @throws {@link UnauthorizedClientException} (client fault)
63
76
  * <p>The client is not currently authorized to make the request.</p>
64
77
  *
78
+ * @throws {@link ChimeSDKIdentityServiceException}
79
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
65
80
  *
66
81
  */
67
82
  export declare class ListAppInstanceAdminsCommand extends $Command<ListAppInstanceAdminsCommandInput, ListAppInstanceAdminsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -33,6 +33,18 @@ export interface ListAppInstanceBotsCommandOutput extends ListAppInstanceBotsRes
33
33
  * };
34
34
  * const command = new ListAppInstanceBotsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListAppInstanceBotsResponse
37
+ * // AppInstanceArn: "STRING_VALUE",
38
+ * // AppInstanceBots: [ // AppInstanceBotList
39
+ * // { // AppInstanceBotSummary
40
+ * // AppInstanceBotArn: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Metadata: "STRING_VALUE",
43
+ * // },
44
+ * // ],
45
+ * // NextToken: "STRING_VALUE",
46
+ * // };
47
+ *
36
48
  * ```
37
49
  *
38
50
  * @param ListAppInstanceBotsCommandInput - {@link ListAppInstanceBotsCommandInput}
@@ -62,6 +74,8 @@ export interface ListAppInstanceBotsCommandOutput extends ListAppInstanceBotsRes
62
74
  * @throws {@link UnauthorizedClientException} (client fault)
63
75
  * <p>The client is not currently authorized to make the request.</p>
64
76
  *
77
+ * @throws {@link ChimeSDKIdentityServiceException}
78
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
65
79
  *
66
80
  */
67
81
  export declare class ListAppInstanceBotsCommand extends $Command<ListAppInstanceBotsCommandInput, ListAppInstanceBotsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -33,6 +33,23 @@ export interface ListAppInstanceUserEndpointsCommandOutput extends ListAppInstan
33
33
  * };
34
34
  * const command = new ListAppInstanceUserEndpointsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListAppInstanceUserEndpointsResponse
37
+ * // AppInstanceUserEndpoints: [ // AppInstanceUserEndpointSummaryList
38
+ * // { // AppInstanceUserEndpointSummary
39
+ * // AppInstanceUserArn: "STRING_VALUE",
40
+ * // EndpointId: "STRING_VALUE",
41
+ * // Name: "STRING_VALUE",
42
+ * // Type: "APNS" || "APNS_SANDBOX" || "GCM",
43
+ * // AllowMessages: "ALL" || "NONE",
44
+ * // EndpointState: { // EndpointState
45
+ * // Status: "ACTIVE" || "INACTIVE", // required
46
+ * // StatusReason: "INVALID_DEVICE_TOKEN" || "INVALID_PINPOINT_ARN",
47
+ * // },
48
+ * // },
49
+ * // ],
50
+ * // NextToken: "STRING_VALUE",
51
+ * // };
52
+ *
36
53
  * ```
37
54
  *
38
55
  * @param ListAppInstanceUserEndpointsCommandInput - {@link ListAppInstanceUserEndpointsCommandInput}
@@ -59,6 +76,8 @@ export interface ListAppInstanceUserEndpointsCommandOutput extends ListAppInstan
59
76
  * @throws {@link UnauthorizedClientException} (client fault)
60
77
  * <p>The client is not currently authorized to make the request.</p>
61
78
  *
79
+ * @throws {@link ChimeSDKIdentityServiceException}
80
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
62
81
  *
63
82
  */
64
83
  export declare class ListAppInstanceUserEndpointsCommand extends $Command<ListAppInstanceUserEndpointsCommandInput, ListAppInstanceUserEndpointsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -34,6 +34,18 @@ export interface ListAppInstanceUsersCommandOutput extends ListAppInstanceUsersR
34
34
  * };
35
35
  * const command = new ListAppInstanceUsersCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListAppInstanceUsersResponse
38
+ * // AppInstanceArn: "STRING_VALUE",
39
+ * // AppInstanceUsers: [ // AppInstanceUserList
40
+ * // { // AppInstanceUserSummary
41
+ * // AppInstanceUserArn: "STRING_VALUE",
42
+ * // Name: "STRING_VALUE",
43
+ * // Metadata: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // NextToken: "STRING_VALUE",
47
+ * // };
48
+ *
37
49
  * ```
38
50
  *
39
51
  * @param ListAppInstanceUsersCommandInput - {@link ListAppInstanceUsersCommandInput}
@@ -60,6 +72,8 @@ export interface ListAppInstanceUsersCommandOutput extends ListAppInstanceUsersR
60
72
  * @throws {@link UnauthorizedClientException} (client fault)
61
73
  * <p>The client is not currently authorized to make the request.</p>
62
74
  *
75
+ * @throws {@link ChimeSDKIdentityServiceException}
76
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
63
77
  *
64
78
  */
65
79
  export declare class ListAppInstanceUsersCommand extends $Command<ListAppInstanceUsersCommandInput, ListAppInstanceUsersCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface ListAppInstancesCommandOutput extends ListAppInstancesResponse,
33
33
  * };
34
34
  * const command = new ListAppInstancesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListAppInstancesResponse
37
+ * // AppInstances: [ // AppInstanceList
38
+ * // { // AppInstanceSummary
39
+ * // AppInstanceArn: "STRING_VALUE",
40
+ * // Name: "STRING_VALUE",
41
+ * // Metadata: "STRING_VALUE",
42
+ * // },
43
+ * // ],
44
+ * // NextToken: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param ListAppInstancesCommandInput - {@link ListAppInstancesCommandInput}
@@ -59,6 +70,8 @@ export interface ListAppInstancesCommandOutput extends ListAppInstancesResponse,
59
70
  * @throws {@link UnauthorizedClientException} (client fault)
60
71
  * <p>The client is not currently authorized to make the request.</p>
61
72
  *
73
+ * @throws {@link ChimeSDKIdentityServiceException}
74
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
62
75
  *
63
76
  */
64
77
  export declare class ListAppInstancesCommand extends $Command<ListAppInstancesCommandInput, ListAppInstancesCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -31,6 +31,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // Tags: [ // TagList
36
+ * // { // Tag
37
+ * // Key: "STRING_VALUE", // required
38
+ * // Value: "STRING_VALUE", // required
39
+ * // },
40
+ * // ],
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -57,6 +66,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
57
66
  * @throws {@link UnauthorizedClientException} (client fault)
58
67
  * <p>The client is not currently authorized to make the request.</p>
59
68
  *
69
+ * @throws {@link ChimeSDKIdentityServiceException}
70
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
60
71
  *
61
72
  */
62
73
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -37,6 +37,15 @@ export interface PutAppInstanceRetentionSettingsCommandOutput extends PutAppInst
37
37
  * };
38
38
  * const command = new PutAppInstanceRetentionSettingsCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // PutAppInstanceRetentionSettingsResponse
41
+ * // AppInstanceRetentionSettings: { // AppInstanceRetentionSettings
42
+ * // ChannelRetentionSettings: { // ChannelRetentionSettings
43
+ * // RetentionDays: Number("int"),
44
+ * // },
45
+ * // },
46
+ * // InitiateDeletionTimestamp: new Date("TIMESTAMP"),
47
+ * // };
48
+ *
40
49
  * ```
41
50
  *
42
51
  * @param PutAppInstanceRetentionSettingsCommandInput - {@link PutAppInstanceRetentionSettingsCommandInput}
@@ -63,6 +72,8 @@ export interface PutAppInstanceRetentionSettingsCommandOutput extends PutAppInst
63
72
  * @throws {@link UnauthorizedClientException} (client fault)
64
73
  * <p>The client is not currently authorized to make the request.</p>
65
74
  *
75
+ * @throws {@link ChimeSDKIdentityServiceException}
76
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
66
77
  *
67
78
  */
68
79
  export declare class PutAppInstanceRetentionSettingsCommand extends $Command<PutAppInstanceRetentionSettingsCommandInput, PutAppInstanceRetentionSettingsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -41,6 +41,14 @@ export interface PutAppInstanceUserExpirationSettingsCommandOutput extends PutAp
41
41
  * };
42
42
  * const command = new PutAppInstanceUserExpirationSettingsCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // PutAppInstanceUserExpirationSettingsResponse
45
+ * // AppInstanceUserArn: "STRING_VALUE",
46
+ * // ExpirationSettings: { // ExpirationSettings
47
+ * // ExpirationDays: Number("int"), // required
48
+ * // ExpirationCriterion: "CREATED_TIMESTAMP", // required
49
+ * // },
50
+ * // };
51
+ *
44
52
  * ```
45
53
  *
46
54
  * @param PutAppInstanceUserExpirationSettingsCommandInput - {@link PutAppInstanceUserExpirationSettingsCommandInput}
@@ -71,6 +79,8 @@ export interface PutAppInstanceUserExpirationSettingsCommandOutput extends PutAp
71
79
  * @throws {@link UnauthorizedClientException} (client fault)
72
80
  * <p>The client is not currently authorized to make the request.</p>
73
81
  *
82
+ * @throws {@link ChimeSDKIdentityServiceException}
83
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
74
84
  *
75
85
  */
76
86
  export declare class PutAppInstanceUserExpirationSettingsCommand extends $Command<PutAppInstanceUserExpirationSettingsCommandInput, PutAppInstanceUserExpirationSettingsCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -40,6 +40,11 @@ export interface RegisterAppInstanceUserEndpointCommandOutput extends RegisterAp
40
40
  * };
41
41
  * const command = new RegisterAppInstanceUserEndpointCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // RegisterAppInstanceUserEndpointResponse
44
+ * // AppInstanceUserArn: "STRING_VALUE",
45
+ * // EndpointId: "STRING_VALUE",
46
+ * // };
47
+ *
43
48
  * ```
44
49
  *
45
50
  * @param RegisterAppInstanceUserEndpointCommandInput - {@link RegisterAppInstanceUserEndpointCommandInput}
@@ -73,6 +78,8 @@ export interface RegisterAppInstanceUserEndpointCommandOutput extends RegisterAp
73
78
  * @throws {@link UnauthorizedClientException} (client fault)
74
79
  * <p>The client is not currently authorized to make the request.</p>
75
80
  *
81
+ * @throws {@link ChimeSDKIdentityServiceException}
82
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
76
83
  *
77
84
  */
78
85
  export declare class RegisterAppInstanceUserEndpointCommand extends $Command<RegisterAppInstanceUserEndpointCommandInput, RegisterAppInstanceUserEndpointCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -37,6 +37,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
37
37
  * };
38
38
  * const command = new TagResourceCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -66,6 +68,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
66
68
  * @throws {@link UnauthorizedClientException} (client fault)
67
69
  * <p>The client is not currently authorized to make the request.</p>
68
70
  *
71
+ * @throws {@link ChimeSDKIdentityServiceException}
72
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
69
73
  *
70
74
  */
71
75
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -60,6 +62,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
60
62
  * @throws {@link UnauthorizedClientException} (client fault)
61
63
  * <p>The client is not currently authorized to make the request.</p>
62
64
  *
65
+ * @throws {@link ChimeSDKIdentityServiceException}
66
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
63
67
  *
64
68
  */
65
69
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -33,6 +33,10 @@ export interface UpdateAppInstanceBotCommandOutput extends UpdateAppInstanceBotR
33
33
  * };
34
34
  * const command = new UpdateAppInstanceBotCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // UpdateAppInstanceBotResponse
37
+ * // AppInstanceBotArn: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param UpdateAppInstanceBotCommandInput - {@link UpdateAppInstanceBotCommandInput}
@@ -66,6 +70,8 @@ export interface UpdateAppInstanceBotCommandOutput extends UpdateAppInstanceBotR
66
70
  * @throws {@link UnauthorizedClientException} (client fault)
67
71
  * <p>The client is not currently authorized to make the request.</p>
68
72
  *
73
+ * @throws {@link ChimeSDKIdentityServiceException}
74
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
69
75
  *
70
76
  */
71
77
  export declare class UpdateAppInstanceBotCommand extends $Command<UpdateAppInstanceBotCommandInput, UpdateAppInstanceBotCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -33,6 +33,10 @@ export interface UpdateAppInstanceCommandOutput extends UpdateAppInstanceRespons
33
33
  * };
34
34
  * const command = new UpdateAppInstanceCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // UpdateAppInstanceResponse
37
+ * // AppInstanceArn: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param UpdateAppInstanceCommandInput - {@link UpdateAppInstanceCommandInput}
@@ -63,6 +67,8 @@ export interface UpdateAppInstanceCommandOutput extends UpdateAppInstanceRespons
63
67
  * @throws {@link UnauthorizedClientException} (client fault)
64
68
  * <p>The client is not currently authorized to make the request.</p>
65
69
  *
70
+ * @throws {@link ChimeSDKIdentityServiceException}
71
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
66
72
  *
67
73
  */
68
74
  export declare class UpdateAppInstanceCommand extends $Command<UpdateAppInstanceCommandInput, UpdateAppInstanceCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -34,6 +34,10 @@ export interface UpdateAppInstanceUserCommandOutput extends UpdateAppInstanceUse
34
34
  * };
35
35
  * const command = new UpdateAppInstanceUserCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // UpdateAppInstanceUserResponse
38
+ * // AppInstanceUserArn: "STRING_VALUE",
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param UpdateAppInstanceUserCommandInput - {@link UpdateAppInstanceUserCommandInput}
@@ -67,6 +71,8 @@ export interface UpdateAppInstanceUserCommandOutput extends UpdateAppInstanceUse
67
71
  * @throws {@link UnauthorizedClientException} (client fault)
68
72
  * <p>The client is not currently authorized to make the request.</p>
69
73
  *
74
+ * @throws {@link ChimeSDKIdentityServiceException}
75
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
70
76
  *
71
77
  */
72
78
  export declare class UpdateAppInstanceUserCommand extends $Command<UpdateAppInstanceUserCommandInput, UpdateAppInstanceUserCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
@@ -34,6 +34,11 @@ export interface UpdateAppInstanceUserEndpointCommandOutput extends UpdateAppIns
34
34
  * };
35
35
  * const command = new UpdateAppInstanceUserEndpointCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // UpdateAppInstanceUserEndpointResponse
38
+ * // AppInstanceUserArn: "STRING_VALUE",
39
+ * // EndpointId: "STRING_VALUE",
40
+ * // };
41
+ *
37
42
  * ```
38
43
  *
39
44
  * @param UpdateAppInstanceUserEndpointCommandInput - {@link UpdateAppInstanceUserEndpointCommandInput}
@@ -64,6 +69,8 @@ export interface UpdateAppInstanceUserEndpointCommandOutput extends UpdateAppIns
64
69
  * @throws {@link UnauthorizedClientException} (client fault)
65
70
  * <p>The client is not currently authorized to make the request.</p>
66
71
  *
72
+ * @throws {@link ChimeSDKIdentityServiceException}
73
+ * <p>Base exception class for all service exceptions from ChimeSDKIdentity service.</p>
67
74
  *
68
75
  */
69
76
  export declare class UpdateAppInstanceUserEndpointCommand extends $Command<UpdateAppInstanceUserEndpointCommandInput, UpdateAppInstanceUserEndpointCommandOutput, ChimeSDKIdentityClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-chime-sdk-identity",
3
3
  "description": "AWS SDK for JavaScript Chime Sdk Identity Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",