voiceid

package
v1.55.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 11

Documentation

Overview

Package voiceid provides the client and types for making API requests to Amazon Voice ID.

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and efficient.

See https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27 for more information on this service.

See voiceid package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/voiceid/

Using the Client

To contact Amazon Voice ID with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Voice ID client VoiceID for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/voiceid/#New

Index

Constants

View Source
const (
	// AuthenticationDecisionAccept is a AuthenticationDecision enum value
	AuthenticationDecisionAccept = "ACCEPT"

	// AuthenticationDecisionReject is a AuthenticationDecision enum value
	AuthenticationDecisionReject = "REJECT"

	// AuthenticationDecisionNotEnoughSpeech is a AuthenticationDecision enum value
	AuthenticationDecisionNotEnoughSpeech = "NOT_ENOUGH_SPEECH"

	// AuthenticationDecisionSpeakerNotEnrolled is a AuthenticationDecision enum value
	AuthenticationDecisionSpeakerNotEnrolled = "SPEAKER_NOT_ENROLLED"

	// AuthenticationDecisionSpeakerOptedOut is a AuthenticationDecision enum value
	AuthenticationDecisionSpeakerOptedOut = "SPEAKER_OPTED_OUT"

	// AuthenticationDecisionSpeakerIdNotProvided is a AuthenticationDecision enum value
	AuthenticationDecisionSpeakerIdNotProvided = "SPEAKER_ID_NOT_PROVIDED"

	// AuthenticationDecisionSpeakerExpired is a AuthenticationDecision enum value
	AuthenticationDecisionSpeakerExpired = "SPEAKER_EXPIRED"
)
View Source
const (
	// ConflictTypeAnotherActiveStream is a ConflictType enum value
	ConflictTypeAnotherActiveStream = "ANOTHER_ACTIVE_STREAM"

	// ConflictTypeDomainNotActive is a ConflictType enum value
	ConflictTypeDomainNotActive = "DOMAIN_NOT_ACTIVE"

	// ConflictTypeCannotChangeSpeakerAfterEnrollment is a ConflictType enum value
	ConflictTypeCannotChangeSpeakerAfterEnrollment = "CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT"

	// ConflictTypeEnrollmentAlreadyExists is a ConflictType enum value
	ConflictTypeEnrollmentAlreadyExists = "ENROLLMENT_ALREADY_EXISTS"

	// ConflictTypeSpeakerNotSet is a ConflictType enum value
	ConflictTypeSpeakerNotSet = "SPEAKER_NOT_SET"

	// ConflictTypeSpeakerOptedOut is a ConflictType enum value
	ConflictTypeSpeakerOptedOut = "SPEAKER_OPTED_OUT"

	// ConflictTypeConcurrentChanges is a ConflictType enum value
	ConflictTypeConcurrentChanges = "CONCURRENT_CHANGES"

	// ConflictTypeDomainLockedFromEncryptionUpdates is a ConflictType enum value
	ConflictTypeDomainLockedFromEncryptionUpdates = "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES"

	// ConflictTypeCannotDeleteNonEmptyWatchlist is a ConflictType enum value
	ConflictTypeCannotDeleteNonEmptyWatchlist = "CANNOT_DELETE_NON_EMPTY_WATCHLIST"

	// ConflictTypeFraudsterMustBelongToAtLeastOneWatchlist is a ConflictType enum value
	ConflictTypeFraudsterMustBelongToAtLeastOneWatchlist = "FRAUDSTER_MUST_BELONG_TO_AT_LEAST_ONE_WATCHLIST"
)
View Source
const (
	// DomainStatusActive is a DomainStatus enum value
	DomainStatusActive = "ACTIVE"

	// DomainStatusPending is a DomainStatus enum value
	DomainStatusPending = "PENDING"

	// DomainStatusSuspended is a DomainStatus enum value
	DomainStatusSuspended = "SUSPENDED"
)
View Source
const (
	// DuplicateRegistrationActionSkip is a DuplicateRegistrationAction enum value
	DuplicateRegistrationActionSkip = "SKIP"

	// DuplicateRegistrationActionRegisterAsNew is a DuplicateRegistrationAction enum value
	DuplicateRegistrationActionRegisterAsNew = "REGISTER_AS_NEW"
)
View Source
const (
	// ExistingEnrollmentActionSkip is a ExistingEnrollmentAction enum value
	ExistingEnrollmentActionSkip = "SKIP"

	// ExistingEnrollmentActionOverwrite is a ExistingEnrollmentAction enum value
	ExistingEnrollmentActionOverwrite = "OVERWRITE"
)
View Source
const (
	// FraudDetectionActionIgnore is a FraudDetectionAction enum value
	FraudDetectionActionIgnore = "IGNORE"

	// FraudDetectionActionFail is a FraudDetectionAction enum value
	FraudDetectionActionFail = "FAIL"
)
View Source
const (
	// FraudDetectionDecisionHighRisk is a FraudDetectionDecision enum value
	FraudDetectionDecisionHighRisk = "HIGH_RISK"

	// FraudDetectionDecisionLowRisk is a FraudDetectionDecision enum value
	FraudDetectionDecisionLowRisk = "LOW_RISK"

	// FraudDetectionDecisionNotEnoughSpeech is a FraudDetectionDecision enum value
	FraudDetectionDecisionNotEnoughSpeech = "NOT_ENOUGH_SPEECH"
)
View Source
const (
	// FraudDetectionReasonKnownFraudster is a FraudDetectionReason enum value
	FraudDetectionReasonKnownFraudster = "KNOWN_FRAUDSTER"

	// FraudDetectionReasonVoiceSpoofing is a FraudDetectionReason enum value
	FraudDetectionReasonVoiceSpoofing = "VOICE_SPOOFING"
)
View Source
const (
	// FraudsterRegistrationJobStatusSubmitted is a FraudsterRegistrationJobStatus enum value
	FraudsterRegistrationJobStatusSubmitted = "SUBMITTED"

	// FraudsterRegistrationJobStatusInProgress is a FraudsterRegistrationJobStatus enum value
	FraudsterRegistrationJobStatusInProgress = "IN_PROGRESS"

	// FraudsterRegistrationJobStatusCompleted is a FraudsterRegistrationJobStatus enum value
	FraudsterRegistrationJobStatusCompleted = "COMPLETED"

	// FraudsterRegistrationJobStatusCompletedWithErrors is a FraudsterRegistrationJobStatus enum value
	FraudsterRegistrationJobStatusCompletedWithErrors = "COMPLETED_WITH_ERRORS"

	// FraudsterRegistrationJobStatusFailed is a FraudsterRegistrationJobStatus enum value
	FraudsterRegistrationJobStatusFailed = "FAILED"
)
View Source
const (
	// ResourceTypeBatchJob is a ResourceType enum value
	ResourceTypeBatchJob = "BATCH_JOB"

	// ResourceTypeComplianceConsent is a ResourceType enum value
	ResourceTypeComplianceConsent = "COMPLIANCE_CONSENT"

	// ResourceTypeDomain is a ResourceType enum value
	ResourceTypeDomain = "DOMAIN"

	// ResourceTypeFraudster is a ResourceType enum value
	ResourceTypeFraudster = "FRAUDSTER"

	// ResourceTypeSession is a ResourceType enum value
	ResourceTypeSession = "SESSION"

	// ResourceTypeSpeaker is a ResourceType enum value
	ResourceTypeSpeaker = "SPEAKER"

	// ResourceTypeWatchlist is a ResourceType enum value
	ResourceTypeWatchlist = "WATCHLIST"
)
View Source
const (
	// ServerSideEncryptionUpdateStatusInProgress is a ServerSideEncryptionUpdateStatus enum value
	ServerSideEncryptionUpdateStatusInProgress = "IN_PROGRESS"

	// ServerSideEncryptionUpdateStatusCompleted is a ServerSideEncryptionUpdateStatus enum value
	ServerSideEncryptionUpdateStatusCompleted = "COMPLETED"

	// ServerSideEncryptionUpdateStatusFailed is a ServerSideEncryptionUpdateStatus enum value
	ServerSideEncryptionUpdateStatusFailed = "FAILED"
)
View Source
const (
	// SpeakerEnrollmentJobStatusSubmitted is a SpeakerEnrollmentJobStatus enum value
	SpeakerEnrollmentJobStatusSubmitted = "SUBMITTED"

	// SpeakerEnrollmentJobStatusInProgress is a SpeakerEnrollmentJobStatus enum value
	SpeakerEnrollmentJobStatusInProgress = "IN_PROGRESS"

	// SpeakerEnrollmentJobStatusCompleted is a SpeakerEnrollmentJobStatus enum value
	SpeakerEnrollmentJobStatusCompleted = "COMPLETED"

	// SpeakerEnrollmentJobStatusCompletedWithErrors is a SpeakerEnrollmentJobStatus enum value
	SpeakerEnrollmentJobStatusCompletedWithErrors = "COMPLETED_WITH_ERRORS"

	// SpeakerEnrollmentJobStatusFailed is a SpeakerEnrollmentJobStatus enum value
	SpeakerEnrollmentJobStatusFailed = "FAILED"
)
View Source
const (
	// SpeakerStatusEnrolled is a SpeakerStatus enum value
	SpeakerStatusEnrolled = "ENROLLED"

	// SpeakerStatusExpired is a SpeakerStatus enum value
	SpeakerStatusExpired = "EXPIRED"

	// SpeakerStatusOptedOut is a SpeakerStatus enum value
	SpeakerStatusOptedOut = "OPTED_OUT"

	// SpeakerStatusPending is a SpeakerStatus enum value
	SpeakerStatusPending = "PENDING"
)
View Source
const (
	// StreamingStatusPendingConfiguration is a StreamingStatus enum value
	StreamingStatusPendingConfiguration = "PENDING_CONFIGURATION"

	// StreamingStatusOngoing is a StreamingStatus enum value
	StreamingStatusOngoing = "ONGOING"

	// StreamingStatusEnded is a StreamingStatus enum value
	StreamingStatusEnded = "ENDED"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient permissions to perform this action. Check the
	// error message and try again.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request failed due to a conflict. Check the ConflictType and error message
	// for more details.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The request failed due to an unknown error on the server side.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource cannot be found. Check the ResourceType and error
	// message for more details.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request exceeded the service quota. Refer to Voice ID Service Quotas
	// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas)
	// and try your request again.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling. Please slow down your request
	// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas)
	// and try your request again.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The request failed one or more validations; check the error message for more
	// details.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "Voice ID" // Name of service.
	EndpointsID = "voiceid"  // ID to lookup a service endpoint with.
	ServiceID   = "Voice ID" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AuthenticationDecision_Values

func AuthenticationDecision_Values() []string

AuthenticationDecision_Values returns all elements of the AuthenticationDecision enum

func ConflictType_Values

func ConflictType_Values() []string

ConflictType_Values returns all elements of the ConflictType enum

func DomainStatus_Values

func DomainStatus_Values() []string

DomainStatus_Values returns all elements of the DomainStatus enum

func DuplicateRegistrationAction_Values

func DuplicateRegistrationAction_Values() []string

DuplicateRegistrationAction_Values returns all elements of the DuplicateRegistrationAction enum

func ExistingEnrollmentAction_Values

func ExistingEnrollmentAction_Values() []string

ExistingEnrollmentAction_Values returns all elements of the ExistingEnrollmentAction enum

func FraudDetectionAction_Values

func FraudDetectionAction_Values() []string

FraudDetectionAction_Values returns all elements of the FraudDetectionAction enum

func FraudDetectionDecision_Values

func FraudDetectionDecision_Values() []string

FraudDetectionDecision_Values returns all elements of the FraudDetectionDecision enum

func FraudDetectionReason_Values

func FraudDetectionReason_Values() []string

FraudDetectionReason_Values returns all elements of the FraudDetectionReason enum

func FraudsterRegistrationJobStatus_Values

func FraudsterRegistrationJobStatus_Values() []string

FraudsterRegistrationJobStatus_Values returns all elements of the FraudsterRegistrationJobStatus enum

func ResourceType_Values

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func ServerSideEncryptionUpdateStatus_Values added in v1.44.27

func ServerSideEncryptionUpdateStatus_Values() []string

ServerSideEncryptionUpdateStatus_Values returns all elements of the ServerSideEncryptionUpdateStatus enum

func SpeakerEnrollmentJobStatus_Values

func SpeakerEnrollmentJobStatus_Values() []string

SpeakerEnrollmentJobStatus_Values returns all elements of the SpeakerEnrollmentJobStatus enum

func SpeakerStatus_Values

func SpeakerStatus_Values() []string

SpeakerStatus_Values returns all elements of the SpeakerStatus enum

func StreamingStatus_Values

func StreamingStatus_Values() []string

StreamingStatus_Values returns all elements of the StreamingStatus enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient permissions to perform this action. Check the error message and try again.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateFraudsterInput added in v1.44.230

type AssociateFraudsterInput struct {

	// The identifier of the domain that contains the fraudster.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the fraudster to be associated with the watchlist.
	//
	// FraudsterId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AssociateFraudsterInput's
	// String and GoString methods.
	//
	// FraudsterId is a required field
	FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"`

	// The identifier of the watchlist you want to associate with the fraudster.
	//
	// WatchlistId is a required field
	WatchlistId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateFraudsterInput) GoString added in v1.44.230

func (s AssociateFraudsterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFraudsterInput) SetDomainId added in v1.44.230

SetDomainId sets the DomainId field's value.

func (*AssociateFraudsterInput) SetFraudsterId added in v1.44.230

SetFraudsterId sets the FraudsterId field's value.

func (*AssociateFraudsterInput) SetWatchlistId added in v1.44.230

SetWatchlistId sets the WatchlistId field's value.

func (AssociateFraudsterInput) String added in v1.44.230

func (s AssociateFraudsterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFraudsterInput) Validate added in v1.44.230

func (s *AssociateFraudsterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateFraudsterOutput added in v1.44.230

type AssociateFraudsterOutput struct {

	// Contains all the information about a fraudster.
	Fraudster *Fraudster `type:"structure"`
	// contains filtered or unexported fields
}

func (AssociateFraudsterOutput) GoString added in v1.44.230

func (s AssociateFraudsterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFraudsterOutput) SetFraudster added in v1.44.230

SetFraudster sets the Fraudster field's value.

func (AssociateFraudsterOutput) String added in v1.44.230

func (s AssociateFraudsterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthenticationConfiguration

type AuthenticationConfiguration struct {

	// The minimum threshold needed to successfully authenticate a speaker.
	//
	// AcceptanceThreshold is a required field
	AcceptanceThreshold *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The configuration used to authenticate a speaker during a session.

func (AuthenticationConfiguration) GoString

func (s AuthenticationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationConfiguration) SetAcceptanceThreshold

func (s *AuthenticationConfiguration) SetAcceptanceThreshold(v int64) *AuthenticationConfiguration

SetAcceptanceThreshold sets the AcceptanceThreshold field's value.

func (AuthenticationConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthenticationResult

type AuthenticationResult struct {

	// A timestamp of when audio aggregation ended for this authentication result.
	AudioAggregationEndedAt *time.Time `type:"timestamp"`

	// A timestamp of when audio aggregation started for this authentication result.
	AudioAggregationStartedAt *time.Time `type:"timestamp"`

	// The unique identifier for this authentication result. Because there can be
	// multiple authentications for a given session, this field helps to identify
	// if the returned result is from a previous streaming activity or a new result.
	// Note that in absence of any new streaming activity, AcceptanceThreshold changes,
	// or SpeakerId changes, Voice ID always returns cached Authentication Result
	// for this API.
	AuthenticationResultId *string `min:"22" type:"string"`

	// The AuthenticationConfiguration used to generate this authentication result.
	Configuration *AuthenticationConfiguration `type:"structure"`

	// The client-provided identifier for the speaker whose authentication result
	// is produced. Only present if a SpeakerId is provided for the session.
	//
	// CustomerSpeakerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AuthenticationResult's
	// String and GoString methods.
	CustomerSpeakerId *string `min:"1" type:"string" sensitive:"true"`

	// The authentication decision produced by Voice ID, processed against the current
	// session state and streamed audio of the speaker.
	Decision *string `type:"string" enum:"AuthenticationDecision"`

	// The service-generated identifier for the speaker whose authentication result
	// is produced.
	GeneratedSpeakerId *string `min:"25" type:"string"`

	// The authentication score for the speaker whose authentication result is produced.
	// This value is only present if the authentication decision is either ACCEPT
	// or REJECT.
	Score *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

func (AuthenticationResult) GoString

func (s AuthenticationResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationResult) SetAudioAggregationEndedAt

func (s *AuthenticationResult) SetAudioAggregationEndedAt(v time.Time) *AuthenticationResult

SetAudioAggregationEndedAt sets the AudioAggregationEndedAt field's value.

func (*AuthenticationResult) SetAudioAggregationStartedAt

func (s *AuthenticationResult) SetAudioAggregationStartedAt(v time.Time) *AuthenticationResult

SetAudioAggregationStartedAt sets the AudioAggregationStartedAt field's value.

func (*AuthenticationResult) SetAuthenticationResultId

func (s *AuthenticationResult) SetAuthenticationResultId(v string) *AuthenticationResult

SetAuthenticationResultId sets the AuthenticationResultId field's value.

func (*AuthenticationResult) SetConfiguration

SetConfiguration sets the Configuration field's value.

func (*AuthenticationResult) SetCustomerSpeakerId

func (s *AuthenticationResult) SetCustomerSpeakerId(v string) *AuthenticationResult

SetCustomerSpeakerId sets the CustomerSpeakerId field's value.

func (*AuthenticationResult) SetDecision

SetDecision sets the Decision field's value.

func (*AuthenticationResult) SetGeneratedSpeakerId

func (s *AuthenticationResult) SetGeneratedSpeakerId(v string) *AuthenticationResult

SetGeneratedSpeakerId sets the GeneratedSpeakerId field's value.

func (*AuthenticationResult) SetScore

SetScore sets the Score field's value.

func (AuthenticationResult) String

func (s AuthenticationResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The type of conflict which caused a ConflictException. Possible types and
	// the corresponding error messages are as follows:
	//
	//    * DOMAIN_NOT_ACTIVE: The domain is not active.
	//
	//    * CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT: You cannot change the speaker
	//    ID after an enrollment has been requested.
	//
	//    * ENROLLMENT_ALREADY_EXISTS: There is already an enrollment for this session.
	//
	//    * SPEAKER_NOT_SET: You must set the speaker ID before requesting an enrollment.
	//
	//    * SPEAKER_OPTED_OUT: You cannot request an enrollment for an opted out
	//    speaker.
	//
	//    * CONCURRENT_CHANGES: The request could not be processed as the resource
	//    was modified by another request during execution.
	ConflictType *string `type:"string" enum:"ConflictType"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request failed due to a conflict. Check the ConflictType and error message for more details.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDomainInput

type CreateDomainInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A brief description of this domain.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateDomainInput's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The name of the domain.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateDomainInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The configuration, containing the KMS key identifier, to be used by Voice
	// ID for the server-side encryption of your data. Refer to Amazon Connect Voice
	// ID encryption at rest (https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid)
	// for more details on how the KMS key is used.
	//
	// ServerSideEncryptionConfiguration is a required field
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure" required:"true"`

	// A list of tags you want added to the domain.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateDomainInput) GoString

func (s CreateDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainInput) SetClientToken

func (s *CreateDomainInput) SetClientToken(v string) *CreateDomainInput

SetClientToken sets the ClientToken field's value.

func (*CreateDomainInput) SetDescription

func (s *CreateDomainInput) SetDescription(v string) *CreateDomainInput

SetDescription sets the Description field's value.

func (*CreateDomainInput) SetName

SetName sets the Name field's value.

func (*CreateDomainInput) SetServerSideEncryptionConfiguration

func (s *CreateDomainInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateDomainInput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*CreateDomainInput) SetTags

func (s *CreateDomainInput) SetTags(v []*Tag) *CreateDomainInput

SetTags sets the Tags field's value.

func (CreateDomainInput) String

func (s CreateDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainInput) Validate

func (s *CreateDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDomainOutput

type CreateDomainOutput struct {

	// Information about the newly created domain.
	Domain *Domain `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDomainOutput) GoString

func (s CreateDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDomainOutput) SetDomain

func (s *CreateDomainOutput) SetDomain(v *Domain) *CreateDomainOutput

SetDomain sets the Domain field's value.

func (CreateDomainOutput) String

func (s CreateDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWatchlistInput added in v1.44.230

type CreateWatchlistInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A brief description of this watchlist.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWatchlistInput's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain that contains the watchlist.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The name of the watchlist.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWatchlistInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateWatchlistInput) GoString added in v1.44.230

func (s CreateWatchlistInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWatchlistInput) SetClientToken added in v1.44.230

func (s *CreateWatchlistInput) SetClientToken(v string) *CreateWatchlistInput

SetClientToken sets the ClientToken field's value.

func (*CreateWatchlistInput) SetDescription added in v1.44.230

func (s *CreateWatchlistInput) SetDescription(v string) *CreateWatchlistInput

SetDescription sets the Description field's value.

func (*CreateWatchlistInput) SetDomainId added in v1.44.230

SetDomainId sets the DomainId field's value.

func (*CreateWatchlistInput) SetName added in v1.44.230

SetName sets the Name field's value.

func (CreateWatchlistInput) String added in v1.44.230

func (s CreateWatchlistInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWatchlistInput) Validate added in v1.44.230

func (s *CreateWatchlistInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWatchlistOutput added in v1.44.230

type CreateWatchlistOutput struct {

	// Information about the newly created watchlist.
	Watchlist *Watchlist `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateWatchlistOutput) GoString added in v1.44.230

func (s CreateWatchlistOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWatchlistOutput) SetWatchlist added in v1.44.230

SetWatchlist sets the Watchlist field's value.

func (CreateWatchlistOutput) String added in v1.44.230

func (s CreateWatchlistOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDomainInput

type DeleteDomainInput struct {

	// The identifier of the domain you want to delete.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDomainInput) GoString

func (s DeleteDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainInput) SetDomainId

func (s *DeleteDomainInput) SetDomainId(v string) *DeleteDomainInput

SetDomainId sets the DomainId field's value.

func (DeleteDomainInput) String

func (s DeleteDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDomainInput) Validate

func (s *DeleteDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDomainOutput

type DeleteDomainOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDomainOutput) GoString

func (s DeleteDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDomainOutput) String

func (s DeleteDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFraudsterInput

type DeleteFraudsterInput struct {

	// The identifier of the domain that contains the fraudster.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the fraudster you want to delete.
	//
	// FraudsterId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteFraudsterInput's
	// String and GoString methods.
	//
	// FraudsterId is a required field
	FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DeleteFraudsterInput) GoString

func (s DeleteFraudsterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFraudsterInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*DeleteFraudsterInput) SetFraudsterId

func (s *DeleteFraudsterInput) SetFraudsterId(v string) *DeleteFraudsterInput

SetFraudsterId sets the FraudsterId field's value.

func (DeleteFraudsterInput) String

func (s DeleteFraudsterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFraudsterInput) Validate

func (s *DeleteFraudsterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFraudsterOutput

type DeleteFraudsterOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFraudsterOutput) GoString

func (s DeleteFraudsterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFraudsterOutput) String

func (s DeleteFraudsterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSpeakerInput

type DeleteSpeakerInput struct {

	// The identifier of the domain that contains the speaker.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the speaker you want to delete.
	//
	// SpeakerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DeleteSpeakerInput's
	// String and GoString methods.
	//
	// SpeakerId is a required field
	SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DeleteSpeakerInput) GoString

func (s DeleteSpeakerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSpeakerInput) SetDomainId

func (s *DeleteSpeakerInput) SetDomainId(v string) *DeleteSpeakerInput

SetDomainId sets the DomainId field's value.

func (*DeleteSpeakerInput) SetSpeakerId

func (s *DeleteSpeakerInput) SetSpeakerId(v string) *DeleteSpeakerInput

SetSpeakerId sets the SpeakerId field's value.

func (DeleteSpeakerInput) String

func (s DeleteSpeakerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSpeakerInput) Validate

func (s *DeleteSpeakerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSpeakerOutput

type DeleteSpeakerOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSpeakerOutput) GoString

func (s DeleteSpeakerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSpeakerOutput) String

func (s DeleteSpeakerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWatchlistInput added in v1.44.230

type DeleteWatchlistInput struct {

	// The identifier of the domain that contains the watchlist.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the watchlist to be deleted.
	//
	// WatchlistId is a required field
	WatchlistId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWatchlistInput) GoString added in v1.44.230

func (s DeleteWatchlistInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWatchlistInput) SetDomainId added in v1.44.230

SetDomainId sets the DomainId field's value.

func (*DeleteWatchlistInput) SetWatchlistId added in v1.44.230

func (s *DeleteWatchlistInput) SetWatchlistId(v string) *DeleteWatchlistInput

SetWatchlistId sets the WatchlistId field's value.

func (DeleteWatchlistInput) String added in v1.44.230

func (s DeleteWatchlistInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWatchlistInput) Validate added in v1.44.230

func (s *DeleteWatchlistInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWatchlistOutput added in v1.44.230

type DeleteWatchlistOutput struct {
	// contains filtered or unexported fields
}

func (DeleteWatchlistOutput) GoString added in v1.44.230

func (s DeleteWatchlistOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWatchlistOutput) String added in v1.44.230

func (s DeleteWatchlistOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDomainInput

type DescribeDomainInput struct {

	// The identifier of the domain that you are describing.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDomainInput) GoString

func (s DescribeDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainInput) SetDomainId

func (s *DescribeDomainInput) SetDomainId(v string) *DescribeDomainInput

SetDomainId sets the DomainId field's value.

func (DescribeDomainInput) String

func (s DescribeDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainInput) Validate

func (s *DescribeDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDomainOutput

type DescribeDomainOutput struct {

	// Information about the specified domain.
	Domain *Domain `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDomainOutput) GoString

func (s DescribeDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDomainOutput) SetDomain

SetDomain sets the Domain field's value.

func (DescribeDomainOutput) String

func (s DescribeDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFraudsterInput

type DescribeFraudsterInput struct {

	// The identifier of the domain that contains the fraudster.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the fraudster you are describing.
	//
	// FraudsterId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeFraudsterInput's
	// String and GoString methods.
	//
	// FraudsterId is a required field
	FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DescribeFraudsterInput) GoString

func (s DescribeFraudsterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFraudsterInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*DescribeFraudsterInput) SetFraudsterId

SetFraudsterId sets the FraudsterId field's value.

func (DescribeFraudsterInput) String

func (s DescribeFraudsterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFraudsterInput) Validate

func (s *DescribeFraudsterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFraudsterOutput

type DescribeFraudsterOutput struct {

	// Information about the specified fraudster.
	Fraudster *Fraudster `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFraudsterOutput) GoString

func (s DescribeFraudsterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFraudsterOutput) SetFraudster

SetFraudster sets the Fraudster field's value.

func (DescribeFraudsterOutput) String

func (s DescribeFraudsterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFraudsterRegistrationJobInput

type DescribeFraudsterRegistrationJobInput struct {

	// The identifier of the domain that contains the fraudster registration job.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the fraudster registration job you are describing.
	//
	// JobId is a required field
	JobId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFraudsterRegistrationJobInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFraudsterRegistrationJobInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*DescribeFraudsterRegistrationJobInput) SetJobId

SetJobId sets the JobId field's value.

func (DescribeFraudsterRegistrationJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFraudsterRegistrationJobInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeFraudsterRegistrationJobOutput

type DescribeFraudsterRegistrationJobOutput struct {

	// Contains details about the specified fraudster registration job.
	Job *FraudsterRegistrationJob `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFraudsterRegistrationJobOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFraudsterRegistrationJobOutput) SetJob

SetJob sets the Job field's value.

func (DescribeFraudsterRegistrationJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSpeakerEnrollmentJobInput

type DescribeSpeakerEnrollmentJobInput struct {

	// The identifier of the domain that contains the speaker enrollment job.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the speaker enrollment job you are describing.
	//
	// JobId is a required field
	JobId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSpeakerEnrollmentJobInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSpeakerEnrollmentJobInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*DescribeSpeakerEnrollmentJobInput) SetJobId

SetJobId sets the JobId field's value.

func (DescribeSpeakerEnrollmentJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSpeakerEnrollmentJobInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeSpeakerEnrollmentJobOutput

type DescribeSpeakerEnrollmentJobOutput struct {

	// Contains details about the specified speaker enrollment job.
	Job *SpeakerEnrollmentJob `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSpeakerEnrollmentJobOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSpeakerEnrollmentJobOutput) SetJob

SetJob sets the Job field's value.

func (DescribeSpeakerEnrollmentJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSpeakerInput

type DescribeSpeakerInput struct {

	// The identifier of the domain that contains the speaker.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the speaker you are describing.
	//
	// SpeakerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribeSpeakerInput's
	// String and GoString methods.
	//
	// SpeakerId is a required field
	SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DescribeSpeakerInput) GoString

func (s DescribeSpeakerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSpeakerInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*DescribeSpeakerInput) SetSpeakerId

func (s *DescribeSpeakerInput) SetSpeakerId(v string) *DescribeSpeakerInput

SetSpeakerId sets the SpeakerId field's value.

func (DescribeSpeakerInput) String

func (s DescribeSpeakerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSpeakerInput) Validate

func (s *DescribeSpeakerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSpeakerOutput

type DescribeSpeakerOutput struct {

	// Information about the specified speaker.
	Speaker *Speaker `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSpeakerOutput) GoString

func (s DescribeSpeakerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSpeakerOutput) SetSpeaker

SetSpeaker sets the Speaker field's value.

func (DescribeSpeakerOutput) String

func (s DescribeSpeakerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWatchlistInput added in v1.44.230

type DescribeWatchlistInput struct {

	// The identifier of the domain that contains the watchlist.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the watchlist that you are describing.
	//
	// WatchlistId is a required field
	WatchlistId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWatchlistInput) GoString added in v1.44.230

func (s DescribeWatchlistInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWatchlistInput) SetDomainId added in v1.44.230

SetDomainId sets the DomainId field's value.

func (*DescribeWatchlistInput) SetWatchlistId added in v1.44.230

SetWatchlistId sets the WatchlistId field's value.

func (DescribeWatchlistInput) String added in v1.44.230

func (s DescribeWatchlistInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWatchlistInput) Validate added in v1.44.230

func (s *DescribeWatchlistInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeWatchlistOutput added in v1.44.230

type DescribeWatchlistOutput struct {

	// Information about the specified watchlist.
	Watchlist *Watchlist `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeWatchlistOutput) GoString added in v1.44.230

func (s DescribeWatchlistOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWatchlistOutput) SetWatchlist added in v1.44.230

SetWatchlist sets the Watchlist field's value.

func (DescribeWatchlistOutput) String added in v1.44.230

func (s DescribeWatchlistOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateFraudsterInput added in v1.44.230

type DisassociateFraudsterInput struct {

	// The identifier of the domain that contains the fraudster.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the fraudster to be disassociated from the watchlist.
	//
	// FraudsterId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DisassociateFraudsterInput's
	// String and GoString methods.
	//
	// FraudsterId is a required field
	FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"`

	// The identifier of the watchlist that you want to disassociate from the fraudster.
	//
	// WatchlistId is a required field
	WatchlistId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateFraudsterInput) GoString added in v1.44.230

func (s DisassociateFraudsterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFraudsterInput) SetDomainId added in v1.44.230

SetDomainId sets the DomainId field's value.

func (*DisassociateFraudsterInput) SetFraudsterId added in v1.44.230

SetFraudsterId sets the FraudsterId field's value.

func (*DisassociateFraudsterInput) SetWatchlistId added in v1.44.230

SetWatchlistId sets the WatchlistId field's value.

func (DisassociateFraudsterInput) String added in v1.44.230

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFraudsterInput) Validate added in v1.44.230

func (s *DisassociateFraudsterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateFraudsterOutput added in v1.44.230

type DisassociateFraudsterOutput struct {

	// Contains all the information about a fraudster.
	Fraudster *Fraudster `type:"structure"`
	// contains filtered or unexported fields
}

func (DisassociateFraudsterOutput) GoString added in v1.44.230

func (s DisassociateFraudsterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFraudsterOutput) SetFraudster added in v1.44.230

SetFraudster sets the Fraudster field's value.

func (DisassociateFraudsterOutput) String added in v1.44.230

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Domain

type Domain struct {

	// The Amazon Resource Name (ARN) for the domain.
	Arn *string `type:"string"`

	// The timestamp of when the domain was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The description of the domain.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Domain's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain.
	DomainId *string `min:"22" type:"string"`

	// The current status of the domain.
	DomainStatus *string `type:"string" enum:"DomainStatus"`

	// The name for the domain.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Domain's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The server-side encryption configuration containing the KMS key identifier
	// you want Voice ID to use to encrypt your data.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

	// Details about the most recent server-side encryption configuration update.
	// When the server-side encryption configuration is changed, dependency on the
	// old KMS key is removed through an asynchronous process. When this update
	// is complete, the domain's data can only be accessed using the new KMS key.
	ServerSideEncryptionUpdateDetails *ServerSideEncryptionUpdateDetails `type:"structure"`

	// The timestamp of when the domain was last update.
	UpdatedAt *time.Time `type:"timestamp"`

	// The watchlist details of a domain. Contains the default watchlist ID of the
	// domain.
	WatchlistDetails *WatchlistDetails `type:"structure"`
	// contains filtered or unexported fields
}

Contains all the information about a domain.

func (Domain) GoString

func (s Domain) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Domain) SetArn

func (s *Domain) SetArn(v string) *Domain

SetArn sets the Arn field's value.

func (*Domain) SetCreatedAt

func (s *Domain) SetCreatedAt(v time.Time) *Domain

SetCreatedAt sets the CreatedAt field's value.

func (*Domain) SetDescription

func (s *Domain) SetDescription(v string) *Domain

SetDescription sets the Description field's value.

func (*Domain) SetDomainId

func (s *Domain) SetDomainId(v string) *Domain

SetDomainId sets the DomainId field's value.

func (*Domain) SetDomainStatus

func (s *Domain) SetDomainStatus(v string) *Domain

SetDomainStatus sets the DomainStatus field's value.

func (*Domain) SetName

func (s *Domain) SetName(v string) *Domain

SetName sets the Name field's value.

func (*Domain) SetServerSideEncryptionConfiguration

func (s *Domain) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *Domain

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*Domain) SetServerSideEncryptionUpdateDetails added in v1.44.27

func (s *Domain) SetServerSideEncryptionUpdateDetails(v *ServerSideEncryptionUpdateDetails) *Domain

SetServerSideEncryptionUpdateDetails sets the ServerSideEncryptionUpdateDetails field's value.

func (*Domain) SetUpdatedAt

func (s *Domain) SetUpdatedAt(v time.Time) *Domain

SetUpdatedAt sets the UpdatedAt field's value.

func (*Domain) SetWatchlistDetails added in v1.44.230

func (s *Domain) SetWatchlistDetails(v *WatchlistDetails) *Domain

SetWatchlistDetails sets the WatchlistDetails field's value.

func (Domain) String

func (s Domain) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DomainSummary

type DomainSummary struct {

	// The Amazon Resource Name (ARN) for the domain.
	Arn *string `type:"string"`

	// The timestamp of when the domain was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The description of the domain.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DomainSummary's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain.
	DomainId *string `min:"22" type:"string"`

	// The current status of the domain.
	DomainStatus *string `type:"string" enum:"DomainStatus"`

	// The client-provided name for the domain.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DomainSummary's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The server-side encryption configuration containing the KMS key identifier
	// you want Voice ID to use to encrypt your data.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

	// Details about the most recent server-side encryption configuration update.
	// When the server-side encryption configuration is changed, dependency on the
	// old KMS key is removed through an asynchronous process. When this update
	// is complete, the domain's data can only be accessed using the new KMS key.
	ServerSideEncryptionUpdateDetails *ServerSideEncryptionUpdateDetails `type:"structure"`

	// The timestamp of when the domain was last updated.
	UpdatedAt *time.Time `type:"timestamp"`

	// Provides information about watchlistDetails and DefaultWatchlistID.
	WatchlistDetails *WatchlistDetails `type:"structure"`
	// contains filtered or unexported fields
}

Contains a summary of information about a domain.

func (DomainSummary) GoString

func (s DomainSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DomainSummary) SetArn

func (s *DomainSummary) SetArn(v string) *DomainSummary

SetArn sets the Arn field's value.

func (*DomainSummary) SetCreatedAt

func (s *DomainSummary) SetCreatedAt(v time.Time) *DomainSummary

SetCreatedAt sets the CreatedAt field's value.

func (*DomainSummary) SetDescription

func (s *DomainSummary) SetDescription(v string) *DomainSummary

SetDescription sets the Description field's value.

func (*DomainSummary) SetDomainId

func (s *DomainSummary) SetDomainId(v string) *DomainSummary

SetDomainId sets the DomainId field's value.

func (*DomainSummary) SetDomainStatus

func (s *DomainSummary) SetDomainStatus(v string) *DomainSummary

SetDomainStatus sets the DomainStatus field's value.

func (*DomainSummary) SetName

func (s *DomainSummary) SetName(v string) *DomainSummary

SetName sets the Name field's value.

func (*DomainSummary) SetServerSideEncryptionConfiguration

func (s *DomainSummary) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DomainSummary

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*DomainSummary) SetServerSideEncryptionUpdateDetails added in v1.44.27

func (s *DomainSummary) SetServerSideEncryptionUpdateDetails(v *ServerSideEncryptionUpdateDetails) *DomainSummary

SetServerSideEncryptionUpdateDetails sets the ServerSideEncryptionUpdateDetails field's value.

func (*DomainSummary) SetUpdatedAt

func (s *DomainSummary) SetUpdatedAt(v time.Time) *DomainSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (*DomainSummary) SetWatchlistDetails added in v1.44.230

func (s *DomainSummary) SetWatchlistDetails(v *WatchlistDetails) *DomainSummary

SetWatchlistDetails sets the WatchlistDetails field's value.

func (DomainSummary) String

func (s DomainSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnrollmentConfig

type EnrollmentConfig struct {

	// The action to take when the specified speaker is already enrolled in the
	// specified domain. The default value is SKIP, which skips the enrollment for
	// the existing speaker. Setting the value to OVERWRITE replaces the existing
	// voice prints and enrollment audio stored for that speaker with new data generated
	// from the latest audio.
	ExistingEnrollmentAction *string `type:"string" enum:"ExistingEnrollmentAction"`

	// The fraud detection configuration to use for the speaker enrollment job.
	FraudDetectionConfig *EnrollmentJobFraudDetectionConfig `type:"structure"`
	// contains filtered or unexported fields
}

Contains configurations defining enrollment behavior for the batch job.

func (EnrollmentConfig) GoString

func (s EnrollmentConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnrollmentConfig) SetExistingEnrollmentAction

func (s *EnrollmentConfig) SetExistingEnrollmentAction(v string) *EnrollmentConfig

SetExistingEnrollmentAction sets the ExistingEnrollmentAction field's value.

func (*EnrollmentConfig) SetFraudDetectionConfig

SetFraudDetectionConfig sets the FraudDetectionConfig field's value.

func (EnrollmentConfig) String

func (s EnrollmentConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnrollmentConfig) Validate added in v1.44.230

func (s *EnrollmentConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnrollmentJobFraudDetectionConfig

type EnrollmentJobFraudDetectionConfig struct {

	// The action to take when the given speaker is flagged by the fraud detection
	// system. The default value is FAIL, which fails the speaker enrollment. Changing
	// this value to IGNORE results in the speaker being enrolled even if they are
	// flagged by the fraud detection system.
	FraudDetectionAction *string `type:"string" enum:"FraudDetectionAction"`

	// 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.
	RiskThreshold *int64 `type:"integer"`

	// The identifier of watchlists against which fraud detection is performed.
	WatchlistIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The fraud detection configuration to be used during the batch speaker enrollment job.

func (EnrollmentJobFraudDetectionConfig) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnrollmentJobFraudDetectionConfig) SetFraudDetectionAction

SetFraudDetectionAction sets the FraudDetectionAction field's value.

func (*EnrollmentJobFraudDetectionConfig) SetRiskThreshold

SetRiskThreshold sets the RiskThreshold field's value.

func (*EnrollmentJobFraudDetectionConfig) SetWatchlistIds added in v1.44.230

SetWatchlistIds sets the WatchlistIds field's value.

func (EnrollmentJobFraudDetectionConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnrollmentJobFraudDetectionConfig) Validate added in v1.44.230

Validate inspects the fields of the type to determine if they are valid.

type EvaluateSessionInput

type EvaluateSessionInput struct {

	// The identifier of the domain where the session started.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The session identifier, or name of the session, that you want to evaluate.
	// In Voice ID integration, this is the Contact-Id.
	//
	// SessionNameOrId is a required field
	SessionNameOrId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EvaluateSessionInput) GoString

func (s EvaluateSessionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EvaluateSessionInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*EvaluateSessionInput) SetSessionNameOrId

func (s *EvaluateSessionInput) SetSessionNameOrId(v string) *EvaluateSessionInput

SetSessionNameOrId sets the SessionNameOrId field's value.

func (EvaluateSessionInput) String

func (s EvaluateSessionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EvaluateSessionInput) Validate

func (s *EvaluateSessionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EvaluateSessionOutput

type EvaluateSessionOutput struct {

	// Details resulting from the authentication process, such as authentication
	// decision and authentication score.
	AuthenticationResult *AuthenticationResult `type:"structure"`

	// The identifier of the domain that contains the session.
	DomainId *string `min:"22" type:"string"`

	// Details resulting from the fraud detection process, such as fraud detection
	// decision and risk score.
	FraudDetectionResult *FraudDetectionResult `type:"structure"`

	// The service-generated identifier of the session.
	SessionId *string `min:"25" type:"string"`

	// The client-provided name of the session.
	SessionName *string `min:"1" type:"string"`

	// The current status of audio streaming for this session. This field is useful
	// to infer next steps when the Authentication or Fraud Detection results are
	// empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus
	// is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call
	// the API again later, after Voice ID has enough audio to produce a result.
	// If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED,
	// it means that the previously streamed session did not have enough speech
	// to perform evaluation, and a new streaming session is needed to try again.
	StreamingStatus *string `type:"string" enum:"StreamingStatus"`
	// contains filtered or unexported fields
}

func (EvaluateSessionOutput) GoString

func (s EvaluateSessionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EvaluateSessionOutput) SetAuthenticationResult

func (s *EvaluateSessionOutput) SetAuthenticationResult(v *AuthenticationResult) *EvaluateSessionOutput

SetAuthenticationResult sets the AuthenticationResult field's value.

func (*EvaluateSessionOutput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*EvaluateSessionOutput) SetFraudDetectionResult

func (s *EvaluateSessionOutput) SetFraudDetectionResult(v *FraudDetectionResult) *EvaluateSessionOutput

SetFraudDetectionResult sets the FraudDetectionResult field's value.

func (*EvaluateSessionOutput) SetSessionId

SetSessionId sets the SessionId field's value.

func (*EvaluateSessionOutput) SetSessionName

func (s *EvaluateSessionOutput) SetSessionName(v string) *EvaluateSessionOutput

SetSessionName sets the SessionName field's value.

func (*EvaluateSessionOutput) SetStreamingStatus

func (s *EvaluateSessionOutput) SetStreamingStatus(v string) *EvaluateSessionOutput

SetStreamingStatus sets the StreamingStatus field's value.

func (EvaluateSessionOutput) String

func (s EvaluateSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailureDetails

type FailureDetails struct {

	// A description of the error that caused the batch job failure.
	Message *string `min:"1" type:"string"`

	// An HTTP status code representing the nature of the error.
	StatusCode *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains error details for a failed batch job.

func (FailureDetails) GoString

func (s FailureDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailureDetails) SetMessage

func (s *FailureDetails) SetMessage(v string) *FailureDetails

SetMessage sets the Message field's value.

func (*FailureDetails) SetStatusCode

func (s *FailureDetails) SetStatusCode(v int64) *FailureDetails

SetStatusCode sets the StatusCode field's value.

func (FailureDetails) String

func (s FailureDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FraudDetectionConfiguration

type FraudDetectionConfiguration struct {

	// Threshold value for determining whether the speaker is a fraudster. If the
	// detected risk score calculated by Voice ID is higher than the threshold,
	// the speaker is considered a fraudster.
	RiskThreshold *int64 `type:"integer"`

	// The identifier of the watchlist against which fraud detection is performed.
	WatchlistId *string `min:"22" type:"string"`
	// contains filtered or unexported fields
}

The configuration used for performing fraud detection over a speaker during a session.

func (FraudDetectionConfiguration) GoString

func (s FraudDetectionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FraudDetectionConfiguration) SetRiskThreshold

SetRiskThreshold sets the RiskThreshold field's value.

func (*FraudDetectionConfiguration) SetWatchlistId added in v1.44.230

SetWatchlistId sets the WatchlistId field's value.

func (FraudDetectionConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FraudDetectionResult

type FraudDetectionResult struct {

	// A timestamp of when audio aggregation ended for this fraud detection result.
	AudioAggregationEndedAt *time.Time `type:"timestamp"`

	// A timestamp of when audio aggregation started for this fraud detection result.
	AudioAggregationStartedAt *time.Time `type:"timestamp"`

	// The FraudDetectionConfiguration used to generate this fraud detection result.
	Configuration *FraudDetectionConfiguration `type:"structure"`

	// The fraud detection decision produced by Voice ID, processed against the
	// current session state and streamed audio of the speaker.
	Decision *string `type:"string" enum:"FraudDetectionDecision"`

	// The unique identifier for this fraud detection result. Given there can be
	// multiple fraud detections for a given session, this field helps in identifying
	// if the returned result is from previous streaming activity or a new result.
	// Note that in the absence of any new streaming activity or risk threshold
	// changes, Voice ID always returns cached Fraud Detection result for this API.
	FraudDetectionResultId *string `min:"22" type:"string"`

	// The reason speaker was flagged by the fraud detection system. This is only
	// be populated if fraud detection Decision is HIGH_RISK, and the following
	// possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.
	Reasons []*string `type:"list" enum:"FraudDetectionReason"`

	// Details about each risk analyzed for this speaker. Currently, this contains
	// KnownFraudsterRisk and VoiceSpoofingRisk details.
	RiskDetails *FraudRiskDetails `type:"structure"`
	// contains filtered or unexported fields
}

The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

func (FraudDetectionResult) GoString

func (s FraudDetectionResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FraudDetectionResult) SetAudioAggregationEndedAt

func (s *FraudDetectionResult) SetAudioAggregationEndedAt(v time.Time) *FraudDetectionResult

SetAudioAggregationEndedAt sets the AudioAggregationEndedAt field's value.

func (*FraudDetectionResult) SetAudioAggregationStartedAt

func (s *FraudDetectionResult) SetAudioAggregationStartedAt(v time.Time) *FraudDetectionResult

SetAudioAggregationStartedAt sets the AudioAggregationStartedAt field's value.

func (*FraudDetectionResult) SetConfiguration

SetConfiguration sets the Configuration field's value.

func (*FraudDetectionResult) SetDecision

SetDecision sets the Decision field's value.

func (*FraudDetectionResult) SetFraudDetectionResultId

func (s *FraudDetectionResult) SetFraudDetectionResultId(v string) *FraudDetectionResult

SetFraudDetectionResultId sets the FraudDetectionResultId field's value.

func (*FraudDetectionResult) SetReasons

func (s *FraudDetectionResult) SetReasons(v []*string) *FraudDetectionResult

SetReasons sets the Reasons field's value.

func (*FraudDetectionResult) SetRiskDetails

SetRiskDetails sets the RiskDetails field's value.

func (FraudDetectionResult) String

func (s FraudDetectionResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FraudRiskDetails

type FraudRiskDetails struct {

	// The details resulting from 'Known Fraudster Risk' analysis of the speaker.
	//
	// KnownFraudsterRisk is a required field
	KnownFraudsterRisk *KnownFraudsterRisk `type:"structure" required:"true"`

	// The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
	//
	// VoiceSpoofingRisk is a required field
	VoiceSpoofingRisk *VoiceSpoofingRisk `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Details regarding various fraud risk analyses performed against the current session state and streamed audio of the speaker.

func (FraudRiskDetails) GoString

func (s FraudRiskDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FraudRiskDetails) SetKnownFraudsterRisk

func (s *FraudRiskDetails) SetKnownFraudsterRisk(v *KnownFraudsterRisk) *FraudRiskDetails

SetKnownFraudsterRisk sets the KnownFraudsterRisk field's value.

func (*FraudRiskDetails) SetVoiceSpoofingRisk added in v1.44.87

func (s *FraudRiskDetails) SetVoiceSpoofingRisk(v *VoiceSpoofingRisk) *FraudRiskDetails

SetVoiceSpoofingRisk sets the VoiceSpoofingRisk field's value.

func (FraudRiskDetails) String

func (s FraudRiskDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Fraudster

type Fraudster struct {

	// The timestamp of when Voice ID identified the fraudster.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of the domain that contains the fraudster.
	DomainId *string `min:"22" type:"string"`

	// The service-generated identifier for the fraudster.
	GeneratedFraudsterId *string `min:"25" type:"string"`

	// The identifier of the watchlists the fraudster is a part of.
	WatchlistIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains all the information about a fraudster.

func (Fraudster) GoString

func (s Fraudster) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Fraudster) SetCreatedAt

func (s *Fraudster) SetCreatedAt(v time.Time) *Fraudster

SetCreatedAt sets the CreatedAt field's value.

func (*Fraudster) SetDomainId

func (s *Fraudster) SetDomainId(v string) *Fraudster

SetDomainId sets the DomainId field's value.

func (*Fraudster) SetGeneratedFraudsterId

func (s *Fraudster) SetGeneratedFraudsterId(v string) *Fraudster

SetGeneratedFraudsterId sets the GeneratedFraudsterId field's value.

func (*Fraudster) SetWatchlistIds added in v1.44.230

func (s *Fraudster) SetWatchlistIds(v []*string) *Fraudster

SetWatchlistIds sets the WatchlistIds field's value.

func (Fraudster) String

func (s Fraudster) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FraudsterRegistrationJob

type FraudsterRegistrationJob struct {

	// A timestamp of when the fraudster registration job was created.
	CreatedAt *time.Time `type:"timestamp"`

	// 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.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The identifier of the domain that contains the fraudster registration job.
	DomainId *string `min:"22" type:"string"`

	// A timestamp of when the fraudster registration job ended.
	EndedAt *time.Time `type:"timestamp"`

	// Contains details that are populated when an entire batch job fails. In cases
	// of individual registration job failures, the batch job as a whole doesn't
	// fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can
	// use the job output file to identify the individual registration requests
	// that failed.
	FailureDetails *FailureDetails `type:"structure"`

	// The input data config containing an S3 URI for the input manifest file that
	// contains the list of fraudster registration job requests.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The service-generated identifier for the fraudster registration job.
	JobId *string `min:"22" type:"string"`

	// The client-provided name for the fraudster registration job.
	//
	// JobName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FraudsterRegistrationJob's
	// String and GoString methods.
	JobName *string `min:"1" type:"string" sensitive:"true"`

	// Shows the completed percentage of registration requests listed in the input
	// file.
	JobProgress *JobProgress `type:"structure"`

	// The current status of the fraudster registration job.
	JobStatus *string `type:"string" enum:"FraudsterRegistrationJobStatus"`

	// The output data config containing the S3 location where you want Voice ID
	// to write your job output file; you must also include a KMS key ID in order
	// to encrypt the file.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The registration config containing details such as the action to take when
	// a duplicate fraudster is detected, and the similarity threshold to use for
	// detecting a duplicate fraudster.
	RegistrationConfig *RegistrationConfig `type:"structure"`
	// contains filtered or unexported fields
}

Contains all the information about a fraudster registration job.

func (FraudsterRegistrationJob) GoString

func (s FraudsterRegistrationJob) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FraudsterRegistrationJob) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*FraudsterRegistrationJob) SetDataAccessRoleArn

func (s *FraudsterRegistrationJob) SetDataAccessRoleArn(v string) *FraudsterRegistrationJob

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*FraudsterRegistrationJob) SetDomainId

SetDomainId sets the DomainId field's value.

func (*FraudsterRegistrationJob) SetEndedAt

SetEndedAt sets the EndedAt field's value.

func (*FraudsterRegistrationJob) SetFailureDetails

SetFailureDetails sets the FailureDetails field's value.

func (*FraudsterRegistrationJob) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*FraudsterRegistrationJob) SetJobId

SetJobId sets the JobId field's value.

func (*FraudsterRegistrationJob) SetJobName

SetJobName sets the JobName field's value.

func (*FraudsterRegistrationJob) SetJobProgress

SetJobProgress sets the JobProgress field's value.

func (*FraudsterRegistrationJob) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (*FraudsterRegistrationJob) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*FraudsterRegistrationJob) SetRegistrationConfig

SetRegistrationConfig sets the RegistrationConfig field's value.

func (FraudsterRegistrationJob) String

func (s FraudsterRegistrationJob) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FraudsterRegistrationJobSummary

type FraudsterRegistrationJobSummary struct {

	// A timestamp of when the fraudster registration job was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of the domain that contains the fraudster registration job.
	DomainId *string `min:"22" type:"string"`

	// A timestamp of when the fraudster registration job ended.
	EndedAt *time.Time `type:"timestamp"`

	// Contains details that are populated when an entire batch job fails. In cases
	// of individual registration job failures, the batch job as a whole doesn't
	// fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can
	// use the job output file to identify the individual registration requests
	// that failed.
	FailureDetails *FailureDetails `type:"structure"`

	// The service-generated identifier for the fraudster registration job.
	JobId *string `min:"22" type:"string"`

	// The client-provided name for the fraudster registration job.
	//
	// JobName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FraudsterRegistrationJobSummary's
	// String and GoString methods.
	JobName *string `min:"1" type:"string" sensitive:"true"`

	// Shows the completed percentage of registration requests listed in the input
	// file.
	JobProgress *JobProgress `type:"structure"`

	// The current status of the fraudster registration job.
	JobStatus *string `type:"string" enum:"FraudsterRegistrationJobStatus"`
	// contains filtered or unexported fields
}

Contains a summary of information about a fraudster registration job.

func (FraudsterRegistrationJobSummary) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FraudsterRegistrationJobSummary) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*FraudsterRegistrationJobSummary) SetDomainId

SetDomainId sets the DomainId field's value.

func (*FraudsterRegistrationJobSummary) SetEndedAt

SetEndedAt sets the EndedAt field's value.

func (*FraudsterRegistrationJobSummary) SetFailureDetails

SetFailureDetails sets the FailureDetails field's value.

func (*FraudsterRegistrationJobSummary) SetJobId

SetJobId sets the JobId field's value.

func (*FraudsterRegistrationJobSummary) SetJobName

SetJobName sets the JobName field's value.

func (*FraudsterRegistrationJobSummary) SetJobProgress

SetJobProgress sets the JobProgress field's value.

func (*FraudsterRegistrationJobSummary) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (FraudsterRegistrationJobSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FraudsterSummary added in v1.44.230

type FraudsterSummary struct {

	// The timestamp of when the fraudster summary was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of the domain that contains the fraudster summary.
	DomainId *string `min:"22" type:"string"`

	// The service-generated identifier for the fraudster.
	GeneratedFraudsterId *string `min:"25" type:"string"`

	// The identifier of the watchlists the fraudster is a part of.
	WatchlistIds []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains a summary of information about a fraudster.

func (FraudsterSummary) GoString added in v1.44.230

func (s FraudsterSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FraudsterSummary) SetCreatedAt added in v1.44.230

func (s *FraudsterSummary) SetCreatedAt(v time.Time) *FraudsterSummary

SetCreatedAt sets the CreatedAt field's value.

func (*FraudsterSummary) SetDomainId added in v1.44.230

func (s *FraudsterSummary) SetDomainId(v string) *FraudsterSummary

SetDomainId sets the DomainId field's value.

func (*FraudsterSummary) SetGeneratedFraudsterId added in v1.44.230

func (s *FraudsterSummary) SetGeneratedFraudsterId(v string) *FraudsterSummary

SetGeneratedFraudsterId sets the GeneratedFraudsterId field's value.

func (*FraudsterSummary) SetWatchlistIds added in v1.44.230

func (s *FraudsterSummary) SetWatchlistIds(v []*string) *FraudsterSummary

SetWatchlistIds sets the WatchlistIds field's value.

func (FraudsterSummary) String added in v1.44.230

func (s FraudsterSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputDataConfig

type InputDataConfig struct {

	// The S3 location for the input manifest file that contains the list of individual
	// enrollment or registration job requests.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration containing input file information for a batch job.

func (InputDataConfig) GoString

func (s InputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDataConfig) SetS3Uri

func (s *InputDataConfig) SetS3Uri(v string) *InputDataConfig

SetS3Uri sets the S3Uri field's value.

func (InputDataConfig) String

func (s InputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDataConfig) Validate

func (s *InputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request failed due to an unknown error on the server side.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JobProgress

type JobProgress struct {

	// Shows the completed percentage of enrollment or registration requests listed
	// in the input file.
	PercentComplete *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Indicates the completion progress for a batch job.

func (JobProgress) GoString

func (s JobProgress) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobProgress) SetPercentComplete

func (s *JobProgress) SetPercentComplete(v int64) *JobProgress

SetPercentComplete sets the PercentComplete field's value.

func (JobProgress) String

func (s JobProgress) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnownFraudsterRisk

type KnownFraudsterRisk struct {

	// The identifier of the fraudster that is the closest match to the speaker.
	// If there are no fraudsters registered in a given domain, or if there are
	// no fraudsters with a non-zero RiskScore, this value is null.
	GeneratedFraudsterId *string `min:"25" type:"string"`

	// The score indicating the likelihood the speaker is a known fraudster.
	//
	// RiskScore is a required field
	RiskScore *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Contains details produced as a result of performing known fraudster risk analysis on a speaker.

func (KnownFraudsterRisk) GoString

func (s KnownFraudsterRisk) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnownFraudsterRisk) SetGeneratedFraudsterId

func (s *KnownFraudsterRisk) SetGeneratedFraudsterId(v string) *KnownFraudsterRisk

SetGeneratedFraudsterId sets the GeneratedFraudsterId field's value.

func (*KnownFraudsterRisk) SetRiskScore

func (s *KnownFraudsterRisk) SetRiskScore(v int64) *KnownFraudsterRisk

SetRiskScore sets the RiskScore field's value.

func (KnownFraudsterRisk) String

func (s KnownFraudsterRisk) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDomainsInput

type ListDomainsInput struct {

	// The maximum number of results that are returned per call. You can use NextToken
	// to obtain more pages of results. The default is 100; the maximum allowed
	// page size is also 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainsInput) GoString

func (s ListDomainsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsInput) SetMaxResults

func (s *ListDomainsInput) SetMaxResults(v int64) *ListDomainsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDomainsInput) SetNextToken

func (s *ListDomainsInput) SetNextToken(v string) *ListDomainsInput

SetNextToken sets the NextToken field's value.

func (ListDomainsInput) String

func (s ListDomainsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsInput) Validate

func (s *ListDomainsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDomainsOutput

type ListDomainsOutput struct {

	// A list containing details about each domain in the Amazon Web Services account.
	DomainSummaries []*DomainSummary `type:"list"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainsOutput) GoString

func (s ListDomainsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDomainsOutput) SetDomainSummaries

func (s *ListDomainsOutput) SetDomainSummaries(v []*DomainSummary) *ListDomainsOutput

SetDomainSummaries sets the DomainSummaries field's value.

func (*ListDomainsOutput) SetNextToken

func (s *ListDomainsOutput) SetNextToken(v string) *ListDomainsOutput

SetNextToken sets the NextToken field's value.

func (ListDomainsOutput) String

func (s ListDomainsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFraudsterRegistrationJobsInput

type ListFraudsterRegistrationJobsInput struct {

	// The identifier of the domain that contains the fraudster registration Jobs.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// Provides the status of your fraudster registration job.
	JobStatus *string `type:"string" enum:"FraudsterRegistrationJobStatus"`

	// The maximum number of results that are returned per call. You can use NextToken
	// to obtain more pages of results. The default is 100; the maximum allowed
	// page size is also 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFraudsterRegistrationJobsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFraudsterRegistrationJobsInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*ListFraudsterRegistrationJobsInput) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (*ListFraudsterRegistrationJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListFraudsterRegistrationJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFraudsterRegistrationJobsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFraudsterRegistrationJobsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListFraudsterRegistrationJobsOutput

type ListFraudsterRegistrationJobsOutput struct {

	// A list containing details about each specified fraudster registration job.
	JobSummaries []*FraudsterRegistrationJobSummary `type:"list"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFraudsterRegistrationJobsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFraudsterRegistrationJobsOutput) SetJobSummaries

SetJobSummaries sets the JobSummaries field's value.

func (*ListFraudsterRegistrationJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFraudsterRegistrationJobsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFraudstersInput added in v1.44.230

type ListFraudstersInput struct {

	// The identifier of the domain.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The maximum number of results that are returned per call. You can use NextToken
	// to obtain more pages of results. The default is 100; the maximum allowed
	// page size is also 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `type:"string"`

	// The identifier of the watchlist. If provided, all fraudsters in the watchlist
	// are listed. If not provided, all fraudsters in the domain are listed.
	WatchlistId *string `min:"22" type:"string"`
	// contains filtered or unexported fields
}

func (ListFraudstersInput) GoString added in v1.44.230

func (s ListFraudstersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFraudstersInput) SetDomainId added in v1.44.230

func (s *ListFraudstersInput) SetDomainId(v string) *ListFraudstersInput

SetDomainId sets the DomainId field's value.

func (*ListFraudstersInput) SetMaxResults added in v1.44.230

func (s *ListFraudstersInput) SetMaxResults(v int64) *ListFraudstersInput

SetMaxResults sets the MaxResults field's value.

func (*ListFraudstersInput) SetNextToken added in v1.44.230

func (s *ListFraudstersInput) SetNextToken(v string) *ListFraudstersInput

SetNextToken sets the NextToken field's value.

func (*ListFraudstersInput) SetWatchlistId added in v1.44.230

func (s *ListFraudstersInput) SetWatchlistId(v string) *ListFraudstersInput

SetWatchlistId sets the WatchlistId field's value.

func (ListFraudstersInput) String added in v1.44.230

func (s ListFraudstersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFraudstersInput) Validate added in v1.44.230

func (s *ListFraudstersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFraudstersOutput added in v1.44.230

type ListFraudstersOutput struct {

	// A list that contains details about each fraudster in the Amazon Web Services
	// account.
	FraudsterSummaries []*FraudsterSummary `type:"list"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFraudstersOutput) GoString added in v1.44.230

func (s ListFraudstersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFraudstersOutput) SetFraudsterSummaries added in v1.44.230

func (s *ListFraudstersOutput) SetFraudsterSummaries(v []*FraudsterSummary) *ListFraudstersOutput

SetFraudsterSummaries sets the FraudsterSummaries field's value.

func (*ListFraudstersOutput) SetNextToken added in v1.44.230

func (s *ListFraudstersOutput) SetNextToken(v string) *ListFraudstersOutput

SetNextToken sets the NextToken field's value.

func (ListFraudstersOutput) String added in v1.44.230

func (s ListFraudstersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSpeakerEnrollmentJobsInput

type ListSpeakerEnrollmentJobsInput struct {

	// The identifier of the domain that contains the speaker enrollment jobs.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// Provides the status of your speaker enrollment Job.
	JobStatus *string `type:"string" enum:"SpeakerEnrollmentJobStatus"`

	// The maximum number of results that are returned per call. You can use NextToken
	// to obtain more pages of results. The default is 100; the maximum allowed
	// page size is also 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSpeakerEnrollmentJobsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSpeakerEnrollmentJobsInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*ListSpeakerEnrollmentJobsInput) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (*ListSpeakerEnrollmentJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListSpeakerEnrollmentJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListSpeakerEnrollmentJobsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSpeakerEnrollmentJobsInput) Validate

func (s *ListSpeakerEnrollmentJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSpeakerEnrollmentJobsOutput

type ListSpeakerEnrollmentJobsOutput struct {

	// A list containing details about each specified speaker enrollment job.
	JobSummaries []*SpeakerEnrollmentJobSummary `type:"list"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListSpeakerEnrollmentJobsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSpeakerEnrollmentJobsOutput) SetJobSummaries

SetJobSummaries sets the JobSummaries field's value.

func (*ListSpeakerEnrollmentJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListSpeakerEnrollmentJobsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSpeakersInput

type ListSpeakersInput struct {

	// The identifier of the domain.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The maximum number of results that are returned per call. You can use NextToken
	// to obtain more pages of results. The default is 100; the maximum allowed
	// page size is also 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListSpeakersInput) GoString

func (s ListSpeakersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSpeakersInput) SetDomainId

func (s *ListSpeakersInput) SetDomainId(v string) *ListSpeakersInput

SetDomainId sets the DomainId field's value.

func (*ListSpeakersInput) SetMaxResults

func (s *ListSpeakersInput) SetMaxResults(v int64) *ListSpeakersInput

SetMaxResults sets the MaxResults field's value.

func (*ListSpeakersInput) SetNextToken

func (s *ListSpeakersInput) SetNextToken(v string) *ListSpeakersInput

SetNextToken sets the NextToken field's value.

func (ListSpeakersInput) String

func (s ListSpeakersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSpeakersInput) Validate

func (s *ListSpeakersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSpeakersOutput

type ListSpeakersOutput struct {

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `min:"1" type:"string"`

	// A list containing details about each speaker in the Amazon Web Services account.
	SpeakerSummaries []*SpeakerSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListSpeakersOutput) GoString

func (s ListSpeakersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSpeakersOutput) SetNextToken

func (s *ListSpeakersOutput) SetNextToken(v string) *ListSpeakersOutput

SetNextToken sets the NextToken field's value.

func (*ListSpeakersOutput) SetSpeakerSummaries

func (s *ListSpeakersOutput) SetSpeakerSummaries(v []*SpeakerSummary) *ListSpeakersOutput

SetSpeakerSummaries sets the SpeakerSummaries field's value.

func (ListSpeakersOutput) String

func (s ListSpeakersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the Voice ID resource for which you want
	// to list the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The list of tags associated with the specified resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWatchlistsInput added in v1.44.230

type ListWatchlistsInput struct {

	// The identifier of the domain.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The maximum number of results that are returned per call. You can use NextToken
	// to obtain more pages of results. The default is 100; the maximum allowed
	// page size is also 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListWatchlistsInput) GoString added in v1.44.230

func (s ListWatchlistsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWatchlistsInput) SetDomainId added in v1.44.230

func (s *ListWatchlistsInput) SetDomainId(v string) *ListWatchlistsInput

SetDomainId sets the DomainId field's value.

func (*ListWatchlistsInput) SetMaxResults added in v1.44.230

func (s *ListWatchlistsInput) SetMaxResults(v int64) *ListWatchlistsInput

SetMaxResults sets the MaxResults field's value.

func (*ListWatchlistsInput) SetNextToken added in v1.44.230

func (s *ListWatchlistsInput) SetNextToken(v string) *ListWatchlistsInput

SetNextToken sets the NextToken field's value.

func (ListWatchlistsInput) String added in v1.44.230

func (s ListWatchlistsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWatchlistsInput) Validate added in v1.44.230

func (s *ListWatchlistsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWatchlistsOutput added in v1.44.230

type ListWatchlistsOutput struct {

	// If NextToken is returned, there are more results available. The value of
	// NextToken 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.
	NextToken *string `min:"1" type:"string"`

	// A list that contains details about each watchlist in the Amazon Web Services
	// account.
	WatchlistSummaries []*WatchlistSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListWatchlistsOutput) GoString added in v1.44.230

func (s ListWatchlistsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWatchlistsOutput) SetNextToken added in v1.44.230

func (s *ListWatchlistsOutput) SetNextToken(v string) *ListWatchlistsOutput

SetNextToken sets the NextToken field's value.

func (*ListWatchlistsOutput) SetWatchlistSummaries added in v1.44.230

func (s *ListWatchlistsOutput) SetWatchlistSummaries(v []*WatchlistSummary) *ListWatchlistsOutput

SetWatchlistSummaries sets the WatchlistSummaries field's value.

func (ListWatchlistsOutput) String added in v1.44.230

func (s ListWatchlistsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OptOutSpeakerInput

type OptOutSpeakerInput struct {

	// The identifier of the domain that contains the speaker.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The identifier of the speaker you want opted-out.
	//
	// SpeakerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by OptOutSpeakerInput's
	// String and GoString methods.
	//
	// SpeakerId is a required field
	SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (OptOutSpeakerInput) GoString

func (s OptOutSpeakerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptOutSpeakerInput) SetDomainId

func (s *OptOutSpeakerInput) SetDomainId(v string) *OptOutSpeakerInput

SetDomainId sets the DomainId field's value.

func (*OptOutSpeakerInput) SetSpeakerId

func (s *OptOutSpeakerInput) SetSpeakerId(v string) *OptOutSpeakerInput

SetSpeakerId sets the SpeakerId field's value.

func (OptOutSpeakerInput) String

func (s OptOutSpeakerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptOutSpeakerInput) Validate

func (s *OptOutSpeakerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OptOutSpeakerOutput

type OptOutSpeakerOutput struct {

	// Details about the opted-out speaker.
	Speaker *Speaker `type:"structure"`
	// contains filtered or unexported fields
}

func (OptOutSpeakerOutput) GoString

func (s OptOutSpeakerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OptOutSpeakerOutput) SetSpeaker

func (s *OptOutSpeakerOutput) SetSpeaker(v *Speaker) *OptOutSpeakerOutput

SetSpeaker sets the Speaker field's value.

func (OptOutSpeakerOutput) String

func (s OptOutSpeakerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OutputDataConfig

type OutputDataConfig struct {

	// The identifier of the KMS key you want Voice ID to use to encrypt the output
	// file of a speaker enrollment job/fraudster registration job.
	KmsKeyId *string `min:"1" type:"string"`

	// The S3 path of the folder where Voice ID writes the job output file. It has
	// a *.out extension. For example, if the input file name is input-file.json
	// and the output folder path is s3://output-bucket/output-folder, the full
	// output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration containing output file information for a batch job.

func (OutputDataConfig) GoString

func (s OutputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputDataConfig) SetKmsKeyId

func (s *OutputDataConfig) SetKmsKeyId(v string) *OutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*OutputDataConfig) SetS3Uri

func (s *OutputDataConfig) SetS3Uri(v string) *OutputDataConfig

SetS3Uri sets the S3Uri field's value.

func (OutputDataConfig) String

func (s OutputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputDataConfig) Validate

func (s *OutputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegistrationConfig

type RegistrationConfig struct {

	// The action to take when a fraudster is identified as a duplicate. The default
	// action is SKIP, which skips registering the duplicate fraudster. Setting
	// the value to REGISTER_AS_NEW always registers a new fraudster into the specified
	// domain.
	DuplicateRegistrationAction *string `type:"string" enum:"DuplicateRegistrationAction"`

	// The minimum similarity score between the new and old fraudsters in order
	// to consider the new fraudster a duplicate.
	FraudsterSimilarityThreshold *int64 `type:"integer"`

	// The identifiers of watchlists that a fraudster is registered to. If a watchlist
	// isn't provided, the fraudsters are registered to the default watchlist.
	WatchlistIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The registration configuration to be used during the batch fraudster registration job.

func (RegistrationConfig) GoString

func (s RegistrationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegistrationConfig) SetDuplicateRegistrationAction

func (s *RegistrationConfig) SetDuplicateRegistrationAction(v string) *RegistrationConfig

SetDuplicateRegistrationAction sets the DuplicateRegistrationAction field's value.

func (*RegistrationConfig) SetFraudsterSimilarityThreshold

func (s *RegistrationConfig) SetFraudsterSimilarityThreshold(v int64) *RegistrationConfig

SetFraudsterSimilarityThreshold sets the FraudsterSimilarityThreshold field's value.

func (*RegistrationConfig) SetWatchlistIds added in v1.44.230

func (s *RegistrationConfig) SetWatchlistIds(v []*string) *RegistrationConfig

SetWatchlistIds sets the WatchlistIds field's value.

func (RegistrationConfig) String

func (s RegistrationConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegistrationConfig) Validate added in v1.44.230

func (s *RegistrationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`

	// The type of resource which cannot not be found. Possible types are BATCH_JOB,
	// COMPLIANCE_CONSENT, DOMAIN, FRAUDSTER, SESSION and SPEAKER.
	ResourceType *string `type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

The specified resource cannot be found. Check the ResourceType and error message for more details.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServerSideEncryptionConfiguration

type ServerSideEncryptionConfiguration struct {

	// The identifier of the KMS key to use to encrypt data stored by Voice ID.
	// Voice ID doesn't support asymmetric customer managed keys.
	//
	// KmsKeyId is a required field
	KmsKeyId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration containing information about the customer managed key used for encrypting customer data.

func (ServerSideEncryptionConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) SetKmsKeyId

SetKmsKeyId sets the KmsKeyId field's value.

func (ServerSideEncryptionConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

type ServerSideEncryptionUpdateDetails added in v1.44.27

type ServerSideEncryptionUpdateDetails struct {

	// Message explaining the current UpdateStatus. When the UpdateStatus is FAILED,
	// this message explains the cause of the failure.
	Message *string `min:"1" type:"string"`

	// The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration
	// was updated to a new KMS key ID.
	OldKmsKeyId *string `min:"1" type:"string"`

	// Status of the server-side encryption update. During an update, if there is
	// an issue with the domain's current or old KMS key ID, such as an inaccessible
	// or disabled key, then the status is FAILED. In order to resolve this, the
	// key needs to be made accessible, and then an UpdateDomain call with the existing
	// server-side encryption configuration will re-attempt this update process.
	UpdateStatus *string `type:"string" enum:"ServerSideEncryptionUpdateStatus"`
	// contains filtered or unexported fields
}

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.

func (ServerSideEncryptionUpdateDetails) GoString added in v1.44.27

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionUpdateDetails) SetMessage added in v1.44.27

SetMessage sets the Message field's value.

func (*ServerSideEncryptionUpdateDetails) SetOldKmsKeyId added in v1.44.27

SetOldKmsKeyId sets the OldKmsKeyId field's value.

func (*ServerSideEncryptionUpdateDetails) SetUpdateStatus added in v1.44.27

SetUpdateStatus sets the UpdateStatus field's value.

func (ServerSideEncryptionUpdateDetails) String added in v1.44.27

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Speaker

type Speaker struct {

	// A timestamp of when the speaker was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The client-provided identifier for the speaker.
	//
	// CustomerSpeakerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Speaker's
	// String and GoString methods.
	CustomerSpeakerId *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain that contains the speaker.
	DomainId *string `min:"22" type:"string"`

	// The service-generated identifier for the speaker.
	GeneratedSpeakerId *string `min:"25" type:"string"`

	// The timestamp of when the speaker was last accessed for enrollment, re-enrollment
	// or a successful authentication. This timestamp is accurate to one hour.
	LastAccessedAt *time.Time `type:"timestamp"`

	// The current status of the speaker.
	Status *string `type:"string" enum:"SpeakerStatus"`

	// A timestamp of the speaker's last update.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Contains all the information about a speaker.

func (Speaker) GoString

func (s Speaker) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Speaker) SetCreatedAt

func (s *Speaker) SetCreatedAt(v time.Time) *Speaker

SetCreatedAt sets the CreatedAt field's value.

func (*Speaker) SetCustomerSpeakerId

func (s *Speaker) SetCustomerSpeakerId(v string) *Speaker

SetCustomerSpeakerId sets the CustomerSpeakerId field's value.

func (*Speaker) SetDomainId

func (s *Speaker) SetDomainId(v string) *Speaker

SetDomainId sets the DomainId field's value.

func (*Speaker) SetGeneratedSpeakerId

func (s *Speaker) SetGeneratedSpeakerId(v string) *Speaker

SetGeneratedSpeakerId sets the GeneratedSpeakerId field's value.

func (*Speaker) SetLastAccessedAt added in v1.44.22

func (s *Speaker) SetLastAccessedAt(v time.Time) *Speaker

SetLastAccessedAt sets the LastAccessedAt field's value.

func (*Speaker) SetStatus

func (s *Speaker) SetStatus(v string) *Speaker

SetStatus sets the Status field's value.

func (*Speaker) SetUpdatedAt

func (s *Speaker) SetUpdatedAt(v time.Time) *Speaker

SetUpdatedAt sets the UpdatedAt field's value.

func (Speaker) String

func (s Speaker) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SpeakerEnrollmentJob

type SpeakerEnrollmentJob struct {

	// A timestamp of when the speaker enrollment job was created.
	CreatedAt *time.Time `type:"timestamp"`

	// 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.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The identifier of the domain that contains the speaker enrollment job.
	DomainId *string `min:"22" type:"string"`

	// A timestamp of when the speaker enrollment job ended.
	EndedAt *time.Time `type:"timestamp"`

	// The configuration that defines the action to take when the speaker is already
	// enrolled in Voice ID, and the FraudDetectionConfig to use.
	EnrollmentConfig *EnrollmentConfig `type:"structure"`

	// Contains details that are populated when an entire batch job fails. In cases
	// of individual registration job failures, the batch job as a whole doesn't
	// fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can
	// use the job output file to identify the individual registration requests
	// that failed.
	FailureDetails *FailureDetails `type:"structure"`

	// The input data config containing an S3 URI for the input manifest file that
	// contains the list of speaker enrollment job requests.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The service-generated identifier for the speaker enrollment job.
	JobId *string `min:"22" type:"string"`

	// The client-provided name for the speaker enrollment job.
	//
	// JobName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SpeakerEnrollmentJob's
	// String and GoString methods.
	JobName *string `min:"1" type:"string" sensitive:"true"`

	// Provides details on job progress. This field shows the completed percentage
	// of registration requests listed in the input file.
	JobProgress *JobProgress `type:"structure"`

	// The current status of the speaker enrollment job.
	JobStatus *string `type:"string" enum:"SpeakerEnrollmentJobStatus"`

	// The output data config containing the S3 location where Voice ID writes the
	// job output file; you must also include a KMS key ID to encrypt the file.
	OutputDataConfig *OutputDataConfig `type:"structure"`
	// contains filtered or unexported fields
}

Contains all the information about a speaker enrollment job.

func (SpeakerEnrollmentJob) GoString

func (s SpeakerEnrollmentJob) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SpeakerEnrollmentJob) SetCreatedAt

func (s *SpeakerEnrollmentJob) SetCreatedAt(v time.Time) *SpeakerEnrollmentJob

SetCreatedAt sets the CreatedAt field's value.

func (*SpeakerEnrollmentJob) SetDataAccessRoleArn

func (s *SpeakerEnrollmentJob) SetDataAccessRoleArn(v string) *SpeakerEnrollmentJob

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*SpeakerEnrollmentJob) SetDomainId

SetDomainId sets the DomainId field's value.

func (*SpeakerEnrollmentJob) SetEndedAt

SetEndedAt sets the EndedAt field's value.

func (*SpeakerEnrollmentJob) SetEnrollmentConfig

func (s *SpeakerEnrollmentJob) SetEnrollmentConfig(v *EnrollmentConfig) *SpeakerEnrollmentJob

SetEnrollmentConfig sets the EnrollmentConfig field's value.

func (*SpeakerEnrollmentJob) SetFailureDetails

func (s *SpeakerEnrollmentJob) SetFailureDetails(v *FailureDetails) *SpeakerEnrollmentJob

SetFailureDetails sets the FailureDetails field's value.

func (*SpeakerEnrollmentJob) SetInputDataConfig

func (s *SpeakerEnrollmentJob) SetInputDataConfig(v *InputDataConfig) *SpeakerEnrollmentJob

SetInputDataConfig sets the InputDataConfig field's value.

func (*SpeakerEnrollmentJob) SetJobId

SetJobId sets the JobId field's value.

func (*SpeakerEnrollmentJob) SetJobName

SetJobName sets the JobName field's value.

func (*SpeakerEnrollmentJob) SetJobProgress

func (s *SpeakerEnrollmentJob) SetJobProgress(v *JobProgress) *SpeakerEnrollmentJob

SetJobProgress sets the JobProgress field's value.

func (*SpeakerEnrollmentJob) SetJobStatus

func (s *SpeakerEnrollmentJob) SetJobStatus(v string) *SpeakerEnrollmentJob

SetJobStatus sets the JobStatus field's value.

func (*SpeakerEnrollmentJob) SetOutputDataConfig

func (s *SpeakerEnrollmentJob) SetOutputDataConfig(v *OutputDataConfig) *SpeakerEnrollmentJob

SetOutputDataConfig sets the OutputDataConfig field's value.

func (SpeakerEnrollmentJob) String

func (s SpeakerEnrollmentJob) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SpeakerEnrollmentJobSummary

type SpeakerEnrollmentJobSummary struct {

	// A timestamp of when of the speaker enrollment job was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of the domain that contains the speaker enrollment job.
	DomainId *string `min:"22" type:"string"`

	// A timestamp of when the speaker enrollment job ended.
	EndedAt *time.Time `type:"timestamp"`

	// Contains details that are populated when an entire batch job fails. In cases
	// of individual registration job failures, the batch job as a whole doesn't
	// fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can
	// use the job output file to identify the individual registration requests
	// that failed.
	FailureDetails *FailureDetails `type:"structure"`

	// The service-generated identifier for the speaker enrollment job.
	JobId *string `min:"22" type:"string"`

	// The client-provided name for the speaker enrollment job.
	//
	// JobName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SpeakerEnrollmentJobSummary's
	// String and GoString methods.
	JobName *string `min:"1" type:"string" sensitive:"true"`

	// Provides details regarding job progress. This field shows the completed percentage
	// of enrollment requests listed in the input file.
	JobProgress *JobProgress `type:"structure"`

	// The current status of the speaker enrollment job.
	JobStatus *string `type:"string" enum:"SpeakerEnrollmentJobStatus"`
	// contains filtered or unexported fields
}

Contains a summary of information about a speaker enrollment job.

func (SpeakerEnrollmentJobSummary) GoString

func (s SpeakerEnrollmentJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SpeakerEnrollmentJobSummary) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*SpeakerEnrollmentJobSummary) SetDomainId

SetDomainId sets the DomainId field's value.

func (*SpeakerEnrollmentJobSummary) SetEndedAt

SetEndedAt sets the EndedAt field's value.

func (*SpeakerEnrollmentJobSummary) SetFailureDetails

SetFailureDetails sets the FailureDetails field's value.

func (*SpeakerEnrollmentJobSummary) SetJobId

SetJobId sets the JobId field's value.

func (*SpeakerEnrollmentJobSummary) SetJobName

SetJobName sets the JobName field's value.

func (*SpeakerEnrollmentJobSummary) SetJobProgress

SetJobProgress sets the JobProgress field's value.

func (*SpeakerEnrollmentJobSummary) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (SpeakerEnrollmentJobSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SpeakerSummary

type SpeakerSummary struct {

	// A timestamp showing the speaker's creation time.
	CreatedAt *time.Time `type:"timestamp"`

	// The client-provided identifier for the speaker.
	//
	// CustomerSpeakerId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SpeakerSummary's
	// String and GoString methods.
	CustomerSpeakerId *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain that contains the speaker.
	DomainId *string `min:"22" type:"string"`

	// The service-generated identifier for the speaker.
	GeneratedSpeakerId *string `min:"25" type:"string"`

	// The timestamp when the speaker was last accessed for enrollment, re-enrollment
	// or a successful authentication. This timestamp is accurate to one hour.
	LastAccessedAt *time.Time `type:"timestamp"`

	// The current status of the speaker.
	Status *string `type:"string" enum:"SpeakerStatus"`

	// A timestamp showing the speaker's last update.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Contains a summary of information about a speaker.

func (SpeakerSummary) GoString

func (s SpeakerSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SpeakerSummary) SetCreatedAt

func (s *SpeakerSummary) SetCreatedAt(v time.Time) *SpeakerSummary

SetCreatedAt sets the CreatedAt field's value.

func (*SpeakerSummary) SetCustomerSpeakerId

func (s *SpeakerSummary) SetCustomerSpeakerId(v string) *SpeakerSummary

SetCustomerSpeakerId sets the CustomerSpeakerId field's value.

func (*SpeakerSummary) SetDomainId

func (s *SpeakerSummary) SetDomainId(v string) *SpeakerSummary

SetDomainId sets the DomainId field's value.

func (*SpeakerSummary) SetGeneratedSpeakerId

func (s *SpeakerSummary) SetGeneratedSpeakerId(v string) *SpeakerSummary

SetGeneratedSpeakerId sets the GeneratedSpeakerId field's value.

func (*SpeakerSummary) SetLastAccessedAt added in v1.44.22

func (s *SpeakerSummary) SetLastAccessedAt(v time.Time) *SpeakerSummary

SetLastAccessedAt sets the LastAccessedAt field's value.

func (*SpeakerSummary) SetStatus

func (s *SpeakerSummary) SetStatus(v string) *SpeakerSummary

SetStatus sets the Status field's value.

func (*SpeakerSummary) SetUpdatedAt

func (s *SpeakerSummary) SetUpdatedAt(v time.Time) *SpeakerSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (SpeakerSummary) String

func (s SpeakerSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartFraudsterRegistrationJobInput

type StartFraudsterRegistrationJobInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 Create and edit a fraudster watchlist (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html)
	// documentation for the permissions needed in this role.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The identifier of the domain that contains the fraudster registration job
	// and in which the fraudsters are registered.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The input data config containing an S3 URI for the input manifest file that
	// contains the list of fraudster registration requests.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The name of the new fraudster registration job.
	//
	// JobName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartFraudsterRegistrationJobInput's
	// String and GoString methods.
	JobName *string `min:"1" type:"string" sensitive:"true"`

	// The output data config containing the S3 location where Voice ID writes the
	// job output file; you must also include a KMS key ID to encrypt the file.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// The registration config containing details such as the action to take when
	// a duplicate fraudster is detected, and the similarity threshold to use for
	// detecting a duplicate fraudster.
	RegistrationConfig *RegistrationConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartFraudsterRegistrationJobInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFraudsterRegistrationJobInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*StartFraudsterRegistrationJobInput) SetDataAccessRoleArn

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartFraudsterRegistrationJobInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*StartFraudsterRegistrationJobInput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartFraudsterRegistrationJobInput) SetJobName

SetJobName sets the JobName field's value.

func (*StartFraudsterRegistrationJobInput) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartFraudsterRegistrationJobInput) SetRegistrationConfig

SetRegistrationConfig sets the RegistrationConfig field's value.

func (StartFraudsterRegistrationJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFraudsterRegistrationJobInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type StartFraudsterRegistrationJobOutput

type StartFraudsterRegistrationJobOutput struct {

	// Details about the started fraudster registration job.
	Job *FraudsterRegistrationJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartFraudsterRegistrationJobOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartFraudsterRegistrationJobOutput) SetJob

SetJob sets the Job field's value.

func (StartFraudsterRegistrationJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSpeakerEnrollmentJobInput

type StartSpeakerEnrollmentJobInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. If not provided, the Amazon Web Services SDK populates this
	// field. For more information about idempotency, see Making retries safe with
	// idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 Batch enrollment using audio data from prior calls
	// (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html)
	// for the permissions needed in this role.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The identifier of the domain that contains the speaker enrollment job and
	// in which the speakers are enrolled.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The enrollment config that contains details such as the action to take when
	// a speaker is already enrolled in Voice ID or when a speaker is identified
	// as a fraudster.
	EnrollmentConfig *EnrollmentConfig `type:"structure"`

	// The input data config containing the S3 location for the input manifest file
	// that contains the list of speaker enrollment requests.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// A name for your speaker enrollment job.
	//
	// JobName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartSpeakerEnrollmentJobInput's
	// String and GoString methods.
	JobName *string `min:"1" type:"string" sensitive:"true"`

	// The output data config containing the S3 location where Voice ID writes the
	// job output file; you must also include a KMS key ID to encrypt the file.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartSpeakerEnrollmentJobInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSpeakerEnrollmentJobInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*StartSpeakerEnrollmentJobInput) SetDataAccessRoleArn

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartSpeakerEnrollmentJobInput) SetDomainId

SetDomainId sets the DomainId field's value.

func (*StartSpeakerEnrollmentJobInput) SetEnrollmentConfig

SetEnrollmentConfig sets the EnrollmentConfig field's value.

func (*StartSpeakerEnrollmentJobInput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartSpeakerEnrollmentJobInput) SetJobName

SetJobName sets the JobName field's value.

func (*StartSpeakerEnrollmentJobInput) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartSpeakerEnrollmentJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSpeakerEnrollmentJobInput) Validate

func (s *StartSpeakerEnrollmentJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSpeakerEnrollmentJobOutput

type StartSpeakerEnrollmentJobOutput struct {

	// Details about the started speaker enrollment job.
	Job *SpeakerEnrollmentJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartSpeakerEnrollmentJobOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSpeakerEnrollmentJobOutput) SetJob

SetJob sets the Job field's value.

func (StartSpeakerEnrollmentJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag

type Tag struct {

	// The first part of a key:value pair that forms a tag associated with a given
	// resource. For example, in the tag 'Department':'Sales', the key is 'Department'.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The second part of a key:value pair that forms a tag associated with a given
	// resource. For example, in the tag 'Department':'Sales', the value is 'Sales'.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Value is a required field
	Value *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// The list of tags to assign to the specified resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Voice ID resource you want to remove
	// tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// The list of tag keys you want to remove from the specified resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDomainInput

type UpdateDomainInput struct {

	// A brief description about this domain.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateDomainInput's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain to be updated.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The name of the domain.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateDomainInput's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The configuration, containing the KMS key identifier, to be used by Voice
	// ID for the server-side encryption of your data. Changing the domain's associated
	// KMS key immediately triggers an asynchronous process to remove dependency
	// on the old KMS key, such that the domain's data can only be accessed using
	// the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains
	// the details for this process.
	//
	// ServerSideEncryptionConfiguration is a required field
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDomainInput) GoString

func (s UpdateDomainInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainInput) SetDescription

func (s *UpdateDomainInput) SetDescription(v string) *UpdateDomainInput

SetDescription sets the Description field's value.

func (*UpdateDomainInput) SetDomainId

func (s *UpdateDomainInput) SetDomainId(v string) *UpdateDomainInput

SetDomainId sets the DomainId field's value.

func (*UpdateDomainInput) SetName

SetName sets the Name field's value.

func (*UpdateDomainInput) SetServerSideEncryptionConfiguration

func (s *UpdateDomainInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *UpdateDomainInput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (UpdateDomainInput) String

func (s UpdateDomainInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainInput) Validate

func (s *UpdateDomainInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDomainOutput

type UpdateDomainOutput struct {

	// Details about the updated domain
	Domain *Domain `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDomainOutput) GoString

func (s UpdateDomainOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDomainOutput) SetDomain

func (s *UpdateDomainOutput) SetDomain(v *Domain) *UpdateDomainOutput

SetDomain sets the Domain field's value.

func (UpdateDomainOutput) String

func (s UpdateDomainOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWatchlistInput added in v1.44.230

type UpdateWatchlistInput struct {

	// A brief description about this watchlist.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateWatchlistInput's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain that contains the watchlist.
	//
	// DomainId is a required field
	DomainId *string `min:"22" type:"string" required:"true"`

	// The name of the watchlist.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateWatchlistInput's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the watchlist to be updated.
	//
	// WatchlistId is a required field
	WatchlistId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWatchlistInput) GoString added in v1.44.230

func (s UpdateWatchlistInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWatchlistInput) SetDescription added in v1.44.230

func (s *UpdateWatchlistInput) SetDescription(v string) *UpdateWatchlistInput

SetDescription sets the Description field's value.

func (*UpdateWatchlistInput) SetDomainId added in v1.44.230

SetDomainId sets the DomainId field's value.

func (*UpdateWatchlistInput) SetName added in v1.44.230

SetName sets the Name field's value.

func (*UpdateWatchlistInput) SetWatchlistId added in v1.44.230

func (s *UpdateWatchlistInput) SetWatchlistId(v string) *UpdateWatchlistInput

SetWatchlistId sets the WatchlistId field's value.

func (UpdateWatchlistInput) String added in v1.44.230

func (s UpdateWatchlistInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWatchlistInput) Validate added in v1.44.230

func (s *UpdateWatchlistInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWatchlistOutput added in v1.44.230

type UpdateWatchlistOutput struct {

	// Details about the updated watchlist.
	Watchlist *Watchlist `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateWatchlistOutput) GoString added in v1.44.230

func (s UpdateWatchlistOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWatchlistOutput) SetWatchlist added in v1.44.230

SetWatchlist sets the Watchlist field's value.

func (UpdateWatchlistOutput) String added in v1.44.230

func (s UpdateWatchlistOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request failed one or more validations; check the error message for more details.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VoiceID

type VoiceID struct {
	*client.Client
}

VoiceID provides the API operation methods for making requests to Amazon Voice ID. See this package's package overview docs for details on the service.

VoiceID methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *VoiceID

New creates a new instance of the VoiceID client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a VoiceID client from just a session.
svc := voiceid.New(mySession)

// Create a VoiceID client with additional configuration
svc := voiceid.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*VoiceID) AssociateFraudster added in v1.44.230

func (c *VoiceID) AssociateFraudster(input *AssociateFraudsterInput) (*AssociateFraudsterOutput, error)

AssociateFraudster API operation for Amazon Voice ID.

Associates the fraudsters with the watchlist specified in the same domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation AssociateFraudster for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/AssociateFraudster

func (*VoiceID) AssociateFraudsterRequest added in v1.44.230

func (c *VoiceID) AssociateFraudsterRequest(input *AssociateFraudsterInput) (req *request.Request, output *AssociateFraudsterOutput)

AssociateFraudsterRequest generates a "aws/request.Request" representing the client's request for the AssociateFraudster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateFraudster for more information on using the AssociateFraudster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateFraudsterRequest method.
req, resp := client.AssociateFraudsterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/AssociateFraudster

func (*VoiceID) AssociateFraudsterWithContext added in v1.44.230

func (c *VoiceID) AssociateFraudsterWithContext(ctx aws.Context, input *AssociateFraudsterInput, opts ...request.Option) (*AssociateFraudsterOutput, error)

AssociateFraudsterWithContext is the same as AssociateFraudster with the addition of the ability to pass a context and additional request options.

See AssociateFraudster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) CreateDomain

func (c *VoiceID) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error)

CreateDomain API operation for Amazon Voice ID.

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation CreateDomain for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateDomain

func (*VoiceID) CreateDomainRequest

func (c *VoiceID) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput)

CreateDomainRequest generates a "aws/request.Request" representing the client's request for the CreateDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDomain for more information on using the CreateDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDomainRequest method.
req, resp := client.CreateDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateDomain

func (*VoiceID) CreateDomainWithContext

func (c *VoiceID) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error)

CreateDomainWithContext is the same as CreateDomain with the addition of the ability to pass a context and additional request options.

See CreateDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) CreateWatchlist added in v1.44.230

func (c *VoiceID) CreateWatchlist(input *CreateWatchlistInput) (*CreateWatchlistOutput, error)

CreateWatchlist API operation for Amazon Voice ID.

Creates a watchlist that fraudsters can be a part of.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation CreateWatchlist for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateWatchlist

func (*VoiceID) CreateWatchlistRequest added in v1.44.230

func (c *VoiceID) CreateWatchlistRequest(input *CreateWatchlistInput) (req *request.Request, output *CreateWatchlistOutput)

CreateWatchlistRequest generates a "aws/request.Request" representing the client's request for the CreateWatchlist operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWatchlist for more information on using the CreateWatchlist API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateWatchlistRequest method.
req, resp := client.CreateWatchlistRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateWatchlist

func (*VoiceID) CreateWatchlistWithContext added in v1.44.230

func (c *VoiceID) CreateWatchlistWithContext(ctx aws.Context, input *CreateWatchlistInput, opts ...request.Option) (*CreateWatchlistOutput, error)

CreateWatchlistWithContext is the same as CreateWatchlist with the addition of the ability to pass a context and additional request options.

See CreateWatchlist for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DeleteDomain

func (c *VoiceID) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error)

DeleteDomain API operation for Amazon Voice ID.

Deletes the specified domain from Voice ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DeleteDomain for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteDomain

func (*VoiceID) DeleteDomainRequest

func (c *VoiceID) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput)

DeleteDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDomain for more information on using the DeleteDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDomainRequest method.
req, resp := client.DeleteDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteDomain

func (*VoiceID) DeleteDomainWithContext

func (c *VoiceID) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error)

DeleteDomainWithContext is the same as DeleteDomain with the addition of the ability to pass a context and additional request options.

See DeleteDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DeleteFraudster

func (c *VoiceID) DeleteFraudster(input *DeleteFraudsterInput) (*DeleteFraudsterOutput, error)

DeleteFraudster API operation for Amazon Voice ID.

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DeleteFraudster for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteFraudster

func (*VoiceID) DeleteFraudsterRequest

func (c *VoiceID) DeleteFraudsterRequest(input *DeleteFraudsterInput) (req *request.Request, output *DeleteFraudsterOutput)

DeleteFraudsterRequest generates a "aws/request.Request" representing the client's request for the DeleteFraudster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFraudster for more information on using the DeleteFraudster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFraudsterRequest method.
req, resp := client.DeleteFraudsterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteFraudster

func (*VoiceID) DeleteFraudsterWithContext

func (c *VoiceID) DeleteFraudsterWithContext(ctx aws.Context, input *DeleteFraudsterInput, opts ...request.Option) (*DeleteFraudsterOutput, error)

DeleteFraudsterWithContext is the same as DeleteFraudster with the addition of the ability to pass a context and additional request options.

See DeleteFraudster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DeleteSpeaker

func (c *VoiceID) DeleteSpeaker(input *DeleteSpeakerInput) (*DeleteSpeakerOutput, error)

DeleteSpeaker API operation for Amazon Voice ID.

Deletes the specified speaker from Voice ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DeleteSpeaker for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteSpeaker

func (*VoiceID) DeleteSpeakerRequest

func (c *VoiceID) DeleteSpeakerRequest(input *DeleteSpeakerInput) (req *request.Request, output *DeleteSpeakerOutput)

DeleteSpeakerRequest generates a "aws/request.Request" representing the client's request for the DeleteSpeaker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSpeaker for more information on using the DeleteSpeaker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSpeakerRequest method.
req, resp := client.DeleteSpeakerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteSpeaker

func (*VoiceID) DeleteSpeakerWithContext

func (c *VoiceID) DeleteSpeakerWithContext(ctx aws.Context, input *DeleteSpeakerInput, opts ...request.Option) (*DeleteSpeakerOutput, error)

DeleteSpeakerWithContext is the same as DeleteSpeaker with the addition of the ability to pass a context and additional request options.

See DeleteSpeaker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DeleteWatchlist added in v1.44.230

func (c *VoiceID) DeleteWatchlist(input *DeleteWatchlistInput) (*DeleteWatchlistOutput, error)

DeleteWatchlist API operation for Amazon Voice ID.

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DeleteWatchlist for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteWatchlist

func (*VoiceID) DeleteWatchlistRequest added in v1.44.230

func (c *VoiceID) DeleteWatchlistRequest(input *DeleteWatchlistInput) (req *request.Request, output *DeleteWatchlistOutput)

DeleteWatchlistRequest generates a "aws/request.Request" representing the client's request for the DeleteWatchlist operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWatchlist for more information on using the DeleteWatchlist API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteWatchlistRequest method.
req, resp := client.DeleteWatchlistRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteWatchlist

func (*VoiceID) DeleteWatchlistWithContext added in v1.44.230

func (c *VoiceID) DeleteWatchlistWithContext(ctx aws.Context, input *DeleteWatchlistInput, opts ...request.Option) (*DeleteWatchlistOutput, error)

DeleteWatchlistWithContext is the same as DeleteWatchlist with the addition of the ability to pass a context and additional request options.

See DeleteWatchlist for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DescribeDomain

func (c *VoiceID) DescribeDomain(input *DescribeDomainInput) (*DescribeDomainOutput, error)

DescribeDomain API operation for Amazon Voice ID.

Describes the specified domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DescribeDomain for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeDomain

func (*VoiceID) DescribeDomainRequest

func (c *VoiceID) DescribeDomainRequest(input *DescribeDomainInput) (req *request.Request, output *DescribeDomainOutput)

DescribeDomainRequest generates a "aws/request.Request" representing the client's request for the DescribeDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDomain for more information on using the DescribeDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDomainRequest method.
req, resp := client.DescribeDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeDomain

func (*VoiceID) DescribeDomainWithContext

func (c *VoiceID) DescribeDomainWithContext(ctx aws.Context, input *DescribeDomainInput, opts ...request.Option) (*DescribeDomainOutput, error)

DescribeDomainWithContext is the same as DescribeDomain with the addition of the ability to pass a context and additional request options.

See DescribeDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DescribeFraudster

func (c *VoiceID) DescribeFraudster(input *DescribeFraudsterInput) (*DescribeFraudsterOutput, error)

DescribeFraudster API operation for Amazon Voice ID.

Describes the specified fraudster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DescribeFraudster for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudster

func (*VoiceID) DescribeFraudsterRegistrationJob

func (c *VoiceID) DescribeFraudsterRegistrationJob(input *DescribeFraudsterRegistrationJobInput) (*DescribeFraudsterRegistrationJobOutput, error)

DescribeFraudsterRegistrationJob API operation for Amazon Voice ID.

Describes the specified fraudster registration job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DescribeFraudsterRegistrationJob for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudsterRegistrationJob

func (*VoiceID) DescribeFraudsterRegistrationJobRequest

func (c *VoiceID) DescribeFraudsterRegistrationJobRequest(input *DescribeFraudsterRegistrationJobInput) (req *request.Request, output *DescribeFraudsterRegistrationJobOutput)

DescribeFraudsterRegistrationJobRequest generates a "aws/request.Request" representing the client's request for the DescribeFraudsterRegistrationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFraudsterRegistrationJob for more information on using the DescribeFraudsterRegistrationJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFraudsterRegistrationJobRequest method.
req, resp := client.DescribeFraudsterRegistrationJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudsterRegistrationJob

func (*VoiceID) DescribeFraudsterRegistrationJobWithContext

func (c *VoiceID) DescribeFraudsterRegistrationJobWithContext(ctx aws.Context, input *DescribeFraudsterRegistrationJobInput, opts ...request.Option) (*DescribeFraudsterRegistrationJobOutput, error)

DescribeFraudsterRegistrationJobWithContext is the same as DescribeFraudsterRegistrationJob with the addition of the ability to pass a context and additional request options.

See DescribeFraudsterRegistrationJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DescribeFraudsterRequest

func (c *VoiceID) DescribeFraudsterRequest(input *DescribeFraudsterInput) (req *request.Request, output *DescribeFraudsterOutput)

DescribeFraudsterRequest generates a "aws/request.Request" representing the client's request for the DescribeFraudster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFraudster for more information on using the DescribeFraudster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFraudsterRequest method.
req, resp := client.DescribeFraudsterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudster

func (*VoiceID) DescribeFraudsterWithContext

func (c *VoiceID) DescribeFraudsterWithContext(ctx aws.Context, input *DescribeFraudsterInput, opts ...request.Option) (*DescribeFraudsterOutput, error)

DescribeFraudsterWithContext is the same as DescribeFraudster with the addition of the ability to pass a context and additional request options.

See DescribeFraudster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DescribeSpeaker

func (c *VoiceID) DescribeSpeaker(input *DescribeSpeakerInput) (*DescribeSpeakerOutput, error)

DescribeSpeaker API operation for Amazon Voice ID.

Describes the specified speaker.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DescribeSpeaker for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeaker

func (*VoiceID) DescribeSpeakerEnrollmentJob

func (c *VoiceID) DescribeSpeakerEnrollmentJob(input *DescribeSpeakerEnrollmentJobInput) (*DescribeSpeakerEnrollmentJobOutput, error)

DescribeSpeakerEnrollmentJob API operation for Amazon Voice ID.

Describes the specified speaker enrollment job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DescribeSpeakerEnrollmentJob for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob

func (*VoiceID) DescribeSpeakerEnrollmentJobRequest

func (c *VoiceID) DescribeSpeakerEnrollmentJobRequest(input *DescribeSpeakerEnrollmentJobInput) (req *request.Request, output *DescribeSpeakerEnrollmentJobOutput)

DescribeSpeakerEnrollmentJobRequest generates a "aws/request.Request" representing the client's request for the DescribeSpeakerEnrollmentJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSpeakerEnrollmentJob for more information on using the DescribeSpeakerEnrollmentJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSpeakerEnrollmentJobRequest method.
req, resp := client.DescribeSpeakerEnrollmentJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob

func (*VoiceID) DescribeSpeakerEnrollmentJobWithContext

func (c *VoiceID) DescribeSpeakerEnrollmentJobWithContext(ctx aws.Context, input *DescribeSpeakerEnrollmentJobInput, opts ...request.Option) (*DescribeSpeakerEnrollmentJobOutput, error)

DescribeSpeakerEnrollmentJobWithContext is the same as DescribeSpeakerEnrollmentJob with the addition of the ability to pass a context and additional request options.

See DescribeSpeakerEnrollmentJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DescribeSpeakerRequest

func (c *VoiceID) DescribeSpeakerRequest(input *DescribeSpeakerInput) (req *request.Request, output *DescribeSpeakerOutput)

DescribeSpeakerRequest generates a "aws/request.Request" representing the client's request for the DescribeSpeaker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSpeaker for more information on using the DescribeSpeaker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSpeakerRequest method.
req, resp := client.DescribeSpeakerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeaker

func (*VoiceID) DescribeSpeakerWithContext

func (c *VoiceID) DescribeSpeakerWithContext(ctx aws.Context, input *DescribeSpeakerInput, opts ...request.Option) (*DescribeSpeakerOutput, error)

DescribeSpeakerWithContext is the same as DescribeSpeaker with the addition of the ability to pass a context and additional request options.

See DescribeSpeaker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DescribeWatchlist added in v1.44.230

func (c *VoiceID) DescribeWatchlist(input *DescribeWatchlistInput) (*DescribeWatchlistOutput, error)

DescribeWatchlist API operation for Amazon Voice ID.

Describes the specified watchlist.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DescribeWatchlist for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlist

func (*VoiceID) DescribeWatchlistRequest added in v1.44.230

func (c *VoiceID) DescribeWatchlistRequest(input *DescribeWatchlistInput) (req *request.Request, output *DescribeWatchlistOutput)

DescribeWatchlistRequest generates a "aws/request.Request" representing the client's request for the DescribeWatchlist operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWatchlist for more information on using the DescribeWatchlist API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeWatchlistRequest method.
req, resp := client.DescribeWatchlistRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlist

func (*VoiceID) DescribeWatchlistWithContext added in v1.44.230

func (c *VoiceID) DescribeWatchlistWithContext(ctx aws.Context, input *DescribeWatchlistInput, opts ...request.Option) (*DescribeWatchlistOutput, error)

DescribeWatchlistWithContext is the same as DescribeWatchlist with the addition of the ability to pass a context and additional request options.

See DescribeWatchlist for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) DisassociateFraudster added in v1.44.230

func (c *VoiceID) DisassociateFraudster(input *DisassociateFraudsterInput) (*DisassociateFraudsterOutput, error)

DisassociateFraudster API operation for Amazon Voice ID.

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation DisassociateFraudster for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DisassociateFraudster

func (*VoiceID) DisassociateFraudsterRequest added in v1.44.230

func (c *VoiceID) DisassociateFraudsterRequest(input *DisassociateFraudsterInput) (req *request.Request, output *DisassociateFraudsterOutput)

DisassociateFraudsterRequest generates a "aws/request.Request" representing the client's request for the DisassociateFraudster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateFraudster for more information on using the DisassociateFraudster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateFraudsterRequest method.
req, resp := client.DisassociateFraudsterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DisassociateFraudster

func (*VoiceID) DisassociateFraudsterWithContext added in v1.44.230

func (c *VoiceID) DisassociateFraudsterWithContext(ctx aws.Context, input *DisassociateFraudsterInput, opts ...request.Option) (*DisassociateFraudsterOutput, error)

DisassociateFraudsterWithContext is the same as DisassociateFraudster with the addition of the ability to pass a context and additional request options.

See DisassociateFraudster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) EvaluateSession

func (c *VoiceID) EvaluateSession(input *EvaluateSessionInput) (*EvaluateSessionOutput, error)

EvaluateSession API operation for Amazon Voice ID.

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation EvaluateSession for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/EvaluateSession

func (*VoiceID) EvaluateSessionRequest

func (c *VoiceID) EvaluateSessionRequest(input *EvaluateSessionInput) (req *request.Request, output *EvaluateSessionOutput)

EvaluateSessionRequest generates a "aws/request.Request" representing the client's request for the EvaluateSession operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EvaluateSession for more information on using the EvaluateSession API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EvaluateSessionRequest method.
req, resp := client.EvaluateSessionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/EvaluateSession

func (*VoiceID) EvaluateSessionWithContext

func (c *VoiceID) EvaluateSessionWithContext(ctx aws.Context, input *EvaluateSessionInput, opts ...request.Option) (*EvaluateSessionOutput, error)

EvaluateSessionWithContext is the same as EvaluateSession with the addition of the ability to pass a context and additional request options.

See EvaluateSession for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListDomains

func (c *VoiceID) ListDomains(input *ListDomainsInput) (*ListDomainsOutput, error)

ListDomains API operation for Amazon Voice ID.

Lists all the domains in the Amazon Web Services account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation ListDomains for usage and error information.

Returned Error Types:

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListDomains

func (*VoiceID) ListDomainsPages

func (c *VoiceID) ListDomainsPages(input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool) error

ListDomainsPages iterates over the pages of a ListDomains operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDomains method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDomains operation.
pageNum := 0
err := client.ListDomainsPages(params,
    func(page *voiceid.ListDomainsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*VoiceID) ListDomainsPagesWithContext

func (c *VoiceID) ListDomainsPagesWithContext(ctx aws.Context, input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool, opts ...request.Option) error

ListDomainsPagesWithContext same as ListDomainsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListDomainsRequest

func (c *VoiceID) ListDomainsRequest(input *ListDomainsInput) (req *request.Request, output *ListDomainsOutput)

ListDomainsRequest generates a "aws/request.Request" representing the client's request for the ListDomains operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDomains for more information on using the ListDomains API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDomainsRequest method.
req, resp := client.ListDomainsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListDomains

func (*VoiceID) ListDomainsWithContext

func (c *VoiceID) ListDomainsWithContext(ctx aws.Context, input *ListDomainsInput, opts ...request.Option) (*ListDomainsOutput, error)

ListDomainsWithContext is the same as ListDomains with the addition of the ability to pass a context and additional request options.

See ListDomains for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListFraudsterRegistrationJobs

func (c *VoiceID) ListFraudsterRegistrationJobs(input *ListFraudsterRegistrationJobsInput) (*ListFraudsterRegistrationJobsOutput, error)

ListFraudsterRegistrationJobs API operation for Amazon Voice ID.

Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation ListFraudsterRegistrationJobs for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsterRegistrationJobs

func (*VoiceID) ListFraudsterRegistrationJobsPages

func (c *VoiceID) ListFraudsterRegistrationJobsPages(input *ListFraudsterRegistrationJobsInput, fn func(*ListFraudsterRegistrationJobsOutput, bool) bool) error

ListFraudsterRegistrationJobsPages iterates over the pages of a ListFraudsterRegistrationJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFraudsterRegistrationJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFraudsterRegistrationJobs operation.
pageNum := 0
err := client.ListFraudsterRegistrationJobsPages(params,
    func(page *voiceid.ListFraudsterRegistrationJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*VoiceID) ListFraudsterRegistrationJobsPagesWithContext

func (c *VoiceID) ListFraudsterRegistrationJobsPagesWithContext(ctx aws.Context, input *ListFraudsterRegistrationJobsInput, fn func(*ListFraudsterRegistrationJobsOutput, bool) bool, opts ...request.Option) error

ListFraudsterRegistrationJobsPagesWithContext same as ListFraudsterRegistrationJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListFraudsterRegistrationJobsRequest

func (c *VoiceID) ListFraudsterRegistrationJobsRequest(input *ListFraudsterRegistrationJobsInput) (req *request.Request, output *ListFraudsterRegistrationJobsOutput)

ListFraudsterRegistrationJobsRequest generates a "aws/request.Request" representing the client's request for the ListFraudsterRegistrationJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFraudsterRegistrationJobs for more information on using the ListFraudsterRegistrationJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFraudsterRegistrationJobsRequest method.
req, resp := client.ListFraudsterRegistrationJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsterRegistrationJobs

func (*VoiceID) ListFraudsterRegistrationJobsWithContext

func (c *VoiceID) ListFraudsterRegistrationJobsWithContext(ctx aws.Context, input *ListFraudsterRegistrationJobsInput, opts ...request.Option) (*ListFraudsterRegistrationJobsOutput, error)

ListFraudsterRegistrationJobsWithContext is the same as ListFraudsterRegistrationJobs with the addition of the ability to pass a context and additional request options.

See ListFraudsterRegistrationJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListFraudsters added in v1.44.230

func (c *VoiceID) ListFraudsters(input *ListFraudstersInput) (*ListFraudstersOutput, error)

ListFraudsters API operation for Amazon Voice ID.

Lists all fraudsters in a specified watchlist or domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation ListFraudsters for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsters

func (*VoiceID) ListFraudstersPages added in v1.44.230

func (c *VoiceID) ListFraudstersPages(input *ListFraudstersInput, fn func(*ListFraudstersOutput, bool) bool) error

ListFraudstersPages iterates over the pages of a ListFraudsters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFraudsters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFraudsters operation.
pageNum := 0
err := client.ListFraudstersPages(params,
    func(page *voiceid.ListFraudstersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*VoiceID) ListFraudstersPagesWithContext added in v1.44.230

func (c *VoiceID) ListFraudstersPagesWithContext(ctx aws.Context, input *ListFraudstersInput, fn func(*ListFraudstersOutput, bool) bool, opts ...request.Option) error

ListFraudstersPagesWithContext same as ListFraudstersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListFraudstersRequest added in v1.44.230

func (c *VoiceID) ListFraudstersRequest(input *ListFraudstersInput) (req *request.Request, output *ListFraudstersOutput)

ListFraudstersRequest generates a "aws/request.Request" representing the client's request for the ListFraudsters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFraudsters for more information on using the ListFraudsters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFraudstersRequest method.
req, resp := client.ListFraudstersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsters

func (*VoiceID) ListFraudstersWithContext added in v1.44.230

func (c *VoiceID) ListFraudstersWithContext(ctx aws.Context, input *ListFraudstersInput, opts ...request.Option) (*ListFraudstersOutput, error)

ListFraudstersWithContext is the same as ListFraudsters with the addition of the ability to pass a context and additional request options.

See ListFraudsters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListSpeakerEnrollmentJobs

func (c *VoiceID) ListSpeakerEnrollmentJobs(input *ListSpeakerEnrollmentJobsInput) (*ListSpeakerEnrollmentJobsOutput, error)

ListSpeakerEnrollmentJobs API operation for Amazon Voice ID.

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation ListSpeakerEnrollmentJobs for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs

func (*VoiceID) ListSpeakerEnrollmentJobsPages

func (c *VoiceID) ListSpeakerEnrollmentJobsPages(input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool) error

ListSpeakerEnrollmentJobsPages iterates over the pages of a ListSpeakerEnrollmentJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSpeakerEnrollmentJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSpeakerEnrollmentJobs operation.
pageNum := 0
err := client.ListSpeakerEnrollmentJobsPages(params,
    func(page *voiceid.ListSpeakerEnrollmentJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*VoiceID) ListSpeakerEnrollmentJobsPagesWithContext

func (c *VoiceID) ListSpeakerEnrollmentJobsPagesWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool, opts ...request.Option) error

ListSpeakerEnrollmentJobsPagesWithContext same as ListSpeakerEnrollmentJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListSpeakerEnrollmentJobsRequest

func (c *VoiceID) ListSpeakerEnrollmentJobsRequest(input *ListSpeakerEnrollmentJobsInput) (req *request.Request, output *ListSpeakerEnrollmentJobsOutput)

ListSpeakerEnrollmentJobsRequest generates a "aws/request.Request" representing the client's request for the ListSpeakerEnrollmentJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSpeakerEnrollmentJobs for more information on using the ListSpeakerEnrollmentJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSpeakerEnrollmentJobsRequest method.
req, resp := client.ListSpeakerEnrollmentJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs

func (*VoiceID) ListSpeakerEnrollmentJobsWithContext

func (c *VoiceID) ListSpeakerEnrollmentJobsWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, opts ...request.Option) (*ListSpeakerEnrollmentJobsOutput, error)

ListSpeakerEnrollmentJobsWithContext is the same as ListSpeakerEnrollmentJobs with the addition of the ability to pass a context and additional request options.

See ListSpeakerEnrollmentJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListSpeakers

func (c *VoiceID) ListSpeakers(input *ListSpeakersInput) (*ListSpeakersOutput, error)

ListSpeakers API operation for Amazon Voice ID.

Lists all speakers in a specified domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation ListSpeakers for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers

func (*VoiceID) ListSpeakersPages

func (c *VoiceID) ListSpeakersPages(input *ListSpeakersInput, fn func(*ListSpeakersOutput, bool) bool) error

ListSpeakersPages iterates over the pages of a ListSpeakers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSpeakers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSpeakers operation.
pageNum := 0
err := client.ListSpeakersPages(params,
    func(page *voiceid.ListSpeakersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*VoiceID) ListSpeakersPagesWithContext

func (c *VoiceID) ListSpeakersPagesWithContext(ctx aws.Context, input *ListSpeakersInput, fn func(*ListSpeakersOutput, bool) bool, opts ...request.Option) error

ListSpeakersPagesWithContext same as ListSpeakersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListSpeakersRequest

func (c *VoiceID) ListSpeakersRequest(input *ListSpeakersInput) (req *request.Request, output *ListSpeakersOutput)

ListSpeakersRequest generates a "aws/request.Request" representing the client's request for the ListSpeakers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSpeakers for more information on using the ListSpeakers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSpeakersRequest method.
req, resp := client.ListSpeakersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers

func (*VoiceID) ListSpeakersWithContext

func (c *VoiceID) ListSpeakersWithContext(ctx aws.Context, input *ListSpeakersInput, opts ...request.Option) (*ListSpeakersOutput, error)

ListSpeakersWithContext is the same as ListSpeakers with the addition of the ability to pass a context and additional request options.

See ListSpeakers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListTagsForResource

func (c *VoiceID) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Voice ID.

Lists all tags associated with a specified Voice ID resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListTagsForResource

func (*VoiceID) ListTagsForResourceRequest

func (c *VoiceID) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListTagsForResource

func (*VoiceID) ListTagsForResourceWithContext

func (c *VoiceID) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListWatchlists added in v1.44.230

func (c *VoiceID) ListWatchlists(input *ListWatchlistsInput) (*ListWatchlistsOutput, error)

ListWatchlists API operation for Amazon Voice ID.

Lists all watchlists in a specified domain.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation ListWatchlists for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListWatchlists

func (*VoiceID) ListWatchlistsPages added in v1.44.230

func (c *VoiceID) ListWatchlistsPages(input *ListWatchlistsInput, fn func(*ListWatchlistsOutput, bool) bool) error

ListWatchlistsPages iterates over the pages of a ListWatchlists operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWatchlists method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWatchlists operation.
pageNum := 0
err := client.ListWatchlistsPages(params,
    func(page *voiceid.ListWatchlistsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*VoiceID) ListWatchlistsPagesWithContext added in v1.44.230

func (c *VoiceID) ListWatchlistsPagesWithContext(ctx aws.Context, input *ListWatchlistsInput, fn func(*ListWatchlistsOutput, bool) bool, opts ...request.Option) error

ListWatchlistsPagesWithContext same as ListWatchlistsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) ListWatchlistsRequest added in v1.44.230

func (c *VoiceID) ListWatchlistsRequest(input *ListWatchlistsInput) (req *request.Request, output *ListWatchlistsOutput)

ListWatchlistsRequest generates a "aws/request.Request" representing the client's request for the ListWatchlists operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWatchlists for more information on using the ListWatchlists API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWatchlistsRequest method.
req, resp := client.ListWatchlistsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListWatchlists

func (*VoiceID) ListWatchlistsWithContext added in v1.44.230

func (c *VoiceID) ListWatchlistsWithContext(ctx aws.Context, input *ListWatchlistsInput, opts ...request.Option) (*ListWatchlistsOutput, error)

ListWatchlistsWithContext is the same as ListWatchlists with the addition of the ability to pass a context and additional request options.

See ListWatchlists for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) OptOutSpeaker

func (c *VoiceID) OptOutSpeaker(input *OptOutSpeakerInput) (*OptOutSpeakerOutput, error)

OptOutSpeaker API operation for Amazon Voice ID.

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. 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 Voice ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation OptOutSpeaker for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/OptOutSpeaker

func (*VoiceID) OptOutSpeakerRequest

func (c *VoiceID) OptOutSpeakerRequest(input *OptOutSpeakerInput) (req *request.Request, output *OptOutSpeakerOutput)

OptOutSpeakerRequest generates a "aws/request.Request" representing the client's request for the OptOutSpeaker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See OptOutSpeaker for more information on using the OptOutSpeaker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the OptOutSpeakerRequest method.
req, resp := client.OptOutSpeakerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/OptOutSpeaker

func (*VoiceID) OptOutSpeakerWithContext

func (c *VoiceID) OptOutSpeakerWithContext(ctx aws.Context, input *OptOutSpeakerInput, opts ...request.Option) (*OptOutSpeakerOutput, error)

OptOutSpeakerWithContext is the same as OptOutSpeaker with the addition of the ability to pass a context and additional request options.

See OptOutSpeaker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) StartFraudsterRegistrationJob

func (c *VoiceID) StartFraudsterRegistrationJob(input *StartFraudsterRegistrationJobInput) (*StartFraudsterRegistrationJobOutput, error)

StartFraudsterRegistrationJob API operation for Amazon Voice ID.

Starts a new batch fraudster registration job using provided details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation StartFraudsterRegistrationJob for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartFraudsterRegistrationJob

func (*VoiceID) StartFraudsterRegistrationJobRequest

func (c *VoiceID) StartFraudsterRegistrationJobRequest(input *StartFraudsterRegistrationJobInput) (req *request.Request, output *StartFraudsterRegistrationJobOutput)

StartFraudsterRegistrationJobRequest generates a "aws/request.Request" representing the client's request for the StartFraudsterRegistrationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartFraudsterRegistrationJob for more information on using the StartFraudsterRegistrationJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartFraudsterRegistrationJobRequest method.
req, resp := client.StartFraudsterRegistrationJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartFraudsterRegistrationJob

func (*VoiceID) StartFraudsterRegistrationJobWithContext

func (c *VoiceID) StartFraudsterRegistrationJobWithContext(ctx aws.Context, input *StartFraudsterRegistrationJobInput, opts ...request.Option) (*StartFraudsterRegistrationJobOutput, error)

StartFraudsterRegistrationJobWithContext is the same as StartFraudsterRegistrationJob with the addition of the ability to pass a context and additional request options.

See StartFraudsterRegistrationJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) StartSpeakerEnrollmentJob

func (c *VoiceID) StartSpeakerEnrollmentJob(input *StartSpeakerEnrollmentJobInput) (*StartSpeakerEnrollmentJobOutput, error)

StartSpeakerEnrollmentJob API operation for Amazon Voice ID.

Starts a new batch speaker enrollment job using specified details.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation StartSpeakerEnrollmentJob for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartSpeakerEnrollmentJob

func (*VoiceID) StartSpeakerEnrollmentJobRequest

func (c *VoiceID) StartSpeakerEnrollmentJobRequest(input *StartSpeakerEnrollmentJobInput) (req *request.Request, output *StartSpeakerEnrollmentJobOutput)

StartSpeakerEnrollmentJobRequest generates a "aws/request.Request" representing the client's request for the StartSpeakerEnrollmentJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSpeakerEnrollmentJob for more information on using the StartSpeakerEnrollmentJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartSpeakerEnrollmentJobRequest method.
req, resp := client.StartSpeakerEnrollmentJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartSpeakerEnrollmentJob

func (*VoiceID) StartSpeakerEnrollmentJobWithContext

func (c *VoiceID) StartSpeakerEnrollmentJobWithContext(ctx aws.Context, input *StartSpeakerEnrollmentJobInput, opts ...request.Option) (*StartSpeakerEnrollmentJobOutput, error)

StartSpeakerEnrollmentJobWithContext is the same as StartSpeakerEnrollmentJob with the addition of the ability to pass a context and additional request options.

See StartSpeakerEnrollmentJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) TagResource

func (c *VoiceID) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Voice ID.

Tags a Voice ID resource with the provided list of tags.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/TagResource

func (*VoiceID) TagResourceRequest

func (c *VoiceID) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/TagResource

func (*VoiceID) TagResourceWithContext

func (c *VoiceID) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) UntagResource

func (c *VoiceID) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Voice ID.

Removes specified tags from a specified Amazon Connect Voice ID resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UntagResource

func (*VoiceID) UntagResourceRequest

func (c *VoiceID) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UntagResource

func (*VoiceID) UntagResourceWithContext

func (c *VoiceID) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) UpdateDomain

func (c *VoiceID) UpdateDomain(input *UpdateDomainInput) (*UpdateDomainOutput, error)

UpdateDomain API operation for Amazon Voice ID.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation UpdateDomain for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain

func (*VoiceID) UpdateDomainRequest

func (c *VoiceID) UpdateDomainRequest(input *UpdateDomainInput) (req *request.Request, output *UpdateDomainOutput)

UpdateDomainRequest generates a "aws/request.Request" representing the client's request for the UpdateDomain operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDomain for more information on using the UpdateDomain API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateDomainRequest method.
req, resp := client.UpdateDomainRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain

func (*VoiceID) UpdateDomainWithContext

func (c *VoiceID) UpdateDomainWithContext(ctx aws.Context, input *UpdateDomainInput, opts ...request.Option) (*UpdateDomainOutput, error)

UpdateDomainWithContext is the same as UpdateDomain with the addition of the ability to pass a context and additional request options.

See UpdateDomain for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*VoiceID) UpdateWatchlist added in v1.44.230

func (c *VoiceID) UpdateWatchlist(input *UpdateWatchlistInput) (*UpdateWatchlistOutput, error)

UpdateWatchlist API operation for Amazon Voice ID.

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Voice ID's API operation UpdateWatchlist for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The specified resource cannot be found. Check the ResourceType and error message for more details.

  • ValidationException The request failed one or more validations; check the error message for more details.

  • ConflictException The request failed due to a conflict. Check the ConflictType and error message for more details.

  • InternalServerException The request failed due to an unknown error on the server side.

  • ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.

  • AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateWatchlist

func (*VoiceID) UpdateWatchlistRequest added in v1.44.230

func (c *VoiceID) UpdateWatchlistRequest(input *UpdateWatchlistInput) (req *request.Request, output *UpdateWatchlistOutput)

UpdateWatchlistRequest generates a "aws/request.Request" representing the client's request for the UpdateWatchlist operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWatchlist for more information on using the UpdateWatchlist API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateWatchlistRequest method.
req, resp := client.UpdateWatchlistRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateWatchlist

func (*VoiceID) UpdateWatchlistWithContext added in v1.44.230

func (c *VoiceID) UpdateWatchlistWithContext(ctx aws.Context, input *UpdateWatchlistInput, opts ...request.Option) (*UpdateWatchlistOutput, error)

UpdateWatchlistWithContext is the same as UpdateWatchlist with the addition of the ability to pass a context and additional request options.

See UpdateWatchlist for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type VoiceSpoofingRisk added in v1.44.87

type VoiceSpoofingRisk struct {

	// The score indicating the likelihood of speaker’s voice being spoofed.
	//
	// RiskScore is a required field
	RiskScore *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

func (VoiceSpoofingRisk) GoString added in v1.44.87

func (s VoiceSpoofingRisk) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VoiceSpoofingRisk) SetRiskScore added in v1.44.87

func (s *VoiceSpoofingRisk) SetRiskScore(v int64) *VoiceSpoofingRisk

SetRiskScore sets the RiskScore field's value.

func (VoiceSpoofingRisk) String added in v1.44.87

func (s VoiceSpoofingRisk) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Watchlist added in v1.44.230

type Watchlist struct {

	// The timestamp of when the watchlist was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Whether the specified watchlist is the default watchlist of a domain.
	DefaultWatchlist *bool `type:"boolean"`

	// The description of the watchlist.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Watchlist's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain that contains the watchlist.
	DomainId *string `min:"22" type:"string"`

	// The name for the watchlist.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Watchlist's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The timestamp of when the watchlist was updated.
	UpdatedAt *time.Time `type:"timestamp"`

	// The identifier of the watchlist.
	WatchlistId *string `min:"22" type:"string"`
	// contains filtered or unexported fields
}

Contains all the information about a watchlist.

func (Watchlist) GoString added in v1.44.230

func (s Watchlist) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Watchlist) SetCreatedAt added in v1.44.230

func (s *Watchlist) SetCreatedAt(v time.Time) *Watchlist

SetCreatedAt sets the CreatedAt field's value.

func (*Watchlist) SetDefaultWatchlist added in v1.44.230

func (s *Watchlist) SetDefaultWatchlist(v bool) *Watchlist

SetDefaultWatchlist sets the DefaultWatchlist field's value.

func (*Watchlist) SetDescription added in v1.44.230

func (s *Watchlist) SetDescription(v string) *Watchlist

SetDescription sets the Description field's value.

func (*Watchlist) SetDomainId added in v1.44.230

func (s *Watchlist) SetDomainId(v string) *Watchlist

SetDomainId sets the DomainId field's value.

func (*Watchlist) SetName added in v1.44.230

func (s *Watchlist) SetName(v string) *Watchlist

SetName sets the Name field's value.

func (*Watchlist) SetUpdatedAt added in v1.44.230

func (s *Watchlist) SetUpdatedAt(v time.Time) *Watchlist

SetUpdatedAt sets the UpdatedAt field's value.

func (*Watchlist) SetWatchlistId added in v1.44.230

func (s *Watchlist) SetWatchlistId(v string) *Watchlist

SetWatchlistId sets the WatchlistId field's value.

func (Watchlist) String added in v1.44.230

func (s Watchlist) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WatchlistDetails added in v1.44.230

type WatchlistDetails struct {

	// The identifier of the default watchlist.
	//
	// DefaultWatchlistId is a required field
	DefaultWatchlistId *string `min:"22" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Details of the watchlists in a domain.

func (WatchlistDetails) GoString added in v1.44.230

func (s WatchlistDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WatchlistDetails) SetDefaultWatchlistId added in v1.44.230

func (s *WatchlistDetails) SetDefaultWatchlistId(v string) *WatchlistDetails

SetDefaultWatchlistId sets the DefaultWatchlistId field's value.

func (WatchlistDetails) String added in v1.44.230

func (s WatchlistDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WatchlistSummary added in v1.44.230

type WatchlistSummary struct {

	// The timestamp of when the watchlist was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Whether the specified watchlist is the default watchlist of a domain.
	DefaultWatchlist *bool `type:"boolean"`

	// The description of the watchlist.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WatchlistSummary's
	// String and GoString methods.
	Description *string `min:"1" type:"string" sensitive:"true"`

	// The identifier of the domain that contains the watchlist.
	DomainId *string `min:"22" type:"string"`

	// The name for the watchlist.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WatchlistSummary's
	// String and GoString methods.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The timestamp of when the watchlist was last updated.
	UpdatedAt *time.Time `type:"timestamp"`

	// The identifier of the watchlist.
	WatchlistId *string `min:"22" type:"string"`
	// contains filtered or unexported fields
}

Contains a summary of information about a watchlist.

func (WatchlistSummary) GoString added in v1.44.230

func (s WatchlistSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WatchlistSummary) SetCreatedAt added in v1.44.230

func (s *WatchlistSummary) SetCreatedAt(v time.Time) *WatchlistSummary

SetCreatedAt sets the CreatedAt field's value.

func (*WatchlistSummary) SetDefaultWatchlist added in v1.44.230

func (s *WatchlistSummary) SetDefaultWatchlist(v bool) *WatchlistSummary

SetDefaultWatchlist sets the DefaultWatchlist field's value.

func (*WatchlistSummary) SetDescription added in v1.44.230

func (s *WatchlistSummary) SetDescription(v string) *WatchlistSummary

SetDescription sets the Description field's value.

func (*WatchlistSummary) SetDomainId added in v1.44.230

func (s *WatchlistSummary) SetDomainId(v string) *WatchlistSummary

SetDomainId sets the DomainId field's value.

func (*WatchlistSummary) SetName added in v1.44.230

func (s *WatchlistSummary) SetName(v string) *WatchlistSummary

SetName sets the Name field's value.

func (*WatchlistSummary) SetUpdatedAt added in v1.44.230

func (s *WatchlistSummary) SetUpdatedAt(v time.Time) *WatchlistSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (*WatchlistSummary) SetWatchlistId added in v1.44.230

func (s *WatchlistSummary) SetWatchlistId(v string) *WatchlistSummary

SetWatchlistId sets the WatchlistId field's value.

func (WatchlistSummary) String added in v1.44.230

func (s WatchlistSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package voiceidiface provides an interface to enable mocking the Amazon Voice ID service client for testing your code.
Package voiceidiface provides an interface to enable mocking the Amazon Voice ID service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL