translate

package
v0.19.0 Latest Latest
Warning

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

Go to latest
Published: Jan 30, 2020 License: Apache-2.0 Imports: 7 Imported by: 31

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 use 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 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 (
	ServiceName = "Amazon Translate" // Service's name
	ServiceID   = "Translate"        // Service's identifier
	EndpointsID = "translate"        // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AppliedTerminology added in v0.6.0

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) String added in v0.6.0

func (s AppliedTerminology) String() string

String returns the string representation

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

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

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := translate.New(myConfig)

func (*Client) DeleteTerminologyRequest added in v0.9.0

func (c *Client) DeleteTerminologyRequest(input *DeleteTerminologyInput) DeleteTerminologyRequest

DeleteTerminologyRequest returns a request value for making API operation for Amazon Translate.

A synchronous action that deletes a custom terminology.

// Example sending a request using DeleteTerminologyRequest.
req := client.DeleteTerminologyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeTextTranslationJobRequest added in v0.19.0

func (c *Client) DescribeTextTranslationJobRequest(input *DescribeTextTranslationJobInput) DescribeTextTranslationJobRequest

DescribeTextTranslationJobRequest returns a request value for making 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.

// Example sending a request using DescribeTextTranslationJobRequest.
req := client.DescribeTextTranslationJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetTerminologyRequest added in v0.9.0

func (c *Client) GetTerminologyRequest(input *GetTerminologyInput) GetTerminologyRequest

GetTerminologyRequest returns a request value for making API operation for Amazon Translate.

Retrieves a custom terminology.

// Example sending a request using GetTerminologyRequest.
req := client.GetTerminologyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ImportTerminologyRequest added in v0.9.0

func (c *Client) ImportTerminologyRequest(input *ImportTerminologyInput) ImportTerminologyRequest

ImportTerminologyRequest returns a request value for making 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.

// Example sending a request using ImportTerminologyRequest.
req := client.ImportTerminologyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTerminologiesRequest added in v0.9.0

func (c *Client) ListTerminologiesRequest(input *ListTerminologiesInput) ListTerminologiesRequest

ListTerminologiesRequest returns a request value for making API operation for Amazon Translate.

Provides a list of custom terminologies associated with your account.

// Example sending a request using ListTerminologiesRequest.
req := client.ListTerminologiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTextTranslationJobsRequest added in v0.19.0

func (c *Client) ListTextTranslationJobsRequest(input *ListTextTranslationJobsInput) ListTextTranslationJobsRequest

ListTextTranslationJobsRequest returns a request value for making API operation for Amazon Translate.

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

// Example sending a request using ListTextTranslationJobsRequest.
req := client.ListTextTranslationJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) StartTextTranslationJobRequest added in v0.19.0

func (c *Client) StartTextTranslationJobRequest(input *StartTextTranslationJobInput) StartTextTranslationJobRequest

StartTextTranslationJobRequest returns a request value for making 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.

// Example sending a request using StartTextTranslationJobRequest.
req := client.StartTextTranslationJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) StopTextTranslationJobRequest added in v0.19.0

func (c *Client) StopTextTranslationJobRequest(input *StopTextTranslationJobInput) StopTextTranslationJobRequest

StopTextTranslationJobRequest returns a request value for making 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.

// Example sending a request using StopTextTranslationJobRequest.
req := client.StopTextTranslationJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TranslateTextRequest added in v0.9.0

func (c *Client) TranslateTextRequest(input *TranslateTextInput) TranslateTextRequest

TranslateTextRequest returns a request value for making 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.

// Example sending a request using TranslateTextRequest.
req := client.TranslateTextRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/TranslateText

type DeleteTerminologyInput added in v0.6.0

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) String added in v0.6.0

func (s DeleteTerminologyInput) String() string

String returns the string representation

func (*DeleteTerminologyInput) Validate added in v0.6.0

func (s *DeleteTerminologyInput) Validate() error

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

