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

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

@@ -17,6 +17,60 @@ export interface PutVoiceConnectorProxyCommandInput extends PutVoiceConnectorPro
  */
 export interface PutVoiceConnectorProxyCommandOutput extends PutVoiceConnectorProxyResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Puts the specified proxy configuration to 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, PutVoiceConnectorProxyCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, PutVoiceConnectorProxyCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   DefaultSessionExpiryMinutes: Number("int"), // required
+ *   PhoneNumberPoolCountries: [ // required
+ *     "STRING_VALUE",
+ *   ],
+ *   FallBackPhoneNumber: "STRING_VALUE",
+ *   Disabled: true || false,
+ * };
+ * const command = new PutVoiceConnectorProxyCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param PutVoiceConnectorProxyCommandInput - {@link PutVoiceConnectorProxyCommandInput}
+ * @returns {@link PutVoiceConnectorProxyCommandOutput}
+ * @see {@link PutVoiceConnectorProxyCommandInput} for command's `input` shape.
+ * @see {@link PutVoiceConnectorProxyCommandOutput} 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 PutVoiceConnectorProxyCommand extends $Command<PutVoiceConnectorProxyCommandInput, PutVoiceConnectorProxyCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: PutVoiceConnectorProxyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,64 @@ export interface PutVoiceConnectorStreamingConfigurationCommandInput extends Put
  */
 export interface PutVoiceConnectorStreamingConfigurationCommandOutput extends PutVoiceConnectorStreamingConfigurationResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Updates a Voice Connector's streaming configuration settings.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, PutVoiceConnectorStreamingConfigurationCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, PutVoiceConnectorStreamingConfigurationCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   StreamingConfiguration: {
+ *     DataRetentionInHours: Number("int"), // required
+ *     Disabled: true || false, // required
+ *     StreamingNotificationTargets: [
+ *       {
+ *         NotificationTarget: "EventBridge" || "SNS" || "SQS",
+ *       },
+ *     ],
+ *     MediaInsightsConfiguration: {
+ *       Disabled: true || false,
+ *       ConfigurationArn: "STRING_VALUE",
+ *     },
+ *   },
+ * };
+ * const command = new PutVoiceConnectorStreamingConfigurationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param PutVoiceConnectorStreamingConfigurationCommandInput - {@link PutVoiceConnectorStreamingConfigurationCommandInput}
+ * @returns {@link PutVoiceConnectorStreamingConfigurationCommandOutput}
+ * @see {@link PutVoiceConnectorStreamingConfigurationCommandInput} for command's `input` shape.
+ * @see {@link PutVoiceConnectorStreamingConfigurationCommandOutput} 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 PutVoiceConnectorStreamingConfigurationCommand extends $Command<PutVoiceConnectorStreamingConfigurationCommandInput, PutVoiceConnectorStreamingConfigurationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: PutVoiceConnectorStreamingConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,65 @@ export interface PutVoiceConnectorTerminationCommandInput extends PutVoiceConnec
  */
 export interface PutVoiceConnectorTerminationCommandOutput extends PutVoiceConnectorTerminationResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Updates a Voice Connector's termination settings.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, PutVoiceConnectorTerminationCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, PutVoiceConnectorTerminationCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   Termination: {
+ *     CpsLimit: Number("int"),
+ *     DefaultPhoneNumber: "STRING_VALUE",
+ *     CallingRegions: [
+ *       "STRING_VALUE",
+ *     ],
+ *     CidrAllowedList: [
+ *       "STRING_VALUE",
+ *     ],
+ *     Disabled: true || false,
+ *   },
+ * };
+ * const command = new PutVoiceConnectorTerminationCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param PutVoiceConnectorTerminationCommandInput - {@link PutVoiceConnectorTerminationCommandInput}
+ * @returns {@link PutVoiceConnectorTerminationCommandOutput}
+ * @see {@link PutVoiceConnectorTerminationCommandInput} for command's `input` shape.
+ * @see {@link PutVoiceConnectorTerminationCommandOutput} 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 PutVoiceConnectorTerminationCommand extends $Command<PutVoiceConnectorTerminationCommandInput, PutVoiceConnectorTerminationCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: PutVoiceConnectorTerminationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,57 @@ export interface PutVoiceConnectorTerminationCredentialsCommandInput extends Put
  */
 export interface PutVoiceConnectorTerminationCredentialsCommandOutput extends __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Updates a Voice Connector's termination credentials.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, PutVoiceConnectorTerminationCredentialsCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, PutVoiceConnectorTerminationCredentialsCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   Credentials: [
