# StartSpeakerSearchTask


Starts a speaker search task.

**Important**  
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 [AWS service terms](https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

## Request Syntax


```
POST /voice-connectors/VoiceConnectorId/speaker-search-tasks HTTP/1.1
Content-type: application/json

{
   "CallLeg": "string",
   "ClientRequestToken": "string",
   "TransactionId": "string",
   "VoiceProfileDomainId": "string"
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [VoiceConnectorId](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-uri-VoiceConnectorId"></a>
The Voice Connector ID.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [CallLeg](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-CallLeg"></a>
Specifies which call leg to stream for speaker search.  
Type: String  
Valid Values: `Caller | Callee`   
Required: No

 ** [ClientRequestToken](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-ClientRequestToken"></a>
The unique identifier for the client request. Use a different token for different speaker search tasks.  
Type: String  
Pattern: `^[-_a-zA-Z0-9]*${2,64}$`   
Required: No

 ** [TransactionId](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-TransactionId"></a>
The transaction ID of the call being analyzed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** [VoiceProfileDomainId](#API_voice-chime_StartSpeakerSearchTask_RequestSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-request-VoiceProfileDomainId"></a>
The ID of the voice profile domain that will store the voice profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

## Response Syntax


```
HTTP/1.1 201
Content-type: application/json

{
   "SpeakerSearchTask": { 
      "CallDetails": { 
         "IsCaller": boolean,
         "TransactionId": "string",
         "VoiceConnectorId": "string"
      },
      "CreatedTimestamp": "string",
      "SpeakerSearchDetails": { 
         "Results": [ 
            { 
               "ConfidenceScore": number,
               "VoiceProfileId": "string"
            }
         ],
         "VoiceprintGenerationStatus": "string"
      },
      "SpeakerSearchTaskId": "string",
      "SpeakerSearchTaskStatus": "string",
      "StartedTimestamp": "string",
      "StatusMessage": "string",
      "UpdatedTimestamp": "string"
   }
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [SpeakerSearchTask](#API_voice-chime_StartSpeakerSearchTask_ResponseSyntax) **   <a name="chimesdk-voice-chime_StartSpeakerSearchTask-response-SpeakerSearchTask"></a>
The details of the speaker search task.  
Type: [SpeakerSearchTask](API_voice-chime_SpeakerSearchTask.md) object

## Errors


For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You don't have the permissions needed to run this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input parameters don't match the service's restrictions.  
HTTP Status Code: 400

 ** ConflictException **   
Multiple instances of the same request were made simultaneously.  
HTTP Status Code: 409

 ** ForbiddenException **   
The client is permanently forbidden from making the request.  
HTTP Status Code: 403

 ** GoneException **   
Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.  
HTTP Status Code: 410

 ** NotFoundException **   
The requested resource couldn't be found.  
HTTP Status Code: 404

 ** ResourceLimitExceededException **   
The request exceeds the resource limit.  
HTTP Status Code: 400

 ** ServiceFailureException **   
The service encountered an unexpected error.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is currently unavailable.  
HTTP Status Code: 503

 ** ThrottledClientException **   
The number of customer requests exceeds the request rate limit.  
HTTP Status Code: 429

 ** UnauthorizedClientException **   
The client isn't authorized to request a resource.  
HTTP Status Code: 401

 ** UnprocessableEntityException **   
A well-formed request couldn't be followed due to semantic errors.  
HTTP Status Code: 422

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask)