@aws-sdk/client-chime-sdk-voice 3.321.1 → 3.326.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 (94) hide show
  1. package/dist-types/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.d.ts +12 -0
  2. package/dist-types/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.d.ts +12 -0
  3. package/dist-types/commands/BatchDeletePhoneNumberCommand.d.ts +12 -0
  4. package/dist-types/commands/BatchUpdatePhoneNumberCommand.d.ts +12 -0
  5. package/dist-types/commands/CreatePhoneNumberOrderCommand.d.ts +19 -0
  6. package/dist-types/commands/CreateProxySessionCommand.d.ts +30 -0
  7. package/dist-types/commands/CreateSipMediaApplicationCallCommand.d.ts +8 -0
  8. package/dist-types/commands/CreateSipMediaApplicationCommand.d.ts +18 -0
  9. package/dist-types/commands/CreateSipRuleCommand.d.ts +21 -0
  10. package/dist-types/commands/CreateVoiceConnectorCommand.d.ts +15 -0
  11. package/dist-types/commands/CreateVoiceConnectorGroupCommand.d.ts +18 -0
  12. package/dist-types/commands/CreateVoiceProfileCommand.d.ts +13 -0
  13. package/dist-types/commands/CreateVoiceProfileDomainCommand.d.ts +16 -0
  14. package/dist-types/commands/DeletePhoneNumberCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteProxySessionCommand.d.ts +4 -0
  16. package/dist-types/commands/DeleteSipMediaApplicationCommand.d.ts +4 -0
  17. package/dist-types/commands/DeleteSipRuleCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteVoiceConnectorCommand.d.ts +4 -0
  19. package/dist-types/commands/DeleteVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +4 -0
  20. package/dist-types/commands/DeleteVoiceConnectorGroupCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteVoiceConnectorOriginationCommand.d.ts +4 -0
  22. package/dist-types/commands/DeleteVoiceConnectorProxyCommand.d.ts +4 -0
  23. package/dist-types/commands/DeleteVoiceConnectorStreamingConfigurationCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteVoiceConnectorTerminationCommand.d.ts +4 -0
  25. package/dist-types/commands/DeleteVoiceConnectorTerminationCredentialsCommand.d.ts +4 -0
  26. package/dist-types/commands/DeleteVoiceProfileCommand.d.ts +4 -0
  27. package/dist-types/commands/DeleteVoiceProfileDomainCommand.d.ts +4 -0
  28. package/dist-types/commands/DisassociatePhoneNumbersFromVoiceConnectorCommand.d.ts +12 -0
  29. package/dist-types/commands/DisassociatePhoneNumbersFromVoiceConnectorGroupCommand.d.ts +12 -0
  30. package/dist-types/commands/GetGlobalSettingsCommand.d.ts +8 -0
  31. package/dist-types/commands/GetPhoneNumberCommand.d.ts +34 -0
  32. package/dist-types/commands/GetPhoneNumberOrderCommand.d.ts +19 -0
  33. package/dist-types/commands/GetPhoneNumberSettingsCommand.d.ts +7 -0
  34. package/dist-types/commands/GetProxySessionCommand.d.ts +30 -0
  35. package/dist-types/commands/GetSipMediaApplicationAlexaSkillConfigurationCommand.d.ts +11 -0
  36. package/dist-types/commands/GetSipMediaApplicationCommand.d.ts +18 -0
  37. package/dist-types/commands/GetSipMediaApplicationLoggingConfigurationCommand.d.ts +8 -0
  38. package/dist-types/commands/GetSipRuleCommand.d.ts +21 -0
  39. package/dist-types/commands/GetSpeakerSearchTaskCommand.d.ts +27 -0
  40. package/dist-types/commands/GetVoiceConnectorCommand.d.ts +15 -0
  41. package/dist-types/commands/GetVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +14 -0
  42. package/dist-types/commands/GetVoiceConnectorGroupCommand.d.ts +18 -0
  43. package/dist-types/commands/GetVoiceConnectorLoggingConfigurationCommand.d.ts +9 -0
  44. package/dist-types/commands/GetVoiceConnectorOriginationCommand.d.ts +17 -0
  45. package/dist-types/commands/GetVoiceConnectorProxyCommand.d.ts +13 -0
  46. package/dist-types/commands/GetVoiceConnectorStreamingConfigurationCommand.d.ts +18 -0
  47. package/dist-types/commands/GetVoiceConnectorTerminationCommand.d.ts +16 -0
  48. package/dist-types/commands/GetVoiceConnectorTerminationHealthCommand.d.ts +9 -0
  49. package/dist-types/commands/GetVoiceProfileCommand.d.ts +13 -0
  50. package/dist-types/commands/GetVoiceProfileDomainCommand.d.ts +16 -0
  51. package/dist-types/commands/GetVoiceToneAnalysisTaskCommand.d.ts +18 -0
  52. package/dist-types/commands/ListAvailableVoiceConnectorRegionsCommand.d.ts +8 -0
  53. package/dist-types/commands/ListPhoneNumberOrdersCommand.d.ts +22 -0
  54. package/dist-types/commands/ListPhoneNumbersCommand.d.ts +37 -0
  55. package/dist-types/commands/ListProxySessionsCommand.d.ts +33 -0
  56. package/dist-types/commands/ListSipMediaApplicationsCommand.d.ts +21 -0
  57. package/dist-types/commands/ListSipRulesCommand.d.ts +24 -0
  58. package/dist-types/commands/ListSupportedPhoneNumberCountriesCommand.d.ts +13 -0
  59. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  60. package/dist-types/commands/ListVoiceConnectorGroupsCommand.d.ts +21 -0
  61. package/dist-types/commands/ListVoiceConnectorTerminationCredentialsCommand.d.ts +8 -0
  62. package/dist-types/commands/ListVoiceConnectorsCommand.d.ts +18 -0
  63. package/dist-types/commands/ListVoiceProfileDomainsCommand.d.ts +16 -0
  64. package/dist-types/commands/ListVoiceProfilesCommand.d.ts +16 -0
  65. package/dist-types/commands/PutSipMediaApplicationAlexaSkillConfigurationCommand.d.ts +11 -0
  66. package/dist-types/commands/PutSipMediaApplicationLoggingConfigurationCommand.d.ts +8 -0
  67. package/dist-types/commands/PutVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +14 -0
  68. package/dist-types/commands/PutVoiceConnectorLoggingConfigurationCommand.d.ts +9 -0
  69. package/dist-types/commands/PutVoiceConnectorOriginationCommand.d.ts +17 -0
  70. package/dist-types/commands/PutVoiceConnectorProxyCommand.d.ts +13 -0
  71. package/dist-types/commands/PutVoiceConnectorStreamingConfigurationCommand.d.ts +18 -0
  72. package/dist-types/commands/PutVoiceConnectorTerminationCommand.d.ts +16 -0
  73. package/dist-types/commands/PutVoiceConnectorTerminationCredentialsCommand.d.ts +4 -0
  74. package/dist-types/commands/RestorePhoneNumberCommand.d.ts +34 -0
  75. package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +9 -0
  76. package/dist-types/commands/StartSpeakerSearchTaskCommand.d.ts +27 -0
  77. package/dist-types/commands/StartVoiceToneAnalysisTaskCommand.d.ts +18 -0
  78. package/dist-types/commands/StopSpeakerSearchTaskCommand.d.ts +4 -0
  79. package/dist-types/commands/StopVoiceToneAnalysisTaskCommand.d.ts +4 -0
  80. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  81. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  82. package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +4 -0
  83. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +34 -0
  84. package/dist-types/commands/UpdatePhoneNumberSettingsCommand.d.ts +4 -0
  85. package/dist-types/commands/UpdateProxySessionCommand.d.ts +30 -0
  86. package/dist-types/commands/UpdateSipMediaApplicationCallCommand.d.ts +8 -0
  87. package/dist-types/commands/UpdateSipMediaApplicationCommand.d.ts +18 -0
  88. package/dist-types/commands/UpdateSipRuleCommand.d.ts +21 -0
  89. package/dist-types/commands/UpdateVoiceConnectorCommand.d.ts +15 -0
  90. package/dist-types/commands/UpdateVoiceConnectorGroupCommand.d.ts +18 -0
  91. package/dist-types/commands/UpdateVoiceProfileCommand.d.ts +13 -0
  92. package/dist-types/commands/UpdateVoiceProfileDomainCommand.d.ts +16 -0
  93. package/dist-types/commands/ValidateE911AddressCommand.d.ts +30 -0
  94. package/package.json +16 -16
@@ -31,6 +31,8 @@ export interface DeleteVoiceProfileDomainCommandOutput extends __MetadataBearer
31
31
  * };
32
32
  * const command = new DeleteVoiceProfileDomainCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteVoiceProfileDomainCommandInput - {@link DeleteVoiceProfileDomainCommandInput}
@@ -66,6 +68,8 @@ export interface DeleteVoiceProfileDomainCommandOutput extends __MetadataBearer
66
68
  * @throws {@link UnauthorizedClientException} (client fault)
67
69
  * <p>The client isn't authorized to request a resource.</p>
68
70
  *
71
+ * @throws {@link ChimeSDKVoiceServiceException}
72
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
69
73
  *
70
74
  */
71
75
  export declare class DeleteVoiceProfileDomainCommand extends $Command<DeleteVoiceProfileDomainCommandInput, DeleteVoiceProfileDomainCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -35,6 +35,16 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorCommandOutput extends
35
35
  * };
36
36
  * const command = new DisassociatePhoneNumbersFromVoiceConnectorCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DisassociatePhoneNumbersFromVoiceConnectorResponse
39
+ * // PhoneNumberErrors: [ // PhoneNumberErrorList
40
+ * // { // PhoneNumberError
41
+ * // PhoneNumberId: "STRING_VALUE",
42
+ * // ErrorCode: "BadRequest" || "Conflict" || "Forbidden" || "NotFound" || "PreconditionFailed" || "ResourceLimitExceeded" || "ServiceFailure" || "AccessDenied" || "ServiceUnavailable" || "Throttled" || "Throttling" || "Unauthorized" || "Unprocessable" || "VoiceConnectorGroupAssociationsExist" || "PhoneNumberAssociationsExist" || "Gone",
43
+ * // ErrorMessage: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
38
48
  * ```
39
49
  *
40
50
  * @param DisassociatePhoneNumbersFromVoiceConnectorCommandInput - {@link DisassociatePhoneNumbersFromVoiceConnectorCommandInput}
@@ -64,6 +74,8 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorCommandOutput extends
64
74
  * @throws {@link UnauthorizedClientException} (client fault)
65
75
  * <p>The client isn't authorized to request a resource.</p>
66
76
  *
77
+ * @throws {@link ChimeSDKVoiceServiceException}
78
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
67
79
  *
68
80
  */
69
81
  export declare class DisassociatePhoneNumbersFromVoiceConnectorCommand extends $Command<DisassociatePhoneNumbersFromVoiceConnectorCommandInput, DisassociatePhoneNumbersFromVoiceConnectorCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -35,6 +35,16 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput ex
35
35
  * };
36
36
  * const command = new DisassociatePhoneNumbersFromVoiceConnectorGroupCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DisassociatePhoneNumbersFromVoiceConnectorGroupResponse
39
+ * // PhoneNumberErrors: [ // PhoneNumberErrorList
40
+ * // { // PhoneNumberError
41
+ * // PhoneNumberId: "STRING_VALUE",
42
+ * // ErrorCode: "BadRequest" || "Conflict" || "Forbidden" || "NotFound" || "PreconditionFailed" || "ResourceLimitExceeded" || "ServiceFailure" || "AccessDenied" || "ServiceUnavailable" || "Throttled" || "Throttling" || "Unauthorized" || "Unprocessable" || "VoiceConnectorGroupAssociationsExist" || "PhoneNumberAssociationsExist" || "Gone",
43
+ * // ErrorMessage: "STRING_VALUE",
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
38
48
  * ```
39
49
  *
40
50
  * @param DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput - {@link DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput}
@@ -64,6 +74,8 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput ex
64
74
  * @throws {@link UnauthorizedClientException} (client fault)
65
75
  * <p>The client isn't authorized to request a resource.</p>
66
76
  *
77
+ * @throws {@link ChimeSDKVoiceServiceException}
78
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
67
79
  *
68
80
  */
69
81
  export declare class DisassociatePhoneNumbersFromVoiceConnectorGroupCommand extends $Command<DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -29,6 +29,12 @@ export interface GetGlobalSettingsCommandOutput extends GetGlobalSettingsRespons
29
29
  * const input = {};
30
30
  * const command = new GetGlobalSettingsCommand(input);
31
31
  * const response = await client.send(command);
32
+ * // { // GetGlobalSettingsResponse
33
+ * // VoiceConnector: { // VoiceConnectorSettings
34
+ * // CdrBucket: "STRING_VALUE",
35
+ * // },
36
+ * // };
37
+ *
32
38
  * ```
33
39
  *
34
40
  * @param GetGlobalSettingsCommandInput - {@link GetGlobalSettingsCommandInput}
@@ -55,6 +61,8 @@ export interface GetGlobalSettingsCommandOutput extends GetGlobalSettingsRespons
55
61
  * @throws {@link UnauthorizedClientException} (client fault)
56
62
  * <p>The client isn't authorized to request a resource.</p>
57
63
  *
64
+ * @throws {@link ChimeSDKVoiceServiceException}
65
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
58
66
  *
59
67
  */
60
68
  export declare class GetGlobalSettingsCommand extends $Command<GetGlobalSettingsCommandInput, GetGlobalSettingsCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,38 @@ export interface GetPhoneNumberCommandOutput extends GetPhoneNumberResponse, __M
32
32
  * };
33
33
  * const command = new GetPhoneNumberCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetPhoneNumberResponse
36
+ * // PhoneNumber: { // PhoneNumber
37
+ * // PhoneNumberId: "STRING_VALUE",
38
+ * // E164PhoneNumber: "STRING_VALUE",
39
+ * // Country: "STRING_VALUE",
40
+ * // Type: "Local" || "TollFree",
41
+ * // ProductType: "VoiceConnector" || "SipMediaApplicationDialIn",
42
+ * // Status: "Cancelled" || "PortinCancelRequested" || "PortinInProgress" || "AcquireInProgress" || "AcquireFailed" || "Unassigned" || "Assigned" || "ReleaseInProgress" || "DeleteInProgress" || "ReleaseFailed" || "DeleteFailed",
43
+ * // Capabilities: { // PhoneNumberCapabilities
44
+ * // InboundCall: true || false,
45
+ * // OutboundCall: true || false,
46
+ * // InboundSMS: true || false,
47
+ * // OutboundSMS: true || false,
48
+ * // InboundMMS: true || false,
49
+ * // OutboundMMS: true || false,
50
+ * // },
51
+ * // Associations: [ // PhoneNumberAssociationList
52
+ * // { // PhoneNumberAssociation
53
+ * // Value: "STRING_VALUE",
54
+ * // Name: "VoiceConnectorId" || "VoiceConnectorGroupId" || "SipRuleId",
55
+ * // AssociatedTimestamp: new Date("TIMESTAMP"),
56
+ * // },
57
+ * // ],
58
+ * // CallingName: "STRING_VALUE",
59
+ * // CallingNameStatus: "Unassigned" || "UpdateInProgress" || "UpdateSucceeded" || "UpdateFailed",
60
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
61
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
62
+ * // DeletionTimestamp: new Date("TIMESTAMP"),
63
+ * // OrderId: "STRING_VALUE",
64
+ * // },
65
+ * // };
66
+ *
35
67
  * ```
