package comprehend

import "github.com/aws/aws-sdk-go-v2/service/comprehend"

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

const (
	ServiceName = "Amazon Comprehend" // Service's name
	ServiceID   = "Comprehend"        // Service's identifier
	EndpointsID = "comprehend"        // Service's Endpoint identifier
)
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 ListDocumentClassificationJobs 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, Amazon Comprehend accepts only English or
	// Spanish text.
	ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException"
)

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
}

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

func (BatchDetectDominantLanguageInput) String

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate

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

type BatchDetectDominantLanguageItemResult

type BatchDetectDominantLanguageItemResult struct {

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

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

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguageItemResult

func (BatchDetectDominantLanguageItemResult) String

String returns the string representation

type BatchDetectDominantLanguageOutput

type BatchDetectDominantLanguageOutput struct {

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

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

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

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

Send marshals and sends the BatchDetectDominantLanguage API request.

type BatchDetectDominantLanguageResponse

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

BatchDetectDominantLanguageResponse is the response type for the BatchDetectDominantLanguage API operation.

func (*BatchDetectDominantLanguageResponse) SDKResponseMetdata

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 English ("en") or Spanish
	// ("es"). 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
}

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntitiesItemResult

func (BatchDetectEntitiesItemResult) String

String returns the string representation

type BatchDetectEntitiesOutput

type BatchDetectEntitiesOutput struct {

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

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

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

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

Send marshals and sends the BatchDetectEntities API request.

type BatchDetectEntitiesResponse

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

BatchDetectEntitiesResponse is the response type for the BatchDetectEntities API operation.

func (*BatchDetectEntitiesResponse) SDKResponseMetdata

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 English ("en") or Spanish
	// ("es"). 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
}

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

func (BatchDetectKeyPhrasesInput) String

String returns the string representation

func (*BatchDetectKeyPhrasesInput) Validate

func (s *BatchDetectKeyPhrasesInput) Validate() error

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

type BatchDetectKeyPhrasesItemResult

type BatchDetectKeyPhrasesItemResult struct {

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

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

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrasesItemResult

func (BatchDetectKeyPhrasesItemResult) String

String returns the string representation

type BatchDetectKeyPhrasesOutput

type BatchDetectKeyPhrasesOutput struct {

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

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

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

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

Send marshals and sends the BatchDetectKeyPhrases API request.

type BatchDetectKeyPhrasesResponse

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

BatchDetectKeyPhrasesResponse is the response type for the BatchDetectKeyPhrases API operation.

func (*BatchDetectKeyPhrasesResponse) SDKResponseMetdata

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 English ("en") or Spanish
	// ("es"). 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
}

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentimentItemResult

func (BatchDetectSentimentItemResult) String

String returns the string representation

type BatchDetectSentimentOutput

type BatchDetectSentimentOutput struct {

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

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

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

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

Send marshals and sends the BatchDetectSentiment API request.

type BatchDetectSentimentResponse

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

BatchDetectSentimentResponse is the response type for the BatchDetectSentiment API operation.

func (*BatchDetectSentimentResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the BatchDetectSentiment request.

type BatchDetectSyntaxInput

type BatchDetectSyntaxInput struct {

	// The language of the input documents. You can specify English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode 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
}

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

func (BatchDetectSyntaxInput) String

func (s BatchDetectSyntaxInput) String() string

String returns the string representation

func (*BatchDetectSyntaxInput) Validate

func (s *BatchDetectSyntaxInput) Validate() error

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

type BatchDetectSyntaxItemResult

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntaxItemResult

func (BatchDetectSyntaxItemResult) String

String returns the string representation

type BatchDetectSyntaxOutput

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
}

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

func (BatchDetectSyntaxOutput) String

func (s BatchDetectSyntaxOutput) String() string

String returns the string representation

type BatchDetectSyntaxRequest

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

BatchDetectSyntaxRequest is the request type for the BatchDetectSyntax API operation.

func (BatchDetectSyntaxRequest) Send

Send marshals and sends the BatchDetectSyntax API request.

type BatchDetectSyntaxResponse

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

BatchDetectSyntaxResponse is the response type for the BatchDetectSyntax API operation.

func (*BatchDetectSyntaxResponse) SDKResponseMetdata

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchItemError

func (BatchItemError) String

func (s BatchItemError) String() string

String returns the string representation

type ClassifierEvaluationMetrics

type ClassifierEvaluationMetrics struct {

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

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

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

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

Describes the result metrics for the test data associated with an documentation classifier. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifierEvaluationMetrics

func (ClassifierEvaluationMetrics) String

String returns the string representation

type ClassifierMetadata

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifierMetadata

func (ClassifierMetadata) String

func (s ClassifierMetadata) String() string

String returns the string representation

type Client

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type CreateDocumentClassifierInput

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 English ("en") or Spanish
	// ("es"). All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" 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
}

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

func (CreateDocumentClassifierInput) String

String returns the string representation

func (*CreateDocumentClassifierInput) Validate

func (s *CreateDocumentClassifierInput) Validate() error

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

type CreateDocumentClassifierOutput

type CreateDocumentClassifierOutput struct {

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

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

func (CreateDocumentClassifierOutput) String

String returns the string representation

type CreateDocumentClassifierRequest

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

CreateDocumentClassifierRequest is the request type for the CreateDocumentClassifier API operation.

func (CreateDocumentClassifierRequest) Send

Send marshals and sends the CreateDocumentClassifier API request.

type CreateDocumentClassifierResponse

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

CreateDocumentClassifierResponse is the response type for the CreateDocumentClassifier API operation.

func (*CreateDocumentClassifierResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the CreateDocumentClassifier request.

type CreateEntityRecognizerInput

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
}

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

func (CreateEntityRecognizerInput) String

String returns the string representation

func (*CreateEntityRecognizerInput) Validate

func (s *CreateEntityRecognizerInput) Validate() error

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

type CreateEntityRecognizerOutput

type CreateEntityRecognizerOutput struct {

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

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

func (CreateEntityRecognizerOutput) String

String returns the string representation

type CreateEntityRecognizerRequest

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

CreateEntityRecognizerRequest is the request type for the CreateEntityRecognizer API operation.

func (CreateEntityRecognizerRequest) Send

Send marshals and sends the CreateEntityRecognizer API request.

type CreateEntityRecognizerResponse

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

CreateEntityRecognizerResponse is the response type for the CreateEntityRecognizer API operation.

func (*CreateEntityRecognizerResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the CreateEntityRecognizer request.

type DeleteDocumentClassifierInput

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
}

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

func (DeleteDocumentClassifierInput) String

String returns the string representation

func (*DeleteDocumentClassifierInput) Validate

func (s *DeleteDocumentClassifierInput) Validate() error

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

type DeleteDocumentClassifierOutput

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

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

func (DeleteDocumentClassifierOutput) String

String returns the string representation

type DeleteDocumentClassifierRequest

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

DeleteDocumentClassifierRequest is the request type for the DeleteDocumentClassifier API operation.

func (DeleteDocumentClassifierRequest) Send

Send marshals and sends the DeleteDocumentClassifier API request.

type DeleteDocumentClassifierResponse

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

DeleteDocumentClassifierResponse is the response type for the DeleteDocumentClassifier API operation.

func (*DeleteDocumentClassifierResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DeleteDocumentClassifier request.

type DeleteEntityRecognizerInput

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
}

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

func (DeleteEntityRecognizerInput) String

String returns the string representation

func (*DeleteEntityRecognizerInput) Validate

func (s *DeleteEntityRecognizerInput) Validate() error

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

type DeleteEntityRecognizerOutput

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

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

func (DeleteEntityRecognizerOutput) String

String returns the string representation

type DeleteEntityRecognizerRequest

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

DeleteEntityRecognizerRequest is the request type for the DeleteEntityRecognizer API operation.

func (DeleteEntityRecognizerRequest) Send

Send marshals and sends the DeleteEntityRecognizer API request.

type DeleteEntityRecognizerResponse

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

DeleteEntityRecognizerResponse is the response type for the DeleteEntityRecognizer API operation.

func (*DeleteEntityRecognizerResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DeleteEntityRecognizer request.

type DescribeDocumentClassificationJobInput

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
}

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

func (DescribeDocumentClassificationJobInput) String

String returns the string representation

func (*DescribeDocumentClassificationJobInput) Validate

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

type DescribeDocumentClassificationJobOutput

type DescribeDocumentClassificationJobOutput struct {

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

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

func (DescribeDocumentClassificationJobOutput) String

String returns the string representation

type DescribeDocumentClassificationJobRequest

DescribeDocumentClassificationJobRequest is the request type for the DescribeDocumentClassificationJob API operation.

func (DescribeDocumentClassificationJobRequest) Send

Send marshals and sends the DescribeDocumentClassificationJob API request.

type DescribeDocumentClassificationJobResponse

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

DescribeDocumentClassificationJobResponse is the response type for the DescribeDocumentClassificationJob API operation.

func (*DescribeDocumentClassificationJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DescribeDocumentClassificationJob request.

type DescribeDocumentClassifierInput

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
}

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

func (DescribeDocumentClassifierInput) String

String returns the string representation

func (*DescribeDocumentClassifierInput) Validate

func (s *DescribeDocumentClassifierInput) Validate() error

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

type DescribeDocumentClassifierOutput

type DescribeDocumentClassifierOutput struct {

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

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

func (DescribeDocumentClassifierOutput) String

String returns the string representation

type DescribeDocumentClassifierRequest

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

DescribeDocumentClassifierRequest is the request type for the DescribeDocumentClassifier API operation.

func (DescribeDocumentClassifierRequest) Send

Send marshals and sends the DescribeDocumentClassifier API request.

type DescribeDocumentClassifierResponse

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

DescribeDocumentClassifierResponse is the response type for the DescribeDocumentClassifier API operation.

func (*DescribeDocumentClassifierResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DescribeDocumentClassifier request.

type DescribeDominantLanguageDetectionJobInput

type DescribeDominantLanguageDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeDominantLanguageDetectionJobInput) String

String returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) Validate

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

type DescribeDominantLanguageDetectionJobOutput

type DescribeDominantLanguageDetectionJobOutput struct {

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

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

func (DescribeDominantLanguageDetectionJobOutput) String

String returns the string representation

type DescribeDominantLanguageDetectionJobRequest

DescribeDominantLanguageDetectionJobRequest is the request type for the DescribeDominantLanguageDetectionJob API operation.

func (DescribeDominantLanguageDetectionJobRequest) Send

Send marshals and sends the DescribeDominantLanguageDetectionJob API request.

type DescribeDominantLanguageDetectionJobResponse

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

DescribeDominantLanguageDetectionJobResponse is the response type for the DescribeDominantLanguageDetectionJob API operation.

func (*DescribeDominantLanguageDetectionJobResponse) SDKResponseMetdata

SDKResponseMetdata returns the response metadata for the DescribeDominantLanguageDetectionJob request.

type DescribeEntitiesDetectionJobInput

type DescribeEntitiesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeEntitiesDetectionJobInput) String

String returns the string representation

func (*DescribeEntitiesDetectionJobInput) Validate

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

type DescribeEntitiesDetectionJobOutput

type DescribeEntitiesDetectionJobOutput struct {

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

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

func (DescribeEntitiesDetectionJobOutput) String

String returns the string representation

type DescribeEntitiesDetectionJobRequest

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

DescribeEntitiesDetectionJobRequest is the request type for the DescribeEntitiesDetectionJob API operation.

func (DescribeEntitiesDetectionJobRequest) Send

Send marshals and sends the DescribeEntitiesDetectionJob API request.

type DescribeEntitiesDetectionJobResponse

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

DescribeEntitiesDetectionJobResponse is the response type for the DescribeEntitiesDetectionJob API operation.

func (*DescribeEntitiesDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DescribeEntitiesDetectionJob request.

type DescribeEntityRecognizerInput

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
}

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

func (DescribeEntityRecognizerInput) String

String returns the string representation

func (*DescribeEntityRecognizerInput) Validate

func (s *DescribeEntityRecognizerInput) Validate() error

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

type DescribeEntityRecognizerOutput

type DescribeEntityRecognizerOutput struct {

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

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

func (DescribeEntityRecognizerOutput) String

String returns the string representation

type DescribeEntityRecognizerRequest

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

DescribeEntityRecognizerRequest is the request type for the DescribeEntityRecognizer API operation.

func (DescribeEntityRecognizerRequest) Send

Send marshals and sends the DescribeEntityRecognizer API request.

type DescribeEntityRecognizerResponse

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

DescribeEntityRecognizerResponse is the response type for the DescribeEntityRecognizer API operation.

func (*DescribeEntityRecognizerResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DescribeEntityRecognizer request.

type DescribeKeyPhrasesDetectionJobInput

type DescribeKeyPhrasesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeKeyPhrasesDetectionJobInput) String

String returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) Validate

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

type DescribeKeyPhrasesDetectionJobOutput

type DescribeKeyPhrasesDetectionJobOutput struct {

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

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

func (DescribeKeyPhrasesDetectionJobOutput) String

String returns the string representation

type DescribeKeyPhrasesDetectionJobRequest

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

DescribeKeyPhrasesDetectionJobRequest is the request type for the DescribeKeyPhrasesDetectionJob API operation.

func (DescribeKeyPhrasesDetectionJobRequest) Send

Send marshals and sends the DescribeKeyPhrasesDetectionJob API request.

type DescribeKeyPhrasesDetectionJobResponse

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

DescribeKeyPhrasesDetectionJobResponse is the response type for the DescribeKeyPhrasesDetectionJob API operation.

func (*DescribeKeyPhrasesDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DescribeKeyPhrasesDetectionJob request.

type DescribeSentimentDetectionJobInput

type DescribeSentimentDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DescribeSentimentDetectionJobInput) String

String returns the string representation

func (*DescribeSentimentDetectionJobInput) Validate

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

type DescribeSentimentDetectionJobOutput

type DescribeSentimentDetectionJobOutput struct {

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

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

func (DescribeSentimentDetectionJobOutput) String

String returns the string representation

type DescribeSentimentDetectionJobRequest

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

DescribeSentimentDetectionJobRequest is the request type for the DescribeSentimentDetectionJob API operation.

func (DescribeSentimentDetectionJobRequest) Send

Send marshals and sends the DescribeSentimentDetectionJob API request.

type DescribeSentimentDetectionJobResponse

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

DescribeSentimentDetectionJobResponse is the response type for the DescribeSentimentDetectionJob API operation.

func (*DescribeSentimentDetectionJobResponse) SDKResponseMetdata

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
}

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

func (DescribeTopicsDetectionJobInput) String

String returns the string representation

func (*DescribeTopicsDetectionJobInput) Validate

func (s *DescribeTopicsDetectionJobInput) Validate() error

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

type DescribeTopicsDetectionJobOutput

type DescribeTopicsDetectionJobOutput struct {

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

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

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

Send marshals and sends the DescribeTopicsDetectionJob API request.

type DescribeTopicsDetectionJobResponse

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

DescribeTopicsDetectionJobResponse is the response type for the DescribeTopicsDetectionJob API operation.

func (*DescribeTopicsDetectionJobResponse) SDKResponseMetdata

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
}

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

func (DetectDominantLanguageInput) String

String returns the string representation

func (*DetectDominantLanguageInput) Validate

func (s *DetectDominantLanguageInput) Validate() error

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

type DetectDominantLanguageOutput

type DetectDominantLanguageOutput struct {

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

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

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

Send marshals and sends the DetectDominantLanguage API request.

type DetectDominantLanguageResponse

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

DetectDominantLanguageResponse is the response type for the DetectDominantLanguage API operation.

func (*DetectDominantLanguageResponse) SDKResponseMetdata

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 English ("en") or Spanish
	// ("es"). 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
}

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

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
}

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

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

Send marshals and sends the DetectEntities API request.

type DetectEntitiesResponse

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

DetectEntitiesResponse is the response type for the DetectEntities API operation.

func (*DetectEntitiesResponse) SDKResponseMetdata

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 English ("en") or Spanish
	// ("es"). 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
}

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

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
}

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

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

Send marshals and sends the DetectKeyPhrases API request.

type DetectKeyPhrasesResponse

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

DetectKeyPhrasesResponse is the response type for the DetectKeyPhrases API operation.

func (*DetectKeyPhrasesResponse) SDKResponseMetdata

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 English ("en") or Spanish
	// ("es"). 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
}

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

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
}

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

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

Send marshals and sends the DetectSentiment API request.

type DetectSentimentResponse

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

DetectSentimentResponse is the response type for the DetectSentiment API operation.

func (*DetectSentimentResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DetectSentiment request.

type DetectSyntaxInput

type DetectSyntaxInput struct {

	// The language code of the input documents. You can specify English ("en")
	// or Spanish ("es").
	//
	// 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
}

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

func (DetectSyntaxInput) String

func (s DetectSyntaxInput) String() string

String returns the string representation

func (*DetectSyntaxInput) Validate

func (s *DetectSyntaxInput) Validate() error

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

type DetectSyntaxOutput

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
}

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

func (DetectSyntaxOutput) String

func (s DetectSyntaxOutput) String() string

String returns the string representation

type DetectSyntaxRequest

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

DetectSyntaxRequest is the request type for the DetectSyntax API operation.

func (DetectSyntaxRequest) Send

Send marshals and sends the DetectSyntax API request.

type DetectSyntaxResponse

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

DetectSyntaxResponse is the response type for the DetectSyntax API operation.

func (*DetectSyntaxResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the DetectSyntax request.

type DocumentClassificationJobFilter

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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`
	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobFilter

func (DocumentClassificationJobFilter) String

String returns the string representation

func (*DocumentClassificationJobFilter) Validate

func (s *DocumentClassificationJobFilter) Validate() error

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

type DocumentClassificationJobProperties

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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties

func (DocumentClassificationJobProperties) String

String returns the string representation

type DocumentClassifierFilter

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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`
	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierFilter

func (DocumentClassifierFilter) String

func (s DocumentClassifierFilter) String() string

String returns the string representation

type DocumentClassifierInputDataConfig

type DocumentClassifierInputDataConfig struct {

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

The input properties for training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig

func (DocumentClassifierInputDataConfig) String

String returns the string representation

func (*DocumentClassifierInputDataConfig) Validate

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

type DocumentClassifierOutputDataConfig

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierOutputDataConfig

func (DocumentClassifierOutputDataConfig) String

String returns the string representation

type DocumentClassifierProperties

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" timestampFormat:"unix"`

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

	// 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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties

func (DocumentClassifierProperties) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DominantLanguage

func (DominantLanguage) String

func (s DominantLanguage) String() string

String returns the string representation

type DominantLanguageDetectionJobFilter

type DominantLanguageDetectionJobFilter struct {

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

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus 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" timestampFormat:"unix"`

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DominantLanguageDetectionJobFilter

func (DominantLanguageDetectionJobFilter) String

String returns the string representation

func (*DominantLanguageDetectionJobFilter) Validate

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

type DominantLanguageDetectionJobProperties

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" timestampFormat:"unix"`

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

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

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

	// The current status of the dominant language detection job. If the status
	// is FAILED, the Message field shows the reason for the failure.
	JobStatus 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DominantLanguageDetectionJobProperties

func (DominantLanguageDetectionJobProperties) String

String returns the string representation

type EntitiesDetectionJobFilter

type EntitiesDetectionJobFilter struct {

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

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus 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" timestampFormat:"unix"`

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobFilter

func (EntitiesDetectionJobFilter) String

String returns the string representation

func (*EntitiesDetectionJobFilter) Validate

func (s *EntitiesDetectionJobFilter) Validate() error

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

type EntitiesDetectionJobProperties

type EntitiesDetectionJobProperties struct {

	// The 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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobProperties

func (EntitiesDetectionJobProperties) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Entity

func (Entity) String

func (s Entity) String() string

String returns the string representation

type EntityRecognizerAnnotations

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerAnnotations

func (EntityRecognizerAnnotations) String

String returns the string representation

func (*EntityRecognizerAnnotations) Validate

func (s *EntityRecognizerAnnotations) Validate() error

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

type EntityRecognizerDocuments

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerDocuments

func (EntityRecognizerDocuments) String

func (s EntityRecognizerDocuments) String() string

String returns the string representation

func (*EntityRecognizerDocuments) Validate

func (s *EntityRecognizerDocuments) Validate() error

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

type EntityRecognizerEntityList

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerEntityList

func (EntityRecognizerEntityList) String

String returns the string representation

func (*EntityRecognizerEntityList) Validate

func (s *EntityRecognizerEntityList) Validate() error

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

type EntityRecognizerEvaluationMetrics

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerEvaluationMetrics

func (EntityRecognizerEvaluationMetrics) String

String returns the string representation

type EntityRecognizerFilter

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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`
	// 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./> Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerFilter

func (EntityRecognizerFilter) String

func (s EntityRecognizerFilter) String() string

String returns the string representation

type EntityRecognizerInputDataConfig

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.
	//
	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerInputDataConfig

func (EntityRecognizerInputDataConfig) String

String returns the string representation

func (*EntityRecognizerInputDataConfig) Validate

func (s *EntityRecognizerInputDataConfig) Validate() error

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

type EntityRecognizerMetadata

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerMetadata

func (EntityRecognizerMetadata) String

func (s EntityRecognizerMetadata) String() string

String returns the string representation

type EntityRecognizerMetadataEntityTypesListItem

type EntityRecognizerMetadataEntityTypesListItem struct {

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerMetadataEntityTypesListItem

func (EntityRecognizerMetadataEntityTypesListItem) String

String returns the string representation

type EntityRecognizerProperties

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" timestampFormat:"unix"`

	// 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" timestampFormat:"unix"`

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

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties

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

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

func (EntityType) MarshalValueBuf

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

type EntityTypesListItem

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesListItem

func (EntityTypesListItem) String

func (s EntityTypesListItem) String() string

String returns the string representation

func (*EntityTypesListItem) Validate

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InputDataConfig

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

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

func (InputFormat) MarshalValueBuf

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

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

func (JobStatus) MarshalValueBuf

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrase

func (KeyPhrase) String

func (s KeyPhrase) String() string

String returns the string representation

type KeyPhrasesDetectionJobFilter

type KeyPhrasesDetectionJobFilter struct {

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

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus 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" timestampFormat:"unix"`

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrasesDetectionJobFilter

func (KeyPhrasesDetectionJobFilter) String

String returns the string representation

func (*KeyPhrasesDetectionJobFilter) Validate

func (s *KeyPhrasesDetectionJobFilter) Validate() error

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

type KeyPhrasesDetectionJobProperties

type KeyPhrasesDetectionJobProperties struct {

	// The 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" timestampFormat:"unix"`

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

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

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

	// The current status of the key phrases detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrasesDetectionJobProperties

func (KeyPhrasesDetectionJobProperties) 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"
)

Enum values for LanguageCode

func (LanguageCode) MarshalValue

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

func (LanguageCode) MarshalValueBuf

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

type ListDocumentClassificationJobsInput

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
}

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

func (ListDocumentClassificationJobsInput) String

String returns the string representation

func (*ListDocumentClassificationJobsInput) Validate

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

type ListDocumentClassificationJobsOutput

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
}

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

func (ListDocumentClassificationJobsOutput) String

String returns the string representation

type ListDocumentClassificationJobsPaginator

type ListDocumentClassificationJobsPaginator struct {
	aws.Pager
}

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

func NewListDocumentClassificationJobsPaginator

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

type ListDocumentClassificationJobsRequest

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

ListDocumentClassificationJobsRequest is the request type for the ListDocumentClassificationJobs API operation.

func (ListDocumentClassificationJobsRequest) Send

Send marshals and sends the ListDocumentClassificationJobs API request.

type ListDocumentClassificationJobsResponse

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

ListDocumentClassificationJobsResponse is the response type for the ListDocumentClassificationJobs API operation.

func (*ListDocumentClassificationJobsResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListDocumentClassificationJobs request.

type ListDocumentClassifiersInput

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
}

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

func (ListDocumentClassifiersInput) String

String returns the string representation

func (*ListDocumentClassifiersInput) Validate

func (s *ListDocumentClassifiersInput) Validate() error

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

type ListDocumentClassifiersOutput

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
}

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

func (ListDocumentClassifiersOutput) String

String returns the string representation

type ListDocumentClassifiersPaginator

type ListDocumentClassifiersPaginator struct {
	aws.Pager
}

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

func NewListDocumentClassifiersPaginator

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

type ListDocumentClassifiersRequest

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

ListDocumentClassifiersRequest is the request type for the ListDocumentClassifiers API operation.

func (ListDocumentClassifiersRequest) Send

Send marshals and sends the ListDocumentClassifiers API request.

type ListDocumentClassifiersResponse

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

ListDocumentClassifiersResponse is the response type for the ListDocumentClassifiers API operation.

func (*ListDocumentClassifiersResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListDocumentClassifiers request.

type ListDominantLanguageDetectionJobsInput

type ListDominantLanguageDetectionJobsInput struct {

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

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

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

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

func (ListDominantLanguageDetectionJobsInput) String

String returns the string representation

func (*ListDominantLanguageDetectionJobsInput) Validate

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

type ListDominantLanguageDetectionJobsOutput

type ListDominantLanguageDetectionJobsOutput struct {

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

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

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

func (ListDominantLanguageDetectionJobsOutput) String

String returns the string representation

type ListDominantLanguageDetectionJobsPaginator

type ListDominantLanguageDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListDominantLanguageDetectionJobsPaginator

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

type ListDominantLanguageDetectionJobsRequest

ListDominantLanguageDetectionJobsRequest is the request type for the ListDominantLanguageDetectionJobs API operation.

func (ListDominantLanguageDetectionJobsRequest) Send

Send marshals and sends the ListDominantLanguageDetectionJobs API request.

type ListDominantLanguageDetectionJobsResponse

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

ListDominantLanguageDetectionJobsResponse is the response type for the ListDominantLanguageDetectionJobs API operation.

func (*ListDominantLanguageDetectionJobsResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListDominantLanguageDetectionJobs request.

type ListEntitiesDetectionJobsInput

type ListEntitiesDetectionJobsInput struct {

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

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

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

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

func (ListEntitiesDetectionJobsInput) String

String returns the string representation

func (*ListEntitiesDetectionJobsInput) Validate

func (s *ListEntitiesDetectionJobsInput) Validate() error

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

type ListEntitiesDetectionJobsOutput

type ListEntitiesDetectionJobsOutput struct {

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

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

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

func (ListEntitiesDetectionJobsOutput) String

String returns the string representation

type ListEntitiesDetectionJobsPaginator

type ListEntitiesDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListEntitiesDetectionJobsPaginator

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

type ListEntitiesDetectionJobsRequest

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

ListEntitiesDetectionJobsRequest is the request type for the ListEntitiesDetectionJobs API operation.

func (ListEntitiesDetectionJobsRequest) Send

Send marshals and sends the ListEntitiesDetectionJobs API request.

type ListEntitiesDetectionJobsResponse

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

ListEntitiesDetectionJobsResponse is the response type for the ListEntitiesDetectionJobs API operation.

func (*ListEntitiesDetectionJobsResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListEntitiesDetectionJobs request.

type ListEntityRecognizersInput

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
}

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

func (ListEntityRecognizersInput) String

String returns the string representation

func (*ListEntityRecognizersInput) Validate

func (s *ListEntityRecognizersInput) Validate() error

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

type ListEntityRecognizersOutput

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
}

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

func (ListEntityRecognizersOutput) String

String returns the string representation

type ListEntityRecognizersPaginator

type ListEntityRecognizersPaginator struct {
	aws.Pager
}

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

func NewListEntityRecognizersPaginator

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

type ListEntityRecognizersRequest

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

ListEntityRecognizersRequest is the request type for the ListEntityRecognizers API operation.

func (ListEntityRecognizersRequest) Send

Send marshals and sends the ListEntityRecognizers API request.

type ListEntityRecognizersResponse

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

ListEntityRecognizersResponse is the response type for the ListEntityRecognizers API operation.

func (*ListEntityRecognizersResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListEntityRecognizers request.

type ListKeyPhrasesDetectionJobsInput

type ListKeyPhrasesDetectionJobsInput struct {

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

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

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

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

func (ListKeyPhrasesDetectionJobsInput) String

String returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) Validate

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

type ListKeyPhrasesDetectionJobsOutput

type ListKeyPhrasesDetectionJobsOutput struct {

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

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

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

func (ListKeyPhrasesDetectionJobsOutput) String

String returns the string representation

type ListKeyPhrasesDetectionJobsPaginator

type ListKeyPhrasesDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListKeyPhrasesDetectionJobsPaginator

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

type ListKeyPhrasesDetectionJobsRequest

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

ListKeyPhrasesDetectionJobsRequest is the request type for the ListKeyPhrasesDetectionJobs API operation.

func (ListKeyPhrasesDetectionJobsRequest) Send

Send marshals and sends the ListKeyPhrasesDetectionJobs API request.

type ListKeyPhrasesDetectionJobsResponse

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

ListKeyPhrasesDetectionJobsResponse is the response type for the ListKeyPhrasesDetectionJobs API operation.

func (*ListKeyPhrasesDetectionJobsResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListKeyPhrasesDetectionJobs request.

type ListSentimentDetectionJobsInput

type ListSentimentDetectionJobsInput struct {

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

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

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

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

func (ListSentimentDetectionJobsInput) String

String returns the string representation

func (*ListSentimentDetectionJobsInput) Validate

func (s *ListSentimentDetectionJobsInput) Validate() error

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

type ListSentimentDetectionJobsOutput

type ListSentimentDetectionJobsOutput struct {

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

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

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

func (ListSentimentDetectionJobsOutput) String

String returns the string representation

type ListSentimentDetectionJobsPaginator

type ListSentimentDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListSentimentDetectionJobsPaginator

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

type ListSentimentDetectionJobsRequest

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

ListSentimentDetectionJobsRequest is the request type for the ListSentimentDetectionJobs API operation.

func (ListSentimentDetectionJobsRequest) Send

Send marshals and sends the ListSentimentDetectionJobs API request.

type ListSentimentDetectionJobsResponse

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

ListSentimentDetectionJobsResponse is the response type for the ListSentimentDetectionJobs API operation.

func (*ListSentimentDetectionJobsResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListSentimentDetectionJobs request.

type ListTagsForResourceInput

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
}

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

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

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
}

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

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest

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

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse

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

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata

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
}

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

func (ListTopicsDetectionJobsInput) String

String returns the string representation

func (*ListTopicsDetectionJobsInput) Validate

func (s *ListTopicsDetectionJobsInput) Validate() error

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

type ListTopicsDetectionJobsOutput

type ListTopicsDetectionJobsOutput struct {

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

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

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

func (ListTopicsDetectionJobsOutput) String

String returns the string representation

type ListTopicsDetectionJobsPaginator

type ListTopicsDetectionJobsPaginator struct {
	aws.Pager
}

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

func NewListTopicsDetectionJobsPaginator

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

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

Send marshals and sends the ListTopicsDetectionJobs API request.

type ListTopicsDetectionJobsResponse

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

ListTopicsDetectionJobsResponse is the response type for the ListTopicsDetectionJobs API operation.

func (*ListTopicsDetectionJobsResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the ListTopicsDetectionJobs request.

type ModelStatus

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

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

func (ModelStatus) MarshalValueBuf

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/OutputDataConfig

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PartOfSpeechTag

func (PartOfSpeechTag) String

func (s PartOfSpeechTag) String() string

String returns the string representation

type PartOfSpeechTagType

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

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

func (PartOfSpeechTagType) MarshalValueBuf

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

type SentimentDetectionJobFilter

type SentimentDetectionJobFilter struct {

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

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus 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" timestampFormat:"unix"`

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentDetectionJobFilter

func (SentimentDetectionJobFilter) String

String returns the string representation

func (*SentimentDetectionJobFilter) Validate

func (s *SentimentDetectionJobFilter) Validate() error

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

type SentimentDetectionJobProperties

type SentimentDetectionJobProperties struct {

	// The 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" timestampFormat:"unix"`

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

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

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

	// The current status of the sentiment detection job. If the status is FAILED,
	// the Messages field shows the reason for the failure.
	JobStatus 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentDetectionJobProperties

func (SentimentDetectionJobProperties) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentScore

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

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

func (SentimentType) MarshalValueBuf

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

type StartDocumentClassificationJobInput

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
}

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

func (StartDocumentClassificationJobInput) String

String returns the string representation

func (*StartDocumentClassificationJobInput) Validate

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

type StartDocumentClassificationJobOutput

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
}

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

func (StartDocumentClassificationJobOutput) String

String returns the string representation

type StartDocumentClassificationJobRequest

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

StartDocumentClassificationJobRequest is the request type for the StartDocumentClassificationJob API operation.

func (StartDocumentClassificationJobRequest) Send

Send marshals and sends the StartDocumentClassificationJob API request.

type StartDocumentClassificationJobResponse

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

StartDocumentClassificationJobResponse is the response type for the StartDocumentClassificationJob API operation.

func (*StartDocumentClassificationJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StartDocumentClassificationJob request.

type StartDominantLanguageDetectionJobInput

type StartDominantLanguageDetectionJobInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and 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
}

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

func (StartDominantLanguageDetectionJobInput) String

String returns the string representation

func (*StartDominantLanguageDetectionJobInput) Validate

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

type StartDominantLanguageDetectionJobOutput

type StartDominantLanguageDetectionJobOutput struct {

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

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

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

func (StartDominantLanguageDetectionJobOutput) String

String returns the string representation

type StartDominantLanguageDetectionJobRequest

StartDominantLanguageDetectionJobRequest is the request type for the StartDominantLanguageDetectionJob API operation.

func (StartDominantLanguageDetectionJobRequest) Send

Send marshals and sends the StartDominantLanguageDetectionJob API request.

type StartDominantLanguageDetectionJobResponse

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

StartDominantLanguageDetectionJobResponse is the response type for the StartDominantLanguageDetectionJob API operation.

func (*StartDominantLanguageDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StartDominantLanguageDetectionJob request.

type StartEntitiesDetectionJobInput

type StartEntitiesDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that grants Amazon Comprehend read access to your input data.
	// For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

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

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

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

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

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

func (StartEntitiesDetectionJobInput) String

String returns the string representation

func (*StartEntitiesDetectionJobInput) Validate

func (s *StartEntitiesDetectionJobInput) Validate() error

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

type StartEntitiesDetectionJobOutput

type StartEntitiesDetectionJobOutput struct {

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

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	//
	//    * 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
}

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

func (StartEntitiesDetectionJobOutput) String

String returns the string representation

type StartEntitiesDetectionJobRequest

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

StartEntitiesDetectionJobRequest is the request type for the StartEntitiesDetectionJob API operation.

func (StartEntitiesDetectionJobRequest) Send

Send marshals and sends the StartEntitiesDetectionJob API request.

type StartEntitiesDetectionJobResponse

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

StartEntitiesDetectionJobResponse is the response type for the StartEntitiesDetectionJob API operation.

func (*StartEntitiesDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StartEntitiesDetectionJob request.

type StartKeyPhrasesDetectionJobInput

type StartKeyPhrasesDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and 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 English ("en") or Spanish
	// ("es"). 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
}

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

func (StartKeyPhrasesDetectionJobInput) String

String returns the string representation

func (*StartKeyPhrasesDetectionJobInput) Validate

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

type StartKeyPhrasesDetectionJobOutput

type StartKeyPhrasesDetectionJobOutput struct {

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

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

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

func (StartKeyPhrasesDetectionJobOutput) String

String returns the string representation

type StartKeyPhrasesDetectionJobRequest

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

StartKeyPhrasesDetectionJobRequest is the request type for the StartKeyPhrasesDetectionJob API operation.

func (StartKeyPhrasesDetectionJobRequest) Send

Send marshals and sends the StartKeyPhrasesDetectionJob API request.

type StartKeyPhrasesDetectionJobResponse

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

StartKeyPhrasesDetectionJobResponse is the response type for the StartKeyPhrasesDetectionJob API operation.

func (*StartKeyPhrasesDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StartKeyPhrasesDetectionJob request.

type StartSentimentDetectionJobInput

type StartSentimentDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and 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 English ("en") or Spanish
	// ("es"). 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
}

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

func (StartSentimentDetectionJobInput) String

String returns the string representation

func (*StartSentimentDetectionJobInput) Validate

func (s *StartSentimentDetectionJobInput) Validate() error

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

type StartSentimentDetectionJobOutput

type StartSentimentDetectionJobOutput struct {

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

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

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

func (StartSentimentDetectionJobOutput) String

String returns the string representation

type StartSentimentDetectionJobRequest

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

StartSentimentDetectionJobRequest is the request type for the StartSentimentDetectionJob API operation.

func (StartSentimentDetectionJobRequest) Send

Send marshals and sends the StartSentimentDetectionJob API request.

type StartSentimentDetectionJobResponse

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

StartSentimentDetectionJobResponse is the response type for the StartSentimentDetectionJob API operation.

func (*StartSentimentDetectionJobResponse) SDKResponseMetdata

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
}

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

func (StartTopicsDetectionJobInput) String

String returns the string representation

func (*StartTopicsDetectionJobInput) Validate

func (s *StartTopicsDetectionJobInput) Validate() error

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

type StartTopicsDetectionJobOutput

type StartTopicsDetectionJobOutput struct {

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

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

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

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

Send marshals and sends the StartTopicsDetectionJob API request.

type StartTopicsDetectionJobResponse

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

StartTopicsDetectionJobResponse is the response type for the StartTopicsDetectionJob API operation.

func (*StartTopicsDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StartTopicsDetectionJob request.

type StopDominantLanguageDetectionJobInput

type StopDominantLanguageDetectionJobInput struct {

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

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

func (StopDominantLanguageDetectionJobInput) String

String returns the string representation

func (*StopDominantLanguageDetectionJobInput) Validate

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

type StopDominantLanguageDetectionJobOutput

type StopDominantLanguageDetectionJobOutput struct {

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

	// Either 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
}

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

func (StopDominantLanguageDetectionJobOutput) String

String returns the string representation

type StopDominantLanguageDetectionJobRequest

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

StopDominantLanguageDetectionJobRequest is the request type for the StopDominantLanguageDetectionJob API operation.

func (StopDominantLanguageDetectionJobRequest) Send

Send marshals and sends the StopDominantLanguageDetectionJob API request.

type StopDominantLanguageDetectionJobResponse

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

StopDominantLanguageDetectionJobResponse is the response type for the StopDominantLanguageDetectionJob API operation.

func (*StopDominantLanguageDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StopDominantLanguageDetectionJob request.

type StopEntitiesDetectionJobInput

type StopEntitiesDetectionJobInput struct {

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

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

func (StopEntitiesDetectionJobInput) String

String returns the string representation

func (*StopEntitiesDetectionJobInput) Validate

func (s *StopEntitiesDetectionJobInput) Validate() error

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

type StopEntitiesDetectionJobOutput

type StopEntitiesDetectionJobOutput struct {

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

	// Either 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
}

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

func (StopEntitiesDetectionJobOutput) String

String returns the string representation

type StopEntitiesDetectionJobRequest

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

StopEntitiesDetectionJobRequest is the request type for the StopEntitiesDetectionJob API operation.

func (StopEntitiesDetectionJobRequest) Send

Send marshals and sends the StopEntitiesDetectionJob API request.

type StopEntitiesDetectionJobResponse

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

StopEntitiesDetectionJobResponse is the response type for the StopEntitiesDetectionJob API operation.

func (*StopEntitiesDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StopEntitiesDetectionJob request.

type StopKeyPhrasesDetectionJobInput

type StopKeyPhrasesDetectionJobInput struct {

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

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

func (StopKeyPhrasesDetectionJobInput) String

String returns the string representation

func (*StopKeyPhrasesDetectionJobInput) Validate

func (s *StopKeyPhrasesDetectionJobInput) Validate() error

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

type StopKeyPhrasesDetectionJobOutput

type StopKeyPhrasesDetectionJobOutput struct {

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

	// Either 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
}

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

func (StopKeyPhrasesDetectionJobOutput) String

String returns the string representation

type StopKeyPhrasesDetectionJobRequest

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

StopKeyPhrasesDetectionJobRequest is the request type for the StopKeyPhrasesDetectionJob API operation.

func (StopKeyPhrasesDetectionJobRequest) Send

Send marshals and sends the StopKeyPhrasesDetectionJob API request.

type StopKeyPhrasesDetectionJobResponse

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

StopKeyPhrasesDetectionJobResponse is the response type for the StopKeyPhrasesDetectionJob API operation.

func (*StopKeyPhrasesDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StopKeyPhrasesDetectionJob request.

type StopSentimentDetectionJobInput

type StopSentimentDetectionJobInput struct {

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

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

func (StopSentimentDetectionJobInput) String

String returns the string representation

func (*StopSentimentDetectionJobInput) Validate

func (s *StopSentimentDetectionJobInput) Validate() error

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

type StopSentimentDetectionJobOutput

type StopSentimentDetectionJobOutput struct {

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

	// Either 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
}

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

func (StopSentimentDetectionJobOutput) String

String returns the string representation

type StopSentimentDetectionJobRequest

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

StopSentimentDetectionJobRequest is the request type for the StopSentimentDetectionJob API operation.

func (StopSentimentDetectionJobRequest) Send

Send marshals and sends the StopSentimentDetectionJob API request.

type StopSentimentDetectionJobResponse

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

StopSentimentDetectionJobResponse is the response type for the StopSentimentDetectionJob API operation.

func (*StopSentimentDetectionJobResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StopSentimentDetectionJob request.

type StopTrainingDocumentClassifierInput

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
}

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

func (StopTrainingDocumentClassifierInput) String

String returns the string representation

func (*StopTrainingDocumentClassifierInput) Validate

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

type StopTrainingDocumentClassifierOutput

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

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

func (StopTrainingDocumentClassifierOutput) String

String returns the string representation

type StopTrainingDocumentClassifierRequest

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

StopTrainingDocumentClassifierRequest is the request type for the StopTrainingDocumentClassifier API operation.

func (StopTrainingDocumentClassifierRequest) Send

Send marshals and sends the StopTrainingDocumentClassifier API request.

type StopTrainingDocumentClassifierResponse

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

StopTrainingDocumentClassifierResponse is the response type for the StopTrainingDocumentClassifier API operation.

func (*StopTrainingDocumentClassifierResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StopTrainingDocumentClassifier request.

type StopTrainingEntityRecognizerInput

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
}

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

func (StopTrainingEntityRecognizerInput) String

String returns the string representation

func (*StopTrainingEntityRecognizerInput) Validate

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

type StopTrainingEntityRecognizerOutput

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

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

func (StopTrainingEntityRecognizerOutput) String

String returns the string representation

type StopTrainingEntityRecognizerRequest

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

StopTrainingEntityRecognizerRequest is the request type for the StopTrainingEntityRecognizer API operation.

func (StopTrainingEntityRecognizerRequest) Send

Send marshals and sends the StopTrainingEntityRecognizer API request.

type StopTrainingEntityRecognizerResponse

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

StopTrainingEntityRecognizerResponse is the response type for the StopTrainingEntityRecognizer API operation.

func (*StopTrainingEntityRecognizerResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the StopTrainingEntityRecognizer request.

type SyntaxLanguageCode

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

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

func (SyntaxLanguageCode) MarshalValueBuf

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

type SyntaxToken

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SyntaxToken

func (SyntaxToken) String

func (s SyntaxToken) String() string

String returns the string representation

type Tag

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Tag

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

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

type TagResourceInput

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
}

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

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

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

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest

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

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send

Send marshals and sends the TagResource API request.

type TagResourceResponse

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata

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" timestampFormat:"unix"`

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

Provides information for filtering topic detection jobs. For more information, see . Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TopicsDetectionJobFilter

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" timestampFormat:"unix"`

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

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

	// The name of the topic detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the topic detection job. If the status is Failed, the
	// reason for the failure is shown in the Message field.
	JobStatus 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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TopicsDetectionJobProperties

func (TopicsDetectionJobProperties) String

String returns the string representation

type UntagResourceInput

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
}

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

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

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

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest

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

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send

Send marshals and sends the UntagResource API request.

type UntagResourceResponse

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata

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

SDKResponseMetdata returns the response metadata for the UntagResource request.

type VpcConfig

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). Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/VpcConfig

func (VpcConfig) String

func (s VpcConfig) String() string

String returns the string representation

func (*VpcConfig) Validate

func (s *VpcConfig) Validate() error

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

Source Files

api_client.go api_doc.go api_enums.go api_errors.go api_op_BatchDetectDominantLanguage.go api_op_BatchDetectEntities.go api_op_BatchDetectKeyPhrases.go api_op_BatchDetectSentiment.go api_op_BatchDetectSyntax.go api_op_CreateDocumentClassifier.go api_op_CreateEntityRecognizer.go api_op_DeleteDocumentClassifier.go api_op_DeleteEntityRecognizer.go api_op_DescribeDocumentClassificationJob.go api_op_DescribeDocumentClassifier.go api_op_DescribeDominantLanguageDetectionJob.go api_op_DescribeEntitiesDetectionJob.go api_op_DescribeEntityRecognizer.go api_op_DescribeKeyPhrasesDetectionJob.go api_op_DescribeSentimentDetectionJob.go api_op_DescribeTopicsDetectionJob.go api_op_DetectDominantLanguage.go api_op_DetectEntities.go api_op_DetectKeyPhrases.go api_op_DetectSentiment.go api_op_DetectSyntax.go api_op_ListDocumentClassificationJobs.go api_op_ListDocumentClassifiers.go api_op_ListDominantLanguageDetectionJobs.go api_op_ListEntitiesDetectionJobs.go api_op_ListEntityRecognizers.go api_op_ListKeyPhrasesDetectionJobs.go api_op_ListSentimentDetectionJobs.go api_op_ListTagsForResource.go api_op_ListTopicsDetectionJobs.go api_op_StartDocumentClassificationJob.go api_op_StartDominantLanguageDetectionJob.go api_op_StartEntitiesDetectionJob.go api_op_StartKeyPhrasesDetectionJob.go api_op_StartSentimentDetectionJob.go api_op_StartTopicsDetectionJob.go api_op_StopDominantLanguageDetectionJob.go api_op_StopEntitiesDetectionJob.go api_op_StopKeyPhrasesDetectionJob.go api_op_StopSentimentDetectionJob.go api_op_StopTrainingDocumentClassifier.go api_op_StopTrainingEntityRecognizer.go api_op_TagResource.go api_op_UntagResource.go api_types.go

Directories

PathSynopsis
service/comprehend/comprehendifacePackage comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.
Version
v0.9.0
Published
May 28, 2019
Platform
windows/amd64
Imports
7 packages
Last checked
2 minutes ago

Tools for package owners.