comprehend

package
v1.99.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2020 License: Apache-2.0 Imports: 10 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"

	// LanguageCodeFr is a LanguageCode enum value
	LanguageCodeFr = "fr"

	// LanguageCodeDe is a LanguageCode enum value
	LanguageCodeDe = "de"

	// LanguageCodeIt is a LanguageCode enum value
	LanguageCodeIt = "it"

	// LanguageCodePt is a LanguageCode enum value
	LanguageCodePt = "pt"
)
View Source
const (
	// ModelStatusSubmitted is a ModelStatus enum value
	ModelStatusSubmitted = "SUBMITTED"

	// ModelStatusTraining is a ModelStatus enum value
	ModelStatusTraining = "TRAINING"

	// ModelStatusDeleting is a ModelStatus enum value
	ModelStatusDeleting = "DELETING"

	// ModelStatusStopRequested is a ModelStatus enum value
	ModelStatusStopRequested = "STOP_REQUESTED"

	// ModelStatusStopped is a ModelStatus enum value
	ModelStatusStopped = "STOPPED"

	// ModelStatusInError is a ModelStatus enum value
	ModelStatusInError = "IN_ERROR"

	// ModelStatusTrained is a ModelStatus enum value
	ModelStatusTrained = "TRAINED"
)
View Source
const (
	// PartOfSpeechTagTypeAdj is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeAdj = "ADJ"

	// PartOfSpeechTagTypeAdp is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeAdp = "ADP"

	// PartOfSpeechTagTypeAdv is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeAdv = "ADV"

	// PartOfSpeechTagTypeAux is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeAux = "AUX"

	// PartOfSpeechTagTypeConj is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeConj = "CONJ"

	// PartOfSpeechTagTypeCconj is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeCconj = "CCONJ"

	// PartOfSpeechTagTypeDet is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeDet = "DET"

	// PartOfSpeechTagTypeIntj is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeIntj = "INTJ"

	// PartOfSpeechTagTypeNoun is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeNoun = "NOUN"

	// PartOfSpeechTagTypeNum is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeNum = "NUM"

	// PartOfSpeechTagTypeO is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeO = "O"

	// PartOfSpeechTagTypePart is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypePart = "PART"

	// PartOfSpeechTagTypePron is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypePron = "PRON"

	// PartOfSpeechTagTypePropn is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypePropn = "PROPN"

	// PartOfSpeechTagTypePunct is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypePunct = "PUNCT"

	// PartOfSpeechTagTypeSconj is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeSconj = "SCONJ"

	// PartOfSpeechTagTypeSym is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeSym = "SYM"

	// PartOfSpeechTagTypeVerb is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeVerb = "VERB"
)
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 (
	// SyntaxLanguageCodeEn is a SyntaxLanguageCode enum value
	SyntaxLanguageCodeEn = "en"

	// SyntaxLanguageCodeEs is a SyntaxLanguageCode enum value
	SyntaxLanguageCodeEs = "es"

	// SyntaxLanguageCodeFr is a SyntaxLanguageCode enum value
	SyntaxLanguageCodeFr = "fr"

	// SyntaxLanguageCodeDe is a SyntaxLanguageCode enum value
	SyntaxLanguageCodeDe = "de"

	// SyntaxLanguageCodeIt is a SyntaxLanguageCode enum value
	SyntaxLanguageCodeIt = "it"

	// SyntaxLanguageCodePt is a SyntaxLanguageCode enum value
	SyntaxLanguageCodePt = "pt"
)
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"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// Concurrent modification of the tags associated with an Amazon Comprehend
	// resource is not supported.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

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

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

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

	// ErrCodeKmsKeyValidationException for service response error code
	// "KmsKeyValidationException".
	//
	// The KMS customer managed key (CMK) entered cannot be validated. Verify the
	// key and re-enter it.
	ErrCodeKmsKeyValidationException = "KmsKeyValidationException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified name is already in use. Use a different name and try your request
	// again.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// The maximum number of recognizers per account has been exceeded. Review the
	// recognizers, perform cleanup, and then try your request again.
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource ARN was not found. Check the ARN and try your request
	// again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceUnavailableException for service response error code
	// "ResourceUnavailableException".
	//
	// The specified resource is not available. Check to see if the resource is
	// in the TRAINED state and try your request again.
	ErrCodeResourceUnavailableException = "ResourceUnavailableException"

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

	// ErrCodeTooManyTagKeysException for service response error code
	// "TooManyTagKeysException".
	//
	// The request contains more tag keys than can be associated with a resource
	// (50 tag keys per resource).
	ErrCodeTooManyTagKeysException = "TooManyTagKeysException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// The request contains more tags than can be associated with a resource (50
	// tags per resource). The maximum number of tags includes both existing tags
	// and those included in your current request.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeUnsupportedLanguageException for service response error code
	// "UnsupportedLanguageException".
	//
	// Amazon Comprehend can't process the language of the input text. For all custom
	// entity recognition APIs (such as CreateEntityRecognizer), only English is
	// accepted. For most other APIs, such as those for Custom Classification, Amazon
	// Comprehend accepts text in all supported languages. For a list of supported
	// languages, see supported-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

GoString returns the string representation

func (*BatchDetectDominantLanguageInput) SetTextList

SetTextList sets the TextList field's value.

func (BatchDetectDominantLanguageInput) String

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate

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

GoString returns the string representation

func (*BatchDetectDominantLanguageItemResult) SetIndex

SetIndex sets the Index field's value.

func (*BatchDetectDominantLanguageItemResult) SetLanguages

SetLanguages sets the Languages field's value.

func (BatchDetectDominantLanguageItemResult) 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

GoString returns the string representation

func (*BatchDetectDominantLanguageOutput) SetErrorList

SetErrorList sets the ErrorList field's value.

func (*BatchDetectDominantLanguageOutput) SetResultList

SetResultList sets the ResultList field's value.

func (BatchDetectDominantLanguageOutput) String

String returns the string representation

type BatchDetectEntitiesInput

type BatchDetectEntitiesInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectEntitiesInput) SetTextList

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

GoString returns the string representation

func (*BatchDetectEntitiesItemResult) SetEntities

SetEntities sets the Entities field's value.

func (*BatchDetectEntitiesItemResult) SetIndex

SetIndex sets the Index field's value.

func (BatchDetectEntitiesItemResult) 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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectEntitiesOutput) SetResultList

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 any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectKeyPhrasesInput) SetTextList

SetTextList sets the TextList field's value.

func (BatchDetectKeyPhrasesInput) 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

GoString returns the string representation

func (*BatchDetectKeyPhrasesItemResult) SetIndex

SetIndex sets the Index field's value.

func (*BatchDetectKeyPhrasesItemResult) SetKeyPhrases

SetKeyPhrases sets the KeyPhrases field's value.

func (BatchDetectKeyPhrasesItemResult) 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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectKeyPhrasesOutput) SetResultList

SetResultList sets the ResultList field's value.

func (BatchDetectKeyPhrasesOutput) String

String returns the string representation

type BatchDetectSentimentInput

type BatchDetectSentimentInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSentimentInput) SetTextList

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

GoString returns the string representation

func (*BatchDetectSentimentItemResult) SetIndex

SetIndex sets the Index field's value.

func (*BatchDetectSentimentItemResult) SetSentiment

SetSentiment sets the Sentiment field's value.

func (*BatchDetectSentimentItemResult) SetSentimentScore

SetSentimentScore sets the SentimentScore field's value.

func (BatchDetectSentimentItemResult) 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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSentimentOutput) SetResultList

SetResultList sets the ResultList field's value.

func (BatchDetectSentimentOutput) String

String returns the string representation

type BatchDetectSyntaxInput added in v1.14.28

type BatchDetectSyntaxInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be
	// in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"`

	// 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 (BatchDetectSyntaxInput) GoString added in v1.14.28

func (s BatchDetectSyntaxInput) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxInput) SetLanguageCode added in v1.14.28

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSyntaxInput) SetTextList added in v1.14.28

SetTextList sets the TextList field's value.

func (BatchDetectSyntaxInput) String added in v1.14.28

func (s BatchDetectSyntaxInput) String() string

String returns the string representation

func (*BatchDetectSyntaxInput) Validate added in v1.14.28

func (s *BatchDetectSyntaxInput) Validate() error

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

type BatchDetectSyntaxItemResult added in v1.14.28

type BatchDetectSyntaxItemResult struct {

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

	// The syntax tokens for the words in the document, one token for each word.
	SyntaxTokens []*SyntaxToken `type:"list"`
	// contains filtered or unexported fields
}

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

func (BatchDetectSyntaxItemResult) GoString added in v1.14.28

func (s BatchDetectSyntaxItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxItemResult) SetIndex added in v1.14.28

SetIndex sets the Index field's value.

func (*BatchDetectSyntaxItemResult) SetSyntaxTokens added in v1.14.28

SetSyntaxTokens sets the SyntaxTokens field's value.

func (BatchDetectSyntaxItemResult) String added in v1.14.28

String returns the string representation

type BatchDetectSyntaxOutput added in v1.14.28

type BatchDetectSyntaxOutput 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 []*BatchDetectSyntaxItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDetectSyntaxOutput) GoString added in v1.14.28

func (s BatchDetectSyntaxOutput) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxOutput) SetErrorList added in v1.14.28

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSyntaxOutput) SetResultList added in v1.14.28

SetResultList sets the ResultList field's value.

func (BatchDetectSyntaxOutput) String added in v1.14.28

func (s BatchDetectSyntaxOutput) 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 ClassifierEvaluationMetrics added in v1.99.0

type ClassifierEvaluationMetrics struct {

	// The fraction of the labels that were correct recognized. It is computed by
	// dividing the number of labels in the test documents that were correctly recognized
	// by the total number of labels in the test documents.
	Accuracy *float64 `type:"double"`

	// A measure of how accurate the classifier results are for the test data. It
	// is derived from the Precision and Recall values. The F1Score is the harmonic
	// average of the two scores. The highest score is 1, and the worst score is
	// 0.
	F1Score *float64 `type:"double"`

	// A measure of the usefulness of the classifier results in the test data. High
	// precision means that the classifier returned substantially more relevant
	// results than irrelevant ones.
	Precision *float64 `type:"double"`

	// A measure of how complete the classifier results are for the test data. High
	// recall means that the classifier returned most of the relevant results.
	Recall *float64 `type:"double"`
	// contains filtered or unexported fields
}

Describes the result metrics for the test data associated with an documentation classifier.

func (ClassifierEvaluationMetrics) GoString added in v1.99.0

func (s ClassifierEvaluationMetrics) GoString() string

GoString returns the string representation

func (*ClassifierEvaluationMetrics) SetAccuracy added in v1.99.0

SetAccuracy sets the Accuracy field's value.

func (*ClassifierEvaluationMetrics) SetF1Score added in v1.99.0

SetF1Score sets the F1Score field's value.

func (*ClassifierEvaluationMetrics) SetPrecision added in v1.99.0

SetPrecision sets the Precision field's value.

func (*ClassifierEvaluationMetrics) SetRecall added in v1.99.0

SetRecall sets the Recall field's value.

func (ClassifierEvaluationMetrics) String added in v1.99.0

String returns the string representation

type ClassifierMetadata added in v1.99.0

type ClassifierMetadata struct {

	// Describes the result metrics for the test data associated with an documentation
	// classifier.
	EvaluationMetrics *ClassifierEvaluationMetrics `type:"structure"`

	// The number of labels in the input data.
	NumberOfLabels *int64 `type:"integer"`

	// The number of documents in the input data that were used to test the classifier.
	// Typically this is 10 to 20 percent of the input documents.
	NumberOfTestDocuments *int64 `type:"integer"`

	// The number of documents in the input data that were used to train the classifier.
	// Typically this is 80 to 90 percent of the input documents.
	NumberOfTrainedDocuments *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Provides information about a document classifier.

func (ClassifierMetadata) GoString added in v1.99.0

func (s ClassifierMetadata) GoString() string

GoString returns the string representation

func (*ClassifierMetadata) SetEvaluationMetrics added in v1.99.0

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*ClassifierMetadata) SetNumberOfLabels added in v1.99.0

func (s *ClassifierMetadata) SetNumberOfLabels(v int64) *ClassifierMetadata

SetNumberOfLabels sets the NumberOfLabels field's value.

func (*ClassifierMetadata) SetNumberOfTestDocuments added in v1.99.0

func (s *ClassifierMetadata) SetNumberOfTestDocuments(v int64) *ClassifierMetadata

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*ClassifierMetadata) SetNumberOfTrainedDocuments added in v1.99.0

func (s *ClassifierMetadata) SetNumberOfTrainedDocuments(v int64) *ClassifierMetadata

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (ClassifierMetadata) String added in v1.99.0

func (s ClassifierMetadata) 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 (https://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 successfully.

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

See 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-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 successfully.

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

See 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-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 successfully.

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

See 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-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 successfully.

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

See 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) BatchDetectSyntax added in v1.14.28