36
68
  *
37
69
  * @param GetPhoneNumberCommandInput - {@link GetPhoneNumberCommandInput}
@@ -61,6 +93,8 @@ export interface GetPhoneNumberCommandOutput extends GetPhoneNumberResponse, __M
61
93
  * @throws {@link UnauthorizedClientException} (client fault)
62
94
  * <p>The client isn't authorized to request a resource.</p>
63
95
  *
96
+ * @throws {@link ChimeSDKVoiceServiceException}
97
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
98
  *
65
99
  */
66
100
  export declare class GetPhoneNumberCommand extends $Command<GetPhoneNumberCommandInput, GetPhoneNumberCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -33,6 +33,23 @@ export interface GetPhoneNumberOrderCommandOutput extends GetPhoneNumberOrderRes
33
33
  * };
34
34
  * const command = new GetPhoneNumberOrderCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetPhoneNumberOrderResponse
37
+ * // PhoneNumberOrder: { // PhoneNumberOrder
38
+ * // PhoneNumberOrderId: "STRING_VALUE",
39
+ * // ProductType: "VoiceConnector" || "SipMediaApplicationDialIn",
40
+ * // Status: "Processing" || "Successful" || "Failed" || "Partial" || "PendingDocuments" || "Submitted" || "FOC" || "ChangeRequested" || "Exception" || "CancelRequested" || "Cancelled",
41
+ * // OrderType: "New" || "Porting",
42
+ * // OrderedPhoneNumbers: [ // OrderedPhoneNumberList
43
+ * // { // OrderedPhoneNumber
44
+ * // E164PhoneNumber: "STRING_VALUE",
45
+ * // Status: "Processing" || "Acquired" || "Failed",
46
+ * // },
47
+ * // ],
48
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
49
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
50
+ * // },
51
+ * // };
52
+ *
36
53
  * ```
37
54
  *
38
55
  * @param GetPhoneNumberOrderCommandInput - {@link GetPhoneNumberOrderCommandInput}
@@ -62,6 +79,8 @@ export interface GetPhoneNumberOrderCommandOutput extends GetPhoneNumberOrderRes
62
79
  * @throws {@link UnauthorizedClientException} (client fault)
63
80
  * <p>The client isn't authorized to request a resource.</p>
64
81
  *
82
+ * @throws {@link ChimeSDKVoiceServiceException}
83
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
65
84
  *
66
85
  */
67
86
  export declare class GetPhoneNumberOrderCommand extends $Command<GetPhoneNumberOrderCommandInput, GetPhoneNumberOrderCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -30,6 +30,11 @@ export interface GetPhoneNumberSettingsCommandOutput extends GetPhoneNumberSetti
30
30
  * const input = {};
31
31
  * const command = new GetPhoneNumberSettingsCommand(input);
32
32
  * const response = await client.send(command);
33
+ * // { // GetPhoneNumberSettingsResponse
34
+ * // CallingName: "STRING_VALUE",
35
+ * // CallingNameUpdatedTimestamp: new Date("TIMESTAMP"),
36
+ * // };
37
+ *
33
38
  * ```
34
39
  *
35
40
  * @param GetPhoneNumberSettingsCommandInput - {@link GetPhoneNumberSettingsCommandInput}
@@ -56,6 +61,8 @@ export interface GetPhoneNumberSettingsCommandOutput extends GetPhoneNumberSetti
56
61
  * @throws {@link UnauthorizedClientException} (client fault)
57
62
  * <p>The client isn't authorized to request a resource.</p>
58
63
  *
64
+ * @throws {@link ChimeSDKVoiceServiceException}
65
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
59
66
  *
60
67
  */
61
68
  export declare class GetPhoneNumberSettingsCommand extends $Command<GetPhoneNumberSettingsCommandInput, GetPhoneNumberSettingsCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,34 @@ export interface GetProxySessionCommandOutput extends GetProxySessionResponse, _
32
32
  * };
33
33
  * const command = new GetProxySessionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetProxySessionResponse
36
+ * // ProxySession: { // ProxySession
37
+ * // VoiceConnectorId: "STRING_VALUE",
38
+ * // ProxySessionId: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // Status: "Open" || "InProgress" || "Closed",
41
+ * // ExpiryMinutes: Number("int"),
42
+ * // Capabilities: [ // CapabilityList
43
+ * // "Voice" || "SMS",
44
+ * // ],
45
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
46
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
47
+ * // EndedTimestamp: new Date("TIMESTAMP"),
48
+ * // Participants: [ // Participants
49
+ * // { // Participant
50
+ * // PhoneNumber: "STRING_VALUE",
51
+ * // ProxyPhoneNumber: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // NumberSelectionBehavior: "PreferSticky" || "AvoidSticky",
55
+ * // GeoMatchLevel: "Country" || "AreaCode",
56
+ * // GeoMatchParams: { // GeoMatchParams
57
+ * // Country: "STRING_VALUE", // required
58
+ * // AreaCode: "STRING_VALUE", // required
59
+ * // },
60
+ * // },
61
+ * // };
62
+ *
35
63
  * ```
36
64
  *
37
65
  * @param GetProxySessionCommandInput - {@link GetProxySessionCommandInput}
@@ -61,6 +89,8 @@ export interface GetProxySessionCommandOutput extends GetProxySessionResponse, _
61
89
  * @throws {@link UnauthorizedClientException} (client fault)
62
90
  * <p>The client isn't authorized to request a resource.</p>
63
91
  *
92
+ * @throws {@link ChimeSDKVoiceServiceException}
93
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
94
  *
65
95
  */
66
96
  export declare class GetProxySessionCommand extends $Command<GetProxySessionCommandInput, GetProxySessionCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -31,6 +31,15 @@ export interface GetSipMediaApplicationAlexaSkillConfigurationCommandOutput exte
31
31
  * };
32
32
  * const command = new GetSipMediaApplicationAlexaSkillConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetSipMediaApplicationAlexaSkillConfigurationResponse
35
+ * // SipMediaApplicationAlexaSkillConfiguration: { // SipMediaApplicationAlexaSkillConfiguration
36
+ * // AlexaSkillStatus: "ACTIVE" || "INACTIVE", // required
37
+ * // AlexaSkillIds: [ // AlexaSkillIdList // required
38
+ * // "STRING_VALUE",
39
+ * // ],
40
+ * // },
41
+ * // };
42
+ *
34
43
  * ```
35
44
  *
36
45
  * @param GetSipMediaApplicationAlexaSkillConfigurationCommandInput - {@link GetSipMediaApplicationAlexaSkillConfigurationCommandInput}
@@ -60,6 +69,8 @@ export interface GetSipMediaApplicationAlexaSkillConfigurationCommandOutput exte
60
69
  * @throws {@link UnauthorizedClientException} (client fault)
61
70
  * <p>The client isn't authorized to request a resource.</p>
62
71
  *
72
+ * @throws {@link ChimeSDKVoiceServiceException}
73
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
63
74
  *
64
75
  */
65
76
  export declare class GetSipMediaApplicationAlexaSkillConfigurationCommand extends $Command<GetSipMediaApplicationAlexaSkillConfigurationCommandInput, GetSipMediaApplicationAlexaSkillConfigurationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,22 @@ export interface GetSipMediaApplicationCommandOutput extends GetSipMediaApplicat
32
32
  * };
33
33
  * const command = new GetSipMediaApplicationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetSipMediaApplicationResponse
36
+ * // SipMediaApplication: { // SipMediaApplication
37
+ * // SipMediaApplicationId: "STRING_VALUE",
38
+ * // AwsRegion: "STRING_VALUE",
39
+ * // Name: "STRING_VALUE",
40
+ * // Endpoints: [ // SipMediaApplicationEndpointList
41
+ * // { // SipMediaApplicationEndpoint
42
+ * // LambdaArn: "STRING_VALUE",
43
+ * // },
44
+ * // ],
45
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
46
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
47
+ * // SipMediaApplicationArn: "STRING_VALUE",
48
+ * // },
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param GetSipMediaApplicationCommandInput - {@link GetSipMediaApplicationCommandInput}
@@ -61,6 +77,8 @@ export interface GetSipMediaApplicationCommandOutput extends GetSipMediaApplicat
61
77
  * @throws {@link UnauthorizedClientException} (client fault)
62
78
  * <p>The client isn't authorized to request a resource.</p>
63
79
  *
80
+ * @throws {@link ChimeSDKVoiceServiceException}
81
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
82
  *
65
83
  */
66
84
  export declare class GetSipMediaApplicationCommand extends $Command<GetSipMediaApplicationCommandInput, GetSipMediaApplicationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface GetSipMediaApplicationLoggingConfigurationCommandOutput extends
31
31
  * };
32
32
  * const command = new GetSipMediaApplicationLoggingConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetSipMediaApplicationLoggingConfigurationResponse
35
+ * // SipMediaApplicationLoggingConfiguration: { // SipMediaApplicationLoggingConfiguration
36
+ * // EnableSipMediaApplicationMessageLogs: true || false,
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param GetSipMediaApplicationLoggingConfigurationCommandInput - {@link GetSipMediaApplicationLoggingConfigurationCommandInput}
@@ -60,6 +66,8 @@ export interface GetSipMediaApplicationLoggingConfigurationCommandOutput extends
60
66
  * @throws {@link UnauthorizedClientException} (client fault)
61
67
  * <p>The client isn't authorized to request a resource.</p>
62
68
  *
69
+ * @throws {@link ChimeSDKVoiceServiceException}
70
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
63
71
  *
64
72
  */
65
73
  export declare class GetSipMediaApplicationLoggingConfigurationCommand extends $Command<GetSipMediaApplicationLoggingConfigurationCommandInput, GetSipMediaApplicationLoggingConfigurationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,25 @@ export interface GetSipRuleCommandOutput extends GetSipRuleResponse, __MetadataB
32
32
  * };
33
33
  * const command = new GetSipRuleCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetSipRuleResponse
36
+ * // SipRule: { // SipRule
37
+ * // SipRuleId: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // Disabled: true || false,
40
+ * // TriggerType: "ToPhoneNumber" || "RequestUriHostname",
41
+ * // TriggerValue: "STRING_VALUE",
42
+ * // TargetApplications: [ // SipRuleTargetApplicationList
43
+ * // { // SipRuleTargetApplication
44
+ * // SipMediaApplicationId: "STRING_VALUE",
45
+ * // Priority: Number("int"),
46
+ * // AwsRegion: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
50
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
51
+ * // },
52
+ * // };
53
+ *
35
54
  * ```
36
55
  *
37
56
  * @param GetSipRuleCommandInput - {@link GetSipRuleCommandInput}
@@ -61,6 +80,8 @@ export interface GetSipRuleCommandOutput extends GetSipRuleResponse, __MetadataB
61
80
  * @throws {@link UnauthorizedClientException} (client fault)
62
81
  * <p>The client isn't authorized to request a resource.</p>
63
82
  *
83
+ * @throws {@link ChimeSDKVoiceServiceException}
84
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
85
  *
65
86
  */
66
87
  export declare class GetSipRuleCommand extends $Command<GetSipRuleCommandInput, GetSipRuleCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,31 @@ export interface GetSpeakerSearchTaskCommandOutput extends GetSpeakerSearchTaskR
32
32
  * };
33
33
  * const command = new GetSpeakerSearchTaskCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetSpeakerSearchTaskResponse
36
+ * // SpeakerSearchTask: { // SpeakerSearchTask
37
+ * // SpeakerSearchTaskId: "STRING_VALUE",
38
+ * // SpeakerSearchTaskStatus: "STRING_VALUE",
39
+ * // CallDetails: { // CallDetails
40
+ * // VoiceConnectorId: "STRING_VALUE",
41
+ * // TransactionId: "STRING_VALUE",
42
+ * // IsCaller: true || false,
43
+ * // },
44
+ * // SpeakerSearchDetails: { // SpeakerSearchDetails
45
+ * // Results: [ // SpeakerSearchResultList
46
+ * // { // SpeakerSearchResult
47
+ * // ConfidenceScore: Number("float"),
48
+ * // VoiceProfileId: "STRING_VALUE",
49
+ * // },
50
+ * // ],
51
+ * // VoiceprintGenerationStatus: "STRING_VALUE",
52
+ * // },
53
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
54
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
55
+ * // StartedTimestamp: new Date("TIMESTAMP"),
56
+ * // StatusMessage: "STRING_VALUE",
57
+ * // },
58
+ * // };
59
+ *
35
60
  * ```
36
61
  *
37
62
  * @param GetSpeakerSearchTaskCommandInput - {@link GetSpeakerSearchTaskCommandInput}
@@ -67,6 +92,8 @@ export interface GetSpeakerSearchTaskCommandOutput extends GetSpeakerSearchTaskR
67
92
  * @throws {@link UnauthorizedClientException} (client fault)
68
93
  * <p>The client isn't authorized to request a resource.</p>
69
94
  *
95
+ * @throws {@link ChimeSDKVoiceServiceException}
96
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
70
97
  *
71
98
  */
72
99
  export declare class GetSpeakerSearchTaskCommand extends $Command<GetSpeakerSearchTaskCommandInput, GetSpeakerSearchTaskCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,19 @@ export interface GetVoiceConnectorCommandOutput extends GetVoiceConnectorRespons
32
32
  * };
33
33
  * const command = new GetVoiceConnectorCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetVoiceConnectorResponse
36
+ * // VoiceConnector: { // VoiceConnector
37
+ * // VoiceConnectorId: "STRING_VALUE",
38
+ * // AwsRegion: "us-east-1" || "us-west-2" || "ca-central-1" || "eu-central-1" || "eu-west-1" || "eu-west-2" || "ap-northeast-2" || "ap-northeast-1" || "ap-southeast-1" || "ap-southeast-2",
39
+ * // Name: "STRING_VALUE",
40
+ * // OutboundHostName: "STRING_VALUE",
41
+ * // RequireEncryption: true || false,
42
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
43
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
44
+ * // VoiceConnectorArn: "STRING_VALUE",
45
+ * // },
46
+ * // };
47
+ *
35
48
  * ```
36
49
  *
37
50
  * @param GetVoiceConnectorCommandInput - {@link GetVoiceConnectorCommandInput}
@@ -61,6 +74,8 @@ export interface GetVoiceConnectorCommandOutput extends GetVoiceConnectorRespons
61
74
  * @throws {@link UnauthorizedClientException} (client fault)
62
75
  * <p>The client isn't authorized to request a resource.</p>
63
76
  *
77
+ * @throws {@link ChimeSDKVoiceServiceException}
78
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
79
  *
65
80
  */
66
81
  export declare class GetVoiceConnectorCommand extends $Command<GetVoiceConnectorCommandInput, GetVoiceConnectorCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -31,6 +31,18 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationCommandOutput ext
31
31
  * };
32
32
  * const command = new GetVoiceConnectorEmergencyCallingConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetVoiceConnectorEmergencyCallingConfigurationResponse
35
+ * // EmergencyCallingConfiguration: { // EmergencyCallingConfiguration
36
+ * // DNIS: [ // DNISEmergencyCallingConfigurationList
37
+ * // { // DNISEmergencyCallingConfiguration
38
+ * // EmergencyPhoneNumber: "STRING_VALUE", // required
39
+ * // TestPhoneNumber: "STRING_VALUE",
40
+ * // CallingCountry: "STRING_VALUE", // required
41
+ * // },
42
+ * // ],
43
+ * // },
44
+ * // };
45
+ *
34
46
  * ```