type DeleteTerminologyOutput added in v0.6.0

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

func (DeleteTerminologyOutput) String added in v0.6.0

func (s DeleteTerminologyOutput) String() string

String returns the string representation

type DeleteTerminologyRequest added in v0.6.0

type DeleteTerminologyRequest struct {
	*aws.Request
	Input *DeleteTerminologyInput
	Copy  func(*DeleteTerminologyInput) DeleteTerminologyRequest
}

DeleteTerminologyRequest is the request type for the DeleteTerminology API operation.

func (DeleteTerminologyRequest) Send added in v0.6.0

Send marshals and sends the DeleteTerminology API request.

type DeleteTerminologyResponse added in v0.9.0

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

DeleteTerminologyResponse is the response type for the DeleteTerminology API operation.

func (*DeleteTerminologyResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteTerminologyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteTerminology request.

type DescribeTextTranslationJobInput added in v0.19.0

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) String added in v0.19.0

String returns the string representation

func (*DescribeTextTranslationJobInput) Validate added in v0.19.0

func (s *DescribeTextTranslationJobInput) Validate() error

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

type DescribeTextTranslationJobOutput added in v0.19.0

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) String added in v0.19.0

String returns the string representation

type DescribeTextTranslationJobRequest added in v0.19.0

type DescribeTextTranslationJobRequest struct {
	*aws.Request
	Input *DescribeTextTranslationJobInput
	Copy  func(*DescribeTextTranslationJobInput) DescribeTextTranslationJobRequest
}

DescribeTextTranslationJobRequest is the request type for the DescribeTextTranslationJob API operation.

func (DescribeTextTranslationJobRequest) Send added in v0.19.0

Send marshals and sends the DescribeTextTranslationJob API request.

type DescribeTextTranslationJobResponse added in v0.19.0

type DescribeTextTranslationJobResponse struct {
	*DescribeTextTranslationJobOutput
	// contains filtered or unexported fields
}

DescribeTextTranslationJobResponse is the response type for the DescribeTextTranslationJob API operation.

func (*DescribeTextTranslationJobResponse) SDKResponseMetdata added in v0.19.0