func (c *Comprehend) BatchDetectSyntax(input *BatchDetectSyntaxInput) (*BatchDetectSyntaxOutput, error)

BatchDetectSyntax API operation for Amazon Comprehend.

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax.

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 BatchDetectSyntax 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-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/BatchDetectSyntax

func (*Comprehend) BatchDetectSyntaxRequest added in v1.14.28

func (c *Comprehend) BatchDetectSyntaxRequest(input *BatchDetectSyntaxInput) (req *request.Request, output *BatchDetectSyntaxOutput)

BatchDetectSyntaxRequest generates a "aws/request.Request" representing the client's request for the BatchDetectSyntax operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See BatchDetectSyntax for more information on using the BatchDetectSyntax 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 BatchDetectSyntaxRequest method.
req, resp := client.BatchDetectSyntaxRequest(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/BatchDetectSyntax

func (*Comprehend) BatchDetectSyntaxWithContext added in v1.14.28

func (c *Comprehend) BatchDetectSyntaxWithContext(ctx aws.Context, input *BatchDetectSyntaxInput, opts ...request.Option) (*BatchDetectSyntaxOutput, error)

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

See BatchDetectSyntax 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) CreateDocumentClassifier added in v1.99.0

func (c *Comprehend) CreateDocumentClassifier(input *CreateDocumentClassifierInput) (*CreateDocumentClassifierOutput, error)

CreateDocumentClassifier API operation for Amazon Comprehend.

Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified name is already in use. Use a different name and try your request again.

  • ErrCodeTooManyTagsException "TooManyTagsException" The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

  • ErrCodeResourceLimitExceededException "ResourceLimitExceededException" The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup, and then try your request again.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-languages.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

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

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

func (*Comprehend) CreateDocumentClassifierRequest added in v1.99.0

func (c *Comprehend) CreateDocumentClassifierRequest(input *CreateDocumentClassifierInput) (req *request.Request, output *CreateDocumentClassifierOutput)

CreateDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the CreateDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See CreateDocumentClassifier for more information on using the CreateDocumentClassifier 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 CreateDocumentClassifierRequest method.
req, resp := client.CreateDocumentClassifierRequest(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/CreateDocumentClassifier

func (*Comprehend) CreateDocumentClassifierWithContext added in v1.99.0

func (c *Comprehend) CreateDocumentClassifierWithContext(ctx aws.Context, input *CreateDocumentClassifierInput, opts ...request.Option) (*CreateDocumentClassifierOutput, error)

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

See CreateDocumentClassifier 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) CreateEntityRecognizer added in v1.99.0

func (c *Comprehend) CreateEntityRecognizer(input *CreateEntityRecognizerInput) (*CreateEntityRecognizerOutput, error)

CreateEntityRecognizer API operation for Amazon Comprehend.

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified name is already in use. Use a different name and try your request again.

  • ErrCodeTooManyTagsException "TooManyTagsException" The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

  • ErrCodeResourceLimitExceededException "ResourceLimitExceededException" The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup, and then try your request again.

  • ErrCodeUnsupportedLanguageException "UnsupportedLanguageException" Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-languages.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

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

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

func (*Comprehend) CreateEntityRecognizerRequest added in v1.99.0

func (c *Comprehend) CreateEntityRecognizerRequest(input *CreateEntityRecognizerInput) (req *request.Request, output *CreateEntityRecognizerOutput)

CreateEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the CreateEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See CreateEntityRecognizer for more information on using the CreateEntityRecognizer 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 CreateEntityRecognizerRequest method.
req, resp := client.CreateEntityRecognizerRequest(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/CreateEntityRecognizer

func (*Comprehend) CreateEntityRecognizerWithContext added in v1.99.0

func (c *Comprehend) CreateEntityRecognizerWithContext(ctx aws.Context, input *CreateEntityRecognizerInput, opts ...request.Option) (*CreateEntityRecognizerOutput, error)

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

See CreateEntityRecognizer 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) DeleteDocumentClassifier added in v1.99.0

func (c *Comprehend) DeleteDocumentClassifier(input *DeleteDocumentClassifierInput) (*DeleteDocumentClassifierOutput, error)

DeleteDocumentClassifier API operation for Amazon Comprehend.

Deletes a previously created document classifier

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified name is already in use. Use a different name and try your request again.

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

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

func (*Comprehend) DeleteDocumentClassifierRequest added in v1.99.0

func (c *Comprehend) DeleteDocumentClassifierRequest(input *DeleteDocumentClassifierInput) (req *request.Request, output *DeleteDocumentClassifierOutput)

DeleteDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the DeleteDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See DeleteDocumentClassifier for more information on using the DeleteDocumentClassifier 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 DeleteDocumentClassifierRequest method.
req, resp := client.DeleteDocumentClassifierRequest(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/DeleteDocumentClassifier

func (*Comprehend) DeleteDocumentClassifierWithContext added in v1.99.0

func (c *Comprehend) DeleteDocumentClassifierWithContext(ctx aws.Context, input *DeleteDocumentClassifierInput, opts ...request.Option) (*DeleteDocumentClassifierOutput, error)

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

See DeleteDocumentClassifier 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) DeleteEntityRecognizer added in v1.99.0

func (c *Comprehend) DeleteEntityRecognizer(input *DeleteEntityRecognizerInput) (*DeleteEntityRecognizerOutput, error)

DeleteEntityRecognizer API operation for Amazon Comprehend.

Deletes an entity recognizer.

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

  • ErrCodeResourceInUseException "ResourceInUseException" The specified name is already in use. Use a different name and try your request again.

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

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

func (*Comprehend) DeleteEntityRecognizerRequest added in v1.99.0

func (c *Comprehend) DeleteEntityRecognizerRequest(input *DeleteEntityRecognizerInput) (req *request.Request, output *DeleteEntityRecognizerOutput)

DeleteEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the DeleteEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See DeleteEntityRecognizer for more information on using the DeleteEntityRecognizer 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 DeleteEntityRecognizerRequest method.
req, resp := client.DeleteEntityRecognizerRequest(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/DeleteEntityRecognizer

func (*Comprehend) DeleteEntityRecognizerWithContext added in v1.99.0

func (c *Comprehend) DeleteEntityRecognizerWithContext(ctx aws.Context, input *DeleteEntityRecognizerInput, opts ...request.Option) (*DeleteEntityRecognizerOutput, error)

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

See DeleteEntityRecognizer 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) DescribeDocumentClassificationJob added in v1.99.0

DescribeDocumentClassificationJob API operation for Amazon Comprehend.

Gets the properties associated with a document classification job. Use this operation to get the status of a classification 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 DescribeDocumentClassificationJob 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.

  • 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/DescribeDocumentClassificationJob

func (*Comprehend) DescribeDocumentClassificationJobRequest added in v1.99.0

func (c *Comprehend) DescribeDocumentClassificationJobRequest(input *DescribeDocumentClassificationJobInput) (req *request.Request, output *DescribeDocumentClassificationJobOutput)

DescribeDocumentClassificationJobRequest generates a "aws/request.Request" representing the client's request for the DescribeDocumentClassificationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See DescribeDocumentClassificationJob for more information on using the DescribeDocumentClassificationJob 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 DescribeDocumentClassificationJobRequest method.
req, resp := client.DescribeDocumentClassificationJobRequest(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/DescribeDocumentClassificationJob

func (*Comprehend) DescribeDocumentClassificationJobWithContext added in v1.99.0

func (c *Comprehend) DescribeDocumentClassificationJobWithContext(ctx aws.Context, input *DescribeDocumentClassificationJobInput, opts ...request.Option) (*DescribeDocumentClassificationJobOutput, error)

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

See DescribeDocumentClassificationJob 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) DescribeDocumentClassifier added in v1.99.0

func (c *Comprehend) DescribeDocumentClassifier(input *DescribeDocumentClassifierInput) (*DescribeDocumentClassifierOutput, error)

DescribeDocumentClassifier API operation for Amazon Comprehend.

Gets the properties associated with a document classifier.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

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

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

func (*Comprehend) DescribeDocumentClassifierRequest added in v1.99.0

func (c *Comprehend) DescribeDocumentClassifierRequest(input *DescribeDocumentClassifierInput) (req *request.Request, output *DescribeDocumentClassifierOutput)

DescribeDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the DescribeDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See DescribeDocumentClassifier for more information on using the DescribeDocumentClassifier 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 DescribeDocumentClassifierRequest method.
req, resp := client.DescribeDocumentClassifierRequest(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/DescribeDocumentClassifier

func (*Comprehend) DescribeDocumentClassifierWithContext added in v1.99.0

func (c *Comprehend) DescribeDocumentClassifierWithContext(ctx aws.Context, input *DescribeDocumentClassifierInput, opts ...request.Option) (*DescribeDocumentClassifierOutput, error)

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

See DescribeDocumentClassifier 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 added in v1.14.15

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

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

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

See 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 added in v1.14.15

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

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

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

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

See 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 added in v1.14.15

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) DescribeEntityRecognizer added in v1.99.0

func (c *Comprehend) DescribeEntityRecognizer(input *DescribeEntityRecognizerInput) (*DescribeEntityRecognizerOutput, error)

DescribeEntityRecognizer API operation for Amazon Comprehend.

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

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

See the AWS API reference guide for Amazon Comprehend's API operation DescribeEntityRecognizer 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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

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

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

func (*Comprehend) DescribeEntityRecognizerRequest added in v1.99.0

func (c *Comprehend) DescribeEntityRecognizerRequest(input *DescribeEntityRecognizerInput) (req *request.Request, output *DescribeEntityRecognizerOutput)

DescribeEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the DescribeEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See DescribeEntityRecognizer for more information on using the DescribeEntityRecognizer 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 DescribeEntityRecognizerRequest method.
req, resp := client.DescribeEntityRecognizerRequest(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/DescribeEntityRecognizer

func (*Comprehend) DescribeEntityRecognizerWithContext added in v1.99.0

func (c *Comprehend) DescribeEntityRecognizerWithContext(ctx aws.Context, input *DescribeEntityRecognizerInput, opts ...request.Option) (*DescribeEntityRecognizerOutput, error)

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

See DescribeEntityRecognizer 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 added in v1.14.15

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

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

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

See 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 added in v1.14.15

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

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

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

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

See 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 added in v1.14.15

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

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

See 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 (https://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 successfully.

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

See 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-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 successfully.

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

See 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-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 successfully.

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

See 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-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 successfully.

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

See 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) DetectSyntax added in v1.14.28

func (c *Comprehend) DetectSyntax(input *DetectSyntaxInput) (*DetectSyntaxOutput, error)

DetectSyntax API operation for Amazon Comprehend.

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

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 DetectSyntax 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 custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-languages.

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

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

func (*Comprehend) DetectSyntaxRequest added in v1.14.28

func (c *Comprehend) DetectSyntaxRequest(input *DetectSyntaxInput) (req *request.Request, output *DetectSyntaxOutput)

DetectSyntaxRequest generates a "aws/request.Request" representing the client's request for the DetectSyntax operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See DetectSyntax for more information on using the DetectSyntax 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 DetectSyntaxRequest method.
req, resp := client.DetectSyntaxRequest(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/DetectSyntax

func (*Comprehend) DetectSyntaxWithContext added in v1.14.28

func (c *Comprehend) DetectSyntaxWithContext(ctx aws.Context, input *DetectSyntaxInput, opts ...request.Option) (*DetectSyntaxOutput, error)

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

See DetectSyntax 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) ListDocumentClassificationJobs added in v1.99.0

func (c *Comprehend) ListDocumentClassificationJobs(input *ListDocumentClassificationJobsInput) (*ListDocumentClassificationJobsOutput, error)

ListDocumentClassificationJobs API operation for Amazon Comprehend.

Gets a list of the documentation classification 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 ListDocumentClassificationJobs 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 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/ListDocumentClassificationJobs

func (*Comprehend) ListDocumentClassificationJobsPages added in v1.99.0

func (c *Comprehend) ListDocumentClassificationJobsPages(input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool) error

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

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

func (*Comprehend) ListDocumentClassificationJobsPagesWithContext added in v1.99.0

func (c *Comprehend) ListDocumentClassificationJobsPagesWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool, opts ...request.Option) error

ListDocumentClassificationJobsPagesWithContext same as ListDocumentClassificationJobsPages 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) ListDocumentClassificationJobsRequest added in v1.99.0

func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentClassificationJobsInput) (req *request.Request, output *ListDocumentClassificationJobsOutput)

ListDocumentClassificationJobsRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassificationJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See ListDocumentClassificationJobs for more information on using the ListDocumentClassificationJobs 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 ListDocumentClassificationJobsRequest method.
req, resp := client.ListDocumentClassificationJobsRequest(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/ListDocumentClassificationJobs

func (*Comprehend) ListDocumentClassificationJobsWithContext added in v1.99.0

func (c *Comprehend) ListDocumentClassificationJobsWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, opts ...request.Option) (*ListDocumentClassificationJobsOutput, error)

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

See ListDocumentClassificationJobs 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) ListDocumentClassifiers added in v1.99.0

