comprehend

package
v0.20.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2020 License: Apache-2.0 Imports: 8 Imported by: 31

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

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

func (s BatchDetectDominantLanguageInput) String() string

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate 

func (s *BatchDetectDominantLanguageInput) Validate() error

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

type BatchDetectDominantLanguageItemResult 

type BatchDetectDominantLanguageItemResult struct {

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

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

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

func (BatchDetectDominantLanguageItemResult) String 

func (s BatchDetectDominantLanguageItemResult) String() string

String returns the string representation

type BatchDetectDominantLanguageOutput 

type BatchDetectDominantLanguageOutput struct {

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

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

func (BatchDetectDominantLanguageOutput) String 

func (s BatchDetectDominantLanguageOutput) String() string

String returns the string representation

type BatchDetectDominantLanguageRequest 

type BatchDetectDominantLanguageRequest struct {
	*aws.Request
	Input *BatchDetectDominantLanguageInput
	Copy  func(*BatchDetectDominantLanguageInput) BatchDetectDominantLanguageRequest
}

BatchDetectDominantLanguageRequest is the request type for the BatchDetectDominantLanguage API operation.

func (BatchDetectDominantLanguageRequest) Send 

func (r BatchDetectDominantLanguageRequest) Send(ctx context.Context) (*BatchDetectDominantLanguageResponse, error)

Send marshals and sends the BatchDetectDominantLanguage API request.

type BatchDetectDominantLanguageResponse added in v0.9.0 

type BatchDetectDominantLanguageResponse struct {
	*BatchDetectDominantLanguageOutput
	// contains filtered or unexported fields
}

BatchDetectDominantLanguageResponse is the response type for the BatchDetectDominantLanguage API operation.

func (*BatchDetectDominantLanguageResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the BatchDetectDominantLanguage request.

type BatchDetectEntitiesInput 

type BatchDetectEntitiesInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// 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) 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) String 

func (s BatchDetectEntitiesItemResult) String() string

String returns the string representation

type BatchDetectEntitiesOutput 

type BatchDetectEntitiesOutput struct {

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

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

func (BatchDetectEntitiesOutput) String 

func (s BatchDetectEntitiesOutput) String() string

String returns the string representation

type BatchDetectEntitiesRequest 

type BatchDetectEntitiesRequest struct {
	*aws.Request
	Input *BatchDetectEntitiesInput
	Copy  func(*BatchDetectEntitiesInput) BatchDetectEntitiesRequest
}

BatchDetectEntitiesRequest is the request type for the BatchDetectEntities API operation.

func (BatchDetectEntitiesRequest) Send 

func (r BatchDetectEntitiesRequest) Send(ctx context.Context) (*BatchDetectEntitiesResponse, error)

Send marshals and sends the BatchDetectEntities API request.

type BatchDetectEntitiesResponse added in v0.9.0 

type BatchDetectEntitiesResponse struct {
	*BatchDetectEntitiesOutput
	// contains filtered or unexported fields
}

BatchDetectEntitiesResponse is the response type for the BatchDetectEntities API operation.

func (*BatchDetectEntitiesResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the BatchDetectEntities request.

type BatchDetectKeyPhrasesInput 

type BatchDetectKeyPhrasesInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// 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) String 

func (s BatchDetectKeyPhrasesInput) String() string

String returns the string representation

func (*BatchDetectKeyPhrasesInput) Validate 

func (s *BatchDetectKeyPhrasesInput) Validate() error

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

type BatchDetectKeyPhrasesItemResult 

type BatchDetectKeyPhrasesItemResult struct {

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

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

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

func (BatchDetectKeyPhrasesItemResult) String 

func (s BatchDetectKeyPhrasesItemResult) String() string

String returns the string representation

type BatchDetectKeyPhrasesOutput 

type BatchDetectKeyPhrasesOutput struct {

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

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

func (BatchDetectKeyPhrasesOutput) String 

func (s BatchDetectKeyPhrasesOutput) String() string

String returns the string representation

type BatchDetectKeyPhrasesRequest 

type BatchDetectKeyPhrasesRequest struct {
	*aws.Request
	Input *BatchDetectKeyPhrasesInput
	Copy  func(*BatchDetectKeyPhrasesInput) BatchDetectKeyPhrasesRequest
}

BatchDetectKeyPhrasesRequest is the request type for the BatchDetectKeyPhrases API operation.

func (BatchDetectKeyPhrasesRequest) Send 

func (r BatchDetectKeyPhrasesRequest) Send(ctx context.Context) (*BatchDetectKeyPhrasesResponse, error)

Send marshals and sends the BatchDetectKeyPhrases API request.

type BatchDetectKeyPhrasesResponse added in v0.9.0 

type BatchDetectKeyPhrasesResponse struct {
	*BatchDetectKeyPhrasesOutput
	// contains filtered or unexported fields
}

BatchDetectKeyPhrasesResponse is the response type for the BatchDetectKeyPhrases API operation.

func (*BatchDetectKeyPhrasesResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the BatchDetectKeyPhrases request.

type BatchDetectSentimentInput 

type BatchDetectSentimentInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// 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) 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 SentimentType `type:"string" enum:"true"`

	// 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) String 

func (s BatchDetectSentimentItemResult) String() string

String returns the string representation

type BatchDetectSentimentOutput 

type BatchDetectSentimentOutput struct {

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

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

func (BatchDetectSentimentOutput) String 

func (s BatchDetectSentimentOutput) String() string

String returns the string representation

type BatchDetectSentimentRequest 

type BatchDetectSentimentRequest struct {
	*aws.Request
	Input *BatchDetectSentimentInput
	Copy  func(*BatchDetectSentimentInput) BatchDetectSentimentRequest
}

BatchDetectSentimentRequest is the request type for the BatchDetectSentiment API operation.

func (BatchDetectSentimentRequest) Send 

func (r BatchDetectSentimentRequest) Send(ctx context.Context) (*BatchDetectSentimentResponse, error)

Send marshals and sends the BatchDetectSentiment API request.

type BatchDetectSentimentResponse added in v0.9.0 

type BatchDetectSentimentResponse struct {
	*BatchDetectSentimentOutput
	// contains filtered or unexported fields
}

BatchDetectSentimentResponse is the response type for the BatchDetectSentiment API operation.

func (*BatchDetectSentimentResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the BatchDetectSentiment request.

type BatchDetectSyntaxInput added in v0.5.0 

type BatchDetectSyntaxInput struct {

	// The language of the input documents. You can specify any of the following
	// 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 SyntaxLanguageCode `type:"string" required:"true" enum:"true"`

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

func (s BatchDetectSyntaxInput) String() string

String returns the string representation

func (*BatchDetectSyntaxInput) Validate added in v0.5.0 

func (s *BatchDetectSyntaxInput) Validate() error

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

type BatchDetectSyntaxItemResult added in v0.5.0 

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

func (s BatchDetectSyntaxItemResult) String() string

String returns the string representation

type BatchDetectSyntaxOutput added in v0.5.0 

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

func (s BatchDetectSyntaxOutput) String() string

String returns the string representation

type BatchDetectSyntaxRequest added in v0.5.0 

type BatchDetectSyntaxRequest struct {
	*aws.Request
	Input *BatchDetectSyntaxInput
	Copy  func(*BatchDetectSyntaxInput) BatchDetectSyntaxRequest
}

BatchDetectSyntaxRequest is the request type for the BatchDetectSyntax API operation.

func (BatchDetectSyntaxRequest) Send added in v0.5.0 

func (r BatchDetectSyntaxRequest) Send(ctx context.Context) (*BatchDetectSyntaxResponse, error)

Send marshals and sends the BatchDetectSyntax API request.

type BatchDetectSyntaxResponse added in v0.9.0 

type BatchDetectSyntaxResponse struct {
	*BatchDetectSyntaxOutput
	// contains filtered or unexported fields
}

BatchDetectSyntaxResponse is the response type for the BatchDetectSyntax API operation.

func (*BatchDetectSyntaxResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the BatchDetectSyntax request.

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

func (s BatchItemError) String() string

String returns the string representation

type ClassifierEvaluationMetrics added in v0.6.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"`

	// Indicates the fraction of labels that are incorrectly predicted. Also seen
	// as the fraction of wrong labels compared to the total number of labels. Scores
	// closer to zero are better.
	HammingLoss *float64 `type:"double"`

	// A measure of how accurate the classifier results are for the test data. It
	// is a combination of the Micro Precision and Micro Recall values. The Micro
	// F1Score is the harmonic mean of the two scores. The highest score is 1, and
	// the worst score is 0.
	MicroF1Score *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. Unlike the Precision metric which comes from
	// averaging the precision of all available labels, this is based on the overall
	// score of all precision scores added together.
	MicroPrecision *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. Specifically,
	// this indicates how many of the correct categories in the text that the model
	// can predict. It is a percentage of correct categories in the text that can
	// found. Instead of averaging the recall scores of all labels (as with Recall),
	// micro Recall is based on the overall score of all recall scores added together.
	MicroRecall *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) String added in v0.6.0 

func (s ClassifierEvaluationMetrics) String() string

String returns the string representation

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

func (s ClassifierMetadata) String() string

String returns the string representation

type ClassifyDocumentInput added in v0.18.0 

type ClassifyDocumentInput struct {

	// The Amazon Resource Number (ARN) of the endpoint.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`

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

func (ClassifyDocumentInput) String added in v0.18.0 

func (s ClassifyDocumentInput) String() string

String returns the string representation

func (*ClassifyDocumentInput) Validate added in v0.18.0 

func (s *ClassifyDocumentInput) Validate() error

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

type ClassifyDocumentOutput added in v0.18.0 

type ClassifyDocumentOutput struct {

	// The classes used by the document being analyzed. These are used for multi-class
	// trained models. Individual classes are mutually exclusive and each document
	// is expected to have only a single class assigned to it. For example, an animal
	// can be a dog or a cat, but not both at the same time.
	Classes []DocumentClass `type:"list"`

	// The labels used the document being analyzed. These are used for multi-label
	// trained models. Individual labels represent different categories that are
	// related in some manner and are not multually exclusive. For example, a movie
	// can be just an action movie, or it can be an action movie, a science fiction
	// movie, and a comedy, all at the same time.
	Labels []DocumentLabel `type:"list"`
	// contains filtered or unexported fields
}

func (ClassifyDocumentOutput) String added in v0.18.0 

func (s ClassifyDocumentOutput) String() string

String returns the string representation

type ClassifyDocumentRequest added in v0.18.0 

type ClassifyDocumentRequest struct {
	*aws.Request
	Input *ClassifyDocumentInput
	Copy  func(*ClassifyDocumentInput) ClassifyDocumentRequest
}

ClassifyDocumentRequest is the request type for the ClassifyDocument API operation.

func (ClassifyDocumentRequest) Send added in v0.18.0 

func (r ClassifyDocumentRequest) Send(ctx context.Context) (*ClassifyDocumentResponse, error)

Send marshals and sends the ClassifyDocument API request.

type ClassifyDocumentResponse added in v0.18.0 

type ClassifyDocumentResponse struct {
	*ClassifyDocumentOutput
	// contains filtered or unexported fields
}

ClassifyDocumentResponse is the response type for the ClassifyDocument API operation.

func (*ClassifyDocumentResponse) SDKResponseMetdata added in v0.18.0 

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

SDKResponseMetdata returns the response metadata for the ClassifyDocument request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *Client

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

Example: 

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

func (*Client) BatchDetectDominantLanguageRequest added in v0.9.0 

func (c *Client) BatchDetectDominantLanguageRequest(input *BatchDetectDominantLanguageInput) BatchDetectDominantLanguageRequest

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

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

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

func (*Client) BatchDetectEntitiesRequest added in v0.9.0 

func (c *Client) BatchDetectEntitiesRequest(input *BatchDetectEntitiesInput) BatchDetectEntitiesRequest

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

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

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

func (*Client) BatchDetectKeyPhrasesRequest added in v0.9.0 

func (c *Client) BatchDetectKeyPhrasesRequest(input *BatchDetectKeyPhrasesInput) BatchDetectKeyPhrasesRequest

BatchDetectKeyPhrasesRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) BatchDetectSentimentRequest added in v0.9.0 

func (c *Client) BatchDetectSentimentRequest(input *BatchDetectSentimentInput) BatchDetectSentimentRequest

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

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

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

func (*Client) BatchDetectSyntaxRequest added in v0.9.0 

func (c *Client) BatchDetectSyntaxRequest(input *BatchDetectSyntaxInput) BatchDetectSyntaxRequest

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntax

func (*Client) ClassifyDocumentRequest added in v0.18.0 

func (c *Client) ClassifyDocumentRequest(input *ClassifyDocumentInput) ClassifyDocumentRequest

ClassifyDocumentRequest returns a request value for making API operation for Amazon Comprehend.

Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocument

func (*Client) CreateDocumentClassifierRequest added in v0.9.0 

func (c *Client) CreateDocumentClassifierRequest(input *CreateDocumentClassifierInput) CreateDocumentClassifierRequest

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

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

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

func (*Client) CreateEndpointRequest added in v0.18.0 

func (c *Client) CreateEndpointRequest(input *CreateEndpointInput) CreateEndpointRequest

CreateEndpointRequest returns a request value for making API operation for Amazon Comprehend.

Creates a model-specific endpoint for synchronous inference for a previously trained custom model 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpoint

func (*Client) CreateEntityRecognizerRequest added in v0.9.0 

func (c *Client) CreateEntityRecognizerRequest(input *CreateEntityRecognizerInput) CreateEntityRecognizerRequest

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

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

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

func (*Client) DeleteDocumentClassifierRequest added in v0.9.0 

func (c *Client) DeleteDocumentClassifierRequest(input *DeleteDocumentClassifierInput) DeleteDocumentClassifierRequest

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

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

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

func (*Client) DeleteEndpointRequest added in v0.18.0 

func (c *Client) DeleteEndpointRequest(input *DeleteEndpointInput) DeleteEndpointRequest

DeleteEndpointRequest returns a request value for making API operation for Amazon Comprehend.

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEndpoint

func (*Client) DeleteEntityRecognizerRequest added in v0.9.0 

func (c *Client) DeleteEntityRecognizerRequest(input *DeleteEntityRecognizerInput) DeleteEntityRecognizerRequest

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

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

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

func (*Client) DescribeDocumentClassificationJobRequest added in v0.9.0 

func (c *Client) DescribeDocumentClassificationJobRequest(input *DescribeDocumentClassificationJobInput) DescribeDocumentClassificationJobRequest

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob

func (*Client) DescribeDocumentClassifierRequest added in v0.9.0 

func (c *Client) DescribeDocumentClassifierRequest(input *DescribeDocumentClassifierInput) DescribeDocumentClassifierRequest

DescribeDocumentClassifierRequest returns a request value for making API operation for Amazon Comprehend.

Gets the properties associated with a document classifier. 

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

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

func (*Client) DescribeDominantLanguageDetectionJobRequest added in v0.9.0 

func (c *Client) DescribeDominantLanguageDetectionJobRequest(input *DescribeDominantLanguageDetectionJobInput) DescribeDominantLanguageDetectionJobRequest

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

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

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

func (*Client) DescribeEndpointRequest added in v0.18.0 

func (c *Client) DescribeEndpointRequest(input *DescribeEndpointInput) DescribeEndpointRequest

DescribeEndpointRequest returns a request value for making API operation for Amazon Comprehend.

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint

func (*Client) DescribeEntitiesDetectionJobRequest added in v0.9.0 

func (c *Client) DescribeEntitiesDetectionJobRequest(input *DescribeEntitiesDetectionJobInput) DescribeEntitiesDetectionJobRequest

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

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

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

func (*Client) DescribeEntityRecognizerRequest added in v0.9.0 

func (c *Client) DescribeEntityRecognizerRequest(input *DescribeEntityRecognizerInput) DescribeEntityRecognizerRequest

DescribeEntityRecognizerRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) DescribeKeyPhrasesDetectionJobRequest added in v0.9.0 

func (c *Client) DescribeKeyPhrasesDetectionJobRequest(input *DescribeKeyPhrasesDetectionJobInput) DescribeKeyPhrasesDetectionJobRequest

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

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

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

func (*Client) DescribeSentimentDetectionJobRequest added in v0.9.0 

func (c *Client) DescribeSentimentDetectionJobRequest(input *DescribeSentimentDetectionJobInput) DescribeSentimentDetectionJobRequest

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

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

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

func (*Client) DescribeTopicsDetectionJobRequest added in v0.9.0 

func (c *Client) DescribeTopicsDetectionJobRequest(input *DescribeTopicsDetectionJobInput) DescribeTopicsDetectionJobRequest

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

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

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

func (*Client) DetectDominantLanguageRequest added in v0.9.0 

func (c *Client) DetectDominantLanguageRequest(input *DetectDominantLanguageInput) DetectDominantLanguageRequest

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

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

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

func (*Client) DetectEntitiesRequest added in v0.9.0 

func (c *Client) DetectEntitiesRequest(input *DetectEntitiesInput) DetectEntitiesRequest

DetectEntitiesRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) DetectKeyPhrasesRequest added in v0.9.0 

func (c *Client) DetectKeyPhrasesRequest(input *DetectKeyPhrasesInput) DetectKeyPhrasesRequest

DetectKeyPhrasesRequest returns a request value for making API operation for Amazon Comprehend.

Detects the key noun phrases found in the text. 

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

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

func (*Client) DetectSentimentRequest added in v0.9.0 

func (c *Client) DetectSentimentRequest(input *DetectSentimentInput) DetectSentimentRequest

DetectSentimentRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) DetectSyntaxRequest added in v0.9.0 

func (c *Client) DetectSyntaxRequest(input *DetectSyntaxInput) DetectSyntaxRequest

DetectSyntaxRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) ListDocumentClassificationJobsRequest added in v0.9.0 

func (c *Client) ListDocumentClassificationJobsRequest(input *ListDocumentClassificationJobsInput) ListDocumentClassificationJobsRequest

ListDocumentClassificationJobsRequest returns a request value for making API operation for Amazon Comprehend.

Gets a list of the documentation classification jobs that you have submitted. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs

func (*Client) ListDocumentClassifiersRequest added in v0.9.0 

func (c *Client) ListDocumentClassifiersRequest(input *ListDocumentClassifiersInput) ListDocumentClassifiersRequest

ListDocumentClassifiersRequest returns a request value for making API operation for Amazon Comprehend.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers

func (*Client) ListDominantLanguageDetectionJobsRequest added in v0.9.0 

func (c *Client) ListDominantLanguageDetectionJobsRequest(input *ListDominantLanguageDetectionJobsInput) ListDominantLanguageDetectionJobsRequest

ListDominantLanguageDetectionJobsRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) ListEndpointsRequest added in v0.18.0 

func (c *Client) ListEndpointsRequest(input *ListEndpointsInput) ListEndpointsRequest

ListEndpointsRequest returns a request value for making API operation for Amazon Comprehend.

Gets a list of all existing endpoints that you've created. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints

func (*Client) ListEntitiesDetectionJobsRequest added in v0.9.0 

func (c *Client) ListEntitiesDetectionJobsRequest(input *ListEntitiesDetectionJobsInput) ListEntitiesDetectionJobsRequest

ListEntitiesDetectionJobsRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) ListEntityRecognizersRequest added in v0.9.0 

func (c *Client) ListEntityRecognizersRequest(input *ListEntityRecognizersInput) ListEntityRecognizersRequest

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers

func (*Client) ListKeyPhrasesDetectionJobsRequest added in v0.9.0 

func (c *Client) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDetectionJobsInput) ListKeyPhrasesDetectionJobsRequest

ListKeyPhrasesDetectionJobsRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) ListSentimentDetectionJobsRequest added in v0.9.0 

func (c *Client) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) ListSentimentDetectionJobsRequest

ListSentimentDetectionJobsRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon Comprehend.

Lists all tags associated with a given Amazon Comprehend resource. 

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

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

func (*Client) ListTopicsDetectionJobsRequest added in v0.9.0 

func (c *Client) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) ListTopicsDetectionJobsRequest

ListTopicsDetectionJobsRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) StartDocumentClassificationJobRequest added in v0.9.0 

