@aws-sdk/client-chime-sdk-voice 3.299.0 → 3.301.0

package/dist-types/commands/GetVoiceConnectorStreamingConfigurationCommand.d.ts

@@ -17,6 +17,53 @@ export interface GetVoiceConnectorStreamingConfigurationCommandInput extends Get
  */
 export interface GetVoiceConnectorStreamingConfigurationCommandOutput extends GetVoiceConnectorStreamingConfigurationResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Retrieves the streaming configuration details for the specified Amazon Chime SDK
+ *          Voice Connector. Shows whether media streaming is enabled for sending to Amazon
+ *          Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, GetVoiceConnectorStreamingConfigurationCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, GetVoiceConnectorStreamingConfigurationCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // GetVoiceConnectorStreamingConfigurationRequest
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ * };
+ * const command = new GetVoiceConnectorStreamingConfigurationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param GetVoiceConnectorStreamingConfigurationCommandInput - {@link GetVoiceConnectorStreamingConfigurationCommandInput}
+ * @returns {@link GetVoiceConnectorStreamingConfigurationCommandOutput}
+ * @see {@link GetVoiceConnectorStreamingConfigurationCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceConnectorStreamingConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class GetVoiceConnectorStreamingConfigurationCommand extends $Command<GetVoiceConnectorStreamingConfigurationCommandInput, GetVoiceConnectorStreamingConfigurationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: GetVoiceConnectorStreamingConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/GetVoiceConnectorTerminationCommand.d.ts

@@ -17,6 +17,51 @@ export interface GetVoiceConnectorTerminationCommandInput extends GetVoiceConnec
  */
 export interface GetVoiceConnectorTerminationCommandOutput extends GetVoiceConnectorTerminationResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Retrieves the termination setting details for the specified Voice Connector.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, GetVoiceConnectorTerminationCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, GetVoiceConnectorTerminationCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // GetVoiceConnectorTerminationRequest
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ * };
+ * const command = new GetVoiceConnectorTerminationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param GetVoiceConnectorTerminationCommandInput - {@link GetVoiceConnectorTerminationCommandInput}
+ * @returns {@link GetVoiceConnectorTerminationCommandOutput}
+ * @see {@link GetVoiceConnectorTerminationCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceConnectorTerminationCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class GetVoiceConnectorTerminationCommand extends $Command<GetVoiceConnectorTerminationCommandInput, GetVoiceConnectorTerminationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: GetVoiceConnectorTerminationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/GetVoiceConnectorTerminationHealthCommand.d.ts

@@ -17,6 +17,53 @@ export interface GetVoiceConnectorTerminationHealthCommandInput extends GetVoice
  */
 export interface GetVoiceConnectorTerminationHealthCommandOutput extends GetVoiceConnectorTerminationHealthResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Retrieves information about the last time a <code>SIP OPTIONS</code> ping
+ *          was received from your SIP infrastructure for the specified Amazon Chime SDK Voice
+ *          Connector.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, GetVoiceConnectorTerminationHealthCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, GetVoiceConnectorTerminationHealthCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // GetVoiceConnectorTerminationHealthRequest
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ * };
+ * const command = new GetVoiceConnectorTerminationHealthCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param GetVoiceConnectorTerminationHealthCommandInput - {@link GetVoiceConnectorTerminationHealthCommandInput}
+ * @returns {@link GetVoiceConnectorTerminationHealthCommandOutput}
+ * @see {@link GetVoiceConnectorTerminationHealthCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceConnectorTerminationHealthCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class GetVoiceConnectorTerminationHealthCommand extends $Command<GetVoiceConnectorTerminationHealthCommandInput, GetVoiceConnectorTerminationHealthCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: GetVoiceConnectorTerminationHealthCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/GetVoiceProfileCommand.d.ts

@@ -17,6 +17,54 @@ export interface GetVoiceProfileCommandInput extends GetVoiceProfileRequest {
  */
 export interface GetVoiceProfileCommandOutput extends GetVoiceProfileResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Retrieves the details of the specified voice profile.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, GetVoiceProfileCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, GetVoiceProfileCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // GetVoiceProfileRequest
+ *   VoiceProfileId: "STRING_VALUE", // required
+ * };
+ * const command = new GetVoiceProfileCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param GetVoiceProfileCommandInput - {@link GetVoiceProfileCommandInput}
+ * @returns {@link GetVoiceProfileCommandOutput}
+ * @see {@link GetVoiceProfileCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceProfileCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have the permissions needed to run this action.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class GetVoiceProfileCommand extends $Command<GetVoiceProfileCommandInput, GetVoiceProfileCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: GetVoiceProfileCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/GetVoiceProfileDomainCommand.d.ts

@@ -17,6 +17,54 @@ export interface GetVoiceProfileDomainCommandInput extends GetVoiceProfileDomain
  */
 export interface GetVoiceProfileDomainCommandOutput extends GetVoiceProfileDomainResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Retrieves the details of the specified voice profile domain.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, GetVoiceProfileDomainCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, GetVoiceProfileDomainCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // GetVoiceProfileDomainRequest
+ *   VoiceProfileDomainId: "STRING_VALUE", // required
+ * };
+ * const command = new GetVoiceProfileDomainCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param GetVoiceProfileDomainCommandInput - {@link GetVoiceProfileDomainCommandInput}
+ * @returns {@link GetVoiceProfileDomainCommandOutput}
+ * @see {@link GetVoiceProfileDomainCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceProfileDomainCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have the permissions needed to run this action.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class GetVoiceProfileDomainCommand extends $Command<GetVoiceProfileDomainCommandInput, GetVoiceProfileDomainCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: GetVoiceProfileDomainCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/GetVoiceToneAnalysisTaskCommand.d.ts

@@ -17,6 +17,59 @@ export interface GetVoiceToneAnalysisTaskCommandInput extends GetVoiceToneAnalys
  */
 export interface GetVoiceToneAnalysisTaskCommandOutput extends GetVoiceToneAnalysisTaskResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Retrieves the details of a voice tone analysis task.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, GetVoiceToneAnalysisTaskCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, GetVoiceToneAnalysisTaskCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // GetVoiceToneAnalysisTaskRequest
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   VoiceToneAnalysisTaskId: "STRING_VALUE", // required
+ *   IsCaller: true || false, // required
+ * };
+ * const command = new GetVoiceToneAnalysisTaskCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param GetVoiceToneAnalysisTaskCommandInput - {@link GetVoiceToneAnalysisTaskCommandInput}
+ * @returns {@link GetVoiceToneAnalysisTaskCommandOutput}
+ * @see {@link GetVoiceToneAnalysisTaskCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceToneAnalysisTaskCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have the permissions needed to run this action.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Multiple instances of the same request were made simultaneously.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class GetVoiceToneAnalysisTaskCommand extends $Command<GetVoiceToneAnalysisTaskCommandInput, GetVoiceToneAnalysisTaskCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: GetVoiceToneAnalysisTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/ListAvailableVoiceConnectorRegionsCommand.d.ts

@@ -17,6 +17,46 @@ export interface ListAvailableVoiceConnectorRegionsCommandInput {
  */
 export interface ListAvailableVoiceConnectorRegionsCommandOutput extends ListAvailableVoiceConnectorRegionsResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Lists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, ListAvailableVoiceConnectorRegionsCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, ListAvailableVoiceConnectorRegionsCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {};
+ * const command = new ListAvailableVoiceConnectorRegionsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param ListAvailableVoiceConnectorRegionsCommandInput - {@link ListAvailableVoiceConnectorRegionsCommandInput}
+ * @returns {@link ListAvailableVoiceConnectorRegionsCommandOutput}
+ * @see {@link ListAvailableVoiceConnectorRegionsCommandInput} for command's `input` shape.
+ * @see {@link ListAvailableVoiceConnectorRegionsCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class ListAvailableVoiceConnectorRegionsCommand extends $Command<ListAvailableVoiceConnectorRegionsCommandInput, ListAvailableVoiceConnectorRegionsCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: ListAvailableVoiceConnectorRegionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/ListPhoneNumberOrdersCommand.d.ts

@@ -17,6 +17,49 @@ export interface ListPhoneNumberOrdersCommandInput extends ListPhoneNumberOrders
  */
 export interface ListPhoneNumberOrdersCommandOutput extends ListPhoneNumberOrdersResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Lists the phone numbers for an administrator's Amazon Chime SDK account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, ListPhoneNumberOrdersCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, ListPhoneNumberOrdersCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // ListPhoneNumberOrdersRequest
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListPhoneNumberOrdersCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param ListPhoneNumberOrdersCommandInput - {@link ListPhoneNumberOrdersCommandInput}
+ * @returns {@link ListPhoneNumberOrdersCommandOutput}
+ * @see {@link ListPhoneNumberOrdersCommandInput} for command's `input` shape.
+ * @see {@link ListPhoneNumberOrdersCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class ListPhoneNumberOrdersCommand extends $Command<ListPhoneNumberOrdersCommandInput, ListPhoneNumberOrdersCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: ListPhoneNumberOrdersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/ListPhoneNumbersCommand.d.ts

@@ -17,6 +17,58 @@ export interface ListPhoneNumbersCommandInput extends ListPhoneNumbersRequest {
  */
 export interface ListPhoneNumbersCommandOutput extends ListPhoneNumbersResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Lists the phone numbers for the specified Amazon Chime SDK account,
+ *          Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice
+ *          Connector group.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, ListPhoneNumbersCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, ListPhoneNumbersCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // ListPhoneNumbersRequest
+ *   Status: "STRING_VALUE",
+ *   ProductType: "VoiceConnector" || "SipMediaApplicationDialIn",
+ *   FilterName: "VoiceConnectorId" || "VoiceConnectorGroupId" || "SipRuleId",
+ *   FilterValue: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListPhoneNumbersCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param ListPhoneNumbersCommandInput - {@link ListPhoneNumbersCommandInput}
+ * @returns {@link ListPhoneNumbersCommandOutput}
+ * @see {@link ListPhoneNumbersCommandInput} for command's `input` shape.
+ * @see {@link ListPhoneNumbersCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class ListPhoneNumbersCommand extends $Command<ListPhoneNumbersCommandInput, ListPhoneNumbersCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: ListPhoneNumbersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/ListProxySessionsCommand.d.ts

@@ -17,6 +17,54 @@ export interface ListProxySessionsCommandInput extends ListProxySessionsRequest
  */
 export interface ListProxySessionsCommandOutput extends ListProxySessionsResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Lists the proxy sessions for the specified Amazon Chime SDK Voice Connector.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, ListProxySessionsCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, ListProxySessionsCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // ListProxySessionsRequest
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   Status: "Open" || "InProgress" || "Closed",
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new ListProxySessionsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param ListProxySessionsCommandInput - {@link ListProxySessionsCommandInput}
+ * @returns {@link ListProxySessionsCommandOutput}
+ * @see {@link ListProxySessionsCommandInput} for command's `input` shape.
+ * @see {@link ListProxySessionsCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class ListProxySessionsCommand extends $Command<ListProxySessionsCommandInput, ListProxySessionsCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: ListProxySessionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/ListSipMediaApplicationsCommand.d.ts

@@ -17,6 +17,49 @@ export interface ListSipMediaApplicationsCommandInput extends ListSipMediaApplic
  */
 export interface ListSipMediaApplicationsCommandOutput extends ListSipMediaApplicationsResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Lists the SIP media applications  under the administrator's AWS account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, ListSipMediaApplicationsCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, ListSipMediaApplicationsCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // ListSipMediaApplicationsRequest
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListSipMediaApplicationsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param ListSipMediaApplicationsCommandInput - {@link ListSipMediaApplicationsCommandInput}
+ * @returns {@link ListSipMediaApplicationsCommandOutput}
+ * @see {@link ListSipMediaApplicationsCommandInput} for command's `input` shape.
+ * @see {@link ListSipMediaApplicationsCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class ListSipMediaApplicationsCommand extends $Command<ListSipMediaApplicationsCommandInput, ListSipMediaApplicationsCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: ListSipMediaApplicationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

package/dist-types/commands/ListSipRulesCommand.d.ts

@@ -17,6 +17,50 @@ export interface ListSipRulesCommandInput extends ListSipRulesRequest {
  */
 export interface ListSipRulesCommandOutput extends ListSipRulesResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Lists the SIP rules under the administrator's AWS account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, ListSipRulesCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, ListSipRulesCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = { // ListSipRulesRequest
+ *   SipMediaApplicationId: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListSipRulesCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param ListSipRulesCommandInput - {@link ListSipRulesCommandInput}
+ * @returns {@link ListSipRulesCommandOutput}
+ * @see {@link ListSipRulesCommandInput} for command's `input` shape.
+ * @see {@link ListSipRulesCommandOutput} for command's `response` shape.
+ * @see {@link ChimeSDKVoiceClientResolvedConfig | config} for ChimeSDKVoiceClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The input parameters don't match the service's restrictions.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The client is permanently forbidden from making the request.</p>
+ *
+ * @throws {@link ServiceFailureException} (server fault)
+ *  <p>The service encountered an unexpected error.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service is currently unavailable.</p>
+ *
+ * @throws {@link ThrottledClientException} (client fault)
+ *  <p>The number of customer requests exceeds the request rate limit.</p>
+ *
+ * @throws {@link UnauthorizedClientException} (client fault)
+ *  <p>The client isn't authorized to request a resource.</p>
+ *
+ *
+ */
 export declare class ListSipRulesCommand extends $Command<ListSipRulesCommandInput, ListSipRulesCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: ListSipRulesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;