func (c *Comprehend) ListDocumentClassifiers(input *ListDocumentClassifiersInput) (*ListDocumentClassifiersOutput, error)

ListDocumentClassifiers API operation for Amazon Comprehend.

Gets a list of the document classifiers that you have created.

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

func (*Comprehend) ListDocumentClassifiersPages added in v1.99.0

func (c *Comprehend) ListDocumentClassifiersPages(input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool) error

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

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

func (*Comprehend) ListDocumentClassifiersPagesWithContext added in v1.99.0

func (c *Comprehend) ListDocumentClassifiersPagesWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool, opts ...request.Option) error

ListDocumentClassifiersPagesWithContext same as ListDocumentClassifiersPages 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) ListDocumentClassifiersRequest added in v1.99.0

func (c *Comprehend) ListDocumentClassifiersRequest(input *ListDocumentClassifiersInput) (req *request.Request, output *ListDocumentClassifiersOutput)

ListDocumentClassifiersRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassifiers operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See ListDocumentClassifiers for more information on using the ListDocumentClassifiers 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 ListDocumentClassifiersRequest method.
req, resp := client.ListDocumentClassifiersRequest(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/ListDocumentClassifiers

func (*Comprehend) ListDocumentClassifiersWithContext added in v1.99.0

func (c *Comprehend) ListDocumentClassifiersWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, opts ...request.Option) (*ListDocumentClassifiersOutput, error)

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

See ListDocumentClassifiers 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 added in v1.14.15

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

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 *comprehend.ListDominantLanguageDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListDominantLanguageDetectionJobsPagesWithContext added in v1.14.15

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

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

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

See 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 added in v1.14.15

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

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

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 *comprehend.ListEntitiesDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListEntitiesDetectionJobsPagesWithContext added in v1.14.15

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

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

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

See 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 added in v1.14.15

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) ListEntityRecognizers added in v1.99.0

func (c *Comprehend) ListEntityRecognizers(input *ListEntityRecognizersInput) (*ListEntityRecognizersOutput, error)

ListEntityRecognizers API operation for Amazon Comprehend.

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

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

func (*Comprehend) ListEntityRecognizersPages added in v1.99.0

func (c *Comprehend) ListEntityRecognizersPages(input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool) error

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

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

func (*Comprehend) ListEntityRecognizersPagesWithContext added in v1.99.0

func (c *Comprehend) ListEntityRecognizersPagesWithContext(ctx aws.Context, input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool, opts ...request.Option) error

ListEntityRecognizersPagesWithContext same as ListEntityRecognizersPages 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) ListEntityRecognizersRequest added in v1.99.0

func (c *Comprehend) ListEntityRecognizersRequest(input *ListEntityRecognizersInput) (req *request.Request, output *ListEntityRecognizersOutput)

ListEntityRecognizersRequest generates a "aws/request.Request" representing the client's request for the ListEntityRecognizers operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See ListEntityRecognizers for more information on using the ListEntityRecognizers 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 ListEntityRecognizersRequest method.
req, resp := client.ListEntityRecognizersRequest(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/ListEntityRecognizers

func (*Comprehend) ListEntityRecognizersWithContext added in v1.99.0

func (c *Comprehend) ListEntityRecognizersWithContext(ctx aws.Context, input *ListEntityRecognizersInput, opts ...request.Option) (*ListEntityRecognizersOutput, error)

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

See ListEntityRecognizers 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 added in v1.14.15

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

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 *comprehend.ListKeyPhrasesDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext added in v1.14.15

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

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

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

See 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 added in v1.14.15

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

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

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 *comprehend.ListSentimentDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListSentimentDetectionJobsPagesWithContext added in v1.14.15

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

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

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

See 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 added in v1.14.15

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) ListTagsForResource added in v1.99.0

func (c *Comprehend) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Comprehend.

Lists all tags associated with a given Amazon Comprehend resource.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

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

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

func (*Comprehend) ListTagsForResourceRequest added in v1.99.0

func (c *Comprehend) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*Comprehend) ListTagsForResourceWithContext added in v1.99.0

func (c *Comprehend) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 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 *comprehend.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 successfully.

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

See 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) StartDocumentClassificationJob added in v1.99.0

func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error)

StartDocumentClassificationJob API operation for Amazon Comprehend.

Starts an asynchronous document classification job. Use the operation to track the progress of the 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 StartDocumentClassificationJob 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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

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

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

func (*Comprehend) StartDocumentClassificationJobRequest added in v1.99.0

func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) (req *request.Request, output *StartDocumentClassificationJobOutput)

StartDocumentClassificationJobRequest generates a "aws/request.Request" representing the client's request for the StartDocumentClassificationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See StartDocumentClassificationJob for more information on using the StartDocumentClassificationJob 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 StartDocumentClassificationJobRequest method.
req, resp := client.StartDocumentClassificationJobRequest(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/StartDocumentClassificationJob

func (*Comprehend) StartDocumentClassificationJobWithContext added in v1.99.0

func (c *Comprehend) StartDocumentClassificationJobWithContext(ctx aws.Context, input *StartDocumentClassificationJobInput, opts ...request.Option) (*StartDocumentClassificationJobOutput, error)

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

See StartDocumentClassificationJob 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 added in v1.14.15

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.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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

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.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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

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.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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

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.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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.

  • ErrCodeKmsKeyValidationException "KmsKeyValidationException" The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

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

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

See 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 added in v1.14.15

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 is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

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

When a job is stopped, any documents already processed are 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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

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 is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

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

When a job is stopped, any documents already processed are 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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

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 is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

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

When a job is stopped, any documents already processed are 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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

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 is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

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

When a job is stopped, any documents already processed are 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 added in v1.14.15

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

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

See 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 added in v1.14.15

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.

func (*Comprehend) StopTrainingDocumentClassifier added in v1.99.0

func (c *Comprehend) StopTrainingDocumentClassifier(input *StopTrainingDocumentClassifierInput) (*StopTrainingDocumentClassifierOutput, error)

StopTrainingDocumentClassifier API operation for Amazon Comprehend.

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

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

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

func (*Comprehend) StopTrainingDocumentClassifierRequest added in v1.99.0

func (c *Comprehend) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) (req *request.Request, output *StopTrainingDocumentClassifierOutput)

StopTrainingDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the StopTrainingDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See StopTrainingDocumentClassifier for more information on using the StopTrainingDocumentClassifier 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 StopTrainingDocumentClassifierRequest method.
req, resp := client.StopTrainingDocumentClassifierRequest(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/StopTrainingDocumentClassifier

func (*Comprehend) StopTrainingDocumentClassifierWithContext added in v1.99.0

func (c *Comprehend) StopTrainingDocumentClassifierWithContext(ctx aws.Context, input *StopTrainingDocumentClassifierInput, opts ...request.Option) (*StopTrainingDocumentClassifierOutput, error)

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

See StopTrainingDocumentClassifier 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) StopTrainingEntityRecognizer added in v1.99.0

func (c *Comprehend) StopTrainingEntityRecognizer(input *StopTrainingEntityRecognizerInput) (*StopTrainingEntityRecognizerOutput, error)

StopTrainingEntityRecognizer API operation for Amazon Comprehend.

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

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

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

func (*Comprehend) StopTrainingEntityRecognizerRequest added in v1.99.0

func (c *Comprehend) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) (req *request.Request, output *StopTrainingEntityRecognizerOutput)

StopTrainingEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the StopTrainingEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See StopTrainingEntityRecognizer for more information on using the StopTrainingEntityRecognizer 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 StopTrainingEntityRecognizerRequest method.
req, resp := client.StopTrainingEntityRecognizerRequest(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/StopTrainingEntityRecognizer

func (*Comprehend) StopTrainingEntityRecognizerWithContext added in v1.99.0

func (c *Comprehend) StopTrainingEntityRecognizerWithContext(ctx aws.Context, input *StopTrainingEntityRecognizerInput, opts ...request.Option) (*StopTrainingEntityRecognizerOutput, error)

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

See StopTrainingEntityRecognizer 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) TagResource added in v1.99.0

func (c *Comprehend) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Comprehend.

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

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

Returned Error Codes:

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

  • ErrCodeTooManyTagsException "TooManyTagsException" The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

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

func (*Comprehend) TagResourceRequest added in v1.99.0

func (c *Comprehend) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*Comprehend) TagResourceWithContext added in v1.99.0

func (c *Comprehend) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.99.0

func (c *Comprehend) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Comprehend.

Removes a specific tag associated with an Amazon Comprehend resource.

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

Returned Error Codes:

  • ErrCodeTooManyTagKeysException "TooManyTagKeysException" The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

  • ErrCodeInvalidRequestException "InvalidRequestException" The request is invalid.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource ARN was not found. Check the ARN and try your request again.

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

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

func (*Comprehend) UntagResourceRequest added in v1.99.0

func (c *Comprehend) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

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

See UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*Comprehend) UntagResourceWithContext added in v1.99.0

func (c *Comprehend) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 CreateDocumentClassifierInput added in v1.99.0

type CreateDocumentClassifierInput 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 `min:"20" type:"string" required:"true"`

	// The name of the document classifier.
	//
	// DocumentClassifierName is a required field
	DocumentClassifierName *string `type:"string" required:"true"`

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

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be
	// in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Enables the addition of output results configuration parameters for custom
	// classifier jobs.
	OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

	// Tags to be associated with the document classifier being created. A tag is
	// a key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
	// For example, a tag with "Sales" as the key might be added to a resource to
	// indicate its use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your custom classifier. For more
	// information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDocumentClassifierInput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateDocumentClassifierInput) SetClientRequestToken added in v1.99.0

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDocumentClassifierInput) SetDataAccessRoleArn added in v1.99.0

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateDocumentClassifierInput) SetDocumentClassifierName added in v1.99.0

func (s *CreateDocumentClassifierInput) SetDocumentClassifierName(v string) *CreateDocumentClassifierInput

SetDocumentClassifierName sets the DocumentClassifierName field's value.

func (*CreateDocumentClassifierInput) SetInputDataConfig added in v1.99.0

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetLanguageCode added in v1.99.0

SetLanguageCode sets the LanguageCode field's value.

func (*CreateDocumentClassifierInput) SetOutputDataConfig added in v1.99.0

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (*CreateDocumentClassifierInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateDocumentClassifierInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (CreateDocumentClassifierInput) String added in v1.99.0

String returns the string representation

func (*CreateDocumentClassifierInput) Validate added in v1.99.0

func (s *CreateDocumentClassifierInput) Validate() error

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

type CreateDocumentClassifierOutput added in v1.99.0

type CreateDocumentClassifierOutput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDocumentClassifierOutput) GoString added in v1.99.0

GoString returns the string representation

func (*CreateDocumentClassifierOutput) SetDocumentClassifierArn added in v1.99.0

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (CreateDocumentClassifierOutput) String added in v1.99.0

String returns the string representation

type CreateEntityRecognizerInput added in v1.99.0

type CreateEntityRecognizerInput 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 `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data. The S3 bucket containing
	// the input data must be located in the same region as the entity recognizer
	// being created.
	//
	// InputDataConfig is a required field
	InputDataConfig *EntityRecognizerInputDataConfig `type:"structure" required:"true"`

	// The language of the input documents. All documents must be in the same language.
	// Only English ("en") is currently supported.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// The name given to the newly created recognizer. Recognizer names can be a
	// maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
	// (_) are allowed. The name must be unique in the account/region.
	//
	// RecognizerName is a required field
	RecognizerName *string `type:"string" required:"true"`

	// Tags to be associated with the entity recognizer being created. A tag is
	// a key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
	// For example, a tag with "Sales" as the key might be added to a resource to
	// indicate its use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your custom entity recognizer.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateEntityRecognizerInput) GoString added in v1.99.0

func (s CreateEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*CreateEntityRecognizerInput) SetClientRequestToken added in v1.99.0

func (s *CreateEntityRecognizerInput) SetClientRequestToken(v string) *CreateEntityRecognizerInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEntityRecognizerInput) SetDataAccessRoleArn added in v1.99.0

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateEntityRecognizerInput) SetInputDataConfig added in v1.99.0

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateEntityRecognizerInput) SetLanguageCode added in v1.99.0

SetLanguageCode sets the LanguageCode field's value.

func (*CreateEntityRecognizerInput) SetRecognizerName added in v1.99.0

SetRecognizerName sets the RecognizerName field's value.

func (*CreateEntityRecognizerInput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (*CreateEntityRecognizerInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateEntityRecognizerInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (CreateEntityRecognizerInput) String added in v1.99.0

String returns the string representation

func (*CreateEntityRecognizerInput) Validate added in v1.99.0

func (s *CreateEntityRecognizerInput) Validate() error

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

type CreateEntityRecognizerOutput added in v1.99.0

type CreateEntityRecognizerOutput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateEntityRecognizerOutput) GoString added in v1.99.0

func (s CreateEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (*CreateEntityRecognizerOutput) SetEntityRecognizerArn added in v1.99.0

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (CreateEntityRecognizerOutput) String added in v1.99.0

String returns the string representation

type DeleteDocumentClassifierInput added in v1.99.0

type DeleteDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	//
	// DocumentClassifierArn is a required field
	DocumentClassifierArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDocumentClassifierInput) GoString added in v1.99.0

GoString returns the string representation

func (*DeleteDocumentClassifierInput) SetDocumentClassifierArn added in v1.99.0

func (s *DeleteDocumentClassifierInput) SetDocumentClassifierArn(v string) *DeleteDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DeleteDocumentClassifierInput) String added in v1.99.0

String returns the string representation

func (*DeleteDocumentClassifierInput) Validate added in v1.99.0

func (s *DeleteDocumentClassifierInput) Validate() error

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

type DeleteDocumentClassifierOutput added in v1.99.0

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

func (DeleteDocumentClassifierOutput) GoString added in v1.99.0

GoString returns the string representation

func (DeleteDocumentClassifierOutput) String added in v1.99.0

String returns the string representation

type DeleteEntityRecognizerInput added in v1.99.0

type DeleteEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	//
	// EntityRecognizerArn is a required field
	EntityRecognizerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEntityRecognizerInput) GoString added in v1.99.0

func (s DeleteEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*DeleteEntityRecognizerInput) SetEntityRecognizerArn added in v1.99.0

func (s *DeleteEntityRecognizerInput) SetEntityRecognizerArn(v string) *DeleteEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DeleteEntityRecognizerInput) String added in v1.99.0

String returns the string representation

func (*DeleteEntityRecognizerInput) Validate added in v1.99.0

func (s *DeleteEntityRecognizerInput) Validate() error

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

type DeleteEntityRecognizerOutput added in v1.99.0

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

func (DeleteEntityRecognizerOutput) GoString added in v1.99.0

func (s DeleteEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (DeleteEntityRecognizerOutput) String added in v1.99.0

String returns the string representation

type DescribeDocumentClassificationJobInput added in v1.99.0

type DescribeDocumentClassificationJobInput 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 (DescribeDocumentClassificationJobInput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeDocumentClassificationJobInput) SetJobId added in v1.99.0

SetJobId sets the JobId field's value.

func (DescribeDocumentClassificationJobInput) String added in v1.99.0

String returns the string representation

func (*DescribeDocumentClassificationJobInput) Validate added in v1.99.0

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

type DescribeDocumentClassificationJobOutput added in v1.99.0

type DescribeDocumentClassificationJobOutput struct {

	// An object that describes the properties associated with the document classification
	// job.
	DocumentClassificationJobProperties *DocumentClassificationJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDocumentClassificationJobOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties added in v1.99.0

SetDocumentClassificationJobProperties sets the DocumentClassificationJobProperties field's value.

func (DescribeDocumentClassificationJobOutput) String added in v1.99.0

String returns the string representation

type DescribeDocumentClassifierInput added in v1.99.0

type DescribeDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier. The
	// operation returns this identifier in its response.
	//
	// DocumentClassifierArn is a required field
	DocumentClassifierArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDocumentClassifierInput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeDocumentClassifierInput) SetDocumentClassifierArn added in v1.99.0

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DescribeDocumentClassifierInput) String added in v1.99.0

String returns the string representation

func (*DescribeDocumentClassifierInput) Validate added in v1.99.0

func (s *DescribeDocumentClassifierInput) Validate() error

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

type DescribeDocumentClassifierOutput added in v1.99.0

type DescribeDocumentClassifierOutput struct {

	// An object that contains the properties associated with a document classifier.
	DocumentClassifierProperties *DocumentClassifierProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDocumentClassifierOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeDocumentClassifierOutput) SetDocumentClassifierProperties added in v1.99.0

SetDocumentClassifierProperties sets the DocumentClassifierProperties field's value.

func (DescribeDocumentClassifierOutput) String added in v1.99.0

String returns the string representation

type DescribeDominantLanguageDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (DescribeDominantLanguageDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) Validate added in v1.14.15

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

type DescribeDominantLanguageDetectionJobOutput added in v1.14.15

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

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties added in v1.14.15

SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value.

func (DescribeDominantLanguageDetectionJobOutput) String added in v1.14.15

String returns the string representation

type DescribeEntitiesDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*DescribeEntitiesDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*DescribeEntitiesDetectionJobInput) Validate added in v1.14.15

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

type DescribeEntitiesDetectionJobOutput added in v1.14.15

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

GoString returns the string representation

func (*DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties added in v1.14.15

SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value.

func (DescribeEntitiesDetectionJobOutput) String added in v1.14.15

String returns the string representation

type DescribeEntityRecognizerInput added in v1.99.0

type DescribeEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	//
	// EntityRecognizerArn is a required field
	EntityRecognizerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEntityRecognizerInput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeEntityRecognizerInput) SetEntityRecognizerArn added in v1.99.0

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DescribeEntityRecognizerInput) String added in v1.99.0

String returns the string representation

func (*DescribeEntityRecognizerInput) Validate added in v1.99.0

func (s *DescribeEntityRecognizerInput) Validate() error

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

type DescribeEntityRecognizerOutput added in v1.99.0

type DescribeEntityRecognizerOutput struct {

	// Describes information associated with an entity recognizer.
	EntityRecognizerProperties *EntityRecognizerProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEntityRecognizerOutput) GoString added in v1.99.0

GoString returns the string representation

func (*DescribeEntityRecognizerOutput) SetEntityRecognizerProperties added in v1.99.0

SetEntityRecognizerProperties sets the EntityRecognizerProperties field's value.

func (DescribeEntityRecognizerOutput) String added in v1.99.0

String returns the string representation

type DescribeKeyPhrasesDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (DescribeKeyPhrasesDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) Validate added in v1.14.15

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

type DescribeKeyPhrasesDetectionJobOutput added in v1.14.15

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

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties added in v1.14.15

SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value.

func (DescribeKeyPhrasesDetectionJobOutput) String added in v1.14.15

String returns the string representation

type DescribeSentimentDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*DescribeSentimentDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (DescribeSentimentDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*DescribeSentimentDetectionJobInput) Validate added in v1.14.15

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

type DescribeSentimentDetectionJobOutput added in v1.14.15

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

GoString returns the string representation

func (*DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties added in v1.14.15

SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value.

func (DescribeSentimentDetectionJobOutput) String added in v1.14.15

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

GoString returns the string representation

func (*DescribeTopicsDetectionJobInput) SetJobId

SetJobId sets the JobId field's value.

func (DescribeTopicsDetectionJobInput) 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

GoString returns the string representation

func (*DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties

SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value.

func (DescribeTopicsDetectionJobOutput) 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

SetText sets the Text field's value.

func (DetectDominantLanguageInput) 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

SetLanguages sets the Languages field's value.

func (DetectDominantLanguageOutput) String

String returns the string representation

type DetectEntitiesInput

type DetectEntitiesInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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

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 any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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

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

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 any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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

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

SetSentiment sets the Sentiment field's value.

func (*DetectSentimentOutput) SetSentimentScore

SetSentimentScore sets the SentimentScore field's value.

func (DetectSentimentOutput) String

func (s DetectSentimentOutput) String() string

String returns the string representation

type DetectSyntaxInput added in v1.14.28

type DetectSyntaxInput struct {

	// The language code of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend: German ("de"), English ("en"),
	// Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"`

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

func (DetectSyntaxInput) GoString added in v1.14.28

func (s DetectSyntaxInput) GoString() string

GoString returns the string representation

func (*DetectSyntaxInput) SetLanguageCode added in v1.14.28

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSyntaxInput) SetText added in v1.14.28

SetText sets the Text field's value.

func (DetectSyntaxInput) String added in v1.14.28

func (s DetectSyntaxInput) String() string

String returns the string representation

func (*DetectSyntaxInput) Validate added in v1.14.28

func (s *DetectSyntaxInput) Validate() error

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

type DetectSyntaxOutput added in v1.14.28

type DetectSyntaxOutput struct {

	// A collection of syntax tokens describing the text. For each token, the response
	// provides the text, the token type, where the text begins and ends, and the
	// level of confidence that Amazon Comprehend has that the token is correct.
	// For a list of token types, see how-syntax.
	SyntaxTokens []*SyntaxToken `type:"list"`
	// contains filtered or unexported fields
}

func (DetectSyntaxOutput) GoString added in v1.14.28

func (s DetectSyntaxOutput) GoString() string

GoString returns the string representation

func (*DetectSyntaxOutput) SetSyntaxTokens added in v1.14.28

func (s *DetectSyntaxOutput) SetSyntaxTokens(v []*SyntaxToken) *DetectSyntaxOutput

SetSyntaxTokens sets the SyntaxTokens field's value.

func (DetectSyntaxOutput) String added in v1.14.28

func (s DetectSyntaxOutput) String() string

String returns the string representation

type DocumentClassificationJobFilter added in v1.99.0

type DocumentClassificationJobFilter struct {

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

	// Filters the list 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 before the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// 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 ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

func (DocumentClassificationJobFilter) GoString added in v1.99.0

GoString returns the string representation

func (*DocumentClassificationJobFilter) SetJobName added in v1.99.0

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobFilter) SetJobStatus added in v1.99.0

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeAfter added in v1.99.0

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeBefore added in v1.99.0

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassificationJobFilter) String added in v1.99.0

String returns the string representation

func (*DocumentClassificationJobFilter) Validate added in v1.99.0

func (s *DocumentClassificationJobFilter) Validate() error

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

type DocumentClassificationJobProperties added in v1.99.0

type DocumentClassificationJobProperties struct {

	// 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 *string `min:"20" type:"string"`

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string `type:"string"`

	// The time that the document classification job completed.
	EndTime *time.Time `type:"timestamp"`

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

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

	// The name that you assigned to the document classification job.
	JobName *string `min:"1" type:"string"`

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

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

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

	// The time that the document classification job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your document classification job. For more
	// information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a document classification job.

func (DocumentClassificationJobProperties) GoString added in v1.99.0

GoString returns the string representation

func (*DocumentClassificationJobProperties) SetDataAccessRoleArn added in v1.99.0

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassificationJobProperties) SetDocumentClassifierArn added in v1.99.0

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassificationJobProperties) SetEndTime added in v1.99.0

SetEndTime sets the EndTime field's value.

func (*DocumentClassificationJobProperties) SetInputDataConfig added in v1.99.0

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetJobId added in v1.99.0

SetJobId sets the JobId field's value.

func (*DocumentClassificationJobProperties) SetJobName added in v1.99.0

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobProperties) SetJobStatus added in v1.99.0

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobProperties) SetMessage added in v1.99.0

SetMessage sets the Message field's value.

func (*DocumentClassificationJobProperties) SetOutputDataConfig added in v1.99.0

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetSubmitTime added in v1.99.0

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassificationJobProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassificationJobProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassificationJobProperties) String added in v1.99.0

String returns the string representation

type DocumentClassifierFilter added in v1.99.0

type DocumentClassifierFilter struct {

	// Filters the list of classifiers based on status.
	Status *string `type:"string" enum:"ModelStatus"`

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

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

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.

func (DocumentClassifierFilter) GoString added in v1.99.0

func (s DocumentClassifierFilter) GoString() string

GoString returns the string representation

func (*DocumentClassifierFilter) SetStatus added in v1.99.0

SetStatus sets the Status field's value.

func (*DocumentClassifierFilter) SetSubmitTimeAfter added in v1.99.0

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

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassifierFilter) SetSubmitTimeBefore added in v1.99.0

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

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassifierFilter) String added in v1.99.0

func (s DocumentClassifierFilter) String() string

String returns the string representation

type DocumentClassifierInputDataConfig added in v1.99.0

type DocumentClassifierInputDataConfig struct {

	// The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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 training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data.

func (DocumentClassifierInputDataConfig) GoString added in v1.99.0

GoString returns the string representation

func (*DocumentClassifierInputDataConfig) SetS3Uri added in v1.99.0

SetS3Uri sets the S3Uri field's value.

func (DocumentClassifierInputDataConfig) String added in v1.99.0

String returns the string representation

func (*DocumentClassifierInputDataConfig) Validate added in v1.99.0

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

type DocumentClassifierOutputDataConfig added in v1.99.0

type DocumentClassifierOutputDataConfig struct {

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt the output results from an analysis job. The KmsKeyId can be one
	// of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * KMS Key Alias: "alias/ExampleAlias"
	//
	//    * ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	KmsKeyId *string `type:"string"`

	// When you use the OutputDataConfig object while creating a custom classifier,
	// you specify the Amazon S3 location where you want to write the confusion
	// matrix. 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 this
	// output file.
	//
	// When the custom classifier job is finished, the service creates the 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 confusion matrix.
	S3Uri *string `type:"string"`
	// contains filtered or unexported fields
}

Provides output results configuration parameters for custom classifier jobs.

func (DocumentClassifierOutputDataConfig) GoString added in v1.99.0

GoString returns the string representation

func (*DocumentClassifierOutputDataConfig) SetKmsKeyId added in v1.99.0

SetKmsKeyId sets the KmsKeyId field's value.

func (*DocumentClassifierOutputDataConfig) SetS3Uri added in v1.99.0

SetS3Uri sets the S3Uri field's value.

func (DocumentClassifierOutputDataConfig) String added in v1.99.0

String returns the string representation

type DocumentClassifierProperties added in v1.99.0

type DocumentClassifierProperties struct {

	// Information about the document classifier, including the number of documents
	// used for training the classifier, the number of documents used for test the
	// classifier, and an accuracy rating.
	ClassifierMetadata *ClassifierMetadata `type:"structure"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string `type:"string"`

	// The time that training the document classifier completed.
	EndTime *time.Time `type:"timestamp"`

	// The input data configuration that you supplied when you created the document
	// classifier for training.
	InputDataConfig *DocumentClassifierInputDataConfig `type:"structure"`

	// The language code for the language of the documents that the classifier was
	// trained on.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// Additional information about the status of the classifier.
	Message *string `type:"string"`

	// Provides output results configuration parameters for custom classifier jobs.
	OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

	// The status of the document classifier. If the status is TRAINED the classifier
	// is ready to use. If the status is FAILED you can see additional information
	// about why the classifier wasn't trained in the Message field.
	Status *string `type:"string" enum:"ModelStatus"`

	// The time that the document classifier was submitted for training.
	SubmitTime *time.Time `type:"timestamp"`

	// The time that training of the document classifier was completed. Indicates
	// the time when the training completes on documentation classifiers. You are
	// billed for the time interval between this time and the value of TrainingStartTime.
	TrainingEndTime *time.Time `type:"timestamp"`

	// Indicates the time when the training starts on documentation classifiers.
	// You are billed for the time interval between this time and the value of TrainingEndTime.
	TrainingStartTime *time.Time `type:"timestamp"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your custom classifier. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a document classifier.

func (DocumentClassifierProperties) GoString added in v1.99.0

func (s DocumentClassifierProperties) GoString() string

GoString returns the string representation

func (*DocumentClassifierProperties) SetClassifierMetadata added in v1.99.0

SetClassifierMetadata sets the ClassifierMetadata field's value.

func (*DocumentClassifierProperties) SetDataAccessRoleArn added in v1.99.0

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassifierProperties) SetDocumentClassifierArn added in v1.99.0

func (s *DocumentClassifierProperties) SetDocumentClassifierArn(v string) *DocumentClassifierProperties

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassifierProperties) SetEndTime added in v1.99.0

SetEndTime sets the EndTime field's value.

func (*DocumentClassifierProperties) SetInputDataConfig added in v1.99.0

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassifierProperties) SetLanguageCode added in v1.99.0

SetLanguageCode sets the LanguageCode field's value.

func (*DocumentClassifierProperties) SetMessage added in v1.99.0

SetMessage sets the Message field's value.

func (*DocumentClassifierProperties) SetOutputDataConfig added in v1.99.0

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassifierProperties) SetStatus added in v1.99.0

SetStatus sets the Status field's value.

func (*DocumentClassifierProperties) SetSubmitTime added in v1.99.0

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassifierProperties) SetTrainingEndTime added in v1.99.0

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*DocumentClassifierProperties) SetTrainingStartTime added in v1.99.0

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*DocumentClassifierProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassifierProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassifierProperties) String added in v1.99.0

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

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"`

	// 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"`
	// 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 added in v1.14.15

GoString returns the string representation

func (*DominantLanguageDetectionJobFilter) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobFilter) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeAfter added in v1.14.15

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeBefore added in v1.14.15

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DominantLanguageDetectionJobFilter) String added in v1.14.15

String returns the string representation

func (*DominantLanguageDetectionJobFilter) Validate added in v1.14.15

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

type DominantLanguageDetectionJobProperties added in v1.14.15

type DominantLanguageDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
	// your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

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

	// 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your dominant language detection job. For
	// more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a dominant language detection job.

func (DominantLanguageDetectionJobProperties) GoString added in v1.14.15

GoString returns the string representation

func (*DominantLanguageDetectionJobProperties) SetDataAccessRoleArn added in v1.14.28

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DominantLanguageDetectionJobProperties) SetEndTime added in v1.14.15

SetEndTime sets the EndTime field's value.

func (*DominantLanguageDetectionJobProperties) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*DominantLanguageDetectionJobProperties) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobProperties) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobProperties) SetMessage added in v1.14.15

SetMessage sets the Message field's value.

func (*DominantLanguageDetectionJobProperties) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetSubmitTime added in v1.14.15

SetSubmitTime sets the SubmitTime field's value.

func (*DominantLanguageDetectionJobProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DominantLanguageDetectionJobProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (DominantLanguageDetectionJobProperties) String added in v1.14.15

String returns the string representation

type EntitiesDetectionJobFilter added in v1.14.15

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"`

	// 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"`
	// 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 added in v1.14.15

func (s EntitiesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*EntitiesDetectionJobFilter) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobFilter) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeAfter added in v1.14.15

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeBefore added in v1.14.15

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntitiesDetectionJobFilter) String added in v1.14.15

String returns the string representation

func (*EntitiesDetectionJobFilter) Validate added in v1.14.15

func (s *EntitiesDetectionJobFilter) Validate() error

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

type EntitiesDetectionJobProperties added in v1.14.15

type EntitiesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
	// your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

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

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string `type:"string"`

	// 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your entity detection job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about an entities detection job.

func (EntitiesDetectionJobProperties) GoString added in v1.14.15

GoString returns the string representation

func (*EntitiesDetectionJobProperties) SetDataAccessRoleArn added in v1.14.28

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntitiesDetectionJobProperties) SetEndTime added in v1.14.15

SetEndTime sets the EndTime field's value.

func (*EntitiesDetectionJobProperties) SetEntityRecognizerArn added in v1.99.0

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntitiesDetectionJobProperties) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*EntitiesDetectionJobProperties) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobProperties) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobProperties) SetLanguageCode added in v1.14.15

SetLanguageCode sets the LanguageCode field's value.

func (*EntitiesDetectionJobProperties) SetMessage added in v1.14.15

SetMessage sets the Message field's value.

func (*EntitiesDetectionJobProperties) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetSubmitTime added in v1.14.15

SetSubmitTime sets the SubmitTime field's value.

func (*EntitiesDetectionJobProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntitiesDetectionJobProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (EntitiesDetectionJobProperties) String added in v1.14.15

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 EntityRecognizerAnnotations added in v1.99.0

type EntityRecognizerAnnotations struct {

	// Specifies the Amazon S3 location where the annotations for an entity recognizer
	// are located. The URI must be in the same region as the API endpoint that
	// you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the annotations associated with a entity recognizer.

func (EntityRecognizerAnnotations) GoString added in v1.99.0

func (s EntityRecognizerAnnotations) GoString() string

GoString returns the string representation

func (*EntityRecognizerAnnotations) SetS3Uri added in v1.99.0

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerAnnotations) String added in v1.99.0

String returns the string representation

func (*EntityRecognizerAnnotations) Validate added in v1.99.0

func (s *EntityRecognizerAnnotations) Validate() error

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

type EntityRecognizerDocuments added in v1.99.0

type EntityRecognizerDocuments struct {

	// Specifies the Amazon S3 location where the training documents for an entity
	// recognizer are located. The URI must be in the same region as the API endpoint
	// that you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the training documents submitted with an entity recognizer.

func (EntityRecognizerDocuments) GoString added in v1.99.0

func (s EntityRecognizerDocuments) GoString() string

GoString returns the string representation

func (*EntityRecognizerDocuments) SetS3Uri added in v1.99.0

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerDocuments) String added in v1.99.0

func (s EntityRecognizerDocuments) String() string

String returns the string representation

func (*EntityRecognizerDocuments) Validate added in v1.99.0

func (s *EntityRecognizerDocuments) Validate() error

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

type EntityRecognizerEntityList added in v1.99.0

type EntityRecognizerEntityList struct {

	// Specifies the Amazon S3 location where the entity list is located. The URI
	// must be in the same region as the API endpoint that you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the entity recognizer submitted with an entity recognizer.

func (EntityRecognizerEntityList) GoString added in v1.99.0

func (s EntityRecognizerEntityList) GoString() string

GoString returns the string representation

func (*EntityRecognizerEntityList) SetS3Uri added in v1.99.0

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerEntityList) String added in v1.99.0

String returns the string representation

func (*EntityRecognizerEntityList) Validate added in v1.99.0

func (s *EntityRecognizerEntityList) Validate() error

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

type EntityRecognizerEvaluationMetrics added in v1.99.0

type EntityRecognizerEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for the test data. It
	// is derived from the Precision and Recall values. The F1Score is the harmonic
	// average of the two scores. The highest score is 1, and the worst score is
	// 0.
	F1Score *float64 `type:"double"`

	// A measure of the usefulness of the recognizer results in the test data. High
	// precision means that the recognizer returned substantially more relevant
	// results than irrelevant ones.
	Precision *float64 `type:"double"`

	// A measure of how complete the recognizer results are for the test data. High
	// recall means that the recognizer returned most of the relevant results.
	Recall *float64 `type:"double"`
	// contains filtered or unexported fields
}

Detailed information about the accuracy of an entity recognizer.

func (EntityRecognizerEvaluationMetrics) GoString added in v1.99.0

GoString returns the string representation

func (*EntityRecognizerEvaluationMetrics) SetF1Score added in v1.99.0

SetF1Score sets the F1Score field's value.

func (*EntityRecognizerEvaluationMetrics) SetPrecision added in v1.99.0

SetPrecision sets the Precision field's value.

func (*EntityRecognizerEvaluationMetrics) SetRecall added in v1.99.0

SetRecall sets the Recall field's value.

func (EntityRecognizerEvaluationMetrics) String added in v1.99.0

String returns the string representation

type EntityRecognizerFilter added in v1.99.0

type EntityRecognizerFilter struct {

	// The status of an entity recognizer.
	Status *string `type:"string" enum:"ModelStatus"`

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

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

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>

func (EntityRecognizerFilter) GoString added in v1.99.0

func (s EntityRecognizerFilter) GoString() string

GoString returns the string representation

func (*EntityRecognizerFilter) SetStatus added in v1.99.0

SetStatus sets the Status field's value.

func (*EntityRecognizerFilter) SetSubmitTimeAfter added in v1.99.0

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

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntityRecognizerFilter) SetSubmitTimeBefore added in v1.99.0

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

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntityRecognizerFilter) String added in v1.99.0

func (s EntityRecognizerFilter) String() string

String returns the string representation

type EntityRecognizerInputDataConfig added in v1.99.0