func (c *Client) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) StartDocumentClassificationJobRequest

StartDocumentClassificationJobRequest returns a request value for making API operation for Amazon Comprehend.

Starts an asynchronous document classification job. Use the operation to track the progress of the job. 

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

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

func (*Client) StartDominantLanguageDetectionJobRequest added in v0.9.0 

func (c *Client) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) StartDominantLanguageDetectionJobRequest

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

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

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

func (*Client) StartEntitiesDetectionJobRequest added in v0.9.0 

func (c *Client) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) StartEntitiesDetectionJobRequest

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

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

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

func (*Client) StartKeyPhrasesDetectionJobRequest added in v0.9.0 

func (c *Client) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) StartKeyPhrasesDetectionJobRequest

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

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

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

func (*Client) StartSentimentDetectionJobRequest added in v0.9.0 

func (c *Client) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) StartSentimentDetectionJobRequest

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

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

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

func (*Client) StartTopicsDetectionJobRequest added in v0.9.0 

func (c *Client) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) StartTopicsDetectionJobRequest

StartTopicsDetectionJobRequest returns a request value for making API operation for Amazon Comprehend.

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

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

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

func (*Client) StopDominantLanguageDetectionJobRequest added in v0.9.0 

func (c *Client) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) StopDominantLanguageDetectionJobRequest

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

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

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

func (*Client) StopEntitiesDetectionJobRequest added in v0.9.0 

func (c *Client) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) StopEntitiesDetectionJobRequest

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

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

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

func (*Client) StopKeyPhrasesDetectionJobRequest added in v0.9.0 

func (c *Client) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) StopKeyPhrasesDetectionJobRequest

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

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

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

func (*Client) StopSentimentDetectionJobRequest added in v0.9.0 

func (c *Client) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) StopSentimentDetectionJobRequest

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

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

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

func (*Client) StopTrainingDocumentClassifierRequest added in v0.9.0 

func (c *Client) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) StopTrainingDocumentClassifierRequest

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

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

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

func (*Client) StopTrainingEntityRecognizerRequest added in v0.9.0 

func (c *Client) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) StopTrainingEntityRecognizerRequest

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

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

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

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

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

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

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

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon Comprehend.

Removes a specific tag associated with an Amazon Comprehend resource. 

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

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

func (*Client) UpdateEndpointRequest added in v0.18.0 

func (c *Client) UpdateEndpointRequest(input *UpdateEndpointInput) UpdateEndpointRequest

UpdateEndpointRequest returns a request value for making API operation for Amazon Comprehend.

Updates information about the specified endpoint. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint

type CreateDocumentClassifierInput added in v0.6.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 following
	// 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 LanguageCode `type:"string" required:"true" enum:"true"`

	// Indicates the mode in which the classifier will be trained. The classifier
	// can be trained in multi-class mode, which identifies one and only one class
	// for each document, or multi-label mode, which identifies one or more labels
	// for each document. In multi-label mode, multiple labels for an individual
	// document are separated by a delimiter. The default delimiter between labels
	// is a pipe (|).
	Mode DocumentClassifierMode `type:"string" enum:"true"`

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

func (s CreateDocumentClassifierInput) String() string

String returns the string representation

func (*CreateDocumentClassifierInput) Validate added in v0.6.0 

func (s *CreateDocumentClassifierInput) Validate() error

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

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

func (s CreateDocumentClassifierOutput) String() string

String returns the string representation

type CreateDocumentClassifierRequest added in v0.6.0 

type CreateDocumentClassifierRequest struct {
	*aws.Request
	Input *CreateDocumentClassifierInput
	Copy  func(*CreateDocumentClassifierInput) CreateDocumentClassifierRequest
}

CreateDocumentClassifierRequest is the request type for the CreateDocumentClassifier API operation.

func (CreateDocumentClassifierRequest) Send added in v0.6.0 

func (r CreateDocumentClassifierRequest) Send(ctx context.Context) (*CreateDocumentClassifierResponse, error)

Send marshals and sends the CreateDocumentClassifier API request.

type CreateDocumentClassifierResponse added in v0.9.0 

type CreateDocumentClassifierResponse struct {
	*CreateDocumentClassifierOutput
	// contains filtered or unexported fields
}

CreateDocumentClassifierResponse is the response type for the CreateDocumentClassifier API operation.