35
47
  *
36
48
  * @param GetVoiceConnectorEmergencyCallingConfigurationCommandInput - {@link GetVoiceConnectorEmergencyCallingConfigurationCommandInput}
@@ -60,6 +72,8 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationCommandOutput ext
60
72
  * @throws {@link UnauthorizedClientException} (client fault)
61
73
  * <p>The client isn't authorized to request a resource.</p>
62
74
  *
75
+ * @throws {@link ChimeSDKVoiceServiceException}
76
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
63
77
  *
64
78
  */
65
79
  export declare class GetVoiceConnectorEmergencyCallingConfigurationCommand extends $Command<GetVoiceConnectorEmergencyCallingConfigurationCommandInput, GetVoiceConnectorEmergencyCallingConfigurationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,22 @@ export interface GetVoiceConnectorGroupCommandOutput extends GetVoiceConnectorGr
32
32
  * };
33
33
  * const command = new GetVoiceConnectorGroupCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetVoiceConnectorGroupResponse
36
+ * // VoiceConnectorGroup: { // VoiceConnectorGroup
37
+ * // VoiceConnectorGroupId: "STRING_VALUE",
38
+ * // Name: "STRING_VALUE",
39
+ * // VoiceConnectorItems: [ // VoiceConnectorItemList
40
+ * // { // VoiceConnectorItem
41
+ * // VoiceConnectorId: "STRING_VALUE", // required
42
+ * // Priority: Number("int"), // required
43
+ * // },
44
+ * // ],
45
+ * // CreatedTimestamp: new Date("TIMESTAMP"),
46
+ * // UpdatedTimestamp: new Date("TIMESTAMP"),
47
+ * // VoiceConnectorGroupArn: "STRING_VALUE",
48
+ * // },
49
+ * // };
50
+ *
35
51
  * ```
36
52
  *
37
53
  * @param GetVoiceConnectorGroupCommandInput - {@link GetVoiceConnectorGroupCommandInput}
@@ -61,6 +77,8 @@ export interface GetVoiceConnectorGroupCommandOutput extends GetVoiceConnectorGr
61
77
  * @throws {@link UnauthorizedClientException} (client fault)
62
78
  * <p>The client isn't authorized to request a resource.</p>
63
79
  *
80
+ * @throws {@link ChimeSDKVoiceServiceException}
81
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
82
  *
65
83
  */
66
84
  export declare class GetVoiceConnectorGroupCommand extends $Command<GetVoiceConnectorGroupCommandInput, GetVoiceConnectorGroupCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface GetVoiceConnectorLoggingConfigurationCommandOutput extends GetV
32
32
  * };
33
33
  * const command = new GetVoiceConnectorLoggingConfigurationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetVoiceConnectorLoggingConfigurationResponse
36
+ * // LoggingConfiguration: { // LoggingConfiguration
37
+ * // EnableSIPLogs: true || false,
38
+ * // EnableMediaMetricLogs: true || false,
39
+ * // },
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param GetVoiceConnectorLoggingConfigurationCommandInput - {@link GetVoiceConnectorLoggingConfigurationCommandInput}
@@ -61,6 +68,8 @@ export interface GetVoiceConnectorLoggingConfigurationCommandOutput extends GetV
61
68
  * @throws {@link UnauthorizedClientException} (client fault)
62
69
  * <p>The client isn't authorized to request a resource.</p>
63
70
  *
71
+ * @throws {@link ChimeSDKVoiceServiceException}
72
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
73
  *
65
74
  */
66
75
  export declare class GetVoiceConnectorLoggingConfigurationCommand extends $Command<GetVoiceConnectorLoggingConfigurationCommandInput, GetVoiceConnectorLoggingConfigurationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -31,6 +31,21 @@ export interface GetVoiceConnectorOriginationCommandOutput extends GetVoiceConne
31
31
  * };
32
32
  * const command = new GetVoiceConnectorOriginationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetVoiceConnectorOriginationResponse
35
+ * // Origination: { // Origination
36
+ * // Routes: [ // OriginationRouteList
37
+ * // { // OriginationRoute
38
+ * // Host: "STRING_VALUE",
39
+ * // Port: Number("int"),
40
+ * // Protocol: "TCP" || "UDP",
41
+ * // Priority: Number("int"),
42
+ * // Weight: Number("int"),
43
+ * // },
44
+ * // ],
45
+ * // Disabled: true || false,
46
+ * // },
47
+ * // };
48
+ *
34
49
  * ```
