comprehend

package
v1.14.27-0...-ebc1ea8 Latest Latest
Warning

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

 Go to latest Published: Jul 12, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package comprehend provides the client and types for making API requests to Amazon Comprehend.

Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

See https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (
	// EntityTypePerson is a EntityType enum value
	EntityTypePerson = "PERSON"

	// EntityTypeLocation is a EntityType enum value
	EntityTypeLocation = "LOCATION"

	// EntityTypeOrganization is a EntityType enum value
	EntityTypeOrganization = "ORGANIZATION"

	// EntityTypeCommercialItem is a EntityType enum value
	EntityTypeCommercialItem = "COMMERCIAL_ITEM"

	// EntityTypeEvent is a EntityType enum value
	EntityTypeEvent = "EVENT"

	// EntityTypeDate is a EntityType enum value
	EntityTypeDate = "DATE"

	// EntityTypeQuantity is a EntityType enum value
	EntityTypeQuantity = "QUANTITY"

	// EntityTypeTitle is a EntityType enum value
	EntityTypeTitle = "TITLE"

	// EntityTypeOther is a EntityType enum value
	EntityTypeOther = "OTHER"
)
View Source 
const (
	// InputFormatOneDocPerFile is a InputFormat enum value
	InputFormatOneDocPerFile = "ONE_DOC_PER_FILE"

	// InputFormatOneDocPerLine is a InputFormat enum value
	InputFormatOneDocPerLine = "ONE_DOC_PER_LINE"
)
View Source 
const (
	// JobStatusSubmitted is a JobStatus enum value
	JobStatusSubmitted = "SUBMITTED"

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

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

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

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

	// JobStatusStopped is a JobStatus enum value
	JobStatusStopped = "STOPPED"
)
View Source 
const (
	// LanguageCodeEn is a LanguageCode enum value
	LanguageCodeEn = "en"

	// LanguageCodeEs is a LanguageCode enum value
	LanguageCodeEs = "es"
)
View Source 
const (
	// SentimentTypePositive is a SentimentType enum value
	SentimentTypePositive = "POSITIVE"

	// SentimentTypeNegative is a SentimentType enum value
	SentimentTypeNegative = "NEGATIVE"

	// SentimentTypeNeutral is a SentimentType enum value
	SentimentTypeNeutral = "NEUTRAL"

	// SentimentTypeMixed is a SentimentType enum value
	SentimentTypeMixed = "MIXED"
)
View Source 
const (

	// ErrCodeBatchSizeLimitExceededException for service response error code
	// "BatchSizeLimitExceededException".
	//
	// The number of documents in the request exceeds the limit of 25. Try your
	// request again with fewer documents.
	ErrCodeBatchSizeLimitExceededException = "BatchSizeLimitExceededException"

	// 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 ListTopicDetectionJobs operation is invalid.
	// Specify a different filter.
	ErrCodeInvalidFilterException = "InvalidFilterException"

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

	// ErrCodeJobNotFoundException for service response error code
	// "JobNotFoundException".
	//
	// The specified job was not found. Check the job ID and try again.
	ErrCodeJobNotFoundException = "JobNotFoundException"

	// ErrCodeTextSizeLimitExceededException for service response error code
	// "TextSizeLimitExceededException".
	//
	// The size of the input text exceeds the limit. Use a smaller document.
	ErrCodeTextSizeLimitExceededException = "TextSizeLimitExceededException"

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

	// ErrCodeUnsupportedLanguageException for service response error code
	// "UnsupportedLanguageException".
	//
	// Amazon Comprehend can't process the language of the input text. For all APIs
	// except DetectDominantLanguage, Amazon Comprehend accepts only English or
	// Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
	// 100 languages. For a list of languages, see how-languages
	ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException"
)
View Source 
const (
	ServiceName = "comprehend" // Name of service.
	EndpointsID = ServiceName  // ID to lookup a service endpoint with.
	ServiceID   = "Comprehend" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchDetectDominantLanguageInput 

type BatchDetectDominantLanguageInput struct {

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document should contain at least 20 characters
	// and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectDominantLanguageInput) GoString 

func (s BatchDetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageInput) SetTextList 

func (s *BatchDetectDominantLanguageInput) SetTextList(v []*string) *BatchDetectDominantLanguageInput

SetTextList sets the TextList field's value.

func (BatchDetectDominantLanguageInput) String 

func (s BatchDetectDominantLanguageInput) String() string

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate 

func (s *BatchDetectDominantLanguageInput) Validate() error

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

type BatchDetectDominantLanguageItemResult 

type BatchDetectDominantLanguageItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`

	// One or more DominantLanguage objects describing the dominant languages in
	// the document.
	Languages []*DominantLanguage `type:"list"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

func (BatchDetectDominantLanguageItemResult) GoString 

func (s BatchDetectDominantLanguageItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageItemResult) SetIndex 

func (s *BatchDetectDominantLanguageItemResult) SetIndex(v int64) *BatchDetectDominantLanguageItemResult

SetIndex sets the Index field's value.

func (*BatchDetectDominantLanguageItemResult) SetLanguages 

func (s *BatchDetectDominantLanguageItemResult) SetLanguages(v []*DominantLanguage) *BatchDetectDominantLanguageItemResult

SetLanguages sets the Languages field's value.

func (BatchDetectDominantLanguageItemResult) String 

func (s BatchDetectDominantLanguageItemResult) String() string

String returns the string representation

type BatchDetectDominantLanguageOutput 

type BatchDetectDominantLanguageOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []*BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []*BatchDetectDominantLanguageItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectDominantLanguageOutput) GoString 

func (s BatchDetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageOutput) SetErrorList 

func (s *BatchDetectDominantLanguageOutput) SetErrorList(v []*BatchItemError) *BatchDetectDominantLanguageOutput

SetErrorList sets the ErrorList field's value.

func (*BatchDetectDominantLanguageOutput) SetResultList 

func (s *BatchDetectDominantLanguageOutput) SetResultList(v []*BatchDetectDominantLanguageItemResult) *BatchDetectDominantLanguageOutput

SetResultList sets the ResultList field's value.

func (BatchDetectDominantLanguageOutput) String 

func (s BatchDetectDominantLanguageOutput) String() string

String returns the string representation

type BatchDetectEntitiesInput 

type BatchDetectEntitiesInput struct {

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer than 5,000 bytes
	// of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectEntitiesInput) GoString 

func (s BatchDetectEntitiesInput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesInput) SetLanguageCode 

func (s *BatchDetectEntitiesInput) SetLanguageCode(v string) *BatchDetectEntitiesInput

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectEntitiesInput) SetTextList 

func (s *BatchDetectEntitiesInput) SetTextList(v []*string) *BatchDetectEntitiesInput

SetTextList sets the TextList field's value.

func (BatchDetectEntitiesInput) String 

func (s BatchDetectEntitiesInput) String() string

String returns the string representation

func (*BatchDetectEntitiesInput) Validate 

func (s *BatchDetectEntitiesInput) Validate() error

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

type BatchDetectEntitiesItemResult 

type BatchDetectEntitiesItemResult struct {

	// One or more Entity objects, one for each entity detected in the document.
	Entities []*Entity `type:"list"`

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

func (BatchDetectEntitiesItemResult) GoString 

func (s BatchDetectEntitiesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesItemResult) SetEntities 

func (s *BatchDetectEntitiesItemResult) SetEntities(v []*Entity) *BatchDetectEntitiesItemResult

SetEntities sets the Entities field's value.

func (*BatchDetectEntitiesItemResult) SetIndex 

func (s *BatchDetectEntitiesItemResult) SetIndex(v int64) *BatchDetectEntitiesItemResult

SetIndex sets the Index field's value.

func (BatchDetectEntitiesItemResult) String 

func (s BatchDetectEntitiesItemResult) String() string

String returns the string representation

type BatchDetectEntitiesOutput 

type BatchDetectEntitiesOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []*BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []*BatchDetectEntitiesItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectEntitiesOutput) GoString 

func (s BatchDetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesOutput) SetErrorList 

func (s *BatchDetectEntitiesOutput) SetErrorList(v []*BatchItemError) *BatchDetectEntitiesOutput

SetErrorList sets the ErrorList field's value.

func (*BatchDetectEntitiesOutput) SetResultList 

func (s *BatchDetectEntitiesOutput) SetResultList(v []*BatchDetectEntitiesItemResult) *BatchDetectEntitiesOutput

SetResultList sets the ResultList field's value.

func (BatchDetectEntitiesOutput) String 

func (s BatchDetectEntitiesOutput) String() string

String returns the string representation

type BatchDetectKeyPhrasesInput 

type BatchDetectKeyPhrasesInput struct {

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer that 5,000 bytes
	// of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectKeyPhrasesInput) GoString 

func (s BatchDetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesInput) SetLanguageCode 

func (s *BatchDetectKeyPhrasesInput) SetLanguageCode(v string) *BatchDetectKeyPhrasesInput

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectKeyPhrasesInput) SetTextList 

func (s *BatchDetectKeyPhrasesInput) SetTextList(v []*string) *BatchDetectKeyPhrasesInput

SetTextList sets the TextList field's value.

func (BatchDetectKeyPhrasesInput) String 

func (s BatchDetectKeyPhrasesInput) String() string

String returns the string representation

func (*BatchDetectKeyPhrasesInput) Validate 

func (s *BatchDetectKeyPhrasesInput) Validate() error

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

type BatchDetectKeyPhrasesItemResult 

type BatchDetectKeyPhrasesItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`

	// One or more KeyPhrase objects, one for each key phrase detected in the document.
	KeyPhrases []*KeyPhrase `type:"list"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

func (BatchDetectKeyPhrasesItemResult) GoString 

func (s BatchDetectKeyPhrasesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesItemResult) SetIndex 

func (s *BatchDetectKeyPhrasesItemResult) SetIndex(v int64) *BatchDetectKeyPhrasesItemResult

SetIndex sets the Index field's value.

func (*BatchDetectKeyPhrasesItemResult) SetKeyPhrases 

func (s *BatchDetectKeyPhrasesItemResult) SetKeyPhrases(v []*KeyPhrase) *BatchDetectKeyPhrasesItemResult

SetKeyPhrases sets the KeyPhrases field's value.

func (BatchDetectKeyPhrasesItemResult) String 

func (s BatchDetectKeyPhrasesItemResult) String() string

String returns the string representation

type BatchDetectKeyPhrasesOutput 

type BatchDetectKeyPhrasesOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []*BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []*BatchDetectKeyPhrasesItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectKeyPhrasesOutput) GoString 

func (s BatchDetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesOutput) SetErrorList 

func (s *BatchDetectKeyPhrasesOutput) SetErrorList(v []*BatchItemError) *BatchDetectKeyPhrasesOutput

SetErrorList sets the ErrorList field's value.

func (*BatchDetectKeyPhrasesOutput) SetResultList 

func (s *BatchDetectKeyPhrasesOutput) SetResultList(v []*BatchDetectKeyPhrasesItemResult) *BatchDetectKeyPhrasesOutput

SetResultList sets the ResultList field's value.

func (BatchDetectKeyPhrasesOutput) String 

func (s BatchDetectKeyPhrasesOutput) String() string

String returns the string representation

type BatchDetectSentimentInput 

type BatchDetectSentimentInput struct {

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer that 5,000 bytes
	// of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectSentimentInput) GoString 

func (s BatchDetectSentimentInput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentInput) SetLanguageCode 

func (s *BatchDetectSentimentInput) SetLanguageCode(v string) *BatchDetectSentimentInput

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSentimentInput) SetTextList 

func (s *BatchDetectSentimentInput) SetTextList(v []*string) *BatchDetectSentimentInput

SetTextList sets the TextList field's value.

func (BatchDetectSentimentInput) String 

func (s BatchDetectSentimentInput) String() string

String returns the string representation

func (*BatchDetectSentimentInput) Validate 

func (s *BatchDetectSentimentInput) Validate() error

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

type BatchDetectSentimentItemResult 

type BatchDetectSentimentItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`

	// The sentiment detected in the document.
	Sentiment *string `type:"string" enum:"SentimentType"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// sentiment detection.
	SentimentScore *SentimentScore `type:"structure"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

func (BatchDetectSentimentItemResult) GoString 

func (s BatchDetectSentimentItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentItemResult) SetIndex 

func (s *BatchDetectSentimentItemResult) SetIndex(v int64) *BatchDetectSentimentItemResult

SetIndex sets the Index field's value.

func (*BatchDetectSentimentItemResult) SetSentiment 

func (s *BatchDetectSentimentItemResult) SetSentiment(v string) *BatchDetectSentimentItemResult

SetSentiment sets the Sentiment field's value.

func (*BatchDetectSentimentItemResult) SetSentimentScore 

func (s *BatchDetectSentimentItemResult) SetSentimentScore(v *SentimentScore) *BatchDetectSentimentItemResult

SetSentimentScore sets the SentimentScore field's value.

func (BatchDetectSentimentItemResult) String 

func (s BatchDetectSentimentItemResult) String() string

String returns the string representation

type BatchDetectSentimentOutput 

type BatchDetectSentimentOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []*BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []*BatchDetectSentimentItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectSentimentOutput) GoString 

func (s BatchDetectSentimentOutput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentOutput) SetErrorList 

func (s *BatchDetectSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectSentimentOutput

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSentimentOutput) SetResultList 

func (s *BatchDetectSentimentOutput) SetResultList(v []*BatchDetectSentimentItemResult) *BatchDetectSentimentOutput

SetResultList sets the ResultList field's value.

func (BatchDetectSentimentOutput) String 

func (s BatchDetectSentimentOutput) String() string

String returns the string representation

type BatchItemError 

type BatchItemError struct {

	// The numeric error code of the error.
	ErrorCode *string `min:"1" type:"string"`

	// A text description of the error.
	ErrorMessage *string `min:"1" type:"string"`

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

func (BatchItemError) GoString 

func (s BatchItemError) GoString() string

GoString returns the string representation

func (*BatchItemError) SetErrorCode 

func (s *BatchItemError) SetErrorCode(v string) *BatchItemError

SetErrorCode sets the ErrorCode field's value.

func (*BatchItemError) SetErrorMessage 

func (s *BatchItemError) SetErrorMessage(v string) *BatchItemError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchItemError) SetIndex 

func (s *BatchItemError) SetIndex(v int64) *BatchItemError

SetIndex sets the Index field's value.

func (BatchItemError) String 

func (s BatchItemError) String() string

String returns the string representation

type Comprehend 

type Comprehend struct {
	*client.Client
}

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

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

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

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

func (*Comprehend) BatchDetectDominantLanguage 

func (c *Comprehend) BatchDetectDominantLanguage(input *BatchDetectDominantLanguageInput) (*BatchDetectDominantLanguageOutput, error)

BatchDetectDominantLanguage API operation for Amazon Comprehend.

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html).

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

  • ErrCodeBatchSizeLimitExceededException "BatchSizeLimitExceededException" The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguage

func (*Comprehend) BatchDetectDominantLanguageRequest 

func (c *Comprehend) BatchDetectDominantLanguageRequest(input *BatchDetectDominantLanguageInput) (req *request.Request, output *BatchDetectDominantLanguageOutput)

BatchDetectDominantLanguageRequest generates a "aws/request.Request" representing the client's request for the BatchDetectDominantLanguage operation. The "output" return value will be populated with the request's response once the request completes 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 BatchDetectDominantLanguage for more information on using the BatchDetectDominantLanguage 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 BatchDetectDominantLanguageRequest method.
req, resp := client.BatchDetectDominantLanguageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguage

func (*Comprehend) BatchDetectDominantLanguageWithContext 

func (c *Comprehend) BatchDetectDominantLanguageWithContext(ctx aws.Context, input *BatchDetectDominantLanguageInput, opts ...request.Option) (*BatchDetectDominantLanguageOutput, error)

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

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

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

func (*Comprehend) BatchDetectEntities 

func (c *Comprehend) BatchDetectEntities(input *BatchDetectEntitiesInput) (*BatchDetectEntitiesOutput, error)

BatchDetectEntities API operation for Amazon Comprehend.

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

  • ErrCodeBatchSizeLimitExceededException "BatchSizeLimitExceededException" The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntities

func (*Comprehend) BatchDetectEntitiesRequest 

func (c *Comprehend) BatchDetectEntitiesRequest(input *BatchDetectEntitiesInput) (req *request.Request, output *BatchDetectEntitiesOutput)

BatchDetectEntitiesRequest generates a "aws/request.Request" representing the client's request for the BatchDetectEntities operation. The "output" return value will be populated with the request's response once the request completes 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 BatchDetectEntities for more information on using the BatchDetectEntities 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 BatchDetectEntitiesRequest method.
req, resp := client.BatchDetectEntitiesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntities

func (*Comprehend) BatchDetectEntitiesWithContext 

func (c *Comprehend) BatchDetectEntitiesWithContext(ctx aws.Context, input *BatchDetectEntitiesInput, opts ...request.Option) (*BatchDetectEntitiesOutput, error)

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

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

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

func (*Comprehend) BatchDetectKeyPhrases 

func (c *Comprehend) BatchDetectKeyPhrases(input *BatchDetectKeyPhrasesInput) (*BatchDetectKeyPhrasesOutput, error)

BatchDetectKeyPhrases API operation for Amazon Comprehend.

Detects the key noun phrases found in a batch of documents.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

  • ErrCodeBatchSizeLimitExceededException "BatchSizeLimitExceededException" The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrases

func (*Comprehend) BatchDetectKeyPhrasesRequest 

func (c *Comprehend) BatchDetectKeyPhrasesRequest(input *BatchDetectKeyPhrasesInput) (req *request.Request, output *BatchDetectKeyPhrasesOutput)

BatchDetectKeyPhrasesRequest generates a "aws/request.Request" representing the client's request for the BatchDetectKeyPhrases operation. The "output" return value will be populated with the request's response once the request completes 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 BatchDetectKeyPhrases for more information on using the BatchDetectKeyPhrases 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 BatchDetectKeyPhrasesRequest method.
req, resp := client.BatchDetectKeyPhrasesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrases

func (*Comprehend) BatchDetectKeyPhrasesWithContext 

func (c *Comprehend) BatchDetectKeyPhrasesWithContext(ctx aws.Context, input *BatchDetectKeyPhrasesInput, opts ...request.Option) (*BatchDetectKeyPhrasesOutput, error)

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

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

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

func (*Comprehend) BatchDetectSentiment 

func (c *Comprehend) BatchDetectSentiment(input *BatchDetectSentimentInput) (*BatchDetectSentimentOutput, error)

BatchDetectSentiment API operation for Amazon Comprehend.

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

  • ErrCodeBatchSizeLimitExceededException "BatchSizeLimitExceededException" The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentiment

func (*Comprehend) BatchDetectSentimentRequest 

func (c *Comprehend) BatchDetectSentimentRequest(input *BatchDetectSentimentInput) (req *request.Request, output *BatchDetectSentimentOutput)

BatchDetectSentimentRequest generates a "aws/request.Request" representing the client's request for the BatchDetectSentiment operation. The "output" return value will be populated with the request's response once the request completes 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 BatchDetectSentiment for more information on using the BatchDetectSentiment 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 BatchDetectSentimentRequest method.
req, resp := client.BatchDetectSentimentRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentiment

func (*Comprehend) BatchDetectSentimentWithContext 

func (c *Comprehend) BatchDetectSentimentWithContext(ctx aws.Context, input *BatchDetectSentimentInput, opts ...request.Option) (*BatchDetectSentimentOutput, error)

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

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

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

func (*Comprehend) DescribeDominantLanguageDetectionJob 

func (c *Comprehend) DescribeDominantLanguageDetectionJob(input *DescribeDominantLanguageDetectionJobInput) (*DescribeDominantLanguageDetectionJobOutput, error)

DescribeDominantLanguageDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob

func (*Comprehend) DescribeDominantLanguageDetectionJobRequest 

func (c *Comprehend) DescribeDominantLanguageDetectionJobRequest(input *DescribeDominantLanguageDetectionJobInput) (req *request.Request, output *DescribeDominantLanguageDetectionJobOutput)

DescribeDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 DescribeDominantLanguageDetectionJob for more information on using the DescribeDominantLanguageDetectionJob 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 DescribeDominantLanguageDetectionJobRequest method.
req, resp := client.DescribeDominantLanguageDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob

func (*Comprehend) DescribeDominantLanguageDetectionJobWithContext 

func (c *Comprehend) DescribeDominantLanguageDetectionJobWithContext(ctx aws.Context, input *DescribeDominantLanguageDetectionJobInput, opts ...request.Option) (*DescribeDominantLanguageDetectionJobOutput, error)

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

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

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

func (*Comprehend) DescribeEntitiesDetectionJob 

func (c *Comprehend) DescribeEntitiesDetectionJob(input *DescribeEntitiesDetectionJobInput) (*DescribeEntitiesDetectionJobOutput, error)

DescribeEntitiesDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob

func (*Comprehend) DescribeEntitiesDetectionJobRequest 

func (c *Comprehend) DescribeEntitiesDetectionJobRequest(input *DescribeEntitiesDetectionJobInput) (req *request.Request, output *DescribeEntitiesDetectionJobOutput)

DescribeEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 DescribeEntitiesDetectionJob for more information on using the DescribeEntitiesDetectionJob 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 DescribeEntitiesDetectionJobRequest method.
req, resp := client.DescribeEntitiesDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob

func (*Comprehend) DescribeEntitiesDetectionJobWithContext 

func (c *Comprehend) DescribeEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribeEntitiesDetectionJobInput, opts ...request.Option) (*DescribeEntitiesDetectionJobOutput, error)

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

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

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

func (*Comprehend) DescribeKeyPhrasesDetectionJob 

func (c *Comprehend) DescribeKeyPhrasesDetectionJob(input *DescribeKeyPhrasesDetectionJobInput) (*DescribeKeyPhrasesDetectionJobOutput, error)

DescribeKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob

func (*Comprehend) DescribeKeyPhrasesDetectionJobRequest 

func (c *Comprehend) DescribeKeyPhrasesDetectionJobRequest(input *DescribeKeyPhrasesDetectionJobInput) (req *request.Request, output *DescribeKeyPhrasesDetectionJobOutput)

DescribeKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 DescribeKeyPhrasesDetectionJob for more information on using the DescribeKeyPhrasesDetectionJob 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 DescribeKeyPhrasesDetectionJobRequest method.
req, resp := client.DescribeKeyPhrasesDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob

func (*Comprehend) DescribeKeyPhrasesDetectionJobWithContext 

func (c *Comprehend) DescribeKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *DescribeKeyPhrasesDetectionJobInput, opts ...request.Option) (*DescribeKeyPhrasesDetectionJobOutput, error)

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

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

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

func (*Comprehend) DescribeSentimentDetectionJob 

func (c *Comprehend) DescribeSentimentDetectionJob(input *DescribeSentimentDetectionJobInput) (*DescribeSentimentDetectionJobOutput, error)

DescribeSentimentDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob

func (*Comprehend) DescribeSentimentDetectionJobRequest 

func (c *Comprehend) DescribeSentimentDetectionJobRequest(input *DescribeSentimentDetectionJobInput) (req *request.Request, output *DescribeSentimentDetectionJobOutput)

DescribeSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 DescribeSentimentDetectionJob for more information on using the DescribeSentimentDetectionJob 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 DescribeSentimentDetectionJobRequest method.
req, resp := client.DescribeSentimentDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob

func (*Comprehend) DescribeSentimentDetectionJobWithContext 

func (c *Comprehend) DescribeSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeSentimentDetectionJobInput, opts ...request.Option) (*DescribeSentimentDetectionJobOutput, error)

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

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

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

func (*Comprehend) DescribeTopicsDetectionJob 

func (c *Comprehend) DescribeTopicsDetectionJob(input *DescribeTopicsDetectionJobInput) (*DescribeTopicsDetectionJobOutput, error)

DescribeTopicsDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob

func (*Comprehend) DescribeTopicsDetectionJobRequest 

func (c *Comprehend) DescribeTopicsDetectionJobRequest(input *DescribeTopicsDetectionJobInput) (req *request.Request, output *DescribeTopicsDetectionJobOutput)

DescribeTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 DescribeTopicsDetectionJob for more information on using the DescribeTopicsDetectionJob 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 DescribeTopicsDetectionJobRequest method.
req, resp := client.DescribeTopicsDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob

func (*Comprehend) DescribeTopicsDetectionJobWithContext 

func (c *Comprehend) DescribeTopicsDetectionJobWithContext(ctx aws.Context, input *DescribeTopicsDetectionJobInput, opts ...request.Option) (*DescribeTopicsDetectionJobOutput, error)

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

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

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

func (*Comprehend) DetectDominantLanguage 

func (c *Comprehend) DetectDominantLanguage(input *DetectDominantLanguageInput) (*DetectDominantLanguageOutput, error)

DetectDominantLanguage API operation for Amazon Comprehend.

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html).

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage

func (*Comprehend) DetectDominantLanguageRequest 

func (c *Comprehend) DetectDominantLanguageRequest(input *DetectDominantLanguageInput) (req *request.Request, output *DetectDominantLanguageOutput)

DetectDominantLanguageRequest generates a "aws/request.Request" representing the client's request for the DetectDominantLanguage operation. The "output" return value will be populated with the request's response once the request completes 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 DetectDominantLanguage for more information on using the DetectDominantLanguage 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 DetectDominantLanguageRequest method.
req, resp := client.DetectDominantLanguageRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage

func (*Comprehend) DetectDominantLanguageWithContext 

func (c *Comprehend) DetectDominantLanguageWithContext(ctx aws.Context, input *DetectDominantLanguageInput, opts ...request.Option) (*DetectDominantLanguageOutput, error)

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

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

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

func (*Comprehend) DetectEntities 

func (c *Comprehend) DetectEntities(input *DetectEntitiesInput) (*DetectEntitiesOutput, error)

DetectEntities API operation for Amazon Comprehend.

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntities

func (*Comprehend) DetectEntitiesRequest 

func (c *Comprehend) DetectEntitiesRequest(input *DetectEntitiesInput) (req *request.Request, output *DetectEntitiesOutput)

DetectEntitiesRequest generates a "aws/request.Request" representing the client's request for the DetectEntities operation. The "output" return value will be populated with the request's response once the request completes 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 DetectEntities for more information on using the DetectEntities 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 DetectEntitiesRequest method.
req, resp := client.DetectEntitiesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntities

func (*Comprehend) DetectEntitiesWithContext 

func (c *Comprehend) DetectEntitiesWithContext(ctx aws.Context, input *DetectEntitiesInput, opts ...request.Option) (*DetectEntitiesOutput, error)

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

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

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

func (*Comprehend) DetectKeyPhrases 

func (c *Comprehend) DetectKeyPhrases(input *DetectKeyPhrasesInput) (*DetectKeyPhrasesOutput, error)

DetectKeyPhrases API operation for Amazon Comprehend.

Detects the key noun phrases found in the text.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrases

func (*Comprehend) DetectKeyPhrasesRequest 

func (c *Comprehend) DetectKeyPhrasesRequest(input *DetectKeyPhrasesInput) (req *request.Request, output *DetectKeyPhrasesOutput)

DetectKeyPhrasesRequest generates a "aws/request.Request" representing the client's request for the DetectKeyPhrases operation. The "output" return value will be populated with the request's response once the request completes 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 DetectKeyPhrases for more information on using the DetectKeyPhrases 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 DetectKeyPhrasesRequest method.
req, resp := client.DetectKeyPhrasesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrases

func (*Comprehend) DetectKeyPhrasesWithContext 

func (c *Comprehend) DetectKeyPhrasesWithContext(ctx aws.Context, input *DetectKeyPhrasesInput, opts ...request.Option) (*DetectKeyPhrasesOutput, error)

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

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

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

func (*Comprehend) DetectSentiment 

func (c *Comprehend) DetectSentiment(input *DetectSentimentInput) (*DetectSentimentOutput, error)

DetectSentiment API operation for Amazon Comprehend.

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException" The size of the input text exceeds the limit. Use a smaller document.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see how-languages

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentiment

func (*Comprehend) DetectSentimentRequest 

func (c *Comprehend) DetectSentimentRequest(input *DetectSentimentInput) (req *request.Request, output *DetectSentimentOutput)

DetectSentimentRequest generates a "aws/request.Request" representing the client's request for the DetectSentiment operation. The "output" return value will be populated with the request's response once the request completes 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 DetectSentiment for more information on using the DetectSentiment 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 DetectSentimentRequest method.
req, resp := client.DetectSentimentRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentiment

func (*Comprehend) DetectSentimentWithContext 

func (c *Comprehend) DetectSentimentWithContext(ctx aws.Context, input *DetectSentimentInput, opts ...request.Option) (*DetectSentimentOutput, error)

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

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

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

func (*Comprehend) ListDominantLanguageDetectionJobs 

func (c *Comprehend) ListDominantLanguageDetectionJobs(input *ListDominantLanguageDetectionJobsInput) (*ListDominantLanguageDetectionJobsOutput, error)

ListDominantLanguageDetectionJobs API operation for Amazon Comprehend.

Gets a list of the dominant language detection jobs that you have submitted.

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

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs

func (*Comprehend) ListDominantLanguageDetectionJobsPages 

func (c *Comprehend) ListDominantLanguageDetectionJobsPages(input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool) error

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

See ListDominantLanguageDetectionJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListDominantLanguageDetectionJobs operation.
pageNum := 0
err := client.ListDominantLanguageDetectionJobsPages(params,
    func(page *ListDominantLanguageDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListDominantLanguageDetectionJobsPagesWithContext 

func (c *Comprehend) ListDominantLanguageDetectionJobsPagesWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListDominantLanguageDetectionJobsPagesWithContext same as ListDominantLanguageDetectionJobsPages except it takes a Context and allows setting request options on the pages.

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

func (*Comprehend) ListDominantLanguageDetectionJobsRequest 

func (c *Comprehend) ListDominantLanguageDetectionJobsRequest(input *ListDominantLanguageDetectionJobsInput) (req *request.Request, output *ListDominantLanguageDetectionJobsOutput)

ListDominantLanguageDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListDominantLanguageDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes 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 ListDominantLanguageDetectionJobs for more information on using the ListDominantLanguageDetectionJobs 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 ListDominantLanguageDetectionJobsRequest method.
req, resp := client.ListDominantLanguageDetectionJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs

func (*Comprehend) ListDominantLanguageDetectionJobsWithContext 

func (c *Comprehend) ListDominantLanguageDetectionJobsWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, opts ...request.Option) (*ListDominantLanguageDetectionJobsOutput, error)

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

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

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

func (*Comprehend) ListEntitiesDetectionJobs 

func (c *Comprehend) ListEntitiesDetectionJobs(input *ListEntitiesDetectionJobsInput) (*ListEntitiesDetectionJobsOutput, error)

ListEntitiesDetectionJobs API operation for Amazon Comprehend.

Gets a list of the entity detection jobs that you have submitted.

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

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs

func (*Comprehend) ListEntitiesDetectionJobsPages 

func (c *Comprehend) ListEntitiesDetectionJobsPages(input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool) error

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

See ListEntitiesDetectionJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListEntitiesDetectionJobs operation.
pageNum := 0
err := client.ListEntitiesDetectionJobsPages(params,
    func(page *ListEntitiesDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListEntitiesDetectionJobsPagesWithContext 

func (c *Comprehend) ListEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListEntitiesDetectionJobsPagesWithContext same as ListEntitiesDetectionJobsPages except it takes a Context and allows setting request options on the pages.

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

func (*Comprehend) ListEntitiesDetectionJobsRequest 

func (c *Comprehend) ListEntitiesDetectionJobsRequest(input *ListEntitiesDetectionJobsInput) (req *request.Request, output *ListEntitiesDetectionJobsOutput)

ListEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListEntitiesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes 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 ListEntitiesDetectionJobs for more information on using the ListEntitiesDetectionJobs 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 ListEntitiesDetectionJobsRequest method.
req, resp := client.ListEntitiesDetectionJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs

func (*Comprehend) ListEntitiesDetectionJobsWithContext 

func (c *Comprehend) ListEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, opts ...request.Option) (*ListEntitiesDetectionJobsOutput, error)

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

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

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

func (*Comprehend) ListKeyPhrasesDetectionJobs 

func (c *Comprehend) ListKeyPhrasesDetectionJobs(input *ListKeyPhrasesDetectionJobsInput) (*ListKeyPhrasesDetectionJobsOutput, error)

ListKeyPhrasesDetectionJobs API operation for Amazon Comprehend.

Get a list of key phrase detection jobs that you have submitted.

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

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs

func (*Comprehend) ListKeyPhrasesDetectionJobsPages 

func (c *Comprehend) ListKeyPhrasesDetectionJobsPages(input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool) error

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

See ListKeyPhrasesDetectionJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListKeyPhrasesDetectionJobs operation.
pageNum := 0
err := client.ListKeyPhrasesDetectionJobsPages(params,
    func(page *ListKeyPhrasesDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext 

func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListKeyPhrasesDetectionJobsPagesWithContext same as ListKeyPhrasesDetectionJobsPages except it takes a Context and allows setting request options on the pages.

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

func (*Comprehend) ListKeyPhrasesDetectionJobsRequest 

func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDetectionJobsInput) (req *request.Request, output *ListKeyPhrasesDetectionJobsOutput)

ListKeyPhrasesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListKeyPhrasesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes 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 ListKeyPhrasesDetectionJobs for more information on using the ListKeyPhrasesDetectionJobs 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 ListKeyPhrasesDetectionJobsRequest method.
req, resp := client.ListKeyPhrasesDetectionJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs

func (*Comprehend) ListKeyPhrasesDetectionJobsWithContext 

func (c *Comprehend) ListKeyPhrasesDetectionJobsWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, opts ...request.Option) (*ListKeyPhrasesDetectionJobsOutput, error)

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

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

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

func (*Comprehend) ListSentimentDetectionJobs 

func (c *Comprehend) ListSentimentDetectionJobs(input *ListSentimentDetectionJobsInput) (*ListSentimentDetectionJobsOutput, error)

ListSentimentDetectionJobs API operation for Amazon Comprehend.

Gets a list of sentiment detection jobs that you have submitted.

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

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs

func (*Comprehend) ListSentimentDetectionJobsPages 

func (c *Comprehend) ListSentimentDetectionJobsPages(input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool) error

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

See ListSentimentDetectionJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListSentimentDetectionJobs operation.
pageNum := 0
err := client.ListSentimentDetectionJobsPages(params,
    func(page *ListSentimentDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListSentimentDetectionJobsPagesWithContext 

func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListSentimentDetectionJobsPagesWithContext same as ListSentimentDetectionJobsPages except it takes a Context and allows setting request options on the pages.

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

func (*Comprehend) ListSentimentDetectionJobsRequest 

func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) (req *request.Request, output *ListSentimentDetectionJobsOutput)

ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListSentimentDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes 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 ListSentimentDetectionJobs for more information on using the ListSentimentDetectionJobs 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 ListSentimentDetectionJobsRequest method.
req, resp := client.ListSentimentDetectionJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs

func (*Comprehend) ListSentimentDetectionJobsWithContext 

func (c *Comprehend) ListSentimentDetectionJobsWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, opts ...request.Option) (*ListSentimentDetectionJobsOutput, error)

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

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

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

func (*Comprehend) ListTopicsDetectionJobs 

func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error)

ListTopicsDetectionJobs API operation for Amazon Comprehend.

Gets a list of the topic detection jobs that you have submitted.

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

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs

func (*Comprehend) ListTopicsDetectionJobsPages 

func (c *Comprehend) ListTopicsDetectionJobsPages(input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool) error

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

See ListTopicsDetectionJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListTopicsDetectionJobs operation.
pageNum := 0
err := client.ListTopicsDetectionJobsPages(params,
    func(page *ListTopicsDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListTopicsDetectionJobsPagesWithContext 

func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListTopicsDetectionJobsPagesWithContext same as ListTopicsDetectionJobsPages except it takes a Context and allows setting request options on the pages.

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

func (*Comprehend) ListTopicsDetectionJobsRequest 

func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput)

ListTopicsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTopicsDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes 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 ListTopicsDetectionJobs for more information on using the ListTopicsDetectionJobs 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 ListTopicsDetectionJobsRequest method.
req, resp := client.ListTopicsDetectionJobsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs

func (*Comprehend) ListTopicsDetectionJobsWithContext 

func (c *Comprehend) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error)

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

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

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

func (*Comprehend) StartDominantLanguageDetectionJob 

func (c *Comprehend) StartDominantLanguageDetectionJob(input *StartDominantLanguageDetectionJobInput) (*StartDominantLanguageDetectionJobOutput, error)

StartDominantLanguageDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob

func (*Comprehend) StartDominantLanguageDetectionJobRequest 

func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) (req *request.Request, output *StartDominantLanguageDetectionJobOutput)

StartDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StartDominantLanguageDetectionJob for more information on using the StartDominantLanguageDetectionJob 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 StartDominantLanguageDetectionJobRequest method.
req, resp := client.StartDominantLanguageDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob

func (*Comprehend) StartDominantLanguageDetectionJobWithContext 

func (c *Comprehend) StartDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StartDominantLanguageDetectionJobInput, opts ...request.Option) (*StartDominantLanguageDetectionJobOutput, error)

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

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

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

func (*Comprehend) StartEntitiesDetectionJob 

func (c *Comprehend) StartEntitiesDetectionJob(input *StartEntitiesDetectionJobInput) (*StartEntitiesDetectionJobOutput, error)

StartEntitiesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob

func (*Comprehend) StartEntitiesDetectionJobRequest 

func (c *Comprehend) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) (req *request.Request, output *StartEntitiesDetectionJobOutput)

StartEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StartEntitiesDetectionJob for more information on using the StartEntitiesDetectionJob 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 StartEntitiesDetectionJobRequest method.
req, resp := client.StartEntitiesDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob

func (*Comprehend) StartEntitiesDetectionJobWithContext 

func (c *Comprehend) StartEntitiesDetectionJobWithContext(ctx aws.Context, input *StartEntitiesDetectionJobInput, opts ...request.Option) (*StartEntitiesDetectionJobOutput, error)

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

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

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

func (*Comprehend) StartKeyPhrasesDetectionJob 

func (c *Comprehend) StartKeyPhrasesDetectionJob(input *StartKeyPhrasesDetectionJobInput) (*StartKeyPhrasesDetectionJobOutput, error)

StartKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob

func (*Comprehend) StartKeyPhrasesDetectionJobRequest 

func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) (req *request.Request, output *StartKeyPhrasesDetectionJobOutput)

StartKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StartKeyPhrasesDetectionJob for more information on using the StartKeyPhrasesDetectionJob 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 StartKeyPhrasesDetectionJobRequest method.
req, resp := client.StartKeyPhrasesDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob

func (*Comprehend) StartKeyPhrasesDetectionJobWithContext 

func (c *Comprehend) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StartKeyPhrasesDetectionJobInput, opts ...request.Option) (*StartKeyPhrasesDetectionJobOutput, error)

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

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

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

func (*Comprehend) StartSentimentDetectionJob 

func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error)

StartSentimentDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob

func (*Comprehend) StartSentimentDetectionJobRequest 

func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput)

StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob 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 StartSentimentDetectionJobRequest method.
req, resp := client.StartSentimentDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob

func (*Comprehend) StartSentimentDetectionJobWithContext 

func (c *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error)

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

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

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

func (*Comprehend) StartTopicsDetectionJob 

func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error)

StartTopicsDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob

func (*Comprehend) StartTopicsDetectionJobRequest 

func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput)

StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob 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 StartTopicsDetectionJobRequest method.
req, resp := client.StartTopicsDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob

func (*Comprehend) StartTopicsDetectionJobWithContext 

func (c *Comprehend) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error)

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

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

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

func (*Comprehend) StopDominantLanguageDetectionJob 

func (c *Comprehend) StopDominantLanguageDetectionJob(input *StopDominantLanguageDetectionJobInput) (*StopDominantLanguageDetectionJobOutput, error)

StopDominantLanguageDetectionJob API operation for Amazon Comprehend.

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.

When a job is stopped, any document that has already been processed will be written to the output location.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob

func (*Comprehend) StopDominantLanguageDetectionJobRequest 

func (c *Comprehend) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) (req *request.Request, output *StopDominantLanguageDetectionJobOutput)

StopDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StopDominantLanguageDetectionJob for more information on using the StopDominantLanguageDetectionJob 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 StopDominantLanguageDetectionJobRequest method.
req, resp := client.StopDominantLanguageDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob

func (*Comprehend) StopDominantLanguageDetectionJobWithContext 

func (c *Comprehend) StopDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StopDominantLanguageDetectionJobInput, opts ...request.Option) (*StopDominantLanguageDetectionJobOutput, error)

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

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

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

func (*Comprehend) StopEntitiesDetectionJob 

func (c *Comprehend) StopEntitiesDetectionJob(input *StopEntitiesDetectionJobInput) (*StopEntitiesDetectionJobOutput, error)

StopEntitiesDetectionJob API operation for Amazon Comprehend.

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.

When a job is stopped, any document that has already been processed will be written to the output location.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob

func (*Comprehend) StopEntitiesDetectionJobRequest 

func (c *Comprehend) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) (req *request.Request, output *StopEntitiesDetectionJobOutput)

StopEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StopEntitiesDetectionJob for more information on using the StopEntitiesDetectionJob 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 StopEntitiesDetectionJobRequest method.
req, resp := client.StopEntitiesDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob

func (*Comprehend) StopEntitiesDetectionJobWithContext 

func (c *Comprehend) StopEntitiesDetectionJobWithContext(ctx aws.Context, input *StopEntitiesDetectionJobInput, opts ...request.Option) (*StopEntitiesDetectionJobOutput, error)

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

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

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

func (*Comprehend) StopKeyPhrasesDetectionJob 

func (c *Comprehend) StopKeyPhrasesDetectionJob(input *StopKeyPhrasesDetectionJobInput) (*StopKeyPhrasesDetectionJobOutput, error)

StopKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.

When a job is stopped, any document that has already been processed will be written to the output location.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob

func (*Comprehend) StopKeyPhrasesDetectionJobRequest 

func (c *Comprehend) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) (req *request.Request, output *StopKeyPhrasesDetectionJobOutput)

StopKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StopKeyPhrasesDetectionJob for more information on using the StopKeyPhrasesDetectionJob 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 StopKeyPhrasesDetectionJobRequest method.
req, resp := client.StopKeyPhrasesDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob

func (*Comprehend) StopKeyPhrasesDetectionJobWithContext 

func (c *Comprehend) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StopKeyPhrasesDetectionJobInput, opts ...request.Option) (*StopKeyPhrasesDetectionJobOutput, error)

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

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

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

func (*Comprehend) StopSentimentDetectionJob 

func (c *Comprehend) StopSentimentDetectionJob(input *StopSentimentDetectionJobInput) (*StopSentimentDetectionJobOutput, error)

StopSentimentDetectionJob API operation for Amazon Comprehend.

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS the job will be marked for termination and put into the STOPPING state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation will return a 400 Internal Request Exception.

When a job is stopped, any document that has already been processed will be written to the output location.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeJobNotFoundException "JobNotFoundException" The specified job was not found. Check the job ID and try again.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob

func (*Comprehend) StopSentimentDetectionJobRequest 

func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) (req *request.Request, output *StopSentimentDetectionJobOutput)

StopSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes 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 StopSentimentDetectionJob for more information on using the StopSentimentDetectionJob 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 StopSentimentDetectionJobRequest method.
req, resp := client.StopSentimentDetectionJobRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob

func (*Comprehend) StopSentimentDetectionJobWithContext 

func (c *Comprehend) StopSentimentDetectionJobWithContext(ctx aws.Context, input *StopSentimentDetectionJobInput, opts ...request.Option) (*StopSentimentDetectionJobOutput, error)

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

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

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

type DescribeDominantLanguageDetectionJobInput 

type DescribeDominantLanguageDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The 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 (DescribeDominantLanguageDetectionJobInput) GoString 

func (s DescribeDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) SetJobId 

func (s *DescribeDominantLanguageDetectionJobInput) SetJobId(v string) *DescribeDominantLanguageDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeDominantLanguageDetectionJobInput) String 

func (s DescribeDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) Validate 

func (s *DescribeDominantLanguageDetectionJobInput) Validate() error

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

type DescribeDominantLanguageDetectionJobOutput 

type DescribeDominantLanguageDetectionJobOutput struct {

	// An object that contains the properties associated with a dominant language
	// detection job.
	DominantLanguageDetectionJobProperties *DominantLanguageDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDominantLanguageDetectionJobOutput) GoString 

func (s DescribeDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties 

func (s *DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties(v *DominantLanguageDetectionJobProperties) *DescribeDominantLanguageDetectionJobOutput

SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value.

func (DescribeDominantLanguageDetectionJobOutput) String 

func (s DescribeDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type DescribeEntitiesDetectionJobInput 

type DescribeEntitiesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The 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 (DescribeEntitiesDetectionJobInput) GoString 

func (s DescribeEntitiesDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionJobInput) SetJobId 

func (s *DescribeEntitiesDetectionJobInput) SetJobId(v string) *DescribeEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionJobInput) String 

func (s DescribeEntitiesDetectionJobInput) String() string

String returns the string representation

func (*DescribeEntitiesDetectionJobInput) Validate 

func (s *DescribeEntitiesDetectionJobInput) Validate() error

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

type DescribeEntitiesDetectionJobOutput 

type DescribeEntitiesDetectionJobOutput struct {

	// An object that contains the properties associated with an entities detection
	// job.
	EntitiesDetectionJobProperties *EntitiesDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEntitiesDetectionJobOutput) GoString 

func (s DescribeEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties 

func (s *DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties(v *EntitiesDetectionJobProperties) *DescribeEntitiesDetectionJobOutput

SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value.

func (DescribeEntitiesDetectionJobOutput) String 

func (s DescribeEntitiesDetectionJobOutput) String() string

String returns the string representation

type DescribeKeyPhrasesDetectionJobInput 

type DescribeKeyPhrasesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The 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 (DescribeKeyPhrasesDetectionJobInput) GoString 

func (s DescribeKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) SetJobId 

func (s *DescribeKeyPhrasesDetectionJobInput) SetJobId(v string) *DescribeKeyPhrasesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeKeyPhrasesDetectionJobInput) String 

func (s DescribeKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) Validate 

func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error

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

type DescribeKeyPhrasesDetectionJobOutput 

type DescribeKeyPhrasesDetectionJobOutput struct {

	// An object that contains the properties associated with a key phrases detection
	// job.
	KeyPhrasesDetectionJobProperties *KeyPhrasesDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeKeyPhrasesDetectionJobOutput) GoString 

func (s DescribeKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties 

func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties(v *KeyPhrasesDetectionJobProperties) *DescribeKeyPhrasesDetectionJobOutput

SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value.

func (DescribeKeyPhrasesDetectionJobOutput) String 

func (s DescribeKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type DescribeSentimentDetectionJobInput 

type DescribeSentimentDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The 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 (DescribeSentimentDetectionJobInput) GoString 

func (s DescribeSentimentDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeSentimentDetectionJobInput) SetJobId 

func (s *DescribeSentimentDetectionJobInput) SetJobId(v string) *DescribeSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeSentimentDetectionJobInput) String 

func (s DescribeSentimentDetectionJobInput) String() string

String returns the string representation

func (*DescribeSentimentDetectionJobInput) Validate 

func (s *DescribeSentimentDetectionJobInput) Validate() error

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

type DescribeSentimentDetectionJobOutput 

type DescribeSentimentDetectionJobOutput struct {

	// An object that contains the properties associated with a sentiment detection
	// job.
	SentimentDetectionJobProperties *SentimentDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSentimentDetectionJobOutput) GoString 

func (s DescribeSentimentDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties 

func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties(v *SentimentDetectionJobProperties) *DescribeSentimentDetectionJobOutput

SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value.

func (DescribeSentimentDetectionJobOutput) String 

func (s DescribeSentimentDetectionJobOutput) String() string

String returns the string representation

type DescribeTopicsDetectionJobInput 

type DescribeTopicsDetectionJobInput struct {

	// The identifier assigned by the user to the detection job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobInput) GoString 

func (s DescribeTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobInput) SetJobId 

func (s *DescribeTopicsDetectionJobInput) SetJobId(v string) *DescribeTopicsDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeTopicsDetectionJobInput) String 

func (s DescribeTopicsDetectionJobInput) String() string

String returns the string representation

func (*DescribeTopicsDetectionJobInput) Validate 

func (s *DescribeTopicsDetectionJobInput) Validate() error

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

type DescribeTopicsDetectionJobOutput 

type DescribeTopicsDetectionJobOutput struct {

	// The list of properties for the requested job.
	TopicsDetectionJobProperties *TopicsDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobOutput) GoString 

func (s DescribeTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties 

func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *TopicsDetectionJobProperties) *DescribeTopicsDetectionJobOutput

SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value.

func (DescribeTopicsDetectionJobOutput) String 

func (s DescribeTopicsDetectionJobOutput) String() string

String returns the string representation

type DetectDominantLanguageInput 

type DetectDominantLanguageInput struct {

	// A UTF-8 text string. Each string should contain at least 20 characters and
	// must contain fewer that 5,000 bytes of UTF-8 encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectDominantLanguageInput) GoString 

func (s DetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageInput) SetText 

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

SetText sets the Text field's value.

func (DetectDominantLanguageInput) String 

func (s DetectDominantLanguageInput) String() string

String returns the string representation

func (*DetectDominantLanguageInput) Validate 

func (s *DetectDominantLanguageInput) Validate() error

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

type DetectDominantLanguageOutput 

type DetectDominantLanguageOutput struct {

	// The languages that Amazon Comprehend detected in the input text. For each
	// language, the response returns the RFC 5646 language code and the level of
	// confidence that Amazon Comprehend has in the accuracy of its inference. For
	// more information about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646)
	// on the IETF Tools web site.
	Languages []*DominantLanguage `type:"list"`
	// contains filtered or unexported fields
}

func (DetectDominantLanguageOutput) GoString 

func (s DetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageOutput) SetLanguages 

func (s *DetectDominantLanguageOutput) SetLanguages(v []*DominantLanguage) *DetectDominantLanguageOutput

SetLanguages sets the Languages field's value.

func (DetectDominantLanguageOutput) String 

func (s DetectDominantLanguageOutput) String() string

String returns the string representation

type DetectEntitiesInput 

type DetectEntitiesInput struct {

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectEntitiesInput) GoString 

func (s DetectEntitiesInput) GoString() string

GoString returns the string representation

func (*DetectEntitiesInput) SetLanguageCode 

func (s *DetectEntitiesInput) SetLanguageCode(v string) *DetectEntitiesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectEntitiesInput) SetText 

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

SetText sets the Text field's value.

func (DetectEntitiesInput) String 

func (s DetectEntitiesInput) String() string

String returns the string representation

func (*DetectEntitiesInput) Validate 

func (s *DetectEntitiesInput) Validate() error

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

type DetectEntitiesOutput 

type DetectEntitiesOutput struct {

	// A collection of entities identified in the input text. For each entity, the
	// response provides the entity text, entity type, where the entity text begins
	// and ends, and the level of confidence that Amazon Comprehend has in the detection.
	// For a list of entity types, see how-entities.
	Entities []*Entity `type:"list"`
	// contains filtered or unexported fields
}

func (DetectEntitiesOutput) GoString 

func (s DetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*DetectEntitiesOutput) SetEntities 

func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput

SetEntities sets the Entities field's value.

func (DetectEntitiesOutput) String 

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectKeyPhrasesInput 

type DetectKeyPhrasesInput struct {

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectKeyPhrasesInput) GoString 

func (s DetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesInput) SetLanguageCode 

func (s *DetectKeyPhrasesInput) SetLanguageCode(v string) *DetectKeyPhrasesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectKeyPhrasesInput) SetText 

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

SetText sets the Text field's value.

func (DetectKeyPhrasesInput) String 

func (s DetectKeyPhrasesInput) String() string

String returns the string representation

func (*DetectKeyPhrasesInput) Validate 

func (s *DetectKeyPhrasesInput) Validate() error

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

type DetectKeyPhrasesOutput 

type DetectKeyPhrasesOutput struct {

	// A collection of key phrases that Amazon Comprehend identified in the input
	// text. For each key phrase, the response provides the text of the key phrase,
	// where the key phrase begins and ends, and the level of confidence that Amazon
	// Comprehend has in the accuracy of the detection.
	KeyPhrases []*KeyPhrase `type:"list"`
	// contains filtered or unexported fields
}

func (DetectKeyPhrasesOutput) GoString 

func (s DetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesOutput) SetKeyPhrases 

func (s *DetectKeyPhrasesOutput) SetKeyPhrases(v []*KeyPhrase) *DetectKeyPhrasesOutput

SetKeyPhrases sets the KeyPhrases field's value.

func (DetectKeyPhrasesOutput) String 

func (s DetectKeyPhrasesOutput) String() string

String returns the string representation

type DetectSentimentInput 

type DetectSentimentInput struct {

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectSentimentInput) GoString 

func (s DetectSentimentInput) GoString() string

GoString returns the string representation

func (*DetectSentimentInput) SetLanguageCode 

func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSentimentInput) SetText 

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

SetText sets the Text field's value.

func (DetectSentimentInput) String 

func (s DetectSentimentInput) String() string

String returns the string representation

func (*DetectSentimentInput) Validate 

func (s *DetectSentimentInput) Validate() error

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

type DetectSentimentOutput 

type DetectSentimentOutput struct {

	// The inferred sentiment that Amazon Comprehend has the highest level of confidence
	// in.
	Sentiment *string `type:"string" enum:"SentimentType"`

	// An object that lists the sentiments, and their corresponding confidence levels.
	SentimentScore *SentimentScore `type:"structure"`
	// contains filtered or unexported fields
}

func (DetectSentimentOutput) GoString 

func (s DetectSentimentOutput) GoString() string

GoString returns the string representation

func (*DetectSentimentOutput) SetSentiment 

func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput

SetSentiment sets the Sentiment field's value.

func (*DetectSentimentOutput) SetSentimentScore 

func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput

SetSentimentScore sets the SentimentScore field's value.

func (DetectSentimentOutput) String 

func (s DetectSentimentOutput) String() string

String returns the string representation

type DominantLanguage 

type DominantLanguage struct {

	// The RFC 5646 language code for the dominant language. For more information
	// about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646)
	// on the IETF Tools web site.
	LanguageCode *string `min:"1" type:"string"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

func (DominantLanguage) GoString 

func (s DominantLanguage) GoString() string

GoString returns the string representation

func (*DominantLanguage) SetLanguageCode 

func (s *DominantLanguage) SetLanguageCode(v string) *DominantLanguage

SetLanguageCode sets the LanguageCode field's value.

func (*DominantLanguage) SetScore 

func (s *DominantLanguage) SetScore(v float64) *DominantLanguage

SetScore sets the Score field's value.

func (DominantLanguage) String 

func (s DominantLanguage) String() string

String returns the string representation

type DominantLanguageDetectionJobFilter 

type DominantLanguageDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

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

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (DominantLanguageDetectionJobFilter) GoString 

func (s DominantLanguageDetectionJobFilter) GoString() string

GoString returns the string representation

func (*DominantLanguageDetectionJobFilter) SetJobName 

func (s *DominantLanguageDetectionJobFilter) SetJobName(v string) *DominantLanguageDetectionJobFilter

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobFilter) SetJobStatus 

func (s *DominantLanguageDetectionJobFilter) SetJobStatus(v string) *DominantLanguageDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeAfter 

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeBefore 

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DominantLanguageDetectionJobFilter) String 

func (s DominantLanguageDetectionJobFilter) String() string

String returns the string representation

func (*DominantLanguageDetectionJobFilter) Validate 

func (s *DominantLanguageDetectionJobFilter) Validate() error

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

type DominantLanguageDetectionJobProperties 

type DominantLanguageDetectionJobProperties struct {

	// The time that the dominant language detection job completed.
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The input data configuration that you supplied when you created the dominant
	// language detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the dominant language detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned to the dominant language detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the dominant language detection job. If the status
	// is FAILED, the Message field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// A description for the status of a job.
	Message *string `type:"string"`

	// The output data configuration that you supplied when you created the dominant
	// language detection job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the dominant language detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Provides information about a dominant language detection job.

func (DominantLanguageDetectionJobProperties) GoString 

func (s DominantLanguageDetectionJobProperties) GoString() string

GoString returns the string representation

func (*DominantLanguageDetectionJobProperties) SetEndTime 

func (s *DominantLanguageDetectionJobProperties) SetEndTime(v time.Time) *DominantLanguageDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*DominantLanguageDetectionJobProperties) SetInputDataConfig 

func (s *DominantLanguageDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *DominantLanguageDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetJobId 

func (s *DominantLanguageDetectionJobProperties) SetJobId(v string) *DominantLanguageDetectionJobProperties

SetJobId sets the JobId field's value.

func (*DominantLanguageDetectionJobProperties) SetJobName 

func (s *DominantLanguageDetectionJobProperties) SetJobName(v string) *DominantLanguageDetectionJobProperties

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobProperties) SetJobStatus 

func (s *DominantLanguageDetectionJobProperties) SetJobStatus(v string) *DominantLanguageDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobProperties) SetMessage 

func (s *DominantLanguageDetectionJobProperties) SetMessage(v string) *DominantLanguageDetectionJobProperties

SetMessage sets the Message field's value.

func (*DominantLanguageDetectionJobProperties) SetOutputDataConfig 

func (s *DominantLanguageDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DominantLanguageDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetSubmitTime 

func (s *DominantLanguageDetectionJobProperties) SetSubmitTime(v time.Time) *DominantLanguageDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (DominantLanguageDetectionJobProperties) String 

func (s DominantLanguageDetectionJobProperties) String() string

String returns the string representation

type EntitiesDetectionJobFilter 

type EntitiesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

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

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (EntitiesDetectionJobFilter) GoString 

func (s EntitiesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*EntitiesDetectionJobFilter) SetJobName 

func (s *EntitiesDetectionJobFilter) SetJobName(v string) *EntitiesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobFilter) SetJobStatus 

func (s *EntitiesDetectionJobFilter) SetJobStatus(v string) *EntitiesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeAfter 

func (s *EntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeBefore 

func (s *EntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntitiesDetectionJobFilter) String 

func (s EntitiesDetectionJobFilter) String() string

String returns the string representation

func (*EntitiesDetectionJobFilter) Validate 

func (s *EntitiesDetectionJobFilter) Validate() error

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

type EntitiesDetectionJobProperties 

type EntitiesDetectionJobProperties struct {

	// The time that the entities detection job completed
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The input data configuration that you supplied when you created the entities
	// detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the entities detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned the entities detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the entities detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The language code of the input documents.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// A description of the status of a job.
	Message *string `type:"string"`

	// The output data configuration that you supplied when you created the entities
	// detection job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the entities detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Provides information about an entities detection job.

func (EntitiesDetectionJobProperties) GoString 

func (s EntitiesDetectionJobProperties) GoString() string

GoString returns the string representation

func (*EntitiesDetectionJobProperties) SetEndTime 

func (s *EntitiesDetectionJobProperties) SetEndTime(v time.Time) *EntitiesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*EntitiesDetectionJobProperties) SetInputDataConfig 

func (s *EntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *EntitiesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetJobId 

func (s *EntitiesDetectionJobProperties) SetJobId(v string) *EntitiesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*EntitiesDetectionJobProperties) SetJobName 

func (s *EntitiesDetectionJobProperties) SetJobName(v string) *EntitiesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobProperties) SetJobStatus 

func (s *EntitiesDetectionJobProperties) SetJobStatus(v string) *EntitiesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobProperties) SetLanguageCode 

func (s *EntitiesDetectionJobProperties) SetLanguageCode(v string) *EntitiesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*EntitiesDetectionJobProperties) SetMessage 

func (s *EntitiesDetectionJobProperties) SetMessage(v string) *EntitiesDetectionJobProperties

SetMessage sets the Message field's value.

func (*EntitiesDetectionJobProperties) SetOutputDataConfig 