+ *     {
+ *       Username: "STRING_VALUE",
+ *       Password: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new PutVoiceConnectorTerminationCredentialsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param PutVoiceConnectorTerminationCredentialsCommandInput - {@link PutVoiceConnectorTerminationCredentialsCommandInput}
+ * @returns {@link PutVoiceConnectorTerminationCredentialsCommandOutput}
+ * @see {@link PutVoiceConnectorTerminationCredentialsCommandInput} for command's `input` shape.
+ * @see {@link PutVoiceConnectorTerminationCredentialsCommandOutput} 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 PutVoiceConnectorTerminationCredentialsCommand extends $Command<PutVoiceConnectorTerminationCredentialsCommandInput, PutVoiceConnectorTerminationCredentialsCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: PutVoiceConnectorTerminationCredentialsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,54 @@ export interface RestorePhoneNumberCommandInput extends RestorePhoneNumberReques
  */
 export interface RestorePhoneNumberCommandOutput extends RestorePhoneNumberResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Restores a deleted phone number.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, RestorePhoneNumberCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, RestorePhoneNumberCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   PhoneNumberId: "STRING_VALUE", // required
+ * };
+ * const command = new RestorePhoneNumberCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param RestorePhoneNumberCommandInput - {@link RestorePhoneNumberCommandInput}
+ * @returns {@link RestorePhoneNumberCommandOutput}
+ * @see {@link RestorePhoneNumberCommandInput} for command's `input` shape.
+ * @see {@link RestorePhoneNumberCommandOutput} 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 ResourceLimitExceededException} (client fault)
+ *  <p>The request exceeds the resource limit.</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 RestorePhoneNumberCommand extends $Command<RestorePhoneNumberCommandInput, RestorePhoneNumberCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: RestorePhoneNumberCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,58 @@ export interface SearchAvailablePhoneNumbersCommandInput extends SearchAvailable
  */
 export interface SearchAvailablePhoneNumbersCommandOutput extends SearchAvailablePhoneNumbersResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Searches the provisioned phone numbers in an organization.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, SearchAvailablePhoneNumbersCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, SearchAvailablePhoneNumbersCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   AreaCode: "STRING_VALUE",
+ *   City: "STRING_VALUE",
+ *   Country: "STRING_VALUE",
+ *   State: "STRING_VALUE",
+ *   TollFreePrefix: "STRING_VALUE",
+ *   PhoneNumberType: "Local" || "TollFree",
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new SearchAvailablePhoneNumbersCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param SearchAvailablePhoneNumbersCommandInput - {@link SearchAvailablePhoneNumbersCommandInput}
+ * @returns {@link SearchAvailablePhoneNumbersCommandOutput}
+ * @see {@link SearchAvailablePhoneNumbersCommandInput} for command's `input` shape.
+ * @see {@link SearchAvailablePhoneNumbersCommandOutput} 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 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 SearchAvailablePhoneNumbersCommand extends $Command<SearchAvailablePhoneNumbersCommandInput, SearchAvailablePhoneNumbersCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: SearchAvailablePhoneNumbersCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,73 @@ export interface StartSpeakerSearchTaskCommandInput extends StartSpeakerSearchTa
  */
 export interface StartSpeakerSearchTaskCommandOutput extends StartSpeakerSearchTaskResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Starts a speaker search task.</p>
+ *          <important>
+ *             <p>Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the
+ *          <a href="https://aws.amazon.com/service-terms/">AWS service terms</a> for the Amazon Chime SDK.</p>
+ *          </important>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, StartSpeakerSearchTaskCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, StartSpeakerSearchTaskCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   TransactionId: "STRING_VALUE", // required
+ *   VoiceProfileDomainId: "STRING_VALUE", // required
+ *   ClientRequestToken: "STRING_VALUE",
+ * };
+ * const command = new StartSpeakerSearchTaskCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param StartSpeakerSearchTaskCommandInput - {@link StartSpeakerSearchTaskCommandInput}
+ * @returns {@link StartSpeakerSearchTaskCommandOutput}
+ * @see {@link StartSpeakerSearchTaskCommandInput} for command's `input` shape.
+ * @see {@link StartSpeakerSearchTaskCommandOutput} 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 GoneException} (client fault)
+ *  <p>Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ResourceLimitExceededException} (client fault)
+ *  <p>The request exceeds the resource limit.</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>
+ *
+ * @throws {@link UnprocessableEntityException} (client fault)
+ *  <p>A well-formed request couldn't be followed due to semantic errors.</p>
+ *
+ *
+ */
 export declare class StartSpeakerSearchTaskCommand extends $Command<StartSpeakerSearchTaskCommandInput, StartSpeakerSearchTaskCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: StartSpeakerSearchTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,75 @@ export interface StartVoiceToneAnalysisTaskCommandInput extends StartVoiceToneAn
  */
 export interface StartVoiceToneAnalysisTaskCommandOutput extends StartVoiceToneAnalysisTaskResponse, __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Starts a voice tone analysis task. For more information about voice tone analysis, see
+ *          <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html">Using Amazon Chime SDK voice analytics</a>
+ *          in the <i>Amazon Chime SDK Developer Guide</i>.</p>
+ *          <important>
+ *             <p>Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the
+ *          <a href="https://aws.amazon.com/service-terms/">AWS service terms</a> for the Amazon Chime SDK.</p>
+ *          </important>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, StartVoiceToneAnalysisTaskCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, StartVoiceToneAnalysisTaskCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   TransactionId: "STRING_VALUE", // required
+ *   LanguageCode: "en-US", // required
+ *   ClientRequestToken: "STRING_VALUE",
+ * };
+ * const command = new StartVoiceToneAnalysisTaskCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param StartVoiceToneAnalysisTaskCommandInput - {@link StartVoiceToneAnalysisTaskCommandInput}
+ * @returns {@link StartVoiceToneAnalysisTaskCommandOutput}
+ * @see {@link StartVoiceToneAnalysisTaskCommandInput} for command's `input` shape.
+ * @see {@link StartVoiceToneAnalysisTaskCommandOutput} 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 GoneException} (client fault)
+ *  <p>Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resource couldn't be found.</p>
+ *
+ * @throws {@link ResourceLimitExceededException} (client fault)
+ *  <p>The request exceeds the resource limit.</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>
+ *
+ * @throws {@link UnprocessableEntityException} (client fault)
+ *  <p>A well-formed request couldn't be followed due to semantic errors.</p>
+ *
+ *
+ */
 export declare class StartVoiceToneAnalysisTaskCommand extends $Command<StartVoiceToneAnalysisTaskCommandInput, StartVoiceToneAnalysisTaskCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: StartVoiceToneAnalysisTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,61 @@ export interface StopSpeakerSearchTaskCommandInput extends StopSpeakerSearchTask
  */
 export interface StopSpeakerSearchTaskCommandOutput extends __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Stops a speaker search task.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ChimeSDKVoiceClient, StopSpeakerSearchTaskCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, StopSpeakerSearchTaskCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   SpeakerSearchTaskId: "STRING_VALUE", // required
+ * };
+ * const command = new StopSpeakerSearchTaskCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param StopSpeakerSearchTaskCommandInput - {@link StopSpeakerSearchTaskCommandInput}
+ * @returns {@link StopSpeakerSearchTaskCommandOutput}
+ * @see {@link StopSpeakerSearchTaskCommandInput} for command's `input` shape.
+ * @see {@link StopSpeakerSearchTaskCommandOutput} 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>
+ *
+ * @throws {@link UnprocessableEntityException} (client fault)
+ *  <p>A well-formed request couldn't be followed due to semantic errors.</p>
+ *
+ *
+ */
 export declare class StopSpeakerSearchTaskCommand extends $Command<StopSpeakerSearchTaskCommandInput, StopSpeakerSearchTaskCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: StopSpeakerSearchTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;

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

@@ -17,6 +17,61 @@ export interface StopVoiceToneAnalysisTaskCommandInput extends StopVoiceToneAnal
  */
 export interface StopVoiceToneAnalysisTaskCommandOutput extends __MetadataBearer {
 }
+/**
+ * @public
+ * <p>Stops 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, StopVoiceToneAnalysisTaskCommand } from "@aws-sdk/client-chime-sdk-voice"; // ES Modules import
+ * // const { ChimeSDKVoiceClient, StopVoiceToneAnalysisTaskCommand } = require("@aws-sdk/client-chime-sdk-voice"); // CommonJS import
+ * const client = new ChimeSDKVoiceClient(config);
+ * const input = {
+ *   VoiceConnectorId: "STRING_VALUE", // required
+ *   VoiceToneAnalysisTaskId: "STRING_VALUE", // required
+ * };
+ * const command = new StopVoiceToneAnalysisTaskCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param StopVoiceToneAnalysisTaskCommandInput - {@link StopVoiceToneAnalysisTaskCommandInput}
+ * @returns {@link StopVoiceToneAnalysisTaskCommandOutput}
+ * @see {@link StopVoiceToneAnalysisTaskCommandInput} for command's `input` shape.
+ * @see {@link StopVoiceToneAnalysisTaskCommandOutput} 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>
+ *
+ * @throws {@link UnprocessableEntityException} (client fault)
+ *  <p>A well-formed request couldn't be followed due to semantic errors.</p>
+ *
+ *
+ */
 export declare class StopVoiceToneAnalysisTaskCommand extends $Command<StopVoiceToneAnalysisTaskCommandInput, StopVoiceToneAnalysisTaskCommandOutput, ChimeSDKVoiceClientResolvedConfig> {
     readonly input: StopVoiceToneAnalysisTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;