AWS.Tools.VoiceID.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.VoiceID</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.VID.AddVIDResourceTagCmdlet"> <summary> Tags an Amazon Connect Voice ID resource with the provided list of tags. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.AddVIDResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.AddVIDResourceTagCmdlet.Tag"> <summary> <para> <para>The list of tags to assign to the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.AddVIDResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.AddVIDResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.AddVIDResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet"> <summary> Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet.Description"> <summary> <para> <para>A brief description about this domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet.ServerSideEncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The identifier of the KMS Key you want Voice ID to use to encrypt your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet.Name"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Domain'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.UpdateDomainResponse). Specifying the name of a property of type Amazon.VoiceID.Model.UpdateDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.EditVIDDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainCmdlet"> <summary> Describes the specified domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain you are describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Domain'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DescribeDomainResponse). Specifying the name of a property of type Amazon.VoiceID.Model.DescribeDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainListCmdlet"> <summary> Lists all the domains in the Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain further pages of results. The default is 100; the maximum allowed page size is also 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainListCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.ListDomainsResponse). Specifying the name of a property of type Amazon.VoiceID.Model.ListDomainsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterCmdlet"> <summary> Describes the specified fraudster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the fraudster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterCmdlet.FraudsterId"> <summary> <para> <para>The identifier of the fraudster you are describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Fraudster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DescribeFraudsterResponse). Specifying the name of a property of type Amazon.VoiceID.Model.DescribeFraudsterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FraudsterId parameter. The -PassThru parameter is deprecated, use -Select '^FraudsterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobCmdlet"> <summary> Describes the specified fraudster registration job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobCmdlet.DomainId"> <summary> <para> <para>The identifier for the domain containing the fraudster registration job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobCmdlet.JobId"> <summary> <para> <para>The identifier for the fraudster registration job you are describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Job'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DescribeFraudsterRegistrationJobResponse). Specifying the name of a property of type Amazon.VoiceID.Model.DescribeFraudsterRegistrationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobListCmdlet"> <summary> Lists all the fraudster registration jobs in the domain with the given <code>JobStatus</code>. If <code>JobStatus</code> is not provided, this lists all fraudster registration jobs in the given domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobListCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the fraudster registration Jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobListCmdlet.JobStatus"> <summary> <para> <para>Provides the status of your fraudster registration job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain further pages of results. The default is 100; the maximum allowed page size is also 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobListCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.ListFraudsterRegistrationJobsResponse). Specifying the name of a property of type Amazon.VoiceID.Model.ListFraudsterRegistrationJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDFraudsterRegistrationJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDResourceTagCmdlet"> <summary> Lists all tags associated with a specified Voice ID resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.VoiceID.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDSessionEvaluationCmdlet"> <summary> Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSessionEvaluationCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain where the session started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSessionEvaluationCmdlet.SessionNameOrId"> <summary> <para> <para>The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSessionEvaluationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.EvaluateSessionResponse). Specifying the name of a property of type Amazon.VoiceID.Model.EvaluateSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSessionEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionNameOrId parameter. The -PassThru parameter is deprecated, use -Select '^SessionNameOrId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerCmdlet"> <summary> Describes the specified speaker. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain that contains the speaker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerCmdlet.SpeakerId"> <summary> <para> <para>The identifier of the speaker you are describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Speaker'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DescribeSpeakerResponse). Specifying the name of a property of type Amazon.VoiceID.Model.DescribeSpeakerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SpeakerId parameter. The -PassThru parameter is deprecated, use -Select '^SpeakerId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobCmdlet"> <summary> Describes the specified speaker enrollment job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the speaker enrollment job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobCmdlet.JobId"> <summary> <para> <para>The identifier of the speaker enrollment job you are describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Job'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DescribeSpeakerEnrollmentJobResponse). Specifying the name of a property of type Amazon.VoiceID.Model.DescribeSpeakerEnrollmentJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobListCmdlet"> <summary> Lists all the speaker enrollment jobs in the domain with the specified <code>JobStatus</code>. If <code>JobStatus</code> is not provided, this lists all jobs with all possible speaker enrollment job statuses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobListCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the speaker enrollment jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobListCmdlet.JobStatus"> <summary> <para> <para>Provides the status of your speaker enrollment Job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain further pages of results. The default is 100; the maximum allowed page size is also 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobListCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.ListSpeakerEnrollmentJobsResponse). Specifying the name of a property of type Amazon.VoiceID.Model.ListSpeakerEnrollmentJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerEnrollmentJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerListCmdlet"> <summary> Lists all speakers in a specified domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerListCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain further pages of results. The default is 100; the maximum allowed page size is also 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerListCmdlet.NextToken"> <summary> <para> <para>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SpeakerSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.ListSpeakersResponse). Specifying the name of a property of type Amazon.VoiceID.Model.ListSpeakersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.GetVIDSpeakerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet"> <summary> Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.Description"> <summary> <para> <para>A brief description of this domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.ServerSideEncryptionConfiguration_KmsKeyId"> <summary> <para> <para>The identifier of the KMS Key you want Voice ID to use to encrypt your data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.Name"> <summary> <para> <para>The name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.Tag"> <summary> <para> <para>A list of tags you want added to the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.ClientToken"> <summary> <para> <para>The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Domain'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.CreateDomainResponse). Specifying the name of a property of type Amazon.VoiceID.Model.CreateDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.NewVIDDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.RemoveVIDDomainCmdlet"> <summary> Deletes the specified domain from the Amazon Connect Voice ID system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDDomainCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDDomainCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DeleteDomainResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.RemoveVIDFraudsterCmdlet"> <summary> Deletes the specified fraudster from the Amazon Connect Voice ID system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDFraudsterCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the fraudster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDFraudsterCmdlet.FraudsterId"> <summary> <para> <para>The identifier of the fraudster you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDFraudsterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DeleteFraudsterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDFraudsterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FraudsterId parameter. The -PassThru parameter is deprecated, use -Select '^FraudsterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDFraudsterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.RemoveVIDResourceTagCmdlet"> <summary> Removes specified tags from a specified Amazon Connect Voice ID resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys you want to remove from the specified resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.RemoveVIDSpeakerCmdlet"> <summary> Deletes the specified speaker from the Amazon Connect Voice ID system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDSpeakerCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the speaker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDSpeakerCmdlet.SpeakerId"> <summary> <para> <para>The identifier of the speaker you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDSpeakerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.DeleteSpeakerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDSpeakerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SpeakerId parameter. The -PassThru parameter is deprecated, use -Select '^SpeakerId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.RemoveVIDSpeakerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.SetVIDOptOutSpeakerCmdlet"> <summary> Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in the system. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.SetVIDOptOutSpeakerCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the speaker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.SetVIDOptOutSpeakerCmdlet.SpeakerId"> <summary> <para> <para>The identifier of the speaker you want opted-out.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.SetVIDOptOutSpeakerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Speaker'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.OptOutSpeakerResponse). Specifying the name of a property of type Amazon.VoiceID.Model.OptOutSpeakerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.SetVIDOptOutSpeakerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SpeakerId parameter. The -PassThru parameter is deprecated, use -Select '^SpeakerId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.SetVIDOptOutSpeakerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet"> <summary> Starts a new batch fraudster registration job using provided details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html">Create and edit a fraudster watchlist</a> documentation for the permissions needed in this role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.RegistrationConfig_DuplicateRegistrationAction"> <summary> <para> <para>The action to take when a fraudster is identified as a duplicate. The default action is <code>SKIP</code>, which skips registering the duplicate fraudster. Setting the value to <code>REGISTER_AS_NEW</code> always registers a new fraudster into the specified domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.RegistrationConfig_FraudsterSimilarityThreshold"> <summary> <para> <para>The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.JobName"> <summary> <para> <para>The name of the new fraudster registration job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.OutputDataConfig_KmsKeyId"> <summary> <para> <para>the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.InputDataConfig_S3Uri"> <summary> <para> <para>The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.OutputDataConfig_S3Uri"> <summary> <para> <para>The S3 path of the folder to which Voice ID writes the job output file, which has a <code>*.out</code> extension. For example, if the input file name is <code>input-file.json</code> and the output folder path is <code>s3://output-bucket/output-folder</code>, the full output file path is <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.ClientToken"> <summary> <para> <para>The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Job'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.StartFraudsterRegistrationJobResponse). Specifying the name of a property of type Amazon.VoiceID.Model.StartFraudsterRegistrationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDFraudsterRegistrationJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet"> <summary> Starts a new batch speaker enrollment job using specified details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.DataAccessRoleArn"> <summary> <para> <para>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html">Batch enrollment using audio data from prior calls</a> documentation for the permissions needed in this role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.DomainId"> <summary> <para> <para>The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.EnrollmentConfig_ExistingEnrollmentAction"> <summary> <para> <para> The action to take when the specified speaker is already enrolled in the specified domain. The default value is <code>SKIP</code>, which skips the enrollment for the existing speaker. Setting the value to <code>OVERWRITE</code> replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.FraudDetectionConfig_FraudDetectionAction"> <summary> <para> <para>The action to take when the given speaker is flagged by the fraud detection system. The default value is <code>FAIL</code>, which fails the speaker enrollment. Changing this value to <code>IGNORE</code> results in the speaker being enrolled even if they are flagged by the fraud detection system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.JobName"> <summary> <para> <para>A name for your speaker enrollment job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.OutputDataConfig_KmsKeyId"> <summary> <para> <para>the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.FraudDetectionConfig_RiskThreshold"> <summary> <para> <para>Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.InputDataConfig_S3Uri"> <summary> <para> <para>The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.OutputDataConfig_S3Uri"> <summary> <para> <para>The S3 path of the folder to which Voice ID writes the job output file, which has a <code>*.out</code> extension. For example, if the input file name is <code>input-file.json</code> and the output folder path is <code>s3://output-bucket/output-folder</code>, the full output file path is <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.ClientToken"> <summary> <para> <para>The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Job'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VoiceID.Model.StartSpeakerEnrollmentJobResponse). Specifying the name of a property of type Amazon.VoiceID.Model.StartSpeakerEnrollmentJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.VID.StartVIDSpeakerEnrollmentJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |