translate

Documentation

Overview

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

Provides translation between English and one of six languages, or between one of the six languages and English.

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

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

Using the Client

To contact Amazon Translate with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Translate client Translate for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/translate/#New

Index

• Constants
• type TextInput
  • func (s TextInput) GoString() string
  • func (s *TextInput) SetSourceLanguageCode(v string) *TextInput
  • func (s *TextInput) SetTargetLanguageCode(v string) *TextInput
  • func (s *TextInput) SetText(v string) *TextInput
  • func (s TextInput) String() string
  • func (s *TextInput) Validate() error
• type TextOutput
  • func (s TextOutput) GoString() string
  • func (s *TextOutput) SetSourceLanguageCode(v string) *TextOutput
  • func (s *TextOutput) SetTargetLanguageCode(v string) *TextOutput
  • func (s *TextOutput) SetTranslatedText(v string) *TextOutput
  • func (s TextOutput) String() string
• type Translate
  • func New(p client.ConfigProvider, cfgs ...*aws.Config) *Translate
  • func (c *Translate) Text(input *TextInput) (*TextOutput, error)
  • func (c *Translate) TextRequest(input *TextInput) (req *request.Request, output *TextOutput)
  • func (c *Translate) TextWithContext(ctx aws.Context, input *TextInput, opts ...request.Option) (*TextOutput, error)

Constants

const (

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

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is invalid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// Amazon Translate is unavailable. Retry your request later.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTextSizeLimitExceededException for service response error code
	// "TextSizeLimitExceededException".
	//
	// The size of the input text exceeds the length constraint for the Text field.
	// Try again with a shorter text.
	ErrCodeTextSizeLimitExceededException = "TextSizeLimitExceededException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// The number of requests exceeds the limit. Resubmit your request later.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeUnsupportedLanguagePairException for service response error code
	// "UnsupportedLanguagePairException".
	//
	// Amazon Translate cannot translate input text in the source language into
	// this target language. For more information, see how-to-error-msg.
	ErrCodeUnsupportedLanguagePairException = "UnsupportedLanguagePairException"
)

const (
	ServiceName = "translate" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Types

type TextInput

type TextInput struct {

	// One of the supported language codes for the source text. If the TargetLanguageCode
	// is not "en", the SourceLanguageCode must be "en".
	//
	// SourceLanguageCode is a required field
	SourceLanguageCode *string `min:"2" type:"string" required:"true"`

	// One of the supported language codes for the target text. If the SourceLanguageCode
	// is not "en", the TargetLanguageCode must be "en".
	//
	// TargetLanguageCode is a required field
	TargetLanguageCode *string `min:"2" type:"string" required:"true"`

	// The text to translate.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TextInput) GoString

func (s TextInput) GoString() string

GoString returns the string representation

func (*TextInput) SetSourceLanguageCode

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

SetSourceLanguageCode sets the SourceLanguageCode field's value.

func (*TextInput) SetTargetLanguageCode

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

SetTargetLanguageCode sets the TargetLanguageCode field's value.

func (*TextInput) SetText

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

SetText sets the Text field's value.

func (TextInput) String

func (s TextInput) String() string

String returns the string representation

func (*TextInput) Validate

func (s *TextInput) Validate() error

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

type TextOutput

type TextOutput struct {

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

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

	// The text translated into the target language.
	//
	// TranslatedText is a required field
	TranslatedText *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TextOutput) GoString

func (s TextOutput) GoString() string

GoString returns the string representation

func (*TextOutput) SetSourceLanguageCode

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

SetSourceLanguageCode sets the SourceLanguageCode field's value.

func (*TextOutput) SetTargetLanguageCode

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

SetTargetLanguageCode sets the TargetLanguageCode field's value.

func (*TextOutput) SetTranslatedText

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

SetTranslatedText sets the TranslatedText field's value.

func (TextOutput) String

func (s TextOutput) String() string

String returns the string representation

type Translate

type Translate struct {
	*client.Client
}

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

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

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Translate

New creates a new instance of the Translate client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a Translate client from just a session.
svc := translate.New(mySession)

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

func (*Translate) Text

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

Text API operation for Amazon Translate.

Translates input text from the source language to the target language. You can translate between English (en) and one of the following languages, or between one of the following languages and English.

• Arabic (ar)

• Chinese (Simplified) (zh)

• French (fr)

• German (de)

• Portuguese (pt)

• Spanish (es)

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

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

Returned Error Codes:

• ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

• ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the length constraint for the Text field. Try again with a shorter text.

• ErrCodeTooManyRequestsException "TooManyRequestsException" The number of requests exceeds the limit. Resubmit your request later.

• ErrCodeUnsupportedLanguagePairException "UnsupportedLanguagePairException" Amazon Translate cannot translate input text in the source language into this target language. For more information, see how-to-error-msg.

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

• ErrCodeServiceUnavailableException "ServiceUnavailableException" Amazon Translate is unavailable. Retry your request later.

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

func (*Translate) TextRequest

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

TextRequest generates a "aws/request.Request" representing the client's request for the Text operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Text for more information on using the Text API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TextRequest method.
req, resp := client.TextRequest(params)

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

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

func (*Translate) TextWithContext

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

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

See Text for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.