func (*CreateDocumentClassifierResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the CreateDocumentClassifier request.

type CreateEndpointInput added in v0.18.0 

type CreateEndpointInput struct {

	// An idempotency token provided by the customer. If this token matches a previous
	// endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The desired number of inference units to be used by the model using this
	// endpoint. Each inference unit represents of a throughput of 100 characters
	// per second.
	//
	// DesiredInferenceUnits is a required field
	DesiredInferenceUnits *int64 `min:"1" type:"integer" required:"true"`

	// This is the descriptive suffix that becomes part of the EndpointArn used
	// for all subsequent requests to this resource.
	//
	// EndpointName is a required field
	EndpointName *string `type:"string" required:"true"`

	// The Amazon Resource Number (ARN) of the model to which the endpoint will
	// be attached.
	//
	// ModelArn is a required field
	ModelArn *string `type:"string" required:"true"`

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

func (CreateEndpointInput) String added in v0.18.0 

func (s CreateEndpointInput) String() string

String returns the string representation

func (*CreateEndpointInput) Validate added in v0.18.0 

func (s *CreateEndpointInput) Validate() error

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

type CreateEndpointOutput added in v0.18.0 

type CreateEndpointOutput struct {

	// The Amazon Resource Number (ARN) of the endpoint being created.
	EndpointArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateEndpointOutput) String added in v0.18.0 

func (s CreateEndpointOutput) String() string

String returns the string representation

type CreateEndpointRequest added in v0.18.0 

type CreateEndpointRequest struct {
	*aws.Request
	Input *CreateEndpointInput
	Copy  func(*CreateEndpointInput) CreateEndpointRequest
}

CreateEndpointRequest is the request type for the CreateEndpoint API operation.

func (CreateEndpointRequest) Send added in v0.18.0 

func (r CreateEndpointRequest) Send(ctx context.Context) (*CreateEndpointResponse, error)

Send marshals and sends the CreateEndpoint API request.

type CreateEndpointResponse added in v0.18.0 

type CreateEndpointResponse struct {
	*CreateEndpointOutput
	// contains filtered or unexported fields
}

CreateEndpointResponse is the response type for the CreateEndpoint API operation.

func (*CreateEndpointResponse) SDKResponseMetdata added in v0.18.0 

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

SDKResponseMetdata returns the response metadata for the CreateEndpoint request.

type CreateEntityRecognizerInput added in v0.6.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 LanguageCode `type:"string" required:"true" enum:"true"`

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

func (s CreateEntityRecognizerInput) String() string

String returns the string representation

func (*CreateEntityRecognizerInput) Validate added in v0.6.0 

func (s *CreateEntityRecognizerInput) Validate() error

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

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

func (s CreateEntityRecognizerOutput) String() string

String returns the string representation

type CreateEntityRecognizerRequest added in v0.6.0 

type CreateEntityRecognizerRequest struct {
	*aws.Request
	Input *CreateEntityRecognizerInput
	Copy  func(*CreateEntityRecognizerInput) CreateEntityRecognizerRequest
}

CreateEntityRecognizerRequest is the request type for the CreateEntityRecognizer API operation.

func (CreateEntityRecognizerRequest) Send added in v0.6.0 

func (r CreateEntityRecognizerRequest) Send(ctx context.Context) (*CreateEntityRecognizerResponse, error)

Send marshals and sends the CreateEntityRecognizer API request.

type CreateEntityRecognizerResponse added in v0.9.0 

type CreateEntityRecognizerResponse struct {
	*CreateEntityRecognizerOutput
	// contains filtered or unexported fields
}

CreateEntityRecognizerResponse is the response type for the CreateEntityRecognizer API operation.

func (*CreateEntityRecognizerResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the CreateEntityRecognizer request.

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

func (s DeleteDocumentClassifierInput) String() string

String returns the string representation

func (*DeleteDocumentClassifierInput) Validate added in v0.6.0 

func (s *DeleteDocumentClassifierInput) Validate() error

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

type DeleteDocumentClassifierOutput added in v0.6.0 

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

func (DeleteDocumentClassifierOutput) String added in v0.6.0 

func (s DeleteDocumentClassifierOutput) String() string

String returns the string representation

type DeleteDocumentClassifierRequest added in v0.6.0 

type DeleteDocumentClassifierRequest struct {
	*aws.Request
	Input *DeleteDocumentClassifierInput
	Copy  func(*DeleteDocumentClassifierInput) DeleteDocumentClassifierRequest
}

DeleteDocumentClassifierRequest is the request type for the DeleteDocumentClassifier API operation.

func (DeleteDocumentClassifierRequest) Send added in v0.6.0 

func (r DeleteDocumentClassifierRequest) Send(ctx context.Context) (*DeleteDocumentClassifierResponse, error)

Send marshals and sends the DeleteDocumentClassifier API request.

type DeleteDocumentClassifierResponse added in v0.9.0 

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

DeleteDocumentClassifierResponse is the response type for the DeleteDocumentClassifier API operation.

func (*DeleteDocumentClassifierResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteDocumentClassifier request.

type DeleteEndpointInput added in v0.18.0 

type DeleteEndpointInput struct {

	// The Amazon Resource Number (ARN) of the endpoint being deleted.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEndpointInput) String added in v0.18.0 

func (s DeleteEndpointInput) String() string

String returns the string representation

func (*DeleteEndpointInput) Validate added in v0.18.0 

func (s *DeleteEndpointInput) Validate() error

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

type DeleteEndpointOutput added in v0.18.0 

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

func (DeleteEndpointOutput) String added in v0.18.0 

func (s DeleteEndpointOutput) String() string

String returns the string representation

type DeleteEndpointRequest added in v0.18.0 

type DeleteEndpointRequest struct {
	*aws.Request
	Input *DeleteEndpointInput
	Copy  func(*DeleteEndpointInput) DeleteEndpointRequest
}

DeleteEndpointRequest is the request type for the DeleteEndpoint API operation.

func (DeleteEndpointRequest) Send added in v0.18.0 

func (r DeleteEndpointRequest) Send(ctx context.Context) (*DeleteEndpointResponse, error)

Send marshals and sends the DeleteEndpoint API request.

type DeleteEndpointResponse added in v0.18.0 

type DeleteEndpointResponse struct {
	*DeleteEndpointOutput
	// contains filtered or unexported fields
}

DeleteEndpointResponse is the response type for the DeleteEndpoint API operation.

func (*DeleteEndpointResponse) SDKResponseMetdata added in v0.18.0 

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

SDKResponseMetdata returns the response metadata for the DeleteEndpoint request.

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

func (s DeleteEntityRecognizerInput) String() string

String returns the string representation

func (*DeleteEntityRecognizerInput) Validate added in v0.6.0 

func (s *DeleteEntityRecognizerInput) Validate() error

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

type DeleteEntityRecognizerOutput added in v0.6.0 

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

func (DeleteEntityRecognizerOutput) String added in v0.6.0 

func (s DeleteEntityRecognizerOutput) String() string

String returns the string representation

type DeleteEntityRecognizerRequest added in v0.6.0 

type DeleteEntityRecognizerRequest struct {
	*aws.Request
	Input *DeleteEntityRecognizerInput
	Copy  func(*DeleteEntityRecognizerInput) DeleteEntityRecognizerRequest
}

DeleteEntityRecognizerRequest is the request type for the DeleteEntityRecognizer API operation.

func (DeleteEntityRecognizerRequest) Send added in v0.6.0 

func (r DeleteEntityRecognizerRequest) Send(ctx context.Context) (*DeleteEntityRecognizerResponse, error)

Send marshals and sends the DeleteEntityRecognizer API request.

type DeleteEntityRecognizerResponse added in v0.9.0 

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

DeleteEntityRecognizerResponse is the response type for the DeleteEntityRecognizer API operation.

func (*DeleteEntityRecognizerResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DeleteEntityRecognizer request.

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

func (s DescribeDocumentClassificationJobInput) String() string

String returns the string representation

func (*DescribeDocumentClassificationJobInput) Validate added in v0.6.0 

func (s *DescribeDocumentClassificationJobInput) Validate() error

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

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

func (s DescribeDocumentClassificationJobOutput) String() string

String returns the string representation

type DescribeDocumentClassificationJobRequest added in v0.6.0 

type DescribeDocumentClassificationJobRequest struct {
	*aws.Request
	Input *DescribeDocumentClassificationJobInput
	Copy  func(*DescribeDocumentClassificationJobInput) DescribeDocumentClassificationJobRequest
}

DescribeDocumentClassificationJobRequest is the request type for the DescribeDocumentClassificationJob API operation.

func (DescribeDocumentClassificationJobRequest) Send added in v0.6.0 

func (r DescribeDocumentClassificationJobRequest) Send(ctx context.Context) (*DescribeDocumentClassificationJobResponse, error)

Send marshals and sends the DescribeDocumentClassificationJob API request.

type DescribeDocumentClassificationJobResponse added in v0.9.0 

type DescribeDocumentClassificationJobResponse struct {
	*DescribeDocumentClassificationJobOutput
	// contains filtered or unexported fields
}

DescribeDocumentClassificationJobResponse is the response type for the DescribeDocumentClassificationJob API operation.

func (*DescribeDocumentClassificationJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeDocumentClassificationJob request.

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

func (s DescribeDocumentClassifierInput) String() string

String returns the string representation

func (*DescribeDocumentClassifierInput) Validate added in v0.6.0 

func (s *DescribeDocumentClassifierInput) Validate() error

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

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

func (s DescribeDocumentClassifierOutput) String() string

String returns the string representation

type DescribeDocumentClassifierRequest added in v0.6.0 

type DescribeDocumentClassifierRequest struct {
	*aws.Request
	Input *DescribeDocumentClassifierInput
	Copy  func(*DescribeDocumentClassifierInput) DescribeDocumentClassifierRequest
}

DescribeDocumentClassifierRequest is the request type for the DescribeDocumentClassifier API operation.

func (DescribeDocumentClassifierRequest) Send added in v0.6.0 

func (r DescribeDocumentClassifierRequest) Send(ctx context.Context) (*DescribeDocumentClassifierResponse, error)

Send marshals and sends the DescribeDocumentClassifier API request.

type DescribeDocumentClassifierResponse added in v0.9.0 

type DescribeDocumentClassifierResponse struct {
	*DescribeDocumentClassifierOutput
	// contains filtered or unexported fields
}

DescribeDocumentClassifierResponse is the response type for the DescribeDocumentClassifier API operation.

func (*DescribeDocumentClassifierResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeDocumentClassifier request.

type DescribeDominantLanguageDetectionJobInput added in v0.5.0 

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

func (s DescribeDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) Validate added in v0.5.0 

func (s *DescribeDominantLanguageDetectionJobInput) Validate() error

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

type DescribeDominantLanguageDetectionJobOutput added in v0.5.0 

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

func (s DescribeDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type DescribeDominantLanguageDetectionJobRequest added in v0.5.0 

type DescribeDominantLanguageDetectionJobRequest struct {
	*aws.Request
	Input *DescribeDominantLanguageDetectionJobInput
	Copy  func(*DescribeDominantLanguageDetectionJobInput) DescribeDominantLanguageDetectionJobRequest
}

DescribeDominantLanguageDetectionJobRequest is the request type for the DescribeDominantLanguageDetectionJob API operation.

func (DescribeDominantLanguageDetectionJobRequest) Send added in v0.5.0 

func (r DescribeDominantLanguageDetectionJobRequest) Send(ctx context.Context) (*DescribeDominantLanguageDetectionJobResponse, error)

Send marshals and sends the DescribeDominantLanguageDetectionJob API request.

type DescribeDominantLanguageDetectionJobResponse added in v0.9.0 

type DescribeDominantLanguageDetectionJobResponse struct {
	*DescribeDominantLanguageDetectionJobOutput
	// contains filtered or unexported fields
}

DescribeDominantLanguageDetectionJobResponse is the response type for the DescribeDominantLanguageDetectionJob API operation.

func (*DescribeDominantLanguageDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeDominantLanguageDetectionJob request.

type DescribeEndpointInput added in v0.18.0 

type DescribeEndpointInput struct {

	// The Amazon Resource Number (ARN) of the endpoint being described.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEndpointInput) String added in v0.18.0 

func (s DescribeEndpointInput) String() string

String returns the string representation

func (*DescribeEndpointInput) Validate added in v0.18.0 

func (s *DescribeEndpointInput) Validate() error

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

type DescribeEndpointOutput added in v0.18.0 

type DescribeEndpointOutput struct {

	// Describes information associated with the specific endpoint.
	EndpointProperties *EndpointProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEndpointOutput) String added in v0.18.0 

func (s DescribeEndpointOutput) String() string

String returns the string representation

type DescribeEndpointRequest added in v0.18.0 

type DescribeEndpointRequest struct {
	*aws.Request
	Input *DescribeEndpointInput
	Copy  func(*DescribeEndpointInput) DescribeEndpointRequest
}

DescribeEndpointRequest is the request type for the DescribeEndpoint API operation.

func (DescribeEndpointRequest) Send added in v0.18.0 

func (r DescribeEndpointRequest) Send(ctx context.Context) (*DescribeEndpointResponse, error)

Send marshals and sends the DescribeEndpoint API request.

type DescribeEndpointResponse added in v0.18.0 

type DescribeEndpointResponse struct {
	*DescribeEndpointOutput
	// contains filtered or unexported fields
}

DescribeEndpointResponse is the response type for the DescribeEndpoint API operation.

func (*DescribeEndpointResponse) SDKResponseMetdata added in v0.18.0 

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

SDKResponseMetdata returns the response metadata for the DescribeEndpoint request.

type DescribeEntitiesDetectionJobInput added in v0.5.0 

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

func (s DescribeEntitiesDetectionJobInput) String() string

String returns the string representation

func (*DescribeEntitiesDetectionJobInput) Validate added in v0.5.0 

func (s *DescribeEntitiesDetectionJobInput) Validate() error

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

type DescribeEntitiesDetectionJobOutput added in v0.5.0 

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

func (s DescribeEntitiesDetectionJobOutput) String() string

String returns the string representation

type DescribeEntitiesDetectionJobRequest added in v0.5.0 

type DescribeEntitiesDetectionJobRequest struct {
	*aws.Request
	Input *DescribeEntitiesDetectionJobInput
	Copy  func(*DescribeEntitiesDetectionJobInput) DescribeEntitiesDetectionJobRequest
}

DescribeEntitiesDetectionJobRequest is the request type for the DescribeEntitiesDetectionJob API operation.

func (DescribeEntitiesDetectionJobRequest) Send added in v0.5.0 

func (r DescribeEntitiesDetectionJobRequest) Send(ctx context.Context) (*DescribeEntitiesDetectionJobResponse, error)

Send marshals and sends the DescribeEntitiesDetectionJob API request.

type DescribeEntitiesDetectionJobResponse added in v0.9.0 

type DescribeEntitiesDetectionJobResponse struct {
	*DescribeEntitiesDetectionJobOutput
	// contains filtered or unexported fields
}

DescribeEntitiesDetectionJobResponse is the response type for the DescribeEntitiesDetectionJob API operation.

func (*DescribeEntitiesDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeEntitiesDetectionJob request.

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

func (s DescribeEntityRecognizerInput) String() string

String returns the string representation

func (*DescribeEntityRecognizerInput) Validate added in v0.6.0 

func (s *DescribeEntityRecognizerInput) Validate() error

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

type DescribeEntityRecognizerOutput added in v0.6.0 

type DescribeEntityRecognizerOutput struct {

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

func (DescribeEntityRecognizerOutput) String added in v0.6.0 

func (s DescribeEntityRecognizerOutput) String() string

String returns the string representation

type DescribeEntityRecognizerRequest added in v0.6.0 

type DescribeEntityRecognizerRequest struct {
	*aws.Request
	Input *DescribeEntityRecognizerInput
	Copy  func(*DescribeEntityRecognizerInput) DescribeEntityRecognizerRequest
}

DescribeEntityRecognizerRequest is the request type for the DescribeEntityRecognizer API operation.

func (DescribeEntityRecognizerRequest) Send added in v0.6.0 

func (r DescribeEntityRecognizerRequest) Send(ctx context.Context) (*DescribeEntityRecognizerResponse, error)

Send marshals and sends the DescribeEntityRecognizer API request.

type DescribeEntityRecognizerResponse added in v0.9.0 

type DescribeEntityRecognizerResponse struct {
	*DescribeEntityRecognizerOutput
	// contains filtered or unexported fields
}

DescribeEntityRecognizerResponse is the response type for the DescribeEntityRecognizer API operation.

func (*DescribeEntityRecognizerResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeEntityRecognizer request.

type DescribeKeyPhrasesDetectionJobInput added in v0.5.0 

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

func (s DescribeKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) Validate added in v0.5.0 

func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error

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

type DescribeKeyPhrasesDetectionJobOutput added in v0.5.0 

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

func (s DescribeKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type DescribeKeyPhrasesDetectionJobRequest added in v0.5.0 

type DescribeKeyPhrasesDetectionJobRequest struct {
	*aws.Request
	Input *DescribeKeyPhrasesDetectionJobInput
	Copy  func(*DescribeKeyPhrasesDetectionJobInput) DescribeKeyPhrasesDetectionJobRequest
}

DescribeKeyPhrasesDetectionJobRequest is the request type for the DescribeKeyPhrasesDetectionJob API operation.

func (DescribeKeyPhrasesDetectionJobRequest) Send added in v0.5.0 

func (r DescribeKeyPhrasesDetectionJobRequest) Send(ctx context.Context) (*DescribeKeyPhrasesDetectionJobResponse, error)

Send marshals and sends the DescribeKeyPhrasesDetectionJob API request.

type DescribeKeyPhrasesDetectionJobResponse added in v0.9.0 

type DescribeKeyPhrasesDetectionJobResponse struct {
	*DescribeKeyPhrasesDetectionJobOutput
	// contains filtered or unexported fields
}

DescribeKeyPhrasesDetectionJobResponse is the response type for the DescribeKeyPhrasesDetectionJob API operation.

func (*DescribeKeyPhrasesDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeKeyPhrasesDetectionJob request.

type DescribeSentimentDetectionJobInput added in v0.5.0 

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

func (s DescribeSentimentDetectionJobInput) String() string

String returns the string representation

func (*DescribeSentimentDetectionJobInput) Validate added in v0.5.0 

func (s *DescribeSentimentDetectionJobInput) Validate() error

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

type DescribeSentimentDetectionJobOutput added in v0.5.0 

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

func (s DescribeSentimentDetectionJobOutput) String() string

String returns the string representation

type DescribeSentimentDetectionJobRequest added in v0.5.0 

type DescribeSentimentDetectionJobRequest struct {
	*aws.Request
	Input *DescribeSentimentDetectionJobInput
	Copy  func(*DescribeSentimentDetectionJobInput) DescribeSentimentDetectionJobRequest
}

DescribeSentimentDetectionJobRequest is the request type for the DescribeSentimentDetectionJob API operation.

func (DescribeSentimentDetectionJobRequest) Send added in v0.5.0 

func (r DescribeSentimentDetectionJobRequest) Send(ctx context.Context) (*DescribeSentimentDetectionJobResponse, error)

Send marshals and sends the DescribeSentimentDetectionJob API request.

type DescribeSentimentDetectionJobResponse added in v0.9.0 

type DescribeSentimentDetectionJobResponse struct {
	*DescribeSentimentDetectionJobOutput
	// contains filtered or unexported fields
}

DescribeSentimentDetectionJobResponse is the response type for the DescribeSentimentDetectionJob API operation.

func (*DescribeSentimentDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeSentimentDetectionJob request.

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

func (s DescribeTopicsDetectionJobInput) String() string

String returns the string representation

func (*DescribeTopicsDetectionJobInput) Validate 

func (s *DescribeTopicsDetectionJobInput) Validate() error

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

type DescribeTopicsDetectionJobOutput 

type DescribeTopicsDetectionJobOutput struct {

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

func (DescribeTopicsDetectionJobOutput) String 

func (s DescribeTopicsDetectionJobOutput) String() string

String returns the string representation

type DescribeTopicsDetectionJobRequest 

type DescribeTopicsDetectionJobRequest struct {
	*aws.Request
	Input *DescribeTopicsDetectionJobInput
	Copy  func(*DescribeTopicsDetectionJobInput) DescribeTopicsDetectionJobRequest
}

DescribeTopicsDetectionJobRequest is the request type for the DescribeTopicsDetectionJob API operation.

func (DescribeTopicsDetectionJobRequest) Send 

func (r DescribeTopicsDetectionJobRequest) Send(ctx context.Context) (*DescribeTopicsDetectionJobResponse, error)

Send marshals and sends the DescribeTopicsDetectionJob API request.

type DescribeTopicsDetectionJobResponse added in v0.9.0 

type DescribeTopicsDetectionJobResponse struct {
	*DescribeTopicsDetectionJobOutput
	// contains filtered or unexported fields
}

DescribeTopicsDetectionJobResponse is the response type for the DescribeTopicsDetectionJob API operation.

func (*DescribeTopicsDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DescribeTopicsDetectionJob request.

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

func (s DetectDominantLanguageInput) String() string

String returns the string representation

func (*DetectDominantLanguageInput) Validate 

func (s *DetectDominantLanguageInput) Validate() error

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

type DetectDominantLanguageOutput 

type DetectDominantLanguageOutput struct {

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

func (DetectDominantLanguageOutput) String 

func (s DetectDominantLanguageOutput) String() string

String returns the string representation

type DetectDominantLanguageRequest 

type DetectDominantLanguageRequest struct {
	*aws.Request
	Input *DetectDominantLanguageInput
	Copy  func(*DetectDominantLanguageInput) DetectDominantLanguageRequest
}

DetectDominantLanguageRequest is the request type for the DetectDominantLanguage API operation.

func (DetectDominantLanguageRequest) Send 

func (r DetectDominantLanguageRequest) Send(ctx context.Context) (*DetectDominantLanguageResponse, error)

Send marshals and sends the DetectDominantLanguage API request.

type DetectDominantLanguageResponse added in v0.9.0 

type DetectDominantLanguageResponse struct {
	*DetectDominantLanguageOutput
	// contains filtered or unexported fields
}

DetectDominantLanguageResponse is the response type for the DetectDominantLanguage API operation.

func (*DetectDominantLanguageResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DetectDominantLanguage request.

type DetectEntitiesInput 

type DetectEntitiesInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// 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) 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) String 

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectEntitiesRequest 

type DetectEntitiesRequest struct {
	*aws.Request
	Input *DetectEntitiesInput
	Copy  func(*DetectEntitiesInput) DetectEntitiesRequest
}

DetectEntitiesRequest is the request type for the DetectEntities API operation.

func (DetectEntitiesRequest) Send 

func (r DetectEntitiesRequest) Send(ctx context.Context) (*DetectEntitiesResponse, error)

Send marshals and sends the DetectEntities API request.

type DetectEntitiesResponse added in v0.9.0 

type DetectEntitiesResponse struct {
	*DetectEntitiesOutput
	// contains filtered or unexported fields
}

DetectEntitiesResponse is the response type for the DetectEntities API operation.

func (*DetectEntitiesResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DetectEntities request.

type DetectKeyPhrasesInput 

type DetectKeyPhrasesInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// 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) 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) String 

func (s DetectKeyPhrasesOutput) String() string

String returns the string representation

type DetectKeyPhrasesRequest 

type DetectKeyPhrasesRequest struct {
	*aws.Request
	Input *DetectKeyPhrasesInput
	Copy  func(*DetectKeyPhrasesInput) DetectKeyPhrasesRequest
}

DetectKeyPhrasesRequest is the request type for the DetectKeyPhrases API operation.

func (DetectKeyPhrasesRequest) Send 

func (r DetectKeyPhrasesRequest) Send(ctx context.Context) (*DetectKeyPhrasesResponse, error)

Send marshals and sends the DetectKeyPhrases API request.

type DetectKeyPhrasesResponse added in v0.9.0 

type DetectKeyPhrasesResponse struct {
	*DetectKeyPhrasesOutput
	// contains filtered or unexported fields
}

DetectKeyPhrasesResponse is the response type for the DetectKeyPhrases API operation.

func (*DetectKeyPhrasesResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DetectKeyPhrases request.

type DetectSentimentInput 

type DetectSentimentInput struct {

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// 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) 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 SentimentType `type:"string" enum:"true"`

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

func (DetectSentimentOutput) String 

func (s DetectSentimentOutput) String() string

String returns the string representation

type DetectSentimentRequest 

type DetectSentimentRequest struct {
	*aws.Request
	Input *DetectSentimentInput
	Copy  func(*DetectSentimentInput) DetectSentimentRequest
}

DetectSentimentRequest is the request type for the DetectSentiment API operation.

func (DetectSentimentRequest) Send 

func (r DetectSentimentRequest) Send(ctx context.Context) (*DetectSentimentResponse, error)

Send marshals and sends the DetectSentiment API request.

type DetectSentimentResponse added in v0.9.0 

type DetectSentimentResponse struct {
	*DetectSentimentOutput
	// contains filtered or unexported fields
}

DetectSentimentResponse is the response type for the DetectSentiment API operation.

func (*DetectSentimentResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DetectSentiment request.

type DetectSyntaxInput added in v0.5.0 

type DetectSyntaxInput struct {

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

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

func (s DetectSyntaxInput) String() string

String returns the string representation

func (*DetectSyntaxInput) Validate added in v0.5.0 

func (s *DetectSyntaxInput) Validate() error

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

type DetectSyntaxOutput added in v0.5.0 

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

func (s DetectSyntaxOutput) String() string

String returns the string representation

type DetectSyntaxRequest added in v0.5.0 

type DetectSyntaxRequest struct {
	*aws.Request
	Input *DetectSyntaxInput
	Copy  func(*DetectSyntaxInput) DetectSyntaxRequest
}

DetectSyntaxRequest is the request type for the DetectSyntax API operation.

func (DetectSyntaxRequest) Send added in v0.5.0 

func (r DetectSyntaxRequest) Send(ctx context.Context) (*DetectSyntaxResponse, error)

Send marshals and sends the DetectSyntax API request.

type DetectSyntaxResponse added in v0.9.0 

type DetectSyntaxResponse struct {
	*DetectSyntaxOutput
	// contains filtered or unexported fields
}

DetectSyntaxResponse is the response type for the DetectSyntax API operation.

func (*DetectSyntaxResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the DetectSyntax request.

type DocumentClass added in v0.18.0 

type DocumentClass struct {

	// The name of the class.
	Name *string `min:"1" type:"string"`

	// The confidence score that Amazon Comprehend has this class correctly attributed.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Specifies the class that categorizes the document being analyzed

func (DocumentClass) String added in v0.18.0 

func (s DocumentClass) String() string

String returns the string representation

type DocumentClassificationJobFilter added in v0.6.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 JobStatus `type:"string" enum:"true"`

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

func (s DocumentClassificationJobFilter) String() string

String returns the string representation

func (*DocumentClassificationJobFilter) Validate added in v0.6.0 

func (s *DocumentClassificationJobFilter) Validate() error

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

type DocumentClassificationJobProperties added in v0.6.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 JobStatus `type:"string" enum:"true"`

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

func (s DocumentClassificationJobProperties) String() string

String returns the string representation

type DocumentClassifierFilter added in v0.6.0 

type DocumentClassifierFilter struct {

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

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

func (s DocumentClassifierFilter) String() string

String returns the string representation

type DocumentClassifierInputDataConfig added in v0.6.0 

type DocumentClassifierInputDataConfig struct {

	// Indicates the delimiter used to separate each label for training a multi-label
	// classifier. The default delimiter between labels is a pipe (|). You can use
	// a different character as a delimiter (if it's an allowed character) by specifying
	// it under Delimiter for labels. If the training documents use a delimiter
	// other than the default or the delimiter you specify, the labels on that line
	// will be combined to make a single unique label, such as LABELLABELLABEL.
	LabelDelimiter *string `min:"1" type:"string"`

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

func (s DocumentClassifierInputDataConfig) String() string

String returns the string representation

func (*DocumentClassifierInputDataConfig) Validate added in v0.6.0 

func (s *DocumentClassifierInputDataConfig) Validate() error

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

type DocumentClassifierMode added in v0.19.0 

type DocumentClassifierMode string
const (
	DocumentClassifierModeMultiClass DocumentClassifierMode = "MULTI_CLASS"
	DocumentClassifierModeMultiLabel DocumentClassifierMode = "MULTI_LABEL"
)

Enum values for DocumentClassifierMode

func (DocumentClassifierMode) MarshalValue added in v0.19.0 

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

func (DocumentClassifierMode) MarshalValueBuf added in v0.19.0 

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

type DocumentClassifierOutputDataConfig added in v0.8.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) String added in v0.8.0 

func (s DocumentClassifierOutputDataConfig) String() string

String returns the string representation

type DocumentClassifierProperties added in v0.6.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 LanguageCode `type:"string" enum:"true"`

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

	// Indicates the mode in which the specific classifier was trained. This also
	// indicates the format of input documents and the format of the confusion matrix.
	// Each classifier can only be trained in one mode and this cannot be changed
	// once the classifier is trained.
	Mode DocumentClassifierMode `type:"string" enum:"true"`

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

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

func (s DocumentClassifierProperties) String() string

String returns the string representation

type DocumentLabel added in v0.19.0 

type DocumentLabel struct {

	// The name of the label.
	Name *string `min:"1" type:"string"`

	// The confidence score that Amazon Comprehend has this label correctly attributed.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Specifies one of the label or labels that categorize the document being analyzed.

func (DocumentLabel) String added in v0.19.0 

func (s DocumentLabel) String() string

String returns the string representation

type DominantLanguage 

type DominantLanguage struct {

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

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

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

func (DominantLanguage) String 

func (s DominantLanguage) String() string

String returns the string representation

type DominantLanguageDetectionJobFilter added in v0.5.0 

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

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

func (s DominantLanguageDetectionJobFilter) String() string

String returns the string representation

func (*DominantLanguageDetectionJobFilter) Validate added in v0.5.0 

func (s *DominantLanguageDetectionJobFilter) Validate() error

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

type DominantLanguageDetectionJobProperties added in v0.5.0 

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

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

func (s DominantLanguageDetectionJobProperties) String() string

String returns the string representation

type EndpointFilter added in v0.18.0 

type EndpointFilter struct {

	// Specifies a date after which the returned endpoint or endpoints were created.
	CreationTimeAfter *time.Time `type:"timestamp"`

	// Specifies a date before which the returned endpoint or endpoints were created.
	CreationTimeBefore *time.Time `type:"timestamp"`

	// The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
	ModelArn *string `type:"string"`

	// Specifies the status of the endpoint being returned. Possible values are:
	// Creating, Ready, Updating, Deleting, Failed.
	Status EndpointStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The filter used to determine which endpoints are are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

func (EndpointFilter) String added in v0.18.0 

func (s EndpointFilter) String() string

String returns the string representation

type EndpointProperties added in v0.18.0 

type EndpointProperties struct {

	// The creation date and time of the endpoint.
	CreationTime *time.Time `type:"timestamp"`

	// The number of inference units currently used by the model using this endpoint.
	CurrentInferenceUnits *int64 `min:"1" type:"integer"`

	// The desired number of inference units to be used by the model using this
	// endpoint. Each inference unit represents of a throughput of 100 characters
	// per second.
	DesiredInferenceUnits *int64 `min:"1" type:"integer"`

	// The Amazon Resource Number (ARN) of the endpoint.
	EndpointArn *string `type:"string"`

	// The date and time that the endpoint was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// Specifies a reason for failure in cases of Failed status.
	Message *string `type:"string"`

	// The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
	ModelArn *string `type:"string"`

	// Specifies the status of the endpoint. Because the endpoint updates and creation
	// are asynchronous, so customers will need to wait for the endpoint to be Ready
	// status before making inference requests.
	Status EndpointStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Specifies information about the specified endpoint.

func (EndpointProperties) String added in v0.18.0 

func (s EndpointProperties) String() string

String returns the string representation

type EndpointStatus added in v0.18.0 

type EndpointStatus string
const (
	EndpointStatusCreating  EndpointStatus = "CREATING"
	EndpointStatusDeleting  EndpointStatus = "DELETING"
	EndpointStatusFailed    EndpointStatus = "FAILED"
	EndpointStatusInService EndpointStatus = "IN_SERVICE"
	EndpointStatusUpdating  EndpointStatus = "UPDATING"
)

Enum values for EndpointStatus

func (EndpointStatus) MarshalValue added in v0.18.0 

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

func (EndpointStatus) MarshalValueBuf added in v0.18.0 

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

type EntitiesDetectionJobFilter added in v0.5.0 

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

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

func (s EntitiesDetectionJobFilter) String() string

String returns the string representation

func (*EntitiesDetectionJobFilter) Validate added in v0.5.0 

func (s *EntitiesDetectionJobFilter) Validate() error

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

type EntitiesDetectionJobProperties added in v0.5.0 

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

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

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

func (s EntitiesDetectionJobProperties) String() string

String returns the string representation

type Entity 

type Entity struct {

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

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

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

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

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

Provides information about an entity.

func (Entity) String 

func (s Entity) String() string

String returns the string representation

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

func (s EntityRecognizerAnnotations) String() string

String returns the string representation

func (*EntityRecognizerAnnotations) Validate added in v0.6.0 

func (s *EntityRecognizerAnnotations) Validate() error

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

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

func (s EntityRecognizerDocuments) String() string

String returns the string representation

func (*EntityRecognizerDocuments) Validate added in v0.6.0 

func (s *EntityRecognizerDocuments) Validate() error

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

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

func (s EntityRecognizerEntityList) String() string

String returns the string representation

func (*EntityRecognizerEntityList) Validate added in v0.6.0 

func (s *EntityRecognizerEntityList) Validate() error

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

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

func (s EntityRecognizerEvaluationMetrics) String() string

String returns the string representation

type EntityRecognizerFilter added in v0.6.0 

type EntityRecognizerFilter struct {

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

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

func (s EntityRecognizerFilter) String() string

String returns the string representation

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

func (s EntityRecognizerInputDataConfig) String() string

String returns the string representation

func (*EntityRecognizerInputDataConfig) Validate added in v0.6.0 

func (s *EntityRecognizerInputDataConfig) Validate() error

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

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

func (s EntityRecognizerMetadata) String() string

String returns the string representation

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

func (s EntityRecognizerMetadataEntityTypesListItem) String() string

String returns the string representation

type EntityRecognizerProperties added in v0.6.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 LanguageCode `type:"string" enum:"true"`

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

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

func (s EntityRecognizerProperties) String() string

String returns the string representation

type EntityType 

type EntityType string
const (
	EntityTypePerson         EntityType = "PERSON"
	EntityTypeLocation       EntityType = "LOCATION"
	EntityTypeOrganization   EntityType = "ORGANIZATION"
	EntityTypeCommercialItem EntityType = "COMMERCIAL_ITEM"
	EntityTypeEvent          EntityType = "EVENT"
	EntityTypeDate           EntityType = "DATE"
	EntityTypeQuantity       EntityType = "QUANTITY"
	EntityTypeTitle          EntityType = "TITLE"
	EntityTypeOther          EntityType = "OTHER"
)

Enum values for EntityType

func (EntityType) MarshalValue added in v0.3.0 

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

func (EntityType) MarshalValueBuf added in v0.3.0 

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

type EntityTypesEvaluationMetrics added in v0.10.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) String added in v0.10.0 

func (s EntityTypesEvaluationMetrics) String() string

String returns the string representation

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

func (s EntityTypesListItem) String() string

String returns the string representation

func (*EntityTypesListItem) Validate added in v0.6.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 InputFormat `type:"string" enum:"true"`

	// 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) 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 InputFormat 

type InputFormat string
const (
	InputFormatOneDocPerFile InputFormat = "ONE_DOC_PER_FILE"
	InputFormatOneDocPerLine InputFormat = "ONE_DOC_PER_LINE"
)

Enum values for InputFormat

func (InputFormat) MarshalValue added in v0.3.0 

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

func (InputFormat) MarshalValueBuf added in v0.3.0 

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

type JobStatus 

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

Enum values for JobStatus

func (JobStatus) MarshalValue added in v0.3.0 

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

func (JobStatus) MarshalValueBuf added in v0.3.0 

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

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

func (s KeyPhrase) String() string

String returns the string representation

type KeyPhrasesDetectionJobFilter added in v0.5.0 

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

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

func (s KeyPhrasesDetectionJobFilter) String() string

String returns the string representation

func (*KeyPhrasesDetectionJobFilter) Validate added in v0.5.0 

func (s *KeyPhrasesDetectionJobFilter) Validate() error

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

type KeyPhrasesDetectionJobProperties added in v0.5.0 

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

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

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

func (s KeyPhrasesDetectionJobProperties) String() string

String returns the string representation

type LanguageCode 

type LanguageCode string
const (
	LanguageCodeEn   LanguageCode = "en"
	LanguageCodeEs   LanguageCode = "es"
	LanguageCodeFr   LanguageCode = "fr"
	LanguageCodeDe   LanguageCode = "de"
	LanguageCodeIt   LanguageCode = "it"
	LanguageCodePt   LanguageCode = "pt"
	LanguageCodeAr   LanguageCode = "ar"
	LanguageCodeHi   LanguageCode = "hi"
	LanguageCodeJa   LanguageCode = "ja"
	LanguageCodeKo   LanguageCode = "ko"
	LanguageCodeZh   LanguageCode = "zh"
	LanguageCodeZhTw LanguageCode = "zh-TW"
)

Enum values for LanguageCode

func (LanguageCode) MarshalValue added in v0.3.0 

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

func (LanguageCode) MarshalValueBuf added in v0.3.0 

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

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

func (s ListDocumentClassificationJobsInput) String() string

String returns the string representation

func (*ListDocumentClassificationJobsInput) Validate added in v0.6.0 

func (s *ListDocumentClassificationJobsInput) Validate() error

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

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

func (s ListDocumentClassificationJobsOutput) String() string

String returns the string representation

type ListDocumentClassificationJobsPaginator added in v0.9.0 

type ListDocumentClassificationJobsPaginator struct {
	aws.Pager
}

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

func NewListDocumentClassificationJobsPaginator added in v0.9.0 

func NewListDocumentClassificationJobsPaginator(req ListDocumentClassificationJobsRequest) ListDocumentClassificationJobsPaginator

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

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

// Example iterating over pages.
req := client.ListDocumentClassificationJobsRequest(input)
p := comprehend.NewListDocumentClassificationJobsRequestPaginator(req)

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

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

func (*ListDocumentClassificationJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListDocumentClassificationJobsPaginator) CurrentPage() *ListDocumentClassificationJobsOutput

type ListDocumentClassificationJobsRequest added in v0.6.0 

type ListDocumentClassificationJobsRequest struct {
	*aws.Request
	Input *ListDocumentClassificationJobsInput
	Copy  func(*ListDocumentClassificationJobsInput) ListDocumentClassificationJobsRequest
}

ListDocumentClassificationJobsRequest is the request type for the ListDocumentClassificationJobs API operation.

func (ListDocumentClassificationJobsRequest) Send added in v0.6.0 

func (r ListDocumentClassificationJobsRequest) Send(ctx context.Context) (*ListDocumentClassificationJobsResponse, error)

Send marshals and sends the ListDocumentClassificationJobs API request.

type ListDocumentClassificationJobsResponse added in v0.9.0 

type ListDocumentClassificationJobsResponse struct {
	*ListDocumentClassificationJobsOutput
	// contains filtered or unexported fields
}

ListDocumentClassificationJobsResponse is the response type for the ListDocumentClassificationJobs API operation.

func (*ListDocumentClassificationJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListDocumentClassificationJobs request.

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

func (s ListDocumentClassifiersInput) String() string

String returns the string representation

func (*ListDocumentClassifiersInput) Validate added in v0.6.0 

func (s *ListDocumentClassifiersInput) Validate() error

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

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

func (s ListDocumentClassifiersOutput) String() string

String returns the string representation

type ListDocumentClassifiersPaginator added in v0.9.0 

type ListDocumentClassifiersPaginator struct {
	aws.Pager
}

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

func NewListDocumentClassifiersPaginator added in v0.9.0 

func NewListDocumentClassifiersPaginator(req ListDocumentClassifiersRequest) ListDocumentClassifiersPaginator

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

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

// Example iterating over pages.
req := client.ListDocumentClassifiersRequest(input)
p := comprehend.NewListDocumentClassifiersRequestPaginator(req)

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

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

func (*ListDocumentClassifiersPaginator) CurrentPage added in v0.9.0 

func (p *ListDocumentClassifiersPaginator) CurrentPage() *ListDocumentClassifiersOutput

type ListDocumentClassifiersRequest added in v0.6.0 

type ListDocumentClassifiersRequest struct {
	*aws.Request
	Input *ListDocumentClassifiersInput
	Copy  func(*ListDocumentClassifiersInput) ListDocumentClassifiersRequest
}

ListDocumentClassifiersRequest is the request type for the ListDocumentClassifiers API operation.

func (ListDocumentClassifiersRequest) Send added in v0.6.0 

func (r ListDocumentClassifiersRequest) Send(ctx context.Context) (*ListDocumentClassifiersResponse, error)

Send marshals and sends the ListDocumentClassifiers API request.

type ListDocumentClassifiersResponse added in v0.9.0 

type ListDocumentClassifiersResponse struct {
	*ListDocumentClassifiersOutput
	// contains filtered or unexported fields
}

ListDocumentClassifiersResponse is the response type for the ListDocumentClassifiers API operation.

func (*ListDocumentClassifiersResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListDocumentClassifiers request.

type ListDominantLanguageDetectionJobsInput added in v0.5.0 

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

func (s ListDominantLanguageDetectionJobsInput) String() string

String returns the string representation

func (*ListDominantLanguageDetectionJobsInput) Validate added in v0.5.0 

func (s *ListDominantLanguageDetectionJobsInput) Validate() error

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

type ListDominantLanguageDetectionJobsOutput added in v0.5.0 

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

func (s ListDominantLanguageDetectionJobsOutput) String() string

String returns the string representation

type ListDominantLanguageDetectionJobsPaginator added in v0.9.0 

type ListDominantLanguageDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListDominantLanguageDetectionJobsPaginator added in v0.9.0 

func NewListDominantLanguageDetectionJobsPaginator(req ListDominantLanguageDetectionJobsRequest) ListDominantLanguageDetectionJobsPaginator

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

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

// Example iterating over pages.
req := client.ListDominantLanguageDetectionJobsRequest(input)
p := comprehend.NewListDominantLanguageDetectionJobsRequestPaginator(req)

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

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

func (*ListDominantLanguageDetectionJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListDominantLanguageDetectionJobsPaginator) CurrentPage() *ListDominantLanguageDetectionJobsOutput

type ListDominantLanguageDetectionJobsRequest added in v0.5.0 

type ListDominantLanguageDetectionJobsRequest struct {
	*aws.Request
	Input *ListDominantLanguageDetectionJobsInput
	Copy  func(*ListDominantLanguageDetectionJobsInput) ListDominantLanguageDetectionJobsRequest
}

ListDominantLanguageDetectionJobsRequest is the request type for the ListDominantLanguageDetectionJobs API operation.

func (ListDominantLanguageDetectionJobsRequest) Send added in v0.5.0 

func (r ListDominantLanguageDetectionJobsRequest) Send(ctx context.Context) (*ListDominantLanguageDetectionJobsResponse, error)

Send marshals and sends the ListDominantLanguageDetectionJobs API request.

type ListDominantLanguageDetectionJobsResponse added in v0.9.0 

type ListDominantLanguageDetectionJobsResponse struct {
	*ListDominantLanguageDetectionJobsOutput
	// contains filtered or unexported fields
}

ListDominantLanguageDetectionJobsResponse is the response type for the ListDominantLanguageDetectionJobs API operation.

func (*ListDominantLanguageDetectionJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListDominantLanguageDetectionJobs request.

type ListEndpointsInput added in v0.18.0 

type ListEndpointsInput struct {

	// Filters the endpoints that are returned. You can filter endpoints on their
	// name, model, status, or the date and time that they were created. You can
	// only set one filter at a time.
	Filter *EndpointFilter `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 (ListEndpointsInput) String added in v0.18.0 

func (s ListEndpointsInput) String() string

String returns the string representation

func (*ListEndpointsInput) Validate added in v0.18.0 

func (s *ListEndpointsInput) Validate() error

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

type ListEndpointsOutput added in v0.18.0 

type ListEndpointsOutput struct {

	// Displays a list of endpoint properties being retrieved by the service in
	// response to the request.
	EndpointPropertiesList []EndpointProperties `type:"list"`

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

func (ListEndpointsOutput) String added in v0.18.0 

func (s ListEndpointsOutput) String() string

String returns the string representation

type ListEndpointsRequest added in v0.18.0 

type ListEndpointsRequest struct {
	*aws.Request
	Input *ListEndpointsInput
	Copy  func(*ListEndpointsInput) ListEndpointsRequest
}

ListEndpointsRequest is the request type for the ListEndpoints API operation.

func (ListEndpointsRequest) Send added in v0.18.0 

func (r ListEndpointsRequest) Send(ctx context.Context) (*ListEndpointsResponse, error)

Send marshals and sends the ListEndpoints API request.

type ListEndpointsResponse added in v0.18.0 

type ListEndpointsResponse struct {
	*ListEndpointsOutput
	// contains filtered or unexported fields
}

ListEndpointsResponse is the response type for the ListEndpoints API operation.

func (*ListEndpointsResponse) SDKResponseMetdata added in v0.18.0 

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

SDKResponseMetdata returns the response metadata for the ListEndpoints request.

type ListEntitiesDetectionJobsInput added in v0.5.0 

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

func (s ListEntitiesDetectionJobsInput) String() string

String returns the string representation

func (*ListEntitiesDetectionJobsInput) Validate added in v0.5.0 

func (s *ListEntitiesDetectionJobsInput) Validate() error

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

type ListEntitiesDetectionJobsOutput added in v0.5.0 

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

func (s ListEntitiesDetectionJobsOutput) String() string

String returns the string representation

type ListEntitiesDetectionJobsPaginator added in v0.9.0 

type ListEntitiesDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListEntitiesDetectionJobsPaginator added in v0.9.0 

func NewListEntitiesDetectionJobsPaginator(req ListEntitiesDetectionJobsRequest) ListEntitiesDetectionJobsPaginator

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

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

// Example iterating over pages.
req := client.ListEntitiesDetectionJobsRequest(input)
p := comprehend.NewListEntitiesDetectionJobsRequestPaginator(req)

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

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

func (*ListEntitiesDetectionJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListEntitiesDetectionJobsPaginator) CurrentPage() *ListEntitiesDetectionJobsOutput

type ListEntitiesDetectionJobsRequest added in v0.5.0 

type ListEntitiesDetectionJobsRequest struct {
	*aws.Request
	Input *ListEntitiesDetectionJobsInput
	Copy  func(*ListEntitiesDetectionJobsInput) ListEntitiesDetectionJobsRequest
}

ListEntitiesDetectionJobsRequest is the request type for the ListEntitiesDetectionJobs API operation.

func (ListEntitiesDetectionJobsRequest) Send added in v0.5.0 

func (r ListEntitiesDetectionJobsRequest) Send(ctx context.Context) (*ListEntitiesDetectionJobsResponse, error)

Send marshals and sends the ListEntitiesDetectionJobs API request.

type ListEntitiesDetectionJobsResponse added in v0.9.0 

type ListEntitiesDetectionJobsResponse struct {
	*ListEntitiesDetectionJobsOutput
	// contains filtered or unexported fields
}

ListEntitiesDetectionJobsResponse is the response type for the ListEntitiesDetectionJobs API operation.

func (*ListEntitiesDetectionJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListEntitiesDetectionJobs request.

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

func (s ListEntityRecognizersInput) String() string

String returns the string representation

func (*ListEntityRecognizersInput) Validate added in v0.6.0 

func (s *ListEntityRecognizersInput) Validate() error

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

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

func (s ListEntityRecognizersOutput) String() string

String returns the string representation

type ListEntityRecognizersPaginator added in v0.9.0 

type ListEntityRecognizersPaginator struct {
	aws.Pager
}

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

func NewListEntityRecognizersPaginator added in v0.9.0 

func NewListEntityRecognizersPaginator(req ListEntityRecognizersRequest) ListEntityRecognizersPaginator

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

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

// Example iterating over pages.
req := client.ListEntityRecognizersRequest(input)
p := comprehend.NewListEntityRecognizersRequestPaginator(req)

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

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

func (*ListEntityRecognizersPaginator) CurrentPage added in v0.9.0 

func (p *ListEntityRecognizersPaginator) CurrentPage() *ListEntityRecognizersOutput

type ListEntityRecognizersRequest added in v0.6.0 

type ListEntityRecognizersRequest struct {
	*aws.Request
	Input *ListEntityRecognizersInput
	Copy  func(*ListEntityRecognizersInput) ListEntityRecognizersRequest
}

ListEntityRecognizersRequest is the request type for the ListEntityRecognizers API operation.

func (ListEntityRecognizersRequest) Send added in v0.6.0 

func (r ListEntityRecognizersRequest) Send(ctx context.Context) (*ListEntityRecognizersResponse, error)

Send marshals and sends the ListEntityRecognizers API request.

type ListEntityRecognizersResponse added in v0.9.0 

type ListEntityRecognizersResponse struct {
	*ListEntityRecognizersOutput
	// contains filtered or unexported fields
}

ListEntityRecognizersResponse is the response type for the ListEntityRecognizers API operation.

func (*ListEntityRecognizersResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListEntityRecognizers request.

type ListKeyPhrasesDetectionJobsInput added in v0.5.0 

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

func (s ListKeyPhrasesDetectionJobsInput) String() string

String returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) Validate added in v0.5.0 

func (s *ListKeyPhrasesDetectionJobsInput) Validate() error

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

type ListKeyPhrasesDetectionJobsOutput added in v0.5.0 

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

func (s ListKeyPhrasesDetectionJobsOutput) String() string

String returns the string representation

type ListKeyPhrasesDetectionJobsPaginator added in v0.9.0 

type ListKeyPhrasesDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListKeyPhrasesDetectionJobsPaginator added in v0.9.0 

func NewListKeyPhrasesDetectionJobsPaginator(req ListKeyPhrasesDetectionJobsRequest) ListKeyPhrasesDetectionJobsPaginator

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

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

// Example iterating over pages.
req := client.ListKeyPhrasesDetectionJobsRequest(input)
p := comprehend.NewListKeyPhrasesDetectionJobsRequestPaginator(req)

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

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

func (*ListKeyPhrasesDetectionJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListKeyPhrasesDetectionJobsPaginator) CurrentPage() *ListKeyPhrasesDetectionJobsOutput

type ListKeyPhrasesDetectionJobsRequest added in v0.5.0 

type ListKeyPhrasesDetectionJobsRequest struct {
	*aws.Request
	Input *ListKeyPhrasesDetectionJobsInput
	Copy  func(*ListKeyPhrasesDetectionJobsInput) ListKeyPhrasesDetectionJobsRequest
}

ListKeyPhrasesDetectionJobsRequest is the request type for the ListKeyPhrasesDetectionJobs API operation.

func (ListKeyPhrasesDetectionJobsRequest) Send added in v0.5.0 

func (r ListKeyPhrasesDetectionJobsRequest) Send(ctx context.Context) (*ListKeyPhrasesDetectionJobsResponse, error)

Send marshals and sends the ListKeyPhrasesDetectionJobs API request.

type ListKeyPhrasesDetectionJobsResponse added in v0.9.0 

type ListKeyPhrasesDetectionJobsResponse struct {
	*ListKeyPhrasesDetectionJobsOutput
	// contains filtered or unexported fields
}

ListKeyPhrasesDetectionJobsResponse is the response type for the ListKeyPhrasesDetectionJobs API operation.

func (*ListKeyPhrasesDetectionJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListKeyPhrasesDetectionJobs request.

type ListSentimentDetectionJobsInput added in v0.5.0 

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

func (s ListSentimentDetectionJobsInput) String() string

String returns the string representation

func (*ListSentimentDetectionJobsInput) Validate added in v0.5.0 

func (s *ListSentimentDetectionJobsInput) Validate() error

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

type ListSentimentDetectionJobsOutput added in v0.5.0 

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

func (s ListSentimentDetectionJobsOutput) String() string

String returns the string representation

type ListSentimentDetectionJobsPaginator added in v0.9.0 

type ListSentimentDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListSentimentDetectionJobsPaginator added in v0.9.0 

func NewListSentimentDetectionJobsPaginator(req ListSentimentDetectionJobsRequest) ListSentimentDetectionJobsPaginator

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

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

// Example iterating over pages.
req := client.ListSentimentDetectionJobsRequest(input)
p := comprehend.NewListSentimentDetectionJobsRequestPaginator(req)

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

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

func (*ListSentimentDetectionJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListSentimentDetectionJobsPaginator) CurrentPage() *ListSentimentDetectionJobsOutput

type ListSentimentDetectionJobsRequest added in v0.5.0 

type ListSentimentDetectionJobsRequest struct {
	*aws.Request
	Input *ListSentimentDetectionJobsInput
	Copy  func(*ListSentimentDetectionJobsInput) ListSentimentDetectionJobsRequest
}

ListSentimentDetectionJobsRequest is the request type for the ListSentimentDetectionJobs API operation.

func (ListSentimentDetectionJobsRequest) Send added in v0.5.0 

func (r ListSentimentDetectionJobsRequest) Send(ctx context.Context) (*ListSentimentDetectionJobsResponse, error)

Send marshals and sends the ListSentimentDetectionJobs API request.

type ListSentimentDetectionJobsResponse added in v0.9.0 

type ListSentimentDetectionJobsResponse struct {
	*ListSentimentDetectionJobsOutput
	// contains filtered or unexported fields
}

ListSentimentDetectionJobsResponse is the response type for the ListSentimentDetectionJobs API operation.

func (*ListSentimentDetectionJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListSentimentDetectionJobs request.

type ListTagsForResourceInput added in v0.8.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) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.8.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) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

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

func (s ListTopicsDetectionJobsInput) String() string

String returns the string representation

func (*ListTopicsDetectionJobsInput) Validate 

func (s *ListTopicsDetectionJobsInput) Validate() error

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

type ListTopicsDetectionJobsOutput 

type ListTopicsDetectionJobsOutput struct {

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

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

func (ListTopicsDetectionJobsOutput) String 

func (s ListTopicsDetectionJobsOutput) String() string

String returns the string representation

type ListTopicsDetectionJobsPaginator added in v0.9.0 

type ListTopicsDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListTopicsDetectionJobsPaginator added in v0.9.0 

func NewListTopicsDetectionJobsPaginator(req ListTopicsDetectionJobsRequest) ListTopicsDetectionJobsPaginator

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

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

// Example iterating over pages.
req := client.ListTopicsDetectionJobsRequest(input)
p := comprehend.NewListTopicsDetectionJobsRequestPaginator(req)

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

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

func (*ListTopicsDetectionJobsPaginator) CurrentPage added in v0.9.0 

func (p *ListTopicsDetectionJobsPaginator) CurrentPage() *ListTopicsDetectionJobsOutput

type ListTopicsDetectionJobsRequest 

type ListTopicsDetectionJobsRequest struct {
	*aws.Request
	Input *ListTopicsDetectionJobsInput
	Copy  func(*ListTopicsDetectionJobsInput) ListTopicsDetectionJobsRequest
}

ListTopicsDetectionJobsRequest is the request type for the ListTopicsDetectionJobs API operation.

func (ListTopicsDetectionJobsRequest) Send 

func (r ListTopicsDetectionJobsRequest) Send(ctx context.Context) (*ListTopicsDetectionJobsResponse, error)

Send marshals and sends the ListTopicsDetectionJobs API request.

type ListTopicsDetectionJobsResponse added in v0.9.0 

type ListTopicsDetectionJobsResponse struct {
	*ListTopicsDetectionJobsOutput
	// contains filtered or unexported fields
}

ListTopicsDetectionJobsResponse is the response type for the ListTopicsDetectionJobs API operation.

func (*ListTopicsDetectionJobsResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the ListTopicsDetectionJobs request.

type ModelStatus added in v0.6.0 

type ModelStatus string
const (
	ModelStatusSubmitted     ModelStatus = "SUBMITTED"
	ModelStatusTraining      ModelStatus = "TRAINING"
	ModelStatusDeleting      ModelStatus = "DELETING"
	ModelStatusStopRequested ModelStatus = "STOP_REQUESTED"
	ModelStatusStopped       ModelStatus = "STOPPED"
	ModelStatusInError       ModelStatus = "IN_ERROR"
	ModelStatusTrained       ModelStatus = "TRAINED"
)

Enum values for ModelStatus

func (ModelStatus) MarshalValue added in v0.6.0 

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

func (ModelStatus) MarshalValueBuf added in v0.6.0 

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

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) 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 v0.5.0 

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 PartOfSpeechTagType `type:"string" enum:"true"`
	// 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) String added in v0.5.0 

func (s PartOfSpeechTag) String() string

String returns the string representation

type PartOfSpeechTagType added in v0.5.0 

type PartOfSpeechTagType string
const (
	PartOfSpeechTagTypeAdj   PartOfSpeechTagType = "ADJ"
	PartOfSpeechTagTypeAdp   PartOfSpeechTagType = "ADP"
	PartOfSpeechTagTypeAdv   PartOfSpeechTagType = "ADV"
	PartOfSpeechTagTypeAux   PartOfSpeechTagType = "AUX"
	PartOfSpeechTagTypeConj  PartOfSpeechTagType = "CONJ"
	PartOfSpeechTagTypeCconj PartOfSpeechTagType = "CCONJ"
	PartOfSpeechTagTypeDet   PartOfSpeechTagType = "DET"
	PartOfSpeechTagTypeIntj  PartOfSpeechTagType = "INTJ"
	PartOfSpeechTagTypeNoun  PartOfSpeechTagType = "NOUN"
	PartOfSpeechTagTypeNum   PartOfSpeechTagType = "NUM"
	PartOfSpeechTagTypeO     PartOfSpeechTagType = "O"
	PartOfSpeechTagTypePart  PartOfSpeechTagType = "PART"
	PartOfSpeechTagTypePron  PartOfSpeechTagType = "PRON"
	PartOfSpeechTagTypePropn PartOfSpeechTagType = "PROPN"
	PartOfSpeechTagTypePunct PartOfSpeechTagType = "PUNCT"
	PartOfSpeechTagTypeSconj PartOfSpeechTagType = "SCONJ"
	PartOfSpeechTagTypeSym   PartOfSpeechTagType = "SYM"
	PartOfSpeechTagTypeVerb  PartOfSpeechTagType = "VERB"
)

Enum values for PartOfSpeechTagType

func (PartOfSpeechTagType) MarshalValue added in v0.5.0 

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

func (PartOfSpeechTagType) MarshalValueBuf added in v0.5.0 

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

type SentimentDetectionJobFilter added in v0.5.0 

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

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

func (s SentimentDetectionJobFilter) String() string

String returns the string representation

func (*SentimentDetectionJobFilter) Validate added in v0.5.0 

func (s *SentimentDetectionJobFilter) Validate() error

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

type SentimentDetectionJobProperties added in v0.5.0 

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

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

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

func (s SentimentDetectionJobProperties) String() string

String returns the string representation

type SentimentScore 

type SentimentScore struct {

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

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

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

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

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

func (SentimentScore) String 

func (s SentimentScore) String() string

String returns the string representation

type SentimentType 

type SentimentType string
const (
	SentimentTypePositive SentimentType = "POSITIVE"
	SentimentTypeNegative SentimentType = "NEGATIVE"
	SentimentTypeNeutral  SentimentType = "NEUTRAL"
	SentimentTypeMixed    SentimentType = "MIXED"
)

Enum values for SentimentType

func (SentimentType) MarshalValue added in v0.3.0 

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

func (SentimentType) MarshalValueBuf added in v0.3.0 

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

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

func (s StartDocumentClassificationJobInput) String() string

String returns the string representation

func (*StartDocumentClassificationJobInput) Validate added in v0.6.0 

func (s *StartDocumentClassificationJobInput) Validate() error

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

type StartDocumentClassificationJobOutput added in v0.6.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 JobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (StartDocumentClassificationJobOutput) String added in v0.6.0 

func (s StartDocumentClassificationJobOutput) String() string

String returns the string representation

type StartDocumentClassificationJobRequest added in v0.6.0 

type StartDocumentClassificationJobRequest struct {
	*aws.Request
	Input *StartDocumentClassificationJobInput
	Copy  func(*StartDocumentClassificationJobInput) StartDocumentClassificationJobRequest
}

StartDocumentClassificationJobRequest is the request type for the StartDocumentClassificationJob API operation.

func (StartDocumentClassificationJobRequest) Send added in v0.6.0 

func (r StartDocumentClassificationJobRequest) Send(ctx context.Context) (*StartDocumentClassificationJobResponse, error)

Send marshals and sends the StartDocumentClassificationJob API request.

type StartDocumentClassificationJobResponse added in v0.9.0 

type StartDocumentClassificationJobResponse struct {
	*StartDocumentClassificationJobOutput
	// contains filtered or unexported fields
}

StartDocumentClassificationJobResponse is the response type for the StartDocumentClassificationJob API operation.

func (*StartDocumentClassificationJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StartDocumentClassificationJob request.

type StartDominantLanguageDetectionJobInput added in v0.5.0 

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

func (s StartDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*StartDominantLanguageDetectionJobInput) Validate added in v0.5.0 

func (s *StartDominantLanguageDetectionJobInput) Validate() error

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

type StartDominantLanguageDetectionJobOutput added in v0.5.0 

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

func (StartDominantLanguageDetectionJobOutput) String added in v0.5.0 

func (s StartDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type StartDominantLanguageDetectionJobRequest added in v0.5.0 

type StartDominantLanguageDetectionJobRequest struct {
	*aws.Request
	Input *StartDominantLanguageDetectionJobInput
	Copy  func(*StartDominantLanguageDetectionJobInput) StartDominantLanguageDetectionJobRequest
}

StartDominantLanguageDetectionJobRequest is the request type for the StartDominantLanguageDetectionJob API operation.

func (StartDominantLanguageDetectionJobRequest) Send added in v0.5.0 

func (r StartDominantLanguageDetectionJobRequest) Send(ctx context.Context) (*StartDominantLanguageDetectionJobResponse, error)

Send marshals and sends the StartDominantLanguageDetectionJob API request.

type StartDominantLanguageDetectionJobResponse added in v0.9.0 

type StartDominantLanguageDetectionJobResponse struct {
	*StartDominantLanguageDetectionJobOutput
	// contains filtered or unexported fields
}

StartDominantLanguageDetectionJobResponse is the response type for the StartDominantLanguageDetectionJob API operation.

func (*StartDominantLanguageDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StartDominantLanguageDetectionJob request.

type StartEntitiesDetectionJobInput added in v0.5.0 

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

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

func (s StartEntitiesDetectionJobInput) String() string

String returns the string representation

func (*StartEntitiesDetectionJobInput) Validate added in v0.5.0 

func (s *StartEntitiesDetectionJobInput) Validate() error

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

type StartEntitiesDetectionJobOutput added in v0.5.0 

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

func (StartEntitiesDetectionJobOutput) String added in v0.5.0 

func (s StartEntitiesDetectionJobOutput) String() string

String returns the string representation

type StartEntitiesDetectionJobRequest added in v0.5.0 

type StartEntitiesDetectionJobRequest struct {
	*aws.Request
	Input *StartEntitiesDetectionJobInput
	Copy  func(*StartEntitiesDetectionJobInput) StartEntitiesDetectionJobRequest
}

StartEntitiesDetectionJobRequest is the request type for the StartEntitiesDetectionJob API operation.

func (StartEntitiesDetectionJobRequest) Send added in v0.5.0 

func (r StartEntitiesDetectionJobRequest) Send(ctx context.Context) (*StartEntitiesDetectionJobResponse, error)

Send marshals and sends the StartEntitiesDetectionJob API request.

type StartEntitiesDetectionJobResponse added in v0.9.0 

type StartEntitiesDetectionJobResponse struct {
	*StartEntitiesDetectionJobOutput
	// contains filtered or unexported fields
}

StartEntitiesDetectionJobResponse is the response type for the StartEntitiesDetectionJob API operation.

func (*StartEntitiesDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StartEntitiesDetectionJob request.

type StartKeyPhrasesDetectionJobInput added in v0.5.0 

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. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

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

func (s StartKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*StartKeyPhrasesDetectionJobInput) Validate added in v0.5.0 

func (s *StartKeyPhrasesDetectionJobInput) Validate() error

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

type StartKeyPhrasesDetectionJobOutput added in v0.5.0 

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

func (StartKeyPhrasesDetectionJobOutput) String added in v0.5.0 

func (s StartKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type StartKeyPhrasesDetectionJobRequest added in v0.5.0 

type StartKeyPhrasesDetectionJobRequest struct {
	*aws.Request
	Input *StartKeyPhrasesDetectionJobInput
	Copy  func(*StartKeyPhrasesDetectionJobInput) StartKeyPhrasesDetectionJobRequest
}

StartKeyPhrasesDetectionJobRequest is the request type for the StartKeyPhrasesDetectionJob API operation.

func (StartKeyPhrasesDetectionJobRequest) Send added in v0.5.0 

func (r StartKeyPhrasesDetectionJobRequest) Send(ctx context.Context) (*StartKeyPhrasesDetectionJobResponse, error)

Send marshals and sends the StartKeyPhrasesDetectionJob API request.

type StartKeyPhrasesDetectionJobResponse added in v0.9.0 

type StartKeyPhrasesDetectionJobResponse struct {
	*StartKeyPhrasesDetectionJobOutput
	// contains filtered or unexported fields
}

StartKeyPhrasesDetectionJobResponse is the response type for the StartKeyPhrasesDetectionJob API operation.

func (*StartKeyPhrasesDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StartKeyPhrasesDetectionJob request.

type StartSentimentDetectionJobInput added in v0.5.0 

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. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

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

func (s StartSentimentDetectionJobInput) String() string

String returns the string representation

func (*StartSentimentDetectionJobInput) Validate added in v0.5.0 

func (s *StartSentimentDetectionJobInput) Validate() error

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

type StartSentimentDetectionJobOutput added in v0.5.0 

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

func (StartSentimentDetectionJobOutput) String added in v0.5.0 

func (s StartSentimentDetectionJobOutput) String() string

String returns the string representation

type StartSentimentDetectionJobRequest added in v0.5.0 

type StartSentimentDetectionJobRequest struct {
	*aws.Request
	Input *StartSentimentDetectionJobInput
	Copy  func(*StartSentimentDetectionJobInput) StartSentimentDetectionJobRequest
}

StartSentimentDetectionJobRequest is the request type for the StartSentimentDetectionJob API operation.

func (StartSentimentDetectionJobRequest) Send added in v0.5.0 

func (r StartSentimentDetectionJobRequest) Send(ctx context.Context) (*StartSentimentDetectionJobResponse, error)

Send marshals and sends the StartSentimentDetectionJob API request.

type StartSentimentDetectionJobResponse added in v0.9.0 

type StartSentimentDetectionJobResponse struct {
	*StartSentimentDetectionJobOutput
	// contains filtered or unexported fields
}

StartSentimentDetectionJobResponse is the response type for the StartSentimentDetectionJob API operation.

func (*StartSentimentDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StartSentimentDetectionJob request.

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

func (s StartTopicsDetectionJobInput) String() string

String returns the string representation

func (*StartTopicsDetectionJobInput) Validate 

func (s *StartTopicsDetectionJobInput) Validate() error

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

type StartTopicsDetectionJobOutput 

type StartTopicsDetectionJobOutput struct {

	// The identifier generated for the job. To get the status of the job, use this
	// identifier with the DescribeTopicDetectionJob operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job:
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob
	//    operation.
	JobStatus JobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (StartTopicsDetectionJobOutput) String 

func (s StartTopicsDetectionJobOutput) String() string

String returns the string representation

type StartTopicsDetectionJobRequest 

type StartTopicsDetectionJobRequest struct {
	*aws.Request
	Input *StartTopicsDetectionJobInput
	Copy  func(*StartTopicsDetectionJobInput) StartTopicsDetectionJobRequest
}

StartTopicsDetectionJobRequest is the request type for the StartTopicsDetectionJob API operation.

func (StartTopicsDetectionJobRequest) Send 

func (r StartTopicsDetectionJobRequest) Send(ctx context.Context) (*StartTopicsDetectionJobResponse, error)

Send marshals and sends the StartTopicsDetectionJob API request.

type StartTopicsDetectionJobResponse added in v0.9.0 

type StartTopicsDetectionJobResponse struct {
	*StartTopicsDetectionJobOutput
	// contains filtered or unexported fields
}

StartTopicsDetectionJobResponse is the response type for the StartTopicsDetectionJob API operation.

func (*StartTopicsDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StartTopicsDetectionJob request.

type StopDominantLanguageDetectionJobInput added in v0.5.0 

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

func (s StopDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*StopDominantLanguageDetectionJobInput) Validate added in v0.5.0 

func (s *StopDominantLanguageDetectionJobInput) Validate() error

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

type StopDominantLanguageDetectionJobOutput added in v0.5.0 

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

func (StopDominantLanguageDetectionJobOutput) String added in v0.5.0 

func (s StopDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type StopDominantLanguageDetectionJobRequest added in v0.5.0 

type StopDominantLanguageDetectionJobRequest struct {
	*aws.Request
	Input *StopDominantLanguageDetectionJobInput
	Copy  func(*StopDominantLanguageDetectionJobInput) StopDominantLanguageDetectionJobRequest
}

StopDominantLanguageDetectionJobRequest is the request type for the StopDominantLanguageDetectionJob API operation.

func (StopDominantLanguageDetectionJobRequest) Send added in v0.5.0 

func (r StopDominantLanguageDetectionJobRequest) Send(ctx context.Context) (*StopDominantLanguageDetectionJobResponse, error)

Send marshals and sends the StopDominantLanguageDetectionJob API request.

type StopDominantLanguageDetectionJobResponse added in v0.9.0 

type StopDominantLanguageDetectionJobResponse struct {
	*StopDominantLanguageDetectionJobOutput
	// contains filtered or unexported fields
}

StopDominantLanguageDetectionJobResponse is the response type for the StopDominantLanguageDetectionJob API operation.

func (*StopDominantLanguageDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StopDominantLanguageDetectionJob request.

type StopEntitiesDetectionJobInput added in v0.5.0 

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

func (s StopEntitiesDetectionJobInput) String() string

String returns the string representation

func (*StopEntitiesDetectionJobInput) Validate added in v0.5.0 

func (s *StopEntitiesDetectionJobInput) Validate() error

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

type StopEntitiesDetectionJobOutput added in v0.5.0 

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

func (StopEntitiesDetectionJobOutput) String added in v0.5.0 

func (s StopEntitiesDetectionJobOutput) String() string

String returns the string representation

type StopEntitiesDetectionJobRequest added in v0.5.0 

type StopEntitiesDetectionJobRequest struct {
	*aws.Request
	Input *StopEntitiesDetectionJobInput
	Copy  func(*StopEntitiesDetectionJobInput) StopEntitiesDetectionJobRequest
}

StopEntitiesDetectionJobRequest is the request type for the StopEntitiesDetectionJob API operation.

func (StopEntitiesDetectionJobRequest) Send added in v0.5.0 

func (r StopEntitiesDetectionJobRequest) Send(ctx context.Context) (*StopEntitiesDetectionJobResponse, error)

Send marshals and sends the StopEntitiesDetectionJob API request.

type StopEntitiesDetectionJobResponse added in v0.9.0 

type StopEntitiesDetectionJobResponse struct {
	*StopEntitiesDetectionJobOutput
	// contains filtered or unexported fields
}

StopEntitiesDetectionJobResponse is the response type for the StopEntitiesDetectionJob API operation.

func (*StopEntitiesDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StopEntitiesDetectionJob request.

type StopKeyPhrasesDetectionJobInput added in v0.5.0 

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

func (s StopKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*StopKeyPhrasesDetectionJobInput) Validate added in v0.5.0 

func (s *StopKeyPhrasesDetectionJobInput) Validate() error

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

type StopKeyPhrasesDetectionJobOutput added in v0.5.0 

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

func (StopKeyPhrasesDetectionJobOutput) String added in v0.5.0 

func (s StopKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type StopKeyPhrasesDetectionJobRequest added in v0.5.0 

type StopKeyPhrasesDetectionJobRequest struct {
	*aws.Request
	Input *StopKeyPhrasesDetectionJobInput
	Copy  func(*StopKeyPhrasesDetectionJobInput) StopKeyPhrasesDetectionJobRequest
}

StopKeyPhrasesDetectionJobRequest is the request type for the StopKeyPhrasesDetectionJob API operation.

func (StopKeyPhrasesDetectionJobRequest) Send added in v0.5.0 

func (r StopKeyPhrasesDetectionJobRequest) Send(ctx context.Context) (*StopKeyPhrasesDetectionJobResponse, error)

Send marshals and sends the StopKeyPhrasesDetectionJob API request.

type StopKeyPhrasesDetectionJobResponse added in v0.9.0 

type StopKeyPhrasesDetectionJobResponse struct {
	*StopKeyPhrasesDetectionJobOutput
	// contains filtered or unexported fields
}

StopKeyPhrasesDetectionJobResponse is the response type for the StopKeyPhrasesDetectionJob API operation.

func (*StopKeyPhrasesDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StopKeyPhrasesDetectionJob request.

type StopSentimentDetectionJobInput added in v0.5.0 

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

func (s StopSentimentDetectionJobInput) String() string

String returns the string representation

func (*StopSentimentDetectionJobInput) Validate added in v0.5.0 

func (s *StopSentimentDetectionJobInput) Validate() error

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

type StopSentimentDetectionJobOutput added in v0.5.0 

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

func (StopSentimentDetectionJobOutput) String added in v0.5.0 

func (s StopSentimentDetectionJobOutput) String() string

String returns the string representation

type StopSentimentDetectionJobRequest added in v0.5.0 

type StopSentimentDetectionJobRequest struct {
	*aws.Request
	Input *StopSentimentDetectionJobInput
	Copy  func(*StopSentimentDetectionJobInput) StopSentimentDetectionJobRequest
}

StopSentimentDetectionJobRequest is the request type for the StopSentimentDetectionJob API operation.

func (StopSentimentDetectionJobRequest) Send added in v0.5.0 

func (r StopSentimentDetectionJobRequest) Send(ctx context.Context) (*StopSentimentDetectionJobResponse, error)

Send marshals and sends the StopSentimentDetectionJob API request.

type StopSentimentDetectionJobResponse added in v0.9.0 

type StopSentimentDetectionJobResponse struct {
	*StopSentimentDetectionJobOutput
	// contains filtered or unexported fields
}

StopSentimentDetectionJobResponse is the response type for the StopSentimentDetectionJob API operation.

func (*StopSentimentDetectionJobResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StopSentimentDetectionJob request.

type StopTrainingDocumentClassifierInput added in v0.7.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) String added in v0.7.0 

func (s StopTrainingDocumentClassifierInput) String() string

String returns the string representation

func (*StopTrainingDocumentClassifierInput) Validate added in v0.7.0 

func (s *StopTrainingDocumentClassifierInput) Validate() error

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

type StopTrainingDocumentClassifierOutput added in v0.7.0 

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

func (StopTrainingDocumentClassifierOutput) String added in v0.7.0 

func (s StopTrainingDocumentClassifierOutput) String() string

String returns the string representation

type StopTrainingDocumentClassifierRequest added in v0.7.0 

type StopTrainingDocumentClassifierRequest struct {
	*aws.Request
	Input *StopTrainingDocumentClassifierInput
	Copy  func(*StopTrainingDocumentClassifierInput) StopTrainingDocumentClassifierRequest
}

StopTrainingDocumentClassifierRequest is the request type for the StopTrainingDocumentClassifier API operation.

func (StopTrainingDocumentClassifierRequest) Send added in v0.7.0 

func (r StopTrainingDocumentClassifierRequest) Send(ctx context.Context) (*StopTrainingDocumentClassifierResponse, error)

Send marshals and sends the StopTrainingDocumentClassifier API request.

type StopTrainingDocumentClassifierResponse added in v0.9.0 

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

StopTrainingDocumentClassifierResponse is the response type for the StopTrainingDocumentClassifier API operation.

func (*StopTrainingDocumentClassifierResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StopTrainingDocumentClassifier request.

type StopTrainingEntityRecognizerInput added in v0.7.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) String added in v0.7.0 

func (s StopTrainingEntityRecognizerInput) String() string

String returns the string representation

func (*StopTrainingEntityRecognizerInput) Validate added in v0.7.0 

func (s *StopTrainingEntityRecognizerInput) Validate() error

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

type StopTrainingEntityRecognizerOutput added in v0.7.0 

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

func (StopTrainingEntityRecognizerOutput) String added in v0.7.0 

func (s StopTrainingEntityRecognizerOutput) String() string

String returns the string representation

type StopTrainingEntityRecognizerRequest added in v0.7.0 

type StopTrainingEntityRecognizerRequest struct {
	*aws.Request
	Input *StopTrainingEntityRecognizerInput
	Copy  func(*StopTrainingEntityRecognizerInput) StopTrainingEntityRecognizerRequest
}

StopTrainingEntityRecognizerRequest is the request type for the StopTrainingEntityRecognizer API operation.

func (StopTrainingEntityRecognizerRequest) Send added in v0.7.0 

func (r StopTrainingEntityRecognizerRequest) Send(ctx context.Context) (*StopTrainingEntityRecognizerResponse, error)

Send marshals and sends the StopTrainingEntityRecognizer API request.

type StopTrainingEntityRecognizerResponse added in v0.9.0 

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

StopTrainingEntityRecognizerResponse is the response type for the StopTrainingEntityRecognizer API operation.

func (*StopTrainingEntityRecognizerResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the StopTrainingEntityRecognizer request.

type SyntaxLanguageCode added in v0.5.0 

type SyntaxLanguageCode string
const (
	SyntaxLanguageCodeEn SyntaxLanguageCode = "en"
	SyntaxLanguageCodeEs SyntaxLanguageCode = "es"
	SyntaxLanguageCodeFr SyntaxLanguageCode = "fr"
	SyntaxLanguageCodeDe SyntaxLanguageCode = "de"
	SyntaxLanguageCodeIt SyntaxLanguageCode = "it"
	SyntaxLanguageCodePt SyntaxLanguageCode = "pt"
)

Enum values for SyntaxLanguageCode

func (SyntaxLanguageCode) MarshalValue added in v0.5.0 

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

func (SyntaxLanguageCode) MarshalValueBuf added in v0.5.0 

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

type SyntaxToken added in v0.5.0 

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

func (s SyntaxToken) String() string

String returns the string representation

type Tag added in v0.8.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) String added in v0.8.0 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v0.8.0 

func (s *Tag) Validate() error

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

type TagResourceInput added in v0.8.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) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.8.0 

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

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the TagResource request.

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

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

	// 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) String 

func (s TopicsDetectionJobProperties) String() string

String returns the string representation

type UntagResourceInput added in v0.8.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) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.8.0 

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

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

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

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateEndpointInput added in v0.18.0 

type UpdateEndpointInput struct {

	// The desired number of inference units to be used by the model using this
	// endpoint. Each inference unit represents of a throughput of 100 characters
	// per second.
	//
	// DesiredInferenceUnits is a required field
	DesiredInferenceUnits *int64 `min:"1" type:"integer" required:"true"`

	// The Amazon Resource Number (ARN) of the endpoint being updated.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateEndpointInput) String added in v0.18.0 

func (s UpdateEndpointInput) String() string

String returns the string representation

func (*UpdateEndpointInput) Validate added in v0.18.0 

func (s *UpdateEndpointInput) Validate() error

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

type UpdateEndpointOutput added in v0.18.0 

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

func (UpdateEndpointOutput) String added in v0.18.0 

func (s UpdateEndpointOutput) String() string

String returns the string representation

type UpdateEndpointRequest added in v0.18.0 

type UpdateEndpointRequest struct {
	*aws.Request
	Input *UpdateEndpointInput
	Copy  func(*UpdateEndpointInput) UpdateEndpointRequest
}

UpdateEndpointRequest is the request type for the UpdateEndpoint API operation.

func (UpdateEndpointRequest) Send added in v0.18.0 

func (r UpdateEndpointRequest) Send(ctx context.Context) (*UpdateEndpointResponse, error)

Send marshals and sends the UpdateEndpoint API request.

type UpdateEndpointResponse added in v0.18.0 

type UpdateEndpointResponse struct {
	*UpdateEndpointOutput
	// contains filtered or unexported fields
}

UpdateEndpointResponse is the response type for the UpdateEndpoint API operation.

func (*UpdateEndpointResponse) SDKResponseMetdata added in v0.18.0 

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

SDKResponseMetdata returns the response metadata for the UpdateEndpoint request.

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

func (s VpcConfig) String() string

String returns the string representation

func (*VpcConfig) Validate added in v0.9.0 

func (s *VpcConfig) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.
 Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.