func (r *DescribeTextTranslationJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTextTranslationJob request.

type EncryptionKey added in v0.6.0

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 EncryptionKeyType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

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

func (EncryptionKey) String added in v0.6.0

func (s EncryptionKey) String() string

String returns the string representation

func (*EncryptionKey) Validate added in v0.6.0

func (s *EncryptionKey) Validate() error

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

type EncryptionKeyType added in v0.6.0

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

Enum values for EncryptionKeyType

func (EncryptionKeyType) MarshalValue added in v0.6.0

func (enum EncryptionKeyType) MarshalValue() (string, error)

func (EncryptionKeyType) MarshalValueBuf added in v0.6.0

func (enum EncryptionKeyType) MarshalValueBuf(b []byte) ([]byte, error)

type GetTerminologyInput added in v0.6.0

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 TerminologyDataFormat `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (GetTerminologyInput) String added in v0.6.0

func (s GetTerminologyInput) String() string

String returns the string representation

func (*GetTerminologyInput) Validate added in v0.6.0

func (s *GetTerminologyInput) Validate() error

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

type GetTerminologyOutput added in v0.6.0

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) String added in v0.6.0

func (s GetTerminologyOutput) String() string

String returns the string representation

type GetTerminologyRequest added in v0.6.0

type GetTerminologyRequest struct {
	*aws.Request
	Input *GetTerminologyInput
	Copy  func(*GetTerminologyInput) GetTerminologyRequest
}

GetTerminologyRequest is the request type for the GetTerminology API operation.

func (GetTerminologyRequest) Send added in v0.6.0

Send marshals and sends the GetTerminology API request.

type GetTerminologyResponse added in v0.9.0

type GetTerminologyResponse struct {
	*GetTerminologyOutput
	// contains filtered or unexported fields
}

GetTerminologyResponse is the response type for the GetTerminology API operation.

func (*GetTerminologyResponse) SDKResponseMetdata added in v0.9.0

func (r *GetTerminologyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTerminology request.

type ImportTerminologyInput added in v0.6.0

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 MergeStrategy `type:"string" required:"true" enum:"true"`

	// 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) String added in v0.6.0

func (s ImportTerminologyInput) String() string

String returns the string representation

func (*ImportTerminologyInput) Validate added in v0.6.0

func (s *ImportTerminologyInput) Validate() error

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

type ImportTerminologyOutput added in v0.6.0

type ImportTerminologyOutput struct {

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

func (ImportTerminologyOutput) String added in v0.6.0

func (s ImportTerminologyOutput) String() string

String returns the string representation

type ImportTerminologyRequest added in v0.6.0

type ImportTerminologyRequest struct {
	*aws.Request
	Input *ImportTerminologyInput
	Copy  func(*ImportTerminologyInput) ImportTerminologyRequest
}

ImportTerminologyRequest is the request type for the ImportTerminology API operation.

func (ImportTerminologyRequest) Send added in v0.6.0

Send marshals and sends the ImportTerminology API request.

type ImportTerminologyResponse added in v0.9.0

type ImportTerminologyResponse struct {
	*ImportTerminologyOutput
	// contains filtered or unexported fields
}

ImportTerminologyResponse is the response type for the ImportTerminology API operation.

func (*ImportTerminologyResponse) SDKResponseMetdata added in v0.9.0

func (r *ImportTerminologyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ImportTerminology request.

type InputDataConfig added in v0.19.0

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) String added in v0.19.0

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate added in v0.19.0

func (s *InputDataConfig) Validate() error

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

type JobDetails added in v0.19.0

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) String added in v0.19.0

func (s JobDetails) String() string

String returns the string representation

type JobStatus added in v0.19.0

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) MarshalValue added in v0.19.0

func (enum JobStatus) MarshalValue() (string, error)

func (JobStatus) MarshalValueBuf added in v0.19.0

func (enum JobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type ListTerminologiesInput added in v0.6.0

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) String added in v0.6.0

func (s ListTerminologiesInput) String() string

String returns the string representation

func (*ListTerminologiesInput) Validate added in v0.6.0

func (s *ListTerminologiesInput) Validate() error

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

type ListTerminologiesOutput added in v0.6.0

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) String added in v0.6.0

func (s ListTerminologiesOutput) String() string

String returns the string representation

type ListTerminologiesPaginator added in v0.19.0

type ListTerminologiesPaginator struct {
	aws.Pager
}

ListTerminologiesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTerminologiesPaginator added in v0.19.0

func NewListTerminologiesPaginator(req ListTerminologiesRequest) ListTerminologiesPaginator

NewListTerminologiesRequestPaginator returns a paginator for ListTerminologies. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListTerminologiesRequest(input)
p := translate.NewListTerminologiesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTerminologiesPaginator) CurrentPage added in v0.19.0

type ListTerminologiesRequest added in v0.6.0

type ListTerminologiesRequest struct {
	*aws.Request
	Input *ListTerminologiesInput
	Copy  func(*ListTerminologiesInput) ListTerminologiesRequest
}

ListTerminologiesRequest is the request type for the ListTerminologies API operation.

func (ListTerminologiesRequest) Send added in v0.6.0

Send marshals and sends the ListTerminologies API request.

type ListTerminologiesResponse added in v0.9.0

type ListTerminologiesResponse struct {
	*ListTerminologiesOutput
	// contains filtered or unexported fields
}

ListTerminologiesResponse is the response type for the ListTerminologies API operation.

func (*ListTerminologiesResponse) SDKResponseMetdata added in v0.9.0

func (r *ListTerminologiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTerminologies request.

type ListTextTranslationJobsInput added in v0.19.0

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) String added in v0.19.0

String returns the string representation

func (*ListTextTranslationJobsInput) Validate added in v0.19.0

func (s *ListTextTranslationJobsInput) Validate() error

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

type ListTextTranslationJobsOutput added in v0.19.0

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) String added in v0.19.0

String returns the string representation

type ListTextTranslationJobsPaginator added in v0.19.0

type ListTextTranslationJobsPaginator struct {
	aws.Pager
}

ListTextTranslationJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTextTranslationJobsPaginator added in v0.19.0

func NewListTextTranslationJobsPaginator(req ListTextTranslationJobsRequest) ListTextTranslationJobsPaginator

NewListTextTranslationJobsRequestPaginator returns a paginator for ListTextTranslationJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListTextTranslationJobsRequest(input)
p := translate.NewListTextTranslationJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTextTranslationJobsPaginator) CurrentPage added in v0.19.0

type ListTextTranslationJobsRequest added in v0.19.0

type ListTextTranslationJobsRequest struct {
	*aws.Request
	Input *ListTextTranslationJobsInput
	Copy  func(*ListTextTranslationJobsInput) ListTextTranslationJobsRequest
}

ListTextTranslationJobsRequest is the request type for the ListTextTranslationJobs API operation.

func (ListTextTranslationJobsRequest) Send added in v0.19.0

Send marshals and sends the ListTextTranslationJobs API request.

type ListTextTranslationJobsResponse added in v0.19.0

type ListTextTranslationJobsResponse struct {
	*ListTextTranslationJobsOutput
	// contains filtered or unexported fields
}

ListTextTranslationJobsResponse is the response type for the ListTextTranslationJobs API operation.

func (*ListTextTranslationJobsResponse) SDKResponseMetdata added in v0.19.0

func (r *ListTextTranslationJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTextTranslationJobs request.

type MergeStrategy added in v0.6.0

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

Enum values for MergeStrategy

func (MergeStrategy) MarshalValue added in v0.6.0

func (enum MergeStrategy) MarshalValue() (string, error)

func (MergeStrategy) MarshalValueBuf added in v0.6.0

func (enum MergeStrategy) MarshalValueBuf(b []byte) ([]byte, error)

type OutputDataConfig added in v0.19.0

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) String added in v0.19.0

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate added in v0.19.0

func (s *OutputDataConfig) Validate() error

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

type StartTextTranslationJobInput added in v0.19.0

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 is a required field
	ClientToken *string `min:"1" type:"string" required:"true" 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) String added in v0.19.0

