@aws-sdk/client-chime-sdk-voice 3.299.0 → 3.301.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 (98) hide show
  1. package/README.md +3 -0
  2. package/dist-types/ChimeSDKVoice.d.ts +203 -0
  3. package/dist-types/ChimeSDKVoiceClient.d.ts +2 -0
  4. package/dist-types/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.d.ts +52 -0
  5. package/dist-types/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.d.ts +52 -0
  6. package/dist-types/commands/BatchDeletePhoneNumberCommand.d.ts +54 -0
  7. package/dist-types/commands/BatchUpdatePhoneNumberCommand.d.ts +51 -0
  8. package/dist-types/commands/CreatePhoneNumberOrderCommand.d.ts +51 -0
  9. package/dist-types/commands/CreateProxySessionCommand.d.ts +60 -0
  10. package/dist-types/commands/CreateSipMediaApplicationCallCommand.d.ts +58 -0
  11. package/dist-types/commands/CreateSipMediaApplicationCommand.d.ts +58 -0
  12. package/dist-types/commands/CreateSipRuleCommand.d.ts +62 -0
  13. package/dist-types/commands/CreateVoiceConnectorCommand.d.ts +53 -0
  14. package/dist-types/commands/CreateVoiceConnectorGroupCommand.d.ts +59 -0
  15. package/dist-types/commands/CreateVoiceProfileCommand.d.ts +63 -0
  16. package/dist-types/commands/CreateVoiceProfileDomainCommand.d.ts +68 -0
  17. package/dist-types/commands/DeletePhoneNumberCommand.d.ts +51 -0
  18. package/dist-types/commands/DeleteProxySessionCommand.d.ts +47 -0
  19. package/dist-types/commands/DeleteSipMediaApplicationCommand.d.ts +48 -0
  20. package/dist-types/commands/DeleteSipRuleCommand.d.ts +48 -0
  21. package/dist-types/commands/DeleteVoiceConnectorCommand.d.ts +50 -0
  22. package/dist-types/commands/DeleteVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +46 -0
  23. package/dist-types/commands/DeleteVoiceConnectorGroupCommand.d.ts +50 -0
  24. package/dist-types/commands/DeleteVoiceConnectorOriginationCommand.d.ts +49 -0
  25. package/dist-types/commands/DeleteVoiceConnectorProxyCommand.d.ts +45 -0
  26. package/dist-types/commands/DeleteVoiceConnectorStreamingConfigurationCommand.d.ts +45 -0
  27. package/dist-types/commands/DeleteVoiceConnectorTerminationCommand.d.ts +49 -0
  28. package/dist-types/commands/DeleteVoiceConnectorTerminationCredentialsCommand.d.ts +49 -0
  29. package/dist-types/commands/DeleteVoiceProfileCommand.d.ts +51 -0
  30. package/dist-types/commands/DeleteVoiceProfileDomainCommand.d.ts +51 -0
  31. package/dist-types/commands/DisassociatePhoneNumbersFromVoiceConnectorCommand.d.ts +49 -0
  32. package/dist-types/commands/DisassociatePhoneNumbersFromVoiceConnectorGroupCommand.d.ts +49 -0
  33. package/dist-types/commands/GetGlobalSettingsCommand.d.ts +40 -0
  34. package/dist-types/commands/GetPhoneNumberCommand.d.ts +46 -0
  35. package/dist-types/commands/GetPhoneNumberOrderCommand.d.ts +47 -0
  36. package/dist-types/commands/GetPhoneNumberSettingsCommand.d.ts +41 -0
  37. package/dist-types/commands/GetProxySessionCommand.d.ts +46 -0
  38. package/dist-types/commands/GetSipMediaApplicationAlexaSkillConfigurationCommand.d.ts +45 -0
  39. package/dist-types/commands/GetSipMediaApplicationCommand.d.ts +46 -0
  40. package/dist-types/commands/GetSipMediaApplicationLoggingConfigurationCommand.d.ts +45 -0
  41. package/dist-types/commands/GetSipRuleCommand.d.ts +46 -0
  42. package/dist-types/commands/GetSpeakerSearchTaskCommand.d.ts +52 -0
  43. package/dist-types/commands/GetVoiceConnectorCommand.d.ts +46 -0
  44. package/dist-types/commands/GetVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +45 -0
  45. package/dist-types/commands/GetVoiceConnectorGroupCommand.d.ts +46 -0
  46. package/dist-types/commands/GetVoiceConnectorLoggingConfigurationCommand.d.ts +46 -0
  47. package/dist-types/commands/GetVoiceConnectorOriginationCommand.d.ts +45 -0
  48. package/dist-types/commands/GetVoiceConnectorProxyCommand.d.ts +46 -0
  49. package/dist-types/commands/GetVoiceConnectorStreamingConfigurationCommand.d.ts +47 -0
  50. package/dist-types/commands/GetVoiceConnectorTerminationCommand.d.ts +45 -0
  51. package/dist-types/commands/GetVoiceConnectorTerminationHealthCommand.d.ts +47 -0
  52. package/dist-types/commands/GetVoiceProfileCommand.d.ts +48 -0
  53. package/dist-types/commands/GetVoiceProfileDomainCommand.d.ts +48 -0
  54. package/dist-types/commands/GetVoiceToneAnalysisTaskCommand.d.ts +53 -0
  55. package/dist-types/commands/ListAvailableVoiceConnectorRegionsCommand.d.ts +40 -0
  56. package/dist-types/commands/ListPhoneNumberOrdersCommand.d.ts +43 -0
  57. package/dist-types/commands/ListPhoneNumbersCommand.d.ts +52 -0
  58. package/dist-types/commands/ListProxySessionsCommand.d.ts +48 -0
  59. package/dist-types/commands/ListSipMediaApplicationsCommand.d.ts +43 -0
  60. package/dist-types/commands/ListSipRulesCommand.d.ts +44 -0
  61. package/dist-types/commands/ListSupportedPhoneNumberCountriesCommand.d.ts +45 -0
  62. package/dist-types/commands/ListTagsForResourceCommand.d.ts +42 -0
  63. package/dist-types/commands/ListVoiceConnectorGroupsCommand.d.ts +44 -0
  64. package/dist-types/commands/ListVoiceConnectorTerminationCredentialsCommand.d.ts +45 -0
  65. package/dist-types/commands/ListVoiceConnectorsCommand.d.ts +44 -0
  66. package/dist-types/commands/ListVoiceProfileDomainsCommand.d.ts +47 -0
  67. package/dist-types/commands/ListVoiceProfilesCommand.d.ts +47 -0
  68. package/dist-types/commands/PutSipMediaApplicationAlexaSkillConfigurationCommand.d.ts +51 -0
  69. package/dist-types/commands/PutSipMediaApplicationLoggingConfigurationCommand.d.ts +48 -0
  70. package/dist-types/commands/PutVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +54 -0
  71. package/dist-types/commands/PutVoiceConnectorLoggingConfigurationCommand.d.ts +49 -0
  72. package/dist-types/commands/PutVoiceConnectorOriginationCommand.d.ts +57 -0
  73. package/dist-types/commands/PutVoiceConnectorProxyCommand.d.ts +54 -0
  74. package/dist-types/commands/PutVoiceConnectorStreamingConfigurationCommand.d.ts +58 -0
  75. package/dist-types/commands/PutVoiceConnectorTerminationCommand.d.ts +59 -0
  76. package/dist-types/commands/PutVoiceConnectorTerminationCredentialsCommand.d.ts +51 -0
  77. package/dist-types/commands/RestorePhoneNumberCommand.d.ts +48 -0
  78. package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +52 -0
  79. package/dist-types/commands/StartSpeakerSearchTaskCommand.d.ts +67 -0
  80. package/dist-types/commands/StartVoiceToneAnalysisTaskCommand.d.ts +69 -0
  81. package/dist-types/commands/StopSpeakerSearchTaskCommand.d.ts +55 -0
  82. package/dist-types/commands/StopVoiceToneAnalysisTaskCommand.d.ts +55 -0
  83. package/dist-types/commands/TagResourceCommand.d.ts +51 -0
  84. package/dist-types/commands/UntagResourceCommand.d.ts +45 -0
  85. package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +44 -0
  86. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +57 -0
  87. package/dist-types/commands/UpdatePhoneNumberSettingsCommand.d.ts +45 -0
  88. package/dist-types/commands/UpdateProxySessionCommand.d.ts +50 -0
  89. package/dist-types/commands/UpdateSipMediaApplicationCallCommand.d.ts +54 -0
  90. package/dist-types/commands/UpdateSipMediaApplicationCommand.d.ts +54 -0
  91. package/dist-types/commands/UpdateSipRuleCommand.d.ts +60 -0
  92. package/dist-types/commands/UpdateVoiceConnectorCommand.d.ts +47 -0
  93. package/dist-types/commands/UpdateVoiceConnectorGroupCommand.d.ts +55 -0
  94. package/dist-types/commands/UpdateVoiceProfileCommand.d.ts +64 -0
  95. package/dist-types/commands/UpdateVoiceProfileDomainCommand.d.ts +50 -0
  96. package/dist-types/commands/ValidateE911AddressCommand.d.ts +54 -0
  97. package/dist-types/models/models_0.d.ts +1583 -0
  98. package/package.json +8 -8
@@ -236,6 +236,8 @@ export interface ChimeSDKVoiceClientResolvedConfig extends ChimeSDKVoiceClientRe
236
236
  }
237
237
  /**
238
238
  * @public
239
+ * <p>The Amazon Chime SDK telephony APIs in this section enable developers to create PSTN calling solutions that use Amazon Chime SDK Voice Connectors, and Amazon Chime SDK SIP media applications. Developers can
240
+ * also order and manage phone numbers, create and manage Voice Connectors and SIP media applications, and run voice analytics.</p>
239
241
  */
240
242
  export declare class ChimeSDKVoiceClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ChimeSDKVoiceClientResolvedConfig> {
241
243
  /**
@@ -17,6 +17,58 @@ export interface AssociatePhoneNumbersWithVoiceConnectorCommandInput extends Ass
17
17
  */
18
18
  export interface AssociatePhoneNumbersWithVoiceConnectorCommandOutput extends AssociatePhoneNumbersWithVoiceConnectorResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Associates phone numbers with the specified Amazon Chime SDK Voice Connector.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { ChimeSDKVoiceClient, AssociatePhoneNumbersWithVoiceConnectorCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
27
+ * // const { ChimeSDKVoiceClient, AssociatePhoneNumbersWithVoiceConnectorCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
28
+ * const client = new ChimeSDKVoiceClient(config);
29
+ * const input = { // AssociatePhoneNumbersWithVoiceConnectorRequest
30
+ * VoiceConnectorId: "STRING_VALUE", // required
31
+ * E164PhoneNumbers: [ // E164PhoneNumberList // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * ForceAssociate: true || false,
35
+ * };
36
+ * const command = new AssociatePhoneNumbersWithVoiceConnectorCommand(input);
37
+ * const response = await client.send(command);
38
+ * ```
39
+ *
40
+ * @param AssociatePhoneNumbersWithVoiceConnectorCommandInput - {@link AssociatePhoneNumbersWithVoiceConnectorCommandInput}
41
+ * @returns {@link AssociatePhoneNumbersWithVoiceConnectorCommandOutput}
42
+ * @see {@link AssociatePhoneNumbersWithVoiceConnectorCommandInput} for command's `input` shape.
43
+ * @see {@link AssociatePhoneNumbersWithVoiceConnectorCommandOutput} for command's `response` shape.
44
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
45
+ *
46
+ * @throws {@link AccessDeniedException} (client fault)
47
+ * <p>You don't have the permissions needed to run this action.</p>
48
+ *
49
+ * @throws {@link BadRequestException} (client fault)
50
+ * <p>The input parameters don't match the service's restrictions.</p>
51
+ *
52
+ * @throws {@link ForbiddenException} (client fault)
53
+ * <p>The client is permanently forbidden from making the request.</p>
54
+ *
55
+ * @throws {@link NotFoundException} (client fault)
56
+ * <p>The requested resource couldn't be found.</p>
57
+ *
58
+ * @throws {@link ServiceFailureException} (server fault)
59
+ * <p>The service encountered an unexpected error.</p>
60
+ *
61
+ * @throws {@link ServiceUnavailableException} (server fault)
62
+ * <p>The service is currently unavailable.</p>
63
+ *
64
+ * @throws {@link ThrottledClientException} (client fault)
65
+ * <p>The number of customer requests exceeds the request rate limit.</p>
66
+ *
67
+ * @throws {@link UnauthorizedClientException} (client fault)
68
+ * <p>The client isn't authorized to request a resource.</p>
69
+ *
70
+ *
71
+ */
20
72
  export declare class AssociatePhoneNumbersWithVoiceConnectorCommand extends $Command<AssociatePhoneNumbersWithVoiceConnectorCommandInput, AssociatePhoneNumbersWithVoiceConnectorCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
73
  readonly input: AssociatePhoneNumbersWithVoiceConnectorCommandInput;
22
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,58 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput extend
17
17
  */
18
18
  export interface AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput extends AssociatePhoneNumbersWithVoiceConnectorGroupResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Associates phone numbers with the specified Amazon Chime SDK Voice Connector group.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { ChimeSDKVoiceClient, AssociatePhoneNumbersWithVoiceConnectorGroupCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
27
+ * // const { ChimeSDKVoiceClient, AssociatePhoneNumbersWithVoiceConnectorGroupCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
28
+ * const client = new ChimeSDKVoiceClient(config);
29
+ * const input = { // AssociatePhoneNumbersWithVoiceConnectorGroupRequest
30
+ * VoiceConnectorGroupId: "STRING_VALUE", // required
31
+ * E164PhoneNumbers: [ // E164PhoneNumberList // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * ForceAssociate: true || false,
35
+ * };
36
+ * const command = new AssociatePhoneNumbersWithVoiceConnectorGroupCommand(input);
37
+ * const response = await client.send(command);
38
+ * ```
39
+ *
40
+ * @param AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput - {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput}
41
+ * @returns {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput}
42
+ * @see {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput} for command's `input` shape.
43
+ * @see {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput} for command's `response` shape.
44
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
45
+ *
46
+ * @throws {@link AccessDeniedException} (client fault)
47
+ * <p>You don't have the permissions needed to run this action.</p>
48
+ *
49
+ * @throws {@link BadRequestException} (client fault)
50
+ * <p>The input parameters don't match the service's restrictions.</p>
51
+ *
52
+ * @throws {@link ForbiddenException} (client fault)
53
+ * <p>The client is permanently forbidden from making the request.</p>
54
+ *
55
+ * @throws {@link NotFoundException} (client fault)
56
+ * <p>The requested resource couldn't be found.</p>
57
+ *
58
+ * @throws {@link ServiceFailureException} (server fault)
59
+ * <p>The service encountered an unexpected error.</p>
60
+ *
61
+ * @throws {@link ServiceUnavailableException} (server fault)
62
+ * <p>The service is currently unavailable.</p>
63
+ *
64
+ * @throws {@link ThrottledClientException} (client fault)
65
+ * <p>The number of customer requests exceeds the request rate limit.</p>
66
+ *
67
+ * @throws {@link UnauthorizedClientException} (client fault)
68
+ * <p>The client isn't authorized to request a resource.</p>
69
+ *
70
+ *
71
+ */
20
72
  export declare class AssociatePhoneNumbersWithVoiceConnectorGroupCommand extends $Command<AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
73
  readonly input: AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput;
22
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,60 @@ export interface BatchDeletePhoneNumberCommandInput extends BatchDeletePhoneNumb
17
17
  */
18
18
  export interface BatchDeletePhoneNumberCommandOutput extends BatchDeletePhoneNumberResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>
23
+ * Moves phone numbers into the
24
+ * <b>Deletion queue</b>. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted.
25
+ * </p>
26
+ * <p>
27
+ * Phone numbers remain in the
28
+ * <b>Deletion queue</b> for 7 days before they are deleted permanently.
29
+ * </p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { ChimeSDKVoiceClient, BatchDeletePhoneNumberCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
34
+ * // const { ChimeSDKVoiceClient, BatchDeletePhoneNumberCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
35
+ * const client = new ChimeSDKVoiceClient(config);
36
+ * const input = { // BatchDeletePhoneNumberRequest
37
+ * PhoneNumberIds: [ // NonEmptyStringList // required
38
+ * "STRING_VALUE",
39
+ * ],
40
+ * };
41
+ * const command = new BatchDeletePhoneNumberCommand(input);
42
+ * const response = await client.send(command);
43
+ * ```
44
+ *
45
+ * @param BatchDeletePhoneNumberCommandInput - {@link BatchDeletePhoneNumberCommandInput}
46
+ * @returns {@link BatchDeletePhoneNumberCommandOutput}
47
+ * @see {@link BatchDeletePhoneNumberCommandInput} for command's `input` shape.
48
+ * @see {@link BatchDeletePhoneNumberCommandOutput} for command's `response` shape.
49
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
50
+ *
51
+ * @throws {@link BadRequestException} (client fault)
52
+ * <p>The input parameters don't match the service's restrictions.</p>
53
+ *
54
+ * @throws {@link ForbiddenException} (client fault)
55
+ * <p>The client is permanently forbidden from making the request.</p>
56
+ *
57
+ * @throws {@link NotFoundException} (client fault)
58
+ * <p>The requested resource couldn't be found.</p>
59
+ *
60
+ * @throws {@link ServiceFailureException} (server fault)
61
+ * <p>The service encountered an unexpected error.</p>
62
+ *
63
+ * @throws {@link ServiceUnavailableException} (server fault)
64
+ * <p>The service is currently unavailable.</p>
65
+ *
66
+ * @throws {@link ThrottledClientException} (client fault)
67
+ * <p>The number of customer requests exceeds the request rate limit.</p>
68
+ *
69
+ * @throws {@link UnauthorizedClientException} (client fault)
70
+ * <p>The client isn't authorized to request a resource.</p>
71
+ *
72
+ *
73
+ */
20
74
  export declare class BatchDeletePhoneNumberCommand extends $Command<BatchDeletePhoneNumberCommandInput, BatchDeletePhoneNumberCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
75
  readonly input: BatchDeletePhoneNumberCommandInput;
22
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,57 @@ export interface BatchUpdatePhoneNumberCommandInput extends BatchUpdatePhoneNumb
17
17
  */
18
18
  export interface BatchUpdatePhoneNumberCommandOutput extends BatchUpdatePhoneNumberResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Updates one or more phone numbers.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { ChimeSDKVoiceClient, BatchUpdatePhoneNumberCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
27
+ * // const { ChimeSDKVoiceClient, BatchUpdatePhoneNumberCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
28
+ * const client = new ChimeSDKVoiceClient(config);
29
+ * const input = { // BatchUpdatePhoneNumberRequest
30
+ * UpdatePhoneNumberRequestItems: [ // UpdatePhoneNumberRequestItemList // required
31
+ * { // UpdatePhoneNumberRequestItem
32
+ * PhoneNumberId: "STRING_VALUE", // required
33
+ * ProductType: "VoiceConnector" || "SipMediaApplicationDialIn",
34
+ * CallingName: "STRING_VALUE",
35
+ * },
36
+ * ],
37
+ * };
38
+ * const command = new BatchUpdatePhoneNumberCommand(input);
39
+ * const response = await client.send(command);
40
+ * ```
41
+ *
42
+ * @param BatchUpdatePhoneNumberCommandInput - {@link BatchUpdatePhoneNumberCommandInput}
43
+ * @returns {@link BatchUpdatePhoneNumberCommandOutput}
44
+ * @see {@link BatchUpdatePhoneNumberCommandInput} for command's `input` shape.
45
+ * @see {@link BatchUpdatePhoneNumberCommandOutput} for command's `response` shape.
46
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
47
+ *
48
+ * @throws {@link BadRequestException} (client fault)
49
+ * <p>The input parameters don't match the service's restrictions.</p>
50
+ *
51
+ * @throws {@link ForbiddenException} (client fault)
52
+ * <p>The client is permanently forbidden from making the request.</p>
53
+ *
54
+ * @throws {@link NotFoundException} (client fault)
55
+ * <p>The requested resource couldn't be found.</p>
56
+ *
57
+ * @throws {@link ServiceFailureException} (server fault)
58
+ * <p>The service encountered an unexpected error.</p>
59
+ *
60
+ * @throws {@link ServiceUnavailableException} (server fault)
61
+ * <p>The service is currently unavailable.</p>
62
+ *
63
+ * @throws {@link ThrottledClientException} (client fault)
64
+ * <p>The number of customer requests exceeds the request rate limit.</p>
65
+ *
66
+ * @throws {@link UnauthorizedClientException} (client fault)
67
+ * <p>The client isn't authorized to request a resource.</p>
68
+ *
69
+ *
70
+ */
20
71
  export declare class BatchUpdatePhoneNumberCommand extends $Command<BatchUpdatePhoneNumberCommandInput, BatchUpdatePhoneNumberCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
72
  readonly input: BatchUpdatePhoneNumberCommandInput;
22
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,57 @@ export interface CreatePhoneNumberOrderCommandInput extends CreatePhoneNumberOrd
17
17
  */
18
18
  export interface CreatePhoneNumberOrderCommandOutput extends CreatePhoneNumberOrderResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Creates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.</p>
23
+ * @example
24
+ * Use a bare-bones client and the command you need to make an API call.
25
+ * ```javascript
26
+ * import { ChimeSDKVoiceClient, CreatePhoneNumberOrderCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
27
+ * // const { ChimeSDKVoiceClient, CreatePhoneNumberOrderCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
28
+ * const client = new ChimeSDKVoiceClient(config);
29
+ * const input = { // CreatePhoneNumberOrderRequest
30
+ * ProductType: "VoiceConnector" || "SipMediaApplicationDialIn", // required
31
+ * E164PhoneNumbers: [ // E164PhoneNumberList // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * };
35
+ * const command = new CreatePhoneNumberOrderCommand(input);
36
+ * const response = await client.send(command);
37
+ * ```
38
+ *
39
+ * @param CreatePhoneNumberOrderCommandInput - {@link CreatePhoneNumberOrderCommandInput}
40
+ * @returns {@link CreatePhoneNumberOrderCommandOutput}
41
+ * @see {@link CreatePhoneNumberOrderCommandInput} for command's `input` shape.
42
+ * @see {@link CreatePhoneNumberOrderCommandOutput} for command's `response` shape.
43
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
44
+ *
45
+ * @throws {@link AccessDeniedException} (client fault)
46
+ * <p>You don't have the permissions needed to run this action.</p>
47
+ *
48
+ * @throws {@link BadRequestException} (client fault)
49
+ * <p>The input parameters don't match the service's restrictions.</p>
50
+ *
51
+ * @throws {@link ForbiddenException} (client fault)
52
+ * <p>The client is permanently forbidden from making the request.</p>
53
+ *
54
+ * @throws {@link ResourceLimitExceededException} (client fault)
55
+ * <p>The request exceeds the resource limit.</p>
56
+ *
57
+ * @throws {@link ServiceFailureException} (server fault)
58
+ * <p>The service encountered an unexpected error.</p>
59
+ *
60
+ * @throws {@link ServiceUnavailableException} (server fault)
61
+ * <p>The service is currently unavailable.</p>
62
+ *
63
+ * @throws {@link ThrottledClientException} (client fault)
64
+ * <p>The number of customer requests exceeds the request rate limit.</p>
65
+ *
66
+ * @throws {@link UnauthorizedClientException} (client fault)
67
+ * <p>The client isn't authorized to request a resource.</p>
68
+ *
69
+ *
70
+ */
20
71
  export declare class CreatePhoneNumberOrderCommand extends $Command<CreatePhoneNumberOrderCommandInput, CreatePhoneNumberOrderCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
72
  readonly input: CreatePhoneNumberOrderCommandInput;
22
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,66 @@ export interface CreateProxySessionCommandInput extends CreateProxySessionReques
17
17
  */
18
18
  export interface CreateProxySessionCommandOutput extends CreateProxySessionResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Creates a proxy session for the specified Amazon Chime SDK Voice Connector for
23
+ * the specified participant phone numbers.</p>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { ChimeSDKVoiceClient, CreateProxySessionCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
28
+ * // const { ChimeSDKVoiceClient, CreateProxySessionCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
29
+ * const client = new ChimeSDKVoiceClient(config);
30
+ * const input = { // CreateProxySessionRequest
31
+ * VoiceConnectorId: "STRING_VALUE", // required
32
+ * ParticipantPhoneNumbers: [ // ParticipantPhoneNumberList // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * Name: "STRING_VALUE",
36
+ * ExpiryMinutes: Number("int"),
37
+ * Capabilities: [ // CapabilityList // required
38
+ * "Voice" || "SMS",
39
+ * ],
40
+ * NumberSelectionBehavior: "PreferSticky" || "AvoidSticky",
41
+ * GeoMatchLevel: "Country" || "AreaCode",
42
+ * GeoMatchParams: { // GeoMatchParams
43
+ * Country: "STRING_VALUE", // required
44
+ * AreaCode: "STRING_VALUE", // required
45
+ * },
46
+ * };
47
+ * const command = new CreateProxySessionCommand(input);
48
+ * const response = await client.send(command);
49
+ * ```
50
+ *
51
+ * @param CreateProxySessionCommandInput - {@link CreateProxySessionCommandInput}
52
+ * @returns {@link CreateProxySessionCommandOutput}
53
+ * @see {@link CreateProxySessionCommandInput} for command's `input` shape.
54
+ * @see {@link CreateProxySessionCommandOutput} for command's `response` shape.
55
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
56
+ *
57
+ * @throws {@link BadRequestException} (client fault)
58
+ * <p>The input parameters don't match the service's restrictions.</p>
59
+ *
60
+ * @throws {@link ForbiddenException} (client fault)
61
+ * <p>The client is permanently forbidden from making the request.</p>
62
+ *
63
+ * @throws {@link NotFoundException} (client fault)
64
+ * <p>The requested resource couldn't be found.</p>
65
+ *
66
+ * @throws {@link ServiceFailureException} (server fault)
67
+ * <p>The service encountered an unexpected error.</p>
68
+ *
69
+ * @throws {@link ServiceUnavailableException} (server fault)
70
+ * <p>The service is currently unavailable.</p>
71
+ *
72
+ * @throws {@link ThrottledClientException} (client fault)
73
+ * <p>The number of customer requests exceeds the request rate limit.</p>
74
+ *
75
+ * @throws {@link UnauthorizedClientException} (client fault)
76
+ * <p>The client isn't authorized to request a resource.</p>
77
+ *
78
+ *
79
+ */
20
80
  export declare class CreateProxySessionCommand extends $Command<CreateProxySessionCommandInput, CreateProxySessionCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
81
  readonly input: CreateProxySessionCommandInput;
22
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,64 @@ export interface CreateSipMediaApplicationCallCommandInput extends CreateSipMedi
17
17
  */
18
18
  export interface CreateSipMediaApplicationCallCommandOutput extends CreateSipMediaApplicationCallResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Creates an outbound call to a phone number from the phone number specified
23
+ * in the request, and it invokes the endpoint of the specified
24
+ * <code>sipMediaApplicationId</code>.</p>
25
+ * @example
26
+ * Use a bare-bones client and the command you need to make an API call.
27
+ * ```javascript
28
+ * import { ChimeSDKVoiceClient, CreateSipMediaApplicationCallCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
29
+ * // const { ChimeSDKVoiceClient, CreateSipMediaApplicationCallCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
30
+ * const client = new ChimeSDKVoiceClient(config);
31
+ * const input = { // CreateSipMediaApplicationCallRequest
32
+ * FromPhoneNumber: "STRING_VALUE", // required
33
+ * ToPhoneNumber: "STRING_VALUE", // required
34
+ * SipMediaApplicationId: "STRING_VALUE", // required
35
+ * SipHeaders: { // SipHeadersMap
36
+ * "<keys>": "STRING_VALUE",
37
+ * },
38
+ * ArgumentsMap: { // SMACreateCallArgumentsMap
39
+ * "<keys>": "STRING_VALUE",
40
+ * },
41
+ * };
42
+ * const command = new CreateSipMediaApplicationCallCommand(input);
43
+ * const response = await client.send(command);
44
+ * ```
45
+ *
46
+ * @param CreateSipMediaApplicationCallCommandInput - {@link CreateSipMediaApplicationCallCommandInput}
47
+ * @returns {@link CreateSipMediaApplicationCallCommandOutput}
48
+ * @see {@link CreateSipMediaApplicationCallCommandInput} for command's `input` shape.
49
+ * @see {@link CreateSipMediaApplicationCallCommandOutput} for command's `response` shape.
50
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
51
+ *
52
+ * @throws {@link AccessDeniedException} (client fault)
53
+ * <p>You don't have the permissions needed to run this action.</p>
54
+ *
55
+ * @throws {@link BadRequestException} (client fault)
56
+ * <p>The input parameters don't match the service's restrictions.</p>
57
+ *
58
+ * @throws {@link ForbiddenException} (client fault)
59
+ * <p>The client is permanently forbidden from making the request.</p>
60
+ *
61
+ * @throws {@link ResourceLimitExceededException} (client fault)
62
+ * <p>The request exceeds the resource limit.</p>
63
+ *
64
+ * @throws {@link ServiceFailureException} (server fault)
65
+ * <p>The service encountered an unexpected error.</p>
66
+ *
67
+ * @throws {@link ServiceUnavailableException} (server fault)
68
+ * <p>The service is currently unavailable.</p>
69
+ *
70
+ * @throws {@link ThrottledClientException} (client fault)
71
+ * <p>The number of customer requests exceeds the request rate limit.</p>
72
+ *
73
+ * @throws {@link UnauthorizedClientException} (client fault)
74
+ * <p>The client isn't authorized to request a resource.</p>
75
+ *
76
+ *
77
+ */
20
78
  export declare class CreateSipMediaApplicationCallCommand extends $Command<CreateSipMediaApplicationCallCommandInput, CreateSipMediaApplicationCallCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
79
  readonly input: CreateSipMediaApplicationCallCommandInput;
22
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,64 @@ export interface CreateSipMediaApplicationCommandInput extends CreateSipMediaApp
17
17
  */
18
18
  export interface CreateSipMediaApplicationCommandOutput extends CreateSipMediaApplicationResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Creates a SIP media application. For more information about SIP media applications, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html">Managing SIP media applications
23
+ * and rules</a> in the <i>Amazon Chime SDK Administrator Guide</i>.</p>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { ChimeSDKVoiceClient, CreateSipMediaApplicationCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
28
+ * // const { ChimeSDKVoiceClient, CreateSipMediaApplicationCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
29
+ * const client = new ChimeSDKVoiceClient(config);
30
+ * const input = { // CreateSipMediaApplicationRequest
31
+ * AwsRegion: "STRING_VALUE", // required
32
+ * Name: "STRING_VALUE", // required
33
+ * Endpoints: [ // SipMediaApplicationEndpointList // required
34
+ * { // SipMediaApplicationEndpoint
35
+ * LambdaArn: "STRING_VALUE",
36
+ * },
37
+ * ],
38
+ * };
39
+ * const command = new CreateSipMediaApplicationCommand(input);
40
+ * const response = await client.send(command);
41
+ * ```
42
+ *
43
+ * @param CreateSipMediaApplicationCommandInput - {@link CreateSipMediaApplicationCommandInput}
44
+ * @returns {@link CreateSipMediaApplicationCommandOutput}
45
+ * @see {@link CreateSipMediaApplicationCommandInput} for command's `input` shape.
46
+ * @see {@link CreateSipMediaApplicationCommandOutput} for command's `response` shape.
47
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
48
+ *
49
+ * @throws {@link AccessDeniedException} (client fault)
50
+ * <p>You don't have the permissions needed to run this action.</p>
51
+ *
52
+ * @throws {@link BadRequestException} (client fault)
53
+ * <p>The input parameters don't match the service's restrictions.</p>
54
+ *
55
+ * @throws {@link ConflictException} (client fault)
56
+ * <p>Multiple instances of the same request were made simultaneously.</p>
57
+ *
58
+ * @throws {@link ForbiddenException} (client fault)
59
+ * <p>The client is permanently forbidden from making the request.</p>
60
+ *
61
+ * @throws {@link ResourceLimitExceededException} (client fault)
62
+ * <p>The request exceeds the resource limit.</p>
63
+ *
64
+ * @throws {@link ServiceFailureException} (server fault)
65
+ * <p>The service encountered an unexpected error.</p>
66
+ *
67
+ * @throws {@link ServiceUnavailableException} (server fault)
68
+ * <p>The service is currently unavailable.</p>
69
+ *
70
+ * @throws {@link ThrottledClientException} (client fault)
71
+ * <p>The number of customer requests exceeds the request rate limit.</p>
72
+ *
73
+ * @throws {@link UnauthorizedClientException} (client fault)
74
+ * <p>The client isn't authorized to request a resource.</p>
75
+ *
76
+ *
77
+ */
20
78
  export declare class CreateSipMediaApplicationCommand extends $Command<CreateSipMediaApplicationCommandInput, CreateSipMediaApplicationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
79
  readonly input: CreateSipMediaApplicationCommandInput;
22
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,68 @@ export interface CreateSipRuleCommandInput extends CreateSipRuleRequest {
17
17
  */
18
18
  export interface CreateSipRuleCommandOutput extends CreateSipRuleResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html">Managing SIP media applications
23
+ * and rules</a> in the <i>Amazon Chime SDK Administrator Guide</i>.</p>
24
+ * @example
25
+ * Use a bare-bones client and the command you need to make an API call.
26
+ * ```javascript
27
+ * import { ChimeSDKVoiceClient, CreateSipRuleCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
28
+ * // const { ChimeSDKVoiceClient, CreateSipRuleCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
29
+ * const client = new ChimeSDKVoiceClient(config);
30
+ * const input = { // CreateSipRuleRequest
31
+ * Name: "STRING_VALUE", // required
32
+ * TriggerType: "ToPhoneNumber" || "RequestUriHostname", // required
33
+ * TriggerValue: "STRING_VALUE", // required
34
+ * Disabled: true || false,
35
+ * TargetApplications: [ // SipRuleTargetApplicationList
36
+ * { // SipRuleTargetApplication
37
+ * SipMediaApplicationId: "STRING_VALUE",
38
+ * Priority: Number("int"),
39
+ * AwsRegion: "STRING_VALUE",
40
+ * },
41
+ * ],
42
+ * };
43
+ * const command = new CreateSipRuleCommand(input);
44
+ * const response = await client.send(command);
45
+ * ```
46
+ *
47
+ * @param CreateSipRuleCommandInput - {@link CreateSipRuleCommandInput}
48
+ * @returns {@link CreateSipRuleCommandOutput}
49
+ * @see {@link CreateSipRuleCommandInput} for command's `input` shape.
50
+ * @see {@link CreateSipRuleCommandOutput} for command's `response` shape.
51
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
52
+ *
53
+ * @throws {@link AccessDeniedException} (client fault)
54
+ * <p>You don't have the permissions needed to run this action.</p>
55
+ *
56
+ * @throws {@link BadRequestException} (client fault)
57
+ * <p>The input parameters don't match the service's restrictions.</p>
58
+ *
59
+ * @throws {@link ConflictException} (client fault)
60
+ * <p>Multiple instances of the same request were made simultaneously.</p>
61
+ *
62
+ * @throws {@link ForbiddenException} (client fault)
63
+ * <p>The client is permanently forbidden from making the request.</p>
64
+ *
65
+ * @throws {@link ResourceLimitExceededException} (client fault)
66
+ * <p>The request exceeds the resource limit.</p>
67
+ *
68
+ * @throws {@link ServiceFailureException} (server fault)
69
+ * <p>The service encountered an unexpected error.</p>
70
+ *
71
+ * @throws {@link ServiceUnavailableException} (server fault)
72
+ * <p>The service is currently unavailable.</p>
73
+ *
74
+ * @throws {@link ThrottledClientException} (client fault)
75
+ * <p>The number of customer requests exceeds the request rate limit.</p>
76
+ *
77
+ * @throws {@link UnauthorizedClientException} (client fault)
78
+ * <p>The client isn't authorized to request a resource.</p>
79
+ *
80
+ *
81
+ */
20
82
  export declare class CreateSipRuleCommand extends $Command<CreateSipRuleCommandInput, CreateSipRuleCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
83
  readonly input: CreateSipRuleCommandInput;
22
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
@@ -17,6 +17,59 @@ export interface CreateVoiceConnectorCommandInput extends CreateVoiceConnectorRe
17
17
  */
18
18
  export interface CreateVoiceConnectorCommandOutput extends CreateVoiceConnectorResponse, __MetadataBearer {
19
19
  }
20
+ /**
21
+ * @public
22
+ * <p>Creates an Amazon Chime SDK Voice Connector. For more information about
23
+ * Voice Connectors,
24
+ * see <a href="https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html">Managing Amazon Chime SDK Voice Connector groups</a> in the <i>Amazon Chime SDK
25
+ * Administrator Guide</i>.</p>
26
+ * @example
27
+ * Use a bare-bones client and the command you need to make an API call.
28
+ * ```javascript
29
+ * import { ChimeSDKVoiceClient, CreateVoiceConnectorCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
30
+ * // const { ChimeSDKVoiceClient, CreateVoiceConnectorCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
31
+ * const client = new ChimeSDKVoiceClient(config);
32
+ * const input = { // CreateVoiceConnectorRequest
33
+ * Name: "STRING_VALUE", // required
34
+ * 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",
35
+ * RequireEncryption: true || false, // required
36
+ * };
37
+ * const command = new CreateVoiceConnectorCommand(input);
38
+ * const response = await client.send(command);
39
+ * ```
40
+ *
41
+ * @param CreateVoiceConnectorCommandInput - {@link CreateVoiceConnectorCommandInput}
42
+ * @returns {@link CreateVoiceConnectorCommandOutput}
43
+ * @see {@link CreateVoiceConnectorCommandInput} for command's `input` shape.
44
+ * @see {@link CreateVoiceConnectorCommandOutput} for command's `response` shape.
45
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
46
+ *
47
+ * @throws {@link AccessDeniedException} (client fault)
48
+ * <p>You don't have the permissions needed to run this action.</p>
49
+ *
50
+ * @throws {@link BadRequestException} (client fault)
51
+ * <p>The input parameters don't match the service's restrictions.</p>
52
+ *
53
+ * @throws {@link ForbiddenException} (client fault)
54
+ * <p>The client is permanently forbidden from making the request.</p>
55
+ *
56
+ * @throws {@link ResourceLimitExceededException} (client fault)
57
+ * <p>The request exceeds the resource limit.</p>
58
+ *
59
+ * @throws {@link ServiceFailureException} (server fault)
60
+ * <p>The service encountered an unexpected error.</p>
61
+ *
62
+ * @throws {@link ServiceUnavailableException} (server fault)
63
+ * <p>The service is currently unavailable.</p>
64
+ *
65
+ * @throws {@link ThrottledClientException} (client fault)
66
+ * <p>The number of customer requests exceeds the request rate limit.</p>
67
+ *
68
+ * @throws {@link UnauthorizedClientException} (client fault)
69
+ * <p>The client isn't authorized to request a resource.</p>
70
+ *
71
+ *
72
+ */
20
73
  export declare class CreateVoiceConnectorCommand extends $Command<CreateVoiceConnectorCommandInput, CreateVoiceConnectorCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
21
74
  readonly input: CreateVoiceConnectorCommandInput;
22
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;