types

package
v1.20.7 Latest Latest
Warning

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

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *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) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AuthenticationConfiguration 

type AuthenticationConfiguration struct {

	// The minimum threshold needed to successfully authenticate a speaker.
	//
	// This member is required.
	AcceptanceThreshold *int32
	// contains filtered or unexported fields
}

The configuration used to authenticate a speaker during a session.

type AuthenticationDecision 

type AuthenticationDecision string
const (
	AuthenticationDecisionAccept               AuthenticationDecision = "ACCEPT"
	AuthenticationDecisionReject               AuthenticationDecision = "REJECT"
	AuthenticationDecisionNotEnoughSpeech      AuthenticationDecision = "NOT_ENOUGH_SPEECH"
	AuthenticationDecisionSpeakerNotEnrolled   AuthenticationDecision = "SPEAKER_NOT_ENROLLED"
	AuthenticationDecisionSpeakerOptedOut      AuthenticationDecision = "SPEAKER_OPTED_OUT"
	AuthenticationDecisionSpeakerIdNotProvided AuthenticationDecision = "SPEAKER_ID_NOT_PROVIDED"
	AuthenticationDecisionSpeakerExpired       AuthenticationDecision = "SPEAKER_EXPIRED"
)

Enum values for AuthenticationDecision

func (AuthenticationDecision) Values 

func (AuthenticationDecision) Values() []AuthenticationDecision

Values returns all known values for AuthenticationDecision. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuthenticationResult 

type AuthenticationResult struct {

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

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

	// 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

	// The AuthenticationConfiguration used to generate this authentication result.
	Configuration *AuthenticationConfiguration

	// The client-provided identifier for the speaker whose authentication result is
	// produced. Only present if a SpeakerId is provided for the session.
	CustomerSpeakerId *string

	// The authentication decision produced by Voice ID, processed against the current
	// session state and streamed audio of the speaker.
	Decision AuthenticationDecision

	// The service-generated identifier for the speaker whose authentication result is
	// produced.
	GeneratedSpeakerId *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 *int32
	// contains filtered or unexported fields
}

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

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ConflictType ConflictType
	// contains filtered or unexported fields
}

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

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConflictType 

type ConflictType string
const (
	ConflictTypeAnotherActiveStream                      ConflictType = "ANOTHER_ACTIVE_STREAM"
	ConflictTypeDomainNotActive                          ConflictType = "DOMAIN_NOT_ACTIVE"
	ConflictTypeCannotChangeSpeakerAfterEnrollment       ConflictType = "CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT"
	ConflictTypeEnrollmentAlreadyExists                  ConflictType = "ENROLLMENT_ALREADY_EXISTS"
	ConflictTypeSpeakerNotSet                            ConflictType = "SPEAKER_NOT_SET"
	ConflictTypeSpeakerOptedOut                          ConflictType = "SPEAKER_OPTED_OUT"
	ConflictTypeConcurrentChanges                        ConflictType = "CONCURRENT_CHANGES"
	ConflictTypeDomainLockedFromEncryptionUpdates        ConflictType = "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES"
	ConflictTypeCannotDeleteNonEmptyWatchlist            ConflictType = "CANNOT_DELETE_NON_EMPTY_WATCHLIST"
	ConflictTypeFraudsterMustBelongToAtLeastOneWatchlist ConflictType = "FRAUDSTER_MUST_BELONG_TO_AT_LEAST_ONE_WATCHLIST"
)

Enum values for ConflictType

func (ConflictType) Values 

func (ConflictType) Values() []ConflictType

Values returns all known values for ConflictType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Domain 