type EntityRecognizerInputDataConfig struct {

	// S3 location of the annotations file for an entity recognizer.
	Annotations *EntityRecognizerAnnotations `type:"structure"`

	// S3 location of the documents folder for an entity recognizer
	//
	// Documents is a required field
	Documents *EntityRecognizerDocuments `type:"structure" required:"true"`

	// S3 location of the entity list for an entity recognizer.
	EntityList *EntityRecognizerEntityList `type:"structure"`

	// The entity types in the input data for an entity recognizer. A maximum of
	// 12 entity types can be used at one time to train an entity recognizer.
	//
	// EntityTypes is a required field
	EntityTypes []*EntityTypesListItem `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies the format and location of the input data.

func (EntityRecognizerInputDataConfig) GoString added in v1.99.0

GoString returns the string representation

func (*EntityRecognizerInputDataConfig) SetAnnotations added in v1.99.0

SetAnnotations sets the Annotations field's value.

func (*EntityRecognizerInputDataConfig) SetDocuments added in v1.99.0

SetDocuments sets the Documents field's value.

func (*EntityRecognizerInputDataConfig) SetEntityList added in v1.99.0

SetEntityList sets the EntityList field's value.

func (*EntityRecognizerInputDataConfig) SetEntityTypes added in v1.99.0

SetEntityTypes sets the EntityTypes field's value.

func (EntityRecognizerInputDataConfig) String added in v1.99.0

String returns the string representation

func (*EntityRecognizerInputDataConfig) Validate added in v1.99.0

func (s *EntityRecognizerInputDataConfig) Validate() error

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

type EntityRecognizerMetadata added in v1.99.0

type EntityRecognizerMetadata struct {

	// Entity types from the metadata of an entity recognizer.
	EntityTypes []*EntityRecognizerMetadataEntityTypesListItem `type:"list"`

	// Detailed information about the accuracy of an entity recognizer.
	EvaluationMetrics *EntityRecognizerEvaluationMetrics `type:"structure"`

	// The number of documents in the input data that were used to test the entity
	// recognizer. Typically this is 10 to 20 percent of the input documents.
	NumberOfTestDocuments *int64 `type:"integer"`

	// The number of documents in the input data that were used to train the entity
	// recognizer. Typically this is 80 to 90 percent of the input documents.
	NumberOfTrainedDocuments *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Detailed information about an entity recognizer.

func (EntityRecognizerMetadata) GoString added in v1.99.0

func (s EntityRecognizerMetadata) GoString() string

GoString returns the string representation

func (*EntityRecognizerMetadata) SetEntityTypes added in v1.99.0

SetEntityTypes sets the EntityTypes field's value.

func (*EntityRecognizerMetadata) SetEvaluationMetrics added in v1.99.0

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadata) SetNumberOfTestDocuments added in v1.99.0

func (s *EntityRecognizerMetadata) SetNumberOfTestDocuments(v int64) *EntityRecognizerMetadata

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*EntityRecognizerMetadata) SetNumberOfTrainedDocuments added in v1.99.0

func (s *EntityRecognizerMetadata) SetNumberOfTrainedDocuments(v int64) *EntityRecognizerMetadata

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (EntityRecognizerMetadata) String added in v1.99.0

func (s EntityRecognizerMetadata) String() string

String returns the string representation

type EntityRecognizerMetadataEntityTypesListItem added in v1.99.0

type EntityRecognizerMetadataEntityTypesListItem struct {

	// Detailed information about the accuracy of the entity recognizer for a specific
	// item on the list of entity types.
	EvaluationMetrics *EntityTypesEvaluationMetrics `type:"structure"`

	// indicates the number of times the given entity name was seen in the training
	// data.
	NumberOfTrainMentions *int64 `type:"integer"`

	// Type of entity from the list of entity types in the metadata of an entity
	// recognizer.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Individual item from the list of entity types in the metadata of an entity recognizer.

func (EntityRecognizerMetadataEntityTypesListItem) GoString added in v1.99.0

GoString returns the string representation

func (*EntityRecognizerMetadataEntityTypesListItem) SetEvaluationMetrics added in v1.99.0

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetNumberOfTrainMentions added in v1.99.0

SetNumberOfTrainMentions sets the NumberOfTrainMentions field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetType added in v1.99.0

SetType sets the Type field's value.

func (EntityRecognizerMetadataEntityTypesListItem) String added in v1.99.0

String returns the string representation

type EntityRecognizerProperties added in v1.99.0

type EntityRecognizerProperties struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the recognizer creation completed.
	EndTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string `type:"string"`

	// The input data properties of an entity recognizer.
	InputDataConfig *EntityRecognizerInputDataConfig `type:"structure"`

	// The language of the input documents. All documents must be in the same language.
	// Only English ("en") is currently supported.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

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

	// Provides information about an entity recognizer.
	RecognizerMetadata *EntityRecognizerMetadata `type:"structure"`

	// Provides the status of the entity recognizer.
	Status *string `type:"string" enum:"ModelStatus"`

	// The time that the recognizer was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// The time that training of the entity recognizer was completed.
	TrainingEndTime *time.Time `type:"timestamp"`

	// The time that training of the entity recognizer started.
	TrainingStartTime *time.Time `type:"timestamp"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your custom entity recognizer. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Describes information about an entity recognizer.

func (EntityRecognizerProperties) GoString added in v1.99.0

func (s EntityRecognizerProperties) GoString() string

GoString returns the string representation

func (*EntityRecognizerProperties) SetDataAccessRoleArn added in v1.99.0

func (s *EntityRecognizerProperties) SetDataAccessRoleArn(v string) *EntityRecognizerProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntityRecognizerProperties) SetEndTime added in v1.99.0

SetEndTime sets the EndTime field's value.

func (*EntityRecognizerProperties) SetEntityRecognizerArn added in v1.99.0

func (s *EntityRecognizerProperties) SetEntityRecognizerArn(v string) *EntityRecognizerProperties

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntityRecognizerProperties) SetInputDataConfig added in v1.99.0

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntityRecognizerProperties) SetLanguageCode added in v1.99.0

SetLanguageCode sets the LanguageCode field's value.

func (*EntityRecognizerProperties) SetMessage added in v1.99.0

SetMessage sets the Message field's value.

func (*EntityRecognizerProperties) SetRecognizerMetadata added in v1.99.0

SetRecognizerMetadata sets the RecognizerMetadata field's value.

func (*EntityRecognizerProperties) SetStatus added in v1.99.0

SetStatus sets the Status field's value.

func (*EntityRecognizerProperties) SetSubmitTime added in v1.99.0

SetSubmitTime sets the SubmitTime field's value.

func (*EntityRecognizerProperties) SetTrainingEndTime added in v1.99.0

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*EntityRecognizerProperties) SetTrainingStartTime added in v1.99.0

func (s *EntityRecognizerProperties) SetTrainingStartTime(v time.Time) *EntityRecognizerProperties

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*EntityRecognizerProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntityRecognizerProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (EntityRecognizerProperties) String added in v1.99.0

String returns the string representation

type EntityTypesEvaluationMetrics added in v1.99.0

type EntityTypesEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for for a specific entity
	// type in the test data. It is derived from the Precision and Recall values.
	// The F1Score is the harmonic average of the two scores. The highest score
	// is 1, and the worst score is 0.
	F1Score *float64 `type:"double"`

	// A measure of the usefulness of the recognizer results for a specific entity
	// type in the test data. High precision means that the recognizer returned
	// substantially more relevant results than irrelevant ones.
	Precision *float64 `type:"double"`

	// A measure of how complete the recognizer results are for a specific entity
	// type in the test data. High recall means that the recognizer returned most
	// of the relevant results.
	Recall *float64 `type:"double"`
	// contains filtered or unexported fields
}

Detailed information about the accuracy of an entity recognizer for a specific entity type.

func (EntityTypesEvaluationMetrics) GoString added in v1.99.0

func (s EntityTypesEvaluationMetrics) GoString() string

GoString returns the string representation

func (*EntityTypesEvaluationMetrics) SetF1Score added in v1.99.0

SetF1Score sets the F1Score field's value.

func (*EntityTypesEvaluationMetrics) SetPrecision added in v1.99.0

SetPrecision sets the Precision field's value.

func (*EntityTypesEvaluationMetrics) SetRecall added in v1.99.0

SetRecall sets the Recall field's value.

func (EntityTypesEvaluationMetrics) String added in v1.99.0

String returns the string representation

type EntityTypesListItem added in v1.99.0

type EntityTypesListItem struct {

	// Entity type of an item on an entity type list.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about an individual item on a list of entity types.

func (EntityTypesListItem) GoString added in v1.99.0

func (s EntityTypesListItem) GoString() string

GoString returns the string representation

func (*EntityTypesListItem) SetType added in v1.99.0

SetType sets the Type field's value.

func (EntityTypesListItem) String added in v1.99.0

func (s EntityTypesListItem) String() string

String returns the string representation

func (*EntityTypesListItem) Validate added in v1.99.0

func (s *EntityTypesListItem) Validate() error

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

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

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"`

	// 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"`
	// 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 added in v1.14.15

func (s KeyPhrasesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*KeyPhrasesDetectionJobFilter) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobFilter) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeAfter added in v1.14.15

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeBefore added in v1.14.15

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (KeyPhrasesDetectionJobFilter) String added in v1.14.15

String returns the string representation

func (*KeyPhrasesDetectionJobFilter) Validate added in v1.14.15

func (s *KeyPhrasesDetectionJobFilter) Validate() error

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

type KeyPhrasesDetectionJobProperties added in v1.14.15

type KeyPhrasesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
	// your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

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

	// 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your key phrases detection job. For more
	// information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a key phrases detection job.

func (KeyPhrasesDetectionJobProperties) GoString added in v1.14.15

GoString returns the string representation

func (*KeyPhrasesDetectionJobProperties) SetDataAccessRoleArn added in v1.14.28

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*KeyPhrasesDetectionJobProperties) SetEndTime added in v1.14.15

SetEndTime sets the EndTime field's value.

func (*KeyPhrasesDetectionJobProperties) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobProperties) SetLanguageCode added in v1.14.15

SetLanguageCode sets the LanguageCode field's value.

func (*KeyPhrasesDetectionJobProperties) SetMessage added in v1.14.15

SetMessage sets the Message field's value.

func (*KeyPhrasesDetectionJobProperties) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetSubmitTime added in v1.14.15

SetSubmitTime sets the SubmitTime field's value.

func (*KeyPhrasesDetectionJobProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*KeyPhrasesDetectionJobProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (KeyPhrasesDetectionJobProperties) String added in v1.14.15

String returns the string representation

type ListDocumentClassificationJobsInput added in v1.99.0

type ListDocumentClassificationJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their names, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *DocumentClassificationJobFilter `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 (ListDocumentClassificationJobsInput) GoString added in v1.99.0

GoString returns the string representation

func (*ListDocumentClassificationJobsInput) SetFilter added in v1.99.0

SetFilter sets the Filter field's value.

func (*ListDocumentClassificationJobsInput) SetMaxResults added in v1.99.0

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentClassificationJobsInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (ListDocumentClassificationJobsInput) String added in v1.99.0

String returns the string representation

func (*ListDocumentClassificationJobsInput) Validate added in v1.99.0

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

type ListDocumentClassificationJobsOutput added in v1.99.0

type ListDocumentClassificationJobsOutput struct {

	// A list containing the properties of each job returned.
	DocumentClassificationJobPropertiesList []*DocumentClassificationJobProperties `type:"list"`

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

func (ListDocumentClassificationJobsOutput) GoString added in v1.99.0

GoString returns the string representation

func (*ListDocumentClassificationJobsOutput) SetDocumentClassificationJobPropertiesList added in v1.99.0

SetDocumentClassificationJobPropertiesList sets the DocumentClassificationJobPropertiesList field's value.

func (*ListDocumentClassificationJobsOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (ListDocumentClassificationJobsOutput) String added in v1.99.0

String returns the string representation

type ListDocumentClassifiersInput added in v1.99.0

type ListDocumentClassifiersInput 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 *DocumentClassifierFilter `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 (ListDocumentClassifiersInput) GoString added in v1.99.0

func (s ListDocumentClassifiersInput) GoString() string

GoString returns the string representation

func (*ListDocumentClassifiersInput) SetFilter added in v1.99.0

SetFilter sets the Filter field's value.

func (*ListDocumentClassifiersInput) SetMaxResults added in v1.99.0

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentClassifiersInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifiersInput) String added in v1.99.0

String returns the string representation

func (*ListDocumentClassifiersInput) Validate added in v1.99.0

func (s *ListDocumentClassifiersInput) Validate() error

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

type ListDocumentClassifiersOutput added in v1.99.0

type ListDocumentClassifiersOutput struct {

	// A list containing the properties of each job returned.
	DocumentClassifierPropertiesList []*DocumentClassifierProperties `type:"list"`

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

func (ListDocumentClassifiersOutput) GoString added in v1.99.0

GoString returns the string representation

func (*ListDocumentClassifiersOutput) SetDocumentClassifierPropertiesList added in v1.99.0

SetDocumentClassifierPropertiesList sets the DocumentClassifierPropertiesList field's value.

func (*ListDocumentClassifiersOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifiersOutput) String added in v1.99.0

String returns the string representation

type ListDominantLanguageDetectionJobsInput added in v1.14.15

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

GoString returns the string representation

func (*ListDominantLanguageDetectionJobsInput) SetFilter added in v1.14.15

SetFilter sets the Filter field's value.

func (*ListDominantLanguageDetectionJobsInput) SetMaxResults added in v1.14.15

SetMaxResults sets the MaxResults field's value.

func (*ListDominantLanguageDetectionJobsInput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsInput) String added in v1.14.15

String returns the string representation

func (*ListDominantLanguageDetectionJobsInput) Validate added in v1.14.15

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

type ListDominantLanguageDetectionJobsOutput added in v1.14.15

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

GoString returns the string representation

func (*ListDominantLanguageDetectionJobsOutput) SetDominantLanguageDetectionJobPropertiesList added in v1.14.15

SetDominantLanguageDetectionJobPropertiesList sets the DominantLanguageDetectionJobPropertiesList field's value.

func (*ListDominantLanguageDetectionJobsOutput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsOutput) String added in v1.14.15

String returns the string representation

type ListEntitiesDetectionJobsInput added in v1.14.15

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

GoString returns the string representation

func (*ListEntitiesDetectionJobsInput) SetFilter added in v1.14.15

SetFilter sets the Filter field's value.

func (*ListEntitiesDetectionJobsInput) SetMaxResults added in v1.14.15

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesDetectionJobsInput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsInput) String added in v1.14.15

String returns the string representation

func (*ListEntitiesDetectionJobsInput) Validate added in v1.14.15

func (s *ListEntitiesDetectionJobsInput) Validate() error

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

type ListEntitiesDetectionJobsOutput added in v1.14.15

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

GoString returns the string representation

func (*ListEntitiesDetectionJobsOutput) SetEntitiesDetectionJobPropertiesList added in v1.14.15

SetEntitiesDetectionJobPropertiesList sets the EntitiesDetectionJobPropertiesList field's value.

func (*ListEntitiesDetectionJobsOutput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsOutput) String added in v1.14.15

String returns the string representation

type ListEntityRecognizersInput added in v1.99.0

