polly

package
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package polly provides the client and types for making API requests to Amazon Polly.

Amazon Polly is a web service that makes it easy to synthesize speech from text.

The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.

See https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10 for more information on this service.

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

Using the Client

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

Index

Examples

Constants

View Source 
const (
	// EngineStandard is a Engine enum value
	EngineStandard = "standard"

	// EngineNeural is a Engine enum value
	EngineNeural = "neural"

	// EngineLongForm is a Engine enum value
	EngineLongForm = "long-form"

	// EngineGenerative is a Engine enum value
	EngineGenerative = "generative"
)
View Source 
const (
	// GenderFemale is a Gender enum value
	GenderFemale = "Female"

	// GenderMale is a Gender enum value
	GenderMale = "Male"
)
View Source 
const (
	// LanguageCodeArb is a LanguageCode enum value
	LanguageCodeArb = "arb"

	// LanguageCodeCmnCn is a LanguageCode enum value
	LanguageCodeCmnCn = "cmn-CN"

	// LanguageCodeCyGb is a LanguageCode enum value
	LanguageCodeCyGb = "cy-GB"

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

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

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

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

	// LanguageCodeEnGbWls is a LanguageCode enum value
	LanguageCodeEnGbWls = "en-GB-WLS"

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

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

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

	// LanguageCodeEsMx is a LanguageCode enum value
	LanguageCodeEsMx = "es-MX"

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

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

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

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

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

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

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

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

	// LanguageCodeNbNo is a LanguageCode enum value
	LanguageCodeNbNo = "nb-NO"

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

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

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

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

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

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

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

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

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

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

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

	// LanguageCodeDeAt is a LanguageCode enum value
	LanguageCodeDeAt = "de-AT"

	// LanguageCodeYueCn is a LanguageCode enum value
	LanguageCodeYueCn = "yue-CN"

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

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

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

	// LanguageCodeNlBe is a LanguageCode enum value
	LanguageCodeNlBe = "nl-BE"

	// LanguageCodeFrBe is a LanguageCode enum value
	LanguageCodeFrBe = "fr-BE"
)
View Source 
const (
	// OutputFormatJson is a OutputFormat enum value
	OutputFormatJson = "json"

	// OutputFormatMp3 is a OutputFormat enum value
	OutputFormatMp3 = "mp3"

	// OutputFormatOggVorbis is a OutputFormat enum value
	OutputFormatOggVorbis = "ogg_vorbis"

	// OutputFormatPcm is a OutputFormat enum value
	OutputFormatPcm = "pcm"
)
View Source 
const (
	// SpeechMarkTypeSentence is a SpeechMarkType enum value
	SpeechMarkTypeSentence = "sentence"

	// SpeechMarkTypeSsml is a SpeechMarkType enum value
	SpeechMarkTypeSsml = "ssml"

	// SpeechMarkTypeViseme is a SpeechMarkType enum value
	SpeechMarkTypeViseme = "viseme"

	// SpeechMarkTypeWord is a SpeechMarkType enum value
	SpeechMarkTypeWord = "word"
)
View Source 
const (
	// TaskStatusScheduled is a TaskStatus enum value
	TaskStatusScheduled = "scheduled"

	// TaskStatusInProgress is a TaskStatus enum value
	TaskStatusInProgress = "inProgress"

	// TaskStatusCompleted is a TaskStatus enum value
	TaskStatusCompleted = "completed"

	// TaskStatusFailed is a TaskStatus enum value
	TaskStatusFailed = "failed"
)
View Source 
const (
	// TextTypeSsml is a TextType enum value
	TextTypeSsml = "ssml"

	// TextTypeText is a TextType enum value
	TextTypeText = "text"
)
View Source 
const (
	// VoiceIdAditi is a VoiceId enum value
	VoiceIdAditi = "Aditi"

	// VoiceIdAmy is a VoiceId enum value
	VoiceIdAmy = "Amy"

	// VoiceIdAstrid is a VoiceId enum value
	VoiceIdAstrid = "Astrid"

	// VoiceIdBianca is a VoiceId enum value
	VoiceIdBianca = "Bianca"

	// VoiceIdBrian is a VoiceId enum value
	VoiceIdBrian = "Brian"

	// VoiceIdCamila is a VoiceId enum value
	VoiceIdCamila = "Camila"

	// VoiceIdCarla is a VoiceId enum value
	VoiceIdCarla = "Carla"

	// VoiceIdCarmen is a VoiceId enum value
	VoiceIdCarmen = "Carmen"

	// VoiceIdCeline is a VoiceId enum value
	VoiceIdCeline = "Celine"

	// VoiceIdChantal is a VoiceId enum value
	VoiceIdChantal = "Chantal"

	// VoiceIdConchita is a VoiceId enum value
	VoiceIdConchita = "Conchita"

	// VoiceIdCristiano is a VoiceId enum value
	VoiceIdCristiano = "Cristiano"

	// VoiceIdDora is a VoiceId enum value
	VoiceIdDora = "Dora"

	// VoiceIdEmma is a VoiceId enum value
	VoiceIdEmma = "Emma"

	// VoiceIdEnrique is a VoiceId enum value
	VoiceIdEnrique = "Enrique"

	// VoiceIdEwa is a VoiceId enum value
	VoiceIdEwa = "Ewa"

	// VoiceIdFiliz is a VoiceId enum value
	VoiceIdFiliz = "Filiz"

	// VoiceIdGabrielle is a VoiceId enum value
	VoiceIdGabrielle = "Gabrielle"

	// VoiceIdGeraint is a VoiceId enum value
	VoiceIdGeraint = "Geraint"

	// VoiceIdGiorgio is a VoiceId enum value
	VoiceIdGiorgio = "Giorgio"

	// VoiceIdGwyneth is a VoiceId enum value
	VoiceIdGwyneth = "Gwyneth"

	// VoiceIdHans is a VoiceId enum value
	VoiceIdHans = "Hans"

	// VoiceIdInes is a VoiceId enum value
	VoiceIdInes = "Ines"

	// VoiceIdIvy is a VoiceId enum value
	VoiceIdIvy = "Ivy"

	// VoiceIdJacek is a VoiceId enum value
	VoiceIdJacek = "Jacek"

	// VoiceIdJan is a VoiceId enum value
	VoiceIdJan = "Jan"

	// VoiceIdJoanna is a VoiceId enum value
	VoiceIdJoanna = "Joanna"

	// VoiceIdJoey is a VoiceId enum value
	VoiceIdJoey = "Joey"

	// VoiceIdJustin is a VoiceId enum value
	VoiceIdJustin = "Justin"

	// VoiceIdKarl is a VoiceId enum value
	VoiceIdKarl = "Karl"

	// VoiceIdKendra is a VoiceId enum value
	VoiceIdKendra = "Kendra"

	// VoiceIdKevin is a VoiceId enum value
	VoiceIdKevin = "Kevin"

	// VoiceIdKimberly is a VoiceId enum value
	VoiceIdKimberly = "Kimberly"

	// VoiceIdLea is a VoiceId enum value
	VoiceIdLea = "Lea"

	// VoiceIdLiv is a VoiceId enum value
	VoiceIdLiv = "Liv"

	// VoiceIdLotte is a VoiceId enum value
	VoiceIdLotte = "Lotte"

	// VoiceIdLucia is a VoiceId enum value
	VoiceIdLucia = "Lucia"

	// VoiceIdLupe is a VoiceId enum value
	VoiceIdLupe = "Lupe"

	// VoiceIdMads is a VoiceId enum value
	VoiceIdMads = "Mads"

	// VoiceIdMaja is a VoiceId enum value
	VoiceIdMaja = "Maja"

	// VoiceIdMarlene is a VoiceId enum value
	VoiceIdMarlene = "Marlene"

	// VoiceIdMathieu is a VoiceId enum value
	VoiceIdMathieu = "Mathieu"

	// VoiceIdMatthew is a VoiceId enum value
	VoiceIdMatthew = "Matthew"

	// VoiceIdMaxim is a VoiceId enum value
	VoiceIdMaxim = "Maxim"

	// VoiceIdMia is a VoiceId enum value
	VoiceIdMia = "Mia"

	// VoiceIdMiguel is a VoiceId enum value
	VoiceIdMiguel = "Miguel"

	// VoiceIdMizuki is a VoiceId enum value
	VoiceIdMizuki = "Mizuki"

	// VoiceIdNaja is a VoiceId enum value
	VoiceIdNaja = "Naja"

	// VoiceIdNicole is a VoiceId enum value
	VoiceIdNicole = "Nicole"

	// VoiceIdOlivia is a VoiceId enum value
	VoiceIdOlivia = "Olivia"

	// VoiceIdPenelope is a VoiceId enum value
	VoiceIdPenelope = "Penelope"

	// VoiceIdRaveena is a VoiceId enum value
	VoiceIdRaveena = "Raveena"

	// VoiceIdRicardo is a VoiceId enum value
	VoiceIdRicardo = "Ricardo"

	// VoiceIdRuben is a VoiceId enum value
	VoiceIdRuben = "Ruben"

	// VoiceIdRussell is a VoiceId enum value
	VoiceIdRussell = "Russell"

	// VoiceIdSalli is a VoiceId enum value
	VoiceIdSalli = "Salli"

	// VoiceIdSeoyeon is a VoiceId enum value
	VoiceIdSeoyeon = "Seoyeon"

	// VoiceIdTakumi is a VoiceId enum value
	VoiceIdTakumi = "Takumi"

	// VoiceIdTatyana is a VoiceId enum value
	VoiceIdTatyana = "Tatyana"

	// VoiceIdVicki is a VoiceId enum value
	VoiceIdVicki = "Vicki"

	// VoiceIdVitoria is a VoiceId enum value
	VoiceIdVitoria = "Vitoria"

	// VoiceIdZeina is a VoiceId enum value
	VoiceIdZeina = "Zeina"

	// VoiceIdZhiyu is a VoiceId enum value
	VoiceIdZhiyu = "Zhiyu"

	// VoiceIdAria is a VoiceId enum value
	VoiceIdAria = "Aria"

	// VoiceIdAyanda is a VoiceId enum value
	VoiceIdAyanda = "Ayanda"

	// VoiceIdArlet is a VoiceId enum value
	VoiceIdArlet = "Arlet"

	// VoiceIdHannah is a VoiceId enum value
	VoiceIdHannah = "Hannah"

	// VoiceIdArthur is a VoiceId enum value
	VoiceIdArthur = "Arthur"

	// VoiceIdDaniel is a VoiceId enum value
	VoiceIdDaniel = "Daniel"

	// VoiceIdLiam is a VoiceId enum value
	VoiceIdLiam = "Liam"

	// VoiceIdPedro is a VoiceId enum value
	VoiceIdPedro = "Pedro"

	// VoiceIdKajal is a VoiceId enum value
	VoiceIdKajal = "Kajal"

	// VoiceIdHiujin is a VoiceId enum value
	VoiceIdHiujin = "Hiujin"

	// VoiceIdLaura is a VoiceId enum value
	VoiceIdLaura = "Laura"

	// VoiceIdElin is a VoiceId enum value
	VoiceIdElin = "Elin"

	// VoiceIdIda is a VoiceId enum value
	VoiceIdIda = "Ida"

	// VoiceIdSuvi is a VoiceId enum value
	VoiceIdSuvi = "Suvi"

	// VoiceIdOla is a VoiceId enum value
	VoiceIdOla = "Ola"

	// VoiceIdHala is a VoiceId enum value
	VoiceIdHala = "Hala"

	// VoiceIdAndres is a VoiceId enum value
	VoiceIdAndres = "Andres"

	// VoiceIdSergio is a VoiceId enum value
	VoiceIdSergio = "Sergio"

	// VoiceIdRemi is a VoiceId enum value
	VoiceIdRemi = "Remi"

	// VoiceIdAdriano is a VoiceId enum value
	VoiceIdAdriano = "Adriano"

	// VoiceIdThiago is a VoiceId enum value
	VoiceIdThiago = "Thiago"

	// VoiceIdRuth is a VoiceId enum value
	VoiceIdRuth = "Ruth"

	// VoiceIdStephen is a VoiceId enum value
	VoiceIdStephen = "Stephen"

	// VoiceIdKazuha is a VoiceId enum value
	VoiceIdKazuha = "Kazuha"

	// VoiceIdTomoko is a VoiceId enum value
	VoiceIdTomoko = "Tomoko"

	// VoiceIdNiamh is a VoiceId enum value
	VoiceIdNiamh = "Niamh"

	// VoiceIdSofie is a VoiceId enum value
	VoiceIdSofie = "Sofie"

	// VoiceIdLisa is a VoiceId enum value
	VoiceIdLisa = "Lisa"

	// VoiceIdIsabelle is a VoiceId enum value
	VoiceIdIsabelle = "Isabelle"

	// VoiceIdZayd is a VoiceId enum value
	VoiceIdZayd = "Zayd"

	// VoiceIdDanielle is a VoiceId enum value
	VoiceIdDanielle = "Danielle"

	// VoiceIdGregory is a VoiceId enum value
	VoiceIdGregory = "Gregory"

	// VoiceIdBurcu is a VoiceId enum value
	VoiceIdBurcu = "Burcu"
)
View Source 
const (

	// ErrCodeEngineNotSupportedException for service response error code
	// "EngineNotSupportedException".
	//
	// This engine is not compatible with the voice that you have designated. Choose
	// a new voice that is compatible with the engine or change the engine and restart
	// the operation.
	ErrCodeEngineNotSupportedException = "EngineNotSupportedException"

	// ErrCodeInvalidLexiconException for service response error code
	// "InvalidLexiconException".
	//
	// Amazon Polly can't find the specified lexicon. Verify that the lexicon's
	// name is spelled correctly, and then try again.
	ErrCodeInvalidLexiconException = "InvalidLexiconException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The NextToken is invalid. Verify that it's spelled correctly, and then try
	// again.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidS3BucketException for service response error code
	// "InvalidS3BucketException".
	//
	// The provided Amazon S3 bucket name is invalid. Please check your input with
	// S3 bucket naming requirements and try again.
	ErrCodeInvalidS3BucketException = "InvalidS3BucketException"

	// ErrCodeInvalidS3KeyException for service response error code
	// "InvalidS3KeyException".
	//
	// The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object
	// key name.
	ErrCodeInvalidS3KeyException = "InvalidS3KeyException"

	// ErrCodeInvalidSampleRateException for service response error code
	// "InvalidSampleRateException".
	//
	// The specified sample rate is not valid.
	ErrCodeInvalidSampleRateException = "InvalidSampleRateException"

	// ErrCodeInvalidSnsTopicArnException for service response error code
	// "InvalidSnsTopicArnException".
	//
	// The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN
	// and try again.
	ErrCodeInvalidSnsTopicArnException = "InvalidSnsTopicArnException"

	// ErrCodeInvalidSsmlException for service response error code
	// "InvalidSsmlException".
	//
	// The SSML you provided is invalid. Verify the SSML syntax, spelling of tags
	// and values, and then try again.
	ErrCodeInvalidSsmlException = "InvalidSsmlException"

	// ErrCodeInvalidTaskIdException for service response error code
	// "InvalidTaskIdException".
	//
	// The provided Task ID is not valid. Please provide a valid Task ID and try
	// again.
	ErrCodeInvalidTaskIdException = "InvalidTaskIdException"

	// ErrCodeLanguageNotSupportedException for service response error code
	// "LanguageNotSupportedException".
	//
	// The language specified is not currently supported by Amazon Polly in this
	// capacity.
	ErrCodeLanguageNotSupportedException = "LanguageNotSupportedException"

	// ErrCodeLexiconNotFoundException for service response error code
	// "LexiconNotFoundException".
	//
	// Amazon Polly can't find the specified lexicon. This could be caused by a
	// lexicon that is missing, its name is misspelled or specifying a lexicon that
	// is in a different region.
	//
	// Verify that the lexicon exists, is in the region (see ListLexicons) and that
	// you spelled its name is spelled correctly. Then try again.
	ErrCodeLexiconNotFoundException = "LexiconNotFoundException"

	// ErrCodeLexiconSizeExceededException for service response error code
	// "LexiconSizeExceededException".
	//
	// The maximum size of the specified lexicon would be exceeded by this operation.
	ErrCodeLexiconSizeExceededException = "LexiconSizeExceededException"

	// ErrCodeMarksNotSupportedForFormatException for service response error code
	// "MarksNotSupportedForFormatException".
	//
	// Speech marks are not supported for the OutputFormat selected. Speech marks
	// are only available for content in json format.
	ErrCodeMarksNotSupportedForFormatException = "MarksNotSupportedForFormatException"

	// ErrCodeMaxLexemeLengthExceededException for service response error code
	// "MaxLexemeLengthExceededException".
	//
	// The maximum size of the lexeme would be exceeded by this operation.
	ErrCodeMaxLexemeLengthExceededException = "MaxLexemeLengthExceededException"

	// ErrCodeMaxLexiconsNumberExceededException for service response error code
	// "MaxLexiconsNumberExceededException".
	//
	// The maximum number of lexicons would be exceeded by this operation.
	ErrCodeMaxLexiconsNumberExceededException = "MaxLexiconsNumberExceededException"

	// ErrCodeServiceFailureException for service response error code
	// "ServiceFailureException".
	//
	// An unknown condition has caused a service failure.
	ErrCodeServiceFailureException = "ServiceFailureException"

	// ErrCodeSsmlMarksNotSupportedForTextTypeException for service response error code
	// "SsmlMarksNotSupportedForTextTypeException".
	//
	// SSML speech marks are not supported for plain text-type input.
	ErrCodeSsmlMarksNotSupportedForTextTypeException = "SsmlMarksNotSupportedForTextTypeException"

	// ErrCodeSynthesisTaskNotFoundException for service response error code
	// "SynthesisTaskNotFoundException".
	//
	// The Speech Synthesis task with requested Task ID cannot be found.
	ErrCodeSynthesisTaskNotFoundException = "SynthesisTaskNotFoundException"

	// ErrCodeTextLengthExceededException for service response error code
	// "TextLengthExceededException".
	//
	// The value of the "Text" parameter is longer than the accepted limits. For
	// the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters
	// total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask
	// API, the maximum is 200,000 characters, of which no more than 100,000 can
	// be billed characters. SSML tags are not counted as billed characters.
	ErrCodeTextLengthExceededException = "TextLengthExceededException"

	// ErrCodeUnsupportedPlsAlphabetException for service response error code
	// "UnsupportedPlsAlphabetException".
	//
	// The alphabet specified by the lexicon is not a supported alphabet. Valid
	// values are x-sampa and ipa.
	ErrCodeUnsupportedPlsAlphabetException = "UnsupportedPlsAlphabetException"

	// ErrCodeUnsupportedPlsLanguageException for service response error code
	// "UnsupportedPlsLanguageException".
	//
	// The language specified in the lexicon is unsupported. For a list of supported
	// languages, see Lexicon Attributes (https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html).
	ErrCodeUnsupportedPlsLanguageException = "UnsupportedPlsLanguageException"
)
View Source 
const (
	ServiceName = "polly"     // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Polly"     // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func Engine_Values 

func Engine_Values() []string

Engine_Values returns all elements of the Engine enum

func Gender_Values 

func Gender_Values() []string

Gender_Values returns all elements of the Gender enum

func LanguageCode_Values 

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func OutputFormat_Values 

func OutputFormat_Values() []string

OutputFormat_Values returns all elements of the OutputFormat enum

func SpeechMarkType_Values 

func SpeechMarkType_Values() []string

SpeechMarkType_Values returns all elements of the SpeechMarkType enum

func TaskStatus_Values 

func TaskStatus_Values() []string

TaskStatus_Values returns all elements of the TaskStatus enum

func TextType_Values 

func TextType_Values() []string

TextType_Values returns all elements of the TextType enum

func VoiceId_Values 

func VoiceId_Values() []string

VoiceId_Values returns all elements of the VoiceId enum

Types

type DeleteLexiconInput 

type DeleteLexiconInput struct {

	// The name of the lexicon to delete. Must be an existing lexicon in the region.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"LexiconName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLexiconInput) GoString 

func (s DeleteLexiconInput) 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 (*DeleteLexiconInput) SetName 

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

SetName sets the Name field's value.

func (DeleteLexiconInput) String 

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

func (s *DeleteLexiconInput) Validate() error

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

type DeleteLexiconOutput 

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

func (DeleteLexiconOutput) GoString 

func (s DeleteLexiconOutput) 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 (DeleteLexiconOutput) String 

func (s DeleteLexiconOutput) 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 DescribeVoicesInput 

type DescribeVoicesInput struct {

	// Specifies the engine (standard, neural, long-form or generative) used by
	// Amazon Polly when processing input text for speech synthesis.
	Engine *string `location:"querystring" locationName:"Engine" type:"string" enum:"Engine"`

	// Boolean value indicating whether to return any bilingual voices that use
	// the specified language as an additional language. For instance, if you request
	// all languages that use US English (es-US), and there is an Italian voice
	// that speaks both Italian (it-IT) and US English, that voice will be included
	// if you specify yes but not if you specify no.
	IncludeAdditionalLanguageCodes *bool `location:"querystring" locationName:"IncludeAdditionalLanguageCodes" type:"boolean"`

	// The language identification tag (ISO 639 code for the language name-ISO 3166
	// country code) for filtering the list of voices returned. If you don't specify
	// this optional parameter, all available voices are returned.
	LanguageCode *string `location:"querystring" locationName:"LanguageCode" type:"string" enum:"LanguageCode"`

	// An opaque pagination token returned from the previous DescribeVoices operation.
	// If present, this indicates where to continue the listing.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeVoicesInput) GoString 

func (s DescribeVoicesInput) 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 (*DescribeVoicesInput) SetEngine 

func (s *DescribeVoicesInput) SetEngine(v string) *DescribeVoicesInput

SetEngine sets the Engine field's value.

func (*DescribeVoicesInput) SetIncludeAdditionalLanguageCodes 

func (s *DescribeVoicesInput) SetIncludeAdditionalLanguageCodes(v bool) *DescribeVoicesInput

SetIncludeAdditionalLanguageCodes sets the IncludeAdditionalLanguageCodes field's value.

func (*DescribeVoicesInput) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*DescribeVoicesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (DescribeVoicesInput) String 

func (s DescribeVoicesInput) 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 DescribeVoicesOutput 

type DescribeVoicesOutput struct {

	// The pagination token to use in the next request to continue the listing of
	// voices. NextToken is returned only if the response is truncated.
	NextToken *string `type:"string"`

	// A list of voices with their properties.
	Voices []*Voice `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeVoicesOutput) GoString 

func (s DescribeVoicesOutput) 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 (*DescribeVoicesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeVoicesOutput) SetVoices 

func (s *DescribeVoicesOutput) SetVoices(v []*Voice) *DescribeVoicesOutput

SetVoices sets the Voices field's value.

func (DescribeVoicesOutput) String 

func (s DescribeVoicesOutput) 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 EngineNotSupportedException 

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

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

This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.

func (*EngineNotSupportedException) Code 

func (s *EngineNotSupportedException) Code() string

Code returns the exception type name.

func (*EngineNotSupportedException) Error 

func (s *EngineNotSupportedException) Error() string

func (EngineNotSupportedException) GoString 

func (s EngineNotSupportedException) 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 (*EngineNotSupportedException) Message 

func (s *EngineNotSupportedException) Message() string

Message returns the exception's message.

func (*EngineNotSupportedException) OrigErr 

func (s *EngineNotSupportedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EngineNotSupportedException) RequestID 

func (s *EngineNotSupportedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EngineNotSupportedException) StatusCode 

func (s *EngineNotSupportedException) StatusCode() int

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

func (EngineNotSupportedException) String 

func (s EngineNotSupportedException) 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 GetLexiconInput 

type GetLexiconInput struct {

	// Name of the lexicon.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"LexiconName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLexiconInput) GoString 

func (s GetLexiconInput) 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 (*GetLexiconInput) SetName 

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

SetName sets the Name field's value.

func (GetLexiconInput) String 

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

func (s *GetLexiconInput) Validate() error

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

type GetLexiconOutput 

type GetLexiconOutput struct {

	// Lexicon object that provides name and the string content of the lexicon.
	Lexicon *Lexicon `type:"structure"`

	// Metadata of the lexicon, including phonetic alphabetic used, language code,
	// lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon
	// in bytes.
	LexiconAttributes *LexiconAttributes `type:"structure"`
	// contains filtered or unexported fields
}

func (GetLexiconOutput) GoString 

func (s GetLexiconOutput) 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 (*GetLexiconOutput) SetLexicon 

func (s *GetLexiconOutput) SetLexicon(v *Lexicon) *GetLexiconOutput

SetLexicon sets the Lexicon field's value.

func (*GetLexiconOutput) SetLexiconAttributes 

func (s *GetLexiconOutput) SetLexiconAttributes(v *LexiconAttributes) *GetLexiconOutput

SetLexiconAttributes sets the LexiconAttributes field's value.

func (GetLexiconOutput) String 

func (s GetLexiconOutput) 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 GetSpeechSynthesisTaskInput 

type GetSpeechSynthesisTaskInput struct {

	// The Amazon Polly generated identifier for a speech synthesis task.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"TaskId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSpeechSynthesisTaskInput) GoString 

func (s GetSpeechSynthesisTaskInput) 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 (*GetSpeechSynthesisTaskInput) SetTaskId 

func (s *GetSpeechSynthesisTaskInput) SetTaskId(v string) *GetSpeechSynthesisTaskInput

SetTaskId sets the TaskId field's value.

func (GetSpeechSynthesisTaskInput) String 

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

func (s *GetSpeechSynthesisTaskInput) Validate() error

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

type GetSpeechSynthesisTaskOutput 

type GetSpeechSynthesisTaskOutput struct {

	// SynthesisTask object that provides information from the requested task, including
	// output format, creation time, task status, and so on.
	SynthesisTask *SynthesisTask `type:"structure"`
	// contains filtered or unexported fields
}

func (GetSpeechSynthesisTaskOutput) GoString 

func (s GetSpeechSynthesisTaskOutput) 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 (*GetSpeechSynthesisTaskOutput) SetSynthesisTask 

func (s *GetSpeechSynthesisTaskOutput) SetSynthesisTask(v *SynthesisTask) *GetSpeechSynthesisTaskOutput

SetSynthesisTask sets the SynthesisTask field's value.

func (GetSpeechSynthesisTaskOutput) String 

func (s GetSpeechSynthesisTaskOutput) 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 InvalidLexiconException 

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

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

Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.

func (*InvalidLexiconException) Code 

func (s *InvalidLexiconException) Code() string

Code returns the exception type name.

func (*InvalidLexiconException) Error 

func (s *InvalidLexiconException) Error() string

func (InvalidLexiconException) GoString 

func (s InvalidLexiconException) 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 (*InvalidLexiconException) Message 

func (s *InvalidLexiconException) Message() string

Message returns the exception's message.

func (*InvalidLexiconException) OrigErr 

func (s *InvalidLexiconException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidLexiconException) RequestID 

func (s *InvalidLexiconException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidLexiconException) StatusCode 

func (s *InvalidLexiconException) StatusCode() int

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

func (InvalidLexiconException) String 

func (s InvalidLexiconException) 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 InvalidNextTokenException 

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

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

The NextToken is invalid. Verify that it's spelled correctly, and then try again.

func (*InvalidNextTokenException) Code 

func (s *InvalidNextTokenException) Code() string

Code returns the exception type name.

func (*InvalidNextTokenException) Error 

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString 

func (s InvalidNextTokenException) 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 (*InvalidNextTokenException) Message 

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr 

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID 

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode 

func (s *InvalidNextTokenException) StatusCode() int

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

func (InvalidNextTokenException) String 

func (s InvalidNextTokenException) 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 InvalidS3BucketException 

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

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

The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.

func (*InvalidS3BucketException) Code 

func (s *InvalidS3BucketException) Code() string

Code returns the exception type name.

func (*InvalidS3BucketException) Error 

func (s *InvalidS3BucketException) Error() string

func (InvalidS3BucketException) GoString 

func (s InvalidS3BucketException) 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 (*InvalidS3BucketException) Message 

func (s *InvalidS3BucketException) Message() string

Message returns the exception's message.

func (*InvalidS3BucketException) OrigErr 

func (s *InvalidS3BucketException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidS3BucketException) RequestID 

func (s *InvalidS3BucketException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidS3BucketException) StatusCode 

func (s *InvalidS3BucketException) StatusCode() int

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

func (InvalidS3BucketException) String 

func (s InvalidS3BucketException) 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 InvalidS3KeyException 

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

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

The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.

func (*InvalidS3KeyException) Code 

func (s *InvalidS3KeyException) Code() string

Code returns the exception type name.

func (*InvalidS3KeyException) Error 

func (s *InvalidS3KeyException) Error() string

func (InvalidS3KeyException) GoString 

func (s InvalidS3KeyException) 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 (*InvalidS3KeyException) Message 

func (s *InvalidS3KeyException) Message() string

Message returns the exception's message.

func (*InvalidS3KeyException) OrigErr 

func (s *InvalidS3KeyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidS3KeyException) RequestID 

func (s *InvalidS3KeyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidS3KeyException) StatusCode 

func (s *InvalidS3KeyException) StatusCode() int

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

func (InvalidS3KeyException) String 

func (s InvalidS3KeyException) 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 InvalidSampleRateException 

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

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

The specified sample rate is not valid.

func (*InvalidSampleRateException) Code 

func (s *InvalidSampleRateException) Code() string

Code returns the exception type name.

func (*InvalidSampleRateException) Error 

func (s *InvalidSampleRateException) Error() string

func (InvalidSampleRateException) GoString 

func (s InvalidSampleRateException) 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 (*InvalidSampleRateException) Message 

func (s *InvalidSampleRateException) Message() string

Message returns the exception's message.

func (*InvalidSampleRateException) OrigErr 

func (s *InvalidSampleRateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidSampleRateException) RequestID 

func (s *InvalidSampleRateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidSampleRateException) StatusCode 

func (s *InvalidSampleRateException) StatusCode() int

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

func (InvalidSampleRateException) String 

func (s InvalidSampleRateException) 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 InvalidSnsTopicArnException 

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

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

The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.

func (*InvalidSnsTopicArnException) Code 

func (s *InvalidSnsTopicArnException) Code() string

Code returns the exception type name.

func (*InvalidSnsTopicArnException) Error 

func (s *InvalidSnsTopicArnException) Error() string

func (InvalidSnsTopicArnException) GoString 

func (s InvalidSnsTopicArnException) 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 (*InvalidSnsTopicArnException) Message 

func (s *InvalidSnsTopicArnException) Message() string

Message returns the exception's message.

func (*InvalidSnsTopicArnException) OrigErr 

func (s *InvalidSnsTopicArnException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidSnsTopicArnException) RequestID 

func (s *InvalidSnsTopicArnException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidSnsTopicArnException) StatusCode 

func (s *InvalidSnsTopicArnException) StatusCode() int

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

func (InvalidSnsTopicArnException) String 

func (s InvalidSnsTopicArnException) 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 InvalidSsmlException 

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

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

The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.

func (*InvalidSsmlException) Code 

func (s *InvalidSsmlException) Code() string

Code returns the exception type name.

func (*InvalidSsmlException) Error 

func (s *InvalidSsmlException) Error() string

func (InvalidSsmlException) GoString 

func (s InvalidSsmlException) 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 (*InvalidSsmlException) Message 

func (s *InvalidSsmlException) Message() string

Message returns the exception's message.

func (*InvalidSsmlException) OrigErr 

func (s *InvalidSsmlException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidSsmlException) RequestID 

func (s *InvalidSsmlException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidSsmlException) StatusCode 

func (s *InvalidSsmlException) StatusCode() int

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

func (InvalidSsmlException) String 

func (s InvalidSsmlException) 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 InvalidTaskIdException 

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

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

The provided Task ID is not valid. Please provide a valid Task ID and try again.

func (*InvalidTaskIdException) Code 

func (s *InvalidTaskIdException) Code() string

Code returns the exception type name.

func (*InvalidTaskIdException) Error 

func (s *InvalidTaskIdException) Error() string

func (InvalidTaskIdException) GoString 

func (s InvalidTaskIdException) 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 (*InvalidTaskIdException) Message 

func (s *InvalidTaskIdException) Message() string

Message returns the exception's message.

func (*InvalidTaskIdException) OrigErr 

func (s *InvalidTaskIdException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTaskIdException) RequestID 

func (s *InvalidTaskIdException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTaskIdException) StatusCode 

func (s *InvalidTaskIdException) StatusCode() int

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

func (InvalidTaskIdException) String 

func (s InvalidTaskIdException) 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 LanguageNotSupportedException 

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

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

The language specified is not currently supported by Amazon Polly in this capacity.

func (*LanguageNotSupportedException) Code 

func (s *LanguageNotSupportedException) Code() string

Code returns the exception type name.

func (*LanguageNotSupportedException) Error 

func (s *LanguageNotSupportedException) Error() string

func (LanguageNotSupportedException) GoString 

func (s LanguageNotSupportedException) 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 (*LanguageNotSupportedException) Message 

func (s *LanguageNotSupportedException) Message() string

Message returns the exception's message.

func (*LanguageNotSupportedException) OrigErr 

func (s *LanguageNotSupportedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LanguageNotSupportedException) RequestID 

func (s *LanguageNotSupportedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LanguageNotSupportedException) StatusCode 

func (s *LanguageNotSupportedException) StatusCode() int

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

func (LanguageNotSupportedException) String 

func (s LanguageNotSupportedException) 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 Lexicon 

type Lexicon struct {

	// Lexicon content in string format. The content of a lexicon must be in PLS
	// format.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Lexicon's
	// String and GoString methods.
	Content *string `type:"string" sensitive:"true"`

	// Name of the lexicon.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0 (https://www.w3.org/TR/pronunciation-lexicon/).

func (Lexicon) GoString 

func (s Lexicon) 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 (*Lexicon) SetContent 

func (s *Lexicon) SetContent(v string) *Lexicon

SetContent sets the Content field's value.

func (*Lexicon) SetName 

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

SetName sets the Name field's value.

func (Lexicon) String 

func (s Lexicon) 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 LexiconAttributes 

type LexiconAttributes struct {

	// Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.
	Alphabet *string `type:"string"`

	// Language code that the lexicon applies to. A lexicon with a language code
	// such as "en" would be applied to all English languages (en-GB, en-US, en-AUS,
	// en-WLS, and so on.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// Date lexicon was last modified (a timestamp value).
	LastModified *time.Time `type:"timestamp"`

	// Number of lexemes in the lexicon.
	LexemesCount *int64 `type:"integer"`

	// Amazon Resource Name (ARN) of the lexicon.
	LexiconArn *string `type:"string"`

	// Total size of the lexicon, in characters.
	Size *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).

func (LexiconAttributes) GoString 

func (s LexiconAttributes) 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 (*LexiconAttributes) SetAlphabet 

func (s *LexiconAttributes) SetAlphabet(v string) *LexiconAttributes

SetAlphabet sets the Alphabet field's value.

func (*LexiconAttributes) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*LexiconAttributes) SetLastModified 

func (s *LexiconAttributes) SetLastModified(v time.Time) *LexiconAttributes

SetLastModified sets the LastModified field's value.

func (*LexiconAttributes) SetLexemesCount 

func (s *LexiconAttributes) SetLexemesCount(v int64) *LexiconAttributes

SetLexemesCount sets the LexemesCount field's value.

func (*LexiconAttributes) SetLexiconArn 

func (s *LexiconAttributes) SetLexiconArn(v string) *LexiconAttributes

SetLexiconArn sets the LexiconArn field's value.

func (*LexiconAttributes) SetSize 

func (s *LexiconAttributes) SetSize(v int64) *LexiconAttributes

SetSize sets the Size field's value.

func (LexiconAttributes) String 

func (s LexiconAttributes) 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 LexiconDescription 

type LexiconDescription struct {

	// Provides lexicon metadata.
	Attributes *LexiconAttributes `type:"structure"`

	// Name of the lexicon.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the content of the lexicon.

func (LexiconDescription) GoString 

func (s LexiconDescription) 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 (*LexiconDescription) SetAttributes 

func (s *LexiconDescription) SetAttributes(v *LexiconAttributes) *LexiconDescription

SetAttributes sets the Attributes field's value.

func (*LexiconDescription) SetName 

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

SetName sets the Name field's value.

func (LexiconDescription) String 

func (s LexiconDescription) 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 LexiconNotFoundException 

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

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

Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.

Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.

func (*LexiconNotFoundException) Code 

func (s *LexiconNotFoundException) Code() string

Code returns the exception type name.

func (*LexiconNotFoundException) Error 

func (s *LexiconNotFoundException) Error() string

func (LexiconNotFoundException) GoString 

func (s LexiconNotFoundException) 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 (*LexiconNotFoundException) Message 

func (s *LexiconNotFoundException) Message() string

Message returns the exception's message.

func (*LexiconNotFoundException) OrigErr 

func (s *LexiconNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LexiconNotFoundException) RequestID 

func (s *LexiconNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LexiconNotFoundException) StatusCode 

func (s *LexiconNotFoundException) StatusCode() int

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

func (LexiconNotFoundException) String 

func (s LexiconNotFoundException) 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 LexiconSizeExceededException 

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

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

The maximum size of the specified lexicon would be exceeded by this operation.

func (*LexiconSizeExceededException) Code 

func (s *LexiconSizeExceededException) Code() string

Code returns the exception type name.

func (*LexiconSizeExceededException) Error 

func (s *LexiconSizeExceededException) Error() string

func (LexiconSizeExceededException) GoString 

func (s LexiconSizeExceededException) 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 (*LexiconSizeExceededException) Message 

func (s *LexiconSizeExceededException) Message() string

Message returns the exception's message.

func (*LexiconSizeExceededException) OrigErr 

func (s *LexiconSizeExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LexiconSizeExceededException) RequestID 

func (s *LexiconSizeExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LexiconSizeExceededException) StatusCode 

func (s *LexiconSizeExceededException) StatusCode() int

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

func (LexiconSizeExceededException) String 

func (s LexiconSizeExceededException) 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 ListLexiconsInput 

type ListLexiconsInput struct {

	// An opaque pagination token returned from previous ListLexicons operation.
	// If present, indicates where to continue the list of lexicons.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListLexiconsInput) GoString 

func (s ListLexiconsInput) 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 (*ListLexiconsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListLexiconsInput) String 

func (s ListLexiconsInput) 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 ListLexiconsOutput 

type ListLexiconsOutput struct {

	// A list of lexicon names and attributes.
	Lexicons []*LexiconDescription `type:"list"`

	// The pagination token to use in the next request to continue the listing of
	// lexicons. NextToken is returned only if the response is truncated.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLexiconsOutput) GoString 

func (s ListLexiconsOutput) 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 (*ListLexiconsOutput) SetLexicons 

func (s *ListLexiconsOutput) SetLexicons(v []*LexiconDescription) *ListLexiconsOutput

SetLexicons sets the Lexicons field's value.

func (*ListLexiconsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListLexiconsOutput) String 

func (s ListLexiconsOutput) 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 ListSpeechSynthesisTasksInput 

type ListSpeechSynthesisTasksInput struct {

	// Maximum number of speech synthesis tasks returned in a List operation.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The pagination token to use in the next request to continue the listing of
	// speech synthesis tasks.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// Status of the speech synthesis tasks returned in a List operation
	Status *string `location:"querystring" locationName:"Status" type:"string" enum:"TaskStatus"`
	// contains filtered or unexported fields
}

func (ListSpeechSynthesisTasksInput) GoString 

func (s ListSpeechSynthesisTasksInput) 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 (*ListSpeechSynthesisTasksInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListSpeechSynthesisTasksInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSpeechSynthesisTasksInput) SetStatus 

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

SetStatus sets the Status field's value.

func (ListSpeechSynthesisTasksInput) String 

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

func (s *ListSpeechSynthesisTasksInput) Validate() error

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

type ListSpeechSynthesisTasksOutput 

type ListSpeechSynthesisTasksOutput struct {

	// An opaque pagination token returned from the previous List operation in this
	// request. If present, this indicates where to continue the listing.
	NextToken *string `type:"string"`

	// List of SynthesisTask objects that provides information from the specified
	// task in the list request, including output format, creation time, task status,
	// and so on.
	SynthesisTasks []*SynthesisTask `type:"list"`
	// contains filtered or unexported fields
}

func (ListSpeechSynthesisTasksOutput) GoString 

func (s ListSpeechSynthesisTasksOutput) 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 (*ListSpeechSynthesisTasksOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSpeechSynthesisTasksOutput) SetSynthesisTasks 

func (s *ListSpeechSynthesisTasksOutput) SetSynthesisTasks(v []*SynthesisTask) *ListSpeechSynthesisTasksOutput

SetSynthesisTasks sets the SynthesisTasks field's value.

func (ListSpeechSynthesisTasksOutput) String 

func (s ListSpeechSynthesisTasksOutput) 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 MarksNotSupportedForFormatException 

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

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

Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.

func (*MarksNotSupportedForFormatException) Code 

func (s *MarksNotSupportedForFormatException) Code() string

Code returns the exception type name.

func (*MarksNotSupportedForFormatException) Error 

func (s *MarksNotSupportedForFormatException) Error() string

func (MarksNotSupportedForFormatException) GoString 

func (s MarksNotSupportedForFormatException) 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 (*MarksNotSupportedForFormatException) Message 

func (s *MarksNotSupportedForFormatException) Message() string

Message returns the exception's message.

func (*MarksNotSupportedForFormatException) OrigErr 

func (s *MarksNotSupportedForFormatException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MarksNotSupportedForFormatException) RequestID 

func (s *MarksNotSupportedForFormatException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MarksNotSupportedForFormatException) StatusCode 

func (s *MarksNotSupportedForFormatException) StatusCode() int

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

func (MarksNotSupportedForFormatException) String 

func (s MarksNotSupportedForFormatException) 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 MaxLexemeLengthExceededException 

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

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

The maximum size of the lexeme would be exceeded by this operation.

func (*MaxLexemeLengthExceededException) Code 

func (s *MaxLexemeLengthExceededException) Code() string

Code returns the exception type name.

func (*MaxLexemeLengthExceededException) Error 

func (s *MaxLexemeLengthExceededException) Error() string

func (MaxLexemeLengthExceededException) GoString 

func (s MaxLexemeLengthExceededException) 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 (*MaxLexemeLengthExceededException) Message 

func (s *MaxLexemeLengthExceededException) Message() string

Message returns the exception's message.

func (*MaxLexemeLengthExceededException) OrigErr 

func (s *MaxLexemeLengthExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MaxLexemeLengthExceededException) RequestID 

func (s *MaxLexemeLengthExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MaxLexemeLengthExceededException) StatusCode 

func (s *MaxLexemeLengthExceededException) StatusCode() int

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

func (MaxLexemeLengthExceededException) String 

func (s MaxLexemeLengthExceededException) 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 MaxLexiconsNumberExceededException 

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

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

The maximum number of lexicons would be exceeded by this operation.

func (*MaxLexiconsNumberExceededException) Code 

func (s *MaxLexiconsNumberExceededException) Code() string

Code returns the exception type name.

func (*MaxLexiconsNumberExceededException) Error 

func (s *MaxLexiconsNumberExceededException) Error() string

func (MaxLexiconsNumberExceededException) GoString 

func (s MaxLexiconsNumberExceededException) 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 (*MaxLexiconsNumberExceededException) Message 

func (s *MaxLexiconsNumberExceededException) Message() string

Message returns the exception's message.

func (*MaxLexiconsNumberExceededException) OrigErr 

func (s *MaxLexiconsNumberExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MaxLexiconsNumberExceededException) RequestID 

func (s *MaxLexiconsNumberExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MaxLexiconsNumberExceededException) StatusCode 

func (s *MaxLexiconsNumberExceededException) StatusCode() int

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

func (MaxLexiconsNumberExceededException) String 

func (s MaxLexiconsNumberExceededException) 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 Polly 

type Polly struct {
	*client.Client
}

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

Polly 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) *Polly

New creates a new instance of the Polly 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 Polly client from just a session.
svc := polly.New(mySession)

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

func (*Polly) DeleteLexicon 

func (c *Polly) DeleteLexicon(input *DeleteLexiconInput) (*DeleteLexiconOutput, error)

DeleteLexicon API operation for Amazon Polly.

Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's API operation DeleteLexicon for usage and error information.

Returned Error Types:

  • LexiconNotFoundException Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.

    Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.

  • ServiceFailureException An unknown condition has caused a service failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DeleteLexicon

Example (Shared00)

To delete a lexicon Deletes a specified pronunciation lexicon stored in an AWS Region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/polly"
)

func main() {
	svc := polly.New(session.New())
	input := &polly.DeleteLexiconInput{
		Name: aws.String("example"),
	}

	result, err := svc.DeleteLexicon(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case polly.ErrCodeLexiconNotFoundException:
				fmt.Println(polly.ErrCodeLexiconNotFoundException, aerr.Error())
			case polly.ErrCodeServiceFailureException:
				fmt.Println(polly.ErrCodeServiceFailureException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Polly) DeleteLexiconRequest 

func (c *Polly) DeleteLexiconRequest(input *DeleteLexiconInput) (req *request.Request, output *DeleteLexiconOutput)

DeleteLexiconRequest generates a "aws/request.Request" representing the client's request for the DeleteLexicon 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 DeleteLexicon for more information on using the DeleteLexicon 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 DeleteLexiconRequest method.
req, resp := client.DeleteLexiconRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DeleteLexicon

func (*Polly) DeleteLexiconWithContext 

func (c *Polly) DeleteLexiconWithContext(ctx aws.Context, input *DeleteLexiconInput, opts ...request.Option) (*DeleteLexiconOutput, error)

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

See DeleteLexicon 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 (*Polly) DescribeVoices 

func (c *Polly) DescribeVoices(input *DescribeVoicesInput) (*DescribeVoicesOutput, error)

DescribeVoices API operation for Amazon Polly.

Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.

When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices.

For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from.

You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices.

This operation requires permissions to perform the polly:DescribeVoices action.

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 Polly's API operation DescribeVoices for usage and error information.

Returned Error Types:

  • InvalidNextTokenException The NextToken is invalid. Verify that it's spelled correctly, and then try again.

  • ServiceFailureException An unknown condition has caused a service failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DescribeVoices

Example (Shared00)

To describe available voices Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those within the specified language code. If no language code is specified, voices for all available languages are displayed. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/polly"
)

func main() {
	svc := polly.New(session.New())
	input := &polly.DescribeVoicesInput{
		LanguageCode: aws.String("en-GB"),
	}

	result, err := svc.DescribeVoices(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case polly.ErrCodeInvalidNextTokenException:
				fmt.Println(polly.ErrCodeInvalidNextTokenException, aerr.Error())
			case polly.ErrCodeServiceFailureException:
				fmt.Println(polly.ErrCodeServiceFailureException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Polly) DescribeVoicesRequest 

func (c *Polly) DescribeVoicesRequest(input *DescribeVoicesInput) (req *request.Request, output *DescribeVoicesOutput)

DescribeVoicesRequest generates a "aws/request.Request" representing the client's request for the DescribeVoices 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 DescribeVoices for more information on using the DescribeVoices 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 DescribeVoicesRequest method.
req, resp := client.DescribeVoicesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/DescribeVoices

func (*Polly) DescribeVoicesWithContext 

func (c *Polly) DescribeVoicesWithContext(ctx aws.Context, input *DescribeVoicesInput, opts ...request.Option) (*DescribeVoicesOutput, error)

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

See DescribeVoices 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 (*Polly) GetLexicon 

func (c *Polly) GetLexicon(input *GetLexiconInput) (*GetLexiconOutput, error)

GetLexicon API operation for Amazon Polly.

Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's API operation GetLexicon for usage and error information.

Returned Error Types:

  • LexiconNotFoundException Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.

    Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.

  • ServiceFailureException An unknown condition has caused a service failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/GetLexicon

Example (Shared00)

To retrieve a lexicon Returns the content of the specified pronunciation lexicon stored in an AWS Region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/polly"
)

func main() {
	svc := polly.New(session.New())
	input := &polly.GetLexiconInput{
		Name: aws.String(""),
	}

	result, err := svc.GetLexicon(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case polly.ErrCodeLexiconNotFoundException:
				fmt.Println(polly.ErrCodeLexiconNotFoundException, aerr.Error())
			case polly.ErrCodeServiceFailureException:
				fmt.Println(polly.ErrCodeServiceFailureException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Polly) GetLexiconRequest 

func (c *Polly) GetLexiconRequest(input *GetLexiconInput) (req *request.Request, output *GetLexiconOutput)

GetLexiconRequest generates a "aws/request.Request" representing the client's request for the GetLexicon 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 GetLexicon for more information on using the GetLexicon 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 GetLexiconRequest method.
req, resp := client.GetLexiconRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/GetLexicon

func (*Polly) GetLexiconWithContext 

func (c *Polly) GetLexiconWithContext(ctx aws.Context, input *GetLexiconInput, opts ...request.Option) (*GetLexiconOutput, error)

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

See GetLexicon 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 (*Polly) GetSpeechSynthesisTask 

func (c *Polly) GetSpeechSynthesisTask(input *GetSpeechSynthesisTaskInput) (*GetSpeechSynthesisTaskOutput, error)

GetSpeechSynthesisTask API operation for Amazon Polly.

Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.

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 Polly's API operation GetSpeechSynthesisTask for usage and error information.

Returned Error Types:

  • InvalidTaskIdException The provided Task ID is not valid. Please provide a valid Task ID and try again.

  • ServiceFailureException An unknown condition has caused a service failure.

  • SynthesisTaskNotFoundException The Speech Synthesis task with requested Task ID cannot be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/GetSpeechSynthesisTask

func (*Polly) GetSpeechSynthesisTaskRequest 

func (c *Polly) GetSpeechSynthesisTaskRequest(input *GetSpeechSynthesisTaskInput) (req *request.Request, output *GetSpeechSynthesisTaskOutput)

GetSpeechSynthesisTaskRequest generates a "aws/request.Request" representing the client's request for the GetSpeechSynthesisTask 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 GetSpeechSynthesisTask for more information on using the GetSpeechSynthesisTask 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 GetSpeechSynthesisTaskRequest method.
req, resp := client.GetSpeechSynthesisTaskRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/GetSpeechSynthesisTask

func (*Polly) GetSpeechSynthesisTaskWithContext 

func (c *Polly) GetSpeechSynthesisTaskWithContext(ctx aws.Context, input *GetSpeechSynthesisTaskInput, opts ...request.Option) (*GetSpeechSynthesisTaskOutput, error)

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

See GetSpeechSynthesisTask 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 (*Polly) ListLexicons 

func (c *Polly) ListLexicons(input *ListLexiconsInput) (*ListLexiconsOutput, error)

ListLexicons API operation for Amazon Polly.

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's API operation ListLexicons for usage and error information.

Returned Error Types:

  • InvalidNextTokenException The NextToken is invalid. Verify that it's spelled correctly, and then try again.

  • ServiceFailureException An unknown condition has caused a service failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/ListLexicons

Example (Shared00)

To list all lexicons in a region Returns a list of pronunciation lexicons stored in an AWS Region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/polly"
)

func main() {
	svc := polly.New(session.New())
	input := &polly.ListLexiconsInput{}

	result, err := svc.ListLexicons(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case polly.ErrCodeInvalidNextTokenException:
				fmt.Println(polly.ErrCodeInvalidNextTokenException, aerr.Error())
			case polly.ErrCodeServiceFailureException:
				fmt.Println(polly.ErrCodeServiceFailureException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Polly) ListLexiconsRequest 

func (c *Polly) ListLexiconsRequest(input *ListLexiconsInput) (req *request.Request, output *ListLexiconsOutput)

ListLexiconsRequest generates a "aws/request.Request" representing the client's request for the ListLexicons 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 ListLexicons for more information on using the ListLexicons 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 ListLexiconsRequest method.
req, resp := client.ListLexiconsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/ListLexicons

func (*Polly) ListLexiconsWithContext 

func (c *Polly) ListLexiconsWithContext(ctx aws.Context, input *ListLexiconsInput, opts ...request.Option) (*ListLexiconsOutput, error)

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

See ListLexicons 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 (*Polly) ListSpeechSynthesisTasks 

func (c *Polly) ListSpeechSynthesisTasks(input *ListSpeechSynthesisTasksInput) (*ListSpeechSynthesisTasksOutput, error)

ListSpeechSynthesisTasks API operation for Amazon Polly.

Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

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 Polly's API operation ListSpeechSynthesisTasks for usage and error information.

Returned Error Types:

  • InvalidNextTokenException The NextToken is invalid. Verify that it's spelled correctly, and then try again.

  • ServiceFailureException An unknown condition has caused a service failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/ListSpeechSynthesisTasks

func (*Polly) ListSpeechSynthesisTasksPages 

func (c *Polly) ListSpeechSynthesisTasksPages(input *ListSpeechSynthesisTasksInput, fn func(*ListSpeechSynthesisTasksOutput, bool) bool) error

ListSpeechSynthesisTasksPages iterates over the pages of a ListSpeechSynthesisTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSpeechSynthesisTasks 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 ListSpeechSynthesisTasks operation.
pageNum := 0
err := client.ListSpeechSynthesisTasksPages(params,
    func(page *polly.ListSpeechSynthesisTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Polly) ListSpeechSynthesisTasksPagesWithContext 

func (c *Polly) ListSpeechSynthesisTasksPagesWithContext(ctx aws.Context, input *ListSpeechSynthesisTasksInput, fn func(*ListSpeechSynthesisTasksOutput, bool) bool, opts ...request.Option) error

ListSpeechSynthesisTasksPagesWithContext same as ListSpeechSynthesisTasksPages 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 (*Polly) ListSpeechSynthesisTasksRequest 

func (c *Polly) ListSpeechSynthesisTasksRequest(input *ListSpeechSynthesisTasksInput) (req *request.Request, output *ListSpeechSynthesisTasksOutput)

ListSpeechSynthesisTasksRequest generates a "aws/request.Request" representing the client's request for the ListSpeechSynthesisTasks 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 ListSpeechSynthesisTasks for more information on using the ListSpeechSynthesisTasks 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 ListSpeechSynthesisTasksRequest method.
req, resp := client.ListSpeechSynthesisTasksRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/ListSpeechSynthesisTasks

func (*Polly) ListSpeechSynthesisTasksWithContext 

func (c *Polly) ListSpeechSynthesisTasksWithContext(ctx aws.Context, input *ListSpeechSynthesisTasksInput, opts ...request.Option) (*ListSpeechSynthesisTasksOutput, error)

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

See ListSpeechSynthesisTasks 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 (*Polly) PutLexicon 

func (c *Polly) PutLexicon(input *PutLexiconInput) (*PutLexiconOutput, error)

PutLexicon API operation for Amazon Polly.

Stores a pronunciation lexicon in an Amazon Web Services Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

For more information, see Managing Lexicons (https://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.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 Polly's API operation PutLexicon for usage and error information.

Returned Error Types:

  • InvalidLexiconException Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.

  • UnsupportedPlsAlphabetException The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa and ipa.

  • UnsupportedPlsLanguageException The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes (https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html).

  • LexiconSizeExceededException The maximum size of the specified lexicon would be exceeded by this operation.

  • MaxLexemeLengthExceededException The maximum size of the lexeme would be exceeded by this operation.

  • MaxLexiconsNumberExceededException The maximum number of lexicons would be exceeded by this operation.

  • ServiceFailureException An unknown condition has caused a service failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/PutLexicon

Example (Shared00)

To save a lexicon Stores a pronunciation lexicon in an AWS Region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/polly"
)

func main() {
	svc := polly.New(session.New())
	input := &polly.PutLexiconInput{
		Content: aws.String("file://example.pls"),
		Name:    aws.String("W3C"),
	}

	result, err := svc.PutLexicon(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case polly.ErrCodeInvalidLexiconException:
				fmt.Println(polly.ErrCodeInvalidLexiconException, aerr.Error())
			case polly.ErrCodeUnsupportedPlsAlphabetException:
				fmt.Println(polly.ErrCodeUnsupportedPlsAlphabetException, aerr.Error())
			case polly.ErrCodeUnsupportedPlsLanguageException:
				fmt.Println(polly.ErrCodeUnsupportedPlsLanguageException, aerr.Error())
			case polly.ErrCodeLexiconSizeExceededException:
				fmt.Println(polly.ErrCodeLexiconSizeExceededException, aerr.Error())
			case polly.ErrCodeMaxLexemeLengthExceededException:
				fmt.Println(polly.ErrCodeMaxLexemeLengthExceededException, aerr.Error())
			case polly.ErrCodeMaxLexiconsNumberExceededException:
				fmt.Println(polly.ErrCodeMaxLexiconsNumberExceededException, aerr.Error())
			case polly.ErrCodeServiceFailureException:
				fmt.Println(polly.ErrCodeServiceFailureException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Polly) PutLexiconRequest 

func (c *Polly) PutLexiconRequest(input *PutLexiconInput) (req *request.Request, output *PutLexiconOutput)

PutLexiconRequest generates a "aws/request.Request" representing the client's request for the PutLexicon 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 PutLexicon for more information on using the PutLexicon 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 PutLexiconRequest method.
req, resp := client.PutLexiconRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/PutLexicon

func (*Polly) PutLexiconWithContext 

func (c *Polly) PutLexiconWithContext(ctx aws.Context, input *PutLexiconInput, opts ...request.Option) (*PutLexiconOutput, error)

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

See PutLexicon 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 (*Polly) StartSpeechSynthesisTask 

func (c *Polly) StartSpeechSynthesisTask(input *StartSpeechSynthesisTaskInput) (*StartSpeechSynthesisTaskOutput, error)

StartSpeechSynthesisTask API operation for Amazon Polly.

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status. The SpeechSynthesisTask object is available for 72 hours after starting the asynchronous synthesis task.

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 Polly's API operation StartSpeechSynthesisTask for usage and error information.

Returned Error Types:

  • TextLengthExceededException The value of the "Text" parameter is longer than the accepted limits. For the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.

  • InvalidS3BucketException The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.

  • InvalidS3KeyException The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.

  • InvalidSampleRateException The specified sample rate is not valid.

  • InvalidSnsTopicArnException The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.

  • InvalidSsmlException The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.

  • EngineNotSupportedException This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.

  • LexiconNotFoundException Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.

    Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.

  • ServiceFailureException An unknown condition has caused a service failure.

  • MarksNotSupportedForFormatException Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.

  • SsmlMarksNotSupportedForTextTypeException SSML speech marks are not supported for plain text-type input.

  • LanguageNotSupportedException The language specified is not currently supported by Amazon Polly in this capacity.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/StartSpeechSynthesisTask

func (*Polly) StartSpeechSynthesisTaskRequest 

func (c *Polly) StartSpeechSynthesisTaskRequest(input *StartSpeechSynthesisTaskInput) (req *request.Request, output *StartSpeechSynthesisTaskOutput)

StartSpeechSynthesisTaskRequest generates a "aws/request.Request" representing the client's request for the StartSpeechSynthesisTask 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 StartSpeechSynthesisTask for more information on using the StartSpeechSynthesisTask 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 StartSpeechSynthesisTaskRequest method.
req, resp := client.StartSpeechSynthesisTaskRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/StartSpeechSynthesisTask

func (*Polly) StartSpeechSynthesisTaskWithContext 

func (c *Polly) StartSpeechSynthesisTaskWithContext(ctx aws.Context, input *StartSpeechSynthesisTaskInput, opts ...request.Option) (*StartSpeechSynthesisTaskOutput, error)

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

See StartSpeechSynthesisTask 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 (*Polly) SynthesizeSpeech 

func (c *Polly) SynthesizeSpeech(input *SynthesizeSpeechInput) (*SynthesizeSpeechOutput, error)

SynthesizeSpeech API operation for Amazon Polly.

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works (https://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.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 Polly's API operation SynthesizeSpeech for usage and error information.

Returned Error Types:

  • TextLengthExceededException The value of the "Text" parameter is longer than the accepted limits. For the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.

  • InvalidSampleRateException The specified sample rate is not valid.

  • InvalidSsmlException The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.

  • LexiconNotFoundException Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.

    Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.

  • ServiceFailureException An unknown condition has caused a service failure.

  • MarksNotSupportedForFormatException Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.

  • SsmlMarksNotSupportedForTextTypeException SSML speech marks are not supported for plain text-type input.

  • LanguageNotSupportedException The language specified is not currently supported by Amazon Polly in this capacity.

  • EngineNotSupportedException This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/SynthesizeSpeech

Example (Shared00)

To synthesize speech Synthesizes plain text or SSML into a file of human-like speech. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/polly"
)

func main() {
	svc := polly.New(session.New())
	input := &polly.SynthesizeSpeechInput{
		LexiconNames: []*string{
			aws.String("example"),
		},
		OutputFormat: aws.String("mp3"),
		SampleRate:   aws.String("8000"),
		Text:         aws.String("All Gaul is divided into three parts"),
		TextType:     aws.String("text"),
		VoiceId:      aws.String("Joanna"),
	}

	result, err := svc.SynthesizeSpeech(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case polly.ErrCodeTextLengthExceededException:
				fmt.Println(polly.ErrCodeTextLengthExceededException, aerr.Error())
			case polly.ErrCodeInvalidSampleRateException:
				fmt.Println(polly.ErrCodeInvalidSampleRateException, aerr.Error())
			case polly.ErrCodeInvalidSsmlException:
				fmt.Println(polly.ErrCodeInvalidSsmlException, aerr.Error())
			case polly.ErrCodeLexiconNotFoundException:
				fmt.Println(polly.ErrCodeLexiconNotFoundException, aerr.Error())
			case polly.ErrCodeServiceFailureException:
				fmt.Println(polly.ErrCodeServiceFailureException, aerr.Error())
			case polly.ErrCodeMarksNotSupportedForFormatException:
				fmt.Println(polly.ErrCodeMarksNotSupportedForFormatException, aerr.Error())
			case polly.ErrCodeSsmlMarksNotSupportedForTextTypeException:
				fmt.Println(polly.ErrCodeSsmlMarksNotSupportedForTextTypeException, aerr.Error())
			case polly.ErrCodeLanguageNotSupportedException:
				fmt.Println(polly.ErrCodeLanguageNotSupportedException, aerr.Error())
			case polly.ErrCodeEngineNotSupportedException:
				fmt.Println(polly.ErrCodeEngineNotSupportedException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Polly) SynthesizeSpeechRequest 

func (c *Polly) SynthesizeSpeechRequest(input *SynthesizeSpeechInput) (req *request.Request, output *SynthesizeSpeechOutput)

SynthesizeSpeechRequest generates a "aws/request.Request" representing the client's request for the SynthesizeSpeech 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 SynthesizeSpeech for more information on using the SynthesizeSpeech 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 SynthesizeSpeechRequest method.
req, resp := client.SynthesizeSpeechRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/SynthesizeSpeech

func (*Polly) SynthesizeSpeechWithContext 

func (c *Polly) SynthesizeSpeechWithContext(ctx aws.Context, input *SynthesizeSpeechInput, opts ...request.Option) (*SynthesizeSpeechOutput, error)

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

See SynthesizeSpeech 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 PutLexiconInput 

type PutLexiconInput struct {

	// Content of the PLS lexicon as string data.
	//
	// Content is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PutLexiconInput's
	// String and GoString methods.
	//
	// Content is a required field
	Content *string `type:"string" required:"true" sensitive:"true"`

	// Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}.
	// That is, the name is a case-sensitive alphanumeric string up to 20 characters
	// long.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"LexiconName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutLexiconInput) GoString 

func (s PutLexiconInput) 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 (*PutLexiconInput) SetContent 

func (s *PutLexiconInput) SetContent(v string) *PutLexiconInput

SetContent sets the Content field's value.

func (*PutLexiconInput) SetName 

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

SetName sets the Name field's value.

func (PutLexiconInput) String 

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

func (s *PutLexiconInput) Validate() error

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

type PutLexiconOutput 

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

func (PutLexiconOutput) GoString 

func (s PutLexiconOutput) 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 (PutLexiconOutput) String 

func (s PutLexiconOutput) 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 ServiceFailureException 

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

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

An unknown condition has caused a service failure.

func (*ServiceFailureException) Code 

func (s *ServiceFailureException) Code() string

Code returns the exception type name.

func (*ServiceFailureException) Error 

func (s *ServiceFailureException) Error() string

func (ServiceFailureException) GoString 

func (s ServiceFailureException) 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 (*ServiceFailureException) Message 

func (s *ServiceFailureException) Message() string

Message returns the exception's message.

func (*ServiceFailureException) OrigErr 

func (s *ServiceFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceFailureException) RequestID 

func (s *ServiceFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceFailureException) StatusCode 

func (s *ServiceFailureException) StatusCode() int

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

func (ServiceFailureException) String 

func (s ServiceFailureException) 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 SsmlMarksNotSupportedForTextTypeException 

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

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

SSML speech marks are not supported for plain text-type input.

func (*SsmlMarksNotSupportedForTextTypeException) Code 

func (s *SsmlMarksNotSupportedForTextTypeException) Code() string

Code returns the exception type name.

func (*SsmlMarksNotSupportedForTextTypeException) Error 

func (s *SsmlMarksNotSupportedForTextTypeException) Error() string

func (SsmlMarksNotSupportedForTextTypeException) GoString 

func (s SsmlMarksNotSupportedForTextTypeException) 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 (*SsmlMarksNotSupportedForTextTypeException) Message 

func (s *SsmlMarksNotSupportedForTextTypeException) Message() string

Message returns the exception's message.

func (*SsmlMarksNotSupportedForTextTypeException) OrigErr 

func (s *SsmlMarksNotSupportedForTextTypeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SsmlMarksNotSupportedForTextTypeException) RequestID 

func (s *SsmlMarksNotSupportedForTextTypeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SsmlMarksNotSupportedForTextTypeException) StatusCode 

func (s *SsmlMarksNotSupportedForTextTypeException) StatusCode() int

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

func (SsmlMarksNotSupportedForTextTypeException) String 

func (s SsmlMarksNotSupportedForTextTypeException) 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 StartSpeechSynthesisTaskInput 

type StartSpeechSynthesisTaskInput struct {

	// Specifies the engine (standard, neural, long-form or generative) for Amazon
	// Polly to use when processing input text for speech synthesis. Using a voice
	// that is not supported for the engine selected will result in an error.
	Engine *string `type:"string" enum:"Engine"`

	// Optional language code for the Speech Synthesis request. This is only necessary
	// if using a bilingual voice, such as Aditi, which can be used for either Indian
	// English (en-IN) or Hindi (hi-IN).
	//
	// If a bilingual voice is used and no language code is specified, Amazon Polly
	// uses the default language of the bilingual voice. The default language for
	// any voice is the one returned by the DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html)
	// operation for the LanguageCode parameter. For example, if no language code
	// is specified, Aditi will use Indian English rather than Hindi.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// List of one or more pronunciation lexicon names you want the service to apply
	// during synthesis. Lexicons are applied only if the language of the lexicon
	// is the same as the language of the voice.
	LexiconNames []*string `type:"list"`

	// The format in which the returned output will be encoded. For audio stream,
	// this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
	//
	// OutputFormat is a required field
	OutputFormat *string `type:"string" required:"true" enum:"OutputFormat"`

	// Amazon S3 bucket name to which the output file will be saved.
	//
	// OutputS3BucketName is a required field
	OutputS3BucketName *string `type:"string" required:"true"`

	// The Amazon S3 key prefix for the output speech file.
	OutputS3KeyPrefix *string `type:"string"`

	// The audio frequency specified in Hz.
	//
	// The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and
	// "24000". The default value for standard voices is "22050". The default value
	// for neural voices is "24000". The default value for long-form voices is "24000".
	// The default value for generative voices is "24000".
	//
	// Valid values for pcm are "8000" and "16000" The default value is "16000".
	SampleRate *string `type:"string"`

	// ARN for the SNS topic optionally used for providing status notification for
	// a speech synthesis task.
	SnsTopicArn *string `type:"string"`

	// The type of speech marks returned for the input text.
	SpeechMarkTypes []*string `type:"list" enum:"SpeechMarkType"`

	// The input text to synthesize. If you specify ssml as the TextType, follow
	// the SSML format for the input text.
	//
	// Text is a required field
	Text *string `type:"string" required:"true"`

	// Specifies whether the input text is plain text or SSML. The default value
	// is plain text.
	TextType *string `type:"string" enum:"TextType"`

	// Voice ID to use for the synthesis.
	//
	// VoiceId is a required field
	VoiceId *string `type:"string" required:"true" enum:"VoiceId"`
	// contains filtered or unexported fields
}

func (StartSpeechSynthesisTaskInput) GoString 

func (s StartSpeechSynthesisTaskInput) 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 (*StartSpeechSynthesisTaskInput) SetEngine 

func (s *StartSpeechSynthesisTaskInput) SetEngine(v string) *StartSpeechSynthesisTaskInput

SetEngine sets the Engine field's value.

func (*StartSpeechSynthesisTaskInput) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*StartSpeechSynthesisTaskInput) SetLexiconNames 

func (s *StartSpeechSynthesisTaskInput) SetLexiconNames(v []*string) *StartSpeechSynthesisTaskInput

SetLexiconNames sets the LexiconNames field's value.

func (*StartSpeechSynthesisTaskInput) SetOutputFormat 

func (s *StartSpeechSynthesisTaskInput) SetOutputFormat(v string) *StartSpeechSynthesisTaskInput

SetOutputFormat sets the OutputFormat field's value.

func (*StartSpeechSynthesisTaskInput) SetOutputS3BucketName 

func (s *StartSpeechSynthesisTaskInput) SetOutputS3BucketName(v string) *StartSpeechSynthesisTaskInput

SetOutputS3BucketName sets the OutputS3BucketName field's value.

func (*StartSpeechSynthesisTaskInput) SetOutputS3KeyPrefix 

func (s *StartSpeechSynthesisTaskInput) SetOutputS3KeyPrefix(v string) *StartSpeechSynthesisTaskInput

SetOutputS3KeyPrefix sets the OutputS3KeyPrefix field's value.

func (*StartSpeechSynthesisTaskInput) SetSampleRate 

func (s *StartSpeechSynthesisTaskInput) SetSampleRate(v string) *StartSpeechSynthesisTaskInput

SetSampleRate sets the SampleRate field's value.

func (*StartSpeechSynthesisTaskInput) SetSnsTopicArn 

func (s *StartSpeechSynthesisTaskInput) SetSnsTopicArn(v string) *StartSpeechSynthesisTaskInput

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*StartSpeechSynthesisTaskInput) SetSpeechMarkTypes 

func (s *StartSpeechSynthesisTaskInput) SetSpeechMarkTypes(v []*string) *StartSpeechSynthesisTaskInput

SetSpeechMarkTypes sets the SpeechMarkTypes field's value.

func (*StartSpeechSynthesisTaskInput) SetText 

func (s *StartSpeechSynthesisTaskInput) SetText(v string) *StartSpeechSynthesisTaskInput

SetText sets the Text field's value.

func (*StartSpeechSynthesisTaskInput) SetTextType 

func (s *StartSpeechSynthesisTaskInput) SetTextType(v string) *StartSpeechSynthesisTaskInput

SetTextType sets the TextType field's value.

func (*StartSpeechSynthesisTaskInput) SetVoiceId 

func (s *StartSpeechSynthesisTaskInput) SetVoiceId(v string) *StartSpeechSynthesisTaskInput

SetVoiceId sets the VoiceId field's value.

func (StartSpeechSynthesisTaskInput) String 

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

func (s *StartSpeechSynthesisTaskInput) Validate() error

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

type StartSpeechSynthesisTaskOutput 

type StartSpeechSynthesisTaskOutput struct {

	// SynthesisTask object that provides information and attributes about a newly
	// submitted speech synthesis task.
	SynthesisTask *SynthesisTask `type:"structure"`
	// contains filtered or unexported fields
}

func (StartSpeechSynthesisTaskOutput) GoString 

func (s StartSpeechSynthesisTaskOutput) 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 (*StartSpeechSynthesisTaskOutput) SetSynthesisTask 

func (s *StartSpeechSynthesisTaskOutput) SetSynthesisTask(v *SynthesisTask) *StartSpeechSynthesisTaskOutput

SetSynthesisTask sets the SynthesisTask field's value.

func (StartSpeechSynthesisTaskOutput) String 

func (s StartSpeechSynthesisTaskOutput) 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 SynthesisTask 

type SynthesisTask struct {

	// Timestamp for the time the synthesis task was started.
	CreationTime *time.Time `type:"timestamp"`

	// Specifies the engine (standard, neural, long-form or generative) for Amazon
	// Polly to use when processing input text for speech synthesis. Using a voice
	// that is not supported for the engine selected will result in an error.
	Engine *string `type:"string" enum:"Engine"`

	// Optional language code for a synthesis task. This is only necessary if using
	// a bilingual voice, such as Aditi, which can be used for either Indian English
	// (en-IN) or Hindi (hi-IN).
	//
	// If a bilingual voice is used and no language code is specified, Amazon Polly
	// uses the default language of the bilingual voice. The default language for
	// any voice is the one returned by the DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html)
	// operation for the LanguageCode parameter. For example, if no language code
	// is specified, Aditi will use Indian English rather than Hindi.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// List of one or more pronunciation lexicon names you want the service to apply
	// during synthesis. Lexicons are applied only if the language of the lexicon
	// is the same as the language of the voice.
	LexiconNames []*string `type:"list"`

	// The format in which the returned output will be encoded. For audio stream,
	// this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
	OutputFormat *string `type:"string" enum:"OutputFormat"`

	// Pathway for the output speech file.
	OutputUri *string `type:"string"`

	// Number of billable characters synthesized.
	RequestCharacters *int64 `type:"integer"`

	// The audio frequency specified in Hz.
	//
	// The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and
	// "24000". The default value for standard voices is "22050". The default value
	// for neural voices is "24000". The default value for long-form voices is "24000".
	// The default value for generative voices is "24000".
	//
	// Valid values for pcm are "8000" and "16000" The default value is "16000".
	SampleRate *string `type:"string"`

	// ARN for the SNS topic optionally used for providing status notification for
	// a speech synthesis task.
	SnsTopicArn *string `type:"string"`

	// The type of speech marks returned for the input text.
	SpeechMarkTypes []*string `type:"list" enum:"SpeechMarkType"`

	// The Amazon Polly generated identifier for a speech synthesis task.
	TaskId *string `type:"string"`

	// Current status of the individual speech synthesis task.
	TaskStatus *string `type:"string" enum:"TaskStatus"`

	// Reason for the current status of a specific speech synthesis task, including
	// errors if the task has failed.
	TaskStatusReason *string `type:"string"`

	// Specifies whether the input text is plain text or SSML. The default value
	// is plain text.
	TextType *string `type:"string" enum:"TextType"`

	// Voice ID to use for the synthesis.
	VoiceId *string `type:"string" enum:"VoiceId"`
	// contains filtered or unexported fields
}

SynthesisTask object that provides information about a speech synthesis task.

func (SynthesisTask) GoString 

func (s SynthesisTask) 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 (*SynthesisTask) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*SynthesisTask) SetEngine 

func (s *SynthesisTask) SetEngine(v string) *SynthesisTask

SetEngine sets the Engine field's value.

func (*SynthesisTask) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*SynthesisTask) SetLexiconNames 

func (s *SynthesisTask) SetLexiconNames(v []*string) *SynthesisTask

SetLexiconNames sets the LexiconNames field's value.

func (*SynthesisTask) SetOutputFormat 

func (s *SynthesisTask) SetOutputFormat(v string) *SynthesisTask

SetOutputFormat sets the OutputFormat field's value.

func (*SynthesisTask) SetOutputUri 

func (s *SynthesisTask) SetOutputUri(v string) *SynthesisTask

SetOutputUri sets the OutputUri field's value.

func (*SynthesisTask) SetRequestCharacters 

func (s *SynthesisTask) SetRequestCharacters(v int64) *SynthesisTask

SetRequestCharacters sets the RequestCharacters field's value.

func (*SynthesisTask) SetSampleRate 

func (s *SynthesisTask) SetSampleRate(v string) *SynthesisTask

SetSampleRate sets the SampleRate field's value.

func (*SynthesisTask) SetSnsTopicArn 

func (s *SynthesisTask) SetSnsTopicArn(v string) *SynthesisTask

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*SynthesisTask) SetSpeechMarkTypes 

func (s *SynthesisTask) SetSpeechMarkTypes(v []*string) *SynthesisTask

SetSpeechMarkTypes sets the SpeechMarkTypes field's value.

func (*SynthesisTask) SetTaskId 

func (s *SynthesisTask) SetTaskId(v string) *SynthesisTask

SetTaskId sets the TaskId field's value.

func (*SynthesisTask) SetTaskStatus 

func (s *SynthesisTask) SetTaskStatus(v string) *SynthesisTask

SetTaskStatus sets the TaskStatus field's value.

func (*SynthesisTask) SetTaskStatusReason 

func (s *SynthesisTask) SetTaskStatusReason(v string) *SynthesisTask

SetTaskStatusReason sets the TaskStatusReason field's value.

func (*SynthesisTask) SetTextType 

func (s *SynthesisTask) SetTextType(v string) *SynthesisTask

SetTextType sets the TextType field's value.

func (*SynthesisTask) SetVoiceId 

func (s *SynthesisTask) SetVoiceId(v string) *SynthesisTask

SetVoiceId sets the VoiceId field's value.

func (SynthesisTask) String 

func (s SynthesisTask) 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 SynthesisTaskNotFoundException 

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

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

The Speech Synthesis task with requested Task ID cannot be found.

func (*SynthesisTaskNotFoundException) Code 

func (s *SynthesisTaskNotFoundException) Code() string

Code returns the exception type name.

func (*SynthesisTaskNotFoundException) Error 

func (s *SynthesisTaskNotFoundException) Error() string

func (SynthesisTaskNotFoundException) GoString 

func (s SynthesisTaskNotFoundException) 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 (*SynthesisTaskNotFoundException) Message 

func (s *SynthesisTaskNotFoundException) Message() string

Message returns the exception's message.

func (*SynthesisTaskNotFoundException) OrigErr 

func (s *SynthesisTaskNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SynthesisTaskNotFoundException) RequestID 

func (s *SynthesisTaskNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SynthesisTaskNotFoundException) StatusCode 

func (s *SynthesisTaskNotFoundException) StatusCode() int

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

func (SynthesisTaskNotFoundException) String 

func (s SynthesisTaskNotFoundException) 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 SynthesizeSpeechInput 

type SynthesizeSpeechInput struct {

	// Specifies the engine (standard, neural, long-form, or generative) for Amazon
	// Polly to use when processing input text for speech synthesis. Provide an
	// engine that is supported by the voice you select. If you don't provide an
	// engine, the standard engine is selected by default. If a chosen voice isn't
	// supported by the standard engine, this will result in an error. For information
	// on Amazon Polly voices and which voices are available for each engine, see
	// Available Voices (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html).
	//
	// Type: String
	//
	// Valid Values: standard | neural | long-form | generative
	//
	// Required: Yes
	Engine *string `type:"string" enum:"Engine"`

	// Optional language code for the Synthesize Speech request. This is only necessary
	// if using a bilingual voice, such as Aditi, which can be used for either Indian
	// English (en-IN) or Hindi (hi-IN).
	//
	// If a bilingual voice is used and no language code is specified, Amazon Polly
	// uses the default language of the bilingual voice. The default language for
	// any voice is the one returned by the DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html)
	// operation for the LanguageCode parameter. For example, if no language code
	// is specified, Aditi will use Indian English rather than Hindi.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// List of one or more pronunciation lexicon names you want the service to apply
	// during synthesis. Lexicons are applied only if the language of the lexicon
	// is the same as the language of the voice. For information about storing lexicons,
	// see PutLexicon (https://docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html).
	LexiconNames []*string `type:"list"`

	// The format in which the returned output will be encoded. For audio stream,
	// this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
	//
	// When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1
	// channel (mono), little-endian format.
	//
	// OutputFormat is a required field
	OutputFormat *string `type:"string" required:"true" enum:"OutputFormat"`

	// The audio frequency specified in Hz.
	//
	// The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and
	// "24000". The default value for standard voices is "22050". The default value
	// for neural voices is "24000". The default value for long-form voices is "24000".
	// The default value for generative voices is "24000".
	//
	// Valid values for pcm are "8000" and "16000" The default value is "16000".
	SampleRate *string `type:"string"`

	// The type of speech marks returned for the input text.
	SpeechMarkTypes []*string `type:"list" enum:"SpeechMarkType"`

	// Input text to synthesize. If you specify ssml as the TextType, follow the
	// SSML format for the input text.
	//
	// Text is a required field
	Text *string `type:"string" required:"true"`

	// Specifies whether the input text is plain text or SSML. The default value
	// is plain text. For more information, see Using SSML (https://docs.aws.amazon.com/polly/latest/dg/ssml.html).
	TextType *string `type:"string" enum:"TextType"`

	// Voice ID to use for the synthesis. You can get a list of available voice
	// IDs by calling the DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html)
	// operation.
	//
	// VoiceId is a required field
	VoiceId *string `type:"string" required:"true" enum:"VoiceId"`
	// contains filtered or unexported fields
}

func (SynthesizeSpeechInput) GoString 

func (s SynthesizeSpeechInput) 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 (*SynthesizeSpeechInput) SetEngine 

func (s *SynthesizeSpeechInput) SetEngine(v string) *SynthesizeSpeechInput

SetEngine sets the Engine field's value.

func (*SynthesizeSpeechInput) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*SynthesizeSpeechInput) SetLexiconNames 

func (s *SynthesizeSpeechInput) SetLexiconNames(v []*string) *SynthesizeSpeechInput

SetLexiconNames sets the LexiconNames field's value.

func (*SynthesizeSpeechInput) SetOutputFormat 

func (s *SynthesizeSpeechInput) SetOutputFormat(v string) *SynthesizeSpeechInput

SetOutputFormat sets the OutputFormat field's value.

func (*SynthesizeSpeechInput) SetSampleRate 

func (s *SynthesizeSpeechInput) SetSampleRate(v string) *SynthesizeSpeechInput

SetSampleRate sets the SampleRate field's value.

func (*SynthesizeSpeechInput) SetSpeechMarkTypes 

func (s *SynthesizeSpeechInput) SetSpeechMarkTypes(v []*string) *SynthesizeSpeechInput

SetSpeechMarkTypes sets the SpeechMarkTypes field's value.

func (*SynthesizeSpeechInput) SetText 

func (s *SynthesizeSpeechInput) SetText(v string) *SynthesizeSpeechInput

SetText sets the Text field's value.

func (*SynthesizeSpeechInput) SetTextType 

func (s *SynthesizeSpeechInput) SetTextType(v string) *SynthesizeSpeechInput

SetTextType sets the TextType field's value.

func (*SynthesizeSpeechInput) SetVoiceId 

func (s *SynthesizeSpeechInput) SetVoiceId(v string) *SynthesizeSpeechInput

SetVoiceId sets the VoiceId field's value.

func (SynthesizeSpeechInput) String 

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

func (s *SynthesizeSpeechInput) Validate() error

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

type SynthesizeSpeechOutput 

type SynthesizeSpeechOutput struct {

	// Stream containing the synthesized speech.
	AudioStream io.ReadCloser `type:"blob"`

	// Specifies the type audio stream. This should reflect the OutputFormat parameter
	// in your request.
	//
	//    * If you request mp3 as the OutputFormat, the ContentType returned is
	//    audio/mpeg.
	//
	//    * If you request ogg_vorbis as the OutputFormat, the ContentType returned
	//    is audio/ogg.
	//
	//    * If you request pcm as the OutputFormat, the ContentType returned is
	//    audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
	//
	//    * If you request json as the OutputFormat, the ContentType returned is
	//    application/x-json-stream.
	ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

	// Number of characters synthesized.
	RequestCharacters *int64 `location:"header" locationName:"x-amzn-RequestCharacters" type:"integer"`
	// contains filtered or unexported fields
}

func (SynthesizeSpeechOutput) GoString 

func (s SynthesizeSpeechOutput) 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 (*SynthesizeSpeechOutput) SetAudioStream 

func (s *SynthesizeSpeechOutput) SetAudioStream(v io.ReadCloser) *SynthesizeSpeechOutput

SetAudioStream sets the AudioStream field's value.

func (*SynthesizeSpeechOutput) SetContentType 

func (s *SynthesizeSpeechOutput) SetContentType(v string) *SynthesizeSpeechOutput

SetContentType sets the ContentType field's value.

func (*SynthesizeSpeechOutput) SetRequestCharacters 

func (s *SynthesizeSpeechOutput) SetRequestCharacters(v int64) *SynthesizeSpeechOutput

SetRequestCharacters sets the RequestCharacters field's value.

func (SynthesizeSpeechOutput) String 

func (s SynthesizeSpeechOutput) 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 TextLengthExceededException 

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

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

The value of the "Text" parameter is longer than the accepted limits. For the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.

func (*TextLengthExceededException) Code 

func (s *TextLengthExceededException) Code() string

Code returns the exception type name.

func (*TextLengthExceededException) Error 

func (s *TextLengthExceededException) Error() string

func (TextLengthExceededException) GoString 

func (s TextLengthExceededException) 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 (*TextLengthExceededException) Message 

func (s *TextLengthExceededException) Message() string

Message returns the exception's message.

func (*TextLengthExceededException) OrigErr 

func (s *TextLengthExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TextLengthExceededException) RequestID 

func (s *TextLengthExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TextLengthExceededException) StatusCode 

func (s *TextLengthExceededException) StatusCode() int

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

func (TextLengthExceededException) String 

func (s TextLengthExceededException) 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 UnsupportedPlsAlphabetException 

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

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

The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa and ipa.

func (*UnsupportedPlsAlphabetException) Code 

func (s *UnsupportedPlsAlphabetException) Code() string

Code returns the exception type name.

func (*UnsupportedPlsAlphabetException) Error 

func (s *UnsupportedPlsAlphabetException) Error() string

func (UnsupportedPlsAlphabetException) GoString 

func (s UnsupportedPlsAlphabetException) 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 (*UnsupportedPlsAlphabetException) Message 

func (s *UnsupportedPlsAlphabetException) Message() string

Message returns the exception's message.

func (*UnsupportedPlsAlphabetException) OrigErr 

func (s *UnsupportedPlsAlphabetException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedPlsAlphabetException) RequestID 

func (s *UnsupportedPlsAlphabetException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedPlsAlphabetException) StatusCode 

func (s *UnsupportedPlsAlphabetException) StatusCode() int

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

func (UnsupportedPlsAlphabetException) String 

func (s UnsupportedPlsAlphabetException) 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 UnsupportedPlsLanguageException 

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

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

The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes (https://docs.aws.amazon.com/polly/latest/dg/API_LexiconAttributes.html).

func (*UnsupportedPlsLanguageException) Code 

func (s *UnsupportedPlsLanguageException) Code() string

Code returns the exception type name.

func (*UnsupportedPlsLanguageException) Error 

func (s *UnsupportedPlsLanguageException) Error() string

func (UnsupportedPlsLanguageException) GoString 

func (s UnsupportedPlsLanguageException) 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 (*UnsupportedPlsLanguageException) Message 

func (s *UnsupportedPlsLanguageException) Message() string

Message returns the exception's message.

func (*UnsupportedPlsLanguageException) OrigErr 

func (s *UnsupportedPlsLanguageException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedPlsLanguageException) RequestID 

func (s *UnsupportedPlsLanguageException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedPlsLanguageException) StatusCode 

func (s *UnsupportedPlsLanguageException) StatusCode() int

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

func (UnsupportedPlsLanguageException) String 

func (s UnsupportedPlsLanguageException) 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 Voice 

type Voice struct {

	// Additional codes for languages available for the specified voice in addition
	// to its default language.
	//
	// For example, the default language for Aditi is Indian English (en-IN) because
	// it was first used for that language. Since Aditi is bilingual and fluent
	// in both Indian English and Hindi, this parameter would show the code hi-IN.
	AdditionalLanguageCodes []*string `type:"list" enum:"LanguageCode"`

	// Gender of the voice.
	Gender *string `type:"string" enum:"Gender"`

	// Amazon Polly assigned voice ID. This is the ID that you specify when calling
	// the SynthesizeSpeech operation.
	Id *string `type:"string" enum:"VoiceId"`

	// Language code of the voice.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// Human readable name of the language in English.
	LanguageName *string `type:"string"`

	// Name of the voice (for example, Salli, Kendra, etc.). This provides a human
	// readable voice name that you might display in your application.
	Name *string `type:"string"`

	// Specifies which engines (standard, neural, long-form or generative) are supported
	// by a given voice.
	SupportedEngines []*string `type:"list" enum:"Engine"`
	// contains filtered or unexported fields
}

Description of the voice.

func (Voice) GoString 

func (s Voice) 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 (*Voice) SetAdditionalLanguageCodes 

func (s *Voice) SetAdditionalLanguageCodes(v []*string) *Voice

SetAdditionalLanguageCodes sets the AdditionalLanguageCodes field's value.

func (*Voice) SetGender 

func (s *Voice) SetGender(v string) *Voice

SetGender sets the Gender field's value.

func (*Voice) SetId 

func (s *Voice) SetId(v string) *Voice

SetId sets the Id field's value.

func (*Voice) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*Voice) SetLanguageName 

func (s *Voice) SetLanguageName(v string) *Voice

SetLanguageName sets the LanguageName field's value.

func (*Voice) SetName 

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

SetName sets the Name field's value.

func (*Voice) SetSupportedEngines 

func (s *Voice) SetSupportedEngines(v []*string) *Voice

SetSupportedEngines sets the SupportedEngines field's value.

func (Voice) String 

func (s Voice) 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 pollyiface provides an interface to enable mocking the Amazon Polly service client for testing your code.
 Package pollyiface provides an interface to enable mocking the Amazon Polly 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.