translate

package
v1.34.4 Latest Latest
Warning

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

Go to latest
Published: Aug 13, 2020 License: Apache-2.0 Imports: 10 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 (
	// JobStatusSubmitted is a JobStatus enum value
	JobStatusSubmitted = "SUBMITTED"

	// JobStatusInProgress is a JobStatus enum value
	JobStatusInProgress = "IN_PROGRESS"

	// JobStatusCompleted is a JobStatus enum value
	JobStatusCompleted = "COMPLETED"

	// JobStatusCompletedWithError is a JobStatus enum value
	JobStatusCompletedWithError = "COMPLETED_WITH_ERROR"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "FAILED"

	// JobStatusStopRequested is a JobStatus enum value
	JobStatusStopRequested = "STOP_REQUESTED"

	// JobStatusStopped is a JobStatus enum value
	JobStatusStopped = "STOPPED"
)
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"

	// ErrCodeInvalidFilterException for service response error code
	// "InvalidFilterException".
	//
	// The filter specified for the operation is invalid. Specify a different filter.
	ErrCodeInvalidFilterException = "InvalidFilterException"

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

func EncryptionKeyType_Values added in v1.34.3

func EncryptionKeyType_Values() []string

EncryptionKeyType_Values returns all elements of the EncryptionKeyType enum

func JobStatus_Values added in v1.34.3

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func MergeStrategy_Values added in v1.34.3

func MergeStrategy_Values() []string

MergeStrategy_Values returns all elements of the MergeStrategy enum

func TerminologyDataFormat_Values added in v1.34.3

func TerminologyDataFormat_Values() []string

TerminologyDataFormat_Values returns all elements of the TerminologyDataFormat enum

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

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

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

type DescribeTextTranslationJobInput struct {

	// The identifier that Amazon Translate generated for the job. The StartTextTranslationJob
	// operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTextTranslationJobInput) GoString added in v1.27.3

GoString returns the string representation

func (*DescribeTextTranslationJobInput) SetJobId added in v1.27.3

SetJobId sets the JobId field's value.

func (DescribeTextTranslationJobInput) String added in v1.27.3

String returns the string representation

func (*DescribeTextTranslationJobInput) Validate added in v1.27.3

func (s *DescribeTextTranslationJobInput) Validate() error

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

type DescribeTextTranslationJobOutput added in v1.27.3

type DescribeTextTranslationJobOutput struct {

	// An object that contains the properties associated with an asynchronous batch
	// translation job.
	TextTranslationJobProperties *TextTranslationJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTextTranslationJobOutput) GoString added in v1.27.3

GoString returns the string representation

func (*DescribeTextTranslationJobOutput) SetTextTranslationJobProperties added in v1.27.3

SetTextTranslationJobProperties sets the TextTranslationJobProperties field's value.

func (DescribeTextTranslationJobOutput) String added in v1.27.3

String returns the string representation

type DetectedLanguageLowConfidenceException added in v1.28.0

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

	// The language code of the auto-detected language from Amazon Comprehend.
	DetectedLanguageCode *string `min:"2" type:"string"`

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

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.

func (*DetectedLanguageLowConfidenceException) Code added in v1.28.0

Code returns the exception type name.

func (*DetectedLanguageLowConfidenceException) Error added in v1.28.0

func (DetectedLanguageLowConfidenceException) GoString added in v1.28.0

GoString returns the string representation

func (*DetectedLanguageLowConfidenceException) Message added in v1.28.0

Message returns the exception's message.

func (*DetectedLanguageLowConfidenceException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DetectedLanguageLowConfidenceException) RequestID added in v1.28.0

RequestID returns the service's response RequestID for request.

func (*DetectedLanguageLowConfidenceException) StatusCode added in v1.28.0

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

func (DetectedLanguageLowConfidenceException) String added in v1.28.0

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

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

SetDescription sets the Description field's value.

func (*ImportTerminologyInput) SetEncryptionKey added in v1.15.84

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

SetName sets the Name field's value.

func (*ImportTerminologyInput) SetTerminologyData added in v1.15.84

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

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

type InputDataConfig struct {

	// The multipurpose internet mail extension (MIME) type of the input files.
	// Valid values are text/plain for plaintext files and text/html for HTML files.
	//
	// ContentType is a required field
	ContentType *string `type:"string" required:"true"`

	// The URI of the AWS S3 folder that contains the input file. The folder must
	// be in the same Region as the API endpoint you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input configuration properties for requesting a batch translation job.

func (InputDataConfig) GoString added in v1.27.3

func (s InputDataConfig) GoString() string

GoString returns the string representation

func (*InputDataConfig) SetContentType added in v1.27.3

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

SetContentType sets the ContentType field's value.

func (*InputDataConfig) SetS3Uri added in v1.27.3

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

SetS3Uri sets the S3Uri field's value.

func (InputDataConfig) String added in v1.27.3

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate added in v1.27.3

func (s *InputDataConfig) Validate() error

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

type InternalServerException added in v1.28.0

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

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

An internal server error occurred. Retry your request.

func (*InternalServerException) Code added in v1.28.0

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message added in v1.28.0

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String added in v1.28.0

func (s InternalServerException) String() string

String returns the string representation

type InvalidFilterException added in v1.28.0

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

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

The filter specified for the operation is invalid. Specify a different filter.

func (*InvalidFilterException) Code added in v1.28.0

func (s *InvalidFilterException) Code() string

Code returns the exception type name.

func (*InvalidFilterException) Error added in v1.28.0

func (s *InvalidFilterException) Error() string

func (InvalidFilterException) GoString added in v1.28.0

func (s InvalidFilterException) GoString() string

GoString returns the string representation

func (*InvalidFilterException) Message added in v1.28.0

func (s *InvalidFilterException) Message() string

Message returns the exception's message.

func (*InvalidFilterException) OrigErr added in v1.28.0

func (s *InvalidFilterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidFilterException) RequestID added in v1.28.0

func (s *InvalidFilterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidFilterException) StatusCode added in v1.28.0

func (s *InvalidFilterException) StatusCode() int

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

func (InvalidFilterException) String added in v1.28.0

func (s InvalidFilterException) String() string

String returns the string representation

type InvalidParameterValueException added in v1.28.0

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

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

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

func (*InvalidParameterValueException) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidParameterValueException) Error added in v1.28.0

func (InvalidParameterValueException) GoString added in v1.28.0

GoString returns the string representation

func (*InvalidParameterValueException) Message added in v1.28.0

Message returns the exception's message.

func (*InvalidParameterValueException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterValueException) RequestID added in v1.28.0

func (s *InvalidParameterValueException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterValueException) StatusCode added in v1.28.0

func (s *InvalidParameterValueException) StatusCode() int

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

func (InvalidParameterValueException) String added in v1.28.0

String returns the string representation

type InvalidRequestException added in v1.28.0

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

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

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

func (*InvalidRequestException) Code added in v1.28.0

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (*InvalidRequestException) Message added in v1.28.0

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0

func (s *InvalidRequestException) StatusCode() int

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

func (InvalidRequestException) String added in v1.28.0

func (s InvalidRequestException) String() string

String returns the string representation

type JobDetails added in v1.27.3

type JobDetails struct {

	// The number of documents that could not be processed during a translation
	// job.
	DocumentsWithErrorsCount *int64 `type:"integer"`

	// The number of documents used as input in a translation job.
	InputDocumentsCount *int64 `type:"integer"`

	// The number of documents successfully processed during a translation job.
	TranslatedDocumentsCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The number of documents successfully and unsuccessfully processed during a translation job.

func (JobDetails) GoString added in v1.27.3

func (s JobDetails) GoString() string

GoString returns the string representation

func (*JobDetails) SetDocumentsWithErrorsCount added in v1.27.3

func (s *JobDetails) SetDocumentsWithErrorsCount(v int64) *JobDetails

SetDocumentsWithErrorsCount sets the DocumentsWithErrorsCount field's value.

func (*JobDetails) SetInputDocumentsCount added in v1.27.3

func (s *JobDetails) SetInputDocumentsCount(v int64) *JobDetails

SetInputDocumentsCount sets the InputDocumentsCount field's value.

func (*JobDetails) SetTranslatedDocumentsCount added in v1.27.3

func (s *JobDetails) SetTranslatedDocumentsCount(v int64) *JobDetails

SetTranslatedDocumentsCount sets the TranslatedDocumentsCount field's value.

func (JobDetails) String added in v1.27.3

func (s JobDetails) String() string

String returns the string representation

type LimitExceededException added in v1.28.0

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

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

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

func (*LimitExceededException) Code added in v1.28.0

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.0

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String added in v1.28.0

func (s LimitExceededException) String() string

String returns the string representation

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

SetMaxResults sets the MaxResults field's value.

func (*ListTerminologiesInput) SetNextToken added in v1.15.84

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

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

type ListTextTranslationJobsInput struct {

	// The parameters that specify which batch translation jobs to retrieve. Filters
	// include job name, job status, and submission time. You can only set one filter
	// at a time.
	Filter *TextTranslationJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default value is
	// 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to request the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTextTranslationJobsInput) GoString added in v1.27.3

func (s ListTextTranslationJobsInput) GoString() string

GoString returns the string representation

func (*ListTextTranslationJobsInput) SetFilter added in v1.27.3

SetFilter sets the Filter field's value.

func (*ListTextTranslationJobsInput) SetMaxResults added in v1.27.3

SetMaxResults sets the MaxResults field's value.

func (*ListTextTranslationJobsInput) SetNextToken added in v1.27.3

SetNextToken sets the NextToken field's value.

func (ListTextTranslationJobsInput) String added in v1.27.3

String returns the string representation

func (*ListTextTranslationJobsInput) Validate added in v1.27.3

func (s *ListTextTranslationJobsInput) Validate() error

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

type ListTextTranslationJobsOutput added in v1.27.3

type ListTextTranslationJobsOutput struct {

	// The token to use to retreive the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `type:"string"`

	// A list containing the properties of each job that is returned.
	TextTranslationJobPropertiesList []*TextTranslationJobProperties `type:"list"`
	// contains filtered or unexported fields
}

func (ListTextTranslationJobsOutput) GoString added in v1.27.3

GoString returns the string representation

func (*ListTextTranslationJobsOutput) SetNextToken added in v1.27.3

SetNextToken sets the NextToken field's value.

func (*ListTextTranslationJobsOutput) SetTextTranslationJobPropertiesList added in v1.27.3

SetTextTranslationJobPropertiesList sets the TextTranslationJobPropertiesList field's value.

func (ListTextTranslationJobsOutput) String added in v1.27.3

String returns the string representation

type OutputDataConfig added in v1.27.3

type OutputDataConfig struct {

	// The URI of the S3 folder that contains a translation job's output file. The
	// folder must be in the same Region as the API endpoint that you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The output configuration properties for a batch translation job.

func (OutputDataConfig) GoString added in v1.27.3

func (s OutputDataConfig) GoString() string

GoString returns the string representation

func (*OutputDataConfig) SetS3Uri added in v1.27.3

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

SetS3Uri sets the S3Uri field's value.

func (OutputDataConfig) String added in v1.27.3

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate added in v1.27.3

func (s *OutputDataConfig) Validate() error

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

type ResourceNotFoundException added in v1.28.0

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

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

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.

func (*ResourceNotFoundException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.28.0

func (s ResourceNotFoundException) String() string

String returns the string representation

type ServiceUnavailableException added in v1.28.0

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

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

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

func (*ServiceUnavailableException) Code added in v1.28.0

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0

func (ServiceUnavailableException) GoString added in v1.28.0

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (*ServiceUnavailableException) Message added in v1.28.0

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0

func (s *ServiceUnavailableException) StatusCode() int

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

func (ServiceUnavailableException) String added in v1.28.0

String returns the string representation

type StartTextTranslationJobInput added in v1.27.3

type StartTextTranslationJobInput struct {

	// The client token of the EC2 instance calling the request. This token is auto-generated
	// when using the Amazon Translate SDK. Otherwise, use the DescribeInstances
	// (docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html)
	// EC2 operation to retreive an instance's client token. For more information,
	// see Client Tokens (docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html#client-tokens)
	// in the EC2 User Guide.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM)
	// role that grants Amazon Translate read access to your input data. For more
	// nformation, see identity-and-access-management.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and S3 location of the input documents for the translation
	// job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The name of the batch translation job to be performed.
	JobName *string `min:"1" type:"string"`

	// Specifies the S3 folder to which your job output will be saved.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// The language code of the input language. For a list of language codes, see
	// what-is-languages.
	//
	// Amazon Translate does not automatically detect a source language during batch
	// translation jobs.
	//
	// SourceLanguageCode is a required field
	SourceLanguageCode *string `min:"2" type:"string" required:"true"`

	// The language code of the output language.
	//
	// TargetLanguageCodes is a required field
	TargetLanguageCodes []*string `min:"1" type:"list" required:"true"`

	// The name of the terminology to use in the batch translation job. For a list
	// of available terminologies, use the ListTerminologies operation.
	TerminologyNames []*string `type:"list"`
	// contains filtered or unexported fields
}

func (StartTextTranslationJobInput) GoString added in v1.27.3

func (s StartTextTranslationJobInput) GoString() string

GoString returns the string representation

func (*StartTextTranslationJobInput) SetClientToken added in v1.27.3

SetClientToken sets the ClientToken field's value.

func (*StartTextTranslationJobInput) SetDataAccessRoleArn added in v1.27.3

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartTextTranslationJobInput) SetInputDataConfig added in v1.27.3

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartTextTranslationJobInput) SetJobName added in v1.27.3

SetJobName sets the JobName field's value.

func (*StartTextTranslationJobInput) SetOutputDataConfig added in v1.27.3

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartTextTranslationJobInput) SetSourceLanguageCode added in v1.27.3

SetSourceLanguageCode sets the SourceLanguageCode field's value.

func (*StartTextTranslationJobInput) SetTargetLanguageCodes added in v1.27.3

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

SetTargetLanguageCodes sets the TargetLanguageCodes field's value.

func (*StartTextTranslationJobInput) SetTerminologyNames added in v1.27.3

SetTerminologyNames sets the TerminologyNames field's value.

func (StartTextTranslationJobInput) String added in v1.27.3

String returns the string representation

func (*StartTextTranslationJobInput) Validate added in v1.27.3

func (s *StartTextTranslationJobInput) Validate() error

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

type StartTextTranslationJobOutput added in v1.27.3

type StartTextTranslationJobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// ID with the DescribeTextTranslationJob operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job. Possible values include:
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Translate is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * COMPLETED_WITH_ERRORS - The job was completed with errors. The errors
	//    can be analyzed in the job's output.
	//
	//    * FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob
	//    operation.
	//
	//    * STOP_REQUESTED - The user who started the job has requested that it
	//    be stopped.
	//
	//    * STOPPED - The job has been stopped.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartTextTranslationJobOutput) GoString added in v1.27.3

GoString returns the string representation

func (*StartTextTranslationJobOutput) SetJobId added in v1.27.3

SetJobId sets the JobId field's value.

func (*StartTextTranslationJobOutput) SetJobStatus added in v1.27.3

SetJobStatus sets the JobStatus field's value.

func (StartTextTranslationJobOutput) String added in v1.27.3

String returns the string representation

type StopTextTranslationJobInput added in v1.27.3

type StopTextTranslationJobInput struct {

	// The job ID of the job to be stopped.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopTextTranslationJobInput) GoString added in v1.27.3

func (s StopTextTranslationJobInput) GoString() string

GoString returns the string representation

func (*StopTextTranslationJobInput) SetJobId added in v1.27.3

SetJobId sets the JobId field's value.

func (StopTextTranslationJobInput) String added in v1.27.3

String returns the string representation

func (*StopTextTranslationJobInput) Validate added in v1.27.3

func (s *StopTextTranslationJobInput) Validate() error

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

type StopTextTranslationJobOutput added in v1.27.3

type StopTextTranslationJobOutput struct {

	// The job ID of the stopped batch translation job.
	JobId *string `min:"1" type:"string"`

	// The status of the designated job. Upon successful completion, the job's status
	// will be STOPPED.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopTextTranslationJobOutput) GoString added in v1.27.3

func (s StopTextTranslationJobOutput) GoString() string

GoString returns the string representation

func (*StopTextTranslationJobOutput) SetJobId added in v1.27.3

SetJobId sets the JobId field's value.

func (*StopTextTranslationJobOutput) SetJobStatus added in v1.27.3

SetJobStatus sets the JobStatus field's value.

func (StopTextTranslationJobOutput) String added in v1.27.3

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. Your version of the AWS
	// SDK performs a Base64-encoding on this field before sending a request to
	// the AWS service. Users of the SDK should not perform Base64-encoding themselves.
	//
	// 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

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

SetArn sets the Arn field's value.

func (*TerminologyProperties) SetCreatedAt added in v1.15.84

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

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

SetName sets the Name field's value.

func (*TerminologyProperties) SetSizeBytes added in v1.15.84

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

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. For a list of language codes,
	// see what-is-languages.
	//
	// 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 (https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html)
	// 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 name of the terminology list file to be used in the TranslateText request.
	// You can use 1 terminology list at most in a TranslateText request. Terminology
	// lists can contain a maximum of 256 terms.
	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 translated text.
	//
	// 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 TextSizeLimitExceededException added in v1.28.0

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

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

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.

func (*TextSizeLimitExceededException) Code added in v1.28.0

Code returns the exception type name.

func (*TextSizeLimitExceededException) Error added in v1.28.0

func (TextSizeLimitExceededException) GoString added in v1.28.0

GoString returns the string representation

func (*TextSizeLimitExceededException) Message added in v1.28.0

Message returns the exception's message.

func (*TextSizeLimitExceededException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TextSizeLimitExceededException) RequestID added in v1.28.0

func (s *TextSizeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TextSizeLimitExceededException) StatusCode added in v1.28.0

func (s *TextSizeLimitExceededException) StatusCode() int

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

func (TextSizeLimitExceededException) String added in v1.28.0

String returns the string representation

type TextTranslationJobFilter added in v1.27.3

type TextTranslationJobFilter struct {

	// Filters the list of jobs by name.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based by job status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing and returns only the jobs submitted after the specified time.
	// Jobs are returned in descending order, newest to oldest.
	SubmittedAfterTime *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing and returns only the jobs submitted before the specified time.
	// Jobs are returned in ascending order, oldest to newest.
	SubmittedBeforeTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.

func (TextTranslationJobFilter) GoString added in v1.27.3

func (s TextTranslationJobFilter) GoString() string

GoString returns the string representation

func (*TextTranslationJobFilter) SetJobName added in v1.27.3

SetJobName sets the JobName field's value.

func (*TextTranslationJobFilter) SetJobStatus added in v1.27.3

SetJobStatus sets the JobStatus field's value.

func (*TextTranslationJobFilter) SetSubmittedAfterTime added in v1.27.3

func (s *TextTranslationJobFilter) SetSubmittedAfterTime(v time.Time) *TextTranslationJobFilter

SetSubmittedAfterTime sets the SubmittedAfterTime field's value.

func (*TextTranslationJobFilter) SetSubmittedBeforeTime added in v1.27.3

func (s *TextTranslationJobFilter) SetSubmittedBeforeTime(v time.Time) *TextTranslationJobFilter

SetSubmittedBeforeTime sets the SubmittedBeforeTime field's value.

func (TextTranslationJobFilter) String added in v1.27.3

func (s TextTranslationJobFilter) String() string

String returns the string representation

func (*TextTranslationJobFilter) Validate added in v1.27.3

func (s *TextTranslationJobFilter) Validate() error

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

type TextTranslationJobProperties added in v1.27.3

type TextTranslationJobProperties struct {

	// The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM)
	// role that granted Amazon Translate read access to the job's input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time at which the translation job ended.
	EndTime *time.Time `type:"timestamp"`

	// The input configuration properties that were specified when the job was requested.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The number of documents successfully and unsuccessfully processed during
	// the translation job.
	JobDetails *JobDetails `type:"structure"`

	// The ID of the translation job.
	JobId *string `min:"1" type:"string"`

	// The user-defined name of the translation job.
	JobName *string `min:"1" type:"string"`

	// The status of the translation job.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// An explanation of any errors that may have occured during the translation
	// job.
	Message *string `type:"string"`

	// The output configuration properties that were specified when the job was
	// requested.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The language code of the language of the source text. The language must be
	// a language supported by Amazon Translate.
	SourceLanguageCode *string `min:"2" type:"string"`

	// The time at which the translation job was submitted.
	SubmittedTime *time.Time `type:"timestamp"`

	// The language code of the language of the target text. The language must be
	// a language supported by Amazon Translate.
	TargetLanguageCodes []*string `min:"1" type:"list"`

	// A list containing the names of the terminologies applied to a translation
	// job. Only one terminology can be applied per StartTextTranslationJob request
	// at this time.
	TerminologyNames []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides information about a translation job.

func (TextTranslationJobProperties) GoString added in v1.27.3

func (s TextTranslationJobProperties) GoString() string

GoString returns the string representation

func (*TextTranslationJobProperties) SetDataAccessRoleArn added in v1.27.3

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*TextTranslationJobProperties) SetEndTime added in v1.27.3

SetEndTime sets the EndTime field's value.

func (*TextTranslationJobProperties) SetInputDataConfig added in v1.27.3

SetInputDataConfig sets the InputDataConfig field's value.

func (*TextTranslationJobProperties) SetJobDetails added in v1.27.3

SetJobDetails sets the JobDetails field's value.

func (*TextTranslationJobProperties) SetJobId added in v1.27.3

SetJobId sets the JobId field's value.

func (*TextTranslationJobProperties) SetJobName added in v1.27.3

SetJobName sets the JobName field's value.

func (*TextTranslationJobProperties) SetJobStatus added in v1.27.3

SetJobStatus sets the JobStatus field's value.

func (*TextTranslationJobProperties) SetMessage added in v1.27.3

SetMessage sets the Message field's value.

func (*TextTranslationJobProperties) SetOutputDataConfig added in v1.27.3

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*TextTranslationJobProperties) SetSourceLanguageCode added in v1.27.3

SetSourceLanguageCode sets the SourceLanguageCode field's value.

func (*TextTranslationJobProperties) SetSubmittedTime added in v1.27.3

SetSubmittedTime sets the SubmittedTime field's value.

func (*TextTranslationJobProperties) SetTargetLanguageCodes added in v1.27.3

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

SetTargetLanguageCodes sets the TargetLanguageCodes field's value.

func (*TextTranslationJobProperties) SetTerminologyNames added in v1.27.3

SetTerminologyNames sets the TerminologyNames field's value.

func (TextTranslationJobProperties) String added in v1.27.3

String returns the string representation

type TooManyRequestsException added in v1.28.0

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

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

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

func (*TooManyRequestsException) Code added in v1.28.0

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0

func (s TooManyRequestsException) GoString() string

GoString returns the string representation

func (*TooManyRequestsException) Message added in v1.28.0

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0

func (s *TooManyRequestsException) StatusCode() int

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

func (TooManyRequestsException) String added in v1.28.0

func (s TooManyRequestsException) 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 Types:

  • 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.

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

  • 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) DescribeTextTranslationJob added in v1.27.3

func (c *Translate) DescribeTextTranslationJob(input *DescribeTextTranslationJobInput) (*DescribeTextTranslationJobOutput, error)

DescribeTextTranslationJob API operation for Amazon Translate.

Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.

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 DescribeTextTranslationJob for usage and error information.

Returned Error Types:

  • 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.

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

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

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

func (*Translate) DescribeTextTranslationJobRequest added in v1.27.3

func (c *Translate) DescribeTextTranslationJobRequest(input *DescribeTextTranslationJobInput) (req *request.Request, output *DescribeTextTranslationJobOutput)

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

func (*Translate) DescribeTextTranslationJobWithContext added in v1.27.3

func (c *Translate) DescribeTextTranslationJobWithContext(ctx aws.Context, input *DescribeTextTranslationJobInput, opts ...request.Option) (*DescribeTextTranslationJobOutput, error)

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

See DescribeTextTranslationJob 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 Types:

  • 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.

  • 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.

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

  • 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 Types:

  • 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.

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

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

  • 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 Types:

  • 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.

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

  • 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) ListTerminologiesPages added in v1.27.3

func (c *Translate) ListTerminologiesPages(input *ListTerminologiesInput, fn func(*ListTerminologiesOutput, bool) bool) error

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

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

func (*Translate) ListTerminologiesPagesWithContext added in v1.27.3

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

ListTerminologiesPagesWithContext same as ListTerminologiesPages 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 (*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) ListTextTranslationJobs added in v1.27.3

func (c *Translate) ListTextTranslationJobs(input *ListTextTranslationJobsInput) (*ListTextTranslationJobsOutput, error)

ListTextTranslationJobs API operation for Amazon Translate.

Gets a list of the batch translation jobs that you have submitted.

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 ListTextTranslationJobs for usage and error information.

Returned Error Types:

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

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

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

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

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

func (*Translate) ListTextTranslationJobsPages added in v1.27.3

func (c *Translate) ListTextTranslationJobsPages(input *ListTextTranslationJobsInput, fn func(*ListTextTranslationJobsOutput, bool) bool) error

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

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

func (*Translate) ListTextTranslationJobsPagesWithContext added in v1.27.3

func (c *Translate) ListTextTranslationJobsPagesWithContext(ctx aws.Context, input *ListTextTranslationJobsInput, fn func(*ListTextTranslationJobsOutput, bool) bool, opts ...request.Option) error

ListTextTranslationJobsPagesWithContext same as ListTextTranslationJobsPages 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 (*Translate) ListTextTranslationJobsRequest added in v1.27.3

func (c *Translate) ListTextTranslationJobsRequest(input *ListTextTranslationJobsInput) (req *request.Request, output *ListTextTranslationJobsOutput)

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

func (*Translate) ListTextTranslationJobsWithContext added in v1.27.3

func (c *Translate) ListTextTranslationJobsWithContext(ctx aws.Context, input *ListTextTranslationJobsInput, opts ...request.Option) (*ListTextTranslationJobsOutput, error)

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

See ListTextTranslationJobs 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) StartTextTranslationJob added in v1.27.3

func (c *Translate) StartTextTranslationJob(input *StartTextTranslationJobInput) (*StartTextTranslationJobOutput, error)

StartTextTranslationJob API operation for Amazon Translate.

Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async.

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

Amazon Translate does not support batch translation of multiple source languages at once.

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 StartTextTranslationJob for usage and error information.

Returned Error Types:

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

  • 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.

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

  • 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.

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

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

func (*Translate) StartTextTranslationJobRequest added in v1.27.3

func (c *Translate) StartTextTranslationJobRequest(input *StartTextTranslationJobInput) (req *request.Request, output *StartTextTranslationJobOutput)

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

func (*Translate) StartTextTranslationJobWithContext added in v1.27.3

func (c *Translate) StartTextTranslationJobWithContext(ctx aws.Context, input *StartTextTranslationJobInput, opts ...request.Option) (*StartTextTranslationJobOutput, error)

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

See StartTextTranslationJob 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) StopTextTranslationJob added in v1.27.3