type ListEntityRecognizersInput struct {

	// Filters the list of entities returned. You can filter on Status, SubmitTimeBefore,
	// or SubmitTimeAfter. You can only set one filter at a time.
	Filter *EntityRecognizerFilter `type:"structure"`

	// The maximum number of results to return on 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 (ListEntityRecognizersInput) GoString added in v1.99.0

func (s ListEntityRecognizersInput) GoString() string

GoString returns the string representation

func (*ListEntityRecognizersInput) SetFilter added in v1.99.0

SetFilter sets the Filter field's value.

func (*ListEntityRecognizersInput) SetMaxResults added in v1.99.0

SetMaxResults sets the MaxResults field's value.

func (*ListEntityRecognizersInput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizersInput) String added in v1.99.0

String returns the string representation

func (*ListEntityRecognizersInput) Validate added in v1.99.0

func (s *ListEntityRecognizersInput) Validate() error

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

type ListEntityRecognizersOutput added in v1.99.0

type ListEntityRecognizersOutput struct {

	// The list of properties of an entity recognizer.
	EntityRecognizerPropertiesList []*EntityRecognizerProperties `type:"list"`

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

func (ListEntityRecognizersOutput) GoString added in v1.99.0

func (s ListEntityRecognizersOutput) GoString() string

GoString returns the string representation

func (*ListEntityRecognizersOutput) SetEntityRecognizerPropertiesList added in v1.99.0

func (s *ListEntityRecognizersOutput) SetEntityRecognizerPropertiesList(v []*EntityRecognizerProperties) *ListEntityRecognizersOutput

SetEntityRecognizerPropertiesList sets the EntityRecognizerPropertiesList field's value.

func (*ListEntityRecognizersOutput) SetNextToken added in v1.99.0

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizersOutput) String added in v1.99.0

String returns the string representation

type ListKeyPhrasesDetectionJobsInput added in v1.14.15

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

GoString returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) SetFilter added in v1.14.15

SetFilter sets the Filter field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetMaxResults added in v1.14.15

SetMaxResults sets the MaxResults field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsInput) String added in v1.14.15

String returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) Validate added in v1.14.15

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

type ListKeyPhrasesDetectionJobsOutput added in v1.14.15

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

GoString returns the string representation

func (*ListKeyPhrasesDetectionJobsOutput) SetKeyPhrasesDetectionJobPropertiesList added in v1.14.15

SetKeyPhrasesDetectionJobPropertiesList sets the KeyPhrasesDetectionJobPropertiesList field's value.

func (*ListKeyPhrasesDetectionJobsOutput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsOutput) String added in v1.14.15

String returns the string representation

type ListSentimentDetectionJobsInput added in v1.14.15

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

GoString returns the string representation

func (*ListSentimentDetectionJobsInput) SetFilter added in v1.14.15

SetFilter sets the Filter field's value.

func (*ListSentimentDetectionJobsInput) SetMaxResults added in v1.14.15

SetMaxResults sets the MaxResults field's value.

func (*ListSentimentDetectionJobsInput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (ListSentimentDetectionJobsInput) String added in v1.14.15

String returns the string representation

func (*ListSentimentDetectionJobsInput) Validate added in v1.14.15

func (s *ListSentimentDetectionJobsInput) Validate() error

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

type ListSentimentDetectionJobsOutput added in v1.14.15

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

GoString returns the string representation

func (*ListSentimentDetectionJobsOutput) SetNextToken added in v1.14.15

SetNextToken sets the NextToken field's value.

func (*ListSentimentDetectionJobsOutput) SetSentimentDetectionJobPropertiesList added in v1.14.15

SetSentimentDetectionJobPropertiesList sets the SentimentDetectionJobPropertiesList field's value.

func (ListSentimentDetectionJobsOutput) String added in v1.14.15

String returns the string representation

type ListTagsForResourceInput added in v1.99.0

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you
	// are querying.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.99.0

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn added in v1.99.0

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.99.0

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.99.0

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.99.0

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you
	// are querying.
	ResourceArn *string `type:"string"`

	// Tags associated with the Amazon Comprehend resource being queried. A tag
	// is a key-value pair that adds as a metadata to a resource used by Amazon
	// Comprehend. For example, a tag with "Sales" as the key might be added to
	// a resource to indicate its use by the sales department.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.99.0

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetResourceArn added in v1.99.0

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetTags added in v1.99.0

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.99.0

func (s ListTagsForResourceOutput) 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

SetFilter sets the Filter field's value.

func (*ListTopicsDetectionJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListTopicsDetectionJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListTopicsDetectionJobsInput) 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

GoString returns the string representation

func (*ListTopicsDetectionJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList

SetTopicsDetectionJobPropertiesList sets the TopicsDetectionJobPropertiesList field's value.

func (ListTopicsDetectionJobsOutput) String

String returns the string representation

type OutputDataConfig

type OutputDataConfig struct {

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt the output results from an analysis job. The KmsKeyId can be one
	// of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * KMS Key Alias: "alias/ExampleAlias"
	//
	//    * ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	KmsKeyId *string `type:"string"`

	// 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) SetKmsKeyId added in v1.99.0

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

SetKmsKeyId sets the KmsKeyId field's value.

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 PartOfSpeechTag added in v1.14.28

type PartOfSpeechTag struct {

	// The confidence that Amazon Comprehend has that the part of speech was correctly
	// identified.
	Score *float64 `type:"float"`

	// Identifies the part of speech that the token represents.
	Tag *string `type:"string" enum:"PartOfSpeechTagType"`
	// contains filtered or unexported fields
}

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.

func (PartOfSpeechTag) GoString added in v1.14.28

func (s PartOfSpeechTag) GoString() string

GoString returns the string representation

func (*PartOfSpeechTag) SetScore added in v1.14.28

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

SetScore sets the Score field's value.

func (*PartOfSpeechTag) SetTag added in v1.14.28

func (s *PartOfSpeechTag) SetTag(v string) *PartOfSpeechTag

SetTag sets the Tag field's value.

func (PartOfSpeechTag) String added in v1.14.28

func (s PartOfSpeechTag) String() string

String returns the string representation

type SentimentDetectionJobFilter added in v1.14.15

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"`

	// 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"`
	// 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 added in v1.14.15

func (s SentimentDetectionJobFilter) GoString() string

GoString returns the string representation

func (*SentimentDetectionJobFilter) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobFilter) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeAfter added in v1.14.15

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeBefore added in v1.14.15

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (SentimentDetectionJobFilter) String added in v1.14.15

String returns the string representation

func (*SentimentDetectionJobFilter) Validate added in v1.14.15

func (s *SentimentDetectionJobFilter) Validate() error

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

type SentimentDetectionJobProperties added in v1.14.15

type SentimentDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
	// your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

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

	// 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your sentiment detection job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a sentiment detection job.

func (SentimentDetectionJobProperties) GoString added in v1.14.15

GoString returns the string representation

func (*SentimentDetectionJobProperties) SetDataAccessRoleArn added in v1.14.28

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*SentimentDetectionJobProperties) SetEndTime added in v1.14.15

SetEndTime sets the EndTime field's value.

func (*SentimentDetectionJobProperties) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*SentimentDetectionJobProperties) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobProperties) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobProperties) SetLanguageCode added in v1.14.15

SetLanguageCode sets the LanguageCode field's value.

func (*SentimentDetectionJobProperties) SetMessage added in v1.14.15

SetMessage sets the Message field's value.

func (*SentimentDetectionJobProperties) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetSubmitTime added in v1.14.15

SetSubmitTime sets the SubmitTime field's value.

