transcribeservice

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: 23

Documentation

Overview

Package transcribeservice provides the client and types for making API requests to Amazon Transcribe Service.

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.

  • Standard transcriptions are the most common option. Refer to for details.

  • Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details.

  • Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.

See https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26 for more information on this service.

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

Using the Client

To contact Amazon Transcribe Service 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 Transcribe Service client TranscribeService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/transcribeservice/#New

Index

Constants

View Source 
const (
	// BaseModelNameNarrowBand is a BaseModelName enum value
	BaseModelNameNarrowBand = "NarrowBand"

	// BaseModelNameWideBand is a BaseModelName enum value
	BaseModelNameWideBand = "WideBand"
)
View Source 
const (
	// CLMLanguageCodeEnUs is a CLMLanguageCode enum value
	CLMLanguageCodeEnUs = "en-US"

	// CLMLanguageCodeHiIn is a CLMLanguageCode enum value
	CLMLanguageCodeHiIn = "hi-IN"

	// CLMLanguageCodeEsUs is a CLMLanguageCode enum value
	CLMLanguageCodeEsUs = "es-US"

	// CLMLanguageCodeEnGb is a CLMLanguageCode enum value
	CLMLanguageCodeEnGb = "en-GB"

	// CLMLanguageCodeEnAu is a CLMLanguageCode enum value
	CLMLanguageCodeEnAu = "en-AU"

	// CLMLanguageCodeDeDe is a CLMLanguageCode enum value
	CLMLanguageCodeDeDe = "de-DE"

	// CLMLanguageCodeJaJp is a CLMLanguageCode enum value
	CLMLanguageCodeJaJp = "ja-JP"
)
View Source 
const (
	// CallAnalyticsJobStatusQueued is a CallAnalyticsJobStatus enum value
	CallAnalyticsJobStatusQueued = "QUEUED"

	// CallAnalyticsJobStatusInProgress is a CallAnalyticsJobStatus enum value
	CallAnalyticsJobStatusInProgress = "IN_PROGRESS"

	// CallAnalyticsJobStatusFailed is a CallAnalyticsJobStatus enum value
	CallAnalyticsJobStatusFailed = "FAILED"

	// CallAnalyticsJobStatusCompleted is a CallAnalyticsJobStatus enum value
	CallAnalyticsJobStatusCompleted = "COMPLETED"
)
View Source 
const (
	// CallAnalyticsSkippedReasonCodeInsufficientConversationContent is a CallAnalyticsSkippedReasonCode enum value
	CallAnalyticsSkippedReasonCodeInsufficientConversationContent = "INSUFFICIENT_CONVERSATION_CONTENT"

	// CallAnalyticsSkippedReasonCodeFailedSafetyGuidelines is a CallAnalyticsSkippedReasonCode enum value
	CallAnalyticsSkippedReasonCodeFailedSafetyGuidelines = "FAILED_SAFETY_GUIDELINES"
)
View Source 
const (
	// InputTypeRealTime is a InputType enum value
	InputTypeRealTime = "REAL_TIME"

	// InputTypePostCall is a InputType enum value
	InputTypePostCall = "POST_CALL"
)
View Source 
const (
	// LanguageCodeAfZa is a LanguageCode enum value
	LanguageCodeAfZa = "af-ZA"

	// LanguageCodeArAe is a LanguageCode enum value
	LanguageCodeArAe = "ar-AE"

	// LanguageCodeArSa is a LanguageCode enum value
	LanguageCodeArSa = "ar-SA"

	// LanguageCodeDaDk is a LanguageCode enum value
	LanguageCodeDaDk = "da-DK"

	// LanguageCodeDeCh is a LanguageCode enum value
	LanguageCodeDeCh = "de-CH"

	// LanguageCodeDeDe is a LanguageCode enum value
	LanguageCodeDeDe = "de-DE"

	// LanguageCodeEnAb is a LanguageCode enum value
	LanguageCodeEnAb = "en-AB"

	// LanguageCodeEnAu is a LanguageCode enum value
	LanguageCodeEnAu = "en-AU"

	// LanguageCodeEnGb is a LanguageCode enum value
	LanguageCodeEnGb = "en-GB"

	// LanguageCodeEnIe is a LanguageCode enum value
	LanguageCodeEnIe = "en-IE"

	// LanguageCodeEnIn is a LanguageCode enum value
	LanguageCodeEnIn = "en-IN"

	// LanguageCodeEnUs is a LanguageCode enum value
	LanguageCodeEnUs = "en-US"

	// LanguageCodeEnWl is a LanguageCode enum value
	LanguageCodeEnWl = "en-WL"

	// LanguageCodeEsEs is a LanguageCode enum value
	LanguageCodeEsEs = "es-ES"

	// LanguageCodeEsUs is a LanguageCode enum value
	LanguageCodeEsUs = "es-US"

	// LanguageCodeFaIr is a LanguageCode enum value
	LanguageCodeFaIr = "fa-IR"

	// LanguageCodeFrCa is a LanguageCode enum value
	LanguageCodeFrCa = "fr-CA"

	// LanguageCodeFrFr is a LanguageCode enum value
	LanguageCodeFrFr = "fr-FR"

	// LanguageCodeHeIl is a LanguageCode enum value
	LanguageCodeHeIl = "he-IL"

	// LanguageCodeHiIn is a LanguageCode enum value
	LanguageCodeHiIn = "hi-IN"

	// LanguageCodeIdId is a LanguageCode enum value
	LanguageCodeIdId = "id-ID"

	// LanguageCodeItIt is a LanguageCode enum value
	LanguageCodeItIt = "it-IT"

	// LanguageCodeJaJp is a LanguageCode enum value
	LanguageCodeJaJp = "ja-JP"

	// LanguageCodeKoKr is a LanguageCode enum value
	LanguageCodeKoKr = "ko-KR"

	// LanguageCodeMsMy is a LanguageCode enum value
	LanguageCodeMsMy = "ms-MY"

	// LanguageCodeNlNl is a LanguageCode enum value
	LanguageCodeNlNl = "nl-NL"

	// LanguageCodePtBr is a LanguageCode enum value
	LanguageCodePtBr = "pt-BR"

	// LanguageCodePtPt is a LanguageCode enum value
	LanguageCodePtPt = "pt-PT"

	// LanguageCodeRuRu is a LanguageCode enum value
	LanguageCodeRuRu = "ru-RU"

	// LanguageCodeTaIn is a LanguageCode enum value
	LanguageCodeTaIn = "ta-IN"

	// LanguageCodeTeIn is a LanguageCode enum value
	LanguageCodeTeIn = "te-IN"

	// LanguageCodeTrTr is a LanguageCode enum value
	LanguageCodeTrTr = "tr-TR"

	// LanguageCodeZhCn is a LanguageCode enum value
	LanguageCodeZhCn = "zh-CN"

	// LanguageCodeZhTw is a LanguageCode enum value
	LanguageCodeZhTw = "zh-TW"

	// LanguageCodeThTh is a LanguageCode enum value
	LanguageCodeThTh = "th-TH"

	// LanguageCodeEnZa is a LanguageCode enum value
	LanguageCodeEnZa = "en-ZA"

	// LanguageCodeEnNz is a LanguageCode enum value
	LanguageCodeEnNz = "en-NZ"

	// LanguageCodeViVn is a LanguageCode enum value
	LanguageCodeViVn = "vi-VN"

	// LanguageCodeSvSe is a LanguageCode enum value
	LanguageCodeSvSe = "sv-SE"

	// LanguageCodeAbGe is a LanguageCode enum value
	LanguageCodeAbGe = "ab-GE"

	// LanguageCodeAstEs is a LanguageCode enum value
	LanguageCodeAstEs = "ast-ES"

	// LanguageCodeAzAz is a LanguageCode enum value
	LanguageCodeAzAz = "az-AZ"

	// LanguageCodeBaRu is a LanguageCode enum value
	LanguageCodeBaRu = "ba-RU"

	// LanguageCodeBeBy is a LanguageCode enum value
	LanguageCodeBeBy = "be-BY"

	// LanguageCodeBgBg is a LanguageCode enum value
	LanguageCodeBgBg = "bg-BG"

	// LanguageCodeBnIn is a LanguageCode enum value
	LanguageCodeBnIn = "bn-IN"

	// LanguageCodeBsBa is a LanguageCode enum value
	LanguageCodeBsBa = "bs-BA"

	// LanguageCodeCaEs is a LanguageCode enum value
	LanguageCodeCaEs = "ca-ES"

	// LanguageCodeCkbIq is a LanguageCode enum value
	LanguageCodeCkbIq = "ckb-IQ"

	// LanguageCodeCkbIr is a LanguageCode enum value
	LanguageCodeCkbIr = "ckb-IR"

	// LanguageCodeCsCz is a LanguageCode enum value
	LanguageCodeCsCz = "cs-CZ"

	// LanguageCodeCyWl is a LanguageCode enum value
	LanguageCodeCyWl = "cy-WL"

	// LanguageCodeElGr is a LanguageCode enum value
	LanguageCodeElGr = "el-GR"

	// LanguageCodeEtEt is a LanguageCode enum value
	LanguageCodeEtEt = "et-ET"

	// LanguageCodeEuEs is a LanguageCode enum value
	LanguageCodeEuEs = "eu-ES"

	// LanguageCodeFiFi is a LanguageCode enum value
	LanguageCodeFiFi = "fi-FI"

	// LanguageCodeGlEs is a LanguageCode enum value
	LanguageCodeGlEs = "gl-ES"

	// LanguageCodeGuIn is a LanguageCode enum value
	LanguageCodeGuIn = "gu-IN"

	// LanguageCodeHaNg is a LanguageCode enum value
	LanguageCodeHaNg = "ha-NG"

	// LanguageCodeHrHr is a LanguageCode enum value
	LanguageCodeHrHr = "hr-HR"

	// LanguageCodeHuHu is a LanguageCode enum value
	LanguageCodeHuHu = "hu-HU"

	// LanguageCodeHyAm is a LanguageCode enum value
	LanguageCodeHyAm = "hy-AM"

	// LanguageCodeIsIs is a LanguageCode enum value
	LanguageCodeIsIs = "is-IS"

	// LanguageCodeKaGe is a LanguageCode enum value
	LanguageCodeKaGe = "ka-GE"

	// LanguageCodeKabDz is a LanguageCode enum value
	LanguageCodeKabDz = "kab-DZ"

	// LanguageCodeKkKz is a LanguageCode enum value
	LanguageCodeKkKz = "kk-KZ"

	// LanguageCodeKnIn is a LanguageCode enum value
	LanguageCodeKnIn = "kn-IN"

	// LanguageCodeKyKg is a LanguageCode enum value
	LanguageCodeKyKg = "ky-KG"

	// LanguageCodeLgIn is a LanguageCode enum value
	LanguageCodeLgIn = "lg-IN"

	// LanguageCodeLtLt is a LanguageCode enum value
	LanguageCodeLtLt = "lt-LT"

	// LanguageCodeLvLv is a LanguageCode enum value
	LanguageCodeLvLv = "lv-LV"

	// LanguageCodeMhrRu is a LanguageCode enum value
	LanguageCodeMhrRu = "mhr-RU"

	// LanguageCodeMiNz is a LanguageCode enum value
	LanguageCodeMiNz = "mi-NZ"

	// LanguageCodeMkMk is a LanguageCode enum value
	LanguageCodeMkMk = "mk-MK"

	// LanguageCodeMlIn is a LanguageCode enum value
	LanguageCodeMlIn = "ml-IN"

	// LanguageCodeMnMn is a LanguageCode enum value
	LanguageCodeMnMn = "mn-MN"

	// LanguageCodeMrIn is a LanguageCode enum value
	LanguageCodeMrIn = "mr-IN"

	// LanguageCodeMtMt is a LanguageCode enum value
	LanguageCodeMtMt = "mt-MT"

	// LanguageCodeNoNo is a LanguageCode enum value
	LanguageCodeNoNo = "no-NO"

	// LanguageCodeOrIn is a LanguageCode enum value
	LanguageCodeOrIn = "or-IN"

	// LanguageCodePaIn is a LanguageCode enum value
	LanguageCodePaIn = "pa-IN"

	// LanguageCodePlPl is a LanguageCode enum value
	LanguageCodePlPl = "pl-PL"

	// LanguageCodePsAf is a LanguageCode enum value
	LanguageCodePsAf = "ps-AF"

	// LanguageCodeRoRo is a LanguageCode enum value
	LanguageCodeRoRo = "ro-RO"

	// LanguageCodeRwRw is a LanguageCode enum value
	LanguageCodeRwRw = "rw-RW"

	// LanguageCodeSiLk is a LanguageCode enum value
	LanguageCodeSiLk = "si-LK"

	// LanguageCodeSkSk is a LanguageCode enum value
	LanguageCodeSkSk = "sk-SK"

	// LanguageCodeSlSi is a LanguageCode enum value
	LanguageCodeSlSi = "sl-SI"

	// LanguageCodeSoSo is a LanguageCode enum value
	LanguageCodeSoSo = "so-SO"

	// LanguageCodeSrRs is a LanguageCode enum value
	LanguageCodeSrRs = "sr-RS"

	// LanguageCodeSuId is a LanguageCode enum value
	LanguageCodeSuId = "su-ID"

	// LanguageCodeSwBi is a LanguageCode enum value
	LanguageCodeSwBi = "sw-BI"

	// LanguageCodeSwKe is a LanguageCode enum value
	LanguageCodeSwKe = "sw-KE"

	// LanguageCodeSwRw is a LanguageCode enum value
	LanguageCodeSwRw = "sw-RW"

	// LanguageCodeSwTz is a LanguageCode enum value
	LanguageCodeSwTz = "sw-TZ"

	// LanguageCodeSwUg is a LanguageCode enum value
	LanguageCodeSwUg = "sw-UG"

	// LanguageCodeTlPh is a LanguageCode enum value
	LanguageCodeTlPh = "tl-PH"

	// LanguageCodeTtRu is a LanguageCode enum value
	LanguageCodeTtRu = "tt-RU"

	// LanguageCodeUgCn is a LanguageCode enum value
	LanguageCodeUgCn = "ug-CN"

	// LanguageCodeUkUa is a LanguageCode enum value
	LanguageCodeUkUa = "uk-UA"

	// LanguageCodeUzUz is a LanguageCode enum value
	LanguageCodeUzUz = "uz-UZ"

	// LanguageCodeWoSn is a LanguageCode enum value
	LanguageCodeWoSn = "wo-SN"

	// LanguageCodeZuZa is a LanguageCode enum value
	LanguageCodeZuZa = "zu-ZA"
)
View Source 
const (
	// MediaFormatMp3 is a MediaFormat enum value
	MediaFormatMp3 = "mp3"

	// MediaFormatMp4 is a MediaFormat enum value
	MediaFormatMp4 = "mp4"

	// MediaFormatWav is a MediaFormat enum value
	MediaFormatWav = "wav"

	// MediaFormatFlac is a MediaFormat enum value
	MediaFormatFlac = "flac"

	// MediaFormatOgg is a MediaFormat enum value
	MediaFormatOgg = "ogg"

	// MediaFormatAmr is a MediaFormat enum value
	MediaFormatAmr = "amr"

	// MediaFormatWebm is a MediaFormat enum value
	MediaFormatWebm = "webm"

	// MediaFormatM4a is a MediaFormat enum value
	MediaFormatM4a = "m4a"
)
View Source 
const (
	// MedicalScribeJobStatusQueued is a MedicalScribeJobStatus enum value
	MedicalScribeJobStatusQueued = "QUEUED"

	// MedicalScribeJobStatusInProgress is a MedicalScribeJobStatus enum value
	MedicalScribeJobStatusInProgress = "IN_PROGRESS"

	// MedicalScribeJobStatusFailed is a MedicalScribeJobStatus enum value
	MedicalScribeJobStatusFailed = "FAILED"

	// MedicalScribeJobStatusCompleted is a MedicalScribeJobStatus enum value
	MedicalScribeJobStatusCompleted = "COMPLETED"
)
View Source 
const (
	// MedicalScribeParticipantRolePatient is a MedicalScribeParticipantRole enum value
	MedicalScribeParticipantRolePatient = "PATIENT"

	// MedicalScribeParticipantRoleClinician is a MedicalScribeParticipantRole enum value
	MedicalScribeParticipantRoleClinician = "CLINICIAN"
)
View Source 
const (
	// ModelStatusInProgress is a ModelStatus enum value
	ModelStatusInProgress = "IN_PROGRESS"

	// ModelStatusFailed is a ModelStatus enum value
	ModelStatusFailed = "FAILED"

	// ModelStatusCompleted is a ModelStatus enum value
	ModelStatusCompleted = "COMPLETED"
)
View Source 
const (
	// OutputLocationTypeCustomerBucket is a OutputLocationType enum value
	OutputLocationTypeCustomerBucket = "CUSTOMER_BUCKET"

	// OutputLocationTypeServiceBucket is a OutputLocationType enum value
	OutputLocationTypeServiceBucket = "SERVICE_BUCKET"
)
View Source 
const (
	// ParticipantRoleAgent is a ParticipantRole enum value
	ParticipantRoleAgent = "AGENT"

	// ParticipantRoleCustomer is a ParticipantRole enum value
	ParticipantRoleCustomer = "CUSTOMER"
)
View Source 
const (
	// PiiEntityTypeBankAccountNumber is a PiiEntityType enum value
	PiiEntityTypeBankAccountNumber = "BANK_ACCOUNT_NUMBER"

	// PiiEntityTypeBankRouting is a PiiEntityType enum value
	PiiEntityTypeBankRouting = "BANK_ROUTING"

	// PiiEntityTypeCreditDebitNumber is a PiiEntityType enum value
	PiiEntityTypeCreditDebitNumber = "CREDIT_DEBIT_NUMBER"

	// PiiEntityTypeCreditDebitCvv is a PiiEntityType enum value
	PiiEntityTypeCreditDebitCvv = "CREDIT_DEBIT_CVV"

	// PiiEntityTypeCreditDebitExpiry is a PiiEntityType enum value
	PiiEntityTypeCreditDebitExpiry = "CREDIT_DEBIT_EXPIRY"

	// PiiEntityTypePin is a PiiEntityType enum value
	PiiEntityTypePin = "PIN"

	// PiiEntityTypeEmail is a PiiEntityType enum value
	PiiEntityTypeEmail = "EMAIL"

	// PiiEntityTypeAddress is a PiiEntityType enum value
	PiiEntityTypeAddress = "ADDRESS"

	// PiiEntityTypeName is a PiiEntityType enum value
	PiiEntityTypeName = "NAME"

	// PiiEntityTypePhone is a PiiEntityType enum value
	PiiEntityTypePhone = "PHONE"

	// PiiEntityTypeSsn is a PiiEntityType enum value
	PiiEntityTypeSsn = "SSN"

	// PiiEntityTypeAll is a PiiEntityType enum value
	PiiEntityTypeAll = "ALL"
)
View Source 
const (
	// RedactionOutputRedacted is a RedactionOutput enum value
	RedactionOutputRedacted = "redacted"

	// RedactionOutputRedactedAndUnredacted is a RedactionOutput enum value
	RedactionOutputRedactedAndUnredacted = "redacted_and_unredacted"
)
View Source 
const (
	// SentimentValuePositive is a SentimentValue enum value
	SentimentValuePositive = "POSITIVE"

	// SentimentValueNegative is a SentimentValue enum value
	SentimentValueNegative = "NEGATIVE"

	// SentimentValueNeutral is a SentimentValue enum value
	SentimentValueNeutral = "NEUTRAL"

	// SentimentValueMixed is a SentimentValue enum value
	SentimentValueMixed = "MIXED"
)
View Source 
const (
	// SubtitleFormatVtt is a SubtitleFormat enum value
	SubtitleFormatVtt = "vtt"

	// SubtitleFormatSrt is a SubtitleFormat enum value
	SubtitleFormatSrt = "srt"
)
View Source 
const (
	// TranscriptionJobStatusQueued is a TranscriptionJobStatus enum value
	TranscriptionJobStatusQueued = "QUEUED"

	// TranscriptionJobStatusInProgress is a TranscriptionJobStatus enum value
	TranscriptionJobStatusInProgress = "IN_PROGRESS"

	// TranscriptionJobStatusFailed is a TranscriptionJobStatus enum value
	TranscriptionJobStatusFailed = "FAILED"

	// TranscriptionJobStatusCompleted is a TranscriptionJobStatus enum value
	TranscriptionJobStatusCompleted = "COMPLETED"
)
View Source 
const (
	// TypeConversation is a Type enum value
	TypeConversation = "CONVERSATION"

	// TypeDictation is a Type enum value
	TypeDictation = "DICTATION"
)
View Source 
const (
	// VocabularyFilterMethodRemove is a VocabularyFilterMethod enum value
	VocabularyFilterMethodRemove = "remove"

	// VocabularyFilterMethodMask is a VocabularyFilterMethod enum value
	VocabularyFilterMethodMask = "mask"

	// VocabularyFilterMethodTag is a VocabularyFilterMethod enum value
	VocabularyFilterMethodTag = "tag"
)
View Source 
const (
	// VocabularyStatePending is a VocabularyState enum value
	VocabularyStatePending = "PENDING"

	// VocabularyStateReady is a VocabularyState enum value
	VocabularyStateReady = "READY"

	// VocabularyStateFailed is a VocabularyState enum value
	VocabularyStateFailed = "FAILED"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Your request didn't pass one or more validation tests. This can occur when
	// the entity you're trying to delete doesn't exist or if it's in a non-terminal
	// state (such as IN PROGRESS). See the exception message field for more information.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A resource already exists with this name. Resource names must be unique within
	// an Amazon Web Services account.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// There was an internal error. Check the error message, correct the issue,
	// and try your request again.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You've either sent too many requests or your input file is too long. Wait
	// before retrying your request, or use a smaller file and try your request
	// again.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// We can't find the requested resource. Check that the specified name is correct
	// and try your request again.
	ErrCodeNotFoundException = "NotFoundException"
)
View Source 
const (
	ServiceName = "transcribe" // Name of service.
	EndpointsID = ServiceName  // ID to lookup a service endpoint with.
	ServiceID   = "Transcribe" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// CallAnalyticsFeatureGenerativeSummarization is a CallAnalyticsFeature enum value
	CallAnalyticsFeatureGenerativeSummarization = "GENERATIVE_SUMMARIZATION"
)
View Source 
const (
	// MedicalContentIdentificationTypePhi is a MedicalContentIdentificationType enum value
	MedicalContentIdentificationTypePhi = "PHI"
)
View Source 
const (
	// MedicalScribeLanguageCodeEnUs is a MedicalScribeLanguageCode enum value
	MedicalScribeLanguageCodeEnUs = "en-US"
)
View Source 
const (
	// RedactionTypePii is a RedactionType enum value
	RedactionTypePii = "PII"
)
View Source 
const (
	// SpecialtyPrimarycare is a Specialty enum value
	SpecialtyPrimarycare = "PRIMARYCARE"
)
View Source 
const (
	// ToxicityCategoryAll is a ToxicityCategory enum value
	ToxicityCategoryAll = "ALL"
)
View Source 
const (
	// TranscriptFilterTypeExact is a TranscriptFilterType enum value
	TranscriptFilterTypeExact = "EXACT"
)

Variables

This section is empty.

Functions

func BaseModelName_Values added in v1.34.3 

func BaseModelName_Values() []string

BaseModelName_Values returns all elements of the BaseModelName enum

func CLMLanguageCode_Values added in v1.34.3 

func CLMLanguageCode_Values() []string

CLMLanguageCode_Values returns all elements of the CLMLanguageCode enum

func CallAnalyticsFeature_Values added in v1.51.31 

func CallAnalyticsFeature_Values() []string

CallAnalyticsFeature_Values returns all elements of the CallAnalyticsFeature enum

func CallAnalyticsJobStatus_Values added in v1.40.15 

func CallAnalyticsJobStatus_Values() []string

CallAnalyticsJobStatus_Values returns all elements of the CallAnalyticsJobStatus enum

func CallAnalyticsSkippedReasonCode_Values added in v1.51.31 

func CallAnalyticsSkippedReasonCode_Values() []string

CallAnalyticsSkippedReasonCode_Values returns all elements of the CallAnalyticsSkippedReasonCode enum

func InputType_Values added in v1.44.146 

func InputType_Values() []string

InputType_Values returns all elements of the InputType enum

func LanguageCode_Values added in v1.34.3 

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func MediaFormat_Values added in v1.34.3 

func MediaFormat_Values() []string

MediaFormat_Values returns all elements of the MediaFormat enum

func MedicalContentIdentificationType_Values added in v1.38.40 

func MedicalContentIdentificationType_Values() []string

MedicalContentIdentificationType_Values returns all elements of the MedicalContentIdentificationType enum

func MedicalScribeJobStatus_Values added in v1.48.5 

func MedicalScribeJobStatus_Values() []string

MedicalScribeJobStatus_Values returns all elements of the MedicalScribeJobStatus enum

func MedicalScribeLanguageCode_Values added in v1.48.5 

func MedicalScribeLanguageCode_Values() []string

MedicalScribeLanguageCode_Values returns all elements of the MedicalScribeLanguageCode enum

func MedicalScribeParticipantRole_Values added in v1.48.5 

func MedicalScribeParticipantRole_Values() []string

MedicalScribeParticipantRole_Values returns all elements of the MedicalScribeParticipantRole enum

func ModelStatus_Values added in v1.34.3 

func ModelStatus_Values() []string

ModelStatus_Values returns all elements of the ModelStatus enum

func OutputLocationType_Values added in v1.34.3 

func OutputLocationType_Values() []string

OutputLocationType_Values returns all elements of the OutputLocationType enum

func ParticipantRole_Values added in v1.40.15 

func ParticipantRole_Values() []string

ParticipantRole_Values returns all elements of the ParticipantRole enum

func PiiEntityType_Values added in v1.42.39 

func PiiEntityType_Values() []string

PiiEntityType_Values returns all elements of the PiiEntityType enum

func RedactionOutput_Values added in v1.34.3 

func RedactionOutput_Values() []string

RedactionOutput_Values returns all elements of the RedactionOutput enum

func RedactionType_Values added in v1.34.3 

func RedactionType_Values() []string

RedactionType_Values returns all elements of the RedactionType enum

func SentimentValue_Values added in v1.40.15 

func SentimentValue_Values() []string

SentimentValue_Values returns all elements of the SentimentValue enum

func Specialty_Values added in v1.34.3 

func Specialty_Values() []string

Specialty_Values returns all elements of the Specialty enum

func SubtitleFormat_Values added in v1.40.44 

func SubtitleFormat_Values() []string

SubtitleFormat_Values returns all elements of the SubtitleFormat enum

func ToxicityCategory_Values added in v1.44.305 

func ToxicityCategory_Values() []string

ToxicityCategory_Values returns all elements of the ToxicityCategory enum

func TranscriptFilterType_Values added in v1.40.15 

func TranscriptFilterType_Values() []string

TranscriptFilterType_Values returns all elements of the TranscriptFilterType enum

func TranscriptionJobStatus_Values added in v1.34.3 

func TranscriptionJobStatus_Values() []string

TranscriptionJobStatus_Values returns all elements of the TranscriptionJobStatus enum

func Type_Values added in v1.34.3 

func Type_Values() []string

Type_Values returns all elements of the Type enum

func VocabularyFilterMethod_Values added in v1.34.3 

func VocabularyFilterMethod_Values() []string

VocabularyFilterMethod_Values returns all elements of the VocabularyFilterMethod enum

func VocabularyState_Values added in v1.34.3 

func VocabularyState_Values() []string

VocabularyState_Values returns all elements of the VocabularyState enum

Types

type AbsoluteTimeRange added in v1.40.15 

type AbsoluteTimeRange struct {

	// The time, in milliseconds, when Amazon Transcribe stops searching for the
	// specified criteria in your audio. If you include EndTime in your request,
	// you must also include StartTime.
	EndTime *int64 `type:"long"`

	// The time, in milliseconds, from the start of your media file until the specified
	// value. Amazon Transcribe searches for your specified criteria in this time
	// segment.
	First *int64 `type:"long"`

	// The time, in milliseconds, from the specified value until the end of your
	// media file. Amazon Transcribe searches for your specified criteria in this
	// time segment.
	Last *int64 `type:"long"`

	// The time, in milliseconds, when Amazon Transcribe starts searching for the
	// specified criteria in your audio. If you include StartTime in your request,
	// you must also include EndTime.
	StartTime *int64 `type:"long"`
	// contains filtered or unexported fields
}

A time range, in milliseconds, between two points in your media file.

You can use StartTime and EndTime to search a custom segment. For example, setting StartTime to 10000 and EndTime to 50000 only searches for your specified criteria in the audio contained between the 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use StartTime and EndTime as a set; that is, if you include one, you must include both.

You can use also First to search from the start of the audio until the time that you specify, or Last to search from the time that you specify until the end of the audio. For example, setting First to 50000 only searches for your specified criteria in the audio contained between the start of the media file to the 50,000 millisecond mark. You can use First and Last independently of each other.

If you prefer to use percentage instead of milliseconds, see .

func (AbsoluteTimeRange) GoString added in v1.40.15 

func (s AbsoluteTimeRange) 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 (*AbsoluteTimeRange) SetEndTime added in v1.40.15 

func (s *AbsoluteTimeRange) SetEndTime(v int64) *AbsoluteTimeRange

SetEndTime sets the EndTime field's value.

func (*AbsoluteTimeRange) SetFirst added in v1.40.15 

func (s *AbsoluteTimeRange) SetFirst(v int64) *AbsoluteTimeRange

SetFirst sets the First field's value.

func (*AbsoluteTimeRange) SetLast added in v1.40.15 

func (s *AbsoluteTimeRange) SetLast(v int64) *AbsoluteTimeRange

SetLast sets the Last field's value.

func (*AbsoluteTimeRange) SetStartTime added in v1.40.15 

func (s *AbsoluteTimeRange) SetStartTime(v int64) *AbsoluteTimeRange

SetStartTime sets the StartTime field's value.

func (AbsoluteTimeRange) String added in v1.40.15 

func (s AbsoluteTimeRange) 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 BadRequestException added in v1.28.0 

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

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

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) 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 (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) 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 CallAnalyticsJob added in v1.40.15 

type CallAnalyticsJob struct {

	// Provides detailed information about a call analytics job, including information
	// about skipped analytics features.
	CallAnalyticsJobDetails *CallAnalyticsJobDetails `type:"structure"`

	// The name of the Call Analytics job. Job names are case sensitive and must
	// be unique within an Amazon Web Services account.
	CallAnalyticsJobName *string `min:"1" type:"string"`

	// Provides the status of the specified Call Analytics job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri,
	// if you requested transcript redaction). If the status is FAILED, FailureReason
	// provides details on why your transcription job failed.
	CallAnalyticsJobStatus *string `type:"string" enum:"CallAnalyticsJobStatus"`

	// Indicates which speaker is on which channel.
	ChannelDefinitions []*ChannelDefinition `min:"2" type:"list"`

	// The date and time the specified Call Analytics job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// The date and time the specified Call Analytics job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) you included in your request.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// If CallAnalyticsJobStatus is FAILED, FailureReason contains information about
	// why the Call Analytics job request failed.
	//
	// The FailureReason field contains one of the following values:
	//
	//    * Unsupported media format. The media format specified in MediaFormat
	//    isn't valid. Refer to refer to the MediaFormat parameter for a list of
	//    supported formats.
	//
	//    * The media format provided does not match the detected media format.
	//    The media format specified in MediaFormat doesn't match the format of
	//    the input file. Check the media format of your media file and correct
	//    the specified value.
	//
	//    * Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz
	//    isn't valid. The sample rate must be between 8,000 and 48,000 hertz.
	//
	//    * The sample rate provided does not match the detected sample rate. The
	//    sample rate specified in MediaSampleRateHertz doesn't match the sample
	//    rate detected in your input media file. Check the sample rate of your
	//    media file and correct the specified value.
	//
	//    * Invalid file size: file size too large. The size of your media file
	//    is larger than what Amazon Transcribe can process. For more information,
	//    refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe).
	//
	//    * Invalid number of channels: number of channels too large. Your audio
	//    contains more channels than Amazon Transcribe is able to process. For
	//    more information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe).
	FailureReason *string `type:"string"`

	// The confidence score associated with the language identified in your media
	// file.
	//
	// Confidence scores are values between 0 and 1; a larger value indicates a
	// higher probability that the identified language correctly matches the language
	// spoken in your media.
	IdentifiedLanguageScore *float64 `type:"float"`

	// The language code used to create your Call Analytics job. For a list of supported
	// languages and their associated language codes, refer to the Supported languages
	// (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	//
	// If you do not know the language spoken in your media file, you can omit this
	// field and let Amazon Transcribe automatically identify the language of your
	// media. To improve the accuracy of language identification, you can include
	// several language codes and Amazon Transcribe chooses the closest match for
	// your transcription.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// Provides the Amazon S3 location of the media file you used in your Call Analytics
	// request.
	Media *Media `type:"structure"`

	// The format of the input media file.
	MediaFormat *string `type:"string" enum:"MediaFormat"`

	// The sample rate, in hertz, of the audio track in your input media file.
	MediaSampleRateHertz *int64 `min:"8000" type:"integer"`

	// Provides information on any additional settings that were included in your
	// request. Additional settings include content redaction and language identification
	// settings.
	Settings *CallAnalyticsJobSettings `type:"structure"`

	// The date and time the specified Call Analytics job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`

	// Provides you with the Amazon S3 URI you can use to access your transcript.
	Transcript *Transcript `type:"structure"`
	// contains filtered or unexported fields
}

Provides detailed information about a Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in the RedactedMediaFileUri field of your response.

func (CallAnalyticsJob) GoString added in v1.40.15 

func (s CallAnalyticsJob) 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 (*CallAnalyticsJob) SetCallAnalyticsJobDetails added in v1.51.31 

func (s *CallAnalyticsJob) SetCallAnalyticsJobDetails(v *CallAnalyticsJobDetails) *CallAnalyticsJob

SetCallAnalyticsJobDetails sets the CallAnalyticsJobDetails field's value.

func (*CallAnalyticsJob) SetCallAnalyticsJobName added in v1.40.15 

func (s *CallAnalyticsJob) SetCallAnalyticsJobName(v string) *CallAnalyticsJob

SetCallAnalyticsJobName sets the CallAnalyticsJobName field's value.

func (*CallAnalyticsJob) SetCallAnalyticsJobStatus added in v1.40.15 

func (s *CallAnalyticsJob) SetCallAnalyticsJobStatus(v string) *CallAnalyticsJob

SetCallAnalyticsJobStatus sets the CallAnalyticsJobStatus field's value.

func (*CallAnalyticsJob) SetChannelDefinitions added in v1.40.15 

func (s *CallAnalyticsJob) SetChannelDefinitions(v []*ChannelDefinition) *CallAnalyticsJob

SetChannelDefinitions sets the ChannelDefinitions field's value.

func (*CallAnalyticsJob) SetCompletionTime added in v1.40.15 

func (s *CallAnalyticsJob) SetCompletionTime(v time.Time) *CallAnalyticsJob

SetCompletionTime sets the CompletionTime field's value.

func (*CallAnalyticsJob) SetCreationTime added in v1.40.15 

func (s *CallAnalyticsJob) SetCreationTime(v time.Time) *CallAnalyticsJob

SetCreationTime sets the CreationTime field's value.

func (*CallAnalyticsJob) SetDataAccessRoleArn added in v1.40.15 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CallAnalyticsJob) SetFailureReason added in v1.40.15 

func (s *CallAnalyticsJob) SetFailureReason(v string) *CallAnalyticsJob

SetFailureReason sets the FailureReason field's value.

func (*CallAnalyticsJob) SetIdentifiedLanguageScore added in v1.40.15 

func (s *CallAnalyticsJob) SetIdentifiedLanguageScore(v float64) *CallAnalyticsJob

SetIdentifiedLanguageScore sets the IdentifiedLanguageScore field's value.

func (*CallAnalyticsJob) SetLanguageCode added in v1.40.15 

func (s *CallAnalyticsJob) SetLanguageCode(v string) *CallAnalyticsJob

SetLanguageCode sets the LanguageCode field's value.

func (*CallAnalyticsJob) SetMedia added in v1.40.15 

func (s *CallAnalyticsJob) SetMedia(v *Media) *CallAnalyticsJob

SetMedia sets the Media field's value.

func (*CallAnalyticsJob) SetMediaFormat added in v1.40.15 

func (s *CallAnalyticsJob) SetMediaFormat(v string) *CallAnalyticsJob

SetMediaFormat sets the MediaFormat field's value.

func (*CallAnalyticsJob) SetMediaSampleRateHertz added in v1.40.15 

func (s *CallAnalyticsJob) SetMediaSampleRateHertz(v int64) *CallAnalyticsJob

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*CallAnalyticsJob) SetSettings added in v1.40.15 

func (s *CallAnalyticsJob) SetSettings(v *CallAnalyticsJobSettings) *CallAnalyticsJob

SetSettings sets the Settings field's value.

func (*CallAnalyticsJob) SetStartTime added in v1.40.15 

func (s *CallAnalyticsJob) SetStartTime(v time.Time) *CallAnalyticsJob

SetStartTime sets the StartTime field's value.

func (*CallAnalyticsJob) SetTranscript added in v1.40.15 

func (s *CallAnalyticsJob) SetTranscript(v *Transcript) *CallAnalyticsJob

SetTranscript sets the Transcript field's value.

func (CallAnalyticsJob) String added in v1.40.15 

func (s CallAnalyticsJob) 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 CallAnalyticsJobDetails added in v1.51.31 

type CallAnalyticsJobDetails struct {

	// Contains information about any skipped analytics features during the analysis
	// of a call analytics job.
	//
	// This array lists all the analytics features that were skipped, along with
	// their corresponding reason code and message.
	Skipped []*CallAnalyticsSkippedFeature `type:"list"`
	// contains filtered or unexported fields
}

Contains details about a call analytics job, including information about skipped analytics features.

func (CallAnalyticsJobDetails) GoString added in v1.51.31 

func (s CallAnalyticsJobDetails) 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 (*CallAnalyticsJobDetails) SetSkipped added in v1.51.31 

func (s *CallAnalyticsJobDetails) SetSkipped(v []*CallAnalyticsSkippedFeature) *CallAnalyticsJobDetails

SetSkipped sets the Skipped field's value.

func (CallAnalyticsJobDetails) String added in v1.51.31 

func (s CallAnalyticsJobDetails) 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 CallAnalyticsJobSettings added in v1.40.15 

type CallAnalyticsJobSettings struct {

	// Makes it possible to redact or flag specified personally identifiable information
	// (PII) in your transcript. If you use ContentRedaction, you must also include
	// the sub-parameters: RedactionOutput and RedactionType. You can optionally
	// include PiiEntityTypes to choose which types of PII you want to redact.
	ContentRedaction *ContentRedaction `type:"structure"`

	// If using automatic language identification in your request and you want to
	// apply a custom language model, a custom vocabulary, or a custom vocabulary
	// filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName,
	// LanguageModelName, and VocabularyFilterName).
	//
	// LanguageIdSettings supports two to five language codes. Each language code
	// you include can have an associated custom language model, custom vocabulary,
	// and custom vocabulary filter. The language codes that you specify must match
	// the languages of the associated custom language models, custom vocabularies,
	// and custom vocabulary filters.
	//
	// It's recommended that you include LanguageOptions when using LanguageIdSettings
	// to ensure that the correct language dialect is identified. For example, if
	// you specify a custom vocabulary that is in en-US but Amazon Transcribe determines
	// that the language spoken in your media is en-AU, your custom vocabulary is
	// not applied to your transcription. If you include LanguageOptions and include
	// en-US as the only English language dialect, your custom vocabulary is applied
	// to your transcription.
	//
	// If you want to include a custom language model, custom vocabulary, or custom
	// vocabulary filter with your request but do not want to use automatic language
	// identification, use instead the parameter with the LanguageModelName, VocabularyName,
	// or VocabularyFilterName sub-parameters.
	//
	// For a list of languages supported with Call Analytics, refer to Supported
	// languages and language-specific features (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html).
	LanguageIdSettings map[string]*LanguageIdSettings `min:"1" type:"map"`

	// The name of the custom language model you want to use when processing your
	// Call Analytics job. Note that custom language model names are case sensitive.
	//
	// The language of the specified custom language model must match the language
	// code that you specify in your transcription request. If the languages do
	// not match, the custom language model isn't applied. There are no errors or
	// warnings associated with a language mismatch.
	LanguageModelName *string `min:"1" type:"string"`

	// You can specify two or more language codes that represent the languages you
	// think may be present in your media. Including more than five is not recommended.
	// If you're unsure what languages are present, do not include this parameter.
	//
	// Including language options can improve the accuracy of language identification.
	//
	// For a list of languages supported with Call Analytics, refer to the Supported
	// languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	//
	// To transcribe speech in Modern Standard Arabic (ar-SA), your media file must
	// be encoded at a sample rate of 16,000 Hz or higher.
	LanguageOptions []*string `min:"1" type:"list" enum:"LanguageCode"`

	// Contains GenerateAbstractiveSummary, which is a required parameter if you
	// want to enable Generative call summarization in your Call Analytics request.
	Summarization *Summarization `type:"structure"`

	// Specify how you want your custom vocabulary filter applied to your transcript.
	//
	// To replace words with ***, choose mask.
	//
	// To delete words, choose remove.
	//
	// To flag words without changing them, choose tag.
	VocabularyFilterMethod *string `type:"string" enum:"VocabularyFilterMethod"`

	// The name of the custom vocabulary filter you want to include in your Call
	// Analytics transcription request. Custom vocabulary filter names are case
	// sensitive.
	//
	// Note that if you include VocabularyFilterName in your request, you must also
	// include VocabularyFilterMethod.
	VocabularyFilterName *string `min:"1" type:"string"`

	// The name of the custom vocabulary you want to include in your Call Analytics
	// transcription request. Custom vocabulary names are case sensitive.
	VocabularyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, custom vocabulary filters, and custom vocabularies.

func (CallAnalyticsJobSettings) GoString added in v1.40.15 

func (s CallAnalyticsJobSettings) 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 (*CallAnalyticsJobSettings) SetContentRedaction added in v1.40.15 

func (s *CallAnalyticsJobSettings) SetContentRedaction(v *ContentRedaction) *CallAnalyticsJobSettings

SetContentRedaction sets the ContentRedaction field's value.

func (*CallAnalyticsJobSettings) SetLanguageIdSettings added in v1.41.14 

func (s *CallAnalyticsJobSettings) SetLanguageIdSettings(v map[string]*LanguageIdSettings) *CallAnalyticsJobSettings

SetLanguageIdSettings sets the LanguageIdSettings field's value.

func (*CallAnalyticsJobSettings) SetLanguageModelName added in v1.40.15 

func (s *CallAnalyticsJobSettings) SetLanguageModelName(v string) *CallAnalyticsJobSettings

SetLanguageModelName sets the LanguageModelName field's value.

func (*CallAnalyticsJobSettings) SetLanguageOptions added in v1.40.15 

func (s *CallAnalyticsJobSettings) SetLanguageOptions(v []*string) *CallAnalyticsJobSettings

SetLanguageOptions sets the LanguageOptions field's value.

func (*CallAnalyticsJobSettings) SetSummarization added in v1.48.4 

func (s *CallAnalyticsJobSettings) SetSummarization(v *Summarization) *CallAnalyticsJobSettings

SetSummarization sets the Summarization field's value.

func (*CallAnalyticsJobSettings) SetVocabularyFilterMethod added in v1.40.15 

func (s *CallAnalyticsJobSettings) SetVocabularyFilterMethod(v string) *CallAnalyticsJobSettings

SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.

func (*CallAnalyticsJobSettings) SetVocabularyFilterName added in v1.40.15 

func (s *CallAnalyticsJobSettings) SetVocabularyFilterName(v string) *CallAnalyticsJobSettings

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*CallAnalyticsJobSettings) SetVocabularyName added in v1.40.15 

func (s *CallAnalyticsJobSettings) SetVocabularyName(v string) *CallAnalyticsJobSettings

SetVocabularyName sets the VocabularyName field's value.

func (CallAnalyticsJobSettings) String added in v1.40.15 

func (s CallAnalyticsJobSettings) 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 (*CallAnalyticsJobSettings) Validate added in v1.40.15 

func (s *CallAnalyticsJobSettings) Validate() error

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

type CallAnalyticsJobSummary added in v1.40.15 

type CallAnalyticsJobSummary struct {

	// Provides detailed information about a call analytics job, including information
	// about skipped analytics features.
	CallAnalyticsJobDetails *CallAnalyticsJobDetails `type:"structure"`

	// The name of the Call Analytics job. Job names are case sensitive and must
	// be unique within an Amazon Web Services account.
	CallAnalyticsJobName *string `min:"1" type:"string"`

	// Provides the status of your Call Analytics job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri,
	// if you requested transcript redaction). If the status is FAILED, FailureReason
	// provides details on why your transcription job failed.
	CallAnalyticsJobStatus *string `type:"string" enum:"CallAnalyticsJobStatus"`

	// The date and time the specified Call Analytics job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// The date and time the specified Call Analytics job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// If CallAnalyticsJobStatus is FAILED, FailureReason contains information about
	// why the Call Analytics job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code used to create your Call Analytics transcription.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time your Call Analytics job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides detailed information about a specific Call Analytics job.

func (CallAnalyticsJobSummary) GoString added in v1.40.15 

func (s CallAnalyticsJobSummary) 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 (*CallAnalyticsJobSummary) SetCallAnalyticsJobDetails added in v1.51.31 

func (s *CallAnalyticsJobSummary) SetCallAnalyticsJobDetails(v *CallAnalyticsJobDetails) *CallAnalyticsJobSummary

SetCallAnalyticsJobDetails sets the CallAnalyticsJobDetails field's value.

func (*CallAnalyticsJobSummary) SetCallAnalyticsJobName added in v1.40.15 

func (s *CallAnalyticsJobSummary) SetCallAnalyticsJobName(v string) *CallAnalyticsJobSummary

SetCallAnalyticsJobName sets the CallAnalyticsJobName field's value.

func (*CallAnalyticsJobSummary) SetCallAnalyticsJobStatus added in v1.40.15 

func (s *CallAnalyticsJobSummary) SetCallAnalyticsJobStatus(v string) *CallAnalyticsJobSummary

SetCallAnalyticsJobStatus sets the CallAnalyticsJobStatus field's value.

func (*CallAnalyticsJobSummary) SetCompletionTime added in v1.40.15 

func (s *CallAnalyticsJobSummary) SetCompletionTime(v time.Time) *CallAnalyticsJobSummary

SetCompletionTime sets the CompletionTime field's value.

func (*CallAnalyticsJobSummary) SetCreationTime added in v1.40.15 

func (s *CallAnalyticsJobSummary) SetCreationTime(v time.Time) *CallAnalyticsJobSummary

SetCreationTime sets the CreationTime field's value.

func (*CallAnalyticsJobSummary) SetFailureReason added in v1.40.15 

func (s *CallAnalyticsJobSummary) SetFailureReason(v string) *CallAnalyticsJobSummary

SetFailureReason sets the FailureReason field's value.

func (*CallAnalyticsJobSummary) SetLanguageCode added in v1.40.15 

func (s *CallAnalyticsJobSummary) SetLanguageCode(v string) *CallAnalyticsJobSummary

SetLanguageCode sets the LanguageCode field's value.

func (*CallAnalyticsJobSummary) SetStartTime added in v1.40.15 

func (s *CallAnalyticsJobSummary) SetStartTime(v time.Time) *CallAnalyticsJobSummary

SetStartTime sets the StartTime field's value.

func (CallAnalyticsJobSummary) String added in v1.40.15 

func (s CallAnalyticsJobSummary) 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 CallAnalyticsSkippedFeature added in v1.51.31 

type CallAnalyticsSkippedFeature struct {

	// Indicates the type of analytics feature that was skipped during the analysis
	// of a call analytics job.
	Feature *string `type:"string" enum:"CallAnalyticsFeature"`

	// Contains additional information or a message explaining why a specific analytics
	// feature was skipped during the analysis of a call analytics job.
	Message *string `type:"string"`

	// Provides a code indicating the reason why a specific analytics feature was
	// skipped during the analysis of a call analytics job.
	ReasonCode *string `type:"string" enum:"CallAnalyticsSkippedReasonCode"`
	// contains filtered or unexported fields
}

Represents a skipped analytics feature during the analysis of a call analytics job.

The Feature field indicates the type of analytics feature that was skipped.

The Message field contains additional information or a message explaining why the analytics feature was skipped.

The ReasonCode field provides a code indicating the reason why the analytics feature was skipped.

func (CallAnalyticsSkippedFeature) GoString added in v1.51.31 

func (s CallAnalyticsSkippedFeature) 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 (*CallAnalyticsSkippedFeature) SetFeature added in v1.51.31 

func (s *CallAnalyticsSkippedFeature) SetFeature(v string) *CallAnalyticsSkippedFeature

SetFeature sets the Feature field's value.

func (*CallAnalyticsSkippedFeature) SetMessage added in v1.51.31 

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

SetMessage sets the Message field's value.

func (*CallAnalyticsSkippedFeature) SetReasonCode added in v1.51.31 

func (s *CallAnalyticsSkippedFeature) SetReasonCode(v string) *CallAnalyticsSkippedFeature

SetReasonCode sets the ReasonCode field's value.

func (CallAnalyticsSkippedFeature) String added in v1.51.31 

func (s CallAnalyticsSkippedFeature) 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 CategoryProperties added in v1.40.15 

type CategoryProperties struct {

	// The name of the Call Analytics category. Category names are case sensitive
	// and must be unique within an Amazon Web Services account.
	CategoryName *string `min:"1" type:"string"`

	// The date and time the specified Call Analytics category was created.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	CreateTime *time.Time `type:"timestamp"`

	// The input type associated with the specified category. POST_CALL refers to
	// a category that is applied to batch transcriptions; REAL_TIME refers to a
	// category that is applied to streaming transcriptions.
	InputType *string `type:"string" enum:"InputType"`

	// The date and time the specified Call Analytics category was last updated.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.
	LastUpdateTime *time.Time `type:"timestamp"`

	// The rules used to define a Call Analytics category. Each category can have
	// between 1 and 20 rules.
	Rules []*Rule `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.

func (CategoryProperties) GoString added in v1.40.15 

func (s CategoryProperties) 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 (*CategoryProperties) SetCategoryName added in v1.40.15 

func (s *CategoryProperties) SetCategoryName(v string) *CategoryProperties

SetCategoryName sets the CategoryName field's value.

func (*CategoryProperties) SetCreateTime added in v1.40.15 

func (s *CategoryProperties) SetCreateTime(v time.Time) *CategoryProperties

SetCreateTime sets the CreateTime field's value.

func (*CategoryProperties) SetInputType added in v1.44.146 

func (s *CategoryProperties) SetInputType(v string) *CategoryProperties

SetInputType sets the InputType field's value.

func (*CategoryProperties) SetLastUpdateTime added in v1.40.15 

func (s *CategoryProperties) SetLastUpdateTime(v time.Time) *CategoryProperties

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*CategoryProperties) SetRules added in v1.40.15 

func (s *CategoryProperties) SetRules(v []*Rule) *CategoryProperties

SetRules sets the Rules field's value.

func (CategoryProperties) String added in v1.40.15 

func (s CategoryProperties) 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 ChannelDefinition added in v1.40.15 

type ChannelDefinition struct {

	// Specify the audio channel you want to define.
	ChannelId *int64 `type:"integer"`

	// Specify the speaker you want to define. Omitting this parameter is equivalent
	// to specifying both participants.
	ParticipantRole *string `type:"string" enum:"ParticipantRole"`
	// contains filtered or unexported fields
}

Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

func (ChannelDefinition) GoString added in v1.40.15 

func (s ChannelDefinition) 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 (*ChannelDefinition) SetChannelId added in v1.40.15 

func (s *ChannelDefinition) SetChannelId(v int64) *ChannelDefinition

SetChannelId sets the ChannelId field's value.

func (*ChannelDefinition) SetParticipantRole added in v1.40.15 

func (s *ChannelDefinition) SetParticipantRole(v string) *ChannelDefinition

SetParticipantRole sets the ParticipantRole field's value.

func (ChannelDefinition) String added in v1.40.15 

func (s ChannelDefinition) 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 added in v1.28.0 

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

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

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

func (*ConflictException) Code added in v1.28.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String added in v1.28.0 

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 ContentRedaction added in v1.29.11 

type ContentRedaction struct {

	// Specify which types of personally identifiable information (PII) you want
	// to redact in your transcript. You can include as many types as you'd like,
	// or you can select ALL. If you do not include PiiEntityTypes in your request,
	// all PII is redacted.
	PiiEntityTypes []*string `type:"list" enum:"PiiEntityType"`

	// Specify if you want only a redacted transcript, or if you want a redacted
	// and an unredacted transcript.
	//
	// When you choose redacted Amazon Transcribe creates only a redacted transcript.
	//
	// When you choose redacted_and_unredacted Amazon Transcribe creates a redacted
	// and an unredacted transcript (as two separate files).
	//
	// RedactionOutput is a required field
	RedactionOutput *string `type:"string" required:"true" enum:"RedactionOutput"`

	// Specify the category of information you want to redact; PII (personally identifiable
	// information) is the only valid value. You can use PiiEntityTypes to choose
	// which types of PII you want to redact. If you do not include PiiEntityTypes
	// in your request, all PII is redacted.
	//
	// RedactionType is a required field
	RedactionType *string `type:"string" required:"true" enum:"RedactionType"`
	// contains filtered or unexported fields
}

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

func (ContentRedaction) GoString added in v1.29.11 

func (s ContentRedaction) 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 (*ContentRedaction) SetPiiEntityTypes added in v1.42.39 

func (s *ContentRedaction) SetPiiEntityTypes(v []*string) *ContentRedaction

SetPiiEntityTypes sets the PiiEntityTypes field's value.

func (*ContentRedaction) SetRedactionOutput added in v1.29.11 

func (s *ContentRedaction) SetRedactionOutput(v string) *ContentRedaction

SetRedactionOutput sets the RedactionOutput field's value.

func (*ContentRedaction) SetRedactionType added in v1.29.11 

func (s *ContentRedaction) SetRedactionType(v string) *ContentRedaction

SetRedactionType sets the RedactionType field's value.

func (ContentRedaction) String added in v1.29.11 

func (s ContentRedaction) 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 (*ContentRedaction) Validate added in v1.29.11 

func (s *ContentRedaction) Validate() error

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

type CreateCallAnalyticsCategoryInput added in v1.40.15 

type CreateCallAnalyticsCategoryInput struct {

	// A unique name, chosen by you, for your Call Analytics category. It's helpful
	// to use a detailed naming system that will make sense to you in the future.
	// For example, it's better to use sentiment-positive-last30seconds for a category
	// over a generic name like test-category.
	//
	// Category names are case sensitive.
	//
	// CategoryName is a required field
	CategoryName *string `min:"1" type:"string" required:"true"`

	// Choose whether you want to create a real-time or a post-call category for
	// your Call Analytics transcription.
	//
	// Specifying POST_CALL assigns your category to post-call transcriptions; categories
	// with this input type cannot be applied to streaming (real-time) transcriptions.
	//
	// Specifying REAL_TIME assigns your category to streaming transcriptions; categories
	// with this input type cannot be applied to post-call transcriptions.
	//
	// If you do not include InputType, your category is created as a post-call
	// category by default.
	InputType *string `type:"string" enum:"InputType"`

	// Rules define a Call Analytics category. When creating a new category, you
	// must create between 1 and 20 rules for that category. For each rule, you
	// specify a filter you want applied to the attributes of a call. For example,
	// you can choose a sentiment filter that detects if a customer's sentiment
	// was positive during the last 30 seconds of the call.
	//
	// Rules is a required field
	Rules []*Rule `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCallAnalyticsCategoryInput) GoString added in v1.40.15 

func (s CreateCallAnalyticsCategoryInput) 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 (*CreateCallAnalyticsCategoryInput) SetCategoryName added in v1.40.15 

func (s *CreateCallAnalyticsCategoryInput) SetCategoryName(v string) *CreateCallAnalyticsCategoryInput

SetCategoryName sets the CategoryName field's value.

func (*CreateCallAnalyticsCategoryInput) SetInputType added in v1.44.146 

func (s *CreateCallAnalyticsCategoryInput) SetInputType(v string) *CreateCallAnalyticsCategoryInput

SetInputType sets the InputType field's value.

func (*CreateCallAnalyticsCategoryInput) SetRules added in v1.40.15 

func (s *CreateCallAnalyticsCategoryInput) SetRules(v []*Rule) *CreateCallAnalyticsCategoryInput

SetRules sets the Rules field's value.

func (CreateCallAnalyticsCategoryInput) String added in v1.40.15 

func (s CreateCallAnalyticsCategoryInput) 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 (*CreateCallAnalyticsCategoryInput) Validate added in v1.40.15 

func (s *CreateCallAnalyticsCategoryInput) Validate() error

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

type CreateCallAnalyticsCategoryOutput added in v1.40.15 

type CreateCallAnalyticsCategoryOutput struct {

	// Provides you with the properties of your new category, including its associated
	// rules.
	CategoryProperties *CategoryProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateCallAnalyticsCategoryOutput) GoString added in v1.40.15 

func (s CreateCallAnalyticsCategoryOutput) 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 (*CreateCallAnalyticsCategoryOutput) SetCategoryProperties added in v1.40.15 

func (s *CreateCallAnalyticsCategoryOutput) SetCategoryProperties(v *CategoryProperties) *CreateCallAnalyticsCategoryOutput

SetCategoryProperties sets the CategoryProperties field's value.

func (CreateCallAnalyticsCategoryOutput) String added in v1.40.15 

func (s CreateCallAnalyticsCategoryOutput) 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 CreateLanguageModelInput added in v1.33.20 

type CreateLanguageModelInput struct {

	// The Amazon Transcribe standard language model, or base model, used to create
	// your custom language model. Amazon Transcribe offers two options for base
	// models: Wideband and Narrowband.
	//
	// If the audio you want to transcribe has a sample rate of 16,000 Hz or greater,
	// choose WideBand. To transcribe audio with a sample rate less than 16,000
	// Hz, choose NarrowBand.
	//
	// BaseModelName is a required field
	BaseModelName *string `type:"string" required:"true" enum:"BaseModelName"`

	// Contains the Amazon S3 location of the training data you want to use to create
	// a new custom language model, and permissions to access this location.
	//
	// When using InputDataConfig, you must include these sub-parameters: S3Uri,
	// which is the Amazon S3 location of your training data, and DataAccessRoleArn,
	// which is the Amazon Resource Name (ARN) of the role that has permission to
	// access your specified Amazon S3 location. You can optionally include TuningDataS3Uri,
	// which is the Amazon S3 location of your tuning data. If you specify different
	// Amazon S3 locations for training and tuning data, the ARN you use must have
	// permissions to access both locations.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The language code that represents the language of your model. Each custom
	// language model must contain terms in only one language, and the language
	// you select for your custom language model must match the language of your
	// training and tuning data.
	//
	// For a list of supported languages and their associated language codes, refer
	// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table. Note that US English (en-US) is the only language supported with Amazon
	// Transcribe Medical.
	//
	// A custom language model can only be used to transcribe files in the same
	// language as the model. For example, if you create a custom language model
	// using US English (en-US), you can only apply this model to files that contain
	// English audio.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"CLMLanguageCode"`

	// A unique name, chosen by you, for your custom language model.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new custom language
	// model with the same name as an existing custom language model, you get a
	// ConflictException error.
	//
	// ModelName is a required field
	ModelName *string `min:"1" type:"string" required:"true"`

	// Adds one or more custom tags, each in the form of a key:value pair, to a
	// new custom language model at the time you create this new model.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateLanguageModelInput) GoString added in v1.33.20 

func (s CreateLanguageModelInput) 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 (*CreateLanguageModelInput) SetBaseModelName added in v1.33.20 

func (s *CreateLanguageModelInput) SetBaseModelName(v string) *CreateLanguageModelInput

SetBaseModelName sets the BaseModelName field's value.

func (*CreateLanguageModelInput) SetInputDataConfig added in v1.33.20 

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

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateLanguageModelInput) SetLanguageCode added in v1.33.20 

func (s *CreateLanguageModelInput) SetLanguageCode(v string) *CreateLanguageModelInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateLanguageModelInput) SetModelName added in v1.33.20 

func (s *CreateLanguageModelInput) SetModelName(v string) *CreateLanguageModelInput

SetModelName sets the ModelName field's value.

func (*CreateLanguageModelInput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (CreateLanguageModelInput) String added in v1.33.20 

func (s CreateLanguageModelInput) 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 (*CreateLanguageModelInput) Validate added in v1.33.20 

func (s *CreateLanguageModelInput) Validate() error

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

type CreateLanguageModelOutput added in v1.33.20 

type CreateLanguageModelOutput struct {

	// The Amazon Transcribe standard language model, or base model, you specified
	// when creating your custom language model.
	BaseModelName *string `type:"string" enum:"BaseModelName"`

	// Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
	// locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri)
	// data.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The language code you selected for your custom language model.
	LanguageCode *string `type:"string" enum:"CLMLanguageCode"`

	// The name of your custom language model.
	ModelName *string `min:"1" type:"string"`

	// The status of your custom language model. When the status displays as COMPLETED,
	// your model is ready to use.
	ModelStatus *string `type:"string" enum:"ModelStatus"`
	// contains filtered or unexported fields
}

func (CreateLanguageModelOutput) GoString added in v1.33.20 

func (s CreateLanguageModelOutput) 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 (*CreateLanguageModelOutput) SetBaseModelName added in v1.33.20 

func (s *CreateLanguageModelOutput) SetBaseModelName(v string) *CreateLanguageModelOutput

SetBaseModelName sets the BaseModelName field's value.

func (*CreateLanguageModelOutput) SetInputDataConfig added in v1.33.20 

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

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateLanguageModelOutput) SetLanguageCode added in v1.33.20 

func (s *CreateLanguageModelOutput) SetLanguageCode(v string) *CreateLanguageModelOutput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateLanguageModelOutput) SetModelName added in v1.33.20 

func (s *CreateLanguageModelOutput) SetModelName(v string) *CreateLanguageModelOutput

SetModelName sets the ModelName field's value.

func (*CreateLanguageModelOutput) SetModelStatus added in v1.33.20 

func (s *CreateLanguageModelOutput) SetModelStatus(v string) *CreateLanguageModelOutput

SetModelStatus sets the ModelStatus field's value.

func (CreateLanguageModelOutput) String added in v1.33.20 

func (s CreateLanguageModelOutput) 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 CreateMedicalVocabularyInput added in v1.30.17 

type CreateMedicalVocabularyInput struct {

	// The language code that represents the language of the entries in your custom
	// vocabulary. US English (en-US) is the only language supported with Amazon
	// Transcribe Medical.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Adds one or more custom tags, each in the form of a key:value pair, to a
	// new custom medical vocabulary at the time you create this new custom vocabulary.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`

	// The Amazon S3 location (URI) of the text file that contains your custom medical
	// vocabulary. The URI must be in the same Amazon Web Services Region as the
	// resource you're calling.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
	//
	// VocabularyFileUri is a required field
	VocabularyFileUri *string `min:"1" type:"string" required:"true"`

	// A unique name, chosen by you, for your new custom medical vocabulary.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new custom medical
	// vocabulary with the same name as an existing custom medical vocabulary, you
	// get a ConflictException error.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMedicalVocabularyInput) GoString added in v1.30.17 

func (s CreateMedicalVocabularyInput) 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 (*CreateMedicalVocabularyInput) SetLanguageCode added in v1.30.17 

func (s *CreateMedicalVocabularyInput) SetLanguageCode(v string) *CreateMedicalVocabularyInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateMedicalVocabularyInput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (*CreateMedicalVocabularyInput) SetVocabularyFileUri added in v1.30.17 

func (s *CreateMedicalVocabularyInput) SetVocabularyFileUri(v string) *CreateMedicalVocabularyInput

SetVocabularyFileUri sets the VocabularyFileUri field's value.

func (*CreateMedicalVocabularyInput) SetVocabularyName added in v1.30.17 

func (s *CreateMedicalVocabularyInput) SetVocabularyName(v string) *CreateMedicalVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (CreateMedicalVocabularyInput) String added in v1.30.17 

func (s CreateMedicalVocabularyInput) 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 (*CreateMedicalVocabularyInput) Validate added in v1.30.17 

func (s *CreateMedicalVocabularyInput) Validate() error

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

type CreateMedicalVocabularyOutput added in v1.30.17 

type CreateMedicalVocabularyOutput struct {

	// If VocabularyState is FAILED, FailureReason contains information about why
	// the medical transcription job request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code you selected for your custom medical vocabulary. US English
	// (en-US) is the only language supported with Amazon Transcribe Medical.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time you created your custom medical vocabulary.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name you chose for your custom medical vocabulary.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom medical vocabulary. If the state is READY,
	// you can use the custom vocabulary in a StartMedicalTranscriptionJob request.
	VocabularyState *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (CreateMedicalVocabularyOutput) GoString added in v1.30.17 

func (s CreateMedicalVocabularyOutput) 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 (*CreateMedicalVocabularyOutput) SetFailureReason added in v1.30.17 

func (s *CreateMedicalVocabularyOutput) SetFailureReason(v string) *CreateMedicalVocabularyOutput

SetFailureReason sets the FailureReason field's value.

func (*CreateMedicalVocabularyOutput) SetLanguageCode added in v1.30.17 

func (s *CreateMedicalVocabularyOutput) SetLanguageCode(v string) *CreateMedicalVocabularyOutput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateMedicalVocabularyOutput) SetLastModifiedTime added in v1.30.17 

func (s *CreateMedicalVocabularyOutput) SetLastModifiedTime(v time.Time) *CreateMedicalVocabularyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*CreateMedicalVocabularyOutput) SetVocabularyName added in v1.30.17 

func (s *CreateMedicalVocabularyOutput) SetVocabularyName(v string) *CreateMedicalVocabularyOutput

SetVocabularyName sets the VocabularyName field's value.

func (*CreateMedicalVocabularyOutput) SetVocabularyState added in v1.30.17 

func (s *CreateMedicalVocabularyOutput) SetVocabularyState(v string) *CreateMedicalVocabularyOutput

SetVocabularyState sets the VocabularyState field's value.

func (CreateMedicalVocabularyOutput) String added in v1.30.17 

func (s CreateMedicalVocabularyOutput) 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 CreateVocabularyFilterInput added in v1.26.7 

type CreateVocabularyFilterInput struct {

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files (in this case, your custom
	// vocabulary filter). If the role that you specify doesn’t have the appropriate
	// permissions to access the specified Amazon S3 location, your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The language code that represents the language of the entries in your vocabulary
	// filter. Each custom vocabulary filter must contain terms in only one language.
	//
	// A custom vocabulary filter can only be used to transcribe files in the same
	// language as the filter. For example, if you create a custom vocabulary filter
	// using US English (en-US), you can only apply this filter to files that contain
	// English audio.
	//
	// For a list of supported languages and their associated language codes, refer
	// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Adds one or more custom tags, each in the form of a key:value pair, to a
	// new custom vocabulary filter at the time you create this new vocabulary filter.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`

	// The Amazon S3 location of the text file that contains your custom vocabulary
	// filter terms. The URI must be located in the same Amazon Web Services Region
	// as the resource you're calling.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
	//
	// Note that if you include VocabularyFilterFileUri in your request, you cannot
	// use Words; you must choose one or the other.
	VocabularyFilterFileUri *string `min:"1" type:"string"`

	// A unique name, chosen by you, for your new custom vocabulary filter.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new custom vocabulary
	// filter with the same name as an existing custom vocabulary filter, you get
	// a ConflictException error.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`

	// Use this parameter if you want to create your custom vocabulary filter by
	// including all desired terms, as comma-separated values, within your request.
	// The other option for creating your vocabulary filter is to save your entries
	// in a text file and upload them to an Amazon S3 bucket, then specify the location
	// of your file using the VocabularyFilterFileUri parameter.
	//
	// Note that if you include Words in your request, you cannot use VocabularyFilterFileUri;
	// you must choose one or the other.
	//
	// Each language has a character set that contains all allowed characters for
	// that specific language. If you use unsupported characters, your custom vocabulary
	// filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html)
	// to get the character set for your language.
	Words []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateVocabularyFilterInput) GoString added in v1.26.7 

func (s CreateVocabularyFilterInput) 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 (*CreateVocabularyFilterInput) SetDataAccessRoleArn added in v1.44.214 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateVocabularyFilterInput) SetLanguageCode added in v1.26.7 

func (s *CreateVocabularyFilterInput) SetLanguageCode(v string) *CreateVocabularyFilterInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateVocabularyFilterInput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (*CreateVocabularyFilterInput) SetVocabularyFilterFileUri added in v1.26.7 

func (s *CreateVocabularyFilterInput) SetVocabularyFilterFileUri(v string) *CreateVocabularyFilterInput

SetVocabularyFilterFileUri sets the VocabularyFilterFileUri field's value.

func (*CreateVocabularyFilterInput) SetVocabularyFilterName added in v1.26.7 

func (s *CreateVocabularyFilterInput) SetVocabularyFilterName(v string) *CreateVocabularyFilterInput

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*CreateVocabularyFilterInput) SetWords added in v1.26.7 

func (s *CreateVocabularyFilterInput) SetWords(v []*string) *CreateVocabularyFilterInput

SetWords sets the Words field's value.

func (CreateVocabularyFilterInput) String added in v1.26.7 

func (s CreateVocabularyFilterInput) 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 (*CreateVocabularyFilterInput) Validate added in v1.26.7 

func (s *CreateVocabularyFilterInput) Validate() error

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

type CreateVocabularyFilterOutput added in v1.26.7 

type CreateVocabularyFilterOutput struct {

	// The language code you selected for your custom vocabulary filter.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time you created your custom vocabulary filter.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name you chose for your custom vocabulary filter.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateVocabularyFilterOutput) GoString added in v1.26.7 

func (s CreateVocabularyFilterOutput) 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 (*CreateVocabularyFilterOutput) SetLanguageCode added in v1.26.7 

func (s *CreateVocabularyFilterOutput) SetLanguageCode(v string) *CreateVocabularyFilterOutput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateVocabularyFilterOutput) SetLastModifiedTime added in v1.26.7 

func (s *CreateVocabularyFilterOutput) SetLastModifiedTime(v time.Time) *CreateVocabularyFilterOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*CreateVocabularyFilterOutput) SetVocabularyFilterName added in v1.26.7 

func (s *CreateVocabularyFilterOutput) SetVocabularyFilterName(v string) *CreateVocabularyFilterOutput

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (CreateVocabularyFilterOutput) String added in v1.26.7 

func (s CreateVocabularyFilterOutput) 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 CreateVocabularyInput added in v1.13.28 

type CreateVocabularyInput struct {

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files (in this case, your custom
	// vocabulary). If the role that you specify doesn’t have the appropriate
	// permissions to access the specified Amazon S3 location, your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The language code that represents the language of the entries in your custom
	// vocabulary. Each custom vocabulary must contain terms in only one language.
	//
	// A custom vocabulary can only be used to transcribe files in the same language
	// as the custom vocabulary. For example, if you create a custom vocabulary
	// using US English (en-US), you can only apply this custom vocabulary to files
	// that contain English audio.
	//
	// For a list of supported languages and their associated language codes, refer
	// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Use this parameter if you want to create your custom vocabulary by including
	// all desired terms, as comma-separated values, within your request. The other
	// option for creating your custom vocabulary is to save your entries in a text
	// file and upload them to an Amazon S3 bucket, then specify the location of
	// your file using the VocabularyFileUri parameter.
	//
	// Note that if you include Phrases in your request, you cannot use VocabularyFileUri;
	// you must choose one or the other.
	//
	// Each language has a character set that contains all allowed characters for
	// that specific language. If you use unsupported characters, your custom vocabulary
	// filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html)
	// to get the character set for your language.
	Phrases []*string `type:"list"`

	// Adds one or more custom tags, each in the form of a key:value pair, to a
	// new custom vocabulary at the time you create this new custom vocabulary.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`

	// The Amazon S3 location of the text file that contains your custom vocabulary.
	// The URI must be located in the same Amazon Web Services Region as the resource
	// you're calling.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
	//
	// Note that if you include VocabularyFileUri in your request, you cannot use
	// the Phrases flag; you must choose one or the other.
	VocabularyFileUri *string `min:"1" type:"string"`

	// A unique name, chosen by you, for your new custom vocabulary.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new custom vocabulary
	// with the same name as an existing custom vocabulary, you get a ConflictException
	// error.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVocabularyInput) GoString added in v1.13.28 

func (s CreateVocabularyInput) 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 (*CreateVocabularyInput) SetDataAccessRoleArn added in v1.44.214 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateVocabularyInput) SetLanguageCode added in v1.13.28 

func (s *CreateVocabularyInput) SetLanguageCode(v string) *CreateVocabularyInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateVocabularyInput) SetPhrases added in v1.13.28 

func (s *CreateVocabularyInput) SetPhrases(v []*string) *CreateVocabularyInput

SetPhrases sets the Phrases field's value.

func (*CreateVocabularyInput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (*CreateVocabularyInput) SetVocabularyFileUri added in v1.19.4 

func (s *CreateVocabularyInput) SetVocabularyFileUri(v string) *CreateVocabularyInput

SetVocabularyFileUri sets the VocabularyFileUri field's value.

func (*CreateVocabularyInput) SetVocabularyName added in v1.13.28 

func (s *CreateVocabularyInput) SetVocabularyName(v string) *CreateVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (CreateVocabularyInput) String added in v1.13.28 

func (s CreateVocabularyInput) 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 (*CreateVocabularyInput) Validate added in v1.13.28 

func (s *CreateVocabularyInput) Validate() error

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

type CreateVocabularyOutput added in v1.13.28 

type CreateVocabularyOutput struct {

	// If VocabularyState is FAILED, FailureReason contains information about why
	// the custom vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code you selected for your custom vocabulary.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time you created your custom vocabulary.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name you chose for your custom vocabulary.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom vocabulary. If the state is READY, you
	// can use the custom vocabulary in a StartTranscriptionJob request.
	VocabularyState *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (CreateVocabularyOutput) GoString added in v1.13.28 

func (s CreateVocabularyOutput) 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 (*CreateVocabularyOutput) SetFailureReason added in v1.13.28 

func (s *CreateVocabularyOutput) SetFailureReason(v string) *CreateVocabularyOutput

SetFailureReason sets the FailureReason field's value.

func (*CreateVocabularyOutput) SetLanguageCode added in v1.13.28 

func (s *CreateVocabularyOutput) SetLanguageCode(v string) *CreateVocabularyOutput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateVocabularyOutput) SetLastModifiedTime added in v1.13.28 

func (s *CreateVocabularyOutput) SetLastModifiedTime(v time.Time) *CreateVocabularyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*CreateVocabularyOutput) SetVocabularyName added in v1.13.28 

func (s *CreateVocabularyOutput) SetVocabularyName(v string) *CreateVocabularyOutput

SetVocabularyName sets the VocabularyName field's value.

func (*CreateVocabularyOutput) SetVocabularyState added in v1.13.28 

func (s *CreateVocabularyOutput) SetVocabularyState(v string) *CreateVocabularyOutput

SetVocabularyState sets the VocabularyState field's value.

func (CreateVocabularyOutput) String added in v1.13.28 

func (s CreateVocabularyOutput) 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 DeleteCallAnalyticsCategoryInput added in v1.40.15 

type DeleteCallAnalyticsCategoryInput struct {

	// The name of the Call Analytics category you want to delete. Category names
	// are case sensitive.
	//
	// CategoryName is a required field
	CategoryName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCallAnalyticsCategoryInput) GoString added in v1.40.15 

func (s DeleteCallAnalyticsCategoryInput) 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 (*DeleteCallAnalyticsCategoryInput) SetCategoryName added in v1.40.15 

func (s *DeleteCallAnalyticsCategoryInput) SetCategoryName(v string) *DeleteCallAnalyticsCategoryInput

SetCategoryName sets the CategoryName field's value.

func (DeleteCallAnalyticsCategoryInput) String added in v1.40.15 

func (s DeleteCallAnalyticsCategoryInput) 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 (*DeleteCallAnalyticsCategoryInput) Validate added in v1.40.15 

func (s *DeleteCallAnalyticsCategoryInput) Validate() error

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

type DeleteCallAnalyticsCategoryOutput added in v1.40.15 

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

func (DeleteCallAnalyticsCategoryOutput) GoString added in v1.40.15 

func (s DeleteCallAnalyticsCategoryOutput) 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 (DeleteCallAnalyticsCategoryOutput) String added in v1.40.15 

func (s DeleteCallAnalyticsCategoryOutput) 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 DeleteCallAnalyticsJobInput added in v1.40.15 

type DeleteCallAnalyticsJobInput struct {

	// The name of the Call Analytics job you want to delete. Job names are case
	// sensitive.
	//
	// CallAnalyticsJobName is a required field
	CallAnalyticsJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCallAnalyticsJobInput) GoString added in v1.40.15 

func (s DeleteCallAnalyticsJobInput) 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 (*DeleteCallAnalyticsJobInput) SetCallAnalyticsJobName added in v1.40.15 

func (s *DeleteCallAnalyticsJobInput) SetCallAnalyticsJobName(v string) *DeleteCallAnalyticsJobInput

SetCallAnalyticsJobName sets the CallAnalyticsJobName field's value.

func (DeleteCallAnalyticsJobInput) String added in v1.40.15 

func (s DeleteCallAnalyticsJobInput) 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 (*DeleteCallAnalyticsJobInput) Validate added in v1.40.15 

func (s *DeleteCallAnalyticsJobInput) Validate() error

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

type DeleteCallAnalyticsJobOutput added in v1.40.15 

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

func (DeleteCallAnalyticsJobOutput) GoString added in v1.40.15 

func (s DeleteCallAnalyticsJobOutput) 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 (DeleteCallAnalyticsJobOutput) String added in v1.40.15 

func (s DeleteCallAnalyticsJobOutput) 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 DeleteLanguageModelInput added in v1.33.20 

type DeleteLanguageModelInput struct {

	// The name of the custom language model you want to delete. Model names are
	// case sensitive.
	//
	// ModelName is a required field
	ModelName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLanguageModelInput) GoString added in v1.33.20 

func (s DeleteLanguageModelInput) 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 (*DeleteLanguageModelInput) SetModelName added in v1.33.20 

func (s *DeleteLanguageModelInput) SetModelName(v string) *DeleteLanguageModelInput

SetModelName sets the ModelName field's value.

func (DeleteLanguageModelInput) String added in v1.33.20 

func (s DeleteLanguageModelInput) 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 (*DeleteLanguageModelInput) Validate added in v1.33.20 

func (s *DeleteLanguageModelInput) Validate() error

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

type DeleteLanguageModelOutput added in v1.33.20 

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

func (DeleteLanguageModelOutput) GoString added in v1.33.20 

func (s DeleteLanguageModelOutput) 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 (DeleteLanguageModelOutput) String added in v1.33.20 

func (s DeleteLanguageModelOutput) 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 DeleteMedicalScribeJobInput added in v1.48.5 

type DeleteMedicalScribeJobInput struct {

	// The name of the Medical Scribe job you want to delete. Job names are case
	// sensitive.
	//
	// MedicalScribeJobName is a required field
	MedicalScribeJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMedicalScribeJobInput) GoString added in v1.48.5 

func (s DeleteMedicalScribeJobInput) 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 (*DeleteMedicalScribeJobInput) SetMedicalScribeJobName added in v1.48.5 

func (s *DeleteMedicalScribeJobInput) SetMedicalScribeJobName(v string) *DeleteMedicalScribeJobInput

SetMedicalScribeJobName sets the MedicalScribeJobName field's value.

func (DeleteMedicalScribeJobInput) String added in v1.48.5 

func (s DeleteMedicalScribeJobInput) 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 (*DeleteMedicalScribeJobInput) Validate added in v1.48.5 

func (s *DeleteMedicalScribeJobInput) Validate() error

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

type DeleteMedicalScribeJobOutput added in v1.48.5 

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

func (DeleteMedicalScribeJobOutput) GoString added in v1.48.5 

func (s DeleteMedicalScribeJobOutput) 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 (DeleteMedicalScribeJobOutput) String added in v1.48.5 

func (s DeleteMedicalScribeJobOutput) 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 DeleteMedicalTranscriptionJobInput added in v1.30.5 

type DeleteMedicalTranscriptionJobInput struct {

	// The name of the medical transcription job you want to delete. Job names are
	// case sensitive.
	//
	// MedicalTranscriptionJobName is a required field
	MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMedicalTranscriptionJobInput) GoString added in v1.30.5 

func (s DeleteMedicalTranscriptionJobInput) 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 (*DeleteMedicalTranscriptionJobInput) SetMedicalTranscriptionJobName added in v1.30.5 

func (s *DeleteMedicalTranscriptionJobInput) SetMedicalTranscriptionJobName(v string) *DeleteMedicalTranscriptionJobInput

SetMedicalTranscriptionJobName sets the MedicalTranscriptionJobName field's value.

func (DeleteMedicalTranscriptionJobInput) String added in v1.30.5 

func (s DeleteMedicalTranscriptionJobInput) 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 (*DeleteMedicalTranscriptionJobInput) Validate added in v1.30.5 

func (s *DeleteMedicalTranscriptionJobInput) Validate() error

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

type DeleteMedicalTranscriptionJobOutput added in v1.30.5 

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

func (DeleteMedicalTranscriptionJobOutput) GoString added in v1.30.5 

func (s DeleteMedicalTranscriptionJobOutput) 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 (DeleteMedicalTranscriptionJobOutput) String added in v1.30.5 

func (s DeleteMedicalTranscriptionJobOutput) 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 DeleteMedicalVocabularyInput added in v1.30.17 

type DeleteMedicalVocabularyInput struct {

	// The name of the custom medical vocabulary you want to delete. Custom medical
	// vocabulary names are case sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMedicalVocabularyInput) GoString added in v1.30.17 

func (s DeleteMedicalVocabularyInput) 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 (*DeleteMedicalVocabularyInput) SetVocabularyName added in v1.30.17 

func (s *DeleteMedicalVocabularyInput) SetVocabularyName(v string) *DeleteMedicalVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (DeleteMedicalVocabularyInput) String added in v1.30.17 

func (s DeleteMedicalVocabularyInput) 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 (*DeleteMedicalVocabularyInput) Validate added in v1.30.17 

func (s *DeleteMedicalVocabularyInput) Validate() error

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

type DeleteMedicalVocabularyOutput added in v1.30.17 

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

func (DeleteMedicalVocabularyOutput) GoString added in v1.30.17 

func (s DeleteMedicalVocabularyOutput) 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 (DeleteMedicalVocabularyOutput) String added in v1.30.17 

func (s DeleteMedicalVocabularyOutput) 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 DeleteTranscriptionJobInput added in v1.15.52 

type DeleteTranscriptionJobInput struct {

	// The name of the transcription job you want to delete. Job names are case
	// sensitive.
	//
	// TranscriptionJobName is a required field
	TranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTranscriptionJobInput) GoString added in v1.15.52 

func (s DeleteTranscriptionJobInput) 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 (*DeleteTranscriptionJobInput) SetTranscriptionJobName added in v1.15.52 

func (s *DeleteTranscriptionJobInput) SetTranscriptionJobName(v string) *DeleteTranscriptionJobInput

SetTranscriptionJobName sets the TranscriptionJobName field's value.

func (DeleteTranscriptionJobInput) String added in v1.15.52 

func (s DeleteTranscriptionJobInput) 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 (*DeleteTranscriptionJobInput) Validate added in v1.15.52 

func (s *DeleteTranscriptionJobInput) Validate() error

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

type DeleteTranscriptionJobOutput added in v1.15.52 

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

func (DeleteTranscriptionJobOutput) GoString added in v1.15.52 

func (s DeleteTranscriptionJobOutput) 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 (DeleteTranscriptionJobOutput) String added in v1.15.52 

func (s DeleteTranscriptionJobOutput) 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 DeleteVocabularyFilterInput added in v1.26.7 

type DeleteVocabularyFilterInput struct {

	// The name of the custom vocabulary filter you want to delete. Custom vocabulary
	// filter names are case sensitive.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVocabularyFilterInput) GoString added in v1.26.7 

func (s DeleteVocabularyFilterInput) 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 (*DeleteVocabularyFilterInput) SetVocabularyFilterName added in v1.26.7 

func (s *DeleteVocabularyFilterInput) SetVocabularyFilterName(v string) *DeleteVocabularyFilterInput

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (DeleteVocabularyFilterInput) String added in v1.26.7 

func (s DeleteVocabularyFilterInput) 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 (*DeleteVocabularyFilterInput) Validate added in v1.26.7 

func (s *DeleteVocabularyFilterInput) Validate() error

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

type DeleteVocabularyFilterOutput added in v1.26.7 

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

func (DeleteVocabularyFilterOutput) GoString added in v1.26.7 

func (s DeleteVocabularyFilterOutput) 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 (DeleteVocabularyFilterOutput) String added in v1.26.7 

func (s DeleteVocabularyFilterOutput) 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 DeleteVocabularyInput added in v1.13.28 

type DeleteVocabularyInput struct {

	// The name of the custom vocabulary you want to delete. Custom vocabulary names
	// are case sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVocabularyInput) GoString added in v1.13.28 

func (s DeleteVocabularyInput) 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 (*DeleteVocabularyInput) SetVocabularyName added in v1.13.28 

func (s *DeleteVocabularyInput) SetVocabularyName(v string) *DeleteVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (DeleteVocabularyInput) String added in v1.13.28 

func (s DeleteVocabularyInput) 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 (*DeleteVocabularyInput) Validate added in v1.13.28 

func (s *DeleteVocabularyInput) Validate() error

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

type DeleteVocabularyOutput added in v1.13.28 

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

func (DeleteVocabularyOutput) GoString added in v1.13.28 

func (s DeleteVocabularyOutput) 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 (DeleteVocabularyOutput) String added in v1.13.28 

func (s DeleteVocabularyOutput) 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 DescribeLanguageModelInput added in v1.33.20 

type DescribeLanguageModelInput struct {

	// The name of the custom language model you want information about. Model names
	// are case sensitive.
	//
	// ModelName is a required field
	ModelName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeLanguageModelInput) GoString added in v1.33.20 

func (s DescribeLanguageModelInput) 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 (*DescribeLanguageModelInput) SetModelName added in v1.33.20 

func (s *DescribeLanguageModelInput) SetModelName(v string) *DescribeLanguageModelInput

SetModelName sets the ModelName field's value.

func (DescribeLanguageModelInput) String added in v1.33.20 

func (s DescribeLanguageModelInput) 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 (*DescribeLanguageModelInput) Validate added in v1.33.20 

func (s *DescribeLanguageModelInput) Validate() error

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

type DescribeLanguageModelOutput added in v1.33.20 

type DescribeLanguageModelOutput struct {

	// Provides information about the specified custom language model.
	//
	// This parameter also shows if the base language model you used to create your
	// custom language model has been updated. If Amazon Transcribe has updated
	// the base model, you can create a new custom language model using the updated
	// base model.
	//
	// If you tried to create a new custom language model and the request wasn't
	// successful, you can use this DescribeLanguageModel to help identify the reason
	// for this failure.
	LanguageModel *LanguageModel `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeLanguageModelOutput) GoString added in v1.33.20 

func (s DescribeLanguageModelOutput) 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 (*DescribeLanguageModelOutput) SetLanguageModel added in v1.33.20 

func (s *DescribeLanguageModelOutput) SetLanguageModel(v *LanguageModel) *DescribeLanguageModelOutput

SetLanguageModel sets the LanguageModel field's value.

func (DescribeLanguageModelOutput) String added in v1.33.20 

func (s DescribeLanguageModelOutput) 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 GetCallAnalyticsCategoryInput added in v1.40.15 

type GetCallAnalyticsCategoryInput struct {

	// The name of the Call Analytics category you want information about. Category
	// names are case sensitive.
	//
	// CategoryName is a required field
	CategoryName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCallAnalyticsCategoryInput) GoString added in v1.40.15 

func (s GetCallAnalyticsCategoryInput) 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 (*GetCallAnalyticsCategoryInput) SetCategoryName added in v1.40.15 

func (s *GetCallAnalyticsCategoryInput) SetCategoryName(v string) *GetCallAnalyticsCategoryInput

SetCategoryName sets the CategoryName field's value.

func (GetCallAnalyticsCategoryInput) String added in v1.40.15 

func (s GetCallAnalyticsCategoryInput) 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 (*GetCallAnalyticsCategoryInput) Validate added in v1.40.15 

func (s *GetCallAnalyticsCategoryInput) Validate() error

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

type GetCallAnalyticsCategoryOutput added in v1.40.15 

type GetCallAnalyticsCategoryOutput struct {

	// Provides you with the properties of the Call Analytics category you specified
	// in your GetCallAnalyticsCategory request.
	CategoryProperties *CategoryProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (GetCallAnalyticsCategoryOutput) GoString added in v1.40.15 

func (s GetCallAnalyticsCategoryOutput) 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 (*GetCallAnalyticsCategoryOutput) SetCategoryProperties added in v1.40.15 

func (s *GetCallAnalyticsCategoryOutput) SetCategoryProperties(v *CategoryProperties) *GetCallAnalyticsCategoryOutput

SetCategoryProperties sets the CategoryProperties field's value.

func (GetCallAnalyticsCategoryOutput) String added in v1.40.15 

func (s GetCallAnalyticsCategoryOutput) 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 GetCallAnalyticsJobInput added in v1.40.15 

type GetCallAnalyticsJobInput struct {

	// The name of the Call Analytics job you want information about. Job names
	// are case sensitive.
	//
	// CallAnalyticsJobName is a required field
	CallAnalyticsJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCallAnalyticsJobInput) GoString added in v1.40.15 

func (s GetCallAnalyticsJobInput) 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 (*GetCallAnalyticsJobInput) SetCallAnalyticsJobName added in v1.40.15 

func (s *GetCallAnalyticsJobInput) SetCallAnalyticsJobName(v string) *GetCallAnalyticsJobInput

SetCallAnalyticsJobName sets the CallAnalyticsJobName field's value.

func (GetCallAnalyticsJobInput) String added in v1.40.15 

func (s GetCallAnalyticsJobInput) 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 (*GetCallAnalyticsJobInput) Validate added in v1.40.15 

func (s *GetCallAnalyticsJobInput) Validate() error

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

type GetCallAnalyticsJobOutput added in v1.40.15 

type GetCallAnalyticsJobOutput struct {

	// Provides detailed information about the specified Call Analytics job, including
	// job status and, if applicable, failure reason.
	CallAnalyticsJob *CallAnalyticsJob `type:"structure"`
	// contains filtered or unexported fields
}

func (GetCallAnalyticsJobOutput) GoString added in v1.40.15 

func (s GetCallAnalyticsJobOutput) 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 (*GetCallAnalyticsJobOutput) SetCallAnalyticsJob added in v1.40.15 

func (s *GetCallAnalyticsJobOutput) SetCallAnalyticsJob(v *CallAnalyticsJob) *GetCallAnalyticsJobOutput

SetCallAnalyticsJob sets the CallAnalyticsJob field's value.

func (GetCallAnalyticsJobOutput) String added in v1.40.15 

func (s GetCallAnalyticsJobOutput) 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 GetMedicalScribeJobInput added in v1.48.5 

type GetMedicalScribeJobInput struct {

	// The name of the Medical Scribe job you want information about. Job names
	// are case sensitive.
	//
	// MedicalScribeJobName is a required field
	MedicalScribeJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMedicalScribeJobInput) GoString added in v1.48.5 

func (s GetMedicalScribeJobInput) 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 (*GetMedicalScribeJobInput) SetMedicalScribeJobName added in v1.48.5 

func (s *GetMedicalScribeJobInput) SetMedicalScribeJobName(v string) *GetMedicalScribeJobInput

SetMedicalScribeJobName sets the MedicalScribeJobName field's value.

func (GetMedicalScribeJobInput) String added in v1.48.5 

func (s GetMedicalScribeJobInput) 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 (*GetMedicalScribeJobInput) Validate added in v1.48.5 

func (s *GetMedicalScribeJobInput) Validate() error

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

type GetMedicalScribeJobOutput added in v1.48.5 

type GetMedicalScribeJobOutput struct {

	// Provides detailed information about the specified Medical Scribe job, including
	// job status and, if applicable, failure reason
	MedicalScribeJob *MedicalScribeJob `type:"structure"`
	// contains filtered or unexported fields
}

func (GetMedicalScribeJobOutput) GoString added in v1.48.5 

func (s GetMedicalScribeJobOutput) 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 (*GetMedicalScribeJobOutput) SetMedicalScribeJob added in v1.48.5 

func (s *GetMedicalScribeJobOutput) SetMedicalScribeJob(v *MedicalScribeJob) *GetMedicalScribeJobOutput

SetMedicalScribeJob sets the MedicalScribeJob field's value.

func (GetMedicalScribeJobOutput) String added in v1.48.5 

func (s GetMedicalScribeJobOutput) 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 GetMedicalTranscriptionJobInput added in v1.30.5 

type GetMedicalTranscriptionJobInput struct {

	// The name of the medical transcription job you want information about. Job
	// names are case sensitive.
	//
	// MedicalTranscriptionJobName is a required field
	MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMedicalTranscriptionJobInput) GoString added in v1.30.5 

func (s GetMedicalTranscriptionJobInput) 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 (*GetMedicalTranscriptionJobInput) SetMedicalTranscriptionJobName added in v1.30.5 

func (s *GetMedicalTranscriptionJobInput) SetMedicalTranscriptionJobName(v string) *GetMedicalTranscriptionJobInput

SetMedicalTranscriptionJobName sets the MedicalTranscriptionJobName field's value.

func (GetMedicalTranscriptionJobInput) String added in v1.30.5 

func (s GetMedicalTranscriptionJobInput) 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 (*GetMedicalTranscriptionJobInput) Validate added in v1.30.5 

func (s *GetMedicalTranscriptionJobInput) Validate() error

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

type GetMedicalTranscriptionJobOutput added in v1.30.5 

type GetMedicalTranscriptionJobOutput struct {

	// Provides detailed information about the specified medical transcription job,
	// including job status and, if applicable, failure reason.
	MedicalTranscriptionJob *MedicalTranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (GetMedicalTranscriptionJobOutput) GoString added in v1.30.5 

func (s GetMedicalTranscriptionJobOutput) 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 (*GetMedicalTranscriptionJobOutput) SetMedicalTranscriptionJob added in v1.30.5 

func (s *GetMedicalTranscriptionJobOutput) SetMedicalTranscriptionJob(v *MedicalTranscriptionJob) *GetMedicalTranscriptionJobOutput

SetMedicalTranscriptionJob sets the MedicalTranscriptionJob field's value.

func (GetMedicalTranscriptionJobOutput) String added in v1.30.5 

func (s GetMedicalTranscriptionJobOutput) 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 GetMedicalVocabularyInput added in v1.30.17 

type GetMedicalVocabularyInput struct {

	// The name of the custom medical vocabulary you want information about. Custom
	// medical vocabulary names are case sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMedicalVocabularyInput) GoString added in v1.30.17 

func (s GetMedicalVocabularyInput) 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 (*GetMedicalVocabularyInput) SetVocabularyName added in v1.30.17 

func (s *GetMedicalVocabularyInput) SetVocabularyName(v string) *GetMedicalVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (GetMedicalVocabularyInput) String added in v1.30.17 

func (s GetMedicalVocabularyInput) 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 (*GetMedicalVocabularyInput) Validate added in v1.30.17 

func (s *GetMedicalVocabularyInput) Validate() error

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

type GetMedicalVocabularyOutput added in v1.30.17 

type GetMedicalVocabularyOutput struct {

	// The Amazon S3 location where the specified custom medical vocabulary is stored;
	// use this URI to view or download the custom vocabulary.
	DownloadUri *string `min:"1" type:"string"`

	// If VocabularyState is FAILED, FailureReason contains information about why
	// the custom medical vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code you selected for your custom medical vocabulary. US English
	// (en-US) is the only language supported with Amazon Transcribe Medical.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom medical vocabulary was last modified.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the custom medical vocabulary you requested information about.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom medical vocabulary. If the state is READY,
	// you can use the custom vocabulary in a StartMedicalTranscriptionJob request.
	VocabularyState *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (GetMedicalVocabularyOutput) GoString added in v1.30.17 

func (s GetMedicalVocabularyOutput) 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 (*GetMedicalVocabularyOutput) SetDownloadUri added in v1.30.17 

func (s *GetMedicalVocabularyOutput) SetDownloadUri(v string) *GetMedicalVocabularyOutput

SetDownloadUri sets the DownloadUri field's value.

func (*GetMedicalVocabularyOutput) SetFailureReason added in v1.30.17 

func (s *GetMedicalVocabularyOutput) SetFailureReason(v string) *GetMedicalVocabularyOutput

SetFailureReason sets the FailureReason field's value.

func (*GetMedicalVocabularyOutput) SetLanguageCode added in v1.30.17 

func (s *GetMedicalVocabularyOutput) SetLanguageCode(v string) *GetMedicalVocabularyOutput

SetLanguageCode sets the LanguageCode field's value.

func (*GetMedicalVocabularyOutput) SetLastModifiedTime added in v1.30.17 

func (s *GetMedicalVocabularyOutput) SetLastModifiedTime(v time.Time) *GetMedicalVocabularyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*GetMedicalVocabularyOutput) SetVocabularyName added in v1.30.17 

func (s *GetMedicalVocabularyOutput) SetVocabularyName(v string) *GetMedicalVocabularyOutput

SetVocabularyName sets the VocabularyName field's value.

func (*GetMedicalVocabularyOutput) SetVocabularyState added in v1.30.17 

func (s *GetMedicalVocabularyOutput) SetVocabularyState(v string) *GetMedicalVocabularyOutput

SetVocabularyState sets the VocabularyState field's value.

func (GetMedicalVocabularyOutput) String added in v1.30.17 

func (s GetMedicalVocabularyOutput) 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 GetTranscriptionJobInput 

type GetTranscriptionJobInput struct {

	// The name of the transcription job you want information about. Job names are
	// case sensitive.
	//
	// TranscriptionJobName is a required field
	TranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTranscriptionJobInput) GoString 

func (s GetTranscriptionJobInput) 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 (*GetTranscriptionJobInput) SetTranscriptionJobName 

func (s *GetTranscriptionJobInput) SetTranscriptionJobName(v string) *GetTranscriptionJobInput

SetTranscriptionJobName sets the TranscriptionJobName field's value.

func (GetTranscriptionJobInput) String 

func (s GetTranscriptionJobInput) 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 (*GetTranscriptionJobInput) Validate 

func (s *GetTranscriptionJobInput) Validate() error

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

type GetTranscriptionJobOutput 

type GetTranscriptionJobOutput struct {

	// Provides detailed information about the specified transcription job, including
	// job status and, if applicable, failure reason.
	TranscriptionJob *TranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTranscriptionJobOutput) GoString 

func (s GetTranscriptionJobOutput) 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 (*GetTranscriptionJobOutput) SetTranscriptionJob 

func (s *GetTranscriptionJobOutput) SetTranscriptionJob(v *TranscriptionJob) *GetTranscriptionJobOutput

SetTranscriptionJob sets the TranscriptionJob field's value.

func (GetTranscriptionJobOutput) String 

func (s GetTranscriptionJobOutput) 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 GetVocabularyFilterInput added in v1.26.7 

type GetVocabularyFilterInput struct {

	// The name of the custom vocabulary filter you want information about. Custom
	// vocabulary filter names are case sensitive.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetVocabularyFilterInput) GoString added in v1.26.7 

func (s GetVocabularyFilterInput) 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 (*GetVocabularyFilterInput) SetVocabularyFilterName added in v1.26.7 

func (s *GetVocabularyFilterInput) SetVocabularyFilterName(v string) *GetVocabularyFilterInput

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (GetVocabularyFilterInput) String added in v1.26.7 

func (s GetVocabularyFilterInput) 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 (*GetVocabularyFilterInput) Validate added in v1.26.7 

func (s *GetVocabularyFilterInput) Validate() error

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

type GetVocabularyFilterOutput added in v1.26.7 

type GetVocabularyFilterOutput struct {

	// The Amazon S3 location where the custom vocabulary filter is stored; use
	// this URI to view or download the custom vocabulary filter.
	DownloadUri *string `min:"1" type:"string"`

	// The language code you selected for your custom vocabulary filter.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom vocabulary filter was last modified.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the custom vocabulary filter you requested information about.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetVocabularyFilterOutput) GoString added in v1.26.7 

func (s GetVocabularyFilterOutput) 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 (*GetVocabularyFilterOutput) SetDownloadUri added in v1.26.7 

func (s *GetVocabularyFilterOutput) SetDownloadUri(v string) *GetVocabularyFilterOutput

SetDownloadUri sets the DownloadUri field's value.

func (*GetVocabularyFilterOutput) SetLanguageCode added in v1.26.7 

func (s *GetVocabularyFilterOutput) SetLanguageCode(v string) *GetVocabularyFilterOutput

SetLanguageCode sets the LanguageCode field's value.

func (*GetVocabularyFilterOutput) SetLastModifiedTime added in v1.26.7 

func (s *GetVocabularyFilterOutput) SetLastModifiedTime(v time.Time) *GetVocabularyFilterOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*GetVocabularyFilterOutput) SetVocabularyFilterName added in v1.26.7 

func (s *GetVocabularyFilterOutput) SetVocabularyFilterName(v string) *GetVocabularyFilterOutput

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (GetVocabularyFilterOutput) String added in v1.26.7 

func (s GetVocabularyFilterOutput) 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 GetVocabularyInput added in v1.13.28 

type GetVocabularyInput struct {

	// The name of the custom vocabulary you want information about. Custom vocabulary
	// names are case sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetVocabularyInput) GoString added in v1.13.28 

func (s GetVocabularyInput) 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 (*GetVocabularyInput) SetVocabularyName added in v1.13.28 

func (s *GetVocabularyInput) SetVocabularyName(v string) *GetVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (GetVocabularyInput) String added in v1.13.28 

func (s GetVocabularyInput) 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 (*GetVocabularyInput) Validate added in v1.13.28 

func (s *GetVocabularyInput) Validate() error

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

type GetVocabularyOutput added in v1.13.28 

type GetVocabularyOutput struct {

	// The Amazon S3 location where the custom vocabulary is stored; use this URI
	// to view or download the custom vocabulary.
	DownloadUri *string `min:"1" type:"string"`

	// If VocabularyState is FAILED, FailureReason contains information about why
	// the custom vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code you selected for your custom vocabulary.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom vocabulary was last modified.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the custom vocabulary you requested information about.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom vocabulary. If the state is READY, you
	// can use the custom vocabulary in a StartTranscriptionJob request.
	VocabularyState *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (GetVocabularyOutput) GoString added in v1.13.28 

func (s GetVocabularyOutput) 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 (*GetVocabularyOutput) SetDownloadUri added in v1.13.28 

func (s *GetVocabularyOutput) SetDownloadUri(v string) *GetVocabularyOutput

SetDownloadUri sets the DownloadUri field's value.

func (*GetVocabularyOutput) SetFailureReason added in v1.13.28 

func (s *GetVocabularyOutput) SetFailureReason(v string) *GetVocabularyOutput

SetFailureReason sets the FailureReason field's value.

func (*GetVocabularyOutput) SetLanguageCode added in v1.13.28 

func (s *GetVocabularyOutput) SetLanguageCode(v string) *GetVocabularyOutput

SetLanguageCode sets the LanguageCode field's value.

func (*GetVocabularyOutput) SetLastModifiedTime added in v1.13.28 

func (s *GetVocabularyOutput) SetLastModifiedTime(v time.Time) *GetVocabularyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*GetVocabularyOutput) SetVocabularyName added in v1.13.28 

func (s *GetVocabularyOutput) SetVocabularyName(v string) *GetVocabularyOutput

SetVocabularyName sets the VocabularyName field's value.

func (*GetVocabularyOutput) SetVocabularyState added in v1.13.28 

func (s *GetVocabularyOutput) SetVocabularyState(v string) *GetVocabularyOutput

SetVocabularyState sets the VocabularyState field's value.

func (GetVocabularyOutput) String added in v1.13.28 

func (s GetVocabularyOutput) 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 added in v1.33.20 

type InputDataConfig struct {

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files. If the role that you
	// specify doesn’t have the appropriate permissions to access the specified
	// Amazon S3 location, your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The Amazon S3 location (URI) of the text files you want to use to train your
	// custom language model.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
	//
	// S3Uri is a required field
	S3Uri *string `min:"1" type:"string" required:"true"`

	// The Amazon S3 location (URI) of the text files you want to use to tune your
	// custom language model.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
	TuningDataS3Uri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

When using InputDataConfig, you must include these sub-parameters: S3Uri and DataAccessRoleArn. You can optionally include TuningDataS3Uri.

func (InputDataConfig) GoString added in v1.33.20 

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) SetDataAccessRoleArn added in v1.33.20 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*InputDataConfig) SetS3Uri added in v1.33.20 

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

SetS3Uri sets the S3Uri field's value.

func (*InputDataConfig) SetTuningDataS3Uri added in v1.33.20 

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

SetTuningDataS3Uri sets the TuningDataS3Uri field's value.

func (InputDataConfig) String added in v1.33.20 

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 added in v1.33.20 

func (s *InputDataConfig) Validate() error

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

type InternalFailureException added in v1.28.0 

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

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

There was an internal error. Check the error message, correct the issue, and try your request again.

func (*InternalFailureException) Code added in v1.28.0 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error added in v1.28.0 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString added in v1.28.0 

func (s InternalFailureException) 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 (*InternalFailureException) Message added in v1.28.0 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr added in v1.28.0 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0 

func (s *InternalFailureException) StatusCode() int

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

func (InternalFailureException) String added in v1.28.0 

func (s InternalFailureException) 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 InterruptionFilter added in v1.40.15 

type InterruptionFilter struct {

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for an interruption. See for more detail.
	AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"`

	// Set to TRUE to flag speech that does not contain interruptions. Set to FALSE
	// to flag speech that contains interruptions.
	Negate *bool `type:"boolean"`

	// Specify the interrupter that you want to flag. Omitting this parameter is
	// equivalent to specifying both participants.
	ParticipantRole *string `type:"string" enum:"ParticipantRole"`

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for an interruption. See for more detail.
	RelativeTimeRange *RelativeTimeRange `type:"structure"`

	// Specify the duration of the interruptions in milliseconds. For example, you
	// can flag speech that contains more than 10,000 milliseconds of interruptions.
	Threshold *int64 `type:"long"`
	// contains filtered or unexported fields
}

Flag the presence or absence of interruptions in your Call Analytics transcription output.

Rules using InterruptionFilter are designed to match:

  • Instances where an agent interrupts a customer

  • Instances where a customer interrupts an agent

  • Either participant interrupting the other

  • A lack of interruptions

See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) for usage examples.

func (InterruptionFilter) GoString added in v1.40.15 

func (s InterruptionFilter) 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 (*InterruptionFilter) SetAbsoluteTimeRange added in v1.40.15 

func (s *InterruptionFilter) SetAbsoluteTimeRange(v *AbsoluteTimeRange) *InterruptionFilter

SetAbsoluteTimeRange sets the AbsoluteTimeRange field's value.

func (*InterruptionFilter) SetNegate added in v1.40.15 

func (s *InterruptionFilter) SetNegate(v bool) *InterruptionFilter

SetNegate sets the Negate field's value.

func (*InterruptionFilter) SetParticipantRole added in v1.40.15 

func (s *InterruptionFilter) SetParticipantRole(v string) *InterruptionFilter

SetParticipantRole sets the ParticipantRole field's value.

func (*InterruptionFilter) SetRelativeTimeRange added in v1.40.15 

func (s *InterruptionFilter) SetRelativeTimeRange(v *RelativeTimeRange) *InterruptionFilter

SetRelativeTimeRange sets the RelativeTimeRange field's value.

func (*InterruptionFilter) SetThreshold added in v1.40.15 

func (s *InterruptionFilter) SetThreshold(v int64) *InterruptionFilter

SetThreshold sets the Threshold field's value.

func (InterruptionFilter) String added in v1.40.15 

func (s InterruptionFilter) 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 JobExecutionSettings added in v1.26.6 

type JobExecutionSettings struct {

	// Makes it possible to enable job queuing when your concurrent request limit
	// is exceeded. When AllowDeferredExecution is set to true, transcription job
	// requests are placed in a queue until the number of jobs falls below the concurrent
	// request limit. If AllowDeferredExecution is set to false and the number of
	// transcription job requests exceed the concurrent request limit, you get a
	// LimitExceededException error.
	//
	// If you include AllowDeferredExecution in your request, you must also include
	// DataAccessRoleArn.
	AllowDeferredExecution *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files. If the role that you
	// specify doesn’t have the appropriate permissions to access the specified
	// Amazon S3 location, your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin. For more information,
	// see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	//
	// Note that if you include DataAccessRoleArn in your request, you must also
	// include AllowDeferredExecution.
	DataAccessRoleArn *string `min:"20" type:"string"`
	// contains filtered or unexported fields
}

Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.

func (JobExecutionSettings) GoString added in v1.26.6 

func (s JobExecutionSettings) 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 (*JobExecutionSettings) SetAllowDeferredExecution added in v1.26.6 

func (s *JobExecutionSettings) SetAllowDeferredExecution(v bool) *JobExecutionSettings

SetAllowDeferredExecution sets the AllowDeferredExecution field's value.

func (*JobExecutionSettings) SetDataAccessRoleArn added in v1.26.6 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (JobExecutionSettings) String added in v1.26.6 

func (s JobExecutionSettings) 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 (*JobExecutionSettings) Validate added in v1.33.20 

func (s *JobExecutionSettings) Validate() error

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

type LanguageCodeItem added in v1.44.25 

type LanguageCodeItem struct {

	// Provides the total time, in seconds, each identified language is spoken in
	// your media.
	DurationInSeconds *float64 `type:"float"`

	// Provides the language code for each language identified in your media.
	LanguageCode *string `type:"string" enum:"LanguageCode"`
	// contains filtered or unexported fields
}

Provides information on the speech contained in a discreet utterance when multi-language identification is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a different language.

func (LanguageCodeItem) GoString added in v1.44.25 

func (s LanguageCodeItem) 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 (*LanguageCodeItem) SetDurationInSeconds added in v1.44.25 

func (s *LanguageCodeItem) SetDurationInSeconds(v float64) *LanguageCodeItem

SetDurationInSeconds sets the DurationInSeconds field's value.

func (*LanguageCodeItem) SetLanguageCode added in v1.44.25 

func (s *LanguageCodeItem) SetLanguageCode(v string) *LanguageCodeItem

SetLanguageCode sets the LanguageCode field's value.

func (LanguageCodeItem) String added in v1.44.25 

func (s LanguageCodeItem) 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 LanguageIdSettings added in v1.41.14 

type LanguageIdSettings struct {

	// The name of the custom language model you want to use when processing your
	// transcription job. Note that custom language model names are case sensitive.
	//
	// The language of the specified custom language model must match the language
	// code that you specify in your transcription request. If the languages do
	// not match, the custom language model isn't applied. There are no errors or
	// warnings associated with a language mismatch.
	LanguageModelName *string `min:"1" type:"string"`

	// The name of the custom vocabulary filter you want to use when processing
	// your transcription job. Custom vocabulary filter names are case sensitive.
	//
	// The language of the specified custom vocabulary filter must match the language
	// code that you specify in your transcription request. If the languages do
	// not match, the custom vocabulary filter isn't applied. There are no errors
	// or warnings associated with a language mismatch.
	//
	// Note that if you include VocabularyFilterName in your request, you must also
	// include VocabularyFilterMethod.
	VocabularyFilterName *string `min:"1" type:"string"`

	// The name of the custom vocabulary you want to use when processing your transcription
	// job. Custom vocabulary names are case sensitive.
	//
	// The language of the specified custom vocabulary must match the language code
	// that you specify in your transcription request. If the languages do not match,
	// the custom vocabulary isn't applied. There are no errors or warnings associated
	// with a language mismatch.
	VocabularyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification (IdentifyMultipleLanguages) doesn't support custom language models.

LanguageIdSettings supports two to five language codes. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The language codes that you specify must match the languages of the associated custom language models, custom vocabularies, and custom vocabulary filters.

It's recommended that you include LanguageOptions when using LanguageIdSettings to ensure that the correct language dialect is identified. For example, if you specify a custom vocabulary that is in en-US but Amazon Transcribe determines that the language spoken in your media is en-AU, your custom vocabulary is not applied to your transcription. If you include LanguageOptions and include en-US as the only English language dialect, your custom vocabulary is applied to your transcription.

If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.

func (LanguageIdSettings) GoString added in v1.41.14 

func (s LanguageIdSettings) 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 (*LanguageIdSettings) SetLanguageModelName added in v1.41.14 

func (s *LanguageIdSettings) SetLanguageModelName(v string) *LanguageIdSettings

SetLanguageModelName sets the LanguageModelName field's value.

func (*LanguageIdSettings) SetVocabularyFilterName added in v1.41.14 

func (s *LanguageIdSettings) SetVocabularyFilterName(v string) *LanguageIdSettings

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*LanguageIdSettings) SetVocabularyName added in v1.41.14 

func (s *LanguageIdSettings) SetVocabularyName(v string) *LanguageIdSettings

SetVocabularyName sets the VocabularyName field's value.

func (LanguageIdSettings) String added in v1.41.14 

func (s LanguageIdSettings) 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 (*LanguageIdSettings) Validate added in v1.41.14 

func (s *LanguageIdSettings) Validate() error

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

type LanguageModel added in v1.33.20 

type LanguageModel struct {

	// The Amazon Transcribe standard language model, or base model, used to create
	// your custom language model.
	BaseModelName *string `type:"string" enum:"BaseModelName"`

	// The date and time the specified custom language model was created.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	CreateTime *time.Time `type:"timestamp"`

	// If ModelStatus is FAILED, FailureReason contains information about why the
	// custom language model request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The Amazon S3 location of the input files used to train and tune your custom
	// language model, in addition to the data access role ARN (Amazon Resource
	// Name) that has permissions to access these data.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The language code used to create your custom language model. Each custom
	// language model must contain terms in only one language, and the language
	// you select for your custom language model must match the language of your
	// training and tuning data.
	//
	// For a list of supported languages and their associated language codes, refer
	// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table. Note that US English (en-US) is the only language supported with Amazon
	// Transcribe Medical.
	LanguageCode *string `type:"string" enum:"CLMLanguageCode"`

	// The date and time the specified custom language model was last modified.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// A unique name, chosen by you, for your custom language model.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account.
	ModelName *string `min:"1" type:"string"`

	// The status of the specified custom language model. When the status displays
	// as COMPLETED the model is ready for use.
	ModelStatus *string `type:"string" enum:"ModelStatus"`

	// Shows if a more current base model is available for use with the specified
	// custom language model.
	//
	// If false, your custom language model is using the most up-to-date base model.
	//
	// If true, there is a newer base model available than the one your language
	// model is using.
	//
	// Note that to update a base model, you must recreate the custom language model
	// using the new base model. Base model upgrades for existing custom language
	// models are not supported.
	UpgradeAvailability *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides information about a custom language model, including:

  • The base model name

  • When the model was created

  • The location of the files used to train the model

  • When the model was last modified

  • The name you chose for the model

  • The model's language

  • The model's processing state

  • Any available upgrades for the base model

func (LanguageModel) GoString added in v1.33.20 

func (s LanguageModel) 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 (*LanguageModel) SetBaseModelName added in v1.33.20 

func (s *LanguageModel) SetBaseModelName(v string) *LanguageModel

SetBaseModelName sets the BaseModelName field's value.

func (*LanguageModel) SetCreateTime added in v1.33.20 

func (s *LanguageModel) SetCreateTime(v time.Time) *LanguageModel

SetCreateTime sets the CreateTime field's value.

func (*LanguageModel) SetFailureReason added in v1.33.20 

func (s *LanguageModel) SetFailureReason(v string) *LanguageModel

SetFailureReason sets the FailureReason field's value.

func (*LanguageModel) SetInputDataConfig added in v1.33.20 

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

SetInputDataConfig sets the InputDataConfig field's value.

func (*LanguageModel) SetLanguageCode added in v1.33.20 

func (s *LanguageModel) SetLanguageCode(v string) *LanguageModel

SetLanguageCode sets the LanguageCode field's value.

func (*LanguageModel) SetLastModifiedTime added in v1.33.20 

func (s *LanguageModel) SetLastModifiedTime(v time.Time) *LanguageModel

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*LanguageModel) SetModelName added in v1.33.20 

func (s *LanguageModel) SetModelName(v string) *LanguageModel

SetModelName sets the ModelName field's value.

func (*LanguageModel) SetModelStatus added in v1.33.20 

func (s *LanguageModel) SetModelStatus(v string) *LanguageModel

SetModelStatus sets the ModelStatus field's value.

func (*LanguageModel) SetUpgradeAvailability added in v1.33.20 

func (s *LanguageModel) SetUpgradeAvailability(v bool) *LanguageModel

SetUpgradeAvailability sets the UpgradeAvailability field's value.

func (LanguageModel) String added in v1.33.20 

func (s LanguageModel) 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 LimitExceededException added in v1.28.0 

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

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

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) 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 (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) 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 ListCallAnalyticsCategoriesInput added in v1.40.15 

type ListCallAnalyticsCategoriesInput struct {

	// The maximum number of Call Analytics categories to return in each page of
	// results. If there are fewer results than the value that you specify, only
	// the actual results are returned. If you do not specify a value, a default
	// of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// If your ListCallAnalyticsCategories request returns more results than can
	// be displayed, NextToken is displayed in the response with an associated string.
	// To get the next page of results, copy this string and repeat your request,
	// including NextToken with the value of the copied string. Repeat as needed
	// to view all your results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCallAnalyticsCategoriesInput) GoString added in v1.40.15 

func (s ListCallAnalyticsCategoriesInput) 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 (*ListCallAnalyticsCategoriesInput) SetMaxResults added in v1.40.15 

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

SetMaxResults sets the MaxResults field's value.

func (*ListCallAnalyticsCategoriesInput) SetNextToken added in v1.40.15 

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

SetNextToken sets the NextToken field's value.

func (ListCallAnalyticsCategoriesInput) String added in v1.40.15 

func (s ListCallAnalyticsCategoriesInput) 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 (*ListCallAnalyticsCategoriesInput) Validate added in v1.40.15 

func (s *ListCallAnalyticsCategoriesInput) Validate() error

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

type ListCallAnalyticsCategoriesOutput added in v1.40.15 

type ListCallAnalyticsCategoriesOutput struct {

	// Provides detailed information about your Call Analytics categories, including
	// all the rules associated with each category.
	Categories []*CategoryProperties `type:"list"`

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCallAnalyticsCategoriesOutput) GoString added in v1.40.15 

func (s ListCallAnalyticsCategoriesOutput) 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 (*ListCallAnalyticsCategoriesOutput) SetCategories added in v1.40.15 

func (s *ListCallAnalyticsCategoriesOutput) SetCategories(v []*CategoryProperties) *ListCallAnalyticsCategoriesOutput

SetCategories sets the Categories field's value.

func (*ListCallAnalyticsCategoriesOutput) SetNextToken added in v1.40.15 

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

SetNextToken sets the NextToken field's value.

func (ListCallAnalyticsCategoriesOutput) String added in v1.40.15 

func (s ListCallAnalyticsCategoriesOutput) 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 ListCallAnalyticsJobsInput added in v1.40.15 

type ListCallAnalyticsJobsInput struct {

	// Returns only the Call Analytics jobs that contain the specified string. The
	// search is not case sensitive.
	JobNameContains *string `min:"1" type:"string"`

	// The maximum number of Call Analytics jobs to return in each page of results.
	// If there are fewer results than the value that you specify, only the actual
	// results are returned. If you do not specify a value, a default of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// If your ListCallAnalyticsJobs request returns more results than can be displayed,
	// NextToken is displayed in the response with an associated string. To get
	// the next page of results, copy this string and repeat your request, including
	// NextToken with the value of the copied string. Repeat as needed to view all
	// your results.
	NextToken *string `type:"string"`

	// Returns only Call Analytics jobs with the specified status. Jobs are ordered
	// by creation date, with the newest job first. If you do not include Status,
	// all Call Analytics jobs are returned.
	Status *string `type:"string" enum:"CallAnalyticsJobStatus"`
	// contains filtered or unexported fields
}

func (ListCallAnalyticsJobsInput) GoString added in v1.40.15 

func (s ListCallAnalyticsJobsInput) 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 (*ListCallAnalyticsJobsInput) SetJobNameContains added in v1.40.15 

func (s *ListCallAnalyticsJobsInput) SetJobNameContains(v string) *ListCallAnalyticsJobsInput

SetJobNameContains sets the JobNameContains field's value.

func (*ListCallAnalyticsJobsInput) SetMaxResults added in v1.40.15 

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

SetMaxResults sets the MaxResults field's value.

func (*ListCallAnalyticsJobsInput) SetNextToken added in v1.40.15 

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

SetNextToken sets the NextToken field's value.

func (*ListCallAnalyticsJobsInput) SetStatus added in v1.40.15 

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

SetStatus sets the Status field's value.

func (ListCallAnalyticsJobsInput) String added in v1.40.15 

func (s ListCallAnalyticsJobsInput) 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 (*ListCallAnalyticsJobsInput) Validate added in v1.40.15 

func (s *ListCallAnalyticsJobsInput) Validate() error

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

type ListCallAnalyticsJobsOutput added in v1.40.15 

type ListCallAnalyticsJobsOutput struct {

	// Provides a summary of information about each result.
	CallAnalyticsJobSummaries []*CallAnalyticsJobSummary `type:"list"`

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`

	// Lists all Call Analytics jobs that have the status specified in your request.
	// Jobs are ordered by creation date, with the newest job first.
	Status *string `type:"string" enum:"CallAnalyticsJobStatus"`
	// contains filtered or unexported fields
}

func (ListCallAnalyticsJobsOutput) GoString added in v1.40.15 

func (s ListCallAnalyticsJobsOutput) 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 (*ListCallAnalyticsJobsOutput) SetCallAnalyticsJobSummaries added in v1.40.15 

func (s *ListCallAnalyticsJobsOutput) SetCallAnalyticsJobSummaries(v []*CallAnalyticsJobSummary) *ListCallAnalyticsJobsOutput

SetCallAnalyticsJobSummaries sets the CallAnalyticsJobSummaries field's value.

func (*ListCallAnalyticsJobsOutput) SetNextToken added in v1.40.15 

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

SetNextToken sets the NextToken field's value.

func (*ListCallAnalyticsJobsOutput) SetStatus added in v1.40.15 

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

SetStatus sets the Status field's value.

func (ListCallAnalyticsJobsOutput) String added in v1.40.15 

func (s ListCallAnalyticsJobsOutput) 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 ListLanguageModelsInput added in v1.33.20 

type ListLanguageModelsInput struct {

	// The maximum number of custom language models to return in each page of results.
	// If there are fewer results than the value that you specify, only the actual
	// results are returned. If you do not specify a value, a default of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// Returns only the custom language models that contain the specified string.
	// The search is not case sensitive.
	NameContains *string `min:"1" type:"string"`

	// If your ListLanguageModels request returns more results than can be displayed,
	// NextToken is displayed in the response with an associated string. To get
	// the next page of results, copy this string and repeat your request, including
	// NextToken with the value of the copied string. Repeat as needed to view all
	// your results.
	NextToken *string `type:"string"`

	// Returns only custom language models with the specified status. Language models
	// are ordered by creation date, with the newest model first. If you do not
	// include StatusEquals, all custom language models are returned.
	StatusEquals *string `type:"string" enum:"ModelStatus"`
	// contains filtered or unexported fields
}

func (ListLanguageModelsInput) GoString added in v1.33.20 

func (s ListLanguageModelsInput) 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 (*ListLanguageModelsInput) SetMaxResults added in v1.33.20 

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

SetMaxResults sets the MaxResults field's value.

func (*ListLanguageModelsInput) SetNameContains added in v1.33.20 

func (s *ListLanguageModelsInput) SetNameContains(v string) *ListLanguageModelsInput

SetNameContains sets the NameContains field's value.

func (*ListLanguageModelsInput) SetNextToken added in v1.33.20 

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

SetNextToken sets the NextToken field's value.

func (*ListLanguageModelsInput) SetStatusEquals added in v1.33.20 

func (s *ListLanguageModelsInput) SetStatusEquals(v string) *ListLanguageModelsInput

SetStatusEquals sets the StatusEquals field's value.

func (ListLanguageModelsInput) String added in v1.33.20 

func (s ListLanguageModelsInput) 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 (*ListLanguageModelsInput) Validate added in v1.33.20 

func (s *ListLanguageModelsInput) Validate() error

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

type ListLanguageModelsOutput added in v1.33.20 

type ListLanguageModelsOutput struct {

	// Provides information about the custom language models that match the criteria
	// specified in your request.
	Models []*LanguageModel `type:"list"`

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLanguageModelsOutput) GoString added in v1.33.20 

func (s ListLanguageModelsOutput) 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 (*ListLanguageModelsOutput) SetModels added in v1.33.20 

func (s *ListLanguageModelsOutput) SetModels(v []*LanguageModel) *ListLanguageModelsOutput

SetModels sets the Models field's value.

func (*ListLanguageModelsOutput) SetNextToken added in v1.33.20 

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

SetNextToken sets the NextToken field's value.

func (ListLanguageModelsOutput) String added in v1.33.20 

func (s ListLanguageModelsOutput) 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 ListMedicalScribeJobsInput added in v1.48.5 

type ListMedicalScribeJobsInput struct {

	// Returns only the Medical Scribe jobs that contain the specified string. The
	// search is not case sensitive.
	JobNameContains *string `min:"1" type:"string"`

	// The maximum number of Medical Scribe jobs to return in each page of results.
	// If there are fewer results than the value that you specify, only the actual
	// results are returned. If you do not specify a value, a default of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// If your ListMedicalScribeJobs request returns more results than can be displayed,
	// NextToken is displayed in the response with an associated string. To get
	// the next page of results, copy this string and repeat your request, including
	// NextToken with the value of the copied string. Repeat as needed to view all
	// your results.
	NextToken *string `type:"string"`

	// Returns only Medical Scribe jobs with the specified status. Jobs are ordered
	// by creation date, with the newest job first. If you do not include Status,
	// all Medical Scribe jobs are returned.
	Status *string `type:"string" enum:"MedicalScribeJobStatus"`
	// contains filtered or unexported fields
}

func (ListMedicalScribeJobsInput) GoString added in v1.48.5 

func (s ListMedicalScribeJobsInput) 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 (*ListMedicalScribeJobsInput) SetJobNameContains added in v1.48.5 

func (s *ListMedicalScribeJobsInput) SetJobNameContains(v string) *ListMedicalScribeJobsInput

SetJobNameContains sets the JobNameContains field's value.

func (*ListMedicalScribeJobsInput) SetMaxResults added in v1.48.5 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMedicalScribeJobsInput) SetNextToken added in v1.48.5 

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

SetNextToken sets the NextToken field's value.

func (*ListMedicalScribeJobsInput) SetStatus added in v1.48.5 

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

SetStatus sets the Status field's value.

func (ListMedicalScribeJobsInput) String added in v1.48.5 

func (s ListMedicalScribeJobsInput) 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 (*ListMedicalScribeJobsInput) Validate added in v1.48.5 

func (s *ListMedicalScribeJobsInput) Validate() error

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

type ListMedicalScribeJobsOutput added in v1.48.5 

type ListMedicalScribeJobsOutput struct {

	// Provides a summary of information about each result.
	MedicalScribeJobSummaries []*MedicalScribeJobSummary `type:"list"`

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`

	// Lists all Medical Scribe jobs that have the status specified in your request.
	// Jobs are ordered by creation date, with the newest job first.
	Status *string `type:"string" enum:"MedicalScribeJobStatus"`
	// contains filtered or unexported fields
}

func (ListMedicalScribeJobsOutput) GoString added in v1.48.5 

func (s ListMedicalScribeJobsOutput) 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 (*ListMedicalScribeJobsOutput) SetMedicalScribeJobSummaries added in v1.48.5 

func (s *ListMedicalScribeJobsOutput) SetMedicalScribeJobSummaries(v []*MedicalScribeJobSummary) *ListMedicalScribeJobsOutput

SetMedicalScribeJobSummaries sets the MedicalScribeJobSummaries field's value.

func (*ListMedicalScribeJobsOutput) SetNextToken added in v1.48.5 

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

SetNextToken sets the NextToken field's value.

func (*ListMedicalScribeJobsOutput) SetStatus added in v1.48.5 

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

SetStatus sets the Status field's value.

func (ListMedicalScribeJobsOutput) String added in v1.48.5 

func (s ListMedicalScribeJobsOutput) 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 ListMedicalTranscriptionJobsInput added in v1.30.5 

type ListMedicalTranscriptionJobsInput struct {

	// Returns only the medical transcription jobs that contain the specified string.
	// The search is not case sensitive.
	JobNameContains *string `min:"1" type:"string"`

	// The maximum number of medical transcription jobs to return in each page of
	// results. If there are fewer results than the value that you specify, only
	// the actual results are returned. If you do not specify a value, a default
	// of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// If your ListMedicalTranscriptionJobs request returns more results than can
	// be displayed, NextToken is displayed in the response with an associated string.
	// To get the next page of results, copy this string and repeat your request,
	// including NextToken with the value of the copied string. Repeat as needed
	// to view all your results.
	NextToken *string `type:"string"`

	// Returns only medical transcription jobs with the specified status. Jobs are
	// ordered by creation date, with the newest job first. If you do not include
	// Status, all medical transcription jobs are returned.
	Status *string `type:"string" enum:"TranscriptionJobStatus"`
	// contains filtered or unexported fields
}

func (ListMedicalTranscriptionJobsInput) GoString added in v1.30.5 

func (s ListMedicalTranscriptionJobsInput) 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 (*ListMedicalTranscriptionJobsInput) SetJobNameContains added in v1.30.5 

func (s *ListMedicalTranscriptionJobsInput) SetJobNameContains(v string) *ListMedicalTranscriptionJobsInput

SetJobNameContains sets the JobNameContains field's value.

func (*ListMedicalTranscriptionJobsInput) SetMaxResults added in v1.30.5 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMedicalTranscriptionJobsInput) SetNextToken added in v1.30.5 

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

SetNextToken sets the NextToken field's value.

func (*ListMedicalTranscriptionJobsInput) SetStatus added in v1.30.5 

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

SetStatus sets the Status field's value.

func (ListMedicalTranscriptionJobsInput) String added in v1.30.5 

func (s ListMedicalTranscriptionJobsInput) 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 (*ListMedicalTranscriptionJobsInput) Validate added in v1.30.5 

func (s *ListMedicalTranscriptionJobsInput) Validate() error

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

type ListMedicalTranscriptionJobsOutput added in v1.30.5 

type ListMedicalTranscriptionJobsOutput struct {

	// Provides a summary of information about each result.
	MedicalTranscriptionJobSummaries []*MedicalTranscriptionJobSummary `type:"list"`

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`

	// Lists all medical transcription jobs that have the status specified in your
	// request. Jobs are ordered by creation date, with the newest job first.
	Status *string `type:"string" enum:"TranscriptionJobStatus"`
	// contains filtered or unexported fields
}

func (ListMedicalTranscriptionJobsOutput) GoString added in v1.30.5 

func (s ListMedicalTranscriptionJobsOutput) 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 (*ListMedicalTranscriptionJobsOutput) SetMedicalTranscriptionJobSummaries added in v1.30.5 

func (s *ListMedicalTranscriptionJobsOutput) SetMedicalTranscriptionJobSummaries(v []*MedicalTranscriptionJobSummary) *ListMedicalTranscriptionJobsOutput

SetMedicalTranscriptionJobSummaries sets the MedicalTranscriptionJobSummaries field's value.

func (*ListMedicalTranscriptionJobsOutput) SetNextToken added in v1.30.5 

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

SetNextToken sets the NextToken field's value.

func (*ListMedicalTranscriptionJobsOutput) SetStatus added in v1.30.5 

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

SetStatus sets the Status field's value.

func (ListMedicalTranscriptionJobsOutput) String added in v1.30.5 

func (s ListMedicalTranscriptionJobsOutput) 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 ListMedicalVocabulariesInput added in v1.30.17 

type ListMedicalVocabulariesInput struct {

	// The maximum number of custom medical vocabularies to return in each page
	// of results. If there are fewer results than the value that you specify, only
	// the actual results are returned. If you do not specify a value, a default
	// of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// Returns only the custom medical vocabularies that contain the specified string.
	// The search is not case sensitive.
	NameContains *string `min:"1" type:"string"`

	// If your ListMedicalVocabularies request returns more results than can be
	// displayed, NextToken is displayed in the response with an associated string.
	// To get the next page of results, copy this string and repeat your request,
	// including NextToken with the value of the copied string. Repeat as needed
	// to view all your results.
	NextToken *string `type:"string"`

	// Returns only custom medical vocabularies with the specified state. Custom
	// vocabularies are ordered by creation date, with the newest vocabulary first.
	// If you do not include StateEquals, all custom medical vocabularies are returned.
	StateEquals *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (ListMedicalVocabulariesInput) GoString added in v1.30.17 

func (s ListMedicalVocabulariesInput) 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 (*ListMedicalVocabulariesInput) SetMaxResults added in v1.30.17 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMedicalVocabulariesInput) SetNameContains added in v1.30.17 

func (s *ListMedicalVocabulariesInput) SetNameContains(v string) *ListMedicalVocabulariesInput

SetNameContains sets the NameContains field's value.

func (*ListMedicalVocabulariesInput) SetNextToken added in v1.30.17 

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

SetNextToken sets the NextToken field's value.

func (*ListMedicalVocabulariesInput) SetStateEquals added in v1.30.17 

func (s *ListMedicalVocabulariesInput) SetStateEquals(v string) *ListMedicalVocabulariesInput

SetStateEquals sets the StateEquals field's value.

func (ListMedicalVocabulariesInput) String added in v1.30.17 

func (s ListMedicalVocabulariesInput) 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 (*ListMedicalVocabulariesInput) Validate added in v1.30.17 

func (s *ListMedicalVocabulariesInput) Validate() error

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

type ListMedicalVocabulariesOutput added in v1.30.17 

type ListMedicalVocabulariesOutput struct {

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`

	// Lists all custom medical vocabularies that have the status specified in your
	// request. Custom vocabularies are ordered by creation date, with the newest
	// vocabulary first.
	Status *string `type:"string" enum:"VocabularyState"`

	// Provides information about the custom medical vocabularies that match the
	// criteria specified in your request.
	Vocabularies []*VocabularyInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListMedicalVocabulariesOutput) GoString added in v1.30.17 

func (s ListMedicalVocabulariesOutput) 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 (*ListMedicalVocabulariesOutput) SetNextToken added in v1.30.17 

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

SetNextToken sets the NextToken field's value.

func (*ListMedicalVocabulariesOutput) SetStatus added in v1.30.17 

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

SetStatus sets the Status field's value.

func (*ListMedicalVocabulariesOutput) SetVocabularies added in v1.30.17 

func (s *ListMedicalVocabulariesOutput) SetVocabularies(v []*VocabularyInfo) *ListMedicalVocabulariesOutput

SetVocabularies sets the Vocabularies field's value.

func (ListMedicalVocabulariesOutput) String added in v1.30.17 

func (s ListMedicalVocabulariesOutput) 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 added in v1.40.29 

type ListTagsForResourceInput struct {

	// Returns a list of all tags associated with the specified Amazon Resource
	// Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.
	//
	// For example, arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
	//
	// Valid values for resource-type are: transcription-job, medical-transcription-job,
	// vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.40.29 

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 added in v1.40.29 

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

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.40.29 

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 added in v1.40.29 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.40.29 

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) specified in your request.
	ResourceArn *string `min:"1" type:"string"`

	// Lists all tags associated with the given transcription job, vocabulary, model,
	// or resource.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.40.29 

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) SetResourceArn added in v1.40.29 

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

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.40.29 

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 ListTranscriptionJobsInput 

type ListTranscriptionJobsInput struct {

	// Returns only the transcription jobs that contain the specified string. The
	// search is not case sensitive.
	JobNameContains *string `min:"1" type:"string"`

	// The maximum number of transcription jobs to return in each page of results.
	// If there are fewer results than the value that you specify, only the actual
	// results are returned. If you do not specify a value, a default of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// If your ListTranscriptionJobs request returns more results than can be displayed,
	// NextToken is displayed in the response with an associated string. To get
	// the next page of results, copy this string and repeat your request, including
	// NextToken with the value of the copied string. Repeat as needed to view all
	// your results.
	NextToken *string `type:"string"`

	// Returns only transcription jobs with the specified status. Jobs are ordered
	// by creation date, with the newest job first. If you do not include Status,
	// all transcription jobs are returned.
	Status *string `type:"string" enum:"TranscriptionJobStatus"`
	// contains filtered or unexported fields
}

func (ListTranscriptionJobsInput) GoString 

func (s ListTranscriptionJobsInput) 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 (*ListTranscriptionJobsInput) SetJobNameContains added in v1.13.28 

func (s *ListTranscriptionJobsInput) SetJobNameContains(v string) *ListTranscriptionJobsInput

SetJobNameContains sets the JobNameContains field's value.

func (*ListTranscriptionJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTranscriptionJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTranscriptionJobsInput) SetStatus 

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

SetStatus sets the Status field's value.

func (ListTranscriptionJobsInput) String 

func (s ListTranscriptionJobsInput) 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 (*ListTranscriptionJobsInput) Validate 

func (s *ListTranscriptionJobsInput) Validate() error

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

type ListTranscriptionJobsOutput 

type ListTranscriptionJobsOutput struct {

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`

	// Lists all transcription jobs that have the status specified in your request.
	// Jobs are ordered by creation date, with the newest job first.
	Status *string `type:"string" enum:"TranscriptionJobStatus"`

	// Provides a summary of information about each result.
	TranscriptionJobSummaries []*TranscriptionJobSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListTranscriptionJobsOutput) GoString 

func (s ListTranscriptionJobsOutput) 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 (*ListTranscriptionJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTranscriptionJobsOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*ListTranscriptionJobsOutput) SetTranscriptionJobSummaries 

func (s *ListTranscriptionJobsOutput) SetTranscriptionJobSummaries(v []*TranscriptionJobSummary) *ListTranscriptionJobsOutput

SetTranscriptionJobSummaries sets the TranscriptionJobSummaries field's value.

func (ListTranscriptionJobsOutput) String 

func (s ListTranscriptionJobsOutput) 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 ListVocabulariesInput added in v1.13.28 

type ListVocabulariesInput struct {

	// The maximum number of custom vocabularies to return in each page of results.
	// If there are fewer results than the value that you specify, only the actual
	// results are returned. If you do not specify a value, a default of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// Returns only the custom vocabularies that contain the specified string. The
	// search is not case sensitive.
	NameContains *string `min:"1" type:"string"`

	// If your ListVocabularies request returns more results than can be displayed,
	// NextToken is displayed in the response with an associated string. To get
	// the next page of results, copy this string and repeat your request, including
	// NextToken with the value of the copied string. Repeat as needed to view all
	// your results.
	NextToken *string `type:"string"`

	// Returns only custom vocabularies with the specified state. Vocabularies are
	// ordered by creation date, with the newest vocabulary first. If you do not
	// include StateEquals, all custom medical vocabularies are returned.
	StateEquals *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (ListVocabulariesInput) GoString added in v1.13.28 

func (s ListVocabulariesInput) 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 (*ListVocabulariesInput) SetMaxResults added in v1.13.28 

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

SetMaxResults sets the MaxResults field's value.

func (*ListVocabulariesInput) SetNameContains added in v1.13.28 

func (s *ListVocabulariesInput) SetNameContains(v string) *ListVocabulariesInput

SetNameContains sets the NameContains field's value.

func (*ListVocabulariesInput) SetNextToken added in v1.13.28 

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

SetNextToken sets the NextToken field's value.

func (*ListVocabulariesInput) SetStateEquals added in v1.13.28 

func (s *ListVocabulariesInput) SetStateEquals(v string) *ListVocabulariesInput

SetStateEquals sets the StateEquals field's value.

func (ListVocabulariesInput) String added in v1.13.28 

func (s ListVocabulariesInput) 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 (*ListVocabulariesInput) Validate added in v1.13.28 

func (s *ListVocabulariesInput) Validate() error

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

type ListVocabulariesOutput added in v1.13.28 

type ListVocabulariesOutput struct {

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`

	// Lists all custom vocabularies that have the status specified in your request.
	// Vocabularies are ordered by creation date, with the newest vocabulary first.
	Status *string `type:"string" enum:"VocabularyState"`

	// Provides information about the custom vocabularies that match the criteria
	// specified in your request.
	Vocabularies []*VocabularyInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListVocabulariesOutput) GoString added in v1.13.28 

func (s ListVocabulariesOutput) 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 (*ListVocabulariesOutput) SetNextToken added in v1.13.28 

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

SetNextToken sets the NextToken field's value.

func (*ListVocabulariesOutput) SetStatus added in v1.13.28 

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

SetStatus sets the Status field's value.

func (*ListVocabulariesOutput) SetVocabularies added in v1.13.28 

func (s *ListVocabulariesOutput) SetVocabularies(v []*VocabularyInfo) *ListVocabulariesOutput

SetVocabularies sets the Vocabularies field's value.

func (ListVocabulariesOutput) String added in v1.13.28 

func (s ListVocabulariesOutput) 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 ListVocabularyFiltersInput added in v1.26.7 

type ListVocabularyFiltersInput struct {

	// The maximum number of custom vocabulary filters to return in each page of
	// results. If there are fewer results than the value that you specify, only
	// the actual results are returned. If you do not specify a value, a default
	// of 5 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// Returns only the custom vocabulary filters that contain the specified string.
	// The search is not case sensitive.
	NameContains *string `min:"1" type:"string"`

	// If your ListVocabularyFilters request returns more results than can be displayed,
	// NextToken is displayed in the response with an associated string. To get
	// the next page of results, copy this string and repeat your request, including
	// NextToken with the value of the copied string. Repeat as needed to view all
	// your results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListVocabularyFiltersInput) GoString added in v1.26.7 

func (s ListVocabularyFiltersInput) 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 (*ListVocabularyFiltersInput) SetMaxResults added in v1.26.7 

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

SetMaxResults sets the MaxResults field's value.

func (*ListVocabularyFiltersInput) SetNameContains added in v1.26.7 

func (s *ListVocabularyFiltersInput) SetNameContains(v string) *ListVocabularyFiltersInput

SetNameContains sets the NameContains field's value.

func (*ListVocabularyFiltersInput) SetNextToken added in v1.26.7 

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

SetNextToken sets the NextToken field's value.

func (ListVocabularyFiltersInput) String added in v1.26.7 

func (s ListVocabularyFiltersInput) 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 (*ListVocabularyFiltersInput) Validate added in v1.26.7 

func (s *ListVocabularyFiltersInput) Validate() error

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

type ListVocabularyFiltersOutput added in v1.26.7 

type ListVocabularyFiltersOutput struct {

	// If NextToken is present in your response, it indicates that not all results
	// are displayed. To view the next set of results, copy the string associated
	// with the NextToken parameter in your results output, then run your request
	// again including NextToken with the value of the copied string. Repeat as
	// needed to view all your results.
	NextToken *string `type:"string"`

	// Provides information about the custom vocabulary filters that match the criteria
	// specified in your request.
	VocabularyFilters []*VocabularyFilterInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListVocabularyFiltersOutput) GoString added in v1.26.7 

func (s ListVocabularyFiltersOutput) 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 (*ListVocabularyFiltersOutput) SetNextToken added in v1.26.7 

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

SetNextToken sets the NextToken field's value.

func (*ListVocabularyFiltersOutput) SetVocabularyFilters added in v1.26.7 

func (s *ListVocabularyFiltersOutput) SetVocabularyFilters(v []*VocabularyFilterInfo) *ListVocabularyFiltersOutput

SetVocabularyFilters sets the VocabularyFilters field's value.

func (ListVocabularyFiltersOutput) String added in v1.26.7 

func (s ListVocabularyFiltersOutput) 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 Media 

type Media struct {

	// The Amazon S3 location of the media file you want to transcribe. For example:
	//
	//    * s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
	//
	//    * s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
	//
	// Note that the Amazon S3 bucket that contains your input media must be located
	// in the same Amazon Web Services Region where you're making your transcription
	// request.
	MediaFileUri *string `min:"1" type:"string"`

	// The Amazon S3 location of the media file you want to redact. For example:
	//
	//    * s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
	//
	//    * s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
	//
	// Note that the Amazon S3 bucket that contains your input media must be located
	// in the same Amazon Web Services Region where you're making your transcription
	// request.
	//
	// RedactedMediaFileUri produces a redacted audio file in addition to a redacted
	// transcript. It is only supported for Call Analytics (StartCallAnalyticsJob)
	// transcription requests.
	RedactedMediaFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio) section in the Amazon S3 Developer Guide.

func (Media) GoString 

func (s Media) 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 (*Media) SetMediaFileUri 

func (s *Media) SetMediaFileUri(v string) *Media

SetMediaFileUri sets the MediaFileUri field's value.

func (*Media) SetRedactedMediaFileUri added in v1.40.15 

func (s *Media) SetRedactedMediaFileUri(v string) *Media

SetRedactedMediaFileUri sets the RedactedMediaFileUri field's value.

func (Media) String 

func (s Media) 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 (*Media) Validate 

func (s *Media) Validate() error

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

type MedicalScribeChannelDefinition added in v1.48.5 

type MedicalScribeChannelDefinition struct {

	// Specify the audio channel you want to define.
	//
	// ChannelId is a required field
	ChannelId *int64 `type:"integer" required:"true"`

	// Specify the participant that you want to flag. The options are CLINICIAN
	// and PATIENT
	//
	// ParticipantRole is a required field
	ParticipantRole *string `type:"string" required:"true" enum:"MedicalScribeParticipantRole"`
	// contains filtered or unexported fields
}

Indicates which speaker is on which channel. The options are CLINICIAN and PATIENT

func (MedicalScribeChannelDefinition) GoString added in v1.48.5 

func (s MedicalScribeChannelDefinition) 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 (*MedicalScribeChannelDefinition) SetChannelId added in v1.48.5 

func (s *MedicalScribeChannelDefinition) SetChannelId(v int64) *MedicalScribeChannelDefinition

SetChannelId sets the ChannelId field's value.

func (*MedicalScribeChannelDefinition) SetParticipantRole added in v1.48.5 

func (s *MedicalScribeChannelDefinition) SetParticipantRole(v string) *MedicalScribeChannelDefinition

SetParticipantRole sets the ParticipantRole field's value.

func (MedicalScribeChannelDefinition) String added in v1.48.5 

func (s MedicalScribeChannelDefinition) 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 (*MedicalScribeChannelDefinition) Validate added in v1.48.5 

func (s *MedicalScribeChannelDefinition) Validate() error

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

type MedicalScribeJob added in v1.48.5 

type MedicalScribeJob struct {

	// Makes it possible to specify which speaker is on which channel. For example,
	// if the clinician is the first participant to speak, you would set ChannelId
	// of the first ChannelDefinition in the list to 0 (to indicate the first channel)
	// and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking).
	// Then you would set the ChannelId of the second ChannelDefinition in the list
	// to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to
	// indicate that it's the patient speaking).
	ChannelDefinitions []*MedicalScribeChannelDefinition `min:"2" type:"list"`

	// The date and time the specified Medical Scribe job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// The date and time the specified Medical Scribe job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files, write to the output
	// bucket, and use your KMS key if supplied. If the role that you specify doesn’t
	// have the appropriate permissions your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	DataAccessRoleArn *string `min:"20" type:"string"`

	// If MedicalScribeJobStatus is FAILED, FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code used to create your Medical Scribe job. US English (en-US)
	// is the only supported language for Medical Scribe jobs.
	LanguageCode *string `type:"string" enum:"MedicalScribeLanguageCode"`

	// Describes the Amazon S3 location of the media file you want to use in your
	// request.
	//
	// For information on supported media formats, refer to the MediaFormat parameter
	// or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
	// section in the Amazon S3 Developer Guide.
	Media *Media `type:"structure"`

	// The name of the Medical Scribe job. Job names are case sensitive and must
	// be unique within an Amazon Web Services account.
	MedicalScribeJobName *string `min:"1" type:"string"`

	// Provides the status of the specified Medical Scribe job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in MedicalScribeOutput If the status is FAILED,
	// FailureReason provides details on why your Medical Scribe job failed.
	MedicalScribeJobStatus *string `type:"string" enum:"MedicalScribeJobStatus"`

	// The location of the output of your Medical Scribe job. ClinicalDocumentUri
	// holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds
	// the Amazon S3 URI for the Transcript.
	MedicalScribeOutput *MedicalScribeOutput_ `type:"structure"`

	// Makes it possible to control how your Medical Scribe job is processed using
	// a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions
	// are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions
	// are not set. One and only one of ChannelIdentification and ShowSpeakerLabels
	// must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set.
	// Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName,
	// VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName
	// is set.
	Settings *MedicalScribeSettings `type:"structure"`

	// The date and time your Medical Scribe job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`

	// Adds one or more custom tags, each in the form of a key:value pair, to the
	// Medica Scribe job.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides detailed information about a Medical Scribe job.

To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the locations specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

func (MedicalScribeJob) GoString added in v1.48.5 

func (s MedicalScribeJob) 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 (*MedicalScribeJob) SetChannelDefinitions added in v1.48.5 

func (s *MedicalScribeJob) SetChannelDefinitions(v []*MedicalScribeChannelDefinition) *MedicalScribeJob

SetChannelDefinitions sets the ChannelDefinitions field's value.

func (*MedicalScribeJob) SetCompletionTime added in v1.48.5 

func (s *MedicalScribeJob) SetCompletionTime(v time.Time) *MedicalScribeJob

SetCompletionTime sets the CompletionTime field's value.

func (*MedicalScribeJob) SetCreationTime added in v1.48.5 

func (s *MedicalScribeJob) SetCreationTime(v time.Time) *MedicalScribeJob

SetCreationTime sets the CreationTime field's value.

func (*MedicalScribeJob) SetDataAccessRoleArn added in v1.48.5 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*MedicalScribeJob) SetFailureReason added in v1.48.5 

func (s *MedicalScribeJob) SetFailureReason(v string) *MedicalScribeJob

SetFailureReason sets the FailureReason field's value.

func (*MedicalScribeJob) SetLanguageCode added in v1.48.5 

func (s *MedicalScribeJob) SetLanguageCode(v string) *MedicalScribeJob

SetLanguageCode sets the LanguageCode field's value.

func (*MedicalScribeJob) SetMedia added in v1.48.5 

func (s *MedicalScribeJob) SetMedia(v *Media) *MedicalScribeJob

SetMedia sets the Media field's value.

func (*MedicalScribeJob) SetMedicalScribeJobName added in v1.48.5 

func (s *MedicalScribeJob) SetMedicalScribeJobName(v string) *MedicalScribeJob

SetMedicalScribeJobName sets the MedicalScribeJobName field's value.

func (*MedicalScribeJob) SetMedicalScribeJobStatus added in v1.48.5 

func (s *MedicalScribeJob) SetMedicalScribeJobStatus(v string) *MedicalScribeJob

SetMedicalScribeJobStatus sets the MedicalScribeJobStatus field's value.

func (*MedicalScribeJob) SetMedicalScribeOutput added in v1.48.5 

func (s *MedicalScribeJob) SetMedicalScribeOutput(v *MedicalScribeOutput_) *MedicalScribeJob

SetMedicalScribeOutput sets the MedicalScribeOutput field's value.

func (*MedicalScribeJob) SetSettings added in v1.48.5 

func (s *MedicalScribeJob) SetSettings(v *MedicalScribeSettings) *MedicalScribeJob

SetSettings sets the Settings field's value.

func (*MedicalScribeJob) SetStartTime added in v1.48.5 

func (s *MedicalScribeJob) SetStartTime(v time.Time) *MedicalScribeJob

SetStartTime sets the StartTime field's value.

func (*MedicalScribeJob) SetTags added in v1.48.5 

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

SetTags sets the Tags field's value.

func (MedicalScribeJob) String added in v1.48.5 

func (s MedicalScribeJob) 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 MedicalScribeJobSummary added in v1.48.5 

type MedicalScribeJobSummary struct {

	// The date and time the specified Medical Scribe job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// The date and time the specified Medical Scribe job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// If MedicalScribeJobStatus is FAILED, FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code used to create your Medical Scribe job. US English (en-US)
	// is the only supported language for Medical Scribe jobs.
	LanguageCode *string `type:"string" enum:"MedicalScribeLanguageCode"`

	// The name of the Medical Scribe job. Job names are case sensitive and must
	// be unique within an Amazon Web Services account.
	MedicalScribeJobName *string `min:"1" type:"string"`

	// Provides the status of the specified Medical Scribe job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in MedicalScribeOutput If the status is FAILED,
	// FailureReason provides details on why your Medical Scribe job failed.
	MedicalScribeJobStatus *string `type:"string" enum:"MedicalScribeJobStatus"`

	// The date and time your Medical Scribe job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides detailed information about a specific Medical Scribe job.

func (MedicalScribeJobSummary) GoString added in v1.48.5 

func (s MedicalScribeJobSummary) 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 (*MedicalScribeJobSummary) SetCompletionTime added in v1.48.5 

func (s *MedicalScribeJobSummary) SetCompletionTime(v time.Time) *MedicalScribeJobSummary

SetCompletionTime sets the CompletionTime field's value.

func (*MedicalScribeJobSummary) SetCreationTime added in v1.48.5 

func (s *MedicalScribeJobSummary) SetCreationTime(v time.Time) *MedicalScribeJobSummary

SetCreationTime sets the CreationTime field's value.

func (*MedicalScribeJobSummary) SetFailureReason added in v1.48.5 

func (s *MedicalScribeJobSummary) SetFailureReason(v string) *MedicalScribeJobSummary

SetFailureReason sets the FailureReason field's value.

func (*MedicalScribeJobSummary) SetLanguageCode added in v1.48.5 

func (s *MedicalScribeJobSummary) SetLanguageCode(v string) *MedicalScribeJobSummary

SetLanguageCode sets the LanguageCode field's value.

func (*MedicalScribeJobSummary) SetMedicalScribeJobName added in v1.48.5 

func (s *MedicalScribeJobSummary) SetMedicalScribeJobName(v string) *MedicalScribeJobSummary

SetMedicalScribeJobName sets the MedicalScribeJobName field's value.

func (*MedicalScribeJobSummary) SetMedicalScribeJobStatus added in v1.48.5 

func (s *MedicalScribeJobSummary) SetMedicalScribeJobStatus(v string) *MedicalScribeJobSummary

SetMedicalScribeJobStatus sets the MedicalScribeJobStatus field's value.

func (*MedicalScribeJobSummary) SetStartTime added in v1.48.5 

func (s *MedicalScribeJobSummary) SetStartTime(v time.Time) *MedicalScribeJobSummary

SetStartTime sets the StartTime field's value.

func (MedicalScribeJobSummary) String added in v1.48.5 

func (s MedicalScribeJobSummary) 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 MedicalScribeOutput_ added in v1.48.5 

type MedicalScribeOutput_ struct {

	// Holds the Amazon S3 URI for the Clinical Document.
	//
	// ClinicalDocumentUri is a required field
	ClinicalDocumentUri *string `min:"1" type:"string" required:"true"`

	// Holds the Amazon S3 URI for the Transcript.
	//
	// TranscriptFileUri is a required field
	TranscriptFileUri *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

func (MedicalScribeOutput_) GoString added in v1.48.5 

func (s MedicalScribeOutput_) 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 (*MedicalScribeOutput_) SetClinicalDocumentUri added in v1.48.5 

func (s *MedicalScribeOutput_) SetClinicalDocumentUri(v string) *MedicalScribeOutput_

SetClinicalDocumentUri sets the ClinicalDocumentUri field's value.

func (*MedicalScribeOutput_) SetTranscriptFileUri added in v1.48.5 

func (s *MedicalScribeOutput_) SetTranscriptFileUri(v string) *MedicalScribeOutput_

SetTranscriptFileUri sets the TranscriptFileUri field's value.

func (MedicalScribeOutput_) String added in v1.48.5 

func (s MedicalScribeOutput_) 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 MedicalScribeSettings added in v1.48.5 

type MedicalScribeSettings struct {

	// Enables channel identification in multi-channel audio.
	//
	// Channel identification transcribes the audio on each channel independently,
	// then appends the output for each channel into one transcript.
	//
	// For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html).
	ChannelIdentification *bool `type:"boolean"`

	// Specify the maximum number of speakers you want to partition in your media.
	//
	// Note that if your media contains more speakers than the specified number,
	// multiple speakers are treated as a single speaker.
	//
	// If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels
	// field to true.
	MaxSpeakerLabels *int64 `min:"2" type:"integer"`

	// Enables speaker partitioning (diarization) in your Medical Scribe output.
	// Speaker partitioning labels the speech from individual speakers in your media
	// file.
	//
	// If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
	//
	// For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html).
	ShowSpeakerLabels *bool `type:"boolean"`

	// Specify how you want your custom vocabulary filter applied to your transcript.
	//
	// To replace words with ***, choose mask.
	//
	// To delete words, choose remove.
	//
	// To flag words without changing them, choose tag.
	VocabularyFilterMethod *string `type:"string" enum:"VocabularyFilterMethod"`

	// The name of the custom vocabulary filter you want to include in your Medical
	// Scribe request. Custom vocabulary filter names are case sensitive.
	//
	// Note that if you include VocabularyFilterName in your request, you must also
	// include VocabularyFilterMethod.
	VocabularyFilterName *string `min:"1" type:"string"`

	// The name of the custom vocabulary you want to include in your Medical Scribe
	// request. Custom vocabulary names are case sensitive.
	VocabularyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

func (MedicalScribeSettings) GoString added in v1.48.5 

func (s MedicalScribeSettings) 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 (*MedicalScribeSettings) SetChannelIdentification added in v1.48.5 

func (s *MedicalScribeSettings) SetChannelIdentification(v bool) *MedicalScribeSettings

SetChannelIdentification sets the ChannelIdentification field's value.

func (*MedicalScribeSettings) SetMaxSpeakerLabels added in v1.48.5 

func (s *MedicalScribeSettings) SetMaxSpeakerLabels(v int64) *MedicalScribeSettings

SetMaxSpeakerLabels sets the MaxSpeakerLabels field's value.

func (*MedicalScribeSettings) SetShowSpeakerLabels added in v1.48.5 

func (s *MedicalScribeSettings) SetShowSpeakerLabels(v bool) *MedicalScribeSettings

SetShowSpeakerLabels sets the ShowSpeakerLabels field's value.

func (*MedicalScribeSettings) SetVocabularyFilterMethod added in v1.48.5 

func (s *MedicalScribeSettings) SetVocabularyFilterMethod(v string) *MedicalScribeSettings

SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.

func (*MedicalScribeSettings) SetVocabularyFilterName added in v1.48.5 

func (s *MedicalScribeSettings) SetVocabularyFilterName(v string) *MedicalScribeSettings

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*MedicalScribeSettings) SetVocabularyName added in v1.48.5 

func (s *MedicalScribeSettings) SetVocabularyName(v string) *MedicalScribeSettings

SetVocabularyName sets the VocabularyName field's value.

func (MedicalScribeSettings) String added in v1.48.5 

func (s MedicalScribeSettings) 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 (*MedicalScribeSettings) Validate added in v1.48.5 

func (s *MedicalScribeSettings) Validate() error

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

type MedicalTranscript added in v1.30.5 

type MedicalTranscript struct {

	// The Amazon S3 location of your transcript. You can use this URI to access
	// or download your transcript.
	//
	// Note that this is the Amazon S3 location you specified in your request using
	// the OutputBucketName parameter.
	TranscriptFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides you with the Amazon S3 URI you can use to access your transcript.

func (MedicalTranscript) GoString added in v1.30.5 

func (s MedicalTranscript) 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 (*MedicalTranscript) SetTranscriptFileUri added in v1.30.5 

func (s *MedicalTranscript) SetTranscriptFileUri(v string) *MedicalTranscript

SetTranscriptFileUri sets the TranscriptFileUri field's value.

func (MedicalTranscript) String added in v1.30.5 

func (s MedicalTranscript) 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 MedicalTranscriptionJob added in v1.30.5 

type MedicalTranscriptionJob struct {

	// The date and time the specified medical transcription job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// Indicates whether content identification was enabled for your transcription
	// request.
	ContentIdentificationType *string `type:"string" enum:"MedicalContentIdentificationType"`

	// The date and time the specified medical transcription job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// If TranscriptionJobStatus is FAILED, FailureReason contains information about
	// why the transcription job request failed.
	//
	// The FailureReason field contains one of the following values:
	//
	//    * Unsupported media format. The media format specified in MediaFormat
	//    isn't valid. Refer to refer to the MediaFormat parameter for a list of
	//    supported formats.
	//
	//    * The media format provided does not match the detected media format.
	//    The media format specified in MediaFormat doesn't match the format of
	//    the input file. Check the media format of your media file and correct
	//    the specified value.
	//
	//    * Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz
	//    isn't valid. The sample rate must be between 16,000 and 48,000 hertz.
	//
	//    * The sample rate provided does not match the detected sample rate. The
	//    sample rate specified in MediaSampleRateHertz doesn't match the sample
	//    rate detected in your input media file. Check the sample rate of your
	//    media file and correct the specified value.
	//
	//    * Invalid file size: file size too large. The size of your media file
	//    is larger than what Amazon Transcribe can process. For more information,
	//    refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe).
	//
	//    * Invalid number of channels: number of channels too large. Your audio
	//    contains more channels than Amazon Transcribe is able to process. For
	//    more information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe).
	FailureReason *string `type:"string"`

	// The language code used to create your medical transcription job. US English
	// (en-US) is the only supported language for medical transcriptions.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// Describes the Amazon S3 location of the media file you want to use in your
	// request.
	//
	// For information on supported media formats, refer to the MediaFormat parameter
	// or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
	// section in the Amazon S3 Developer Guide.
	Media *Media `type:"structure"`

	// The format of the input media file.
	MediaFormat *string `type:"string" enum:"MediaFormat"`

	// The sample rate, in hertz, of the audio track in your input media file.
	MediaSampleRateHertz *int64 `min:"16000" type:"integer"`

	// The name of the medical transcription job. Job names are case sensitive and
	// must be unique within an Amazon Web Services account.
	MedicalTranscriptionJobName *string `min:"1" type:"string"`

	// Provides information on any additional settings that were included in your
	// request. Additional settings include channel identification, alternative
	// transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary
	// filters.
	Settings *MedicalTranscriptionSetting `type:"structure"`

	// Describes the medical specialty represented in your media.
	Specialty *string `type:"string" enum:"Specialty"`

	// The date and time the specified medical transcription job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`

	// The tags, each in the form of a key:value pair, assigned to the specified
	// medical transcription job.
	Tags []*Tag `min:"1" type:"list"`

	// Provides you with the Amazon S3 URI you can use to access your transcript.
	Transcript *MedicalTranscript `type:"structure"`

	// Provides the status of the specified medical transcription job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in TranscriptFileUri. If the status is FAILED,
	// FailureReason provides details on why your transcription job failed.
	TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"`

	// Indicates whether the input media is a dictation or a conversation, as specified
	// in the StartMedicalTranscriptionJob request.
	Type *string `type:"string" enum:"Type"`
	// contains filtered or unexported fields
}

Provides detailed information about a medical transcription job.

To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

func (MedicalTranscriptionJob) GoString added in v1.30.5 

func (s MedicalTranscriptionJob) 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 (*MedicalTranscriptionJob) SetCompletionTime added in v1.30.5 

func (s *MedicalTranscriptionJob) SetCompletionTime(v time.Time) *MedicalTranscriptionJob

SetCompletionTime sets the CompletionTime field's value.

func (*MedicalTranscriptionJob) SetContentIdentificationType added in v1.38.40 

func (s *MedicalTranscriptionJob) SetContentIdentificationType(v string) *MedicalTranscriptionJob

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*MedicalTranscriptionJob) SetCreationTime added in v1.30.5 

func (s *MedicalTranscriptionJob) SetCreationTime(v time.Time) *MedicalTranscriptionJob

SetCreationTime sets the CreationTime field's value.

func (*MedicalTranscriptionJob) SetFailureReason added in v1.30.5 

func (s *MedicalTranscriptionJob) SetFailureReason(v string) *MedicalTranscriptionJob

SetFailureReason sets the FailureReason field's value.

func (*MedicalTranscriptionJob) SetLanguageCode added in v1.30.5 

func (s *MedicalTranscriptionJob) SetLanguageCode(v string) *MedicalTranscriptionJob

SetLanguageCode sets the LanguageCode field's value.

func (*MedicalTranscriptionJob) SetMedia added in v1.30.5 

func (s *MedicalTranscriptionJob) SetMedia(v *Media) *MedicalTranscriptionJob

SetMedia sets the Media field's value.

func (*MedicalTranscriptionJob) SetMediaFormat added in v1.30.5 

func (s *MedicalTranscriptionJob) SetMediaFormat(v string) *MedicalTranscriptionJob

SetMediaFormat sets the MediaFormat field's value.

func (*MedicalTranscriptionJob) SetMediaSampleRateHertz added in v1.30.5 

func (s *MedicalTranscriptionJob) SetMediaSampleRateHertz(v int64) *MedicalTranscriptionJob

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*MedicalTranscriptionJob) SetMedicalTranscriptionJobName added in v1.30.5 

func (s *MedicalTranscriptionJob) SetMedicalTranscriptionJobName(v string) *MedicalTranscriptionJob

SetMedicalTranscriptionJobName sets the MedicalTranscriptionJobName field's value.

func (*MedicalTranscriptionJob) SetSettings added in v1.30.5 

func (s *MedicalTranscriptionJob) SetSettings(v *MedicalTranscriptionSetting) *MedicalTranscriptionJob

SetSettings sets the Settings field's value.

func (*MedicalTranscriptionJob) SetSpecialty added in v1.30.5 

func (s *MedicalTranscriptionJob) SetSpecialty(v string) *MedicalTranscriptionJob

SetSpecialty sets the Specialty field's value.

func (*MedicalTranscriptionJob) SetStartTime added in v1.30.5 

func (s *MedicalTranscriptionJob) SetStartTime(v time.Time) *MedicalTranscriptionJob

SetStartTime sets the StartTime field's value.

func (*MedicalTranscriptionJob) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (*MedicalTranscriptionJob) SetTranscript added in v1.30.5 

func (s *MedicalTranscriptionJob) SetTranscript(v *MedicalTranscript) *MedicalTranscriptionJob

SetTranscript sets the Transcript field's value.

func (*MedicalTranscriptionJob) SetTranscriptionJobStatus added in v1.30.5 

func (s *MedicalTranscriptionJob) SetTranscriptionJobStatus(v string) *MedicalTranscriptionJob

SetTranscriptionJobStatus sets the TranscriptionJobStatus field's value.

func (*MedicalTranscriptionJob) SetType added in v1.30.5 

func (s *MedicalTranscriptionJob) SetType(v string) *MedicalTranscriptionJob

SetType sets the Type field's value.

func (MedicalTranscriptionJob) String added in v1.30.5 

func (s MedicalTranscriptionJob) 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 MedicalTranscriptionJobSummary added in v1.30.5 

type MedicalTranscriptionJobSummary struct {

	// The date and time the specified medical transcription job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// Labels all personal health information (PHI) identified in your transcript.
	// For more information, see Identifying personal health information (PHI) in
	// a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html).
	ContentIdentificationType *string `type:"string" enum:"MedicalContentIdentificationType"`

	// The date and time the specified medical transcription job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// If TranscriptionJobStatus is FAILED, FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The language code used to create your medical transcription. US English (en-US)
	// is the only supported language for medical transcriptions.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The name of the medical transcription job. Job names are case sensitive and
	// must be unique within an Amazon Web Services account.
	MedicalTranscriptionJobName *string `min:"1" type:"string"`

	// Indicates where the specified medical transcription output is stored.
	//
	// If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you
	// specified using the OutputBucketName parameter in your request. If you also
	// included OutputKey in your request, your output is located in the path you
	// specified in your request.
	//
	// If the value is SERVICE_BUCKET, the location is a service-managed Amazon
	// S3 bucket. To access a transcript stored in a service-managed bucket, use
	// the URI shown in the TranscriptFileUri field.
	OutputLocationType *string `type:"string" enum:"OutputLocationType"`

	// Provides the medical specialty represented in your media.
	Specialty *string `type:"string" enum:"Specialty"`

	// The date and time your medical transcription job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`

	// Provides the status of your medical transcription job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in TranscriptFileUri. If the status is FAILED,
	// FailureReason provides details on why your transcription job failed.
	TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"`

	// Indicates whether the input media is a dictation or a conversation, as specified
	// in the StartMedicalTranscriptionJob request.
	Type *string `type:"string" enum:"Type"`
	// contains filtered or unexported fields
}

Provides detailed information about a specific medical transcription job.

func (MedicalTranscriptionJobSummary) GoString added in v1.30.5 

func (s MedicalTranscriptionJobSummary) 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 (*MedicalTranscriptionJobSummary) SetCompletionTime added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetCompletionTime(v time.Time) *MedicalTranscriptionJobSummary

SetCompletionTime sets the CompletionTime field's value.

func (*MedicalTranscriptionJobSummary) SetContentIdentificationType added in v1.38.40 

func (s *MedicalTranscriptionJobSummary) SetContentIdentificationType(v string) *MedicalTranscriptionJobSummary

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*MedicalTranscriptionJobSummary) SetCreationTime added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetCreationTime(v time.Time) *MedicalTranscriptionJobSummary

SetCreationTime sets the CreationTime field's value.

func (*MedicalTranscriptionJobSummary) SetFailureReason added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetFailureReason(v string) *MedicalTranscriptionJobSummary

SetFailureReason sets the FailureReason field's value.

func (*MedicalTranscriptionJobSummary) SetLanguageCode added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetLanguageCode(v string) *MedicalTranscriptionJobSummary

SetLanguageCode sets the LanguageCode field's value.

func (*MedicalTranscriptionJobSummary) SetMedicalTranscriptionJobName added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetMedicalTranscriptionJobName(v string) *MedicalTranscriptionJobSummary

SetMedicalTranscriptionJobName sets the MedicalTranscriptionJobName field's value.

func (*MedicalTranscriptionJobSummary) SetOutputLocationType added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetOutputLocationType(v string) *MedicalTranscriptionJobSummary

SetOutputLocationType sets the OutputLocationType field's value.

func (*MedicalTranscriptionJobSummary) SetSpecialty added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetSpecialty(v string) *MedicalTranscriptionJobSummary

SetSpecialty sets the Specialty field's value.

func (*MedicalTranscriptionJobSummary) SetStartTime added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetStartTime(v time.Time) *MedicalTranscriptionJobSummary

SetStartTime sets the StartTime field's value.

func (*MedicalTranscriptionJobSummary) SetTranscriptionJobStatus added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetTranscriptionJobStatus(v string) *MedicalTranscriptionJobSummary

SetTranscriptionJobStatus sets the TranscriptionJobStatus field's value.

func (*MedicalTranscriptionJobSummary) SetType added in v1.30.5 

func (s *MedicalTranscriptionJobSummary) SetType(v string) *MedicalTranscriptionJobSummary

SetType sets the Type field's value.

func (MedicalTranscriptionJobSummary) String added in v1.30.5 

func (s MedicalTranscriptionJobSummary) 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 MedicalTranscriptionSetting added in v1.30.5 

type MedicalTranscriptionSetting struct {

	// Enables channel identification in multi-channel audio.
	//
	// Channel identification transcribes the audio on each channel independently,
	// then appends the output for each channel into one transcript.
	//
	// If you have multi-channel audio and do not enable channel identification,
	// your audio is transcribed in a continuous manner and your transcript does
	// not separate the speech by channel.
	//
	// For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html).
	ChannelIdentification *bool `type:"boolean"`

	// Indicate the maximum number of alternative transcriptions you want Amazon
	// Transcribe Medical to include in your transcript.
	//
	// If you select a number greater than the number of alternative transcriptions
	// generated by Amazon Transcribe Medical, only the actual number of alternative
	// transcriptions are included.
	//
	// If you include MaxAlternatives in your request, you must also include ShowAlternatives
	// with a value of true.
	//
	// For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html).
	MaxAlternatives *int64 `min:"2" type:"integer"`

	// Specify the maximum number of speakers you want to partition in your media.
	//
	// Note that if your media contains more speakers than the specified number,
	// multiple speakers are treated as a single speaker.
	//
	// If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels
	// field to true.
	MaxSpeakerLabels *int64 `min:"2" type:"integer"`

	// To include alternative transcriptions within your transcription output, include
	// ShowAlternatives in your transcription request.
	//
	// If you include ShowAlternatives, you must also include MaxAlternatives, which
	// is the maximum number of alternative transcriptions you want Amazon Transcribe
	// Medical to generate.
	//
	// For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html).
	ShowAlternatives *bool `type:"boolean"`

	// Enables speaker partitioning (diarization) in your transcription output.
	// Speaker partitioning labels the speech from individual speakers in your media
	// file.
	//
	// If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
	//
	// For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html).
	ShowSpeakerLabels *bool `type:"boolean"`

	// The name of the custom vocabulary you want to use when processing your medical
	// transcription job. Custom vocabulary names are case sensitive.
	//
	// The language of the specified custom vocabulary must match the language code
	// that you specify in your transcription request. If the languages do not match,
	// the custom vocabulary isn't applied. There are no errors or warnings associated
	// with a language mismatch. US English (en-US) is the only valid language for
	// Amazon Transcribe Medical.
	VocabularyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job.

func (MedicalTranscriptionSetting) GoString added in v1.30.5 

func (s MedicalTranscriptionSetting) 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 (*MedicalTranscriptionSetting) SetChannelIdentification added in v1.30.5 

func (s *MedicalTranscriptionSetting) SetChannelIdentification(v bool) *MedicalTranscriptionSetting

SetChannelIdentification sets the ChannelIdentification field's value.

func (*MedicalTranscriptionSetting) SetMaxAlternatives added in v1.30.5 

func (s *MedicalTranscriptionSetting) SetMaxAlternatives(v int64) *MedicalTranscriptionSetting

SetMaxAlternatives sets the MaxAlternatives field's value.

func (*MedicalTranscriptionSetting) SetMaxSpeakerLabels added in v1.30.5 

func (s *MedicalTranscriptionSetting) SetMaxSpeakerLabels(v int64) *MedicalTranscriptionSetting

SetMaxSpeakerLabels sets the MaxSpeakerLabels field's value.

func (*MedicalTranscriptionSetting) SetShowAlternatives added in v1.30.5 

func (s *MedicalTranscriptionSetting) SetShowAlternatives(v bool) *MedicalTranscriptionSetting

SetShowAlternatives sets the ShowAlternatives field's value.

func (*MedicalTranscriptionSetting) SetShowSpeakerLabels added in v1.30.5 

func (s *MedicalTranscriptionSetting) SetShowSpeakerLabels(v bool) *MedicalTranscriptionSetting

SetShowSpeakerLabels sets the ShowSpeakerLabels field's value.

func (*MedicalTranscriptionSetting) SetVocabularyName added in v1.30.17 

func (s *MedicalTranscriptionSetting) SetVocabularyName(v string) *MedicalTranscriptionSetting

SetVocabularyName sets the VocabularyName field's value.

func (MedicalTranscriptionSetting) String added in v1.30.5 

func (s MedicalTranscriptionSetting) 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 (*MedicalTranscriptionSetting) Validate added in v1.30.5 

func (s *MedicalTranscriptionSetting) Validate() error

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

type ModelSettings added in v1.33.20 

type ModelSettings struct {

	// The name of the custom language model you want to use when processing your
	// transcription job. Note that custom language model names are case sensitive.
	//
	// The language of the specified custom language model must match the language
	// code that you specify in your transcription request. If the languages do
	// not match, the custom language model isn't applied. There are no errors or
	// warnings associated with a language mismatch.
	LanguageModelName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides the name of the custom language model that was included in the specified transcription job.

Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification (). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

func (ModelSettings) GoString added in v1.33.20 

func (s ModelSettings) 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 (*ModelSettings) SetLanguageModelName added in v1.33.20 

func (s *ModelSettings) SetLanguageModelName(v string) *ModelSettings

SetLanguageModelName sets the LanguageModelName field's value.

func (ModelSettings) String added in v1.33.20 

func (s ModelSettings) 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 (*ModelSettings) Validate added in v1.33.20 

func (s *ModelSettings) Validate() error

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

type NonTalkTimeFilter added in v1.40.15 

type NonTalkTimeFilter struct {

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for a period of silence. See for more detail.
	AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"`

	// Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence
	Negate *bool `type:"boolean"`

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for a period of silence. See for more detail.
	RelativeTimeRange *RelativeTimeRange `type:"structure"`

	// Specify the duration, in milliseconds, of the period of silence that you
	// want to flag. For example, you can flag a silent period that lasts 30,000
	// milliseconds.
	Threshold *int64 `type:"long"`
	// contains filtered or unexported fields
}

Flag the presence or absence of periods of silence in your Call Analytics transcription output.

Rules using NonTalkTimeFilter are designed to match:

  • The presence of silence at specified periods throughout the call

  • The presence of speech at specified periods throughout the call

See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) for usage examples.

func (NonTalkTimeFilter) GoString added in v1.40.15 

func (s NonTalkTimeFilter) 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 (*NonTalkTimeFilter) SetAbsoluteTimeRange added in v1.40.15 

func (s *NonTalkTimeFilter) SetAbsoluteTimeRange(v *AbsoluteTimeRange) *NonTalkTimeFilter

SetAbsoluteTimeRange sets the AbsoluteTimeRange field's value.

func (*NonTalkTimeFilter) SetNegate added in v1.40.15 

func (s *NonTalkTimeFilter) SetNegate(v bool) *NonTalkTimeFilter

SetNegate sets the Negate field's value.

func (*NonTalkTimeFilter) SetRelativeTimeRange added in v1.40.15 

func (s *NonTalkTimeFilter) SetRelativeTimeRange(v *RelativeTimeRange) *NonTalkTimeFilter

SetRelativeTimeRange sets the RelativeTimeRange field's value.

func (*NonTalkTimeFilter) SetThreshold added in v1.40.15 

func (s *NonTalkTimeFilter) SetThreshold(v int64) *NonTalkTimeFilter

SetThreshold sets the Threshold field's value.

func (NonTalkTimeFilter) String added in v1.40.15 

func (s NonTalkTimeFilter) 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 NotFoundException added in v1.28.0 

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

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

We can't find the requested resource. Check that the specified name is correct and try your request again.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) 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 (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

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

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) 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 RelativeTimeRange added in v1.40.15 

type RelativeTimeRange struct {

	// The time, in percentage, when Amazon Transcribe stops searching for the specified
	// criteria in your media file. If you include EndPercentage in your request,
	// you must also include StartPercentage.
	EndPercentage *int64 `type:"integer"`

	// The time, in percentage, from the start of your media file until the specified
	// value. Amazon Transcribe searches for your specified criteria in this time
	// segment.
	First *int64 `type:"integer"`

	// The time, in percentage, from the specified value until the end of your media
	// file. Amazon Transcribe searches for your specified criteria in this time
	// segment.
	Last *int64 `type:"integer"`

	// The time, in percentage, when Amazon Transcribe starts searching for the
	// specified criteria in your media file. If you include StartPercentage in
	// your request, you must also include EndPercentage.
	StartPercentage *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A time range, in percentage, between two points in your media file.

You can use StartPercentage and EndPercentage to search a custom segment. For example, setting StartPercentage to 10 and EndPercentage to 50 only searches for your specified criteria in the audio contained between the 10 percent mark and the 50 percent mark of your media file.

You can use also First to search from the start of the media file until the time that you specify. Or use Last to search from the time that you specify until the end of the media file. For example, setting First to 10 only searches for your specified criteria in the audio contained in the first 10 percent of the media file.

If you prefer to use milliseconds instead of percentage, see .

func (RelativeTimeRange) GoString added in v1.40.15 

func (s RelativeTimeRange) 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 (*RelativeTimeRange) SetEndPercentage added in v1.40.15 

func (s *RelativeTimeRange) SetEndPercentage(v int64) *RelativeTimeRange

SetEndPercentage sets the EndPercentage field's value.

func (*RelativeTimeRange) SetFirst added in v1.40.15 

func (s *RelativeTimeRange) SetFirst(v int64) *RelativeTimeRange

SetFirst sets the First field's value.

func (*RelativeTimeRange) SetLast added in v1.40.15 

func (s *RelativeTimeRange) SetLast(v int64) *RelativeTimeRange

SetLast sets the Last field's value.

func (*RelativeTimeRange) SetStartPercentage added in v1.40.15 

func (s *RelativeTimeRange) SetStartPercentage(v int64) *RelativeTimeRange

SetStartPercentage sets the StartPercentage field's value.

func (RelativeTimeRange) String added in v1.40.15 

func (s RelativeTimeRange) 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 Rule added in v1.40.15 

type Rule struct {

	// Flag the presence or absence of interruptions in your Call Analytics transcription
	// output. Refer to for more detail.
	InterruptionFilter *InterruptionFilter `type:"structure"`

	// Flag the presence or absence of periods of silence in your Call Analytics
	// transcription output. Refer to for more detail.
	NonTalkTimeFilter *NonTalkTimeFilter `type:"structure"`

	// Flag the presence or absence of specific sentiments in your Call Analytics
	// transcription output. Refer to for more detail.
	SentimentFilter *SentimentFilter `type:"structure"`

	// Flag the presence or absence of specific words or phrases in your Call Analytics
	// transcription output. Refer to for more detail.
	TranscriptFilter *TranscriptFilter `type:"structure"`
	// contains filtered or unexported fields
}

A rule is a set of criteria that you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

Rules can include these parameters: , , , and .

To learn more about Call Analytics rules and categories, see Creating categories for post-call transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) and Creating categories for real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html).

To learn more about Call Analytics, see Analyzing call center audio with Call Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html).

func (Rule) GoString added in v1.40.15 

func (s Rule) 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 (*Rule) SetInterruptionFilter added in v1.40.15 

func (s *Rule) SetInterruptionFilter(v *InterruptionFilter) *Rule

SetInterruptionFilter sets the InterruptionFilter field's value.

func (*Rule) SetNonTalkTimeFilter added in v1.40.15 

func (s *Rule) SetNonTalkTimeFilter(v *NonTalkTimeFilter) *Rule

SetNonTalkTimeFilter sets the NonTalkTimeFilter field's value.

func (*Rule) SetSentimentFilter added in v1.40.15 

func (s *Rule) SetSentimentFilter(v *SentimentFilter) *Rule

SetSentimentFilter sets the SentimentFilter field's value.

func (*Rule) SetTranscriptFilter added in v1.40.15 

func (s *Rule) SetTranscriptFilter(v *TranscriptFilter) *Rule

SetTranscriptFilter sets the TranscriptFilter field's value.

func (Rule) String added in v1.40.15 

func (s Rule) 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 (*Rule) Validate added in v1.40.15 

func (s *Rule) Validate() error

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

type SentimentFilter added in v1.40.15 

type SentimentFilter struct {

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for the specified sentiments. See for more
	// detail.
	AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"`

	// Set to TRUE to flag the sentiments that you didn't include in your request.
	// Set to FALSE to flag the sentiments that you specified in your request.
	Negate *bool `type:"boolean"`

	// Specify the participant that you want to flag. Omitting this parameter is
	// equivalent to specifying both participants.
	ParticipantRole *string `type:"string" enum:"ParticipantRole"`

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for the specified sentiments. See for more
	// detail.
	RelativeTimeRange *RelativeTimeRange `type:"structure"`

	// Specify the sentiments that you want to flag.
	//
	// Sentiments is a required field
	Sentiments []*string `min:"1" type:"list" required:"true" enum:"SentimentValue"`
	// contains filtered or unexported fields
}

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

Rules using SentimentFilter are designed to match:

  • The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call

  • The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call

See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) for usage examples.

func (SentimentFilter) GoString added in v1.40.15 

func (s SentimentFilter) 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 (*SentimentFilter) SetAbsoluteTimeRange added in v1.40.15 

func (s *SentimentFilter) SetAbsoluteTimeRange(v *AbsoluteTimeRange) *SentimentFilter

SetAbsoluteTimeRange sets the AbsoluteTimeRange field's value.

func (*SentimentFilter) SetNegate added in v1.40.15 

func (s *SentimentFilter) SetNegate(v bool) *SentimentFilter

SetNegate sets the Negate field's value.

func (*SentimentFilter) SetParticipantRole added in v1.40.15 

func (s *SentimentFilter) SetParticipantRole(v string) *SentimentFilter

SetParticipantRole sets the ParticipantRole field's value.

func (*SentimentFilter) SetRelativeTimeRange added in v1.40.15 

func (s *SentimentFilter) SetRelativeTimeRange(v *RelativeTimeRange) *SentimentFilter

SetRelativeTimeRange sets the RelativeTimeRange field's value.

func (*SentimentFilter) SetSentiments added in v1.40.15 

func (s *SentimentFilter) SetSentiments(v []*string) *SentimentFilter

SetSentiments sets the Sentiments field's value.

func (SentimentFilter) String added in v1.40.15 

func (s SentimentFilter) 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 (*SentimentFilter) Validate added in v1.40.15 

func (s *SentimentFilter) Validate() error

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

type Settings added in v1.13.28 

type Settings struct {

	// Enables channel identification in multi-channel audio.
	//
	// Channel identification transcribes the audio on each channel independently,
	// then appends the output for each channel into one transcript.
	//
	// For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html).
	ChannelIdentification *bool `type:"boolean"`

	// Indicate the maximum number of alternative transcriptions you want Amazon
	// Transcribe to include in your transcript.
	//
	// If you select a number greater than the number of alternative transcriptions
	// generated by Amazon Transcribe, only the actual number of alternative transcriptions
	// are included.
	//
	// If you include MaxAlternatives in your request, you must also include ShowAlternatives
	// with a value of true.
	//
	// For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html).
	MaxAlternatives *int64 `min:"2" type:"integer"`

	// Specify the maximum number of speakers you want to partition in your media.
	//
	// Note that if your media contains more speakers than the specified number,
	// multiple speakers are treated as a single speaker.
	//
	// If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels
	// field to true.
	MaxSpeakerLabels *int64 `min:"2" type:"integer"`

	// To include alternative transcriptions within your transcription output, include
	// ShowAlternatives in your transcription request.
	//
	// If you have multi-channel audio and do not enable channel identification,
	// your audio is transcribed in a continuous manner and your transcript does
	// not separate the speech by channel.
	//
	// If you include ShowAlternatives, you must also include MaxAlternatives, which
	// is the maximum number of alternative transcriptions you want Amazon Transcribe
	// to generate.
	//
	// For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html).
	ShowAlternatives *bool `type:"boolean"`

	// Enables speaker partitioning (diarization) in your transcription output.
	// Speaker partitioning labels the speech from individual speakers in your media
	// file.
	//
	// If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
	//
	// For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html).
	ShowSpeakerLabels *bool `type:"boolean"`

	// Specify how you want your custom vocabulary filter applied to your transcript.
	//
	// To replace words with ***, choose mask.
	//
	// To delete words, choose remove.
	//
	// To flag words without changing them, choose tag.
	VocabularyFilterMethod *string `type:"string" enum:"VocabularyFilterMethod"`

	// The name of the custom vocabulary filter you want to use in your transcription
	// job request. This name is case sensitive, cannot contain spaces, and must
	// be unique within an Amazon Web Services account.
	//
	// Note that if you include VocabularyFilterName in your request, you must also
	// include VocabularyFilterMethod.
	VocabularyFilterName *string `min:"1" type:"string"`

	// The name of the custom vocabulary you want to use in your transcription job
	// request. This name is case sensitive, cannot contain spaces, and must be
	// unique within an Amazon Web Services account.
	VocabularyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.

func (Settings) GoString added in v1.13.28 

func (s Settings) 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 (*Settings) SetChannelIdentification added in v1.15.3 

func (s *Settings) SetChannelIdentification(v bool) *Settings

SetChannelIdentification sets the ChannelIdentification field's value.

func (*Settings) SetMaxAlternatives added in v1.25.39 

func (s *Settings) SetMaxAlternatives(v int64) *Settings

SetMaxAlternatives sets the MaxAlternatives field's value.

func (*Settings) SetMaxSpeakerLabels added in v1.13.28 

func (s *Settings) SetMaxSpeakerLabels(v int64) *Settings

SetMaxSpeakerLabels sets the MaxSpeakerLabels field's value.

func (*Settings) SetShowAlternatives added in v1.25.39 

func (s *Settings) SetShowAlternatives(v bool) *Settings

SetShowAlternatives sets the ShowAlternatives field's value.

func (*Settings) SetShowSpeakerLabels added in v1.13.28 

func (s *Settings) SetShowSpeakerLabels(v bool) *Settings

SetShowSpeakerLabels sets the ShowSpeakerLabels field's value.

func (*Settings) SetVocabularyFilterMethod added in v1.26.7 

func (s *Settings) SetVocabularyFilterMethod(v string) *Settings

SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.

func (*Settings) SetVocabularyFilterName added in v1.26.7 

func (s *Settings) SetVocabularyFilterName(v string) *Settings

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*Settings) SetVocabularyName added in v1.13.28 

func (s *Settings) SetVocabularyName(v string) *Settings

SetVocabularyName sets the VocabularyName field's value.

func (Settings) String added in v1.13.28 

func (s Settings) 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 (*Settings) Validate added in v1.13.28 

func (s *Settings) Validate() error

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

type StartCallAnalyticsJobInput added in v1.40.15 

type StartCallAnalyticsJobInput struct {

	// A unique name, chosen by you, for your Call Analytics job.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new job with the same
	// name as an existing job, you get a ConflictException error.
	//
	// CallAnalyticsJobName is a required field
	CallAnalyticsJobName *string `min:"1" type:"string" required:"true"`

	// Makes it possible to specify which speaker is on which channel. For example,
	// if your agent is the first participant to speak, you would set ChannelId
	// to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate
	// that it's the agent speaking).
	ChannelDefinitions []*ChannelDefinition `min:"2" type:"list"`

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files. If the role that you
	// specify doesn’t have the appropriate permissions to access the specified
	// Amazon S3 location, your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	DataAccessRoleArn *string `min:"20" type:"string"`

	// Describes the Amazon S3 location of the media file you want to use in your
	// Call Analytics request.
	//
	// Media is a required field
	Media *Media `type:"structure" required:"true"`

	// The KMS key you want to use to encrypt your Call Analytics output.
	//
	// If using a key located in the current Amazon Web Services account, you can
	// specify your KMS key in one of four ways:
	//
	// Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use an alias for the KMS key ID. For example, alias/ExampleAlias.
	//
	// Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If using a key located in a different Amazon Web Services account than the
	// current Amazon Web Services account, you can specify your KMS key in one
	// of two ways:
	//
	// Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If you do not specify an encryption key, your output is encrypted with the
	// default Amazon S3 key (SSE-S3).
	//
	// If you specify a KMS key to encrypt your output, you must also specify an
	// output location using the OutputLocation parameter.
	//
	// Note that the role making the request must have permission to use the specified
	// KMS key.
	OutputEncryptionKMSKeyId *string `min:"1" type:"string"`

	// The Amazon S3 location where you want your Call Analytics transcription output
	// stored. You can use any of the following formats to specify the output location:
	//
	// s3://DOC-EXAMPLE-BUCKET
	//
	// s3://DOC-EXAMPLE-BUCKET/my-output-folder/
	//
	// s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
	//
	// Unless you specify a file name (option 3), the name of your output file has
	// a default value that matches the name you specified for your transcription
	// job using the CallAnalyticsJobName parameter.
	//
	// You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId
	// parameter. If you do not specify a KMS key, Amazon Transcribe uses the default
	// Amazon S3 key for server-side encryption.
	//
	// If you do not specify OutputLocation, your transcript is placed in a service-managed
	// Amazon S3 bucket and you are provided with a URI to access your transcript.
	OutputLocation *string `min:"1" type:"string"`

	// Specify additional optional settings in your request, including content redaction;
	// allows you to apply custom language models, vocabulary filters, and custom
	// vocabularies to your Call Analytics job.
	Settings *CallAnalyticsJobSettings `type:"structure"`
	// contains filtered or unexported fields
}

func (StartCallAnalyticsJobInput) GoString added in v1.40.15 

func (s StartCallAnalyticsJobInput) 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 (*StartCallAnalyticsJobInput) SetCallAnalyticsJobName added in v1.40.15 

func (s *StartCallAnalyticsJobInput) SetCallAnalyticsJobName(v string) *StartCallAnalyticsJobInput

SetCallAnalyticsJobName sets the CallAnalyticsJobName field's value.

func (*StartCallAnalyticsJobInput) SetChannelDefinitions added in v1.40.15 

func (s *StartCallAnalyticsJobInput) SetChannelDefinitions(v []*ChannelDefinition) *StartCallAnalyticsJobInput

SetChannelDefinitions sets the ChannelDefinitions field's value.

func (*StartCallAnalyticsJobInput) SetDataAccessRoleArn added in v1.40.15 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartCallAnalyticsJobInput) SetMedia added in v1.40.15 

func (s *StartCallAnalyticsJobInput) SetMedia(v *Media) *StartCallAnalyticsJobInput

SetMedia sets the Media field's value.

func (*StartCallAnalyticsJobInput) SetOutputEncryptionKMSKeyId added in v1.40.15 

func (s *StartCallAnalyticsJobInput) SetOutputEncryptionKMSKeyId(v string) *StartCallAnalyticsJobInput

SetOutputEncryptionKMSKeyId sets the OutputEncryptionKMSKeyId field's value.

func (*StartCallAnalyticsJobInput) SetOutputLocation added in v1.40.15 

func (s *StartCallAnalyticsJobInput) SetOutputLocation(v string) *StartCallAnalyticsJobInput

SetOutputLocation sets the OutputLocation field's value.

func (*StartCallAnalyticsJobInput) SetSettings added in v1.40.15 

func (s *StartCallAnalyticsJobInput) SetSettings(v *CallAnalyticsJobSettings) *StartCallAnalyticsJobInput

SetSettings sets the Settings field's value.

func (StartCallAnalyticsJobInput) String added in v1.40.15 

func (s StartCallAnalyticsJobInput) 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 (*StartCallAnalyticsJobInput) Validate added in v1.40.15 

func (s *StartCallAnalyticsJobInput) Validate() error

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

type StartCallAnalyticsJobOutput added in v1.40.15 

type StartCallAnalyticsJobOutput struct {

	// Provides detailed information about the current Call Analytics job, including
	// job status and, if applicable, failure reason.
	CallAnalyticsJob *CallAnalyticsJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartCallAnalyticsJobOutput) GoString added in v1.40.15 

func (s StartCallAnalyticsJobOutput) 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 (*StartCallAnalyticsJobOutput) SetCallAnalyticsJob added in v1.40.15 

func (s *StartCallAnalyticsJobOutput) SetCallAnalyticsJob(v *CallAnalyticsJob) *StartCallAnalyticsJobOutput

SetCallAnalyticsJob sets the CallAnalyticsJob field's value.

func (StartCallAnalyticsJobOutput) String added in v1.40.15 

func (s StartCallAnalyticsJobOutput) 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 StartMedicalScribeJobInput added in v1.48.5 

type StartMedicalScribeJobInput struct {

	// Makes it possible to specify which speaker is on which channel. For example,
	// if the clinician is the first participant to speak, you would set ChannelId
	// of the first ChannelDefinition in the list to 0 (to indicate the first channel)
	// and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking).
	// Then you would set the ChannelId of the second ChannelDefinition in the list
	// to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to
	// indicate that it's the patient speaking).
	ChannelDefinitions []*MedicalScribeChannelDefinition `min:"2" type:"list"`

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files, write to the output
	// bucket, and use your KMS key if supplied. If the role that you specify doesn’t
	// have the appropriate permissions your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// A map of plain text, non-secret key:value pairs, known as encryption context
	// pairs, that provide an added layer of security for your data. For more information,
	// see KMS encryption context (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context)
	// and Asymmetric keys in KMS (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html).
	KMSEncryptionContext map[string]*string `min:"1" type:"map"`

	// Describes the Amazon S3 location of the media file you want to use in your
	// request.
	//
	// For information on supported media formats, refer to the MediaFormat parameter
	// or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
	// section in the Amazon S3 Developer Guide.
	//
	// Media is a required field
	Media *Media `type:"structure" required:"true"`

	// A unique name, chosen by you, for your Medical Scribe job.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new job with the same
	// name as an existing job, you get a ConflictException error.
	//
	// MedicalScribeJobName is a required field
	MedicalScribeJobName *string `min:"1" type:"string" required:"true"`

	// The name of the Amazon S3 bucket where you want your Medical Scribe output
	// stored. Do not include the S3:// prefix of the specified bucket.
	//
	// Note that the role specified in the DataAccessRoleArn request parameter must
	// have permission to use the specified location. You can change Amazon S3 permissions
	// using the Amazon Web Services Management Console (https://console.aws.amazon.com/s3).
	// See also Permissions Required for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user).
	//
	// OutputBucketName is a required field
	OutputBucketName *string `type:"string" required:"true"`

	// The KMS key you want to use to encrypt your Medical Scribe output.
	//
	// If using a key located in the current Amazon Web Services account, you can
	// specify your KMS key in one of four ways:
	//
	// Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use an alias for the KMS key ID. For example, alias/ExampleAlias.
	//
	// Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If using a key located in a different Amazon Web Services account than the
	// current Amazon Web Services account, you can specify your KMS key in one
	// of two ways:
	//
	// Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If you do not specify an encryption key, your output is encrypted with the
	// default Amazon S3 key (SSE-S3).
	//
	// Note that the role specified in the DataAccessRoleArn request parameter must
	// have permission to use the specified KMS key.
	OutputEncryptionKMSKeyId *string `min:"1" type:"string"`

	// Makes it possible to control how your Medical Scribe job is processed using
	// a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions
	// are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions
	// are not set. One and only one of ChannelIdentification and ShowSpeakerLabels
	// must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set.
	// Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName,
	// VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName
	// is set.
	//
	// Settings is a required field
	Settings *MedicalScribeSettings `type:"structure" required:"true"`

	// Adds one or more custom tags, each in the form of a key:value pair, to the
	// Medica Scribe job.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (StartMedicalScribeJobInput) GoString added in v1.48.5 

func (s StartMedicalScribeJobInput) 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 (*StartMedicalScribeJobInput) SetChannelDefinitions added in v1.48.5 

func (s *StartMedicalScribeJobInput) SetChannelDefinitions(v []*MedicalScribeChannelDefinition) *StartMedicalScribeJobInput

SetChannelDefinitions sets the ChannelDefinitions field's value.

func (*StartMedicalScribeJobInput) SetDataAccessRoleArn added in v1.48.5 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartMedicalScribeJobInput) SetKMSEncryptionContext added in v1.48.5 

func (s *StartMedicalScribeJobInput) SetKMSEncryptionContext(v map[string]*string) *StartMedicalScribeJobInput

SetKMSEncryptionContext sets the KMSEncryptionContext field's value.

func (*StartMedicalScribeJobInput) SetMedia added in v1.48.5 

func (s *StartMedicalScribeJobInput) SetMedia(v *Media) *StartMedicalScribeJobInput

SetMedia sets the Media field's value.

func (*StartMedicalScribeJobInput) SetMedicalScribeJobName added in v1.48.5 

func (s *StartMedicalScribeJobInput) SetMedicalScribeJobName(v string) *StartMedicalScribeJobInput

SetMedicalScribeJobName sets the MedicalScribeJobName field's value.

func (*StartMedicalScribeJobInput) SetOutputBucketName added in v1.48.5 

func (s *StartMedicalScribeJobInput) SetOutputBucketName(v string) *StartMedicalScribeJobInput

SetOutputBucketName sets the OutputBucketName field's value.

func (*StartMedicalScribeJobInput) SetOutputEncryptionKMSKeyId added in v1.48.5 

func (s *StartMedicalScribeJobInput) SetOutputEncryptionKMSKeyId(v string) *StartMedicalScribeJobInput

SetOutputEncryptionKMSKeyId sets the OutputEncryptionKMSKeyId field's value.

func (*StartMedicalScribeJobInput) SetSettings added in v1.48.5 

func (s *StartMedicalScribeJobInput) SetSettings(v *MedicalScribeSettings) *StartMedicalScribeJobInput

SetSettings sets the Settings field's value.

func (*StartMedicalScribeJobInput) SetTags added in v1.48.5 

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

SetTags sets the Tags field's value.

func (StartMedicalScribeJobInput) String added in v1.48.5 

func (s StartMedicalScribeJobInput) 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 (*StartMedicalScribeJobInput) Validate added in v1.48.5 

func (s *StartMedicalScribeJobInput) Validate() error

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

type StartMedicalScribeJobOutput added in v1.48.5 

type StartMedicalScribeJobOutput struct {

	// Provides detailed information about the current Medical Scribe job, including
	// job status and, if applicable, failure reason.
	MedicalScribeJob *MedicalScribeJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartMedicalScribeJobOutput) GoString added in v1.48.5 

func (s StartMedicalScribeJobOutput) 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 (*StartMedicalScribeJobOutput) SetMedicalScribeJob added in v1.48.5 

func (s *StartMedicalScribeJobOutput) SetMedicalScribeJob(v *MedicalScribeJob) *StartMedicalScribeJobOutput

SetMedicalScribeJob sets the MedicalScribeJob field's value.

func (StartMedicalScribeJobOutput) String added in v1.48.5 

func (s StartMedicalScribeJobOutput) 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 StartMedicalTranscriptionJobInput added in v1.30.5 

type StartMedicalTranscriptionJobInput struct {

	// Labels all personal health information (PHI) identified in your transcript.
	// For more information, see Identifying personal health information (PHI) in
	// a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html).
	ContentIdentificationType *string `type:"string" enum:"MedicalContentIdentificationType"`

	// A map of plain text, non-secret key:value pairs, known as encryption context
	// pairs, that provide an added layer of security for your data. For more information,
	// see KMS encryption context (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context)
	// and Asymmetric keys in KMS (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html).
	KMSEncryptionContext map[string]*string `min:"1" type:"map"`

	// The language code that represents the language spoken in the input media
	// file. US English (en-US) is the only valid value for medical transcription
	// jobs. Any other value you enter for language code results in a BadRequestException
	// error.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Describes the Amazon S3 location of the media file you want to use in your
	// request.
	//
	// For information on supported media formats, refer to the MediaFormat parameter
	// or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
	// section in the Amazon S3 Developer Guide.
	//
	// Media is a required field
	Media *Media `type:"structure" required:"true"`

	// Specify the format of your input media file.
	MediaFormat *string `type:"string" enum:"MediaFormat"`

	// The sample rate, in hertz, of the audio track in your input media file.
	//
	// If you do not specify the media sample rate, Amazon Transcribe Medical determines
	// it for you. If you specify the sample rate, it must match the rate detected
	// by Amazon Transcribe Medical; if there's a mismatch between the value that
	// you specify and the value detected, your job fails. Therefore, in most cases,
	// it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical
	// determine the sample rate.
	MediaSampleRateHertz *int64 `min:"16000" type:"integer"`

	// A unique name, chosen by you, for your medical transcription job. The name
	// that you specify is also used as the default name of your transcription output
	// file. If you want to specify a different name for your transcription output,
	// use the OutputKey parameter.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new job with the same
	// name as an existing job, you get a ConflictException error.
	//
	// MedicalTranscriptionJobName is a required field
	MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"`

	// The name of the Amazon S3 bucket where you want your medical transcription
	// output stored. Do not include the S3:// prefix of the specified bucket.
	//
	// If you want your output to go to a sub-folder of this bucket, specify it
	// using the OutputKey parameter; OutputBucketName only accepts the name of
	// a bucket.
	//
	// For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
	// OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output
	// stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET
	// and OutputKey to test-files/.
	//
	// Note that Amazon Transcribe must have permission to use the specified location.
	// You can change Amazon S3 permissions using the Amazon Web Services Management
	// Console (https://console.aws.amazon.com/s3). See also Permissions Required
	// for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user).
	//
	// OutputBucketName is a required field
	OutputBucketName *string `type:"string" required:"true"`

	// The KMS key you want to use to encrypt your medical transcription output.
	//
	// If using a key located in the current Amazon Web Services account, you can
	// specify your KMS key in one of four ways:
	//
	// Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use an alias for the KMS key ID. For example, alias/ExampleAlias.
	//
	// Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If using a key located in a different Amazon Web Services account than the
	// current Amazon Web Services account, you can specify your KMS key in one
	// of two ways:
	//
	// Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If you do not specify an encryption key, your output is encrypted with the
	// default Amazon S3 key (SSE-S3).
	//
	// If you specify a KMS key to encrypt your output, you must also specify an
	// output location using the OutputLocation parameter.
	//
	// Note that the role making the request must have permission to use the specified
	// KMS key.
	OutputEncryptionKMSKeyId *string `min:"1" type:"string"`

	// Use in combination with OutputBucketName to specify the output location of
	// your transcript and, optionally, a unique name for your output file. The
	// default name for your transcription output is the same as the name you specified
	// for your medical transcription job (MedicalTranscriptionJobName).
	//
	// Here are some examples of how you can use OutputKey:
	//
	//    * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json'
	//    as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
	//
	//    * If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,
	//    'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the
	//    OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
	//
	//    * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json'
	//    as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
	//
	//    * If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,
	//    'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript'
	//    as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
	//
	// If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
	// one is created for you.
	OutputKey *string `min:"1" type:"string"`

	// Specify additional optional settings in your request, including channel identification,
	// alternative transcriptions, and speaker partitioning. You can use that to
	// apply custom vocabularies to your transcription job.
	Settings *MedicalTranscriptionSetting `type:"structure"`

	// Specify the predominant medical specialty represented in your media. For
	// batch transcriptions, PRIMARYCARE is the only valid value. If you require
	// additional specialties, refer to .
	//
	// Specialty is a required field
	Specialty *string `type:"string" required:"true" enum:"Specialty"`

	// Adds one or more custom tags, each in the form of a key:value pair, to a
	// new medical transcription job at the time you start this new job.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`

	// Specify whether your input media contains only one person (DICTATION) or
	// contains a conversation between two people (CONVERSATION).
	//
	// For example, DICTATION could be used for a medical professional wanting to
	// transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient
	// dialogue during the patient's office visit.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"Type"`
	// contains filtered or unexported fields
}

func (StartMedicalTranscriptionJobInput) GoString added in v1.30.5 

func (s StartMedicalTranscriptionJobInput) 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 (*StartMedicalTranscriptionJobInput) SetContentIdentificationType added in v1.38.40 

func (s *StartMedicalTranscriptionJobInput) SetContentIdentificationType(v string) *StartMedicalTranscriptionJobInput

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartMedicalTranscriptionJobInput) SetKMSEncryptionContext added in v1.40.41 

func (s *StartMedicalTranscriptionJobInput) SetKMSEncryptionContext(v map[string]*string) *StartMedicalTranscriptionJobInput

SetKMSEncryptionContext sets the KMSEncryptionContext field's value.

func (*StartMedicalTranscriptionJobInput) SetLanguageCode added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetLanguageCode(v string) *StartMedicalTranscriptionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartMedicalTranscriptionJobInput) SetMedia added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetMedia(v *Media) *StartMedicalTranscriptionJobInput

SetMedia sets the Media field's value.

func (*StartMedicalTranscriptionJobInput) SetMediaFormat added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetMediaFormat(v string) *StartMedicalTranscriptionJobInput

SetMediaFormat sets the MediaFormat field's value.

func (*StartMedicalTranscriptionJobInput) SetMediaSampleRateHertz added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetMediaSampleRateHertz(v int64) *StartMedicalTranscriptionJobInput

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartMedicalTranscriptionJobInput) SetMedicalTranscriptionJobName added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetMedicalTranscriptionJobName(v string) *StartMedicalTranscriptionJobInput

SetMedicalTranscriptionJobName sets the MedicalTranscriptionJobName field's value.

func (*StartMedicalTranscriptionJobInput) SetOutputBucketName added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetOutputBucketName(v string) *StartMedicalTranscriptionJobInput

SetOutputBucketName sets the OutputBucketName field's value.

func (*StartMedicalTranscriptionJobInput) SetOutputEncryptionKMSKeyId added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetOutputEncryptionKMSKeyId(v string) *StartMedicalTranscriptionJobInput

SetOutputEncryptionKMSKeyId sets the OutputEncryptionKMSKeyId field's value.

func (*StartMedicalTranscriptionJobInput) SetOutputKey added in v1.34.31 

func (s *StartMedicalTranscriptionJobInput) SetOutputKey(v string) *StartMedicalTranscriptionJobInput

SetOutputKey sets the OutputKey field's value.

func (*StartMedicalTranscriptionJobInput) SetSettings added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetSettings(v *MedicalTranscriptionSetting) *StartMedicalTranscriptionJobInput

SetSettings sets the Settings field's value.

func (*StartMedicalTranscriptionJobInput) SetSpecialty added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetSpecialty(v string) *StartMedicalTranscriptionJobInput

SetSpecialty sets the Specialty field's value.

func (*StartMedicalTranscriptionJobInput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (*StartMedicalTranscriptionJobInput) SetType added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) SetType(v string) *StartMedicalTranscriptionJobInput

SetType sets the Type field's value.

func (StartMedicalTranscriptionJobInput) String added in v1.30.5 

func (s StartMedicalTranscriptionJobInput) 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 (*StartMedicalTranscriptionJobInput) Validate added in v1.30.5 

func (s *StartMedicalTranscriptionJobInput) Validate() error

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

type StartMedicalTranscriptionJobOutput added in v1.30.5 

type StartMedicalTranscriptionJobOutput struct {

	// Provides detailed information about the current medical transcription job,
	// including job status and, if applicable, failure reason.
	MedicalTranscriptionJob *MedicalTranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartMedicalTranscriptionJobOutput) GoString added in v1.30.5 

func (s StartMedicalTranscriptionJobOutput) 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 (*StartMedicalTranscriptionJobOutput) SetMedicalTranscriptionJob added in v1.30.5 

func (s *StartMedicalTranscriptionJobOutput) SetMedicalTranscriptionJob(v *MedicalTranscriptionJob) *StartMedicalTranscriptionJobOutput

SetMedicalTranscriptionJob sets the MedicalTranscriptionJob field's value.

func (StartMedicalTranscriptionJobOutput) String added in v1.30.5 

func (s StartMedicalTranscriptionJobOutput) 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 StartTranscriptionJobInput 

type StartTranscriptionJobInput struct {

	// Makes it possible to redact or flag specified personally identifiable information
	// (PII) in your transcript. If you use ContentRedaction, you must also include
	// the sub-parameters: RedactionOutput and RedactionType. You can optionally
	// include PiiEntityTypes to choose which types of PII you want to redact. If
	// you do not include PiiEntityTypes in your request, all PII is redacted.
	ContentRedaction *ContentRedaction `type:"structure"`

	// Enables automatic language identification in your transcription job request.
	// Use this parameter if your media file contains only one language. If your
	// media contains multiple languages, use IdentifyMultipleLanguages instead.
	//
	// If you include IdentifyLanguage, you can optionally include a list of language
	// codes, using LanguageOptions, that you think may be present in your media
	// file. Including LanguageOptions restricts IdentifyLanguage to only the language
	// options that you specify, which can improve transcription accuracy.
	//
	// If you want to apply a custom language model, a custom vocabulary, or a custom
	// vocabulary filter to your automatic language identification request, include
	// LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName,
	// and VocabularyFilterName). If you include LanguageIdSettings, also include
	// LanguageOptions.
	//
	// Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages
	// in your request. If you include more than one of these parameters, your transcription
	// job fails.
	IdentifyLanguage *bool `type:"boolean"`

	// Enables automatic multi-language identification in your transcription job
	// request. Use this parameter if your media file contains more than one language.
	// If your media contains only one language, use IdentifyLanguage instead.
	//
	// If you include IdentifyMultipleLanguages, you can optionally include a list
	// of language codes, using LanguageOptions, that you think may be present in
	// your media file. Including LanguageOptions restricts IdentifyLanguage to
	// only the language options that you specify, which can improve transcription
	// accuracy.
	//
	// If you want to apply a custom vocabulary or a custom vocabulary filter to
	// your automatic language identification request, include LanguageIdSettings
	// with the relevant sub-parameters (VocabularyName and VocabularyFilterName).
	// If you include LanguageIdSettings, also include LanguageOptions.
	//
	// Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages
	// in your request. If you include more than one of these parameters, your transcription
	// job fails.
	IdentifyMultipleLanguages *bool `type:"boolean"`

	// Makes it possible to control how your transcription job is processed. Currently,
	// the only JobExecutionSettings modification you can choose is enabling job
	// queueing using the AllowDeferredExecution sub-parameter.
	//
	// If you include JobExecutionSettings in your request, you must also include
	// the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.
	JobExecutionSettings *JobExecutionSettings `type:"structure"`

	// A map of plain text, non-secret key:value pairs, known as encryption context
	// pairs, that provide an added layer of security for your data. For more information,
	// see KMS encryption context (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context)
	// and Asymmetric keys in KMS (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html).
	KMSEncryptionContext map[string]*string `min:"1" type:"map"`

	// The language code that represents the language spoken in the input media
	// file.
	//
	// If you're unsure of the language spoken in your media file, consider using
	// IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language
	// identification.
	//
	// Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages
	// in your request. If you include more than one of these parameters, your transcription
	// job fails.
	//
	// For a list of supported languages and their associated language codes, refer
	// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	//
	// To transcribe speech in Modern Standard Arabic (ar-SA), your media file must
	// be encoded at a sample rate of 16,000 Hz or higher.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// If using automatic language identification in your request and you want to
	// apply a custom language model, a custom vocabulary, or a custom vocabulary
	// filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName,
	// LanguageModelName, and VocabularyFilterName). Note that multi-language identification
	// (IdentifyMultipleLanguages) doesn't support custom language models.
	//
	// LanguageIdSettings supports two to five language codes. Each language code
	// you include can have an associated custom language model, custom vocabulary,
	// and custom vocabulary filter. The language codes that you specify must match
	// the languages of the associated custom language models, custom vocabularies,
	// and custom vocabulary filters.
	//
	// It's recommended that you include LanguageOptions when using LanguageIdSettings
	// to ensure that the correct language dialect is identified. For example, if
	// you specify a custom vocabulary that is in en-US but Amazon Transcribe determines
	// that the language spoken in your media is en-AU, your custom vocabulary is
	// not applied to your transcription. If you include LanguageOptions and include
	// en-US as the only English language dialect, your custom vocabulary is applied
	// to your transcription.
	//
	// If you want to include a custom language model with your request but do not
	// want to use automatic language identification, use instead the parameter
	// with the LanguageModelName sub-parameter. If you want to include a custom
	// vocabulary or a custom vocabulary filter (or both) with your request but
	// do not want to use automatic language identification, use instead the parameter
	// with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
	LanguageIdSettings map[string]*LanguageIdSettings `min:"1" type:"map"`

	// You can specify two or more language codes that represent the languages you
	// think may be present in your media. Including more than five is not recommended.
	// If you're unsure what languages are present, do not include this parameter.
	//
	// If you include LanguageOptions in your request, you must also include IdentifyLanguage.
	//
	// For more information, refer to Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html).
	//
	// To transcribe speech in Modern Standard Arabic (ar-SA), your media file must
	// be encoded at a sample rate of 16,000 Hz or higher.
	LanguageOptions []*string `min:"1" type:"list" enum:"LanguageCode"`

	// Describes the Amazon S3 location of the media file you want to use in your
	// request.
	//
	// Media is a required field
	Media *Media `type:"structure" required:"true"`

	// Specify the format of your input media file.
	MediaFormat *string `type:"string" enum:"MediaFormat"`

	// The sample rate, in hertz, of the audio track in your input media file.
	//
	// If you do not specify the media sample rate, Amazon Transcribe determines
	// it for you. If you specify the sample rate, it must match the rate detected
	// by Amazon Transcribe. If there's a mismatch between the value that you specify
	// and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz
	// and let Amazon Transcribe determine the sample rate.
	MediaSampleRateHertz *int64 `min:"8000" type:"integer"`

	// Specify the custom language model you want to include with your transcription
	// job. If you include ModelSettings in your request, you must include the LanguageModelName
	// sub-parameter.
	//
	// For more information, see Custom language models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html).
	ModelSettings *ModelSettings `type:"structure"`

	// The name of the Amazon S3 bucket where you want your transcription output
	// stored. Do not include the S3:// prefix of the specified bucket.
	//
	// If you want your output to go to a sub-folder of this bucket, specify it
	// using the OutputKey parameter; OutputBucketName only accepts the name of
	// a bucket.
	//
	// For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
	// OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output
	// stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET
	// and OutputKey to test-files/.
	//
	// Note that Amazon Transcribe must have permission to use the specified location.
	// You can change Amazon S3 permissions using the Amazon Web Services Management
	// Console (https://console.aws.amazon.com/s3). See also Permissions Required
	// for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user).
	//
	// If you do not specify OutputBucketName, your transcript is placed in a service-managed
	// Amazon S3 bucket and you are provided with a URI to access your transcript.
	OutputBucketName *string `type:"string"`

	// The KMS key you want to use to encrypt your transcription output.
	//
	// If using a key located in the current Amazon Web Services account, you can
	// specify your KMS key in one of four ways:
	//
	// Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use an alias for the KMS key ID. For example, alias/ExampleAlias.
	//
	// Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If using a key located in a different Amazon Web Services account than the
	// current Amazon Web Services account, you can specify your KMS key in one
	// of two ways:
	//
	// Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	//
	// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
	//
	// If you do not specify an encryption key, your output is encrypted with the
	// default Amazon S3 key (SSE-S3).
	//
	// If you specify a KMS key to encrypt your output, you must also specify an
	// output location using the OutputLocation parameter.
	//
	// Note that the role making the request must have permission to use the specified
	// KMS key.
	OutputEncryptionKMSKeyId *string `min:"1" type:"string"`

	// Use in combination with OutputBucketName to specify the output location of
	// your transcript and, optionally, a unique name for your output file. The
	// default name for your transcription output is the same as the name you specified
	// for your transcription job (TranscriptionJobName).
	//
	// Here are some examples of how you can use OutputKey:
	//
	//    * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json'
	//    as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
	//
	//    * If you specify 'my-first-transcription' as the TranscriptionJobName,
	//    'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the
	//    OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
	//
	//    * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json'
	//    as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
	//
	//    * If you specify 'my-first-transcription' as the TranscriptionJobName,
	//    'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript'
	//    as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
	//
	// If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
	// one is created for you.
	OutputKey *string `min:"1" type:"string"`

	// Specify additional optional settings in your request, including channel identification,
	// alternative transcriptions, speaker partitioning. You can use that to apply
	// custom vocabularies and vocabulary filters.
	//
	// If you want to include a custom vocabulary or a custom vocabulary filter
	// (or both) with your request but do not want to use automatic language identification,
	// use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
	//
	// If you're using automatic language identification with your request and want
	// to include a custom language model, a custom vocabulary, or a custom vocabulary
	// filter, use instead the parameter with the LanguageModelName, VocabularyName
	// or VocabularyFilterName sub-parameters.
	Settings *Settings `type:"structure"`

	// Produces subtitle files for your input media. You can specify WebVTT (*.vtt)
	// and SubRip (*.srt) formats.
	Subtitles *Subtitles `type:"structure"`

	// Adds one or more custom tags, each in the form of a key:value pair, to a
	// new transcription job at the time you start this new job.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []*Tag `min:"1" type:"list"`

	// Enables toxic speech detection in your transcript. If you include ToxicityDetection
	// in your request, you must also include ToxicityCategories.
	//
	// For information on the types of toxic speech Amazon Transcribe can detect,
	// see Detecting toxic speech (https://docs.aws.amazon.com/transcribe/latest/dg/toxic-language.html).
	ToxicityDetection []*ToxicityDetectionSettings `min:"1" type:"list"`

	// A unique name, chosen by you, for your transcription job. The name that you
	// specify is also used as the default name of your transcription output file.
	// If you want to specify a different name for your transcription output, use
	// the OutputKey parameter.
	//
	// This name is case sensitive, cannot contain spaces, and must be unique within
	// an Amazon Web Services account. If you try to create a new job with the same
	// name as an existing job, you get a ConflictException error.
	//
	// TranscriptionJobName is a required field
	TranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartTranscriptionJobInput) GoString 

func (s StartTranscriptionJobInput) 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 (*StartTranscriptionJobInput) SetContentRedaction added in v1.29.11 

func (s *StartTranscriptionJobInput) SetContentRedaction(v *ContentRedaction) *StartTranscriptionJobInput

SetContentRedaction sets the ContentRedaction field's value.

func (*StartTranscriptionJobInput) SetIdentifyLanguage added in v1.34.24 

func (s *StartTranscriptionJobInput) SetIdentifyLanguage(v bool) *StartTranscriptionJobInput

SetIdentifyLanguage sets the IdentifyLanguage field's value.

func (*StartTranscriptionJobInput) SetIdentifyMultipleLanguages added in v1.44.25 

func (s *StartTranscriptionJobInput) SetIdentifyMultipleLanguages(v bool) *StartTranscriptionJobInput

SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value.

func (*StartTranscriptionJobInput) SetJobExecutionSettings added in v1.26.6 

func (s *StartTranscriptionJobInput) SetJobExecutionSettings(v *JobExecutionSettings) *StartTranscriptionJobInput

SetJobExecutionSettings sets the JobExecutionSettings field's value.

func (*StartTranscriptionJobInput) SetKMSEncryptionContext added in v1.40.41 

func (s *StartTranscriptionJobInput) SetKMSEncryptionContext(v map[string]*string) *StartTranscriptionJobInput

SetKMSEncryptionContext sets the KMSEncryptionContext field's value.

func (*StartTranscriptionJobInput) SetLanguageCode 

func (s *StartTranscriptionJobInput) SetLanguageCode(v string) *StartTranscriptionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartTranscriptionJobInput) SetLanguageIdSettings added in v1.41.14 

func (s *StartTranscriptionJobInput) SetLanguageIdSettings(v map[string]*LanguageIdSettings) *StartTranscriptionJobInput

SetLanguageIdSettings sets the LanguageIdSettings field's value.

func (*StartTranscriptionJobInput) SetLanguageOptions added in v1.34.24 

func (s *StartTranscriptionJobInput) SetLanguageOptions(v []*string) *StartTranscriptionJobInput

SetLanguageOptions sets the LanguageOptions field's value.

func (*StartTranscriptionJobInput) SetMedia 

func (s *StartTranscriptionJobInput) SetMedia(v *Media) *StartTranscriptionJobInput

SetMedia sets the Media field's value.

func (*StartTranscriptionJobInput) SetMediaFormat 

func (s *StartTranscriptionJobInput) SetMediaFormat(v string) *StartTranscriptionJobInput

SetMediaFormat sets the MediaFormat field's value.

func (*StartTranscriptionJobInput) SetMediaSampleRateHertz 

func (s *StartTranscriptionJobInput) SetMediaSampleRateHertz(v int64) *StartTranscriptionJobInput

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartTranscriptionJobInput) SetModelSettings added in v1.33.20 

func (s *StartTranscriptionJobInput) SetModelSettings(v *ModelSettings) *StartTranscriptionJobInput

SetModelSettings sets the ModelSettings field's value.

func (*StartTranscriptionJobInput) SetOutputBucketName added in v1.14.22 

func (s *StartTranscriptionJobInput) SetOutputBucketName(v string) *StartTranscriptionJobInput

SetOutputBucketName sets the OutputBucketName field's value.

func (*StartTranscriptionJobInput) SetOutputEncryptionKMSKeyId added in v1.24.5 

func (s *StartTranscriptionJobInput) SetOutputEncryptionKMSKeyId(v string) *StartTranscriptionJobInput

SetOutputEncryptionKMSKeyId sets the OutputEncryptionKMSKeyId field's value.

func (*StartTranscriptionJobInput) SetOutputKey added in v1.34.31 

func (s *StartTranscriptionJobInput) SetOutputKey(v string) *StartTranscriptionJobInput

SetOutputKey sets the OutputKey field's value.

func (*StartTranscriptionJobInput) SetSettings added in v1.13.28 

func (s *StartTranscriptionJobInput) SetSettings(v *Settings) *StartTranscriptionJobInput

SetSettings sets the Settings field's value.

func (*StartTranscriptionJobInput) SetSubtitles added in v1.40.44 

func (s *StartTranscriptionJobInput) SetSubtitles(v *Subtitles) *StartTranscriptionJobInput

SetSubtitles sets the Subtitles field's value.

func (*StartTranscriptionJobInput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (*StartTranscriptionJobInput) SetToxicityDetection added in v1.44.305 

func (s *StartTranscriptionJobInput) SetToxicityDetection(v []*ToxicityDetectionSettings) *StartTranscriptionJobInput

SetToxicityDetection sets the ToxicityDetection field's value.

func (*StartTranscriptionJobInput) SetTranscriptionJobName 

func (s *StartTranscriptionJobInput) SetTranscriptionJobName(v string) *StartTranscriptionJobInput

SetTranscriptionJobName sets the TranscriptionJobName field's value.

func (StartTranscriptionJobInput) String 

func (s StartTranscriptionJobInput) 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 (*StartTranscriptionJobInput) Validate 

func (s *StartTranscriptionJobInput) Validate() error

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

type StartTranscriptionJobOutput 

type StartTranscriptionJobOutput struct {

	// Provides detailed information about the current transcription job, including
	// job status and, if applicable, failure reason.
	TranscriptionJob *TranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartTranscriptionJobOutput) GoString 

func (s StartTranscriptionJobOutput) 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 (*StartTranscriptionJobOutput) SetTranscriptionJob 

func (s *StartTranscriptionJobOutput) SetTranscriptionJob(v *TranscriptionJob) *StartTranscriptionJobOutput

SetTranscriptionJob sets the TranscriptionJob field's value.

func (StartTranscriptionJobOutput) String 

func (s StartTranscriptionJobOutput) 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 Subtitles added in v1.40.44 

type Subtitles struct {

	// Specify the output format for your subtitle file; if you select both WebVTT
	// (vtt) and SubRip (srt) formats, two output files are generated.
	Formats []*string `type:"list" enum:"SubtitleFormat"`

	// Specify the starting value that is assigned to the first subtitle segment.
	//
	// The default start index for Amazon Transcribe is 0, which differs from the
	// more widely used standard of 1. If you're uncertain which value to use, we
	// recommend choosing 1, as this may improve compatibility with other services.
	OutputStartIndex *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Generate subtitles for your media file with your transcription request.

You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or both) as your output format.

Note that your subtitle files are placed in the same location as your transcription output.

func (Subtitles) GoString added in v1.40.44 

func (s Subtitles) 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 (*Subtitles) SetFormats added in v1.40.44 

func (s *Subtitles) SetFormats(v []*string) *Subtitles

SetFormats sets the Formats field's value.

func (*Subtitles) SetOutputStartIndex added in v1.43.25 

func (s *Subtitles) SetOutputStartIndex(v int64) *Subtitles

SetOutputStartIndex sets the OutputStartIndex field's value.

func (Subtitles) String added in v1.40.44 

func (s Subtitles) 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 SubtitlesOutput_ added in v1.40.44 

type SubtitlesOutput_ struct {

	// Provides the format of your subtitle files. If your request included both
	// WebVTT (vtt) and SubRip (srt) formats, both formats are shown.
	Formats []*string `type:"list" enum:"SubtitleFormat"`

	// Provides the start index value for your subtitle files. If you did not specify
	// a value in your request, the default value of 0 is used.
	OutputStartIndex *int64 `type:"integer"`

	// The Amazon S3 location of your transcript. You can use this URI to access
	// or download your subtitle file. Your subtitle file is stored in the same
	// location as your transcript. If you specified both WebVTT and SubRip subtitle
	// formats, two URIs are provided.
	//
	// If you included OutputBucketName in your transcription job request, this
	// is the URI of that bucket. If you also included OutputKey in your request,
	// your output is located in the path you specified in your request.
	//
	// If you didn't include OutputBucketName in your transcription job request,
	// your subtitle file is stored in a service-managed bucket, and TranscriptFileUri
	// provides you with a temporary URI you can use for secure access to your subtitle
	// file.
	//
	// Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
	// minutes. If you get an AccesDenied error, you can get a new temporary URI
	// by running a GetTranscriptionJob or ListTranscriptionJob request.
	SubtitleFileUris []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides information about your subtitle file, including format, start index, and Amazon S3 location.

func (SubtitlesOutput_) GoString added in v1.40.44 

func (s SubtitlesOutput_) 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 (*SubtitlesOutput_) SetFormats added in v1.40.44 

func (s *SubtitlesOutput_) SetFormats(v []*string) *SubtitlesOutput_

SetFormats sets the Formats field's value.

func (*SubtitlesOutput_) SetOutputStartIndex added in v1.43.25 

func (s *SubtitlesOutput_) SetOutputStartIndex(v int64) *SubtitlesOutput_

SetOutputStartIndex sets the OutputStartIndex field's value.

func (*SubtitlesOutput_) SetSubtitleFileUris added in v1.40.44 

func (s *SubtitlesOutput_) SetSubtitleFileUris(v []*string) *SubtitlesOutput_

SetSubtitleFileUris sets the SubtitleFileUris field's value.

func (SubtitlesOutput_) String added in v1.40.44 

func (s SubtitlesOutput_) 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 Summarization added in v1.48.4 

type Summarization struct {

	// Enables Generative call summarization in your Call Analytics request
	//
	// Generative call summarization provides a summary of the transcript including
	// important components discussed in the conversation.
	//
	// For more information, see Enabling generative call summarization (https://docs.aws.amazon.com/transcribe/latest/dg/tca-enable-summarization.html).
	//
	// GenerateAbstractiveSummary is a required field
	GenerateAbstractiveSummary *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

func (Summarization) GoString added in v1.48.4 

func (s Summarization) 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 (*Summarization) SetGenerateAbstractiveSummary added in v1.48.4 

func (s *Summarization) SetGenerateAbstractiveSummary(v bool) *Summarization

SetGenerateAbstractiveSummary sets the GenerateAbstractiveSummary field's value.

func (Summarization) String added in v1.48.4 

func (s Summarization) 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 (*Summarization) Validate added in v1.48.4 

func (s *Summarization) Validate() error

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

type Tag added in v1.40.29 

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 required field
	Key *string `min:"1" type:"string" required:"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'.
	//
	// Note that you can set the value of a tag to an empty string, but you can't
	// set the value of a tag to null. Omitting the tag value is the same as using
	// an empty string.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Adds metadata, in the form of a key:value pair, to the specified resource.

For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

To learn more about tagging, see Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).

func (Tag) GoString added in v1.40.29 

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 added in v1.40.29 

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

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.40.29 

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

SetValue sets the Value field's value.

func (Tag) String added in v1.40.29 

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 added in v1.40.29 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.40.29 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have
	// the format arn:partition:service:region:account-id:resource-type/resource-id.
	//
	// For example, arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
	//
	// Valid values for resource-type are: transcription-job, medical-transcription-job,
	// vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// Adds one or more custom tags, each in the form of a key:value pair, to the
	// specified resource.
	//
	// To learn more about using tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.40.29 

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 added in v1.40.29 

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.40.29 

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 added in v1.40.29 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.40.29 

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

func (TagResourceOutput) GoString added in v1.40.29 

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 added in v1.40.29 

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 ToxicityDetectionSettings added in v1.44.305 

type ToxicityDetectionSettings struct {

	// If you include ToxicityDetection in your transcription request, you must
	// also include ToxicityCategories. The only accepted value for this parameter
	// is ALL.
	//
	// ToxicityCategories is a required field
	ToxicityCategories []*string `min:"1" type:"list" required:"true" enum:"ToxicityCategory"`
	// contains filtered or unexported fields
}

Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection (ToxicityDetection) in your transcription request.

func (ToxicityDetectionSettings) GoString added in v1.44.305 

func (s ToxicityDetectionSettings) 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 (*ToxicityDetectionSettings) SetToxicityCategories added in v1.44.305 

func (s *ToxicityDetectionSettings) SetToxicityCategories(v []*string) *ToxicityDetectionSettings

SetToxicityCategories sets the ToxicityCategories field's value.

func (ToxicityDetectionSettings) String added in v1.44.305 

func (s ToxicityDetectionSettings) 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 (*ToxicityDetectionSettings) Validate added in v1.44.305 

func (s *ToxicityDetectionSettings) Validate() error

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

type TranscribeService 

type TranscribeService struct {
	*client.Client
}

TranscribeService provides the API operation methods for making requests to Amazon Transcribe Service. See this package's package overview docs for details on the service.

TranscribeService 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) *TranscribeService

New creates a new instance of the TranscribeService 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 TranscribeService client from just a session.
svc := transcribeservice.New(mySession)

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

func (*TranscribeService) CreateCallAnalyticsCategory added in v1.40.15 

func (c *TranscribeService) CreateCallAnalyticsCategory(input *CreateCallAnalyticsCategoryInput) (*CreateCallAnalyticsCategoryOutput, error)

CreateCallAnalyticsCategory API operation for Amazon Transcribe Service.

Creates a new Call Analytics category.

All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively.

When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default.

Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .

To update an existing category, see .

To learn more about Call Analytics categories, see Creating categories for post-call transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) and Creating categories for real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html).

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 Transcribe Service's API operation CreateCallAnalyticsCategory for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategory

func (*TranscribeService) CreateCallAnalyticsCategoryRequest added in v1.40.15 

func (c *TranscribeService) CreateCallAnalyticsCategoryRequest(input *CreateCallAnalyticsCategoryInput) (req *request.Request, output *CreateCallAnalyticsCategoryOutput)

CreateCallAnalyticsCategoryRequest generates a "aws/request.Request" representing the client's request for the CreateCallAnalyticsCategory 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 CreateCallAnalyticsCategory for more information on using the CreateCallAnalyticsCategory 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 CreateCallAnalyticsCategoryRequest method.
req, resp := client.CreateCallAnalyticsCategoryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategory

func (*TranscribeService) CreateCallAnalyticsCategoryWithContext added in v1.40.15 

func (c *TranscribeService) CreateCallAnalyticsCategoryWithContext(ctx aws.Context, input *CreateCallAnalyticsCategoryInput, opts ...request.Option) (*CreateCallAnalyticsCategoryOutput, error)

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

See CreateCallAnalyticsCategory 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 (*TranscribeService) CreateLanguageModel added in v1.33.20 

func (c *TranscribeService) CreateLanguageModel(input *CreateLanguageModelInput) (*CreateLanguageModelOutput, error)

CreateLanguageModel API operation for Amazon Transcribe Service.

Creates a new custom language model.

When creating a new custom language model, you must specify:

  • If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model

  • The location of your training and tuning files (this must be an Amazon S3 URI)

  • The language of your model

  • A unique name for your model

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 Transcribe Service's API operation CreateLanguageModel for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateLanguageModel

func (*TranscribeService) CreateLanguageModelRequest added in v1.33.20 

func (c *TranscribeService) CreateLanguageModelRequest(input *CreateLanguageModelInput) (req *request.Request, output *CreateLanguageModelOutput)

CreateLanguageModelRequest generates a "aws/request.Request" representing the client's request for the CreateLanguageModel 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 CreateLanguageModel for more information on using the CreateLanguageModel 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 CreateLanguageModelRequest method.
req, resp := client.CreateLanguageModelRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateLanguageModel

func (*TranscribeService) CreateLanguageModelWithContext added in v1.33.20 

func (c *TranscribeService) CreateLanguageModelWithContext(ctx aws.Context, input *CreateLanguageModelInput, opts ...request.Option) (*CreateLanguageModelOutput, error)

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

See CreateLanguageModel 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 (*TranscribeService) CreateMedicalVocabulary added in v1.30.17 

func (c *TranscribeService) CreateMedicalVocabulary(input *CreateMedicalVocabularyInput) (*CreateMedicalVocabularyOutput, error)

CreateMedicalVocabulary API operation for Amazon Transcribe Service.

Creates a new custom medical vocabulary.

Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the character set for your language.

For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html).

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 Transcribe Service's API operation CreateMedicalVocabulary for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabulary

func (*TranscribeService) CreateMedicalVocabularyRequest added in v1.30.17 

func (c *TranscribeService) CreateMedicalVocabularyRequest(input *CreateMedicalVocabularyInput) (req *request.Request, output *CreateMedicalVocabularyOutput)

CreateMedicalVocabularyRequest generates a "aws/request.Request" representing the client's request for the CreateMedicalVocabulary 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 CreateMedicalVocabulary for more information on using the CreateMedicalVocabulary 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 CreateMedicalVocabularyRequest method.
req, resp := client.CreateMedicalVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabulary

func (*TranscribeService) CreateMedicalVocabularyWithContext added in v1.30.17 

func (c *TranscribeService) CreateMedicalVocabularyWithContext(ctx aws.Context, input *CreateMedicalVocabularyInput, opts ...request.Option) (*CreateMedicalVocabularyOutput, error)

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

See CreateMedicalVocabulary 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 (*TranscribeService) CreateVocabulary added in v1.13.28 

func (c *TranscribeService) CreateVocabulary(input *CreateVocabularyInput) (*CreateVocabularyOutput, error)

CreateVocabulary API operation for Amazon Transcribe Service.

Creates a new custom vocabulary.

When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the character set for your language.

For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html).

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 Transcribe Service's API operation CreateVocabulary for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabulary

func (*TranscribeService) CreateVocabularyFilter added in v1.26.7 

func (c *TranscribeService) CreateVocabularyFilter(input *CreateVocabularyFilterInput) (*CreateVocabularyFilterOutput, error)

CreateVocabularyFilter API operation for Amazon Transcribe Service.

Creates a new custom vocabulary filter.

You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) to get the character set for your language.

For more information, see Vocabulary filtering (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html).

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 Transcribe Service's API operation CreateVocabularyFilter for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilter

func (*TranscribeService) CreateVocabularyFilterRequest added in v1.26.7 

func (c *TranscribeService) CreateVocabularyFilterRequest(input *CreateVocabularyFilterInput) (req *request.Request, output *CreateVocabularyFilterOutput)

CreateVocabularyFilterRequest generates a "aws/request.Request" representing the client's request for the CreateVocabularyFilter 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 CreateVocabularyFilter for more information on using the CreateVocabularyFilter 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 CreateVocabularyFilterRequest method.
req, resp := client.CreateVocabularyFilterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilter

func (*TranscribeService) CreateVocabularyFilterWithContext added in v1.26.7 

func (c *TranscribeService) CreateVocabularyFilterWithContext(ctx aws.Context, input *CreateVocabularyFilterInput, opts ...request.Option) (*CreateVocabularyFilterOutput, error)

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

See CreateVocabularyFilter 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 (*TranscribeService) CreateVocabularyRequest added in v1.13.28 

func (c *TranscribeService) CreateVocabularyRequest(input *CreateVocabularyInput) (req *request.Request, output *CreateVocabularyOutput)

CreateVocabularyRequest generates a "aws/request.Request" representing the client's request for the CreateVocabulary 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 CreateVocabulary for more information on using the CreateVocabulary 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 CreateVocabularyRequest method.
req, resp := client.CreateVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabulary

func (*TranscribeService) CreateVocabularyWithContext added in v1.13.28 

func (c *TranscribeService) CreateVocabularyWithContext(ctx aws.Context, input *CreateVocabularyInput, opts ...request.Option) (*CreateVocabularyOutput, error)

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

See CreateVocabulary 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 (*TranscribeService) DeleteCallAnalyticsCategory added in v1.40.15 

func (c *TranscribeService) DeleteCallAnalyticsCategory(input *DeleteCallAnalyticsCategoryInput) (*DeleteCallAnalyticsCategoryOutput, error)

DeleteCallAnalyticsCategory API operation for Amazon Transcribe Service.

Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.

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 Transcribe Service's API operation DeleteCallAnalyticsCategory for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsCategory

func (*TranscribeService) DeleteCallAnalyticsCategoryRequest added in v1.40.15 

func (c *TranscribeService) DeleteCallAnalyticsCategoryRequest(input *DeleteCallAnalyticsCategoryInput) (req *request.Request, output *DeleteCallAnalyticsCategoryOutput)

DeleteCallAnalyticsCategoryRequest generates a "aws/request.Request" representing the client's request for the DeleteCallAnalyticsCategory 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 DeleteCallAnalyticsCategory for more information on using the DeleteCallAnalyticsCategory 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 DeleteCallAnalyticsCategoryRequest method.
req, resp := client.DeleteCallAnalyticsCategoryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsCategory

func (*TranscribeService) DeleteCallAnalyticsCategoryWithContext added in v1.40.15 

func (c *TranscribeService) DeleteCallAnalyticsCategoryWithContext(ctx aws.Context, input *DeleteCallAnalyticsCategoryInput, opts ...request.Option) (*DeleteCallAnalyticsCategoryOutput, error)

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

See DeleteCallAnalyticsCategory 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 (*TranscribeService) DeleteCallAnalyticsJob added in v1.40.15 

func (c *TranscribeService) DeleteCallAnalyticsJob(input *DeleteCallAnalyticsJobInput) (*DeleteCallAnalyticsJobOutput, error)

DeleteCallAnalyticsJob API operation for Amazon Transcribe Service.

Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive.

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 Transcribe Service's API operation DeleteCallAnalyticsJob for usage and error information.

Returned Error Types:

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsJob

func (*TranscribeService) DeleteCallAnalyticsJobRequest added in v1.40.15 

func (c *TranscribeService) DeleteCallAnalyticsJobRequest(input *DeleteCallAnalyticsJobInput) (req *request.Request, output *DeleteCallAnalyticsJobOutput)

DeleteCallAnalyticsJobRequest generates a "aws/request.Request" representing the client's request for the DeleteCallAnalyticsJob 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 DeleteCallAnalyticsJob for more information on using the DeleteCallAnalyticsJob 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 DeleteCallAnalyticsJobRequest method.
req, resp := client.DeleteCallAnalyticsJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsJob

func (*TranscribeService) DeleteCallAnalyticsJobWithContext added in v1.40.15 

func (c *TranscribeService) DeleteCallAnalyticsJobWithContext(ctx aws.Context, input *DeleteCallAnalyticsJobInput, opts ...request.Option) (*DeleteCallAnalyticsJobOutput, error)

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

See DeleteCallAnalyticsJob 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 (*TranscribeService) DeleteLanguageModel added in v1.33.20 

func (c *TranscribeService) DeleteLanguageModel(input *DeleteLanguageModelInput) (*DeleteLanguageModelOutput, error)

DeleteLanguageModel API operation for Amazon Transcribe Service.

Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive.

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 Transcribe Service's API operation DeleteLanguageModel for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteLanguageModel

func (*TranscribeService) DeleteLanguageModelRequest added in v1.33.20 

func (c *TranscribeService) DeleteLanguageModelRequest(input *DeleteLanguageModelInput) (req *request.Request, output *DeleteLanguageModelOutput)

DeleteLanguageModelRequest generates a "aws/request.Request" representing the client's request for the DeleteLanguageModel 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 DeleteLanguageModel for more information on using the DeleteLanguageModel 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 DeleteLanguageModelRequest method.
req, resp := client.DeleteLanguageModelRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteLanguageModel

func (*TranscribeService) DeleteLanguageModelWithContext added in v1.33.20 

func (c *TranscribeService) DeleteLanguageModelWithContext(ctx aws.Context, input *DeleteLanguageModelInput, opts ...request.Option) (*DeleteLanguageModelOutput, error)

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

See DeleteLanguageModel 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 (*TranscribeService) DeleteMedicalScribeJob added in v1.48.5 

func (c *TranscribeService) DeleteMedicalScribeJob(input *DeleteMedicalScribeJobInput) (*DeleteMedicalScribeJobOutput, error)

DeleteMedicalScribeJob API operation for Amazon Transcribe Service.

Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.

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 Transcribe Service's API operation DeleteMedicalScribeJob for usage and error information.

Returned Error Types:

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalScribeJob

func (*TranscribeService) DeleteMedicalScribeJobRequest added in v1.48.5 

func (c *TranscribeService) DeleteMedicalScribeJobRequest(input *DeleteMedicalScribeJobInput) (req *request.Request, output *DeleteMedicalScribeJobOutput)

DeleteMedicalScribeJobRequest generates a "aws/request.Request" representing the client's request for the DeleteMedicalScribeJob 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 DeleteMedicalScribeJob for more information on using the DeleteMedicalScribeJob 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 DeleteMedicalScribeJobRequest method.
req, resp := client.DeleteMedicalScribeJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalScribeJob

func (*TranscribeService) DeleteMedicalScribeJobWithContext added in v1.48.5 

func (c *TranscribeService) DeleteMedicalScribeJobWithContext(ctx aws.Context, input *DeleteMedicalScribeJobInput, opts ...request.Option) (*DeleteMedicalScribeJobOutput, error)

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

See DeleteMedicalScribeJob 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 (*TranscribeService) DeleteMedicalTranscriptionJob added in v1.30.5 

func (c *TranscribeService) DeleteMedicalTranscriptionJob(input *DeleteMedicalTranscriptionJobInput) (*DeleteMedicalTranscriptionJobOutput, error)

DeleteMedicalTranscriptionJob API operation for Amazon Transcribe Service.

Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive.

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 Transcribe Service's API operation DeleteMedicalTranscriptionJob for usage and error information.

Returned Error Types:

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalTranscriptionJob

func (*TranscribeService) DeleteMedicalTranscriptionJobRequest added in v1.30.5 

func (c *TranscribeService) DeleteMedicalTranscriptionJobRequest(input *DeleteMedicalTranscriptionJobInput) (req *request.Request, output *DeleteMedicalTranscriptionJobOutput)

DeleteMedicalTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the DeleteMedicalTranscriptionJob 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 DeleteMedicalTranscriptionJob for more information on using the DeleteMedicalTranscriptionJob 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 DeleteMedicalTranscriptionJobRequest method.
req, resp := client.DeleteMedicalTranscriptionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalTranscriptionJob

func (*TranscribeService) DeleteMedicalTranscriptionJobWithContext added in v1.30.5 

func (c *TranscribeService) DeleteMedicalTranscriptionJobWithContext(ctx aws.Context, input *DeleteMedicalTranscriptionJobInput, opts ...request.Option) (*DeleteMedicalTranscriptionJobOutput, error)

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

See DeleteMedicalTranscriptionJob 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 (*TranscribeService) DeleteMedicalVocabulary added in v1.30.17 

func (c *TranscribeService) DeleteMedicalVocabulary(input *DeleteMedicalVocabularyInput) (*DeleteMedicalVocabularyOutput, error)

DeleteMedicalVocabulary API operation for Amazon Transcribe Service.

Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

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 Transcribe Service's API operation DeleteMedicalVocabulary for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabulary

func (*TranscribeService) DeleteMedicalVocabularyRequest added in v1.30.17 

func (c *TranscribeService) DeleteMedicalVocabularyRequest(input *DeleteMedicalVocabularyInput) (req *request.Request, output *DeleteMedicalVocabularyOutput)

DeleteMedicalVocabularyRequest generates a "aws/request.Request" representing the client's request for the DeleteMedicalVocabulary 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 DeleteMedicalVocabulary for more information on using the DeleteMedicalVocabulary 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 DeleteMedicalVocabularyRequest method.
req, resp := client.DeleteMedicalVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabulary

func (*TranscribeService) DeleteMedicalVocabularyWithContext added in v1.30.17 

func (c *TranscribeService) DeleteMedicalVocabularyWithContext(ctx aws.Context, input *DeleteMedicalVocabularyInput, opts ...request.Option) (*DeleteMedicalVocabularyOutput, error)

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

See DeleteMedicalVocabulary 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 (*TranscribeService) DeleteTranscriptionJob added in v1.15.52 

func (c *TranscribeService) DeleteTranscriptionJob(input *DeleteTranscriptionJobInput) (*DeleteTranscriptionJobOutput, error)

DeleteTranscriptionJob API operation for Amazon Transcribe Service.

Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.

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 Transcribe Service's API operation DeleteTranscriptionJob for usage and error information.

Returned Error Types:

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteTranscriptionJob

func (*TranscribeService) DeleteTranscriptionJobRequest added in v1.15.52 

func (c *TranscribeService) DeleteTranscriptionJobRequest(input *DeleteTranscriptionJobInput) (req *request.Request, output *DeleteTranscriptionJobOutput)

DeleteTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the DeleteTranscriptionJob 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 DeleteTranscriptionJob for more information on using the DeleteTranscriptionJob 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 DeleteTranscriptionJobRequest method.
req, resp := client.DeleteTranscriptionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteTranscriptionJob

func (*TranscribeService) DeleteTranscriptionJobWithContext added in v1.15.52 

func (c *TranscribeService) DeleteTranscriptionJobWithContext(ctx aws.Context, input *DeleteTranscriptionJobInput, opts ...request.Option) (*DeleteTranscriptionJobOutput, error)

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

See DeleteTranscriptionJob 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 (*TranscribeService) DeleteVocabulary added in v1.13.28 

func (c *TranscribeService) DeleteVocabulary(input *DeleteVocabularyInput) (*DeleteVocabularyOutput, error)

DeleteVocabulary API operation for Amazon Transcribe Service.

Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

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 Transcribe Service's API operation DeleteVocabulary for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabulary

func (*TranscribeService) DeleteVocabularyFilter added in v1.26.7 

func (c *TranscribeService) DeleteVocabularyFilter(input *DeleteVocabularyFilterInput) (*DeleteVocabularyFilterOutput, error)

DeleteVocabularyFilter API operation for Amazon Transcribe Service.

Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive.

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 Transcribe Service's API operation DeleteVocabularyFilter for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyFilter

func (*TranscribeService) DeleteVocabularyFilterRequest added in v1.26.7 

func (c *TranscribeService) DeleteVocabularyFilterRequest(input *DeleteVocabularyFilterInput) (req *request.Request, output *DeleteVocabularyFilterOutput)

DeleteVocabularyFilterRequest generates a "aws/request.Request" representing the client's request for the DeleteVocabularyFilter 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 DeleteVocabularyFilter for more information on using the DeleteVocabularyFilter 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 DeleteVocabularyFilterRequest method.
req, resp := client.DeleteVocabularyFilterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyFilter

func (*TranscribeService) DeleteVocabularyFilterWithContext added in v1.26.7 

func (c *TranscribeService) DeleteVocabularyFilterWithContext(ctx aws.Context, input *DeleteVocabularyFilterInput, opts ...request.Option) (*DeleteVocabularyFilterOutput, error)

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

See DeleteVocabularyFilter 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 (*TranscribeService) DeleteVocabularyRequest added in v1.13.28 

func (c *TranscribeService) DeleteVocabularyRequest(input *DeleteVocabularyInput) (req *request.Request, output *DeleteVocabularyOutput)

DeleteVocabularyRequest generates a "aws/request.Request" representing the client's request for the DeleteVocabulary 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 DeleteVocabulary for more information on using the DeleteVocabulary 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 DeleteVocabularyRequest method.
req, resp := client.DeleteVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabulary

func (*TranscribeService) DeleteVocabularyWithContext added in v1.13.28 

func (c *TranscribeService) DeleteVocabularyWithContext(ctx aws.Context, input *DeleteVocabularyInput, opts ...request.Option) (*DeleteVocabularyOutput, error)

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

See DeleteVocabulary 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 (*TranscribeService) DescribeLanguageModel added in v1.33.20 

func (c *TranscribeService) DescribeLanguageModel(input *DescribeLanguageModelInput) (*DescribeLanguageModelOutput, error)

DescribeLanguageModel API operation for Amazon Transcribe Service.

Provides information about the specified custom language model.

This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

If you tried to create a new custom language model and the request wasn't successful, you can use DescribeLanguageModel to help identify the reason for this failure.

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 Transcribe Service's API operation DescribeLanguageModel for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DescribeLanguageModel

func (*TranscribeService) DescribeLanguageModelRequest added in v1.33.20 

func (c *TranscribeService) DescribeLanguageModelRequest(input *DescribeLanguageModelInput) (req *request.Request, output *DescribeLanguageModelOutput)

DescribeLanguageModelRequest generates a "aws/request.Request" representing the client's request for the DescribeLanguageModel 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 DescribeLanguageModel for more information on using the DescribeLanguageModel 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 DescribeLanguageModelRequest method.
req, resp := client.DescribeLanguageModelRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DescribeLanguageModel

func (*TranscribeService) DescribeLanguageModelWithContext added in v1.33.20 

func (c *TranscribeService) DescribeLanguageModelWithContext(ctx aws.Context, input *DescribeLanguageModelInput, opts ...request.Option) (*DescribeLanguageModelOutput, error)

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

See DescribeLanguageModel 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 (*TranscribeService) GetCallAnalyticsCategory added in v1.40.15 

func (c *TranscribeService) GetCallAnalyticsCategory(input *GetCallAnalyticsCategoryInput) (*GetCallAnalyticsCategoryOutput, error)

GetCallAnalyticsCategory API operation for Amazon Transcribe Service.

Provides information about the specified Call Analytics category.

To get a list of your Call Analytics categories, use the operation.

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 Transcribe Service's API operation GetCallAnalyticsCategory for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsCategory

func (*TranscribeService) GetCallAnalyticsCategoryRequest added in v1.40.15 

func (c *TranscribeService) GetCallAnalyticsCategoryRequest(input *GetCallAnalyticsCategoryInput) (req *request.Request, output *GetCallAnalyticsCategoryOutput)

GetCallAnalyticsCategoryRequest generates a "aws/request.Request" representing the client's request for the GetCallAnalyticsCategory 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 GetCallAnalyticsCategory for more information on using the GetCallAnalyticsCategory 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 GetCallAnalyticsCategoryRequest method.
req, resp := client.GetCallAnalyticsCategoryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsCategory

func (*TranscribeService) GetCallAnalyticsCategoryWithContext added in v1.40.15 

func (c *TranscribeService) GetCallAnalyticsCategoryWithContext(ctx aws.Context, input *GetCallAnalyticsCategoryInput, opts ...request.Option) (*GetCallAnalyticsCategoryOutput, error)

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

See GetCallAnalyticsCategory 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 (*TranscribeService) GetCallAnalyticsJob added in v1.40.15 

func (c *TranscribeService) GetCallAnalyticsJob(input *GetCallAnalyticsJobInput) (*GetCallAnalyticsJobOutput, error)

GetCallAnalyticsJob API operation for Amazon Transcribe Service.

Provides information about the specified Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

To get a list of your Call Analytics jobs, use the operation.

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 Transcribe Service's API operation GetCallAnalyticsJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsJob

func (*TranscribeService) GetCallAnalyticsJobRequest added in v1.40.15 

func (c *TranscribeService) GetCallAnalyticsJobRequest(input *GetCallAnalyticsJobInput) (req *request.Request, output *GetCallAnalyticsJobOutput)

GetCallAnalyticsJobRequest generates a "aws/request.Request" representing the client's request for the GetCallAnalyticsJob 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 GetCallAnalyticsJob for more information on using the GetCallAnalyticsJob 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 GetCallAnalyticsJobRequest method.
req, resp := client.GetCallAnalyticsJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsJob

func (*TranscribeService) GetCallAnalyticsJobWithContext added in v1.40.15 

func (c *TranscribeService) GetCallAnalyticsJobWithContext(ctx aws.Context, input *GetCallAnalyticsJobInput, opts ...request.Option) (*GetCallAnalyticsJobOutput, error)

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

See GetCallAnalyticsJob 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 (*TranscribeService) GetMedicalScribeJob added in v1.48.5 

func (c *TranscribeService) GetMedicalScribeJob(input *GetMedicalScribeJobInput) (*GetMedicalScribeJobOutput, error)

GetMedicalScribeJob API operation for Amazon Transcribe Service.

Provides information about the specified Medical Scribe job.

To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

To get a list of your Medical Scribe jobs, use the operation.

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 Transcribe Service's API operation GetMedicalScribeJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalScribeJob

func (*TranscribeService) GetMedicalScribeJobRequest added in v1.48.5 

func (c *TranscribeService) GetMedicalScribeJobRequest(input *GetMedicalScribeJobInput) (req *request.Request, output *GetMedicalScribeJobOutput)

GetMedicalScribeJobRequest generates a "aws/request.Request" representing the client's request for the GetMedicalScribeJob 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 GetMedicalScribeJob for more information on using the GetMedicalScribeJob 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 GetMedicalScribeJobRequest method.
req, resp := client.GetMedicalScribeJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalScribeJob

func (*TranscribeService) GetMedicalScribeJobWithContext added in v1.48.5 

func (c *TranscribeService) GetMedicalScribeJobWithContext(ctx aws.Context, input *GetMedicalScribeJobInput, opts ...request.Option) (*GetMedicalScribeJobOutput, error)

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

See GetMedicalScribeJob 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 (*TranscribeService) GetMedicalTranscriptionJob added in v1.30.5 

func (c *TranscribeService) GetMedicalTranscriptionJob(input *GetMedicalTranscriptionJobInput) (*GetMedicalTranscriptionJobOutput, error)

GetMedicalTranscriptionJob API operation for Amazon Transcribe Service.

Provides information about the specified medical transcription job.

To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

To get a list of your medical transcription jobs, use the operation.

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 Transcribe Service's API operation GetMedicalTranscriptionJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJob

func (*TranscribeService) GetMedicalTranscriptionJobRequest added in v1.30.5 

func (c *TranscribeService) GetMedicalTranscriptionJobRequest(input *GetMedicalTranscriptionJobInput) (req *request.Request, output *GetMedicalTranscriptionJobOutput)

GetMedicalTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the GetMedicalTranscriptionJob 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 GetMedicalTranscriptionJob for more information on using the GetMedicalTranscriptionJob 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 GetMedicalTranscriptionJobRequest method.
req, resp := client.GetMedicalTranscriptionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJob

func (*TranscribeService) GetMedicalTranscriptionJobWithContext added in v1.30.5 

func (c *TranscribeService) GetMedicalTranscriptionJobWithContext(ctx aws.Context, input *GetMedicalTranscriptionJobInput, opts ...request.Option) (*GetMedicalTranscriptionJobOutput, error)

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

See GetMedicalTranscriptionJob 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 (*TranscribeService) GetMedicalVocabulary added in v1.30.17 

func (c *TranscribeService) GetMedicalVocabulary(input *GetMedicalVocabularyInput) (*GetMedicalVocabularyOutput, error)

GetMedicalVocabulary API operation for Amazon Transcribe Service.

Provides information about the specified custom medical vocabulary.

To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.

To get a list of your custom medical vocabularies, use the operation.

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 Transcribe Service's API operation GetMedicalVocabulary for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabulary

func (*TranscribeService) GetMedicalVocabularyRequest added in v1.30.17 

func (c *TranscribeService) GetMedicalVocabularyRequest(input *GetMedicalVocabularyInput) (req *request.Request, output *GetMedicalVocabularyOutput)

GetMedicalVocabularyRequest generates a "aws/request.Request" representing the client's request for the GetMedicalVocabulary 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 GetMedicalVocabulary for more information on using the GetMedicalVocabulary 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 GetMedicalVocabularyRequest method.
req, resp := client.GetMedicalVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabulary

func (*TranscribeService) GetMedicalVocabularyWithContext added in v1.30.17 

func (c *TranscribeService) GetMedicalVocabularyWithContext(ctx aws.Context, input *GetMedicalVocabularyInput, opts ...request.Option) (*GetMedicalVocabularyOutput, error)

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

See GetMedicalVocabulary 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 (*TranscribeService) GetTranscriptionJob 

func (c *TranscribeService) GetTranscriptionJob(input *GetTranscriptionJobInput) (*GetTranscriptionJobOutput, error)

GetTranscriptionJob API operation for Amazon Transcribe Service.

Provides information about the specified transcription job.

To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

To get a list of your transcription jobs, use the operation.

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 Transcribe Service's API operation GetTranscriptionJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetTranscriptionJob

func (*TranscribeService) GetTranscriptionJobRequest 

func (c *TranscribeService) GetTranscriptionJobRequest(input *GetTranscriptionJobInput) (req *request.Request, output *GetTranscriptionJobOutput)

GetTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the GetTranscriptionJob 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 GetTranscriptionJob for more information on using the GetTranscriptionJob 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 GetTranscriptionJobRequest method.
req, resp := client.GetTranscriptionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetTranscriptionJob

func (*TranscribeService) GetTranscriptionJobWithContext 

func (c *TranscribeService) GetTranscriptionJobWithContext(ctx aws.Context, input *GetTranscriptionJobInput, opts ...request.Option) (*GetTranscriptionJobOutput, error)

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

See GetTranscriptionJob 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 (*TranscribeService) GetVocabulary added in v1.13.28 

func (c *TranscribeService) GetVocabulary(input *GetVocabularyInput) (*GetVocabularyOutput, error)

GetVocabulary API operation for Amazon Transcribe Service.

Provides information about the specified custom vocabulary.

To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed.

To get a list of your custom vocabularies, use the operation.

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 Transcribe Service's API operation GetVocabulary for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabulary

func (*TranscribeService) GetVocabularyFilter added in v1.26.7 

func (c *TranscribeService) GetVocabularyFilter(input *GetVocabularyFilterInput) (*GetVocabularyFilterOutput, error)

GetVocabularyFilter API operation for Amazon Transcribe Service.

Provides information about the specified custom vocabulary filter.

To get a list of your custom vocabulary filters, use the operation.

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 Transcribe Service's API operation GetVocabularyFilter for usage and error information.

Returned Error Types:

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilter

func (*TranscribeService) GetVocabularyFilterRequest added in v1.26.7 

func (c *TranscribeService) GetVocabularyFilterRequest(input *GetVocabularyFilterInput) (req *request.Request, output *GetVocabularyFilterOutput)

GetVocabularyFilterRequest generates a "aws/request.Request" representing the client's request for the GetVocabularyFilter 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 GetVocabularyFilter for more information on using the GetVocabularyFilter 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 GetVocabularyFilterRequest method.
req, resp := client.GetVocabularyFilterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilter

func (*TranscribeService) GetVocabularyFilterWithContext added in v1.26.7 

func (c *TranscribeService) GetVocabularyFilterWithContext(ctx aws.Context, input *GetVocabularyFilterInput, opts ...request.Option) (*GetVocabularyFilterOutput, error)

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

See GetVocabularyFilter 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 (*TranscribeService) GetVocabularyRequest added in v1.13.28 

func (c *TranscribeService) GetVocabularyRequest(input *GetVocabularyInput) (req *request.Request, output *GetVocabularyOutput)

GetVocabularyRequest generates a "aws/request.Request" representing the client's request for the GetVocabulary 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 GetVocabulary for more information on using the GetVocabulary 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 GetVocabularyRequest method.
req, resp := client.GetVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabulary

func (*TranscribeService) GetVocabularyWithContext added in v1.13.28 

func (c *TranscribeService) GetVocabularyWithContext(ctx aws.Context, input *GetVocabularyInput, opts ...request.Option) (*GetVocabularyOutput, error)

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

See GetVocabulary 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 (*TranscribeService) ListCallAnalyticsCategories added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsCategories(input *ListCallAnalyticsCategoriesInput) (*ListCallAnalyticsCategoriesOutput, error)

ListCallAnalyticsCategories API operation for Amazon Transcribe Service.

Provides a list of Call Analytics categories, including all rules that make up each category.

To get detailed information about a specific Call Analytics category, use the operation.

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 Transcribe Service's API operation ListCallAnalyticsCategories for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategories

func (*TranscribeService) ListCallAnalyticsCategoriesPages added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsCategoriesPages(input *ListCallAnalyticsCategoriesInput, fn func(*ListCallAnalyticsCategoriesOutput, bool) bool) error

ListCallAnalyticsCategoriesPages iterates over the pages of a ListCallAnalyticsCategories operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCallAnalyticsCategories 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 ListCallAnalyticsCategories operation.
pageNum := 0
err := client.ListCallAnalyticsCategoriesPages(params,
    func(page *transcribeservice.ListCallAnalyticsCategoriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListCallAnalyticsCategoriesPagesWithContext added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsCategoriesPagesWithContext(ctx aws.Context, input *ListCallAnalyticsCategoriesInput, fn func(*ListCallAnalyticsCategoriesOutput, bool) bool, opts ...request.Option) error

ListCallAnalyticsCategoriesPagesWithContext same as ListCallAnalyticsCategoriesPages 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 (*TranscribeService) ListCallAnalyticsCategoriesRequest added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsCategoriesRequest(input *ListCallAnalyticsCategoriesInput) (req *request.Request, output *ListCallAnalyticsCategoriesOutput)

ListCallAnalyticsCategoriesRequest generates a "aws/request.Request" representing the client's request for the ListCallAnalyticsCategories 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 ListCallAnalyticsCategories for more information on using the ListCallAnalyticsCategories 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 ListCallAnalyticsCategoriesRequest method.
req, resp := client.ListCallAnalyticsCategoriesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategories

func (*TranscribeService) ListCallAnalyticsCategoriesWithContext added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsCategoriesWithContext(ctx aws.Context, input *ListCallAnalyticsCategoriesInput, opts ...request.Option) (*ListCallAnalyticsCategoriesOutput, error)

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

See ListCallAnalyticsCategories 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 (*TranscribeService) ListCallAnalyticsJobs added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsJobs(input *ListCallAnalyticsJobsInput) (*ListCallAnalyticsJobsOutput, error)

ListCallAnalyticsJobs API operation for Amazon Transcribe Service.

Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.

To get detailed information about a specific Call Analytics job, use the operation.

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 Transcribe Service's API operation ListCallAnalyticsJobs for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobs

func (*TranscribeService) ListCallAnalyticsJobsPages added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsJobsPages(input *ListCallAnalyticsJobsInput, fn func(*ListCallAnalyticsJobsOutput, bool) bool) error

ListCallAnalyticsJobsPages iterates over the pages of a ListCallAnalyticsJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCallAnalyticsJobs 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 ListCallAnalyticsJobs operation.
pageNum := 0
err := client.ListCallAnalyticsJobsPages(params,
    func(page *transcribeservice.ListCallAnalyticsJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListCallAnalyticsJobsPagesWithContext added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsJobsPagesWithContext(ctx aws.Context, input *ListCallAnalyticsJobsInput, fn func(*ListCallAnalyticsJobsOutput, bool) bool, opts ...request.Option) error

ListCallAnalyticsJobsPagesWithContext same as ListCallAnalyticsJobsPages 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 (*TranscribeService) ListCallAnalyticsJobsRequest added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsJobsRequest(input *ListCallAnalyticsJobsInput) (req *request.Request, output *ListCallAnalyticsJobsOutput)

ListCallAnalyticsJobsRequest generates a "aws/request.Request" representing the client's request for the ListCallAnalyticsJobs 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 ListCallAnalyticsJobs for more information on using the ListCallAnalyticsJobs 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 ListCallAnalyticsJobsRequest method.
req, resp := client.ListCallAnalyticsJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobs

func (*TranscribeService) ListCallAnalyticsJobsWithContext added in v1.40.15 

func (c *TranscribeService) ListCallAnalyticsJobsWithContext(ctx aws.Context, input *ListCallAnalyticsJobsInput, opts ...request.Option) (*ListCallAnalyticsJobsOutput, error)

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

See ListCallAnalyticsJobs 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 (*TranscribeService) ListLanguageModels added in v1.33.20 

func (c *TranscribeService) ListLanguageModels(input *ListLanguageModelsInput) (*ListLanguageModelsOutput, error)

ListLanguageModels API operation for Amazon Transcribe Service.

Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.

To get detailed information about a specific custom language model, use the operation.

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 Transcribe Service's API operation ListLanguageModels for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListLanguageModels

func (*TranscribeService) ListLanguageModelsPages added in v1.33.20 

func (c *TranscribeService) ListLanguageModelsPages(input *ListLanguageModelsInput, fn func(*ListLanguageModelsOutput, bool) bool) error

ListLanguageModelsPages iterates over the pages of a ListLanguageModels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLanguageModels 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 ListLanguageModels operation.
pageNum := 0
err := client.ListLanguageModelsPages(params,
    func(page *transcribeservice.ListLanguageModelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListLanguageModelsPagesWithContext added in v1.33.20 

func (c *TranscribeService) ListLanguageModelsPagesWithContext(ctx aws.Context, input *ListLanguageModelsInput, fn func(*ListLanguageModelsOutput, bool) bool, opts ...request.Option) error

ListLanguageModelsPagesWithContext same as ListLanguageModelsPages 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 (*TranscribeService) ListLanguageModelsRequest added in v1.33.20 

func (c *TranscribeService) ListLanguageModelsRequest(input *ListLanguageModelsInput) (req *request.Request, output *ListLanguageModelsOutput)

ListLanguageModelsRequest generates a "aws/request.Request" representing the client's request for the ListLanguageModels 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 ListLanguageModels for more information on using the ListLanguageModels 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 ListLanguageModelsRequest method.
req, resp := client.ListLanguageModelsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListLanguageModels

func (*TranscribeService) ListLanguageModelsWithContext added in v1.33.20 

func (c *TranscribeService) ListLanguageModelsWithContext(ctx aws.Context, input *ListLanguageModelsInput, opts ...request.Option) (*ListLanguageModelsOutput, error)

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

See ListLanguageModels 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 (*TranscribeService) ListMedicalScribeJobs added in v1.48.5 

func (c *TranscribeService) ListMedicalScribeJobs(input *ListMedicalScribeJobsInput) (*ListMedicalScribeJobsOutput, error)

ListMedicalScribeJobs API operation for Amazon Transcribe Service.

Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.

To get detailed information about a specific Medical Scribe job, use the operation.

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 Transcribe Service's API operation ListMedicalScribeJobs for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalScribeJobs

func (*TranscribeService) ListMedicalScribeJobsPages added in v1.48.5 

func (c *TranscribeService) ListMedicalScribeJobsPages(input *ListMedicalScribeJobsInput, fn func(*ListMedicalScribeJobsOutput, bool) bool) error

ListMedicalScribeJobsPages iterates over the pages of a ListMedicalScribeJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMedicalScribeJobs 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 ListMedicalScribeJobs operation.
pageNum := 0
err := client.ListMedicalScribeJobsPages(params,
    func(page *transcribeservice.ListMedicalScribeJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListMedicalScribeJobsPagesWithContext added in v1.48.5 

func (c *TranscribeService) ListMedicalScribeJobsPagesWithContext(ctx aws.Context, input *ListMedicalScribeJobsInput, fn func(*ListMedicalScribeJobsOutput, bool) bool, opts ...request.Option) error

ListMedicalScribeJobsPagesWithContext same as ListMedicalScribeJobsPages 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 (*TranscribeService) ListMedicalScribeJobsRequest added in v1.48.5 

func (c *TranscribeService) ListMedicalScribeJobsRequest(input *ListMedicalScribeJobsInput) (req *request.Request, output *ListMedicalScribeJobsOutput)

ListMedicalScribeJobsRequest generates a "aws/request.Request" representing the client's request for the ListMedicalScribeJobs 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 ListMedicalScribeJobs for more information on using the ListMedicalScribeJobs 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 ListMedicalScribeJobsRequest method.
req, resp := client.ListMedicalScribeJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalScribeJobs

func (*TranscribeService) ListMedicalScribeJobsWithContext added in v1.48.5 

func (c *TranscribeService) ListMedicalScribeJobsWithContext(ctx aws.Context, input *ListMedicalScribeJobsInput, opts ...request.Option) (*ListMedicalScribeJobsOutput, error)

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

See ListMedicalScribeJobs 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 (*TranscribeService) ListMedicalTranscriptionJobs added in v1.30.5 

func (c *TranscribeService) ListMedicalTranscriptionJobs(input *ListMedicalTranscriptionJobsInput) (*ListMedicalTranscriptionJobsOutput, error)

ListMedicalTranscriptionJobs API operation for Amazon Transcribe Service.

Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned.

To get detailed information about a specific medical transcription job, use the operation.

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 Transcribe Service's API operation ListMedicalTranscriptionJobs for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobs

func (*TranscribeService) ListMedicalTranscriptionJobsPages added in v1.30.5 

func (c *TranscribeService) ListMedicalTranscriptionJobsPages(input *ListMedicalTranscriptionJobsInput, fn func(*ListMedicalTranscriptionJobsOutput, bool) bool) error

ListMedicalTranscriptionJobsPages iterates over the pages of a ListMedicalTranscriptionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMedicalTranscriptionJobs 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 ListMedicalTranscriptionJobs operation.
pageNum := 0
err := client.ListMedicalTranscriptionJobsPages(params,
    func(page *transcribeservice.ListMedicalTranscriptionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListMedicalTranscriptionJobsPagesWithContext added in v1.30.5 

func (c *TranscribeService) ListMedicalTranscriptionJobsPagesWithContext(ctx aws.Context, input *ListMedicalTranscriptionJobsInput, fn func(*ListMedicalTranscriptionJobsOutput, bool) bool, opts ...request.Option) error

ListMedicalTranscriptionJobsPagesWithContext same as ListMedicalTranscriptionJobsPages 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 (*TranscribeService) ListMedicalTranscriptionJobsRequest added in v1.30.5 

func (c *TranscribeService) ListMedicalTranscriptionJobsRequest(input *ListMedicalTranscriptionJobsInput) (req *request.Request, output *ListMedicalTranscriptionJobsOutput)

ListMedicalTranscriptionJobsRequest generates a "aws/request.Request" representing the client's request for the ListMedicalTranscriptionJobs 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 ListMedicalTranscriptionJobs for more information on using the ListMedicalTranscriptionJobs 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 ListMedicalTranscriptionJobsRequest method.
req, resp := client.ListMedicalTranscriptionJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobs

func (*TranscribeService) ListMedicalTranscriptionJobsWithContext added in v1.30.5 

func (c *TranscribeService) ListMedicalTranscriptionJobsWithContext(ctx aws.Context, input *ListMedicalTranscriptionJobsInput, opts ...request.Option) (*ListMedicalTranscriptionJobsOutput, error)

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

See ListMedicalTranscriptionJobs 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 (*TranscribeService) ListMedicalVocabularies added in v1.30.17 

func (c *TranscribeService) ListMedicalVocabularies(input *ListMedicalVocabulariesInput) (*ListMedicalVocabulariesOutput, error)

ListMedicalVocabularies API operation for Amazon Transcribe Service.

Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned.

To get detailed information about a specific custom medical vocabulary, use the operation.

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 Transcribe Service's API operation ListMedicalVocabularies for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalVocabularies

func (*TranscribeService) ListMedicalVocabulariesPages added in v1.30.17 

func (c *TranscribeService) ListMedicalVocabulariesPages(input *ListMedicalVocabulariesInput, fn func(*ListMedicalVocabulariesOutput, bool) bool) error

ListMedicalVocabulariesPages iterates over the pages of a ListMedicalVocabularies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMedicalVocabularies 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 ListMedicalVocabularies operation.
pageNum := 0
err := client.ListMedicalVocabulariesPages(params,
    func(page *transcribeservice.ListMedicalVocabulariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListMedicalVocabulariesPagesWithContext added in v1.30.17 

func (c *TranscribeService) ListMedicalVocabulariesPagesWithContext(ctx aws.Context, input *ListMedicalVocabulariesInput, fn func(*ListMedicalVocabulariesOutput, bool) bool, opts ...request.Option) error

ListMedicalVocabulariesPagesWithContext same as ListMedicalVocabulariesPages 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 (*TranscribeService) ListMedicalVocabulariesRequest added in v1.30.17 

func (c *TranscribeService) ListMedicalVocabulariesRequest(input *ListMedicalVocabulariesInput) (req *request.Request, output *ListMedicalVocabulariesOutput)

ListMedicalVocabulariesRequest generates a "aws/request.Request" representing the client's request for the ListMedicalVocabularies 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 ListMedicalVocabularies for more information on using the ListMedicalVocabularies 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 ListMedicalVocabulariesRequest method.
req, resp := client.ListMedicalVocabulariesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalVocabularies

func (*TranscribeService) ListMedicalVocabulariesWithContext added in v1.30.17 

func (c *TranscribeService) ListMedicalVocabulariesWithContext(ctx aws.Context, input *ListMedicalVocabulariesInput, opts ...request.Option) (*ListMedicalVocabulariesOutput, error)

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

See ListMedicalVocabularies 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 (*TranscribeService) ListTagsForResource added in v1.40.29 

func (c *TranscribeService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Transcribe Service.

Lists all tags associated with the specified transcription job, vocabulary, model, or resource.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).

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 Transcribe Service's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTagsForResource

func (*TranscribeService) ListTagsForResourceRequest added in v1.40.29 

func (c *TranscribeService) 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/transcribe-2017-10-26/ListTagsForResource

func (*TranscribeService) ListTagsForResourceWithContext added in v1.40.29 

func (c *TranscribeService) 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 (*TranscribeService) ListTranscriptionJobs 

func (c *TranscribeService) ListTranscriptionJobs(input *ListTranscriptionJobsInput) (*ListTranscriptionJobsOutput, error)

ListTranscriptionJobs API operation for Amazon Transcribe Service.

Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.

To get detailed information about a specific transcription job, use the operation.

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 Transcribe Service's API operation ListTranscriptionJobs for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs

func (*TranscribeService) ListTranscriptionJobsPages 

func (c *TranscribeService) ListTranscriptionJobsPages(input *ListTranscriptionJobsInput, fn func(*ListTranscriptionJobsOutput, bool) bool) error

ListTranscriptionJobsPages iterates over the pages of a ListTranscriptionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTranscriptionJobs 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 ListTranscriptionJobs operation.
pageNum := 0
err := client.ListTranscriptionJobsPages(params,
    func(page *transcribeservice.ListTranscriptionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListTranscriptionJobsPagesWithContext 

func (c *TranscribeService) ListTranscriptionJobsPagesWithContext(ctx aws.Context, input *ListTranscriptionJobsInput, fn func(*ListTranscriptionJobsOutput, bool) bool, opts ...request.Option) error

ListTranscriptionJobsPagesWithContext same as ListTranscriptionJobsPages 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 (*TranscribeService) ListTranscriptionJobsRequest 

func (c *TranscribeService) ListTranscriptionJobsRequest(input *ListTranscriptionJobsInput) (req *request.Request, output *ListTranscriptionJobsOutput)

ListTranscriptionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTranscriptionJobs 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 ListTranscriptionJobs for more information on using the ListTranscriptionJobs 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 ListTranscriptionJobsRequest method.
req, resp := client.ListTranscriptionJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs

func (*TranscribeService) ListTranscriptionJobsWithContext 

func (c *TranscribeService) ListTranscriptionJobsWithContext(ctx aws.Context, input *ListTranscriptionJobsInput, opts ...request.Option) (*ListTranscriptionJobsOutput, error)

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

See ListTranscriptionJobs 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 (*TranscribeService) ListVocabularies added in v1.13.28 

func (c *TranscribeService) ListVocabularies(input *ListVocabulariesInput) (*ListVocabulariesOutput, error)

ListVocabularies API operation for Amazon Transcribe Service.

Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

To get detailed information about a specific custom vocabulary, use the operation.

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 Transcribe Service's API operation ListVocabularies for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularies

func (*TranscribeService) ListVocabulariesPages added in v1.13.28 

func (c *TranscribeService) ListVocabulariesPages(input *ListVocabulariesInput, fn func(*ListVocabulariesOutput, bool) bool) error

ListVocabulariesPages iterates over the pages of a ListVocabularies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListVocabularies 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 ListVocabularies operation.
pageNum := 0
err := client.ListVocabulariesPages(params,
    func(page *transcribeservice.ListVocabulariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListVocabulariesPagesWithContext added in v1.13.28 

func (c *TranscribeService) ListVocabulariesPagesWithContext(ctx aws.Context, input *ListVocabulariesInput, fn func(*ListVocabulariesOutput, bool) bool, opts ...request.Option) error

ListVocabulariesPagesWithContext same as ListVocabulariesPages 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 (*TranscribeService) ListVocabulariesRequest added in v1.13.28 

func (c *TranscribeService) ListVocabulariesRequest(input *ListVocabulariesInput) (req *request.Request, output *ListVocabulariesOutput)

ListVocabulariesRequest generates a "aws/request.Request" representing the client's request for the ListVocabularies 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 ListVocabularies for more information on using the ListVocabularies 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 ListVocabulariesRequest method.
req, resp := client.ListVocabulariesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularies

func (*TranscribeService) ListVocabulariesWithContext added in v1.13.28 

func (c *TranscribeService) ListVocabulariesWithContext(ctx aws.Context, input *ListVocabulariesInput, opts ...request.Option) (*ListVocabulariesOutput, error)

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

See ListVocabularies 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 (*TranscribeService) ListVocabularyFilters added in v1.26.7 

func (c *TranscribeService) ListVocabularyFilters(input *ListVocabularyFiltersInput) (*ListVocabularyFiltersOutput, error)

ListVocabularyFilters API operation for Amazon Transcribe Service.

Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

To get detailed information about a specific custom vocabulary filter, use the operation.

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 Transcribe Service's API operation ListVocabularyFilters for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFilters

func (*TranscribeService) ListVocabularyFiltersPages added in v1.26.7 

func (c *TranscribeService) ListVocabularyFiltersPages(input *ListVocabularyFiltersInput, fn func(*ListVocabularyFiltersOutput, bool) bool) error

ListVocabularyFiltersPages iterates over the pages of a ListVocabularyFilters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListVocabularyFilters 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 ListVocabularyFilters operation.
pageNum := 0
err := client.ListVocabularyFiltersPages(params,
    func(page *transcribeservice.ListVocabularyFiltersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListVocabularyFiltersPagesWithContext added in v1.26.7 

func (c *TranscribeService) ListVocabularyFiltersPagesWithContext(ctx aws.Context, input *ListVocabularyFiltersInput, fn func(*ListVocabularyFiltersOutput, bool) bool, opts ...request.Option) error

ListVocabularyFiltersPagesWithContext same as ListVocabularyFiltersPages 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 (*TranscribeService) ListVocabularyFiltersRequest added in v1.26.7 

func (c *TranscribeService) ListVocabularyFiltersRequest(input *ListVocabularyFiltersInput) (req *request.Request, output *ListVocabularyFiltersOutput)

ListVocabularyFiltersRequest generates a "aws/request.Request" representing the client's request for the ListVocabularyFilters 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 ListVocabularyFilters for more information on using the ListVocabularyFilters 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 ListVocabularyFiltersRequest method.
req, resp := client.ListVocabularyFiltersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFilters

func (*TranscribeService) ListVocabularyFiltersWithContext added in v1.26.7 

func (c *TranscribeService) ListVocabularyFiltersWithContext(ctx aws.Context, input *ListVocabularyFiltersInput, opts ...request.Option) (*ListVocabularyFiltersOutput, error)

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

See ListVocabularyFilters 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 (*TranscribeService) StartCallAnalyticsJob added in v1.40.15 

func (c *TranscribeService) StartCallAnalyticsJob(input *StartCallAnalyticsJobInput) (*StartCallAnalyticsJobOutput, error)

StartCallAnalyticsJob API operation for Amazon Transcribe Service.

Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.

In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html).

If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) and Creating categories for real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html).

To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

Note that job queuing is enabled by default for Call Analytics jobs.

You must include the following parameters in your StartCallAnalyticsJob request:

  • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html).

  • CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your Amazon Web Services account.

  • DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.

  • Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.

With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response.

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 Transcribe Service's API operation StartCallAnalyticsJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartCallAnalyticsJob

func (*TranscribeService) StartCallAnalyticsJobRequest added in v1.40.15 

func (c *TranscribeService) StartCallAnalyticsJobRequest(input *StartCallAnalyticsJobInput) (req *request.Request, output *StartCallAnalyticsJobOutput)

StartCallAnalyticsJobRequest generates a "aws/request.Request" representing the client's request for the StartCallAnalyticsJob 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 StartCallAnalyticsJob for more information on using the StartCallAnalyticsJob 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 StartCallAnalyticsJobRequest method.
req, resp := client.StartCallAnalyticsJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartCallAnalyticsJob

func (*TranscribeService) StartCallAnalyticsJobWithContext added in v1.40.15 

func (c *TranscribeService) StartCallAnalyticsJobWithContext(ctx aws.Context, input *StartCallAnalyticsJobInput, opts ...request.Option) (*StartCallAnalyticsJobOutput, error)

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

See StartCallAnalyticsJob 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 (*TranscribeService) StartMedicalScribeJob added in v1.48.5 

func (c *TranscribeService) StartMedicalScribeJob(input *StartMedicalScribeJobInput) (*StartMedicalScribeJobOutput, error)

StartMedicalScribeJob API operation for Amazon Transcribe Service.

Transcribes patient-clinician conversations and generates clinical notes.

Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe (https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html).

To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

You must include the following parameters in your StartMedicalTranscriptionJob request:

  • DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it.

  • Media (MediaFileUri): The Amazon S3 location of your media file.

  • MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account.

  • OutputBucketName: The Amazon S3 bucket where you want your output files stored.

  • Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.

  • ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.

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 Transcribe Service's API operation StartMedicalScribeJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalScribeJob

func (*TranscribeService) StartMedicalScribeJobRequest added in v1.48.5 

func (c *TranscribeService) StartMedicalScribeJobRequest(input *StartMedicalScribeJobInput) (req *request.Request, output *StartMedicalScribeJobOutput)

StartMedicalScribeJobRequest generates a "aws/request.Request" representing the client's request for the StartMedicalScribeJob 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 StartMedicalScribeJob for more information on using the StartMedicalScribeJob 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 StartMedicalScribeJobRequest method.
req, resp := client.StartMedicalScribeJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalScribeJob

func (*TranscribeService) StartMedicalScribeJobWithContext added in v1.48.5 

func (c *TranscribeService) StartMedicalScribeJobWithContext(ctx aws.Context, input *StartMedicalScribeJobInput, opts ...request.Option) (*StartMedicalScribeJobOutput, error)

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

See StartMedicalScribeJob 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 (*TranscribeService) StartMedicalTranscriptionJob added in v1.30.5 

func (c *TranscribeService) StartMedicalTranscriptionJob(input *StartMedicalTranscriptionJobInput) (*StartMedicalTranscriptionJobOutput, error)

StartMedicalTranscriptionJob API operation for Amazon Transcribe Service.

Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.

In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works (https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html).

To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

You must include the following parameters in your StartMedicalTranscriptionJob request:

  • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html).

  • MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

  • Media (MediaFileUri): The Amazon S3 location of your media file.

  • LanguageCode: This must be en-US.

  • OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey.

  • Specialty: This must be PRIMARYCARE.

  • Type: Choose whether your audio is a conversation or a dictation.

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 Transcribe Service's API operation StartMedicalTranscriptionJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJob

func (*TranscribeService) StartMedicalTranscriptionJobRequest added in v1.30.5 

func (c *TranscribeService) StartMedicalTranscriptionJobRequest(input *StartMedicalTranscriptionJobInput) (req *request.Request, output *StartMedicalTranscriptionJobOutput)

StartMedicalTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the StartMedicalTranscriptionJob 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 StartMedicalTranscriptionJob for more information on using the StartMedicalTranscriptionJob 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 StartMedicalTranscriptionJobRequest method.
req, resp := client.StartMedicalTranscriptionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJob

func (*TranscribeService) StartMedicalTranscriptionJobWithContext added in v1.30.5 

func (c *TranscribeService) StartMedicalTranscriptionJobWithContext(ctx aws.Context, input *StartMedicalTranscriptionJobInput, opts ...request.Option) (*StartMedicalTranscriptionJobOutput, error)

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

See StartMedicalTranscriptionJob 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 (*TranscribeService) StartTranscriptionJob 

func (c *TranscribeService) StartTranscriptionJob(input *StartTranscriptionJobInput) (*StartTranscriptionJobOutput, error)

StartTranscriptionJob API operation for Amazon Transcribe Service.

Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.

To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

You must include the following parameters in your StartTranscriptionJob request:

  • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html).

  • TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

  • Media (MediaFileUri): The Amazon S3 location of your media file.

  • One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

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 Transcribe Service's API operation StartTranscriptionJob for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJob

func (*TranscribeService) StartTranscriptionJobRequest 

func (c *TranscribeService) StartTranscriptionJobRequest(input *StartTranscriptionJobInput) (req *request.Request, output *StartTranscriptionJobOutput)

StartTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the StartTranscriptionJob 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 StartTranscriptionJob for more information on using the StartTranscriptionJob 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 StartTranscriptionJobRequest method.
req, resp := client.StartTranscriptionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJob

func (*TranscribeService) StartTranscriptionJobWithContext 

func (c *TranscribeService) StartTranscriptionJobWithContext(ctx aws.Context, input *StartTranscriptionJobInput, opts ...request.Option) (*StartTranscriptionJobOutput, error)

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

See StartTranscriptionJob 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 (*TranscribeService) TagResource added in v1.40.29 

func (c *TranscribeService) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Transcribe Service.

Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).

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 Transcribe Service's API operation TagResource for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TagResource

func (*TranscribeService) TagResourceRequest added in v1.40.29 

func (c *TranscribeService) 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/transcribe-2017-10-26/TagResource

func (*TranscribeService) TagResourceWithContext added in v1.40.29 

func (c *TranscribeService) 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 (*TranscribeService) UntagResource added in v1.40.29 

func (c *TranscribeService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Transcribe Service.

Removes the specified tags from the specified Amazon Transcribe resource.

If you include UntagResource in your request, you must also include ResourceArn and TagKeys.

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 Transcribe Service's API operation UntagResource for usage and error information.

Returned Error Types:

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UntagResource

func (*TranscribeService) UntagResourceRequest added in v1.40.29 

func (c *TranscribeService) 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/transcribe-2017-10-26/UntagResource

func (*TranscribeService) UntagResourceWithContext added in v1.40.29 

func (c *TranscribeService) 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 (*TranscribeService) UpdateCallAnalyticsCategory added in v1.40.15 

func (c *TranscribeService) UpdateCallAnalyticsCategory(input *UpdateCallAnalyticsCategoryInput) (*UpdateCallAnalyticsCategoryOutput, error)

UpdateCallAnalyticsCategory API operation for Amazon Transcribe Service.

Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.

To create a new category, see .

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 Transcribe Service's API operation UpdateCallAnalyticsCategory for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategory

func (*TranscribeService) UpdateCallAnalyticsCategoryRequest added in v1.40.15 

func (c *TranscribeService) UpdateCallAnalyticsCategoryRequest(input *UpdateCallAnalyticsCategoryInput) (req *request.Request, output *UpdateCallAnalyticsCategoryOutput)

UpdateCallAnalyticsCategoryRequest generates a "aws/request.Request" representing the client's request for the UpdateCallAnalyticsCategory 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 UpdateCallAnalyticsCategory for more information on using the UpdateCallAnalyticsCategory 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 UpdateCallAnalyticsCategoryRequest method.
req, resp := client.UpdateCallAnalyticsCategoryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategory

func (*TranscribeService) UpdateCallAnalyticsCategoryWithContext added in v1.40.15 

func (c *TranscribeService) UpdateCallAnalyticsCategoryWithContext(ctx aws.Context, input *UpdateCallAnalyticsCategoryInput, opts ...request.Option) (*UpdateCallAnalyticsCategoryOutput, error)

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

See UpdateCallAnalyticsCategory 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 (*TranscribeService) UpdateMedicalVocabulary added in v1.30.17 

func (c *TranscribeService) UpdateMedicalVocabulary(input *UpdateMedicalVocabularyInput) (*UpdateMedicalVocabularyOutput, error)

UpdateMedicalVocabulary API operation for Amazon Transcribe Service.

Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

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 Transcribe Service's API operation UpdateMedicalVocabulary for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabulary

func (*TranscribeService) UpdateMedicalVocabularyRequest added in v1.30.17 

func (c *TranscribeService) UpdateMedicalVocabularyRequest(input *UpdateMedicalVocabularyInput) (req *request.Request, output *UpdateMedicalVocabularyOutput)

UpdateMedicalVocabularyRequest generates a "aws/request.Request" representing the client's request for the UpdateMedicalVocabulary 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 UpdateMedicalVocabulary for more information on using the UpdateMedicalVocabulary 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 UpdateMedicalVocabularyRequest method.
req, resp := client.UpdateMedicalVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabulary

func (*TranscribeService) UpdateMedicalVocabularyWithContext added in v1.30.17 

func (c *TranscribeService) UpdateMedicalVocabularyWithContext(ctx aws.Context, input *UpdateMedicalVocabularyInput, opts ...request.Option) (*UpdateMedicalVocabularyOutput, error)

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

See UpdateMedicalVocabulary 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 (*TranscribeService) UpdateVocabulary added in v1.13.28 

func (c *TranscribeService) UpdateVocabulary(input *UpdateVocabularyInput) (*UpdateVocabularyOutput, error)

UpdateVocabulary API operation for Amazon Transcribe Service.

Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

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 Transcribe Service's API operation UpdateVocabulary for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

  • ConflictException A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabulary

func (*TranscribeService) UpdateVocabularyFilter added in v1.26.7 

func (c *TranscribeService) UpdateVocabularyFilter(input *UpdateVocabularyFilterInput) (*UpdateVocabularyFilterOutput, error)

UpdateVocabularyFilter API operation for Amazon Transcribe Service.

Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.

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 Transcribe Service's API operation UpdateVocabularyFilter for usage and error information.

Returned Error Types:

  • BadRequestException Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • LimitExceededException You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • InternalFailureException There was an internal error. Check the error message, correct the issue, and try your request again.

  • NotFoundException We can't find the requested resource. Check that the specified name is correct and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyFilter

func (*TranscribeService) UpdateVocabularyFilterRequest added in v1.26.7 

func (c *TranscribeService) UpdateVocabularyFilterRequest(input *UpdateVocabularyFilterInput) (req *request.Request, output *UpdateVocabularyFilterOutput)

UpdateVocabularyFilterRequest generates a "aws/request.Request" representing the client's request for the UpdateVocabularyFilter 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 UpdateVocabularyFilter for more information on using the UpdateVocabularyFilter 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 UpdateVocabularyFilterRequest method.
req, resp := client.UpdateVocabularyFilterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyFilter

func (*TranscribeService) UpdateVocabularyFilterWithContext added in v1.26.7 

func (c *TranscribeService) UpdateVocabularyFilterWithContext(ctx aws.Context, input *UpdateVocabularyFilterInput, opts ...request.Option) (*UpdateVocabularyFilterOutput, error)

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

See UpdateVocabularyFilter 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 (*TranscribeService) UpdateVocabularyRequest added in v1.13.28 

func (c *TranscribeService) UpdateVocabularyRequest(input *UpdateVocabularyInput) (req *request.Request, output *UpdateVocabularyOutput)

UpdateVocabularyRequest generates a "aws/request.Request" representing the client's request for the UpdateVocabulary 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 UpdateVocabulary for more information on using the UpdateVocabulary 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 UpdateVocabularyRequest method.
req, resp := client.UpdateVocabularyRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabulary

func (*TranscribeService) UpdateVocabularyWithContext added in v1.13.28 

func (c *TranscribeService) UpdateVocabularyWithContext(ctx aws.Context, input *UpdateVocabularyInput, opts ...request.Option) (*UpdateVocabularyOutput, error)

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

See UpdateVocabulary 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 Transcript 

type Transcript struct {

	// The Amazon S3 location of your redacted transcript. You can use this URI
	// to access or download your transcript.
	//
	// If you included OutputBucketName in your transcription job request, this
	// is the URI of that bucket. If you also included OutputKey in your request,
	// your output is located in the path you specified in your request.
	//
	// If you didn't include OutputBucketName in your transcription job request,
	// your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri
	// provides you with a temporary URI you can use for secure access to your transcript.
	//
	// Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
	// minutes. If you get an AccesDenied error, you can get a new temporary URI
	// by running a GetTranscriptionJob or ListTranscriptionJob request.
	RedactedTranscriptFileUri *string `min:"1" type:"string"`

	// The Amazon S3 location of your transcript. You can use this URI to access
	// or download your transcript.
	//
	// If you included OutputBucketName in your transcription job request, this
	// is the URI of that bucket. If you also included OutputKey in your request,
	// your output is located in the path you specified in your request.
	//
	// If you didn't include OutputBucketName in your transcription job request,
	// your transcript is stored in a service-managed bucket, and TranscriptFileUri
	// provides you with a temporary URI you can use for secure access to your transcript.
	//
	// Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
	// minutes. If you get an AccesDenied error, you can get a new temporary URI
	// by running a GetTranscriptionJob or ListTranscriptionJob request.
	TranscriptFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides you with the Amazon S3 URI you can use to access your transcript.

func (Transcript) GoString 

func (s Transcript) 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 (*Transcript) SetRedactedTranscriptFileUri added in v1.29.11 

func (s *Transcript) SetRedactedTranscriptFileUri(v string) *Transcript

SetRedactedTranscriptFileUri sets the RedactedTranscriptFileUri field's value.

func (*Transcript) SetTranscriptFileUri 

func (s *Transcript) SetTranscriptFileUri(v string) *Transcript

SetTranscriptFileUri sets the TranscriptFileUri field's value.

func (Transcript) String 

func (s Transcript) 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 TranscriptFilter added in v1.40.15 

type TranscriptFilter struct {

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for the specified key words or phrases. See
	// for more detail.
	AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"`

	// Set to TRUE to flag the absence of the phrase that you specified in your
	// request. Set to FALSE to flag the presence of the phrase that you specified
	// in your request.
	Negate *bool `type:"boolean"`

	// Specify the participant that you want to flag. Omitting this parameter is
	// equivalent to specifying both participants.
	ParticipantRole *string `type:"string" enum:"ParticipantRole"`

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for the specified key words or phrases. See
	// for more detail.
	RelativeTimeRange *RelativeTimeRange `type:"structure"`

	// Specify the phrases that you want to flag.
	//
	// Targets is a required field
	Targets []*string `min:"1" type:"list" required:"true"`

	// Flag the presence or absence of an exact match to the phrases that you specify.
	// For example, if you specify the phrase "speak to a manager" as your Targets
	// value, only that exact phrase is flagged.
	//
	// Note that semantic matching is not supported. For example, if your customer
	// says "speak to the manager", instead of "speak to a manager", your content
	// is not flagged.
	//
	// TranscriptFilterType is a required field
	TranscriptFilterType *string `type:"string" required:"true" enum:"TranscriptFilterType"`
	// contains filtered or unexported fields
}

Flag the presence or absence of specific words or phrases detected in your Call Analytics transcription output.

Rules using TranscriptFilter are designed to match:

  • Custom words or phrases spoken by the agent, the customer, or both

  • Custom words or phrases not spoken by the agent, the customer, or either

  • Custom words or phrases that occur at a specific time frame

See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch) and Rule criteria for streaming categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream) for usage examples.

func (TranscriptFilter) GoString added in v1.40.15 

func (s TranscriptFilter) 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 (*TranscriptFilter) SetAbsoluteTimeRange added in v1.40.15 

func (s *TranscriptFilter) SetAbsoluteTimeRange(v *AbsoluteTimeRange) *TranscriptFilter

SetAbsoluteTimeRange sets the AbsoluteTimeRange field's value.

func (*TranscriptFilter) SetNegate added in v1.40.15 

func (s *TranscriptFilter) SetNegate(v bool) *TranscriptFilter

SetNegate sets the Negate field's value.

func (*TranscriptFilter) SetParticipantRole added in v1.40.15 

func (s *TranscriptFilter) SetParticipantRole(v string) *TranscriptFilter

SetParticipantRole sets the ParticipantRole field's value.

func (*TranscriptFilter) SetRelativeTimeRange added in v1.40.15 

func (s *TranscriptFilter) SetRelativeTimeRange(v *RelativeTimeRange) *TranscriptFilter

SetRelativeTimeRange sets the RelativeTimeRange field's value.

func (*TranscriptFilter) SetTargets added in v1.40.15 

func (s *TranscriptFilter) SetTargets(v []*string) *TranscriptFilter

SetTargets sets the Targets field's value.

func (*TranscriptFilter) SetTranscriptFilterType added in v1.40.15 

func (s *TranscriptFilter) SetTranscriptFilterType(v string) *TranscriptFilter

SetTranscriptFilterType sets the TranscriptFilterType field's value.

func (TranscriptFilter) String added in v1.40.15 

func (s TranscriptFilter) 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 (*TranscriptFilter) Validate added in v1.40.15 

func (s *TranscriptFilter) Validate() error

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

type TranscriptionJob 

type TranscriptionJob struct {

	// The date and time the specified transcription job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// Indicates whether redaction was enabled in your transcript.
	ContentRedaction *ContentRedaction `type:"structure"`

	// The date and time the specified transcription job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// If TranscriptionJobStatus is FAILED, FailureReason contains information about
	// why the transcription job request failed.
	//
	// The FailureReason field contains one of the following values:
	//
	//    * Unsupported media format. The media format specified in MediaFormat
	//    isn't valid. Refer to refer to the MediaFormat parameter for a list of
	//    supported formats.
	//
	//    * The media format provided does not match the detected media format.
	//    The media format specified in MediaFormat doesn't match the format of
	//    the input file. Check the media format of your media file and correct
	//    the specified value.
	//
	//    * Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz
	//    isn't valid. The sample rate must be between 8,000 and 48,000 hertz.
	//
	//    * The sample rate provided does not match the detected sample rate. The
	//    sample rate specified in MediaSampleRateHertz doesn't match the sample
	//    rate detected in your input media file. Check the sample rate of your
	//    media file and correct the specified value.
	//
	//    * Invalid file size: file size too large. The size of your media file
	//    is larger than what Amazon Transcribe can process. For more information,
	//    refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe).
	//
	//    * Invalid number of channels: number of channels too large. Your audio
	//    contains more channels than Amazon Transcribe is able to process. For
	//    more information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe).
	FailureReason *string `type:"string"`

	// The confidence score associated with the language identified in your media
	// file.
	//
	// Confidence scores are values between 0 and 1; a larger value indicates a
	// higher probability that the identified language correctly matches the language
	// spoken in your media.
	IdentifiedLanguageScore *float64 `type:"float"`

	// Indicates whether automatic language identification was enabled (TRUE) for
	// the specified transcription job.
	IdentifyLanguage *bool `type:"boolean"`

	// Indicates whether automatic multi-language identification was enabled (TRUE)
	// for the specified transcription job.
	IdentifyMultipleLanguages *bool `type:"boolean"`

	// Provides information about how your transcription job was processed. This
	// parameter shows if your request was queued and what data access role was
	// used.
	JobExecutionSettings *JobExecutionSettings `type:"structure"`

	// The language code used to create your transcription job. This parameter is
	// used with single-language identification. For multi-language identification
	// requests, refer to the plural version of this parameter, LanguageCodes.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The language codes used to create your transcription job. This parameter
	// is used with multi-language identification. For single-language identification
	// requests, refer to the singular version of this parameter, LanguageCode.
	LanguageCodes []*LanguageCodeItem `type:"list"`

	// Provides the name and language of all custom language models, custom vocabularies,
	// and custom vocabulary filters that you included in your request.
	LanguageIdSettings map[string]*LanguageIdSettings `min:"1" type:"map"`

	// Provides the language codes you specified in your request.
	LanguageOptions []*string `min:"1" type:"list" enum:"LanguageCode"`

	// Provides the Amazon S3 location of the media file you used in your request.
	Media *Media `type:"structure"`

	// The format of the input media file.
	MediaFormat *string `type:"string" enum:"MediaFormat"`

	// The sample rate, in hertz, of the audio track in your input media file.
	MediaSampleRateHertz *int64 `min:"8000" type:"integer"`

	// Provides information on the custom language model you included in your request.
	ModelSettings *ModelSettings `type:"structure"`

	// Provides information on any additional settings that were included in your
	// request. Additional settings include channel identification, alternative
	// transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary
	// filters.
	Settings *Settings `type:"structure"`

	// The date and time the specified transcription job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`

	// Indicates whether subtitles were generated with your transcription.
	Subtitles *SubtitlesOutput_ `type:"structure"`

	// The tags, each in the form of a key:value pair, assigned to the specified
	// transcription job.
	Tags []*Tag `min:"1" type:"list"`

	// Provides information about the toxicity detection settings applied to your
	// transcription.
	ToxicityDetection []*ToxicityDetectionSettings `min:"1" type:"list"`

	// Provides you with the Amazon S3 URI you can use to access your transcript.
	Transcript *Transcript `type:"structure"`

	// The name of the transcription job. Job names are case sensitive and must
	// be unique within an Amazon Web Services account.
	TranscriptionJobName *string `min:"1" type:"string"`

	// Provides the status of the specified transcription job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri,
	// if you requested transcript redaction). If the status is FAILED, FailureReason
	// provides details on why your transcription job failed.
	TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"`
	// contains filtered or unexported fields
}

Provides detailed information about a transcription job.

To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

func (TranscriptionJob) GoString 

func (s TranscriptionJob) 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 (*TranscriptionJob) SetCompletionTime 

func (s *TranscriptionJob) SetCompletionTime(v time.Time) *TranscriptionJob

SetCompletionTime sets the CompletionTime field's value.

func (*TranscriptionJob) SetContentRedaction added in v1.29.11 

func (s *TranscriptionJob) SetContentRedaction(v *ContentRedaction) *TranscriptionJob

SetContentRedaction sets the ContentRedaction field's value.

func (*TranscriptionJob) SetCreationTime 

func (s *TranscriptionJob) SetCreationTime(v time.Time) *TranscriptionJob

SetCreationTime sets the CreationTime field's value.

func (*TranscriptionJob) SetFailureReason 

func (s *TranscriptionJob) SetFailureReason(v string) *TranscriptionJob

SetFailureReason sets the FailureReason field's value.

func (*TranscriptionJob) SetIdentifiedLanguageScore added in v1.34.24 

func (s *TranscriptionJob) SetIdentifiedLanguageScore(v float64) *TranscriptionJob

SetIdentifiedLanguageScore sets the IdentifiedLanguageScore field's value.

func (*TranscriptionJob) SetIdentifyLanguage added in v1.34.24 

func (s *TranscriptionJob) SetIdentifyLanguage(v bool) *TranscriptionJob

SetIdentifyLanguage sets the IdentifyLanguage field's value.

func (*TranscriptionJob) SetIdentifyMultipleLanguages added in v1.44.25 

func (s *TranscriptionJob) SetIdentifyMultipleLanguages(v bool) *TranscriptionJob

SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value.

func (*TranscriptionJob) SetJobExecutionSettings added in v1.26.6 

func (s *TranscriptionJob) SetJobExecutionSettings(v *JobExecutionSettings) *TranscriptionJob

SetJobExecutionSettings sets the JobExecutionSettings field's value.

func (*TranscriptionJob) SetLanguageCode 

func (s *TranscriptionJob) SetLanguageCode(v string) *TranscriptionJob

SetLanguageCode sets the LanguageCode field's value.

func (*TranscriptionJob) SetLanguageCodes added in v1.44.25 

func (s *TranscriptionJob) SetLanguageCodes(v []*LanguageCodeItem) *TranscriptionJob

SetLanguageCodes sets the LanguageCodes field's value.

func (*TranscriptionJob) SetLanguageIdSettings added in v1.41.14 

func (s *TranscriptionJob) SetLanguageIdSettings(v map[string]*LanguageIdSettings) *TranscriptionJob

SetLanguageIdSettings sets the LanguageIdSettings field's value.

func (*TranscriptionJob) SetLanguageOptions added in v1.34.24 

func (s *TranscriptionJob) SetLanguageOptions(v []*string) *TranscriptionJob

SetLanguageOptions sets the LanguageOptions field's value.

func (*TranscriptionJob) SetMedia 

func (s *TranscriptionJob) SetMedia(v *Media) *TranscriptionJob

SetMedia sets the Media field's value.

func (*TranscriptionJob) SetMediaFormat 

func (s *TranscriptionJob) SetMediaFormat(v string) *TranscriptionJob

SetMediaFormat sets the MediaFormat field's value.

func (*TranscriptionJob) SetMediaSampleRateHertz 

func (s *TranscriptionJob) SetMediaSampleRateHertz(v int64) *TranscriptionJob

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*TranscriptionJob) SetModelSettings added in v1.33.20 

func (s *TranscriptionJob) SetModelSettings(v *ModelSettings) *TranscriptionJob

SetModelSettings sets the ModelSettings field's value.

func (*TranscriptionJob) SetSettings added in v1.13.28 

func (s *TranscriptionJob) SetSettings(v *Settings) *TranscriptionJob

SetSettings sets the Settings field's value.

func (*TranscriptionJob) SetStartTime added in v1.26.6 

func (s *TranscriptionJob) SetStartTime(v time.Time) *TranscriptionJob

SetStartTime sets the StartTime field's value.

func (*TranscriptionJob) SetSubtitles added in v1.40.44 

func (s *TranscriptionJob) SetSubtitles(v *SubtitlesOutput_) *TranscriptionJob

SetSubtitles sets the Subtitles field's value.

func (*TranscriptionJob) SetTags added in v1.40.29 

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

SetTags sets the Tags field's value.

func (*TranscriptionJob) SetToxicityDetection added in v1.44.305 

func (s *TranscriptionJob) SetToxicityDetection(v []*ToxicityDetectionSettings) *TranscriptionJob

SetToxicityDetection sets the ToxicityDetection field's value.

func (*TranscriptionJob) SetTranscript 

func (s *TranscriptionJob) SetTranscript(v *Transcript) *TranscriptionJob

SetTranscript sets the Transcript field's value.

func (*TranscriptionJob) SetTranscriptionJobName 

func (s *TranscriptionJob) SetTranscriptionJobName(v string) *TranscriptionJob

SetTranscriptionJobName sets the TranscriptionJobName field's value.

func (*TranscriptionJob) SetTranscriptionJobStatus 

func (s *TranscriptionJob) SetTranscriptionJobStatus(v string) *TranscriptionJob

SetTranscriptionJobStatus sets the TranscriptionJobStatus field's value.

func (TranscriptionJob) String 

func (s TranscriptionJob) 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 TranscriptionJobSummary 

type TranscriptionJobSummary struct {

	// The date and time the specified transcription job finished processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time `type:"timestamp"`

	// The content redaction settings of the transcription job.
	ContentRedaction *ContentRedaction `type:"structure"`

	// The date and time the specified transcription job request was made.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time `type:"timestamp"`

	// If TranscriptionJobStatus is FAILED, FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html).
	FailureReason *string `type:"string"`

	// The confidence score associated with the language identified in your media
	// file.
	//
	// Confidence scores are values between 0 and 1; a larger value indicates a
	// higher probability that the identified language correctly matches the language
	// spoken in your media.
	IdentifiedLanguageScore *float64 `type:"float"`

	// Indicates whether automatic language identification was enabled (TRUE) for
	// the specified transcription job.
	IdentifyLanguage *bool `type:"boolean"`

	// Indicates whether automatic multi-language identification was enabled (TRUE)
	// for the specified transcription job.
	IdentifyMultipleLanguages *bool `type:"boolean"`

	// The language code used to create your transcription.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The language codes used to create your transcription job. This parameter
	// is used with multi-language identification. For single-language identification,
	// the singular version of this parameter, LanguageCode, is present.
	LanguageCodes []*LanguageCodeItem `type:"list"`

	// Provides the name of the custom language model that was included in the specified
	// transcription job.
	//
	// Only use ModelSettings with the LanguageModelName sub-parameter if you're
	// not using automatic language identification (). If using LanguageIdSettings
	// in your request, this parameter contains a LanguageModelName sub-parameter.
	ModelSettings *ModelSettings `type:"structure"`

	// Indicates where the specified transcription output is stored.
	//
	// If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you
	// specified using the OutputBucketName parameter in your request. If you also
	// included OutputKey in your request, your output is located in the path you
	// specified in your request.
	//
	// If the value is SERVICE_BUCKET, the location is a service-managed Amazon
	// S3 bucket. To access a transcript stored in a service-managed bucket, use
	// the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.
	OutputLocationType *string `type:"string" enum:"OutputLocationType"`

	// The date and time your transcription job began processing.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time `type:"timestamp"`

	// Indicates whether toxicity detection was enabled for the specified transcription
	// job.
	ToxicityDetection []*ToxicityDetectionSettings `min:"1" type:"list"`

	// The name of the transcription job. Job names are case sensitive and must
	// be unique within an Amazon Web Services account.
	TranscriptionJobName *string `min:"1" type:"string"`

	// Provides the status of your transcription job.
	//
	// If the status is COMPLETED, the job is finished and you can find the results
	// at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri,
	// if you requested transcript redaction). If the status is FAILED, FailureReason
	// provides details on why your transcription job failed.
	TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"`
	// contains filtered or unexported fields
}

Provides detailed information about a specific transcription job.

func (TranscriptionJobSummary) GoString 

func (s TranscriptionJobSummary) 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 (*TranscriptionJobSummary) SetCompletionTime 

func (s *TranscriptionJobSummary) SetCompletionTime(v time.Time) *TranscriptionJobSummary

SetCompletionTime sets the CompletionTime field's value.

func (*TranscriptionJobSummary) SetContentRedaction added in v1.29.11 

func (s *TranscriptionJobSummary) SetContentRedaction(v *ContentRedaction) *TranscriptionJobSummary

SetContentRedaction sets the ContentRedaction field's value.

func (*TranscriptionJobSummary) SetCreationTime 

func (s *TranscriptionJobSummary) SetCreationTime(v time.Time) *TranscriptionJobSummary

SetCreationTime sets the CreationTime field's value.

func (*TranscriptionJobSummary) SetFailureReason 

func (s *TranscriptionJobSummary) SetFailureReason(v string) *TranscriptionJobSummary

SetFailureReason sets the FailureReason field's value.

func (*TranscriptionJobSummary) SetIdentifiedLanguageScore added in v1.34.24 

func (s *TranscriptionJobSummary) SetIdentifiedLanguageScore(v float64) *TranscriptionJobSummary

SetIdentifiedLanguageScore sets the IdentifiedLanguageScore field's value.

func (*TranscriptionJobSummary) SetIdentifyLanguage added in v1.34.24 

func (s *TranscriptionJobSummary) SetIdentifyLanguage(v bool) *TranscriptionJobSummary

SetIdentifyLanguage sets the IdentifyLanguage field's value.

func (*TranscriptionJobSummary) SetIdentifyMultipleLanguages added in v1.44.25 

func (s *TranscriptionJobSummary) SetIdentifyMultipleLanguages(v bool) *TranscriptionJobSummary

SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value.

func (*TranscriptionJobSummary) SetLanguageCode 

func (s *TranscriptionJobSummary) SetLanguageCode(v string) *TranscriptionJobSummary

SetLanguageCode sets the LanguageCode field's value.

func (*TranscriptionJobSummary) SetLanguageCodes added in v1.44.25 

func (s *TranscriptionJobSummary) SetLanguageCodes(v []*LanguageCodeItem) *TranscriptionJobSummary

SetLanguageCodes sets the LanguageCodes field's value.

func (*TranscriptionJobSummary) SetModelSettings added in v1.33.20 

func (s *TranscriptionJobSummary) SetModelSettings(v *ModelSettings) *TranscriptionJobSummary

SetModelSettings sets the ModelSettings field's value.

func (*TranscriptionJobSummary) SetOutputLocationType added in v1.14.22 

func (s *TranscriptionJobSummary) SetOutputLocationType(v string) *TranscriptionJobSummary

SetOutputLocationType sets the OutputLocationType field's value.

func (*TranscriptionJobSummary) SetStartTime added in v1.26.6 

func (s *TranscriptionJobSummary) SetStartTime(v time.Time) *TranscriptionJobSummary

SetStartTime sets the StartTime field's value.

func (*TranscriptionJobSummary) SetToxicityDetection added in v1.44.305 

func (s *TranscriptionJobSummary) SetToxicityDetection(v []*ToxicityDetectionSettings) *TranscriptionJobSummary

SetToxicityDetection sets the ToxicityDetection field's value.

func (*TranscriptionJobSummary) SetTranscriptionJobName 

func (s *TranscriptionJobSummary) SetTranscriptionJobName(v string) *TranscriptionJobSummary

SetTranscriptionJobName sets the TranscriptionJobName field's value.

func (*TranscriptionJobSummary) SetTranscriptionJobStatus 

func (s *TranscriptionJobSummary) SetTranscriptionJobStatus(v string) *TranscriptionJobSummary

SetTranscriptionJobStatus sets the TranscriptionJobStatus field's value.

func (TranscriptionJobSummary) String 

func (s TranscriptionJobSummary) 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 added in v1.40.29 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want
	// to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.
	//
	// For example, arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
	//
	// Valid values for resource-type are: transcription-job, medical-transcription-job,
	// vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// Removes the specified tag keys from the specified Amazon Transcribe resource.
	//
	// TagKeys is a required field
	TagKeys []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.40.29 

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 added in v1.40.29 

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.40.29 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.40.29 

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 added in v1.40.29 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.40.29 

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

func (UntagResourceOutput) GoString added in v1.40.29 

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 added in v1.40.29 

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 UpdateCallAnalyticsCategoryInput added in v1.40.15 

type UpdateCallAnalyticsCategoryInput struct {

	// The name of the Call Analytics category you want to update. Category names
	// are case sensitive.
	//
	// CategoryName is a required field
	CategoryName *string `min:"1" type:"string" required:"true"`

	// Choose whether you want to update a real-time or a post-call category. The
	// input type you specify must match the input type specified when the category
	// was created. For example, if you created a category with the POST_CALL input
	// type, you must use POST_CALL as the input type when updating this category.
	InputType *string `type:"string" enum:"InputType"`

	// The rules used for the updated Call Analytics category. The rules you provide
	// in this field replace the ones that are currently being used in the specified
	// category.
	//
	// Rules is a required field
	Rules []*Rule `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateCallAnalyticsCategoryInput) GoString added in v1.40.15 

func (s UpdateCallAnalyticsCategoryInput) 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 (*UpdateCallAnalyticsCategoryInput) SetCategoryName added in v1.40.15 

func (s *UpdateCallAnalyticsCategoryInput) SetCategoryName(v string) *UpdateCallAnalyticsCategoryInput

SetCategoryName sets the CategoryName field's value.

func (*UpdateCallAnalyticsCategoryInput) SetInputType added in v1.44.146 

func (s *UpdateCallAnalyticsCategoryInput) SetInputType(v string) *UpdateCallAnalyticsCategoryInput

SetInputType sets the InputType field's value.

func (*UpdateCallAnalyticsCategoryInput) SetRules added in v1.40.15 

func (s *UpdateCallAnalyticsCategoryInput) SetRules(v []*Rule) *UpdateCallAnalyticsCategoryInput

SetRules sets the Rules field's value.

func (UpdateCallAnalyticsCategoryInput) String added in v1.40.15 

func (s UpdateCallAnalyticsCategoryInput) 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 (*UpdateCallAnalyticsCategoryInput) Validate added in v1.40.15 

func (s *UpdateCallAnalyticsCategoryInput) Validate() error

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

type UpdateCallAnalyticsCategoryOutput added in v1.40.15 

type UpdateCallAnalyticsCategoryOutput struct {

	// Provides you with the properties of the Call Analytics category you specified
	// in your UpdateCallAnalyticsCategory request.
	CategoryProperties *CategoryProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateCallAnalyticsCategoryOutput) GoString added in v1.40.15 

func (s UpdateCallAnalyticsCategoryOutput) 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 (*UpdateCallAnalyticsCategoryOutput) SetCategoryProperties added in v1.40.15 

func (s *UpdateCallAnalyticsCategoryOutput) SetCategoryProperties(v *CategoryProperties) *UpdateCallAnalyticsCategoryOutput

SetCategoryProperties sets the CategoryProperties field's value.

func (UpdateCallAnalyticsCategoryOutput) String added in v1.40.15 

func (s UpdateCallAnalyticsCategoryOutput) 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 UpdateMedicalVocabularyInput added in v1.30.17 

type UpdateMedicalVocabularyInput struct {

	// The language code that represents the language of the entries in the custom
	// vocabulary you want to update. US English (en-US) is the only language supported
	// with Amazon Transcribe Medical.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// The Amazon S3 location of the text file that contains your custom medical
	// vocabulary. The URI must be located in the same Amazon Web Services Region
	// as the resource you're calling.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
	//
	// VocabularyFileUri is a required field
	VocabularyFileUri *string `min:"1" type:"string" required:"true"`

	// The name of the custom medical vocabulary you want to update. Custom medical
	// vocabulary names are case sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMedicalVocabularyInput) GoString added in v1.30.17 

func (s UpdateMedicalVocabularyInput) 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 (*UpdateMedicalVocabularyInput) SetLanguageCode added in v1.30.17 

func (s *UpdateMedicalVocabularyInput) SetLanguageCode(v string) *UpdateMedicalVocabularyInput

SetLanguageCode sets the LanguageCode field's value.

func (*UpdateMedicalVocabularyInput) SetVocabularyFileUri added in v1.30.17 

func (s *UpdateMedicalVocabularyInput) SetVocabularyFileUri(v string) *UpdateMedicalVocabularyInput

SetVocabularyFileUri sets the VocabularyFileUri field's value.

func (*UpdateMedicalVocabularyInput) SetVocabularyName added in v1.30.17 

func (s *UpdateMedicalVocabularyInput) SetVocabularyName(v string) *UpdateMedicalVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (UpdateMedicalVocabularyInput) String added in v1.30.17 

func (s UpdateMedicalVocabularyInput) 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 (*UpdateMedicalVocabularyInput) Validate added in v1.30.17 

func (s *UpdateMedicalVocabularyInput) Validate() error

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

type UpdateMedicalVocabularyOutput added in v1.30.17 

type UpdateMedicalVocabularyOutput struct {

	// The language code you selected for your custom medical vocabulary. US English
	// (en-US) is the only language supported with Amazon Transcribe Medical.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom medical vocabulary was last updated.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the updated custom medical vocabulary.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom medical vocabulary. If the state is READY,
	// you can use the custom vocabulary in a StartMedicalTranscriptionJob request.
	VocabularyState *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (UpdateMedicalVocabularyOutput) GoString added in v1.30.17 

func (s UpdateMedicalVocabularyOutput) 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 (*UpdateMedicalVocabularyOutput) SetLanguageCode added in v1.30.17 

func (s *UpdateMedicalVocabularyOutput) SetLanguageCode(v string) *UpdateMedicalVocabularyOutput

SetLanguageCode sets the LanguageCode field's value.

func (*UpdateMedicalVocabularyOutput) SetLastModifiedTime added in v1.30.17 

func (s *UpdateMedicalVocabularyOutput) SetLastModifiedTime(v time.Time) *UpdateMedicalVocabularyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*UpdateMedicalVocabularyOutput) SetVocabularyName added in v1.30.17 

func (s *UpdateMedicalVocabularyOutput) SetVocabularyName(v string) *UpdateMedicalVocabularyOutput

SetVocabularyName sets the VocabularyName field's value.

func (*UpdateMedicalVocabularyOutput) SetVocabularyState added in v1.30.17 

func (s *UpdateMedicalVocabularyOutput) SetVocabularyState(v string) *UpdateMedicalVocabularyOutput

SetVocabularyState sets the VocabularyState field's value.

func (UpdateMedicalVocabularyOutput) String added in v1.30.17 

func (s UpdateMedicalVocabularyOutput) 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 UpdateVocabularyFilterInput added in v1.26.7 

type UpdateVocabularyFilterInput struct {

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files (in this case, your custom
	// vocabulary filter). If the role that you specify doesn’t have the appropriate
	// permissions to access the specified Amazon S3 location, your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The Amazon S3 location of the text file that contains your custom vocabulary
	// filter terms. The URI must be located in the same Amazon Web Services Region
	// as the resource you're calling.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
	//
	// Note that if you include VocabularyFilterFileUri in your request, you cannot
	// use Words; you must choose one or the other.
	VocabularyFilterFileUri *string `min:"1" type:"string"`

	// The name of the custom vocabulary filter you want to update. Custom vocabulary
	// filter names are case sensitive.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`

	// Use this parameter if you want to update your custom vocabulary filter by
	// including all desired terms, as comma-separated values, within your request.
	// The other option for updating your vocabulary filter is to save your entries
	// in a text file and upload them to an Amazon S3 bucket, then specify the location
	// of your file using the VocabularyFilterFileUri parameter.
	//
	// Note that if you include Words in your request, you cannot use VocabularyFilterFileUri;
	// you must choose one or the other.
	//
	// Each language has a character set that contains all allowed characters for
	// that specific language. If you use unsupported characters, your custom vocabulary
	// filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html)
	// to get the character set for your language.
	Words []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyFilterInput) GoString added in v1.26.7 

func (s UpdateVocabularyFilterInput) 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 (*UpdateVocabularyFilterInput) SetDataAccessRoleArn added in v1.44.214 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*UpdateVocabularyFilterInput) SetVocabularyFilterFileUri added in v1.26.7 

func (s *UpdateVocabularyFilterInput) SetVocabularyFilterFileUri(v string) *UpdateVocabularyFilterInput

SetVocabularyFilterFileUri sets the VocabularyFilterFileUri field's value.

func (*UpdateVocabularyFilterInput) SetVocabularyFilterName added in v1.26.7 

func (s *UpdateVocabularyFilterInput) SetVocabularyFilterName(v string) *UpdateVocabularyFilterInput

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*UpdateVocabularyFilterInput) SetWords added in v1.26.7 

func (s *UpdateVocabularyFilterInput) SetWords(v []*string) *UpdateVocabularyFilterInput

SetWords sets the Words field's value.

func (UpdateVocabularyFilterInput) String added in v1.26.7 

func (s UpdateVocabularyFilterInput) 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 (*UpdateVocabularyFilterInput) Validate added in v1.26.7 

func (s *UpdateVocabularyFilterInput) Validate() error

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

type UpdateVocabularyFilterOutput added in v1.26.7 

type UpdateVocabularyFilterOutput struct {

	// The language code you selected for your custom vocabulary filter.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom vocabulary filter was last updated.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the updated custom vocabulary filter.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyFilterOutput) GoString added in v1.26.7 

func (s UpdateVocabularyFilterOutput) 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 (*UpdateVocabularyFilterOutput) SetLanguageCode added in v1.26.7 

func (s *UpdateVocabularyFilterOutput) SetLanguageCode(v string) *UpdateVocabularyFilterOutput

SetLanguageCode sets the LanguageCode field's value.

func (*UpdateVocabularyFilterOutput) SetLastModifiedTime added in v1.26.7 

func (s *UpdateVocabularyFilterOutput) SetLastModifiedTime(v time.Time) *UpdateVocabularyFilterOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*UpdateVocabularyFilterOutput) SetVocabularyFilterName added in v1.26.7 

func (s *UpdateVocabularyFilterOutput) SetVocabularyFilterName(v string) *UpdateVocabularyFilterOutput

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (UpdateVocabularyFilterOutput) String added in v1.26.7 

func (s UpdateVocabularyFilterOutput) 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 UpdateVocabularyInput added in v1.13.28 

type UpdateVocabularyInput struct {

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files (in this case, your custom
	// vocabulary). If the role that you specify doesn’t have the appropriate
	// permissions to access the specified Amazon S3 location, your request fails.
	//
	// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
	// For example: arn:aws:iam::111122223333:role/Admin.
	//
	// For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The language code that represents the language of the entries in the custom
	// vocabulary you want to update. Each custom vocabulary must contain terms
	// in only one language.
	//
	// A custom vocabulary can only be used to transcribe files in the same language
	// as the custom vocabulary. For example, if you create a custom vocabulary
	// using US English (en-US), you can only apply this custom vocabulary to files
	// that contain English audio.
	//
	// For a list of supported languages and their associated language codes, refer
	// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Use this parameter if you want to update your custom vocabulary by including
	// all desired terms, as comma-separated values, within your request. The other
	// option for updating your custom vocabulary is to save your entries in a text
	// file and upload them to an Amazon S3 bucket, then specify the location of
	// your file using the VocabularyFileUri parameter.
	//
	// Note that if you include Phrases in your request, you cannot use VocabularyFileUri;
	// you must choose one or the other.
	//
	// Each language has a character set that contains all allowed characters for
	// that specific language. If you use unsupported characters, your custom vocabulary
	// filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html)
	// to get the character set for your language.
	Phrases []*string `type:"list"`

	// The Amazon S3 location of the text file that contains your custom vocabulary.
	// The URI must be located in the same Amazon Web Services Region as the resource
	// you're calling.
	//
	// Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
	//
	// Note that if you include VocabularyFileUri in your request, you cannot use
	// the Phrases flag; you must choose one or the other.
	VocabularyFileUri *string `min:"1" type:"string"`

	// The name of the custom vocabulary you want to update. Custom vocabulary names
	// are case sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyInput) GoString added in v1.13.28 

func (s UpdateVocabularyInput) 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 (*UpdateVocabularyInput) SetDataAccessRoleArn added in v1.44.214 

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*UpdateVocabularyInput) SetLanguageCode added in v1.13.28 

func (s *UpdateVocabularyInput) SetLanguageCode(v string) *UpdateVocabularyInput

SetLanguageCode sets the LanguageCode field's value.

func (*UpdateVocabularyInput) SetPhrases added in v1.13.28 

func (s *UpdateVocabularyInput) SetPhrases(v []*string) *UpdateVocabularyInput

SetPhrases sets the Phrases field's value.

func (*UpdateVocabularyInput) SetVocabularyFileUri added in v1.19.4 

func (s *UpdateVocabularyInput) SetVocabularyFileUri(v string) *UpdateVocabularyInput

SetVocabularyFileUri sets the VocabularyFileUri field's value.

func (*UpdateVocabularyInput) SetVocabularyName added in v1.13.28 

func (s *UpdateVocabularyInput) SetVocabularyName(v string) *UpdateVocabularyInput

SetVocabularyName sets the VocabularyName field's value.

func (UpdateVocabularyInput) String added in v1.13.28 

func (s UpdateVocabularyInput) 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 (*UpdateVocabularyInput) Validate added in v1.13.28 

func (s *UpdateVocabularyInput) Validate() error

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

type UpdateVocabularyOutput added in v1.13.28 

type UpdateVocabularyOutput struct {

	// The language code you selected for your custom vocabulary.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom vocabulary was last updated.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the updated custom vocabulary.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom vocabulary. If the state is READY, you
	// can use the custom vocabulary in a StartTranscriptionJob request.
	VocabularyState *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyOutput) GoString added in v1.13.28 

func (s UpdateVocabularyOutput) 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 (*UpdateVocabularyOutput) SetLanguageCode added in v1.13.28 

func (s *UpdateVocabularyOutput) SetLanguageCode(v string) *UpdateVocabularyOutput

SetLanguageCode sets the LanguageCode field's value.

func (*UpdateVocabularyOutput) SetLastModifiedTime added in v1.13.28 

func (s *UpdateVocabularyOutput) SetLastModifiedTime(v time.Time) *UpdateVocabularyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*UpdateVocabularyOutput) SetVocabularyName added in v1.13.28 

func (s *UpdateVocabularyOutput) SetVocabularyName(v string) *UpdateVocabularyOutput

SetVocabularyName sets the VocabularyName field's value.

func (*UpdateVocabularyOutput) SetVocabularyState added in v1.13.28 

func (s *UpdateVocabularyOutput) SetVocabularyState(v string) *UpdateVocabularyOutput

SetVocabularyState sets the VocabularyState field's value.

func (UpdateVocabularyOutput) String added in v1.13.28 

func (s UpdateVocabularyOutput) 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 VocabularyFilterInfo added in v1.26.7 

type VocabularyFilterInfo struct {

	// The language code that represents the language of the entries in your vocabulary
	// filter. Each custom vocabulary filter must contain terms in only one language.
	//
	// A custom vocabulary filter can only be used to transcribe files in the same
	// language as the filter. For example, if you create a custom vocabulary filter
	// using US English (en-US), you can only apply this filter to files that contain
	// English audio.
	//
	// For a list of supported languages and their associated language codes, refer
	// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom vocabulary filter was last modified.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// A unique name, chosen by you, for your custom vocabulary filter. This name
	// is case sensitive, cannot contain spaces, and must be unique within an Amazon
	// Web Services account.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about a custom vocabulary filter, including the language of the filter, when it was last modified, and its name.

func (VocabularyFilterInfo) GoString added in v1.26.7 

func (s VocabularyFilterInfo) 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 (*VocabularyFilterInfo) SetLanguageCode added in v1.26.7 

func (s *VocabularyFilterInfo) SetLanguageCode(v string) *VocabularyFilterInfo

SetLanguageCode sets the LanguageCode field's value.

func (*VocabularyFilterInfo) SetLastModifiedTime added in v1.26.7 

func (s *VocabularyFilterInfo) SetLastModifiedTime(v time.Time) *VocabularyFilterInfo

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*VocabularyFilterInfo) SetVocabularyFilterName added in v1.26.7 

func (s *VocabularyFilterInfo) SetVocabularyFilterName(v string) *VocabularyFilterInfo

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (VocabularyFilterInfo) String added in v1.26.7 

func (s VocabularyFilterInfo) 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 VocabularyInfo added in v1.13.28 

type VocabularyInfo struct {

	// The language code used to create your custom vocabulary. Each custom vocabulary
	// must contain terms in only one language.
	//
	// A custom vocabulary can only be used to transcribe files in the same language
	// as the custom vocabulary. For example, if you create a custom vocabulary
	// using US English (en-US), you can only apply this custom vocabulary to files
	// that contain English audio.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The date and time the specified custom vocabulary was last modified.
	//
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time `type:"timestamp"`

	// A unique name, chosen by you, for your custom vocabulary. This name is case
	// sensitive, cannot contain spaces, and must be unique within an Amazon Web
	// Services account.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom vocabulary. If the state is READY, you
	// can use the custom vocabulary in a StartTranscriptionJob request.
	VocabularyState *string `type:"string" enum:"VocabularyState"`
	// contains filtered or unexported fields
}

Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.

func (VocabularyInfo) GoString added in v1.13.28 

func (s VocabularyInfo) 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 (*VocabularyInfo) SetLanguageCode added in v1.13.28 

func (s *VocabularyInfo) SetLanguageCode(v string) *VocabularyInfo

SetLanguageCode sets the LanguageCode field's value.

func (*VocabularyInfo) SetLastModifiedTime added in v1.13.28 

func (s *VocabularyInfo) SetLastModifiedTime(v time.Time) *VocabularyInfo

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*VocabularyInfo) SetVocabularyName added in v1.13.28 

func (s *VocabularyInfo) SetVocabularyName(v string) *VocabularyInfo

SetVocabularyName sets the VocabularyName field's value.

func (*VocabularyInfo) SetVocabularyState added in v1.13.28 

func (s *VocabularyInfo) SetVocabularyState(v string) *VocabularyInfo

SetVocabularyState sets the VocabularyState field's value.

func (VocabularyInfo) String added in v1.13.28 

func (s VocabularyInfo) 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".

Source Files

View all Source files

Directories

Path Synopsis
Package transcribeserviceiface provides an interface to enable mocking the Amazon Transcribe Service service client for testing your code.
 Package transcribeserviceiface provides an interface to enable mocking the Amazon Transcribe Service service client for testing your code.

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.