func (c *Translate) StopTextTranslationJob(input *StopTextTranslationJobInput) (*StopTextTranslationJobOutput, error)

StopTextTranslationJob API operation for Amazon Translate.

Stops an asynchronous batch translation job that is in progress.

If the job's state is IN_PROGRESS, the job will be marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state. Otherwise, the job is put into the STOPPED state.

Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId.

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 StopTextTranslationJob for usage and error information.

Returned Error Types:

  • 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.

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

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

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

func (*Translate) StopTextTranslationJobRequest added in v1.27.3

func (c *Translate) StopTextTranslationJobRequest(input *StopTextTranslationJobInput) (req *request.Request, output *StopTextTranslationJobOutput)

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

func (*Translate) StopTextTranslationJobWithContext added in v1.27.3

func (c *Translate) StopTextTranslationJobWithContext(ctx aws.Context, input *StopTextTranslationJobInput, opts ...request.Option) (*StopTextTranslationJobOutput, error)

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

See StopTextTranslationJob 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. For a list of available languages and language codes, see what-is-languages.

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

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

  • 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.

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

  • 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.

  • 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.

  • 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.

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

  • 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.

type UnsupportedLanguagePairException added in v1.28.0

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

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

	// The language code for the language of the input text.
	SourceLanguageCode *string `min:"2" type:"string"`

	// The language code for the language of the translated text.
	TargetLanguageCode *string `min:"2" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*UnsupportedLanguagePairException) Code added in v1.28.0

Code returns the exception type name.

func (*UnsupportedLanguagePairException) Error added in v1.28.0

func (UnsupportedLanguagePairException) GoString added in v1.28.0

GoString returns the string representation

func (*UnsupportedLanguagePairException) Message added in v1.28.0

Message returns the exception's message.

func (*UnsupportedLanguagePairException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedLanguagePairException) RequestID added in v1.28.0

RequestID returns the service's response RequestID for request.

func (*UnsupportedLanguagePairException) StatusCode added in v1.28.0

func (s *UnsupportedLanguagePairException) StatusCode() int

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

func (UnsupportedLanguagePairException) String added in v1.28.0

String returns the string representation

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