func (*SentimentDetectionJobProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*SentimentDetectionJobProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (SentimentDetectionJobProperties) String added in v1.14.15

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 StartDocumentClassificationJobInput added in v1.99.0

type StartDocumentClassificationJobInput 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 `min:"20" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the document classifier to use to process
	// the job.
	//
	// DocumentClassifierArn is a required field
	DocumentClassifierArn *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"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your document classification job.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDocumentClassificationJobInput) GoString added in v1.99.0

GoString returns the string representation

func (*StartDocumentClassificationJobInput) SetClientRequestToken added in v1.99.0

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDocumentClassificationJobInput) SetDataAccessRoleArn added in v1.99.0

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartDocumentClassificationJobInput) SetDocumentClassifierArn added in v1.99.0

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*StartDocumentClassificationJobInput) SetInputDataConfig added in v1.99.0

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartDocumentClassificationJobInput) SetJobName added in v1.99.0

SetJobName sets the JobName field's value.

func (*StartDocumentClassificationJobInput) SetOutputDataConfig added in v1.99.0

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartDocumentClassificationJobInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartDocumentClassificationJobInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (StartDocumentClassificationJobInput) String added in v1.99.0

String returns the string representation

func (*StartDocumentClassificationJobInput) Validate added in v1.99.0

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

type StartDocumentClassificationJobOutput added in v1.99.0

type StartDocumentClassificationJobOutput struct {

	// The identifier generated for the job. To get the status of the 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 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. For details, use the operation.
	//
	//    * STOP_REQUESTED - Amazon Comprehend has received a stop request for the
	//    job and is processing the request.
	//
	//    * STOPPED - The job was successfully stopped without completing.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartDocumentClassificationJobOutput) GoString added in v1.99.0

GoString returns the string representation

func (*StartDocumentClassificationJobOutput) SetJobId added in v1.99.0

SetJobId sets the JobId field's value.

func (*StartDocumentClassificationJobOutput) SetJobStatus added in v1.99.0

SetJobStatus sets the JobStatus field's value.

func (StartDocumentClassificationJobOutput) String added in v1.99.0

String returns the string representation

type StartDominantLanguageDetectionJobInput added in v1.14.15

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 Access Management
	// (IAM) role that grants Amazon Comprehend read access to your input data.
	// For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your dominant language detection
	// job. For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDominantLanguageDetectionJobInput) GoString added in v1.14.15

GoString returns the string representation

func (*StartDominantLanguageDetectionJobInput) SetClientRequestToken added in v1.14.15

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDominantLanguageDetectionJobInput) SetDataAccessRoleArn added in v1.14.15

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartDominantLanguageDetectionJobInput) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartDominantLanguageDetectionJobInput) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*StartDominantLanguageDetectionJobInput) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartDominantLanguageDetectionJobInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartDominantLanguageDetectionJobInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (StartDominantLanguageDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StartDominantLanguageDetectionJobInput) Validate added in v1.14.15

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

type StartDominantLanguageDetectionJobOutput added in v1.14.15

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

GoString returns the string representation

func (*StartDominantLanguageDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StartDominantLanguageDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StartDominantLanguageDetectionJobOutput) String added in v1.14.15

String returns the string representation

type StartEntitiesDetectionJobInput added in v1.14.15

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 Access Management
	// (IAM) role that grants Amazon Comprehend read access to your input data.
	// For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that identifies the specific entity recognizer
	// to be used by the StartEntitiesDetectionJob. This ARN is optional and is
	// only used for a custom entity recognition job.
	EntityRecognizerArn *string `type:"string"`

	// 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. All documents must be in the same language.
	// You can specify any of the languages supported by Amazon Comprehend: English
	// ("en"), Spanish ("es"), French ("fr"), German ("de"), Italian ("it"), or
	// Portuguese ("pt"). If custom entities recognition is used, this parameter
	// is ignored and the language used for training the model is used instead.
	//
	// 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your entity detection job. For
	// more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionJobInput) GoString added in v1.14.15

GoString returns the string representation

func (*StartEntitiesDetectionJobInput) SetClientRequestToken added in v1.14.15

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEntitiesDetectionJobInput) SetDataAccessRoleArn added in v1.14.15

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEntitiesDetectionJobInput) SetEntityRecognizerArn added in v1.99.0

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*StartEntitiesDetectionJobInput) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEntitiesDetectionJobInput) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*StartEntitiesDetectionJobInput) SetLanguageCode added in v1.14.15

SetLanguageCode sets the LanguageCode field's value.

func (*StartEntitiesDetectionJobInput) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartEntitiesDetectionJobInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartEntitiesDetectionJobInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (StartEntitiesDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StartEntitiesDetectionJobInput) Validate added in v1.14.15

func (s *StartEntitiesDetectionJobInput) Validate() error

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

type StartEntitiesDetectionJobOutput added in v1.14.15

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.
	//
	//    * STOP_REQUESTED - Amazon Comprehend has received a stop request for the
	//    job and is processing the request.
	//
	//    * STOPPED - The job was successfully stopped without completing.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionJobOutput) GoString added in v1.14.15

GoString returns the string representation

func (*StartEntitiesDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StartEntitiesDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StartEntitiesDetectionJobOutput) String added in v1.14.15

String returns the string representation

type StartKeyPhrasesDetectionJobInput added in v1.14.15

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 Access Management
	// (IAM) role that grants Amazon Comprehend read access to your input data.
	// For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" 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 any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your key phrases detection job.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartKeyPhrasesDetectionJobInput) GoString added in v1.14.15

GoString returns the string representation

func (*StartKeyPhrasesDetectionJobInput) SetClientRequestToken added in v1.14.15

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartKeyPhrasesDetectionJobInput) SetDataAccessRoleArn added in v1.14.15

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartKeyPhrasesDetectionJobInput) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartKeyPhrasesDetectionJobInput) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*StartKeyPhrasesDetectionJobInput) SetLanguageCode added in v1.14.15

SetLanguageCode sets the LanguageCode field's value.

func (*StartKeyPhrasesDetectionJobInput) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartKeyPhrasesDetectionJobInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartKeyPhrasesDetectionJobInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (StartKeyPhrasesDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StartKeyPhrasesDetectionJobInput) Validate added in v1.14.15

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

type StartKeyPhrasesDetectionJobOutput added in v1.14.15

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

GoString returns the string representation

func (*StartKeyPhrasesDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StartKeyPhrasesDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StartKeyPhrasesDetectionJobOutput) String added in v1.14.15

String returns the string representation

type StartSentimentDetectionJobInput added in v1.14.15

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 Access Management
	// (IAM) role that grants Amazon Comprehend read access to your input data.
	// For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" 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 any of the primary languages
	// supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), or Portuguese ("pt"). 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your sentiment detection job.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartSentimentDetectionJobInput) GoString added in v1.14.15

GoString returns the string representation

func (*StartSentimentDetectionJobInput) SetClientRequestToken added in v1.14.15

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartSentimentDetectionJobInput) SetDataAccessRoleArn added in v1.14.15

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartSentimentDetectionJobInput) SetInputDataConfig added in v1.14.15

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartSentimentDetectionJobInput) SetJobName added in v1.14.15

SetJobName sets the JobName field's value.

func (*StartSentimentDetectionJobInput) SetLanguageCode added in v1.14.15

SetLanguageCode sets the LanguageCode field's value.

func (*StartSentimentDetectionJobInput) SetOutputDataConfig added in v1.14.15

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartSentimentDetectionJobInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartSentimentDetectionJobInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (StartSentimentDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StartSentimentDetectionJobInput) Validate added in v1.14.15

func (s *StartSentimentDetectionJobInput) Validate() error

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

type StartSentimentDetectionJobOutput added in v1.14.15

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

GoString returns the string representation

func (*StartSentimentDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StartSentimentDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StartSentimentDetectionJobOutput) String added in v1.14.15

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.
	// For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your topic detection job. For
	// more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartTopicsDetectionJobInput) GoString

func (s StartTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartTopicsDetectionJobInput) SetClientRequestToken

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartTopicsDetectionJobInput) SetDataAccessRoleArn

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartTopicsDetectionJobInput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartTopicsDetectionJobInput) SetJobName

SetJobName sets the JobName field's value.

func (*StartTopicsDetectionJobInput) SetNumberOfTopics

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*StartTopicsDetectionJobInput) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartTopicsDetectionJobInput) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartTopicsDetectionJobInput) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (StartTopicsDetectionJobInput) 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

GoString returns the string representation

func (*StartTopicsDetectionJobOutput) SetJobId

SetJobId sets the JobId field's value.

func (*StartTopicsDetectionJobOutput) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (StartTopicsDetectionJobOutput) String

String returns the string representation

type StopDominantLanguageDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*StopDominantLanguageDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (StopDominantLanguageDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StopDominantLanguageDetectionJobInput) Validate added in v1.14.15

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

type StopDominantLanguageDetectionJobOutput added in v1.14.15

type StopDominantLanguageDetectionJobOutput struct {

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

	// Either STOP_REQUESTED 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 added in v1.14.15

GoString returns the string representation

func (*StopDominantLanguageDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StopDominantLanguageDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StopDominantLanguageDetectionJobOutput) String added in v1.14.15

String returns the string representation

type StopEntitiesDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*StopEntitiesDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StopEntitiesDetectionJobInput) Validate added in v1.14.15

func (s *StopEntitiesDetectionJobInput) Validate() error

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

type StopEntitiesDetectionJobOutput added in v1.14.15

type StopEntitiesDetectionJobOutput struct {

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

	// Either STOP_REQUESTED 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 added in v1.14.15

GoString returns the string representation

func (*StopEntitiesDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StopEntitiesDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StopEntitiesDetectionJobOutput) String added in v1.14.15

String returns the string representation

type StopKeyPhrasesDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*StopKeyPhrasesDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (StopKeyPhrasesDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StopKeyPhrasesDetectionJobInput) Validate added in v1.14.15

func (s *StopKeyPhrasesDetectionJobInput) Validate() error

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

type StopKeyPhrasesDetectionJobOutput added in v1.14.15

type StopKeyPhrasesDetectionJobOutput struct {

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

	// Either STOP_REQUESTED 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 added in v1.14.15

GoString returns the string representation

func (*StopKeyPhrasesDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StopKeyPhrasesDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StopKeyPhrasesDetectionJobOutput) String added in v1.14.15

String returns the string representation

type StopSentimentDetectionJobInput added in v1.14.15

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

GoString returns the string representation

func (*StopSentimentDetectionJobInput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (StopSentimentDetectionJobInput) String added in v1.14.15

String returns the string representation

func (*StopSentimentDetectionJobInput) Validate added in v1.14.15

func (s *StopSentimentDetectionJobInput) Validate() error

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

type StopSentimentDetectionJobOutput added in v1.14.15

type StopSentimentDetectionJobOutput struct {

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

	// Either STOP_REQUESTED 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 added in v1.14.15

GoString returns the string representation

func (*StopSentimentDetectionJobOutput) SetJobId added in v1.14.15

SetJobId sets the JobId field's value.

func (*StopSentimentDetectionJobOutput) SetJobStatus added in v1.14.15

SetJobStatus sets the JobStatus field's value.

func (StopSentimentDetectionJobOutput) String added in v1.14.15

String returns the string representation

type StopTrainingDocumentClassifierInput added in v1.99.0

type StopTrainingDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier currently
	// being trained.
	//
	// DocumentClassifierArn is a required field
	DocumentClassifierArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopTrainingDocumentClassifierInput) GoString added in v1.99.0

GoString returns the string representation

func (*StopTrainingDocumentClassifierInput) SetDocumentClassifierArn added in v1.99.0

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (StopTrainingDocumentClassifierInput) String added in v1.99.0

String returns the string representation

func (*StopTrainingDocumentClassifierInput) Validate added in v1.99.0

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

type StopTrainingDocumentClassifierOutput added in v1.99.0

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

func (StopTrainingDocumentClassifierOutput) GoString added in v1.99.0

GoString returns the string representation

func (StopTrainingDocumentClassifierOutput) String added in v1.99.0

String returns the string representation

type StopTrainingEntityRecognizerInput added in v1.99.0

type StopTrainingEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer currently
	// being trained.
	//
	// EntityRecognizerArn is a required field
	EntityRecognizerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopTrainingEntityRecognizerInput) GoString added in v1.99.0

GoString returns the string representation

func (*StopTrainingEntityRecognizerInput) SetEntityRecognizerArn added in v1.99.0

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (StopTrainingEntityRecognizerInput) String added in v1.99.0

String returns the string representation

func (*StopTrainingEntityRecognizerInput) Validate added in v1.99.0

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

type StopTrainingEntityRecognizerOutput added in v1.99.0

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

func (StopTrainingEntityRecognizerOutput) GoString added in v1.99.0

GoString returns the string representation

func (StopTrainingEntityRecognizerOutput) String added in v1.99.0

String returns the string representation

type SyntaxToken added in v1.14.28

type SyntaxToken struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the word.
	BeginOffset *int64 `type:"integer"`

	// The zero-based offset from the beginning of the source text to the last character
	// in the word.
	EndOffset *int64 `type:"integer"`

	// Provides the part of speech label and the confidence level that Amazon Comprehend
	// has that the part of speech was correctly identified. For more information,
	// see how-syntax.
	PartOfSpeech *PartOfSpeechTag `type:"structure"`

	// The word that was recognized in the source text.
	Text *string `min:"1" type:"string"`

	// A unique identifier for a token.
	TokenId *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

func (SyntaxToken) GoString added in v1.14.28

func (s SyntaxToken) GoString() string

GoString returns the string representation

func (*SyntaxToken) SetBeginOffset added in v1.14.28

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

SetBeginOffset sets the BeginOffset field's value.

func (*SyntaxToken) SetEndOffset added in v1.14.28

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

SetEndOffset sets the EndOffset field's value.

func (*SyntaxToken) SetPartOfSpeech added in v1.14.28

func (s *SyntaxToken) SetPartOfSpeech(v *PartOfSpeechTag) *SyntaxToken

SetPartOfSpeech sets the PartOfSpeech field's value.

func (*SyntaxToken) SetText added in v1.14.28

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

SetText sets the Text field's value.

func (*SyntaxToken) SetTokenId added in v1.14.28

func (s *SyntaxToken) SetTokenId(v int64) *SyntaxToken

SetTokenId sets the TokenId field's value.

func (SyntaxToken) String added in v1.14.28

func (s SyntaxToken) String() string

String returns the string representation

type Tag added in v1.99.0

type Tag struct {

	// The initial part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the key portion of the pair,
	// with multiple possible values such as “sales,” “legal,” and “administration.”
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The second part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the initial (key) portion
	// of the pair, with a value of “sales” to indicate the sales department.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

func (Tag) GoString added in v1.99.0

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.99.0

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.99.0

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.99.0

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.99.0

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.99.0

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to
	// which you want to associate the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// Tags being associated with a specific Amazon Comprehend resource. There can
	// be a maximum of 50 tags (both existing and pending) associated with a specific
	// resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.99.0

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn added in v1.99.0

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.99.0

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.99.0

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.99.0

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.99.0

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

func (TagResourceOutput) GoString added in v1.99.0

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.99.0

func (s TagResourceOutput) 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"`

	// 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"`
	// 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

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobFilter) SetJobStatus

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 Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your job data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the topic detection job was completed.
	EndTime *time.Time `type:"timestamp"`

	// 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"`

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
	// to encrypt data on the storage volume attached to the ML compute instance(s)
	// that process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your topic detection job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// 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) SetDataAccessRoleArn added in v1.99.0

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*TopicsDetectionJobProperties) SetEndTime

SetEndTime sets the EndTime field's value.

func (*TopicsDetectionJobProperties) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetJobId

SetJobId sets the JobId field's value.

func (*TopicsDetectionJobProperties) SetJobName

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobProperties) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (*TopicsDetectionJobProperties) SetMessage

SetMessage sets the Message field's value.

func (*TopicsDetectionJobProperties) SetNumberOfTopics

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*TopicsDetectionJobProperties) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetSubmitTime

SetSubmitTime sets the SubmitTime field's value.

func (*TopicsDetectionJobProperties) SetVolumeKmsKeyId added in v1.99.0

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*TopicsDetectionJobProperties) SetVpcConfig added in v1.99.0

SetVpcConfig sets the VpcConfig field's value.

func (TopicsDetectionJobProperties) String

String returns the string representation

type UntagResourceInput added in v1.99.0

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from
	// which you want to remove the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The initial part of a key-value pair that forms a tag being removed from
	// a given resource. For example, a tag with "Sales" as the key might be added
	// to a resource to indicate its use by the sales department. Keys must be unique
	// and cannot be duplicated for a particular resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.99.0

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn added in v1.99.0

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.99.0

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.99.0

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.99.0

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.99.0

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

func (UntagResourceOutput) GoString added in v1.99.0

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.99.0

func (s UntagResourceOutput) String() string

String returns the string representation

type VpcConfig added in v1.99.0

type VpcConfig struct {

	// The ID number for a security group on an instance of your private VPC. Security
	// groups on your VPC function serve as a virtual firewall to control inbound
	// and outbound traffic and provides security for the resources that you’ll
	// be accessing on the VPC. This ID number is preceded by "sg-", for instance:
	// "sg-03b388029b0a285ea". For more information, see Security Groups for your
	// VPC (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html).
	//
	// SecurityGroupIds is a required field
	SecurityGroupIds []*string `min:"1" type:"list" required:"true"`

	// The ID for each subnet being used in your private VPC. This subnet is a subset
	// of the a range of IPv4 addresses used by the VPC and is specific to a given
	// availability zone in the VPC’s region. This ID number is preceded by "subnet-",
	// for instance: "subnet-04ccf456919e69055". For more information, see VPCs
	// and Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html).
	//
	// Subnets is a required field
	Subnets []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).

func (VpcConfig) GoString added in v1.99.0

func (s VpcConfig) GoString() string

GoString returns the string representation

func (*VpcConfig) SetSecurityGroupIds added in v1.99.0

func (s *VpcConfig) SetSecurityGroupIds(v []*string) *VpcConfig

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfig) SetSubnets added in v1.99.0

func (s *VpcConfig) SetSubnets(v []*string) *VpcConfig

SetSubnets sets the Subnets field's value.

func (VpcConfig) String added in v1.99.0

func (s VpcConfig) String() string

String returns the string representation

func (*VpcConfig) Validate added in v1.99.0

func (s *VpcConfig) Validate() error

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

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