type Domain struct {

	// The Amazon Resource Name (ARN) for the domain.
	Arn *string

	// The timestamp of when the domain was created.
	CreatedAt *time.Time

	// The description of the domain.
	Description *string

	// The identifier of the domain.
	DomainId *string

	// The current status of the domain.
	DomainStatus DomainStatus

	// The name for the domain.
	Name *string

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

	// 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

	// The timestamp of when the domain was last update.
	UpdatedAt *time.Time

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

Contains all the information about a domain.

type DomainStatus 

type DomainStatus string
const (
	DomainStatusActive    DomainStatus = "ACTIVE"
	DomainStatusPending   DomainStatus = "PENDING"
	DomainStatusSuspended DomainStatus = "SUSPENDED"
)

Enum values for DomainStatus

func (DomainStatus) Values 

func (DomainStatus) Values() []DomainStatus

Values returns all known values for DomainStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DomainSummary 

type DomainSummary struct {

	// The Amazon Resource Name (ARN) for the domain.
	Arn *string

	// The timestamp of when the domain was created.
	CreatedAt *time.Time

	// The description of the domain.
	Description *string

	// The identifier of the domain.
	DomainId *string

	// The current status of the domain.
	DomainStatus DomainStatus

	// The client-provided name for the domain.
	Name *string

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

	// 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

	// The timestamp of when the domain was last updated.
	UpdatedAt *time.Time

	// Provides information about watchlistDetails and DefaultWatchlistID .
	WatchlistDetails *WatchlistDetails
	// contains filtered or unexported fields
}

Contains a summary of information about a domain.

type DuplicateRegistrationAction 

type DuplicateRegistrationAction string
const (
	DuplicateRegistrationActionSkip          DuplicateRegistrationAction = "SKIP"
	DuplicateRegistrationActionRegisterAsNew DuplicateRegistrationAction = "REGISTER_AS_NEW"
)

Enum values for DuplicateRegistrationAction

func (DuplicateRegistrationAction) Values 

func (DuplicateRegistrationAction) Values() []DuplicateRegistrationAction

Values returns all known values for DuplicateRegistrationAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

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 ExistingEnrollmentAction

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

Contains configurations defining enrollment behavior for the batch job.

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 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 *int32

	// The identifier of watchlists against which fraud detection is performed.
	WatchlistIds []string
	// contains filtered or unexported fields
}

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

type ExistingEnrollmentAction 

type ExistingEnrollmentAction string
const (
	ExistingEnrollmentActionSkip      ExistingEnrollmentAction = "SKIP"
	ExistingEnrollmentActionOverwrite ExistingEnrollmentAction = "OVERWRITE"
)

Enum values for ExistingEnrollmentAction

func (ExistingEnrollmentAction) Values 

func (ExistingEnrollmentAction) Values() []ExistingEnrollmentAction

Values returns all known values for ExistingEnrollmentAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FailureDetails 

type FailureDetails struct {

	// A description of the error that caused the batch job failure.
	Message *string

	// An HTTP status code representing the nature of the error.
	StatusCode *int32
	// contains filtered or unexported fields
}

Contains error details for a failed batch job.

type FraudDetectionAction 

type FraudDetectionAction string
const (
	FraudDetectionActionIgnore FraudDetectionAction = "IGNORE"
	FraudDetectionActionFail   FraudDetectionAction = "FAIL"
)

Enum values for FraudDetectionAction

func (FraudDetectionAction) Values 

func (FraudDetectionAction) Values() []FraudDetectionAction

Values returns all known values for FraudDetectionAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

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 *int32

	// The identifier of the watchlist against which fraud detection is performed.
	WatchlistId *string
	// contains filtered or unexported fields
}

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

type FraudDetectionDecision 

type FraudDetectionDecision string
const (
	FraudDetectionDecisionHighRisk        FraudDetectionDecision = "HIGH_RISK"
	FraudDetectionDecisionLowRisk         FraudDetectionDecision = "LOW_RISK"
	FraudDetectionDecisionNotEnoughSpeech FraudDetectionDecision = "NOT_ENOUGH_SPEECH"
)

Enum values for FraudDetectionDecision

func (FraudDetectionDecision) Values 

func (FraudDetectionDecision) Values() []FraudDetectionDecision

Values returns all known values for FraudDetectionDecision. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FraudDetectionReason 

type FraudDetectionReason string
const (
	FraudDetectionReasonKnownFraudster FraudDetectionReason = "KNOWN_FRAUDSTER"
	FraudDetectionReasonVoiceSpoofing  FraudDetectionReason = "VOICE_SPOOFING"
)

Enum values for FraudDetectionReason

func (FraudDetectionReason) Values 

func (FraudDetectionReason) Values() []FraudDetectionReason

Values returns all known values for FraudDetectionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FraudDetectionResult 

type FraudDetectionResult struct {

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

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

	// The FraudDetectionConfiguration used to generate this fraud detection result.
	Configuration *FraudDetectionConfiguration

	// The fraud detection decision produced by Voice ID, processed against the
	// current session state and streamed audio of the speaker.
	Decision 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

	// 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 []FraudDetectionReason

	// Details about each risk analyzed for this speaker. Currently, this contains
	// KnownFraudsterRisk and VoiceSpoofingRisk details.
	RiskDetails *FraudRiskDetails
	// 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.

type FraudRiskDetails 

type FraudRiskDetails struct {

	// The details resulting from 'Known Fraudster Risk' analysis of the speaker.
	//
	// This member is required.
	KnownFraudsterRisk *KnownFraudsterRisk

	// The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
	//
	// This member is required.
	VoiceSpoofingRisk *VoiceSpoofingRisk
	// contains filtered or unexported fields
}

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

type Fraudster 

type Fraudster struct {

	// The timestamp of when Voice ID identified the fraudster.
	CreatedAt *time.Time

	// The identifier of the domain that contains the fraudster.
	DomainId *string

	// The service-generated identifier for the fraudster.
	GeneratedFraudsterId *string

	// The identifier of the watchlists the fraudster is a part of.
	WatchlistIds []string
	// contains filtered or unexported fields
}

Contains all the information about a fraudster.

type FraudsterRegistrationJob 

type FraudsterRegistrationJob struct {

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

	// 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

	// The identifier of the domain that contains the fraudster registration job.
	DomainId *string

	// A timestamp of when the fraudster registration job ended.
	EndedAt *time.Time

	// 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

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

	// The service-generated identifier for the fraudster registration job.
	JobId *string

	// The client-provided name for the fraudster registration job.
	JobName *string

	// Shows the completed percentage of registration requests listed in the input
	// file.
	JobProgress *JobProgress

	// The current status of the fraudster registration job.
	JobStatus 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

	// 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
	// contains filtered or unexported fields
}

Contains all the information about a fraudster registration job.

type FraudsterRegistrationJobStatus 

type FraudsterRegistrationJobStatus string
const (
	FraudsterRegistrationJobStatusSubmitted           FraudsterRegistrationJobStatus = "SUBMITTED"
	FraudsterRegistrationJobStatusInProgress          FraudsterRegistrationJobStatus = "IN_PROGRESS"
	FraudsterRegistrationJobStatusCompleted           FraudsterRegistrationJobStatus = "COMPLETED"
	FraudsterRegistrationJobStatusCompletedWithErrors FraudsterRegistrationJobStatus = "COMPLETED_WITH_ERRORS"
	FraudsterRegistrationJobStatusFailed              FraudsterRegistrationJobStatus = "FAILED"
)

Enum values for FraudsterRegistrationJobStatus

func (FraudsterRegistrationJobStatus) Values 

func (FraudsterRegistrationJobStatus) Values() []FraudsterRegistrationJobStatus

Values returns all known values for FraudsterRegistrationJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FraudsterRegistrationJobSummary 

type FraudsterRegistrationJobSummary struct {

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

	// The identifier of the domain that contains the fraudster registration job.
	DomainId *string

	// A timestamp of when the fraudster registration job ended.
	EndedAt *time.Time

	// 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

	// The service-generated identifier for the fraudster registration job.
	JobId *string

	// The client-provided name for the fraudster registration job.
	JobName *string

	// Shows the completed percentage of registration requests listed in the input
	// file.
	JobProgress *JobProgress

	// The current status of the fraudster registration job.
	JobStatus FraudsterRegistrationJobStatus
	// contains filtered or unexported fields
}

Contains a summary of information about a fraudster registration job.

type FraudsterSummary added in v1.13.0 

type FraudsterSummary struct {

	// The timestamp of when the fraudster summary was created.
	CreatedAt *time.Time

	// The identifier of the domain that contains the fraudster summary.
	DomainId *string

	// The service-generated identifier for the fraudster.
	GeneratedFraudsterId *string

	// The identifier of the watchlists the fraudster is a part of.
	WatchlistIds []string
	// contains filtered or unexported fields
}

Contains a summary of information about a fraudster.

type InputDataConfig 

type InputDataConfig struct {

	// The S3 location for the input manifest file that contains the list of
	// individual enrollment or registration job requests.
	//
	// This member is required.
	S3Uri *string
	// contains filtered or unexported fields
}

The configuration containing input file information for a batch job.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type JobProgress 

type JobProgress struct {

	// Shows the completed percentage of enrollment or registration requests listed in
	// the input file.
	PercentComplete *int32
	// contains filtered or unexported fields
}

Indicates the completion progress for a batch job.

type KnownFraudsterRisk 

type KnownFraudsterRisk struct {

	// The score indicating the likelihood the speaker is a known fraudster.
	//
	// This member is required.
	RiskScore *int32

	// 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
	// contains filtered or unexported fields
}

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

type OutputDataConfig 

type OutputDataConfig struct {

	// 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 .
	//
	// This member is required.
	S3Uri *string

	// 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
	// contains filtered or unexported fields
}

The configuration containing output file information for a batch job.

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 DuplicateRegistrationAction

	// The minimum similarity score between the new and old fraudsters in order to
	// consider the new fraudster a duplicate.
	FraudsterSimilarityThreshold *int32

	// 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
	// contains filtered or unexported fields
}

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

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType ResourceType
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType 

type ResourceType string
const (
	ResourceTypeBatchJob          ResourceType = "BATCH_JOB"
	ResourceTypeComplianceConsent ResourceType = "COMPLIANCE_CONSENT"
	ResourceTypeDomain            ResourceType = "DOMAIN"
	ResourceTypeFraudster         ResourceType = "FRAUDSTER"
	ResourceTypeSession           ResourceType = "SESSION"
	ResourceTypeSpeaker           ResourceType = "SPEAKER"
	ResourceTypeWatchlist         ResourceType = "WATCHLIST"
)

Enum values for ResourceType

func (ResourceType) Values 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

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.
	//
	// This member is required.
	KmsKeyId *string
	// contains filtered or unexported fields
}

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

type ServerSideEncryptionUpdateDetails added in v1.10.0 

type ServerSideEncryptionUpdateDetails struct {

	// Message explaining the current UpdateStatus. When the UpdateStatus is FAILED,
	// this message explains the cause of the failure.
	Message *string

	// The previous KMS key ID the domain was encrypted with, before
	// ServerSideEncryptionConfiguration was updated to a new KMS key ID.
	OldKmsKeyId *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 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.

type ServerSideEncryptionUpdateStatus added in v1.10.0 

type ServerSideEncryptionUpdateStatus string
const (
	ServerSideEncryptionUpdateStatusInProgress ServerSideEncryptionUpdateStatus = "IN_PROGRESS"
	ServerSideEncryptionUpdateStatusCompleted  ServerSideEncryptionUpdateStatus = "COMPLETED"
	ServerSideEncryptionUpdateStatusFailed     ServerSideEncryptionUpdateStatus = "FAILED"
)

Enum values for ServerSideEncryptionUpdateStatus

func (ServerSideEncryptionUpdateStatus) Values added in v1.10.0 

func (ServerSideEncryptionUpdateStatus) Values() []ServerSideEncryptionUpdateStatus

Values returns all known values for ServerSideEncryptionUpdateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Speaker 

type Speaker struct {

	// A timestamp of when the speaker was created.
	CreatedAt *time.Time

	// The client-provided identifier for the speaker.
	CustomerSpeakerId *string

	// The identifier of the domain that contains the speaker.
	DomainId *string

	// The service-generated identifier for the speaker.
	GeneratedSpeakerId *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

	// The current status of the speaker.
	Status SpeakerStatus

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

Contains all the information about a speaker.

type SpeakerEnrollmentJob 

type SpeakerEnrollmentJob struct {

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

	// 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

	// The identifier of the domain that contains the speaker enrollment job.
	DomainId *string

	// A timestamp of when the speaker enrollment job ended.
	EndedAt *time.Time

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

	// 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

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

	// The service-generated identifier for the speaker enrollment job.
	JobId *string

	// The client-provided name for the speaker enrollment job.
	JobName *string

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

	// The current status of the speaker enrollment job.
	JobStatus 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
	// contains filtered or unexported fields
}

Contains all the information about a speaker enrollment job.

type SpeakerEnrollmentJobStatus 

type SpeakerEnrollmentJobStatus string
const (
	SpeakerEnrollmentJobStatusSubmitted           SpeakerEnrollmentJobStatus = "SUBMITTED"
	SpeakerEnrollmentJobStatusInProgress          SpeakerEnrollmentJobStatus = "IN_PROGRESS"
	SpeakerEnrollmentJobStatusCompleted           SpeakerEnrollmentJobStatus = "COMPLETED"
	SpeakerEnrollmentJobStatusCompletedWithErrors SpeakerEnrollmentJobStatus = "COMPLETED_WITH_ERRORS"
	SpeakerEnrollmentJobStatusFailed              SpeakerEnrollmentJobStatus = "FAILED"
)

Enum values for SpeakerEnrollmentJobStatus

func (SpeakerEnrollmentJobStatus) Values 

func (SpeakerEnrollmentJobStatus) Values() []SpeakerEnrollmentJobStatus

Values returns all known values for SpeakerEnrollmentJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SpeakerEnrollmentJobSummary 

type SpeakerEnrollmentJobSummary struct {

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

	// The identifier of the domain that contains the speaker enrollment job.
	DomainId *string

	// A timestamp of when the speaker enrollment job ended.
	EndedAt *time.Time

	// 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

	// The service-generated identifier for the speaker enrollment job.
	JobId *string

	// The client-provided name for the speaker enrollment job.
	JobName *string

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

	// The current status of the speaker enrollment job.
	JobStatus SpeakerEnrollmentJobStatus
	// contains filtered or unexported fields
}

Contains a summary of information about a speaker enrollment job.

type SpeakerStatus 

type SpeakerStatus string
const (
	SpeakerStatusEnrolled SpeakerStatus = "ENROLLED"
	SpeakerStatusExpired  SpeakerStatus = "EXPIRED"
	SpeakerStatusOptedOut SpeakerStatus = "OPTED_OUT"
	SpeakerStatusPending  SpeakerStatus = "PENDING"
)

Enum values for SpeakerStatus

func (SpeakerStatus) Values 

func (SpeakerStatus) Values() []SpeakerStatus

Values returns all known values for SpeakerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SpeakerSummary 

type SpeakerSummary struct {

	// A timestamp showing the speaker's creation time.
	CreatedAt *time.Time

	// The client-provided identifier for the speaker.
	CustomerSpeakerId *string

	// The identifier of the domain that contains the speaker.
	DomainId *string

	// The service-generated identifier for the speaker.
	GeneratedSpeakerId *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

	// The current status of the speaker.
	Status SpeakerStatus

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

Contains a summary of information about a speaker.

type StreamingStatus 

type StreamingStatus string
const (
	StreamingStatusPendingConfiguration StreamingStatus = "PENDING_CONFIGURATION"
	StreamingStatusOngoing              StreamingStatus = "ONGOING"
	StreamingStatusEnded                StreamingStatus = "ENDED"
)

Enum values for StreamingStatus

func (StreamingStatus) Values 

func (StreamingStatus) Values() []StreamingStatus

Values returns all known values for StreamingStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

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'.
	//
	// This member is required.
	Key *string

	// 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'.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

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

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *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 quotasand try your request again.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VoiceSpoofingRisk added in v1.11.0 

type VoiceSpoofingRisk struct {

	// The score indicating the likelihood of speaker’s voice being spoofed.
	//
	// This member is required.
	RiskScore *int32
	// contains filtered or unexported fields
}

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

type Watchlist added in v1.13.0 

type Watchlist struct {

	// The timestamp of when the watchlist was created.
	CreatedAt *time.Time

	// Whether the specified watchlist is the default watchlist of a domain.
	DefaultWatchlist bool

	// The description of the watchlist.
	Description *string

	// The identifier of the domain that contains the watchlist.
	DomainId *string

	// The name for the watchlist.
	Name *string

	// The timestamp of when the watchlist was updated.
	UpdatedAt *time.Time

	// The identifier of the watchlist.
	WatchlistId *string
	// contains filtered or unexported fields
}

Contains all the information about a watchlist.

type WatchlistDetails added in v1.13.0 

type WatchlistDetails struct {

	// The identifier of the default watchlist.
	//
	// This member is required.
	DefaultWatchlistId *string
	// contains filtered or unexported fields
}

Details of the watchlists in a domain.

type WatchlistSummary added in v1.13.0 

type WatchlistSummary struct {

	// The timestamp of when the watchlist was created.
	CreatedAt *time.Time

	// Whether the specified watchlist is the default watchlist of a domain.
	DefaultWatchlist bool

	// The description of the watchlist.
	Description *string

	// The identifier of the domain that contains the watchlist.
	DomainId *string

	// The name for the watchlist.
	Name *string

	// The timestamp of when the watchlist was last updated.
	UpdatedAt *time.Time

	// The identifier of the watchlist.
	WatchlistId *string
	// contains filtered or unexported fields
}

Contains a summary of information about a watchlist.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.