String returns the string representation

func (*StartTextTranslationJobInput) Validate added in v0.19.0

func (s *StartTextTranslationJobInput) Validate() error

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

type StartTextTranslationJobOutput added in v0.19.0

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 JobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (StartTextTranslationJobOutput) String added in v0.19.0

String returns the string representation

type StartTextTranslationJobRequest added in v0.19.0

type StartTextTranslationJobRequest struct {
	*aws.Request
	Input *StartTextTranslationJobInput
	Copy  func(*StartTextTranslationJobInput) StartTextTranslationJobRequest
}

StartTextTranslationJobRequest is the request type for the StartTextTranslationJob API operation.

func (StartTextTranslationJobRequest) Send added in v0.19.0

Send marshals and sends the StartTextTranslationJob API request.

type StartTextTranslationJobResponse added in v0.19.0

type StartTextTranslationJobResponse struct {
	*StartTextTranslationJobOutput
	// contains filtered or unexported fields
}

StartTextTranslationJobResponse is the response type for the StartTextTranslationJob API operation.

func (*StartTextTranslationJobResponse) SDKResponseMetdata added in v0.19.0

func (r *StartTextTranslationJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartTextTranslationJob request.

type StopTextTranslationJobInput added in v0.19.0

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) String added in v0.19.0

String returns the string representation

func (*StopTextTranslationJobInput) Validate added in v0.19.0

func (s *StopTextTranslationJobInput) Validate() error

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

type StopTextTranslationJobOutput added in v0.19.0

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 JobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (StopTextTranslationJobOutput) String added in v0.19.0

String returns the string representation

type StopTextTranslationJobRequest added in v0.19.0

type StopTextTranslationJobRequest struct {
	*aws.Request
	Input *StopTextTranslationJobInput
	Copy  func(*StopTextTranslationJobInput) StopTextTranslationJobRequest
}

StopTextTranslationJobRequest is the request type for the StopTextTranslationJob API operation.

func (StopTextTranslationJobRequest) Send added in v0.19.0

Send marshals and sends the StopTextTranslationJob API request.

type StopTextTranslationJobResponse added in v0.19.0

type StopTextTranslationJobResponse struct {
	*StopTextTranslationJobOutput
	// contains filtered or unexported fields
}

StopTextTranslationJobResponse is the response type for the StopTextTranslationJob API operation.

func (*StopTextTranslationJobResponse) SDKResponseMetdata added in v0.19.0

func (r *StopTextTranslationJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopTextTranslationJob request.

type Term added in v0.6.0

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) String added in v0.6.0

func (s Term) String() string

String returns the string representation

type TerminologyData added in v0.6.0

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 TerminologyDataFormat `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

The data associated with the custom terminology.

func (TerminologyData) String added in v0.6.0

func (s TerminologyData) String() string

String returns the string representation

func (*TerminologyData) Validate added in v0.6.0

func (s *TerminologyData) Validate() error

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

type TerminologyDataFormat added in v0.6.0

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

Enum values for TerminologyDataFormat

func (TerminologyDataFormat) MarshalValue added in v0.6.0

func (enum TerminologyDataFormat) MarshalValue() (string, error)

func (TerminologyDataFormat) MarshalValueBuf added in v0.6.0

func (enum TerminologyDataFormat) MarshalValueBuf(b []byte) ([]byte, error)

type TerminologyDataLocation added in v0.6.0

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) String added in v0.6.0

func (s TerminologyDataLocation) String() string

String returns the string representation

type TerminologyProperties added in v0.6.0

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) String added in v0.6.0

func (s TerminologyProperties) String() string

String returns the string representation

type TextTranslationJobFilter added in v0.19.0

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 JobStatus `type:"string" enum:"true"`

	// 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) String added in v0.19.0

func (s TextTranslationJobFilter) String() string

String returns the string representation

func (*TextTranslationJobFilter) Validate added in v0.19.0

func (s *TextTranslationJobFilter) Validate() error

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

type TextTranslationJobProperties added in v0.19.0

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 JobStatus `type:"string" enum:"true"`

	// 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) String added in v0.19.0

String returns the string representation

type TranslateTextInput added in v0.9.0

type TranslateTextInput 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 (TranslateTextInput) String added in v0.9.0

func (s TranslateTextInput) String() string

String returns the string representation

func (*TranslateTextInput) Validate added in v0.9.0

func (s *TranslateTextInput) Validate() error

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

type TranslateTextOutput added in v0.9.0

type TranslateTextOutput 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 (TranslateTextOutput) String added in v0.9.0

func (s TranslateTextOutput) String() string

String returns the string representation

type TranslateTextRequest added in v0.9.0

type TranslateTextRequest struct {
	*aws.Request
	Input *TranslateTextInput
	Copy  func(*TranslateTextInput) TranslateTextRequest
}

TranslateTextRequest is the request type for the TranslateText API operation.

func (TranslateTextRequest) Send added in v0.9.0

Send marshals and sends the TranslateText API request.

type TranslateTextResponse added in v0.9.0

type TranslateTextResponse struct {
	*TranslateTextOutput
	// contains filtered or unexported fields
}

TranslateTextResponse is the response type for the TranslateText API operation.

func (*TranslateTextResponse) SDKResponseMetdata added in v0.9.0

func (r *TranslateTextResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TranslateText request.

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