func (s *EntitiesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *EntitiesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetSubmitTime 

func (s *EntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *EntitiesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (EntitiesDetectionJobProperties) String 

func (s EntitiesDetectionJobProperties) String() string

String returns the string representation

type Entity 

type Entity struct {

	// A character offset in the input text that shows where the entity begins (the
	// first character is at position 0). The offset returns the position of each
	// UTF-8 code point in the string. A code point is the abstract character from
	// a particular graphical representation. For example, a multi-byte UTF-8 character
	// maps to a single code point.
	BeginOffset *int64 `type:"integer"`

	// A character offset in the input text that shows where the entity ends. The
	// offset returns the position of each UTF-8 code point in the string. A code
	// point is the abstract character from a particular graphical representation.
	// For example, a multi-byte UTF-8 character maps to a single code point.
	EndOffset *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`

	// The text of the entity.
	Text *string `min:"1" type:"string"`

	// The entity's type.
	Type *string `type:"string" enum:"EntityType"`
	// contains filtered or unexported fields
}

Provides information about an entity.

func (Entity) GoString 

func (s Entity) GoString() string

GoString returns the string representation

func (*Entity) SetBeginOffset 

func (s *Entity) SetBeginOffset(v int64) *Entity

SetBeginOffset sets the BeginOffset field's value.

func (*Entity) SetEndOffset 

func (s *Entity) SetEndOffset(v int64) *Entity

SetEndOffset sets the EndOffset field's value.

func (*Entity) SetScore 

func (s *Entity) SetScore(v float64) *Entity

SetScore sets the Score field's value.

func (*Entity) SetText 

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

SetText sets the Text field's value.

func (*Entity) SetType 

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

SetType sets the Type field's value.

func (Entity) String 

func (s Entity) String() string

String returns the string representation

type InputDataConfig 

type InputDataConfig struct {

	// Specifies how the text in an input file should be processed:
	//
	//    * ONE_DOC_PER_FILE - Each file is considered a separate document. Use
	//    this option when you are processing large documents, such as newspaper
	//    articles or scientific papers.
	//
	//    * ONE_DOC_PER_LINE - Each line in a file is considered a separate document.
	//    Use this option when you are processing many short documents, such as
	//    text messages.
	InputFormat *string `type:"string" enum:"InputFormat"`

	// The Amazon S3 URI for the input data. The URI must be in same region as the
	// API endpoint that you are calling. The URI can point to a single input file
	// or it can provide the prefix for a collection of data files.
	//
	// For example, if you use the URI S3://bucketName/prefix, if the prefix is
	// a single file, Amazon Comprehend uses that file as input. If more than one
	// file begins with the prefix, Amazon Comprehend uses all of them as input.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input properties for a topic detection job.

func (InputDataConfig) GoString 

func (s InputDataConfig) GoString() string

GoString returns the string representation

func (*InputDataConfig) SetInputFormat 

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

SetInputFormat sets the InputFormat field's value.

func (*InputDataConfig) SetS3Uri 

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

SetS3Uri sets the S3Uri field's value.

func (InputDataConfig) String 

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate 

func (s *InputDataConfig) Validate() error

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

type KeyPhrase 

type KeyPhrase struct {

	// A character offset in the input text that shows where the key phrase begins
	// (the first character is at position 0). The offset returns the position of
	// each UTF-8 code point in the string. A code point is the abstract character
	// from a particular graphical representation. For example, a multi-byte UTF-8
	// character maps to a single code point.
	BeginOffset *int64 `type:"integer"`

	// A character offset in the input text where the key phrase ends. The offset
	// returns the position of each UTF-8 code point in the string. A code point
	// is the abstract character from a particular graphical representation. For
	// example, a multi-byte UTF-8 character maps to a single code point.
	EndOffset *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`

	// The text of a key noun phrase.
	Text *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a key noun phrase.

func (KeyPhrase) GoString 

func (s KeyPhrase) GoString() string

GoString returns the string representation

func (*KeyPhrase) SetBeginOffset 

func (s *KeyPhrase) SetBeginOffset(v int64) *KeyPhrase

SetBeginOffset sets the BeginOffset field's value.

func (*KeyPhrase) SetEndOffset 

func (s *KeyPhrase) SetEndOffset(v int64) *KeyPhrase

SetEndOffset sets the EndOffset field's value.

func (*KeyPhrase) SetScore 

func (s *KeyPhrase) SetScore(v float64) *KeyPhrase

SetScore sets the Score field's value.

func (*KeyPhrase) SetText 

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

SetText sets the Text field's value.

func (KeyPhrase) String 

func (s KeyPhrase) String() string

String returns the string representation

type KeyPhrasesDetectionJobFilter 

type KeyPhrasesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

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

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (KeyPhrasesDetectionJobFilter) GoString 

func (s KeyPhrasesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*KeyPhrasesDetectionJobFilter) SetJobName 

func (s *KeyPhrasesDetectionJobFilter) SetJobName(v string) *KeyPhrasesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobFilter) SetJobStatus 

func (s *KeyPhrasesDetectionJobFilter) SetJobStatus(v string) *KeyPhrasesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeAfter 

func (s *KeyPhrasesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *KeyPhrasesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeBefore 

func (s *KeyPhrasesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *KeyPhrasesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (KeyPhrasesDetectionJobFilter) String 

func (s KeyPhrasesDetectionJobFilter) String() string

String returns the string representation

func (*KeyPhrasesDetectionJobFilter) Validate 

func (s *KeyPhrasesDetectionJobFilter) Validate() error

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

type KeyPhrasesDetectionJobProperties 

type KeyPhrasesDetectionJobProperties struct {

	// The time that the key phrases detection job completed.
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The input data configuration that you supplied when you created the key phrases
	// detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the key phrases detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned the key phrases detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the key phrases detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The language code of the input documents.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// A description of the status of a job.
	Message *string `type:"string"`

	// The output data configuration that you supplied when you created the key
	// phrases detection job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the key phrases detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Provides information about a key phrases detection job.

func (KeyPhrasesDetectionJobProperties) GoString 

func (s KeyPhrasesDetectionJobProperties) GoString() string

GoString returns the string representation

func (*KeyPhrasesDetectionJobProperties) SetEndTime 

func (s *KeyPhrasesDetectionJobProperties) SetEndTime(v time.Time) *KeyPhrasesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*KeyPhrasesDetectionJobProperties) SetInputDataConfig 

func (s *KeyPhrasesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *KeyPhrasesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobId 

func (s *KeyPhrasesDetectionJobProperties) SetJobId(v string) *KeyPhrasesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobName 

func (s *KeyPhrasesDetectionJobProperties) SetJobName(v string) *KeyPhrasesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobStatus 

func (s *KeyPhrasesDetectionJobProperties) SetJobStatus(v string) *KeyPhrasesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobProperties) SetLanguageCode 

func (s *KeyPhrasesDetectionJobProperties) SetLanguageCode(v string) *KeyPhrasesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*KeyPhrasesDetectionJobProperties) SetMessage 

func (s *KeyPhrasesDetectionJobProperties) SetMessage(v string) *KeyPhrasesDetectionJobProperties

SetMessage sets the Message field's value.

func (*KeyPhrasesDetectionJobProperties) SetOutputDataConfig 

func (s *KeyPhrasesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *KeyPhrasesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetSubmitTime 

func (s *KeyPhrasesDetectionJobProperties) SetSubmitTime(v time.Time) *KeyPhrasesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (KeyPhrasesDetectionJobProperties) String 

func (s KeyPhrasesDetectionJobProperties) String() string

String returns the string representation

type ListDominantLanguageDetectionJobsInput 

type ListDominantLanguageDetectionJobsInput struct {

	// Filters that jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *DominantLanguageDetectionJobFilter `type:"structure"`

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

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDominantLanguageDetectionJobsInput) GoString 

func (s ListDominantLanguageDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListDominantLanguageDetectionJobsInput) SetFilter 

func (s *ListDominantLanguageDetectionJobsInput) SetFilter(v *DominantLanguageDetectionJobFilter) *ListDominantLanguageDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListDominantLanguageDetectionJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDominantLanguageDetectionJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsInput) String 

func (s ListDominantLanguageDetectionJobsInput) String() string

String returns the string representation

func (*ListDominantLanguageDetectionJobsInput) Validate 

func (s *ListDominantLanguageDetectionJobsInput) Validate() error

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

type ListDominantLanguageDetectionJobsOutput 

type ListDominantLanguageDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	DominantLanguageDetectionJobPropertiesList []*DominantLanguageDetectionJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDominantLanguageDetectionJobsOutput) GoString 

func (s ListDominantLanguageDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListDominantLanguageDetectionJobsOutput) SetDominantLanguageDetectionJobPropertiesList 

func (s *ListDominantLanguageDetectionJobsOutput) SetDominantLanguageDetectionJobPropertiesList(v []*DominantLanguageDetectionJobProperties) *ListDominantLanguageDetectionJobsOutput

SetDominantLanguageDetectionJobPropertiesList sets the DominantLanguageDetectionJobPropertiesList field's value.

func (*ListDominantLanguageDetectionJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsOutput) String 

func (s ListDominantLanguageDetectionJobsOutput) String() string

String returns the string representation

type ListEntitiesDetectionJobsInput 

type ListEntitiesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *EntitiesDetectionJobFilter `type:"structure"`

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

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionJobsInput) GoString 

func (s ListEntitiesDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListEntitiesDetectionJobsInput) SetFilter 

func (s *ListEntitiesDetectionJobsInput) SetFilter(v *EntitiesDetectionJobFilter) *ListEntitiesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListEntitiesDetectionJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesDetectionJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsInput) String 

func (s ListEntitiesDetectionJobsInput) String() string

String returns the string representation

func (*ListEntitiesDetectionJobsInput) Validate 

func (s *ListEntitiesDetectionJobsInput) Validate() error

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

type ListEntitiesDetectionJobsOutput 

type ListEntitiesDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	EntitiesDetectionJobPropertiesList []*EntitiesDetectionJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionJobsOutput) GoString 

func (s ListEntitiesDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListEntitiesDetectionJobsOutput) SetEntitiesDetectionJobPropertiesList 

func (s *ListEntitiesDetectionJobsOutput) SetEntitiesDetectionJobPropertiesList(v []*EntitiesDetectionJobProperties) *ListEntitiesDetectionJobsOutput

SetEntitiesDetectionJobPropertiesList sets the EntitiesDetectionJobPropertiesList field's value.

func (*ListEntitiesDetectionJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsOutput) String 

func (s ListEntitiesDetectionJobsOutput) String() string

String returns the string representation

type ListKeyPhrasesDetectionJobsInput 

type ListKeyPhrasesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *KeyPhrasesDetectionJobFilter `type:"structure"`

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

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeyPhrasesDetectionJobsInput) GoString 

func (s ListKeyPhrasesDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) SetFilter 

func (s *ListKeyPhrasesDetectionJobsInput) SetFilter(v *KeyPhrasesDetectionJobFilter) *ListKeyPhrasesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsInput) String 

func (s ListKeyPhrasesDetectionJobsInput) String() string

String returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) Validate 

func (s *ListKeyPhrasesDetectionJobsInput) Validate() error

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

type ListKeyPhrasesDetectionJobsOutput 

type ListKeyPhrasesDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	KeyPhrasesDetectionJobPropertiesList []*KeyPhrasesDetectionJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeyPhrasesDetectionJobsOutput) GoString 

func (s ListKeyPhrasesDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListKeyPhrasesDetectionJobsOutput) SetKeyPhrasesDetectionJobPropertiesList 

func (s *ListKeyPhrasesDetectionJobsOutput) SetKeyPhrasesDetectionJobPropertiesList(v []*KeyPhrasesDetectionJobProperties) *ListKeyPhrasesDetectionJobsOutput

SetKeyPhrasesDetectionJobPropertiesList sets the KeyPhrasesDetectionJobPropertiesList field's value.

func (*ListKeyPhrasesDetectionJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsOutput) String 

func (s ListKeyPhrasesDetectionJobsOutput) String() string

String returns the string representation

type ListSentimentDetectionJobsInput 

type ListSentimentDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *SentimentDetectionJobFilter `type:"structure"`

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

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListSentimentDetectionJobsInput) GoString 

func (s ListSentimentDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListSentimentDetectionJobsInput) SetFilter 

func (s *ListSentimentDetectionJobsInput) SetFilter(v *SentimentDetectionJobFilter) *ListSentimentDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListSentimentDetectionJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListSentimentDetectionJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListSentimentDetectionJobsInput) String 

func (s ListSentimentDetectionJobsInput) String() string

String returns the string representation

func (*ListSentimentDetectionJobsInput) Validate 

func (s *ListSentimentDetectionJobsInput) Validate() error

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

type ListSentimentDetectionJobsOutput 

type ListSentimentDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`

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

func (ListSentimentDetectionJobsOutput) GoString 

func (s ListSentimentDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListSentimentDetectionJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSentimentDetectionJobsOutput) SetSentimentDetectionJobPropertiesList 

func (s *ListSentimentDetectionJobsOutput) SetSentimentDetectionJobPropertiesList(v []*SentimentDetectionJobProperties) *ListSentimentDetectionJobsOutput

SetSentimentDetectionJobPropertiesList sets the SentimentDetectionJobPropertiesList field's value.

func (ListSentimentDetectionJobsOutput) String 

func (s ListSentimentDetectionJobsOutput) String() string

String returns the string representation

type ListTopicsDetectionJobsInput 

type ListTopicsDetectionJobsInput struct {

	// Filters the jobs that are returned. Jobs can be filtered on their name, status,
	// or the date and time that they were submitted. You can set only one filter
	// at a time.
	Filter *TopicsDetectionJobFilter `type:"structure"`

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

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTopicsDetectionJobsInput) GoString 

func (s ListTopicsDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListTopicsDetectionJobsInput) SetFilter 

func (s *ListTopicsDetectionJobsInput) SetFilter(v *TopicsDetectionJobFilter) *ListTopicsDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListTopicsDetectionJobsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTopicsDetectionJobsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListTopicsDetectionJobsInput) String 

func (s ListTopicsDetectionJobsInput) String() string

String returns the string representation

func (*ListTopicsDetectionJobsInput) Validate 

func (s *ListTopicsDetectionJobsInput) Validate() error

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

type ListTopicsDetectionJobsOutput 

type ListTopicsDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`

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

func (ListTopicsDetectionJobsOutput) GoString 

func (s ListTopicsDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListTopicsDetectionJobsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList 

func (s *ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList(v []*TopicsDetectionJobProperties) *ListTopicsDetectionJobsOutput

SetTopicsDetectionJobPropertiesList sets the TopicsDetectionJobPropertiesList field's value.

func (ListTopicsDetectionJobsOutput) String 

func (s ListTopicsDetectionJobsOutput) String() string

String returns the string representation

type OutputDataConfig 

type OutputDataConfig struct {

	// When you use the OutputDataConfig object with asynchronous operations, you
	// specify the Amazon S3 location where you want to write the output data. The
	// URI must be in the same region as the API endpoint that you are calling.
	// The location is used as the prefix for the actual location of the output
	// file.
	//
	// When the topic detection job is finished, the service creates an output file
	// in a directory specific to the job. The S3Uri field contains the location
	// of the output file, called output.tar.gz. It is a compressed archive that
	// contains the ouput of the operation.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides configuration parameters for the output of topic detection jobs.

func (OutputDataConfig) GoString 

func (s OutputDataConfig) GoString() string

GoString returns the string representation

func (*OutputDataConfig) SetS3Uri 

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

SetS3Uri sets the S3Uri field's value.

func (OutputDataConfig) String 

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate 

func (s *OutputDataConfig) Validate() error

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

type SentimentDetectionJobFilter 

type SentimentDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

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

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (SentimentDetectionJobFilter) GoString 

func (s SentimentDetectionJobFilter) GoString() string

GoString returns the string representation

func (*SentimentDetectionJobFilter) SetJobName 

func (s *SentimentDetectionJobFilter) SetJobName(v string) *SentimentDetectionJobFilter

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobFilter) SetJobStatus 

func (s *SentimentDetectionJobFilter) SetJobStatus(v string) *SentimentDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeAfter 

func (s *SentimentDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *SentimentDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeBefore 

func (s *SentimentDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *SentimentDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (SentimentDetectionJobFilter) String 

func (s SentimentDetectionJobFilter) String() string

String returns the string representation

func (*SentimentDetectionJobFilter) Validate 

func (s *SentimentDetectionJobFilter) Validate() error

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

type SentimentDetectionJobProperties 

type SentimentDetectionJobProperties struct {

	// The time that the sentiment detection job ended.
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The input data configuration that you supplied when you created the sentiment
	// detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the sentiment detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned to the sentiment detection job
	JobName *string `min:"1" type:"string"`

	// The current status of the sentiment detection job. If the status is FAILED,
	// the Messages field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The language code of the input documents.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// A description of the status of a job.
	Message *string `type:"string"`

	// The output data configuration that you supplied when you created the sentiment
	// detection job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the sentiment detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Provides information about a sentiment detection job.

func (SentimentDetectionJobProperties) GoString 

func (s SentimentDetectionJobProperties) GoString() string

GoString returns the string representation

func (*SentimentDetectionJobProperties) SetEndTime 

func (s *SentimentDetectionJobProperties) SetEndTime(v time.Time) *SentimentDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*SentimentDetectionJobProperties) SetInputDataConfig 

func (s *SentimentDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *SentimentDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetJobId 

func (s *SentimentDetectionJobProperties) SetJobId(v string) *SentimentDetectionJobProperties

SetJobId sets the JobId field's value.

func (*SentimentDetectionJobProperties) SetJobName 

func (s *SentimentDetectionJobProperties) SetJobName(v string) *SentimentDetectionJobProperties

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobProperties) SetJobStatus 

func (s *SentimentDetectionJobProperties) SetJobStatus(v string) *SentimentDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobProperties) SetLanguageCode 

func (s *SentimentDetectionJobProperties) SetLanguageCode(v string) *SentimentDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*SentimentDetectionJobProperties) SetMessage 

func (s *SentimentDetectionJobProperties) SetMessage(v string) *SentimentDetectionJobProperties

SetMessage sets the Message field's value.

func (*SentimentDetectionJobProperties) SetOutputDataConfig 

func (s *SentimentDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *SentimentDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetSubmitTime 

func (s *SentimentDetectionJobProperties) SetSubmitTime(v time.Time) *SentimentDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (SentimentDetectionJobProperties) String 

func (s SentimentDetectionJobProperties) String() string

String returns the string representation

type SentimentScore 

type SentimentScore struct {

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the MIXED sentiment.
	Mixed *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEGATIVE sentiment.
	Negative *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEUTRAL sentiment.
	Neutral *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the POSITIVE sentiment.
	Positive *float64 `type:"float"`
	// contains filtered or unexported fields
}

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

func (SentimentScore) GoString 

func (s SentimentScore) GoString() string

GoString returns the string representation

func (*SentimentScore) SetMixed 

func (s *SentimentScore) SetMixed(v float64) *SentimentScore

SetMixed sets the Mixed field's value.

func (*SentimentScore) SetNegative 

func (s *SentimentScore) SetNegative(v float64) *SentimentScore

SetNegative sets the Negative field's value.

func (*SentimentScore) SetNeutral 

func (s *SentimentScore) SetNeutral(v float64) *SentimentScore

SetNeutral sets the Neutral field's value.

func (*SentimentScore) SetPositive 

func (s *SentimentScore) SetPositive(v float64) *SentimentScore

SetPositive sets the Positive field's value.

func (SentimentScore) String 

func (s SentimentScore) String() string

String returns the string representation

type StartDominantLanguageDetectionJobInput 

type StartDominantLanguageDetectionJobInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `type:"string" required:"true"`

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

	// An identifier for the job.
	JobName *string `min:"1" type:"string"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartDominantLanguageDetectionJobInput) GoString 

func (s StartDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartDominantLanguageDetectionJobInput) SetClientRequestToken 

func (s *StartDominantLanguageDetectionJobInput) SetClientRequestToken(v string) *StartDominantLanguageDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDominantLanguageDetectionJobInput) SetDataAccessRoleArn 

func (s *StartDominantLanguageDetectionJobInput) SetDataAccessRoleArn(v string) *StartDominantLanguageDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartDominantLanguageDetectionJobInput) SetInputDataConfig 

func (s *StartDominantLanguageDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartDominantLanguageDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartDominantLanguageDetectionJobInput) SetJobName 

func (s *StartDominantLanguageDetectionJobInput) SetJobName(v string) *StartDominantLanguageDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartDominantLanguageDetectionJobInput) SetOutputDataConfig 

func (s *StartDominantLanguageDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartDominantLanguageDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartDominantLanguageDetectionJobInput) String 

func (s StartDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*StartDominantLanguageDetectionJobInput) Validate 

func (s *StartDominantLanguageDetectionJobInput) Validate() error

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

type StartDominantLanguageDetectionJobOutput 

type StartDominantLanguageDetectionJobOutput struct {

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

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartDominantLanguageDetectionJobOutput) GoString 

func (s StartDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartDominantLanguageDetectionJobOutput) SetJobId 

func (s *StartDominantLanguageDetectionJobOutput) SetJobId(v string) *StartDominantLanguageDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartDominantLanguageDetectionJobOutput) SetJobStatus 

func (s *StartDominantLanguageDetectionJobOutput) SetJobStatus(v string) *StartDominantLanguageDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartDominantLanguageDetectionJobOutput) String 

func (s StartDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type StartEntitiesDetectionJobInput 

type StartEntitiesDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `type:"string" required:"true"`

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

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionJobInput) GoString 

func (s StartEntitiesDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartEntitiesDetectionJobInput) SetClientRequestToken 

func (s *StartEntitiesDetectionJobInput) SetClientRequestToken(v string) *StartEntitiesDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEntitiesDetectionJobInput) SetDataAccessRoleArn 

func (s *StartEntitiesDetectionJobInput) SetDataAccessRoleArn(v string) *StartEntitiesDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEntitiesDetectionJobInput) SetInputDataConfig 

func (s *StartEntitiesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartEntitiesDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEntitiesDetectionJobInput) SetJobName 

func (s *StartEntitiesDetectionJobInput) SetJobName(v string) *StartEntitiesDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartEntitiesDetectionJobInput) SetLanguageCode 

func (s *StartEntitiesDetectionJobInput) SetLanguageCode(v string) *StartEntitiesDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartEntitiesDetectionJobInput) SetOutputDataConfig 

func (s *StartEntitiesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartEntitiesDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartEntitiesDetectionJobInput) String 

func (s StartEntitiesDetectionJobInput) String() string

String returns the string representation

func (*StartEntitiesDetectionJobInput) Validate 

func (s *StartEntitiesDetectionJobInput) Validate() error

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

type StartEntitiesDetectionJobOutput 

type StartEntitiesDetectionJobOutput struct {

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

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionJobOutput) GoString 

func (s StartEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartEntitiesDetectionJobOutput) SetJobId 

func (s *StartEntitiesDetectionJobOutput) SetJobId(v string) *StartEntitiesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartEntitiesDetectionJobOutput) SetJobStatus 

func (s *StartEntitiesDetectionJobOutput) SetJobStatus(v string) *StartEntitiesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartEntitiesDetectionJobOutput) String 

func (s StartEntitiesDetectionJobOutput) String() string

String returns the string representation

type StartKeyPhrasesDetectionJobInput 

type StartKeyPhrasesDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `type:"string" required:"true"`

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

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartKeyPhrasesDetectionJobInput) GoString 

func (s StartKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartKeyPhrasesDetectionJobInput) SetClientRequestToken 

func (s *StartKeyPhrasesDetectionJobInput) SetClientRequestToken(v string) *StartKeyPhrasesDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartKeyPhrasesDetectionJobInput) SetDataAccessRoleArn 

func (s *StartKeyPhrasesDetectionJobInput) SetDataAccessRoleArn(v string) *StartKeyPhrasesDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartKeyPhrasesDetectionJobInput) SetInputDataConfig 

func (s *StartKeyPhrasesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartKeyPhrasesDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartKeyPhrasesDetectionJobInput) SetJobName 

func (s *StartKeyPhrasesDetectionJobInput) SetJobName(v string) *StartKeyPhrasesDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartKeyPhrasesDetectionJobInput) SetLanguageCode 

func (s *StartKeyPhrasesDetectionJobInput) SetLanguageCode(v string) *StartKeyPhrasesDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartKeyPhrasesDetectionJobInput) SetOutputDataConfig 

func (s *StartKeyPhrasesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartKeyPhrasesDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartKeyPhrasesDetectionJobInput) String 

func (s StartKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*StartKeyPhrasesDetectionJobInput) Validate 

func (s *StartKeyPhrasesDetectionJobInput) Validate() error

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

type StartKeyPhrasesDetectionJobOutput 

type StartKeyPhrasesDetectionJobOutput struct {

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

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartKeyPhrasesDetectionJobOutput) GoString 

func (s StartKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartKeyPhrasesDetectionJobOutput) SetJobId 

func (s *StartKeyPhrasesDetectionJobOutput) SetJobId(v string) *StartKeyPhrasesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartKeyPhrasesDetectionJobOutput) SetJobStatus 

func (s *StartKeyPhrasesDetectionJobOutput) SetJobStatus(v string) *StartKeyPhrasesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartKeyPhrasesDetectionJobOutput) String 

func (s StartKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type StartSentimentDetectionJobInput 

type StartSentimentDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `type:"string" required:"true"`

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

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartSentimentDetectionJobInput) GoString 

func (s StartSentimentDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartSentimentDetectionJobInput) SetClientRequestToken 

func (s *StartSentimentDetectionJobInput) SetClientRequestToken(v string) *StartSentimentDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartSentimentDetectionJobInput) SetDataAccessRoleArn 

func (s *StartSentimentDetectionJobInput) SetDataAccessRoleArn(v string) *StartSentimentDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartSentimentDetectionJobInput) SetInputDataConfig 

func (s *StartSentimentDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartSentimentDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartSentimentDetectionJobInput) SetJobName 

func (s *StartSentimentDetectionJobInput) SetJobName(v string) *StartSentimentDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartSentimentDetectionJobInput) SetLanguageCode 

func (s *StartSentimentDetectionJobInput) SetLanguageCode(v string) *StartSentimentDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartSentimentDetectionJobInput) SetOutputDataConfig 

func (s *StartSentimentDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartSentimentDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartSentimentDetectionJobInput) String 

func (s StartSentimentDetectionJobInput) String() string

String returns the string representation

func (*StartSentimentDetectionJobInput) Validate 

func (s *StartSentimentDetectionJobInput) Validate() error

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

type StartSentimentDetectionJobOutput 

type StartSentimentDetectionJobOutput struct {

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

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartSentimentDetectionJobOutput) GoString 

func (s StartSentimentDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartSentimentDetectionJobOutput) SetJobId 

func (s *StartSentimentDetectionJobOutput) SetJobId(v string) *StartSentimentDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartSentimentDetectionJobOutput) SetJobStatus 

func (s *StartSentimentDetectionJobOutput) SetJobStatus(v string) *StartSentimentDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartSentimentDetectionJobOutput) String 

func (s StartSentimentDetectionJobOutput) String() string

String returns the string representation

type StartTopicsDetectionJobInput 

type StartTopicsDetectionJobInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that grants Amazon Comprehend read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `type:"string" required:"true"`

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

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The number of topics to detect.
	NumberOfTopics *int64 `min:"1" type:"integer"`

	// Specifies where to send the output files. The output is a compressed archive
	// with two files, topic-terms.csv that lists the terms associated with each
	// topic, and doc-topics.csv that lists the documents associated with each topic
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartTopicsDetectionJobInput) GoString 

func (s StartTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartTopicsDetectionJobInput) SetClientRequestToken 

func (s *StartTopicsDetectionJobInput) SetClientRequestToken(v string) *StartTopicsDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartTopicsDetectionJobInput) SetDataAccessRoleArn 

func (s *StartTopicsDetectionJobInput) SetDataAccessRoleArn(v string) *StartTopicsDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartTopicsDetectionJobInput) SetInputDataConfig 

func (s *StartTopicsDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartTopicsDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartTopicsDetectionJobInput) SetJobName 

func (s *StartTopicsDetectionJobInput) SetJobName(v string) *StartTopicsDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartTopicsDetectionJobInput) SetNumberOfTopics 

func (s *StartTopicsDetectionJobInput) SetNumberOfTopics(v int64) *StartTopicsDetectionJobInput

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*StartTopicsDetectionJobInput) SetOutputDataConfig 

func (s *StartTopicsDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartTopicsDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartTopicsDetectionJobInput) String 

func (s StartTopicsDetectionJobInput) String() string

String returns the string representation

func (*StartTopicsDetectionJobInput) Validate 

func (s *StartTopicsDetectionJobInput) Validate() error

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

type StartTopicsDetectionJobOutput 

type StartTopicsDetectionJobOutput struct {

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

	// The status of the job:
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob
	//    operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartTopicsDetectionJobOutput) GoString 

func (s StartTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartTopicsDetectionJobOutput) SetJobId 

func (s *StartTopicsDetectionJobOutput) SetJobId(v string) *StartTopicsDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartTopicsDetectionJobOutput) SetJobStatus 

func (s *StartTopicsDetectionJobOutput) SetJobStatus(v string) *StartTopicsDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartTopicsDetectionJobOutput) String 

func (s StartTopicsDetectionJobOutput) String() string

String returns the string representation

type StopDominantLanguageDetectionJobInput 

type StopDominantLanguageDetectionJobInput struct {

	// The identifier of the dominant language detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopDominantLanguageDetectionJobInput) GoString 

func (s StopDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation

func (*StopDominantLanguageDetectionJobInput) SetJobId 

func (s *StopDominantLanguageDetectionJobInput) SetJobId(v string) *StopDominantLanguageDetectionJobInput

SetJobId sets the JobId field's value.

func (StopDominantLanguageDetectionJobInput) String 

func (s StopDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*StopDominantLanguageDetectionJobInput) Validate 

func (s *StopDominantLanguageDetectionJobInput) Validate() error

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

type StopDominantLanguageDetectionJobOutput 

type StopDominantLanguageDetectionJobOutput struct {

	// The identifier of the dominant language detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOPPING if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopDominantLanguageDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopDominantLanguageDetectionJobOutput) GoString 

func (s StopDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StopDominantLanguageDetectionJobOutput) SetJobId 

func (s *StopDominantLanguageDetectionJobOutput) SetJobId(v string) *StopDominantLanguageDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopDominantLanguageDetectionJobOutput) SetJobStatus 

func (s *StopDominantLanguageDetectionJobOutput) SetJobStatus(v string) *StopDominantLanguageDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopDominantLanguageDetectionJobOutput) String 

func (s StopDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type StopEntitiesDetectionJobInput 

type StopEntitiesDetectionJobInput struct {

	// The identifier of the entities detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionJobInput) GoString 

func (s StopEntitiesDetectionJobInput) GoString() string

GoString returns the string representation

func (*StopEntitiesDetectionJobInput) SetJobId 

func (s *StopEntitiesDetectionJobInput) SetJobId(v string) *StopEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionJobInput) String 

func (s StopEntitiesDetectionJobInput) String() string

String returns the string representation

func (*StopEntitiesDetectionJobInput) Validate 

func (s *StopEntitiesDetectionJobInput) Validate() error

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

type StopEntitiesDetectionJobOutput 

type StopEntitiesDetectionJobOutput struct {

	// The identifier of the entities detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOPPING if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopEntitiesDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionJobOutput) GoString 

func (s StopEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StopEntitiesDetectionJobOutput) SetJobId 

func (s *StopEntitiesDetectionJobOutput) SetJobId(v string) *StopEntitiesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopEntitiesDetectionJobOutput) SetJobStatus 

func (s *StopEntitiesDetectionJobOutput) SetJobStatus(v string) *StopEntitiesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopEntitiesDetectionJobOutput) String 

func (s StopEntitiesDetectionJobOutput) String() string

String returns the string representation

type StopKeyPhrasesDetectionJobInput 

type StopKeyPhrasesDetectionJobInput struct {

	// The identifier of the key phrases detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopKeyPhrasesDetectionJobInput) GoString 

func (s StopKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation

func (*StopKeyPhrasesDetectionJobInput) SetJobId 

func (s *StopKeyPhrasesDetectionJobInput) SetJobId(v string) *StopKeyPhrasesDetectionJobInput

SetJobId sets the JobId field's value.

func (StopKeyPhrasesDetectionJobInput) String 

func (s StopKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*StopKeyPhrasesDetectionJobInput) Validate 

func (s *StopKeyPhrasesDetectionJobInput) Validate() error

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

type StopKeyPhrasesDetectionJobOutput 

type StopKeyPhrasesDetectionJobOutput struct {

	// The identifier of the key phrases detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOPPING if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopKeyPhrasesDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopKeyPhrasesDetectionJobOutput) GoString 

func (s StopKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StopKeyPhrasesDetectionJobOutput) SetJobId 

func (s *StopKeyPhrasesDetectionJobOutput) SetJobId(v string) *StopKeyPhrasesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopKeyPhrasesDetectionJobOutput) SetJobStatus 

func (s *StopKeyPhrasesDetectionJobOutput) SetJobStatus(v string) *StopKeyPhrasesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopKeyPhrasesDetectionJobOutput) String 

func (s StopKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type StopSentimentDetectionJobInput 

type StopSentimentDetectionJobInput struct {

	// The identifier of the sentiment detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopSentimentDetectionJobInput) GoString 

func (s StopSentimentDetectionJobInput) GoString() string

GoString returns the string representation

func (*StopSentimentDetectionJobInput) SetJobId 

func (s *StopSentimentDetectionJobInput) SetJobId(v string) *StopSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (StopSentimentDetectionJobInput) String 

func (s StopSentimentDetectionJobInput) String() string

String returns the string representation

func (*StopSentimentDetectionJobInput) Validate 

func (s *StopSentimentDetectionJobInput) Validate() error

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

type StopSentimentDetectionJobOutput 

type StopSentimentDetectionJobOutput struct {

	// The identifier of the sentiment detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOPPING if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopSentimentDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopSentimentDetectionJobOutput) GoString 

func (s StopSentimentDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StopSentimentDetectionJobOutput) SetJobId 

func (s *StopSentimentDetectionJobOutput) SetJobId(v string) *StopSentimentDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopSentimentDetectionJobOutput) SetJobStatus 

func (s *StopSentimentDetectionJobOutput) SetJobStatus(v string) *StopSentimentDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopSentimentDetectionJobOutput) String 

func (s StopSentimentDetectionJobOutput) String() string

String returns the string representation

type TopicsDetectionJobFilter 

type TopicsDetectionJobFilter struct {
	JobName *string `min:"1" type:"string"`

	// Filters the list of topic detection jobs based on job status. Returns only
	// jobs with the specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Only returns jobs submitted after the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeAfter *time.Time `type:"timestamp" timestampFormat:"unix"`

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

Provides information for filtering topic detection jobs. For more information, see .

func (TopicsDetectionJobFilter) GoString 

func (s TopicsDetectionJobFilter) GoString() string

GoString returns the string representation

func (*TopicsDetectionJobFilter) SetJobName 

func (s *TopicsDetectionJobFilter) SetJobName(v string) *TopicsDetectionJobFilter

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobFilter) SetJobStatus 

func (s *TopicsDetectionJobFilter) SetJobStatus(v string) *TopicsDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*TopicsDetectionJobFilter) SetSubmitTimeAfter 

func (s *TopicsDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *TopicsDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*TopicsDetectionJobFilter) SetSubmitTimeBefore 

func (s *TopicsDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *TopicsDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (TopicsDetectionJobFilter) String 

func (s TopicsDetectionJobFilter) String() string

String returns the string representation

func (*TopicsDetectionJobFilter) Validate 

func (s *TopicsDetectionJobFilter) Validate() error

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

type TopicsDetectionJobProperties 

type TopicsDetectionJobProperties struct {

	// The time that the topic detection job was completed.
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The input data configuration supplied when you created the topic detection
	// job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the topic detection job.
	JobId *string `min:"1" type:"string"`

	// The name of the topic detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the topic detection job. If the status is Failed, the
	// reason for the failure is shown in the Message field.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// A description for the status of a job.
	Message *string `type:"string"`

	// The number of topics to detect supplied when you created the topic detection
	// job. The default is 10.
	NumberOfTopics *int64 `type:"integer"`

	// The output data configuration supplied when you created the topic detection
	// job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the topic detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Provides information about a topic detection job.

func (TopicsDetectionJobProperties) GoString 

func (s TopicsDetectionJobProperties) GoString() string

GoString returns the string representation

func (*TopicsDetectionJobProperties) SetEndTime 

func (s *TopicsDetectionJobProperties) SetEndTime(v time.Time) *TopicsDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*TopicsDetectionJobProperties) SetInputDataConfig 

func (s *TopicsDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *TopicsDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetJobId 

func (s *TopicsDetectionJobProperties) SetJobId(v string) *TopicsDetectionJobProperties

SetJobId sets the JobId field's value.

func (*TopicsDetectionJobProperties) SetJobName 

func (s *TopicsDetectionJobProperties) SetJobName(v string) *TopicsDetectionJobProperties

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobProperties) SetJobStatus 

func (s *TopicsDetectionJobProperties) SetJobStatus(v string) *TopicsDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*TopicsDetectionJobProperties) SetMessage 

func (s *TopicsDetectionJobProperties) SetMessage(v string) *TopicsDetectionJobProperties

SetMessage sets the Message field's value.

func (*TopicsDetectionJobProperties) SetNumberOfTopics 

func (s *TopicsDetectionJobProperties) SetNumberOfTopics(v int64) *TopicsDetectionJobProperties

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*TopicsDetectionJobProperties) SetOutputDataConfig 

func (s *TopicsDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *TopicsDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetSubmitTime 

func (s *TopicsDetectionJobProperties) SetSubmitTime(v time.Time) *TopicsDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (TopicsDetectionJobProperties) String 

func (s TopicsDetectionJobProperties) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.
 Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.