translate

package
v1.25.40 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2019 License: Apache-2.0 Imports: 9 Imported by: 22

Documentation

Overview

Package translate provides the client and types for making API requests to Amazon Translate.

Provides translation between one source language and another of the same set of languages.

See https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (
	// TerminologyDataFormatCsv is a TerminologyDataFormat enum value
	TerminologyDataFormatCsv = "CSV"

	// TerminologyDataFormatTmx is a TerminologyDataFormat enum value
	TerminologyDataFormatTmx = "TMX"
)
View Source 
const (

	// ErrCodeDetectedLanguageLowConfidenceException for service response error code
	// "DetectedLanguageLowConfidenceException".
	//
	// The confidence that Amazon Comprehend accurately detected the source language
	// is low. If a low confidence level is acceptable for your application, you
	// can use the language in the exception to call Amazon Translate again. For
	// more information, see the DetectDominantLanguage (https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.html)
	// operation in the Amazon Comprehend Developer Guide.
	ErrCodeDetectedLanguageLowConfidenceException = "DetectedLanguageLowConfidenceException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal server error occurred. Retry your request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValueException".
	//
	// The value of the parameter is invalid. Review the value of the parameter
	// you are using to correct it, and then retry your operation.
	ErrCodeInvalidParameterValueException = "InvalidParameterValueException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request that you made is invalid. Check your request to determine why
	// it's invalid and then retry the request.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The specified limit has been exceeded. Review your request and retry it with
	// a quantity below the stated limit.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource you are looking for has not been found. Review the resource
	// you're looking for and see if a different resource will accomplish your needs
	// before retrying the revised request. .
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The Amazon Translate service is temporarily unavailable. Please wait a bit
	// and then retry your request.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTextSizeLimitExceededException for service response error code
	// "TextSizeLimitExceededException".
	//
	// The size of the text you submitted exceeds the size limit. Reduce the size
	// of the text or use a smaller document and then retry your request.
	ErrCodeTextSizeLimitExceededException = "TextSizeLimitExceededException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// You have made too many requests within a short period of time. Wait for a
	// short time and then try your request again.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeUnsupportedLanguagePairException for service response error code
	// "UnsupportedLanguagePairException".
	//
	// Amazon Translate does not support translation from the language of the source
	// text into the requested target language. For more information, see how-to-error-msg.
	ErrCodeUnsupportedLanguagePairException = "UnsupportedLanguagePairException"
)
View Source 
const (
	ServiceName = "translate" // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Translate" // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source 
const (
	// EncryptionKeyTypeKms is a EncryptionKeyType enum value
	EncryptionKeyTypeKms = "KMS"
)
View Source 
const (
	// MergeStrategyOverwrite is a MergeStrategy enum value
	MergeStrategyOverwrite = "OVERWRITE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AppliedTerminology added in v1.15.84 

type AppliedTerminology struct {

	// The name of the custom terminology applied to the input text by Amazon Translate
	// for the translated text response.
	Name *string `min:"1" type:"string"`

	// The specific terms of the custom terminology applied to the input text by
	// Amazon Translate for the translated text response. A maximum of 250 terms
	// will be returned, and the specific terms applied will be the first 250 terms
	// in the source text.
	Terms []*Term `type:"list"`
	// contains filtered or unexported fields
}

The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.

func (AppliedTerminology) GoString added in v1.15.84 

func (s AppliedTerminology) GoString() string

GoString returns the string representation

func (*AppliedTerminology) SetName added in v1.15.84 

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

SetName sets the Name field's value.

func (*AppliedTerminology) SetTerms added in v1.15.84 

func (s *AppliedTerminology) SetTerms(v []*Term) *AppliedTerminology

SetTerms sets the Terms field's value.

func (AppliedTerminology) String added in v1.15.84 

func (s AppliedTerminology) String() string

String returns the string representation

type DeleteTerminologyInput added in v1.15.84 

type DeleteTerminologyInput struct {

	// The name of the custom terminology being deleted.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTerminologyInput) GoString added in v1.15.84 

func (s DeleteTerminologyInput) GoString() string

GoString returns the string representation

func (*DeleteTerminologyInput) SetName added in v1.15.84 

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

SetName sets the Name field's value.

func (DeleteTerminologyInput) String added in v1.15.84 

func (s DeleteTerminologyInput) String() string

String returns the string representation

func (*DeleteTerminologyInput) Validate added in v1.15.84 

func (s *DeleteTerminologyInput) Validate() error

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

type DeleteTerminologyOutput added in v1.15.84 

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

func (DeleteTerminologyOutput) GoString added in v1.15.84 

func (s DeleteTerminologyOutput) GoString() string

GoString returns the string representation

func (DeleteTerminologyOutput) String added in v1.15.84 

func (s DeleteTerminologyOutput) String() string

String returns the string representation

type EncryptionKey added in v1.15.84 

type EncryptionKey struct {

	// The Amazon Resource Name (ARN) of the encryption key being used to encrypt
	// the custom terminology.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The type of encryption key used by Amazon Translate to encrypt custom terminologies.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"EncryptionKeyType"`
	// contains filtered or unexported fields
}

The encryption key used to encrypt the custom terminologies used by Amazon Translate.

func (EncryptionKey) GoString added in v1.15.84 

func (s EncryptionKey) GoString() string

GoString returns the string representation

func (*EncryptionKey) SetId added in v1.15.84 

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

SetId sets the Id field's value.

func (*EncryptionKey) SetType added in v1.15.84 

func (s *EncryptionKey) SetType(v string) *EncryptionKey

SetType sets the Type field's value.

func (EncryptionKey) String added in v1.15.84 

func (s EncryptionKey) String() string

String returns the string representation

func (*EncryptionKey) Validate added in v1.15.84 

func (s *EncryptionKey) Validate() error

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

type GetTerminologyInput added in v1.15.84 

type GetTerminologyInput struct {

	// The name of the custom terminology being retrieved.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The data format of the custom terminology being retrieved, either CSV or
	// TMX.
	//
	// TerminologyDataFormat is a required field
	TerminologyDataFormat *string `type:"string" required:"true" enum:"TerminologyDataFormat"`
	// contains filtered or unexported fields
}

func (GetTerminologyInput) GoString added in v1.15.84 

func (s GetTerminologyInput) GoString() string

GoString returns the string representation

func (*GetTerminologyInput) SetName added in v1.15.84 

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

SetName sets the Name field's value.

func (*GetTerminologyInput) SetTerminologyDataFormat added in v1.15.84 

func (s *GetTerminologyInput) SetTerminologyDataFormat(v string) *GetTerminologyInput

SetTerminologyDataFormat sets the TerminologyDataFormat field's value.

func (GetTerminologyInput) String added in v1.15.84 

func (s GetTerminologyInput) String() string

String returns the string representation

func (*GetTerminologyInput) Validate added in v1.15.84 

func (s *GetTerminologyInput) Validate() error

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

type GetTerminologyOutput added in v1.15.84 

type GetTerminologyOutput struct {

	// The data location of the custom terminology being retrieved. The custom terminology
	// file is returned in a presigned url that has a 30 minute expiration.
	TerminologyDataLocation *TerminologyDataLocation `type:"structure"`

	// The properties of the custom terminology being retrieved.
	TerminologyProperties *TerminologyProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTerminologyOutput) GoString added in v1.15.84 

func (s GetTerminologyOutput) GoString() string

GoString returns the string representation

func (*GetTerminologyOutput) SetTerminologyDataLocation added in v1.15.84 

func (s *GetTerminologyOutput) SetTerminologyDataLocation(v *TerminologyDataLocation) *GetTerminologyOutput

SetTerminologyDataLocation sets the TerminologyDataLocation field's value.

func (*GetTerminologyOutput) SetTerminologyProperties added in v1.15.84 

func (s *GetTerminologyOutput) SetTerminologyProperties(v *TerminologyProperties) *GetTerminologyOutput

SetTerminologyProperties sets the TerminologyProperties field's value.

func (GetTerminologyOutput) String added in v1.15.84 

func (s GetTerminologyOutput) String() string

String returns the string representation

type ImportTerminologyInput added in v1.15.84 

type ImportTerminologyInput struct {

	// The description of the custom terminology being imported.
	Description *string `type:"string"`

	// The encryption key for the custom terminology being imported.
	EncryptionKey *EncryptionKey `type:"structure"`

	// The merge strategy of the custom terminology being imported. Currently, only
	// the OVERWRITE merge strategy is supported. In this case, the imported terminology
	// will overwrite an existing terminology of the same name.
	//
	// MergeStrategy is a required field
	MergeStrategy *string `type:"string" required:"true" enum:"MergeStrategy"`

	// The name of the custom terminology being imported.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The terminology data for the custom terminology being imported.
	//
	// TerminologyData is a required field
	TerminologyData *TerminologyData `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ImportTerminologyInput) GoString added in v1.15.84 

func (s ImportTerminologyInput) GoString() string

GoString returns the string representation

func (*ImportTerminologyInput) SetDescription added in v1.15.84 

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

SetDescription sets the Description field's value.

func (*ImportTerminologyInput) SetEncryptionKey added in v1.15.84 

func (s *ImportTerminologyInput) SetEncryptionKey(v *EncryptionKey) *ImportTerminologyInput

SetEncryptionKey sets the EncryptionKey field's value.

func (*ImportTerminologyInput) SetMergeStrategy added in v1.15.84 

func (s *ImportTerminologyInput) SetMergeStrategy(v string) *ImportTerminologyInput

SetMergeStrategy sets the MergeStrategy field's value.

func (*ImportTerminologyInput) SetName added in v1.15.84 

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

SetName sets the Name field's value.

func (*ImportTerminologyInput) SetTerminologyData added in v1.15.84 

func (s *ImportTerminologyInput) SetTerminologyData(v *TerminologyData) *ImportTerminologyInput

SetTerminologyData sets the TerminologyData field's value.

func (ImportTerminologyInput) String added in v1.15.84 

func (s ImportTerminologyInput) String() string

String returns the string representation

func (*ImportTerminologyInput) Validate added in v1.15.84 

func (s *ImportTerminologyInput) Validate() error

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

type ImportTerminologyOutput added in v1.15.84 

type ImportTerminologyOutput struct {

	// The properties of the custom terminology being imported.
	TerminologyProperties *TerminologyProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (ImportTerminologyOutput) GoString added in v1.15.84 

func (s ImportTerminologyOutput) GoString() string

GoString returns the string representation

func (*ImportTerminologyOutput) SetTerminologyProperties added in v1.15.84 

func (s *ImportTerminologyOutput) SetTerminologyProperties(v *TerminologyProperties) *ImportTerminologyOutput

SetTerminologyProperties sets the TerminologyProperties field's value.

func (ImportTerminologyOutput) String added in v1.15.84 

func (s ImportTerminologyOutput) String() string

String returns the string representation

type ListTerminologiesInput added in v1.15.84 

type ListTerminologiesInput struct {

	// The maximum number of custom terminologies returned per list request.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the result of the request to ListTerminologies was truncated, include
	// the NextToken to fetch the next group of custom terminologies.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTerminologiesInput) GoString added in v1.15.84 

func (s ListTerminologiesInput) GoString() string

GoString returns the string representation

func (*ListTerminologiesInput) SetMaxResults added in v1.15.84 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTerminologiesInput) SetNextToken added in v1.15.84 

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

SetNextToken sets the NextToken field's value.

func (ListTerminologiesInput) String added in v1.15.84 

func (s ListTerminologiesInput) String() string

String returns the string representation

func (*ListTerminologiesInput) Validate added in v1.15.84 

func (s *ListTerminologiesInput) Validate() error

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

type ListTerminologiesOutput added in v1.15.84 

type ListTerminologiesOutput struct {

	// If the response to the ListTerminologies was truncated, the NextToken fetches
	// the next group of custom terminologies.
	NextToken *string `type:"string"`

	// The properties list of the custom terminologies returned on the list request.
	TerminologyPropertiesList []*TerminologyProperties `type:"list"`
	// contains filtered or unexported fields
}

func (ListTerminologiesOutput) GoString added in v1.15.84 

func (s ListTerminologiesOutput) GoString() string

GoString returns the string representation

func (*ListTerminologiesOutput) SetNextToken added in v1.15.84 

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

SetNextToken sets the NextToken field's value.

func (*ListTerminologiesOutput) SetTerminologyPropertiesList added in v1.15.84 

func (s *ListTerminologiesOutput) SetTerminologyPropertiesList(v []*TerminologyProperties) *ListTerminologiesOutput

SetTerminologyPropertiesList sets the TerminologyPropertiesList field's value.

func (ListTerminologiesOutput) String added in v1.15.84 

func (s ListTerminologiesOutput) String() string

String returns the string representation

type Term added in v1.15.84 

type Term struct {

	// The source text of the term being translated by the custom terminology.
	SourceText *string `type:"string"`

	// The target text of the term being translated by the custom terminology.
	TargetText *string `type:"string"`
	// contains filtered or unexported fields
}

The term being translated by the custom terminology.

func (Term) GoString added in v1.15.84 

func (s Term) GoString() string

GoString returns the string representation

func (*Term) SetSourceText added in v1.15.84 

func (s *Term) SetSourceText(v string) *Term

SetSourceText sets the SourceText field's value.

func (*Term) SetTargetText added in v1.15.84 

func (s *Term) SetTargetText(v string) *Term

SetTargetText sets the TargetText field's value.

func (Term) String added in v1.15.84 

func (s Term) String() string

String returns the string representation

type TerminologyData added in v1.15.84 

type TerminologyData struct {

	// The file containing the custom terminology data.
	//
	// File is automatically base64 encoded/decoded by the SDK.
	//
	// File is a required field
	File []byte `type:"blob" required:"true" sensitive:"true"`

	// The data format of the custom terminology. Either CSV or TMX.
	//
	// Format is a required field
	Format *string `type:"string" required:"true" enum:"TerminologyDataFormat"`
	// contains filtered or unexported fields
}

The data associated with the custom terminology.

func (TerminologyData) GoString added in v1.15.84 

func (s TerminologyData) GoString() string

GoString returns the string representation

func (*TerminologyData) SetFile added in v1.15.84 

func (s *TerminologyData) SetFile(v []byte) *TerminologyData

SetFile sets the File field's value.

func (*TerminologyData) SetFormat added in v1.15.84 

func (s *TerminologyData) SetFormat(v string) *TerminologyData

SetFormat sets the Format field's value.

func (TerminologyData) String added in v1.15.84 

func (s TerminologyData) String() string

String returns the string representation

func (*TerminologyData) Validate added in v1.15.84 

func (s *TerminologyData) Validate() error

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

type TerminologyDataLocation added in v1.15.84 

type TerminologyDataLocation struct {

	// The location of the custom terminology data.
	//
	// Location is a required field
	Location *string `type:"string" required:"true"`

	// The repository type for the custom terminology data.
	//
	// RepositoryType is a required field
	RepositoryType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The location of the custom terminology data.

func (TerminologyDataLocation) GoString added in v1.15.84 

func (s TerminologyDataLocation) GoString() string

GoString returns the string representation

func (*TerminologyDataLocation) SetLocation added in v1.15.84 

func (s *TerminologyDataLocation) SetLocation(v string) *TerminologyDataLocation

SetLocation sets the Location field's value.

func (*TerminologyDataLocation) SetRepositoryType added in v1.15.84 

func (s *TerminologyDataLocation) SetRepositoryType(v string) *TerminologyDataLocation

SetRepositoryType sets the RepositoryType field's value.

func (TerminologyDataLocation) String added in v1.15.84 

func (s TerminologyDataLocation) String() string

String returns the string representation

type TerminologyProperties added in v1.15.84 

type TerminologyProperties struct {

	// The Amazon Resource Name (ARN) of the custom terminology.
	Arn *string `type:"string"`

	// The time at which the custom terminology was created, based on the timestamp.
	CreatedAt *time.Time `type:"timestamp"`

	// The description of the custom terminology properties.
	Description *string `type:"string"`

	// The encryption key for the custom terminology.
	EncryptionKey *EncryptionKey `type:"structure"`

	// The time at which the custom terminology was last update, based on the timestamp.
	LastUpdatedAt *time.Time `type:"timestamp"`

	// The name of the custom terminology.
	Name *string `min:"1" type:"string"`

	// The size of the file used when importing a custom terminology.
	SizeBytes *int64 `type:"integer"`

	// The language code for the source text of the translation request for which
	// the custom terminology is being used.
	SourceLanguageCode *string `min:"2" type:"string"`

	// The language codes for the target languages available with the custom terminology
	// file. All possible target languages are returned in array.
	TargetLanguageCodes []*string `type:"list"`

	// The number of terms included in the custom terminology.
	TermCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The properties of the custom terminology.

func (TerminologyProperties) GoString added in v1.15.84 

func (s TerminologyProperties) GoString() string

GoString returns the string representation

func (*TerminologyProperties) SetArn added in v1.15.84 

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

SetArn sets the Arn field's value.

func (*TerminologyProperties) SetCreatedAt added in v1.15.84 

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

SetCreatedAt sets the CreatedAt field's value.

func (*TerminologyProperties) SetDescription added in v1.15.84 

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

SetDescription sets the Description field's value.

func (*TerminologyProperties) SetEncryptionKey added in v1.15.84 

func (s *TerminologyProperties) SetEncryptionKey(v *EncryptionKey) *TerminologyProperties

SetEncryptionKey sets the EncryptionKey field's value.

func (*TerminologyProperties) SetLastUpdatedAt added in v1.15.84 

func (s *TerminologyProperties) SetLastUpdatedAt(v time.Time) *TerminologyProperties

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*TerminologyProperties) SetName added in v1.15.84 

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

SetName sets the Name field's value.

func (*TerminologyProperties) SetSizeBytes added in v1.15.84 

func (s *TerminologyProperties) SetSizeBytes(v int64) *TerminologyProperties

SetSizeBytes sets the SizeBytes field's value.

func (*TerminologyProperties) SetSourceLanguageCode added in v1.15.84 

func (s *TerminologyProperties) SetSourceLanguageCode(v string) *TerminologyProperties

SetSourceLanguageCode sets the SourceLanguageCode field's value.

func (*TerminologyProperties) SetTargetLanguageCodes added in v1.15.84 

func (s *TerminologyProperties) SetTargetLanguageCodes(v []*string) *TerminologyProperties

SetTargetLanguageCodes sets the TargetLanguageCodes field's value.

func (*TerminologyProperties) SetTermCount added in v1.15.84 

func (s *TerminologyProperties) SetTermCount(v int64) *TerminologyProperties

SetTermCount sets the TermCount field's value.

func (TerminologyProperties) String added in v1.15.84 

func (s TerminologyProperties) String() string

String returns the string representation

type TextInput 

type TextInput struct {

	// The language code for the language of the source text. The language must
	// be a language supported by Amazon Translate.
	//
	// To have Amazon Translate determine the source language of your text, you
	// can specify auto in the SourceLanguageCode field. If you specify auto, Amazon
	// Translate will call Amazon Comprehend to determine the source language.
	//
	// SourceLanguageCode is a required field
	SourceLanguageCode *string `min:"2" type:"string" required:"true"`

	// The language code requested for the language of the target text. The language
	// must be a language supported by Amazon Translate.
	//
	// TargetLanguageCode is a required field
	TargetLanguageCode *string `min:"2" type:"string" required:"true"`

	// The TerminologyNames list that is taken as input to the TranslateText request.
	// This has a minimum length of 0 and a maximum length of 1.
	TerminologyNames []*string `type:"list"`

	// The text to translate. The text string can be a maximum of 5,000 bytes long.
	// Depending on your character set, this may be fewer than 5,000 characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TextInput) GoString 

func (s TextInput) GoString() string

GoString returns the string representation

func (*TextInput) SetSourceLanguageCode 

func (s *TextInput) SetSourceLanguageCode(v string) *TextInput

SetSourceLanguageCode sets the SourceLanguageCode field's value.

func (*TextInput) SetTargetLanguageCode 

func (s *TextInput) SetTargetLanguageCode(v string) *TextInput

SetTargetLanguageCode sets the TargetLanguageCode field's value.

func (*TextInput) SetTerminologyNames added in v1.15.84 

func (s *TextInput) SetTerminologyNames(v []*string) *TextInput

SetTerminologyNames sets the TerminologyNames field's value.

func (*TextInput) SetText 

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

SetText sets the Text field's value.

func (TextInput) String 

func (s TextInput) String() string

String returns the string representation

func (*TextInput) Validate 

func (s *TextInput) Validate() error

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

type TextOutput 

type TextOutput struct {

	// The names of the custom terminologies applied to the input text by Amazon
	// Translate for the translated text response.
	AppliedTerminologies []*AppliedTerminology `type:"list"`

	// The language code for the language of the source text.
	//
	// SourceLanguageCode is a required field
	SourceLanguageCode *string `min:"2" type:"string" required:"true"`

	// The language code for the language of the target text.
	//
	// TargetLanguageCode is a required field
	TargetLanguageCode *string `min:"2" type:"string" required:"true"`

	// The the translated text. The maximum length of this text is 5kb.
	//
	// TranslatedText is a required field
	TranslatedText *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TextOutput) GoString 

func (s TextOutput) GoString() string

GoString returns the string representation

func (*TextOutput) SetAppliedTerminologies added in v1.15.84 

func (s *TextOutput) SetAppliedTerminologies(v []*AppliedTerminology) *TextOutput

SetAppliedTerminologies sets the AppliedTerminologies field's value.

func (*TextOutput) SetSourceLanguageCode 

func (s *TextOutput) SetSourceLanguageCode(v string) *TextOutput

SetSourceLanguageCode sets the SourceLanguageCode field's value.

func (*TextOutput) SetTargetLanguageCode 

func (s *TextOutput) SetTargetLanguageCode(v string) *TextOutput

SetTargetLanguageCode sets the TargetLanguageCode field's value.

func (*TextOutput) SetTranslatedText 

func (s *TextOutput) SetTranslatedText(v string) *TextOutput

SetTranslatedText sets the TranslatedText field's value.

func (TextOutput) String 

func (s TextOutput) String() string

String returns the string representation

type Translate 

type Translate struct {
	*client.Client
}

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

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

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

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

func (*Translate) DeleteTerminology added in v1.15.84 

func (c *Translate) DeleteTerminology(input *DeleteTerminologyInput) (*DeleteTerminologyOutput, error)

DeleteTerminology API operation for Amazon Translate.

A synchronous action that deletes a custom terminology.

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

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .

  • ErrCodeTooManyRequestsException "TooManyRequestsException" You have made too many requests within a short period of time. Wait for a short time and then try your request again.

  • ErrCodeInternalServerException "InternalServerException" An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/DeleteTerminology

func (*Translate) DeleteTerminologyRequest added in v1.15.84 

func (c *Translate) DeleteTerminologyRequest(input *DeleteTerminologyInput) (req *request.Request, output *DeleteTerminologyOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/DeleteTerminology

func (*Translate) DeleteTerminologyWithContext added in v1.15.84 

func (c *Translate) DeleteTerminologyWithContext(ctx aws.Context, input *DeleteTerminologyInput, opts ...request.Option) (*DeleteTerminologyOutput, error)

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

See DeleteTerminology 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 (*Translate) GetTerminology added in v1.15.84 

func (c *Translate) GetTerminology(input *GetTerminologyInput) (*GetTerminologyOutput, error)

GetTerminology API operation for Amazon Translate.

Retrieves a custom terminology.

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

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" You have made too many requests within a short period of time. Wait for a short time and then try your request again.

  • ErrCodeInternalServerException "InternalServerException" An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/GetTerminology

func (*Translate) GetTerminologyRequest added in v1.15.84 

func (c *Translate) GetTerminologyRequest(input *GetTerminologyInput) (req *request.Request, output *GetTerminologyOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/GetTerminology

func (*Translate) GetTerminologyWithContext added in v1.15.84 

func (c *Translate) GetTerminologyWithContext(ctx aws.Context, input *GetTerminologyInput, opts ...request.Option) (*GetTerminologyOutput, error)

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

See GetTerminology 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 (*Translate) ImportTerminology added in v1.15.84 

func (c *Translate) ImportTerminology(input *ImportTerminologyInput) (*ImportTerminologyOutput, error)

ImportTerminology API operation for Amazon Translate.

Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

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

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.

  • ErrCodeLimitExceededException "LimitExceededException" The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" You have made too many requests within a short period of time. Wait for a short time and then try your request again.

  • ErrCodeInternalServerException "InternalServerException" An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/ImportTerminology

func (*Translate) ImportTerminologyRequest added in v1.15.84 

func (c *Translate) ImportTerminologyRequest(input *ImportTerminologyInput) (req *request.Request, output *ImportTerminologyOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/ImportTerminology

func (*Translate) ImportTerminologyWithContext added in v1.15.84 

func (c *Translate) ImportTerminologyWithContext(ctx aws.Context, input *ImportTerminologyInput, opts ...request.Option) (*ImportTerminologyOutput, error)

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

See ImportTerminology 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 (*Translate) ListTerminologies added in v1.15.84 

func (c *Translate) ListTerminologies(input *ListTerminologiesInput) (*ListTerminologiesOutput, error)

ListTerminologies API operation for Amazon Translate.

Provides a list of custom terminologies associated with your account.

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

See the AWS API reference guide for Amazon Translate's API operation ListTerminologies for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" You have made too many requests within a short period of time. Wait for a short time and then try your request again.

  • ErrCodeInternalServerException "InternalServerException" An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/ListTerminologies

func (*Translate) ListTerminologiesRequest added in v1.15.84 

func (c *Translate) ListTerminologiesRequest(input *ListTerminologiesInput) (req *request.Request, output *ListTerminologiesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/ListTerminologies

func (*Translate) ListTerminologiesWithContext added in v1.15.84 

func (c *Translate) ListTerminologiesWithContext(ctx aws.Context, input *ListTerminologiesInput, opts ...request.Option) (*ListTerminologiesOutput, error)

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

See ListTerminologies 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 (*Translate) Text 

func (c *Translate) Text(input *TextInput) (*TextOutput, error)

Text API operation for Amazon Translate.

Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs (http://docs.aws.amazon.com/translate/latest/dg/pairs.html).

  • Arabic (ar)

  • Chinese (Simplified) (zh)

  • Chinese (Traditional) (zh-TW)

  • Czech (cs)

  • Danish (da)

  • Dutch (nl)

  • English (en)

  • Finnish (fi)

  • French (fr)

  • German (de)

  • Hebrew (he)

  • Indonesian (id)

  • Italian (it)

  • Japanese (ja)

  • Korean (ko)

  • Polish (pl)

  • Portuguese (pt)

  • Russian (ru)

  • Spanish (es)

  • Swedish (sv)

  • Turkish (tr)

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

  • ErrCodeTooManyRequestsException "TooManyRequestsException" You have made too many requests within a short period of time. Wait for a short time and then try your request again.

  • ErrCodeUnsupportedLanguagePairException "UnsupportedLanguagePairException" Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see how-to-error-msg.

  • ErrCodeDetectedLanguageLowConfidenceException "DetectedLanguageLowConfidenceException" The confidence that Amazon Comprehend accurately detected the source language is low. If a low confidence level is acceptable for your application, you can use the language in the exception to call Amazon Translate again. For more information, see the DetectDominantLanguage (https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.html) operation in the Amazon Comprehend Developer Guide.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .

  • ErrCodeInternalServerException "InternalServerException" An internal server error occurred. Retry your request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/Text

func (*Translate) TextRequest 

func (c *Translate) TextRequest(input *TextInput) (req *request.Request, output *TextOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/Text

func (*Translate) TextWithContext 

func (c *Translate) TextWithContext(ctx aws.Context, input *TextInput, opts ...request.Option) (*TextOutput, error)

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

See Text 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.

Source Files

View all Source files

Directories

Path Synopsis
Package translateiface provides an interface to enable mocking the Amazon Translate service client for testing your code.
 Package translateiface provides an interface to enable mocking the Amazon Translate 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.