Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppliedTerminology

type AppliedTerminology struct {

	// The name of the custom terminology applied to the input text by Amazon Translate
	// for the translated text response.
	Name *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
}

    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.

    type ConcurrentModificationException

    type ConcurrentModificationException struct {
    	Message *string
    }

      Another modification is being made. That modification must complete before you can make your change.

      func (*ConcurrentModificationException) Error

      func (*ConcurrentModificationException) ErrorCode

      func (e *ConcurrentModificationException) ErrorCode() string

      func (*ConcurrentModificationException) ErrorFault

      func (*ConcurrentModificationException) ErrorMessage

      func (e *ConcurrentModificationException) ErrorMessage() string

      type ConflictException

      type ConflictException struct {
      	Message *string
      }

        There was a conflict processing the request. Try your request again.

        func (*ConflictException) Error

        func (e *ConflictException) Error() string

        func (*ConflictException) ErrorCode

        func (e *ConflictException) ErrorCode() string

        func (*ConflictException) ErrorFault

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

        func (*ConflictException) ErrorMessage

        func (e *ConflictException) ErrorMessage() string

        type DetectedLanguageLowConfidenceException

        type DetectedLanguageLowConfidenceException struct {
        	Message *string
        
        	DetectedLanguageCode *string
        }

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

          func (*DetectedLanguageLowConfidenceException) ErrorCode

          func (*DetectedLanguageLowConfidenceException) ErrorFault

          func (*DetectedLanguageLowConfidenceException) ErrorMessage

          type EncryptionKey

          type EncryptionKey struct {
          
          	// The Amazon Resource Name (ARN) of the encryption key being used to encrypt the
          	// custom terminology.
          	//
          	// This member is required.
          	Id *string
          
          	// The type of encryption key used by Amazon Translate to encrypt custom
          	// terminologies.
          	//
          	// This member is required.
          	Type EncryptionKeyType
          }

            The encryption key used to encrypt this object.

            type EncryptionKeyType

            type EncryptionKeyType string
            const (
            	EncryptionKeyTypeKms EncryptionKeyType = "KMS"
            )

              Enum values for EncryptionKeyType

              func (EncryptionKeyType) Values

                Values returns all known values for EncryptionKeyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                type InputDataConfig

                type InputDataConfig struct {
                
                	// Describes the format of the data that you submit to Amazon Translate as input.
                	// You can specify one of the following multipurpose internet mail extension (MIME)
                	// types:
                	//
                	// * text/html: The input data consists of one or more HTML files. Amazon
                	// Translate translates only the text that resides in the html element in each
                	// file.
                	//
                	// * text/plain: The input data consists of one or more unformatted text
                	// files. Amazon Translate translates every character in this type of input.
                	//
                	// *
                	// application/vnd.openxmlformats-officedocument.wordprocessingml.document: The
                	// input data consists of one or more Word documents (.docx).
                	//
                	// *
                	// application/vnd.openxmlformats-officedocument.presentationml.presentation: The
                	// input data consists of one or more PowerPoint Presentation files (.pptx).
                	//
                	// *
                	// application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input
                	// data consists of one or more Excel Workbook files (.xlsx).
                	//
                	// If you structure
                	// your input data as HTML, ensure that you set this parameter to text/html. By
                	// doing so, you cut costs by limiting the translation to the contents of the html
                	// element in each file. Otherwise, if you set this parameter to text/plain, your
                	// costs will cover the translation of every character.
                	//
                	// This member is required.
                	ContentType *string
                
                	// 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.
                	//
                	// This member is required.
                	S3Uri *string
                }

                  The input configuration properties for requesting a batch translation job.

                  type InternalServerException

                  type InternalServerException struct {
                  	Message *string
                  }

                    An internal server error occurred. Retry your request.

                    func (*InternalServerException) Error

                    func (e *InternalServerException) Error() string

                    func (*InternalServerException) ErrorCode

                    func (e *InternalServerException) ErrorCode() string

                    func (*InternalServerException) ErrorFault

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

                    func (*InternalServerException) ErrorMessage

                    func (e *InternalServerException) ErrorMessage() string

                    type InvalidFilterException

                    type InvalidFilterException struct {
                    	Message *string
                    }

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

                      func (*InvalidFilterException) Error

                      func (e *InvalidFilterException) Error() string

                      func (*InvalidFilterException) ErrorCode

                      func (e *InvalidFilterException) ErrorCode() string

                      func (*InvalidFilterException) ErrorFault

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

                      func (*InvalidFilterException) ErrorMessage

                      func (e *InvalidFilterException) ErrorMessage() string

                      type InvalidParameterValueException

                      type InvalidParameterValueException struct {
                      	Message *string
                      }

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

                        func (*InvalidParameterValueException) ErrorCode

                        func (e *InvalidParameterValueException) ErrorCode() string

                        func (*InvalidParameterValueException) ErrorFault

                        func (*InvalidParameterValueException) ErrorMessage

                        func (e *InvalidParameterValueException) ErrorMessage() string

                        type InvalidRequestException

                        type InvalidRequestException struct {
                        	Message *string
                        }

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

                          func (*InvalidRequestException) Error

                          func (e *InvalidRequestException) Error() string

                          func (*InvalidRequestException) ErrorCode

                          func (e *InvalidRequestException) ErrorCode() string

                          func (*InvalidRequestException) ErrorFault

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

                          func (*InvalidRequestException) ErrorMessage

                          func (e *InvalidRequestException) ErrorMessage() string

                          type JobDetails

                          type JobDetails struct {
                          
                          	// The number of documents that could not be processed during a translation job.
                          	DocumentsWithErrorsCount *int32
                          
                          	// The number of documents used as input in a translation job.
                          	InputDocumentsCount *int32
                          
                          	// The number of documents successfully processed during a translation job.
                          	TranslatedDocumentsCount *int32
                          }

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

                            type JobStatus

                            type JobStatus string
                            const (
                            	JobStatusSubmitted          JobStatus = "SUBMITTED"
                            	JobStatusInProgress         JobStatus = "IN_PROGRESS"
                            	JobStatusCompleted          JobStatus = "COMPLETED"
                            	JobStatusCompletedWithError JobStatus = "COMPLETED_WITH_ERROR"
                            	JobStatusFailed             JobStatus = "FAILED"
                            	JobStatusStopRequested      JobStatus = "STOP_REQUESTED"
                            	JobStatusStopped            JobStatus = "STOPPED"
                            )

                              Enum values for JobStatus

                              func (JobStatus) Values

                              func (JobStatus) Values() []JobStatus

                                Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                type LimitExceededException

                                type LimitExceededException struct {
                                	Message *string
                                }

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

                                  func (*LimitExceededException) Error

                                  func (e *LimitExceededException) Error() string

                                  func (*LimitExceededException) ErrorCode

                                  func (e *LimitExceededException) ErrorCode() string

                                  func (*LimitExceededException) ErrorFault

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

                                  func (*LimitExceededException) ErrorMessage

                                  func (e *LimitExceededException) ErrorMessage() string

                                  type MergeStrategy

                                  type MergeStrategy string
                                  const (
                                  	MergeStrategyOverwrite MergeStrategy = "OVERWRITE"
                                  )

                                    Enum values for MergeStrategy

                                    func (MergeStrategy) Values

                                    func (MergeStrategy) Values() []MergeStrategy

                                      Values returns all known values for MergeStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                      type OutputDataConfig

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

                                        The output configuration properties for a batch translation job.

                                        type ParallelDataConfig

                                        type ParallelDataConfig struct {
                                        
                                        	// The format of the parallel data input file.
                                        	//
                                        	// This member is required.
                                        	Format ParallelDataFormat
                                        
                                        	// The URI of the Amazon S3 folder that contains the parallel data input file. The
                                        	// folder must be in the same Region as the API endpoint you are calling.
                                        	//
                                        	// This member is required.
                                        	S3Uri *string
                                        }

                                          Specifies the format and S3 location of the parallel data input file.

                                          type ParallelDataDataLocation

                                          type ParallelDataDataLocation struct {
                                          
                                          	// The Amazon S3 location of the parallel data input file. The location is returned
                                          	// as a presigned URL to that has a 30 minute expiration.
                                          	//
                                          	// This member is required.
                                          	Location *string
                                          
                                          	// Describes the repository that contains the parallel data input file.
                                          	//
                                          	// This member is required.
                                          	RepositoryType *string
                                          }

                                            The location of the most recent parallel data input file that was successfully imported into Amazon Translate.

                                            type ParallelDataFormat

                                            type ParallelDataFormat string
                                            const (
                                            	ParallelDataFormatTsv ParallelDataFormat = "TSV"
                                            	ParallelDataFormatCsv ParallelDataFormat = "CSV"
                                            	ParallelDataFormatTmx ParallelDataFormat = "TMX"
                                            )

                                              Enum values for ParallelDataFormat

                                              func (ParallelDataFormat) Values

                                                Values returns all known values for ParallelDataFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                type ParallelDataProperties

                                                type ParallelDataProperties struct {
                                                
                                                	// The Amazon Resource Name (ARN) of the parallel data resource.
                                                	Arn *string
                                                
                                                	// The time at which the parallel data resource was created.
                                                	CreatedAt *time.Time
                                                
                                                	// The description assigned to the parallel data resource.
                                                	Description *string
                                                
                                                	// The encryption key used to encrypt this object.
                                                	EncryptionKey *EncryptionKey
                                                
                                                	// The number of records unsuccessfully imported from the parallel data input file.
                                                	FailedRecordCount *int64
                                                
                                                	// The number of UTF-8 characters that Amazon Translate imported from the parallel
                                                	// data input file. This number includes only the characters in your translation
                                                	// examples. It does not include characters that are used to format your file. For
                                                	// example, if you provided a Translation Memory Exchange (.tmx) file, this number
                                                	// does not include the tags.
                                                	ImportedDataSize *int64
                                                
                                                	// The number of records successfully imported from the parallel data input file.
                                                	ImportedRecordCount *int64
                                                
                                                	// The time at which the parallel data resource was last updated.
                                                	LastUpdatedAt *time.Time
                                                
                                                	// The time that the most recent update was attempted.
                                                	LatestUpdateAttemptAt *time.Time
                                                
                                                	// The status of the most recent update attempt for the parallel data resource.
                                                	LatestUpdateAttemptStatus ParallelDataStatus
                                                
                                                	// Additional information from Amazon Translate about the parallel data resource.
                                                	Message *string
                                                
                                                	// The custom name assigned to the parallel data resource.
                                                	Name *string
                                                
                                                	// Specifies the format and S3 location of the parallel data input file.
                                                	ParallelDataConfig *ParallelDataConfig
                                                
                                                	// The number of items in the input file that Amazon Translate skipped when you
                                                	// created or updated the parallel data resource. For example, Amazon Translate
                                                	// skips empty records, empty target texts, and empty lines.
                                                	SkippedRecordCount *int64
                                                
                                                	// The source language of the translations in the parallel data file.
                                                	SourceLanguageCode *string
                                                
                                                	// The status of the parallel data resource. When the parallel data is ready for
                                                	// you to use, the status is ACTIVE.
                                                	Status ParallelDataStatus
                                                
                                                	// The language codes for the target languages available in the parallel data file.
                                                	// All possible target languages are returned as an array.
                                                	TargetLanguageCodes []string
                                                }

                                                  The properties of a parallel data resource.

                                                  type ParallelDataStatus

                                                  type ParallelDataStatus string
                                                  const (
                                                  	ParallelDataStatusCreating ParallelDataStatus = "CREATING"
                                                  	ParallelDataStatusUpdating ParallelDataStatus = "UPDATING"
                                                  	ParallelDataStatusActive   ParallelDataStatus = "ACTIVE"
                                                  	ParallelDataStatusDeleting ParallelDataStatus = "DELETING"
                                                  	ParallelDataStatusFailed   ParallelDataStatus = "FAILED"
                                                  )

                                                    Enum values for ParallelDataStatus

                                                    func (ParallelDataStatus) Values

                                                      Values returns all known values for ParallelDataStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                      type ResourceNotFoundException

                                                      type ResourceNotFoundException struct {
                                                      	Message *string
                                                      }

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

                                                        func (e *ResourceNotFoundException) Error() string

                                                        func (*ResourceNotFoundException) ErrorCode

                                                        func (e *ResourceNotFoundException) ErrorCode() string

                                                        func (*ResourceNotFoundException) ErrorFault

                                                        func (*ResourceNotFoundException) ErrorMessage

                                                        func (e *ResourceNotFoundException) ErrorMessage() string

                                                        type ServiceUnavailableException

                                                        type ServiceUnavailableException struct {
                                                        	Message *string
                                                        }

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

                                                          func (*ServiceUnavailableException) Error

                                                          func (*ServiceUnavailableException) ErrorCode

                                                          func (e *ServiceUnavailableException) ErrorCode() string

                                                          func (*ServiceUnavailableException) ErrorFault

                                                          func (*ServiceUnavailableException) ErrorMessage

                                                          func (e *ServiceUnavailableException) ErrorMessage() string

                                                          type Term

                                                          type Term struct {
                                                          
                                                          	// The source text of the term being translated by the custom terminology.
                                                          	SourceText *string
                                                          
                                                          	// The target text of the term being translated by the custom terminology.
                                                          	TargetText *string
                                                          }

                                                            The term being translated by the custom terminology.

                                                            type TerminologyData

                                                            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.
                                                            	//
                                                            	// This member is required.
                                                            	File []byte
                                                            
                                                            	// The data format of the custom terminology. Either CSV or TMX.
                                                            	//
                                                            	// This member is required.
                                                            	Format TerminologyDataFormat
                                                            }

                                                              The data associated with the custom terminology.

                                                              type TerminologyDataFormat

                                                              type TerminologyDataFormat string
                                                              const (
                                                              	TerminologyDataFormatCsv TerminologyDataFormat = "CSV"
                                                              	TerminologyDataFormatTmx TerminologyDataFormat = "TMX"
                                                              )

                                                                Enum values for TerminologyDataFormat

                                                                func (TerminologyDataFormat) Values

                                                                  Values returns all known values for TerminologyDataFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                  type TerminologyDataLocation

                                                                  type TerminologyDataLocation struct {
                                                                  
                                                                  	// The location of the custom terminology data.
                                                                  	//
                                                                  	// This member is required.
                                                                  	Location *string
                                                                  
                                                                  	// The repository type for the custom terminology data.
                                                                  	//
                                                                  	// This member is required.
                                                                  	RepositoryType *string
                                                                  }

                                                                    The location of the custom terminology data.

                                                                    type TerminologyProperties

                                                                    type TerminologyProperties struct {
                                                                    
                                                                    	// The Amazon Resource Name (ARN) of the custom terminology.
                                                                    	Arn *string
                                                                    
                                                                    	// The time at which the custom terminology was created, based on the timestamp.
                                                                    	CreatedAt *time.Time
                                                                    
                                                                    	// The description of the custom terminology properties.
                                                                    	Description *string
                                                                    
                                                                    	// The encryption key for the custom terminology.
                                                                    	EncryptionKey *EncryptionKey
                                                                    
                                                                    	// The time at which the custom terminology was last update, based on the
                                                                    	// timestamp.
                                                                    	LastUpdatedAt *time.Time
                                                                    
                                                                    	// The name of the custom terminology.
                                                                    	Name *string
                                                                    
                                                                    	// The size of the file used when importing a custom terminology.
                                                                    	SizeBytes *int32
                                                                    
                                                                    	// The language code for the source text of the translation request for which the
                                                                    	// custom terminology is being used.
                                                                    	SourceLanguageCode *string
                                                                    
                                                                    	// The language codes for the target languages available with the custom
                                                                    	// terminology file. All possible target languages are returned in array.
                                                                    	TargetLanguageCodes []string
                                                                    
                                                                    	// The number of terms included in the custom terminology.
                                                                    	TermCount *int32
                                                                    }

                                                                      The properties of the custom terminology.

                                                                      type TextSizeLimitExceededException

                                                                      type TextSizeLimitExceededException struct {
                                                                      	Message *string
                                                                      }

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

                                                                        func (*TextSizeLimitExceededException) ErrorCode

                                                                        func (e *TextSizeLimitExceededException) ErrorCode() string

                                                                        func (*TextSizeLimitExceededException) ErrorFault

                                                                        func (*TextSizeLimitExceededException) ErrorMessage

                                                                        func (e *TextSizeLimitExceededException) ErrorMessage() string

                                                                        type TextTranslationJobFilter

                                                                        type TextTranslationJobFilter struct {
                                                                        
                                                                        	// Filters the list of jobs by name.
                                                                        	JobName *string
                                                                        
                                                                        	// Filters the list of jobs based by job status.
                                                                        	JobStatus 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
                                                                        
                                                                        	// 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
                                                                        }

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

                                                                          type TextTranslationJobProperties

                                                                          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
                                                                          
                                                                          	// The time at which the translation job ended.
                                                                          	EndTime *time.Time
                                                                          
                                                                          	// The input configuration properties that were specified when the job was
                                                                          	// requested.
                                                                          	InputDataConfig *InputDataConfig
                                                                          
                                                                          	// The number of documents successfully and unsuccessfully processed during the
                                                                          	// translation job.
                                                                          	JobDetails *JobDetails
                                                                          
                                                                          	// The ID of the translation job.
                                                                          	JobId *string
                                                                          
                                                                          	// The user-defined name of the translation job.
                                                                          	JobName *string
                                                                          
                                                                          	// The status of the translation job.
                                                                          	JobStatus JobStatus
                                                                          
                                                                          	// An explanation of any errors that may have occured during the translation job.
                                                                          	Message *string
                                                                          
                                                                          	// The output configuration properties that were specified when the job was
                                                                          	// requested.
                                                                          	OutputDataConfig *OutputDataConfig
                                                                          
                                                                          	// A list containing the names of the parallel data resources applied to the
                                                                          	// translation job.
                                                                          	ParallelDataNames []string
                                                                          
                                                                          	// The language code of the language of the source text. The language must be a
                                                                          	// language supported by Amazon Translate.
                                                                          	SourceLanguageCode *string
                                                                          
                                                                          	// The time at which the translation job was submitted.
                                                                          	SubmittedTime *time.Time
                                                                          
                                                                          	// The language code of the language of the target text. The language must be a
                                                                          	// language supported by Amazon Translate.
                                                                          	TargetLanguageCodes []string
                                                                          
                                                                          	// 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
                                                                          }

                                                                            Provides information about a translation job.

                                                                            type TooManyRequestsException

                                                                            type TooManyRequestsException struct {
                                                                            	Message *string
                                                                            }

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

                                                                              func (e *TooManyRequestsException) Error() string

                                                                              func (*TooManyRequestsException) ErrorCode

                                                                              func (e *TooManyRequestsException) ErrorCode() string

                                                                              func (*TooManyRequestsException) ErrorFault

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

                                                                              func (*TooManyRequestsException) ErrorMessage

                                                                              func (e *TooManyRequestsException) ErrorMessage() string

                                                                              type UnsupportedLanguagePairException

                                                                              type UnsupportedLanguagePairException struct {
                                                                              	Message *string
                                                                              
                                                                              	SourceLanguageCode *string
                                                                              	TargetLanguageCode *string
                                                                              }

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

                                                                                func (*UnsupportedLanguagePairException) ErrorCode

                                                                                func (*UnsupportedLanguagePairException) ErrorFault

                                                                                func (*UnsupportedLanguagePairException) ErrorMessage

                                                                                func (e *UnsupportedLanguagePairException) ErrorMessage() string