35
50
  *
36
51
  * @param GetVoiceConnectorOriginationCommandInput - {@link GetVoiceConnectorOriginationCommandInput}
@@ -60,6 +75,8 @@ export interface GetVoiceConnectorOriginationCommandOutput extends GetVoiceConne
60
75
  * @throws {@link UnauthorizedClientException} (client fault)
61
76
  * <p>The client isn't authorized to request a resource.</p>
62
77
  *
78
+ * @throws {@link ChimeSDKVoiceServiceException}
79
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
63
80
  *
64
81
  */
65
82
  export declare class GetVoiceConnectorOriginationCommand extends $Command<GetVoiceConnectorOriginationCommandInput, GetVoiceConnectorOriginationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface GetVoiceConnectorProxyCommandOutput extends GetVoiceConnectorPr
32
32
  * };
33
33
  * const command = new GetVoiceConnectorProxyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetVoiceConnectorProxyResponse
36
+ * // Proxy: { // Proxy
37
+ * // DefaultSessionExpiryMinutes: Number("int"),
38
+ * // Disabled: true || false,
39
+ * // FallBackPhoneNumber: "STRING_VALUE",
40
+ * // PhoneNumberCountries: [ // StringList
41
+ * // "STRING_VALUE",
42
+ * // ],
43
+ * // },
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param GetVoiceConnectorProxyCommandInput - {@link GetVoiceConnectorProxyCommandInput}
@@ -61,6 +72,8 @@ export interface GetVoiceConnectorProxyCommandOutput extends GetVoiceConnectorPr
61
72
  * @throws {@link UnauthorizedClientException} (client fault)
62
73
  * <p>The client isn't authorized to request a resource.</p>
63
74
  *
75
+ * @throws {@link ChimeSDKVoiceServiceException}
76
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
64
77
  *
65
78
  */
66
79
  export declare class GetVoiceConnectorProxyCommand extends $Command<GetVoiceConnectorProxyCommandInput, GetVoiceConnectorProxyCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -33,6 +33,22 @@ export interface GetVoiceConnectorStreamingConfigurationCommandOutput extends Ge
33
33
  * };
34
34
  * const command = new GetVoiceConnectorStreamingConfigurationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetVoiceConnectorStreamingConfigurationResponse
37
+ * // StreamingConfiguration: { // StreamingConfiguration
38
+ * // DataRetentionInHours: Number("int"), // required
39
+ * // Disabled: true || false, // required
40
+ * // StreamingNotificationTargets: [ // StreamingNotificationTargetList
41
+ * // { // StreamingNotificationTarget
42
+ * // NotificationTarget: "EventBridge" || "SNS" || "SQS",
43
+ * // },
44
+ * // ],
45
+ * // MediaInsightsConfiguration: { // MediaInsightsConfiguration
46
+ * // Disabled: true || false,
47
+ * // ConfigurationArn: "STRING_VALUE",
48
+ * // },
49
+ * // },
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param GetVoiceConnectorStreamingConfigurationCommandInput - {@link GetVoiceConnectorStreamingConfigurationCommandInput}
@@ -62,6 +78,8 @@ export interface GetVoiceConnectorStreamingConfigurationCommandOutput extends Ge
62
78
  * @throws {@link UnauthorizedClientException} (client fault)
63
79
  * <p>The client isn't authorized to request a resource.</p>
64
80
  *
81
+ * @throws {@link ChimeSDKVoiceServiceException}
82
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
65
83
  *
66
84
  */
67
85
  export declare class GetVoiceConnectorStreamingConfigurationCommand extends $Command<GetVoiceConnectorStreamingConfigurationCommandInput, GetVoiceConnectorStreamingConfigurationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
@@ -31,6 +31,20 @@ export interface GetVoiceConnectorTerminationCommandOutput extends GetVoiceConne
31
31
  * };
32
32
  * const command = new GetVoiceConnectorTerminationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetVoiceConnectorTerminationResponse
35
+ * // Termination: { // Termination
36
+ * // CpsLimit: Number("int"),
37
+ * // DefaultPhoneNumber: "STRING_VALUE",
38
+ * // CallingRegions: [ // CallingRegionList
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // CidrAllowedList: [ // StringList
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // Disabled: true || false,
45
+ * // },
46
+ * // };
47
+ *
34
48
  * ```
35
49
  *
36
50
  * @param GetVoiceConnectorTerminationCommandInput - {@link GetVoiceConnectorTerminationCommandInput}
@@ -60,6 +74,8 @@ export interface GetVoiceConnectorTerminationCommandOutput extends GetVoiceConne
60
74
  * @throws {@link UnauthorizedClientException} (client fault)
61
75
  * <p>The client isn't authorized to request a resource.</p>
62
76
  *
77
+ * @throws {@link ChimeSDKVoiceServiceException}
78
+ * <p>Base exception class for all service exceptions from ChimeSDKVoice service.</p>
63
79
  *
64
80
  */
65
81
  export declare class GetVoiceConnectorTerminationCommand extends $Command<GetVoiceConnectorTerminationCommandInput, GetVoiceConnectorTerminationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {