...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/comprehend"
Overview
Constants

Overview ▾

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

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

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

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

Using the Client

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

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

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

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

The stub package, comprehendiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type Comprehend
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Comprehend
func (c *Comprehend) BatchDetectDominantLanguage(input *BatchDetectDominantLanguageInput) (*BatchDetectDominantLanguageOutput, error)
func (c *Comprehend) BatchDetectDominantLanguageRequest(input *BatchDetectDominantLanguageInput) (req *request.Request, output *BatchDetectDominantLanguageOutput)
func (c *Comprehend) BatchDetectDominantLanguageWithContext(ctx aws.Context, input *BatchDetectDominantLanguageInput, opts ...request.Option) (*BatchDetectDominantLanguageOutput, error)
func (c *Comprehend) BatchDetectEntities(input *BatchDetectEntitiesInput) (*BatchDetectEntitiesOutput, error)
func (c *Comprehend) BatchDetectEntitiesRequest(input *BatchDetectEntitiesInput) (req *request.Request, output *BatchDetectEntitiesOutput)
func (c *Comprehend) BatchDetectEntitiesWithContext(ctx aws.Context, input *BatchDetectEntitiesInput, opts ...request.Option) (*BatchDetectEntitiesOutput, error)
func (c *Comprehend) BatchDetectKeyPhrases(input *BatchDetectKeyPhrasesInput) (*BatchDetectKeyPhrasesOutput, error)
func (c *Comprehend) BatchDetectKeyPhrasesRequest(input *BatchDetectKeyPhrasesInput) (req *request.Request, output *BatchDetectKeyPhrasesOutput)
func (c *Comprehend) BatchDetectKeyPhrasesWithContext(ctx aws.Context, input *BatchDetectKeyPhrasesInput, opts ...request.Option) (*BatchDetectKeyPhrasesOutput, error)
func (c *Comprehend) BatchDetectSentiment(input *BatchDetectSentimentInput) (*BatchDetectSentimentOutput, error)
func (c *Comprehend) BatchDetectSentimentRequest(input *BatchDetectSentimentInput) (req *request.Request, output *BatchDetectSentimentOutput)
func (c *Comprehend) BatchDetectSentimentWithContext(ctx aws.Context, input *BatchDetectSentimentInput, opts ...request.Option) (*BatchDetectSentimentOutput, error)
func (c *Comprehend) BatchDetectSyntax(input *BatchDetectSyntaxInput) (*BatchDetectSyntaxOutput, error)
func (c *Comprehend) BatchDetectSyntaxRequest(input *BatchDetectSyntaxInput) (req *request.Request, output *BatchDetectSyntaxOutput)
func (c *Comprehend) BatchDetectSyntaxWithContext(ctx aws.Context, input *BatchDetectSyntaxInput, opts ...request.Option) (*BatchDetectSyntaxOutput, error)
func (c *Comprehend) ClassifyDocument(input *ClassifyDocumentInput) (*ClassifyDocumentOutput, error)
func (c *Comprehend) ClassifyDocumentRequest(input *ClassifyDocumentInput) (req *request.Request, output *ClassifyDocumentOutput)
func (c *Comprehend) ClassifyDocumentWithContext(ctx aws.Context, input *ClassifyDocumentInput, opts ...request.Option) (*ClassifyDocumentOutput, error)
func (c *Comprehend) CreateDocumentClassifier(input *CreateDocumentClassifierInput) (*CreateDocumentClassifierOutput, error)
func (c *Comprehend) CreateDocumentClassifierRequest(input *CreateDocumentClassifierInput) (req *request.Request, output *CreateDocumentClassifierOutput)
func (c *Comprehend) CreateDocumentClassifierWithContext(ctx aws.Context, input *CreateDocumentClassifierInput, opts ...request.Option) (*CreateDocumentClassifierOutput, error)
func (c *Comprehend) CreateEndpoint(input *CreateEndpointInput) (*CreateEndpointOutput, error)
func (c *Comprehend) CreateEndpointRequest(input *CreateEndpointInput) (req *request.Request, output *CreateEndpointOutput)
func (c *Comprehend) CreateEndpointWithContext(ctx aws.Context, input *CreateEndpointInput, opts ...request.Option) (*CreateEndpointOutput, error)
func (c *Comprehend) CreateEntityRecognizer(input *CreateEntityRecognizerInput) (*CreateEntityRecognizerOutput, error)
func (c *Comprehend) CreateEntityRecognizerRequest(input *CreateEntityRecognizerInput) (req *request.Request, output *CreateEntityRecognizerOutput)
func (c *Comprehend) CreateEntityRecognizerWithContext(ctx aws.Context, input *CreateEntityRecognizerInput, opts ...request.Option) (*CreateEntityRecognizerOutput, error)
func (c *Comprehend) DeleteDocumentClassifier(input *DeleteDocumentClassifierInput) (*DeleteDocumentClassifierOutput, error)
func (c *Comprehend) DeleteDocumentClassifierRequest(input *DeleteDocumentClassifierInput) (req *request.Request, output *DeleteDocumentClassifierOutput)
func (c *Comprehend) DeleteDocumentClassifierWithContext(ctx aws.Context, input *DeleteDocumentClassifierInput, opts ...request.Option) (*DeleteDocumentClassifierOutput, error)
func (c *Comprehend) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
func (c *Comprehend) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
func (c *Comprehend) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)
func (c *Comprehend) DeleteEntityRecognizer(input *DeleteEntityRecognizerInput) (*DeleteEntityRecognizerOutput, error)
func (c *Comprehend) DeleteEntityRecognizerRequest(input *DeleteEntityRecognizerInput) (req *request.Request, output *DeleteEntityRecognizerOutput)
func (c *Comprehend) DeleteEntityRecognizerWithContext(ctx aws.Context, input *DeleteEntityRecognizerInput, opts ...request.Option) (*DeleteEntityRecognizerOutput, error)
func (c *Comprehend) DescribeDocumentClassificationJob(input *DescribeDocumentClassificationJobInput) (*DescribeDocumentClassificationJobOutput, error)
func (c *Comprehend) DescribeDocumentClassificationJobRequest(input *DescribeDocumentClassificationJobInput) (req *request.Request, output *DescribeDocumentClassificationJobOutput)
func (c *Comprehend) DescribeDocumentClassificationJobWithContext(ctx aws.Context, input *DescribeDocumentClassificationJobInput, opts ...request.Option) (*DescribeDocumentClassificationJobOutput, error)
func (c *Comprehend) DescribeDocumentClassifier(input *DescribeDocumentClassifierInput) (*DescribeDocumentClassifierOutput, error)
func (c *Comprehend) DescribeDocumentClassifierRequest(input *DescribeDocumentClassifierInput) (req *request.Request, output *DescribeDocumentClassifierOutput)
func (c *Comprehend) DescribeDocumentClassifierWithContext(ctx aws.Context, input *DescribeDocumentClassifierInput, opts ...request.Option) (*DescribeDocumentClassifierOutput, error)
func (c *Comprehend) DescribeDominantLanguageDetectionJob(input *DescribeDominantLanguageDetectionJobInput) (*DescribeDominantLanguageDetectionJobOutput, error)
func (c *Comprehend) DescribeDominantLanguageDetectionJobRequest(input *DescribeDominantLanguageDetectionJobInput) (req *request.Request, output *DescribeDominantLanguageDetectionJobOutput)
func (c *Comprehend) DescribeDominantLanguageDetectionJobWithContext(ctx aws.Context, input *DescribeDominantLanguageDetectionJobInput, opts ...request.Option) (*DescribeDominantLanguageDetectionJobOutput, error)
func (c *Comprehend) DescribeEndpoint(input *DescribeEndpointInput) (*DescribeEndpointOutput, error)
func (c *Comprehend) DescribeEndpointRequest(input *DescribeEndpointInput) (req *request.Request, output *DescribeEndpointOutput)
func (c *Comprehend) DescribeEndpointWithContext(ctx aws.Context, input *DescribeEndpointInput, opts ...request.Option) (*DescribeEndpointOutput, error)
func (c *Comprehend) DescribeEntitiesDetectionJob(input *DescribeEntitiesDetectionJobInput) (*DescribeEntitiesDetectionJobOutput, error)
func (c *Comprehend) DescribeEntitiesDetectionJobRequest(input *DescribeEntitiesDetectionJobInput) (req *request.Request, output *DescribeEntitiesDetectionJobOutput)
func (c *Comprehend) DescribeEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribeEntitiesDetectionJobInput, opts ...request.Option) (*DescribeEntitiesDetectionJobOutput, error)
func (c *Comprehend) DescribeEntityRecognizer(input *DescribeEntityRecognizerInput) (*DescribeEntityRecognizerOutput, error)
func (c *Comprehend) DescribeEntityRecognizerRequest(input *DescribeEntityRecognizerInput) (req *request.Request, output *DescribeEntityRecognizerOutput)
func (c *Comprehend) DescribeEntityRecognizerWithContext(ctx aws.Context, input *DescribeEntityRecognizerInput, opts ...request.Option) (*DescribeEntityRecognizerOutput, error)
func (c *Comprehend) DescribeKeyPhrasesDetectionJob(input *DescribeKeyPhrasesDetectionJobInput) (*DescribeKeyPhrasesDetectionJobOutput, error)
func (c *Comprehend) DescribeKeyPhrasesDetectionJobRequest(input *DescribeKeyPhrasesDetectionJobInput) (req *request.Request, output *DescribeKeyPhrasesDetectionJobOutput)
func (c *Comprehend) DescribeKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *DescribeKeyPhrasesDetectionJobInput, opts ...request.Option) (*DescribeKeyPhrasesDetectionJobOutput, error)
func (c *Comprehend) DescribePiiEntitiesDetectionJob(input *DescribePiiEntitiesDetectionJobInput) (*DescribePiiEntitiesDetectionJobOutput, error)
func (c *Comprehend) DescribePiiEntitiesDetectionJobRequest(input *DescribePiiEntitiesDetectionJobInput) (req *request.Request, output *DescribePiiEntitiesDetectionJobOutput)
func (c *Comprehend) DescribePiiEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribePiiEntitiesDetectionJobInput, opts ...request.Option) (*DescribePiiEntitiesDetectionJobOutput, error)
func (c *Comprehend) DescribeSentimentDetectionJob(input *DescribeSentimentDetectionJobInput) (*DescribeSentimentDetectionJobOutput, error)
func (c *Comprehend) DescribeSentimentDetectionJobRequest(input *DescribeSentimentDetectionJobInput) (req *request.Request, output *DescribeSentimentDetectionJobOutput)
func (c *Comprehend) DescribeSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeSentimentDetectionJobInput, opts ...request.Option) (*DescribeSentimentDetectionJobOutput, error)
func (c *Comprehend) DescribeTopicsDetectionJob(input *DescribeTopicsDetectionJobInput) (*DescribeTopicsDetectionJobOutput, error)
func (c *Comprehend) DescribeTopicsDetectionJobRequest(input *DescribeTopicsDetectionJobInput) (req *request.Request, output *DescribeTopicsDetectionJobOutput)
func (c *Comprehend) DescribeTopicsDetectionJobWithContext(ctx aws.Context, input *DescribeTopicsDetectionJobInput, opts ...request.Option) (*DescribeTopicsDetectionJobOutput, error)
func (c *Comprehend) DetectDominantLanguage(input *DetectDominantLanguageInput) (*DetectDominantLanguageOutput, error)
func (c *Comprehend) DetectDominantLanguageRequest(input *DetectDominantLanguageInput) (req *request.Request, output *DetectDominantLanguageOutput)
func (c *Comprehend) DetectDominantLanguageWithContext(ctx aws.Context, input *DetectDominantLanguageInput, opts ...request.Option) (*DetectDominantLanguageOutput, error)
func (c *Comprehend) DetectEntities(input *DetectEntitiesInput) (*DetectEntitiesOutput, error)
func (c *Comprehend) DetectEntitiesRequest(input *DetectEntitiesInput) (req *request.Request, output *DetectEntitiesOutput)
func (c *Comprehend) DetectEntitiesWithContext(ctx aws.Context, input *DetectEntitiesInput, opts ...request.Option) (*DetectEntitiesOutput, error)
func (c *Comprehend) DetectKeyPhrases(input *DetectKeyPhrasesInput) (*DetectKeyPhrasesOutput, error)
func (c *Comprehend) DetectKeyPhrasesRequest(input *DetectKeyPhrasesInput) (req *request.Request, output *DetectKeyPhrasesOutput)
func (c *Comprehend) DetectKeyPhrasesWithContext(ctx aws.Context, input *DetectKeyPhrasesInput, opts ...request.Option) (*DetectKeyPhrasesOutput, error)
func (c *Comprehend) DetectPiiEntities(input *DetectPiiEntitiesInput) (*DetectPiiEntitiesOutput, error)
func (c *Comprehend) DetectPiiEntitiesRequest(input *DetectPiiEntitiesInput) (req *request.Request, output *DetectPiiEntitiesOutput)
func (c *Comprehend) DetectPiiEntitiesWithContext(ctx aws.Context, input *DetectPiiEntitiesInput, opts ...request.Option) (*DetectPiiEntitiesOutput, error)
func (c *Comprehend) DetectSentiment(input *DetectSentimentInput) (*DetectSentimentOutput, error)
func (c *Comprehend) DetectSentimentRequest(input *DetectSentimentInput) (req *request.Request, output *DetectSentimentOutput)
func (c *Comprehend) DetectSentimentWithContext(ctx aws.Context, input *DetectSentimentInput, opts ...request.Option) (*DetectSentimentOutput, error)
func (c *Comprehend) DetectSyntax(input *DetectSyntaxInput) (*DetectSyntaxOutput, error)
func (c *Comprehend) DetectSyntaxRequest(input *DetectSyntaxInput) (req *request.Request, output *DetectSyntaxOutput)
func (c *Comprehend) DetectSyntaxWithContext(ctx aws.Context, input *DetectSyntaxInput, opts ...request.Option) (*DetectSyntaxOutput, error)
func (c *Comprehend) ListDocumentClassificationJobs(input *ListDocumentClassificationJobsInput) (*ListDocumentClassificationJobsOutput, error)
func (c *Comprehend) ListDocumentClassificationJobsPages(input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool) error
func (c *Comprehend) ListDocumentClassificationJobsPagesWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentClassificationJobsInput) (req *request.Request, output *ListDocumentClassificationJobsOutput)
func (c *Comprehend) ListDocumentClassificationJobsWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, opts ...request.Option) (*ListDocumentClassificationJobsOutput, error)
func (c *Comprehend) ListDocumentClassifiers(input *ListDocumentClassifiersInput) (*ListDocumentClassifiersOutput, error)
func (c *Comprehend) ListDocumentClassifiersPages(input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool) error
func (c *Comprehend) ListDocumentClassifiersPagesWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListDocumentClassifiersRequest(input *ListDocumentClassifiersInput) (req *request.Request, output *ListDocumentClassifiersOutput)
func (c *Comprehend) ListDocumentClassifiersWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, opts ...request.Option) (*ListDocumentClassifiersOutput, error)
func (c *Comprehend) ListDominantLanguageDetectionJobs(input *ListDominantLanguageDetectionJobsInput) (*ListDominantLanguageDetectionJobsOutput, error)
func (c *Comprehend) ListDominantLanguageDetectionJobsPages(input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListDominantLanguageDetectionJobsPagesWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListDominantLanguageDetectionJobsRequest(input *ListDominantLanguageDetectionJobsInput) (req *request.Request, output *ListDominantLanguageDetectionJobsOutput)
func (c *Comprehend) ListDominantLanguageDetectionJobsWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, opts ...request.Option) (*ListDominantLanguageDetectionJobsOutput, error)
func (c *Comprehend) ListEndpoints(input *ListEndpointsInput) (*ListEndpointsOutput, error)
func (c *Comprehend) ListEndpointsRequest(input *ListEndpointsInput) (req *request.Request, output *ListEndpointsOutput)
func (c *Comprehend) ListEndpointsWithContext(ctx aws.Context, input *ListEndpointsInput, opts ...request.Option) (*ListEndpointsOutput, error)
func (c *Comprehend) ListEntitiesDetectionJobs(input *ListEntitiesDetectionJobsInput) (*ListEntitiesDetectionJobsOutput, error)
func (c *Comprehend) ListEntitiesDetectionJobsPages(input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListEntitiesDetectionJobsRequest(input *ListEntitiesDetectionJobsInput) (req *request.Request, output *ListEntitiesDetectionJobsOutput)
func (c *Comprehend) ListEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, opts ...request.Option) (*ListEntitiesDetectionJobsOutput, error)
func (c *Comprehend) ListEntityRecognizers(input *ListEntityRecognizersInput) (*ListEntityRecognizersOutput, error)
func (c *Comprehend) ListEntityRecognizersPages(input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool) error
func (c *Comprehend) ListEntityRecognizersPagesWithContext(ctx aws.Context, input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListEntityRecognizersRequest(input *ListEntityRecognizersInput) (req *request.Request, output *ListEntityRecognizersOutput)
func (c *Comprehend) ListEntityRecognizersWithContext(ctx aws.Context, input *ListEntityRecognizersInput, opts ...request.Option) (*ListEntityRecognizersOutput, error)
func (c *Comprehend) ListKeyPhrasesDetectionJobs(input *ListKeyPhrasesDetectionJobsInput) (*ListKeyPhrasesDetectionJobsOutput, error)
func (c *Comprehend) ListKeyPhrasesDetectionJobsPages(input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDetectionJobsInput) (req *request.Request, output *ListKeyPhrasesDetectionJobsOutput)
func (c *Comprehend) ListKeyPhrasesDetectionJobsWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, opts ...request.Option) (*ListKeyPhrasesDetectionJobsOutput, error)
func (c *Comprehend) ListPiiEntitiesDetectionJobs(input *ListPiiEntitiesDetectionJobsInput) (*ListPiiEntitiesDetectionJobsOutput, error)
func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesDetectionJobsInput) (req *request.Request, output *ListPiiEntitiesDetectionJobsOutput)
func (c *Comprehend) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, opts ...request.Option) (*ListPiiEntitiesDetectionJobsOutput, error)
func (c *Comprehend) ListSentimentDetectionJobs(input *ListSentimentDetectionJobsInput) (*ListSentimentDetectionJobsOutput, error)
func (c *Comprehend) ListSentimentDetectionJobsPages(input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) (req *request.Request, output *ListSentimentDetectionJobsOutput)
func (c *Comprehend) ListSentimentDetectionJobsWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, opts ...request.Option) (*ListSentimentDetectionJobsOutput, error)
func (c *Comprehend) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
func (c *Comprehend) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
func (c *Comprehend) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error)
func (c *Comprehend) ListTopicsDetectionJobsPages(input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput)
func (c *Comprehend) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error)
func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error)
func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) (req *request.Request, output *StartDocumentClassificationJobOutput)
func (c *Comprehend) StartDocumentClassificationJobWithContext(ctx aws.Context, input *StartDocumentClassificationJobInput, opts ...request.Option) (*StartDocumentClassificationJobOutput, error)
func (c *Comprehend) StartDominantLanguageDetectionJob(input *StartDominantLanguageDetectionJobInput) (*StartDominantLanguageDetectionJobOutput, error)
func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) (req *request.Request, output *StartDominantLanguageDetectionJobOutput)
func (c *Comprehend) StartDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StartDominantLanguageDetectionJobInput, opts ...request.Option) (*StartDominantLanguageDetectionJobOutput, error)
func (c *Comprehend) StartEntitiesDetectionJob(input *StartEntitiesDetectionJobInput) (*StartEntitiesDetectionJobOutput, error)
func (c *Comprehend) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) (req *request.Request, output *StartEntitiesDetectionJobOutput)
func (c *Comprehend) StartEntitiesDetectionJobWithContext(ctx aws.Context, input *StartEntitiesDetectionJobInput, opts ...request.Option) (*StartEntitiesDetectionJobOutput, error)
func (c *Comprehend) StartKeyPhrasesDetectionJob(input *StartKeyPhrasesDetectionJobInput) (*StartKeyPhrasesDetectionJobOutput, error)
func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) (req *request.Request, output *StartKeyPhrasesDetectionJobOutput)
func (c *Comprehend) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StartKeyPhrasesDetectionJobInput, opts ...request.Option) (*StartKeyPhrasesDetectionJobOutput, error)
func (c *Comprehend) StartPiiEntitiesDetectionJob(input *StartPiiEntitiesDetectionJobInput) (*StartPiiEntitiesDetectionJobOutput, error)
func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntitiesDetectionJobInput) (req *request.Request, output *StartPiiEntitiesDetectionJobOutput)
func (c *Comprehend) StartPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StartPiiEntitiesDetectionJobInput, opts ...request.Option) (*StartPiiEntitiesDetectionJobOutput, error)
func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error)
func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput)
func (c *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error)
func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error)
func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput)
func (c *Comprehend) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error)
func (c *Comprehend) StopDominantLanguageDetectionJob(input *StopDominantLanguageDetectionJobInput) (*StopDominantLanguageDetectionJobOutput, error)
func (c *Comprehend) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) (req *request.Request, output *StopDominantLanguageDetectionJobOutput)
func (c *Comprehend) StopDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StopDominantLanguageDetectionJobInput, opts ...request.Option) (*StopDominantLanguageDetectionJobOutput, error)
func (c *Comprehend) StopEntitiesDetectionJob(input *StopEntitiesDetectionJobInput) (*StopEntitiesDetectionJobOutput, error)
func (c *Comprehend) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) (req *request.Request, output *StopEntitiesDetectionJobOutput)
func (c *Comprehend) StopEntitiesDetectionJobWithContext(ctx aws.Context, input *StopEntitiesDetectionJobInput, opts ...request.Option) (*StopEntitiesDetectionJobOutput, error)
func (c *Comprehend) StopKeyPhrasesDetectionJob(input *StopKeyPhrasesDetectionJobInput) (*StopKeyPhrasesDetectionJobOutput, error)
func (c *Comprehend) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) (req *request.Request, output *StopKeyPhrasesDetectionJobOutput)
func (c *Comprehend) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StopKeyPhrasesDetectionJobInput, opts ...request.Option) (*StopKeyPhrasesDetectionJobOutput, error)
func (c *Comprehend) StopPiiEntitiesDetectionJob(input *StopPiiEntitiesDetectionJobInput) (*StopPiiEntitiesDetectionJobOutput, error)
func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDetectionJobInput) (req *request.Request, output *StopPiiEntitiesDetectionJobOutput)
func (c *Comprehend) StopPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StopPiiEntitiesDetectionJobInput, opts ...request.Option) (*StopPiiEntitiesDetectionJobOutput, error)
func (c *Comprehend) StopSentimentDetectionJob(input *StopSentimentDetectionJobInput) (*StopSentimentDetectionJobOutput, error)
func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) (req *request.Request, output *StopSentimentDetectionJobOutput)
func (c *Comprehend) StopSentimentDetectionJobWithContext(ctx aws.Context, input *StopSentimentDetectionJobInput, opts ...request.Option) (*StopSentimentDetectionJobOutput, error)
func (c *Comprehend) StopTrainingDocumentClassifier(input *StopTrainingDocumentClassifierInput) (*StopTrainingDocumentClassifierOutput, error)
func (c *Comprehend) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) (req *request.Request, output *StopTrainingDocumentClassifierOutput)
func (c *Comprehend) StopTrainingDocumentClassifierWithContext(ctx aws.Context, input *StopTrainingDocumentClassifierInput, opts ...request.Option) (*StopTrainingDocumentClassifierOutput, error)
func (c *Comprehend) StopTrainingEntityRecognizer(input *StopTrainingEntityRecognizerInput) (*StopTrainingEntityRecognizerOutput, error)
func (c *Comprehend) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) (req *request.Request, output *StopTrainingEntityRecognizerOutput)
func (c *Comprehend) StopTrainingEntityRecognizerWithContext(ctx aws.Context, input *StopTrainingEntityRecognizerInput, opts ...request.Option) (*StopTrainingEntityRecognizerOutput, error)
func (c *Comprehend) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
func (c *Comprehend) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
func (c *Comprehend) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
func (c *Comprehend) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
func (c *Comprehend) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
func (c *Comprehend) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
func (c *Comprehend) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error)
func (c *Comprehend) UpdateEndpointRequest(input *UpdateEndpointInput) (req *request.Request, output *UpdateEndpointOutput)
func (c *Comprehend) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error)
func DocumentClassifierDataFormat_Values() []string
func DocumentClassifierMode_Values() []string
func EndpointStatus_Values() []string
func EntityRecognizerDataFormat_Values() []string
func EntityType_Values() []string
func InputFormat_Values() []string
func JobStatus_Values() []string
func LanguageCode_Values() []string
func ModelStatus_Values() []string
func PartOfSpeechTagType_Values() []string
func PiiEntitiesDetectionMaskMode_Values() []string
func PiiEntitiesDetectionMode_Values() []string
func PiiEntityType_Values() []string
func SentimentType_Values() []string
func SyntaxLanguageCode_Values() []string
type AugmentedManifestsListItem
type BatchDetectDominantLanguageInput
type BatchDetectDominantLanguageItemResult
type BatchDetectDominantLanguageOutput
type BatchDetectEntitiesInput
type BatchDetectEntitiesItemResult
type BatchDetectEntitiesOutput
type BatchDetectKeyPhrasesInput
type BatchDetectKeyPhrasesItemResult
type BatchDetectKeyPhrasesOutput
type BatchDetectSentimentInput
type BatchDetectSentimentItemResult
type BatchDetectSentimentOutput
type BatchDetectSyntaxInput
type BatchDetectSyntaxItemResult
type BatchDetectSyntaxOutput
type BatchItemError
type BatchSizeLimitExceededException
type ClassifierEvaluationMetrics
type ClassifierMetadata
type ClassifyDocumentInput
type ClassifyDocumentOutput
type ConcurrentModificationException
type CreateDocumentClassifierInput
type CreateDocumentClassifierOutput
type CreateEndpointInput
type CreateEndpointOutput
type CreateEntityRecognizerInput
type CreateEntityRecognizerOutput
type DeleteDocumentClassifierInput
type DeleteDocumentClassifierOutput
type DeleteEndpointInput
type DeleteEndpointOutput
type DeleteEntityRecognizerInput
type DeleteEntityRecognizerOutput
type DescribeDocumentClassificationJobInput
type DescribeDocumentClassificationJobOutput
type DescribeDocumentClassifierInput
type DescribeDocumentClassifierOutput
type DescribeDominantLanguageDetectionJobInput
type DescribeDominantLanguageDetectionJobOutput
type DescribeEndpointInput
type DescribeEndpointOutput
type DescribeEntitiesDetectionJobInput
type DescribeEntitiesDetectionJobOutput
type DescribeEntityRecognizerInput
type DescribeEntityRecognizerOutput
type DescribeKeyPhrasesDetectionJobInput
type DescribeKeyPhrasesDetectionJobOutput
type DescribePiiEntitiesDetectionJobInput
type DescribePiiEntitiesDetectionJobOutput
type DescribeSentimentDetectionJobInput
type DescribeSentimentDetectionJobOutput
type DescribeTopicsDetectionJobInput
type DescribeTopicsDetectionJobOutput
type DetectDominantLanguageInput
type DetectDominantLanguageOutput
type DetectEntitiesInput
type DetectEntitiesOutput
type DetectKeyPhrasesInput
type DetectKeyPhrasesOutput
type DetectPiiEntitiesInput
type DetectPiiEntitiesOutput
type DetectSentimentInput
type DetectSentimentOutput
type DetectSyntaxInput
type DetectSyntaxOutput
type DocumentClass
type DocumentClassificationJobFilter
type DocumentClassificationJobProperties
type DocumentClassifierFilter
type DocumentClassifierInputDataConfig
type DocumentClassifierOutputDataConfig
type DocumentClassifierProperties
type DocumentLabel
type DominantLanguage
type DominantLanguageDetectionJobFilter
type DominantLanguageDetectionJobProperties
type EndpointFilter
type EndpointProperties
type EntitiesDetectionJobFilter
type EntitiesDetectionJobProperties
type Entity
type EntityRecognizerAnnotations
type EntityRecognizerDocuments
type EntityRecognizerEntityList
type EntityRecognizerEvaluationMetrics
type EntityRecognizerFilter
type EntityRecognizerInputDataConfig
type EntityRecognizerMetadata
type EntityRecognizerMetadataEntityTypesListItem
type EntityRecognizerProperties
type EntityTypesEvaluationMetrics
type EntityTypesListItem
type InputDataConfig
type InternalServerException
type InvalidFilterException
type InvalidRequestException
type JobNotFoundException
type KeyPhrase
type KeyPhrasesDetectionJobFilter
type KeyPhrasesDetectionJobProperties
type KmsKeyValidationException
type ListDocumentClassificationJobsInput
type ListDocumentClassificationJobsOutput
type ListDocumentClassifiersInput
type ListDocumentClassifiersOutput
type ListDominantLanguageDetectionJobsInput
type ListDominantLanguageDetectionJobsOutput
type ListEndpointsInput
type ListEndpointsOutput
type ListEntitiesDetectionJobsInput
type ListEntitiesDetectionJobsOutput
type ListEntityRecognizersInput
type ListEntityRecognizersOutput
type ListKeyPhrasesDetectionJobsInput
type ListKeyPhrasesDetectionJobsOutput
type ListPiiEntitiesDetectionJobsInput
type ListPiiEntitiesDetectionJobsOutput
type ListSentimentDetectionJobsInput
type ListSentimentDetectionJobsOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type ListTopicsDetectionJobsInput
type ListTopicsDetectionJobsOutput
type OutputDataConfig
type PartOfSpeechTag
type PiiEntitiesDetectionJobFilter
type PiiEntitiesDetectionJobProperties
type PiiEntity
type PiiOutputDataConfig
type RedactionConfig
type ResourceInUseException
type ResourceLimitExceededException
type ResourceNotFoundException
type ResourceUnavailableException
type SentimentDetectionJobFilter
type SentimentDetectionJobProperties
type SentimentScore
type StartDocumentClassificationJobInput
type StartDocumentClassificationJobOutput
type StartDominantLanguageDetectionJobInput
type StartDominantLanguageDetectionJobOutput
type StartEntitiesDetectionJobInput
type StartEntitiesDetectionJobOutput
type StartKeyPhrasesDetectionJobInput
type StartKeyPhrasesDetectionJobOutput
type StartPiiEntitiesDetectionJobInput
type StartPiiEntitiesDetectionJobOutput
type StartSentimentDetectionJobInput
type StartSentimentDetectionJobOutput
type StartTopicsDetectionJobInput
type StartTopicsDetectionJobOutput
type StopDominantLanguageDetectionJobInput
type StopDominantLanguageDetectionJobOutput
type StopEntitiesDetectionJobInput
type StopEntitiesDetectionJobOutput
type StopKeyPhrasesDetectionJobInput
type StopKeyPhrasesDetectionJobOutput
type StopPiiEntitiesDetectionJobInput
type StopPiiEntitiesDetectionJobOutput
type StopSentimentDetectionJobInput
type StopSentimentDetectionJobOutput
type StopTrainingDocumentClassifierInput
type StopTrainingDocumentClassifierOutput
type StopTrainingEntityRecognizerInput
type StopTrainingEntityRecognizerOutput
type SyntaxToken
type Tag
type TagResourceInput
type TagResourceOutput
type TextSizeLimitExceededException
type TooManyRequestsException
type TooManyTagKeysException
type TooManyTagsException
type TopicsDetectionJobFilter
type TopicsDetectionJobProperties
type UnsupportedLanguageException
type UntagResourceInput
type UntagResourceOutput
type UpdateEndpointInput
type UpdateEndpointOutput
type VpcConfig

Constants ▾

const (
    // DocumentClassifierDataFormatComprehendCsv is a DocumentClassifierDataFormat enum value
    DocumentClassifierDataFormatComprehendCsv = "COMPREHEND_CSV"

    // DocumentClassifierDataFormatAugmentedManifest is a DocumentClassifierDataFormat enum value
    DocumentClassifierDataFormatAugmentedManifest = "AUGMENTED_MANIFEST"
)
const (
    // DocumentClassifierModeMultiClass is a DocumentClassifierMode enum value
    DocumentClassifierModeMultiClass = "MULTI_CLASS"

    // DocumentClassifierModeMultiLabel is a DocumentClassifierMode enum value
    DocumentClassifierModeMultiLabel = "MULTI_LABEL"
)
const (
    // EndpointStatusCreating is a EndpointStatus enum value
    EndpointStatusCreating = "CREATING"

    // EndpointStatusDeleting is a EndpointStatus enum value
    EndpointStatusDeleting = "DELETING"

    // EndpointStatusFailed is a EndpointStatus enum value
    EndpointStatusFailed = "FAILED"

    // EndpointStatusInService is a EndpointStatus enum value
    EndpointStatusInService = "IN_SERVICE"

    // EndpointStatusUpdating is a EndpointStatus enum value
    EndpointStatusUpdating = "UPDATING"
)
const (
    // EntityRecognizerDataFormatComprehendCsv is a EntityRecognizerDataFormat enum value
    EntityRecognizerDataFormatComprehendCsv = "COMPREHEND_CSV"

    // EntityRecognizerDataFormatAugmentedManifest is a EntityRecognizerDataFormat enum value
    EntityRecognizerDataFormatAugmentedManifest = "AUGMENTED_MANIFEST"
)
const (
    // EntityTypePerson is a EntityType enum value
    EntityTypePerson = "PERSON"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // LanguageCodeEs is a LanguageCode enum value
    LanguageCodeEs = "es"

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

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

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

    // LanguageCodePt is a LanguageCode enum value
    LanguageCodePt = "pt"

    // LanguageCodeAr is a LanguageCode enum value
    LanguageCodeAr = "ar"

    // LanguageCodeHi is a LanguageCode enum value
    LanguageCodeHi = "hi"

    // LanguageCodeJa is a LanguageCode enum value
    LanguageCodeJa = "ja"

    // LanguageCodeKo is a LanguageCode enum value
    LanguageCodeKo = "ko"

    // LanguageCodeZh is a LanguageCode enum value
    LanguageCodeZh = "zh"

    // LanguageCodeZhTw is a LanguageCode enum value
    LanguageCodeZhTw = "zh-TW"
)
const (
    // ModelStatusSubmitted is a ModelStatus enum value
    ModelStatusSubmitted = "SUBMITTED"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // PartOfSpeechTagTypeVerb is a PartOfSpeechTagType enum value
    PartOfSpeechTagTypeVerb = "VERB"
)
const (
    // PiiEntitiesDetectionMaskModeMask is a PiiEntitiesDetectionMaskMode enum value
    PiiEntitiesDetectionMaskModeMask = "MASK"

    // PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType is a PiiEntitiesDetectionMaskMode enum value
    PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType = "REPLACE_WITH_PII_ENTITY_TYPE"
)
const (
    // PiiEntitiesDetectionModeOnlyRedaction is a PiiEntitiesDetectionMode enum value
    PiiEntitiesDetectionModeOnlyRedaction = "ONLY_REDACTION"

    // PiiEntitiesDetectionModeOnlyOffsets is a PiiEntitiesDetectionMode enum value
    PiiEntitiesDetectionModeOnlyOffsets = "ONLY_OFFSETS"
)
const (
    // PiiEntityTypeBankAccountNumber is a PiiEntityType enum value
    PiiEntityTypeBankAccountNumber = "BANK_ACCOUNT_NUMBER"

    // PiiEntityTypeBankRouting is a PiiEntityType enum value
    PiiEntityTypeBankRouting = "BANK_ROUTING"

    // PiiEntityTypeCreditDebitNumber is a PiiEntityType enum value
    PiiEntityTypeCreditDebitNumber = "CREDIT_DEBIT_NUMBER"

    // PiiEntityTypeCreditDebitCvv is a PiiEntityType enum value
    PiiEntityTypeCreditDebitCvv = "CREDIT_DEBIT_CVV"

    // PiiEntityTypeCreditDebitExpiry is a PiiEntityType enum value
    PiiEntityTypeCreditDebitExpiry = "CREDIT_DEBIT_EXPIRY"

    // PiiEntityTypePin is a PiiEntityType enum value
    PiiEntityTypePin = "PIN"

    // PiiEntityTypeEmail is a PiiEntityType enum value
    PiiEntityTypeEmail = "EMAIL"

    // PiiEntityTypeAddress is a PiiEntityType enum value
    PiiEntityTypeAddress = "ADDRESS"

    // PiiEntityTypeName is a PiiEntityType enum value
    PiiEntityTypeName = "NAME"

    // PiiEntityTypePhone is a PiiEntityType enum value
    PiiEntityTypePhone = "PHONE"

    // PiiEntityTypeSsn is a PiiEntityType enum value
    PiiEntityTypeSsn = "SSN"

    // PiiEntityTypeDateTime is a PiiEntityType enum value
    PiiEntityTypeDateTime = "DATE_TIME"

    // PiiEntityTypePassportNumber is a PiiEntityType enum value
    PiiEntityTypePassportNumber = "PASSPORT_NUMBER"

    // PiiEntityTypeDriverId is a PiiEntityType enum value
    PiiEntityTypeDriverId = "DRIVER_ID"

    // PiiEntityTypeUrl is a PiiEntityType enum value
    PiiEntityTypeUrl = "URL"

    // PiiEntityTypeAge is a PiiEntityType enum value
    PiiEntityTypeAge = "AGE"

    // PiiEntityTypeUsername is a PiiEntityType enum value
    PiiEntityTypeUsername = "USERNAME"

    // PiiEntityTypePassword is a PiiEntityType enum value
    PiiEntityTypePassword = "PASSWORD"

    // PiiEntityTypeAwsAccessKey is a PiiEntityType enum value
    PiiEntityTypeAwsAccessKey = "AWS_ACCESS_KEY"

    // PiiEntityTypeAwsSecretKey is a PiiEntityType enum value
    PiiEntityTypeAwsSecretKey = "AWS_SECRET_KEY"

    // PiiEntityTypeIpAddress is a PiiEntityType enum value
    PiiEntityTypeIpAddress = "IP_ADDRESS"

    // PiiEntityTypeMacAddress is a PiiEntityType enum value
    PiiEntityTypeMacAddress = "MAC_ADDRESS"

    // PiiEntityTypeAll is a PiiEntityType enum value
    PiiEntityTypeAll = "ALL"
)
const (
    // SentimentTypePositive is a SentimentType enum value
    SentimentTypePositive = "POSITIVE"

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

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

    // SentimentTypeMixed is a SentimentType enum value
    SentimentTypeMixed = "MIXED"
)
const (
    // SyntaxLanguageCodeEn is a SyntaxLanguageCode enum value
    SyntaxLanguageCodeEn = "en"

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

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

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

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

    // SyntaxLanguageCodePt is a SyntaxLanguageCode enum value
    SyntaxLanguageCodePt = "pt"
)
const (

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

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

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

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

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

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

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

    // ErrCodeResourceInUseException for service response error code
    // "ResourceInUseException".
    //
    // The specified resource 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 resources per account has been exceeded. Review the
    // resources, 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 the resource 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, Spanish,
    // French, Italian, German, or Portuguese are accepted. For most other APIs,
    // such as those for Custom Classification, Amazon Comprehend accepts text in
    // all supported languages. For a list of supported languages, see supported-languages.
    ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException"
)
const (
    ServiceName = "comprehend" // Name of service.
    EndpointsID = ServiceName  // ID to lookup a service endpoint with.
    ServiceID   = "Comprehend" // ServiceID is a unique identifier of a specific service.
)

Service information constants

func DocumentClassifierDataFormat_Values

func DocumentClassifierDataFormat_Values() []string

DocumentClassifierDataFormat_Values returns all elements of the DocumentClassifierDataFormat enum

func DocumentClassifierMode_Values

func DocumentClassifierMode_Values() []string

DocumentClassifierMode_Values returns all elements of the DocumentClassifierMode enum

func EndpointStatus_Values

func EndpointStatus_Values() []string

EndpointStatus_Values returns all elements of the EndpointStatus enum

func EntityRecognizerDataFormat_Values

func EntityRecognizerDataFormat_Values() []string

EntityRecognizerDataFormat_Values returns all elements of the EntityRecognizerDataFormat enum

func EntityType_Values

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func InputFormat_Values

func InputFormat_Values() []string

InputFormat_Values returns all elements of the InputFormat enum

func JobStatus_Values

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func LanguageCode_Values

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func ModelStatus_Values

func ModelStatus_Values() []string

ModelStatus_Values returns all elements of the ModelStatus enum

func PartOfSpeechTagType_Values

func PartOfSpeechTagType_Values() []string

PartOfSpeechTagType_Values returns all elements of the PartOfSpeechTagType enum

func PiiEntitiesDetectionMaskMode_Values

func PiiEntitiesDetectionMaskMode_Values() []string

PiiEntitiesDetectionMaskMode_Values returns all elements of the PiiEntitiesDetectionMaskMode enum

func PiiEntitiesDetectionMode_Values

func PiiEntitiesDetectionMode_Values() []string

PiiEntitiesDetectionMode_Values returns all elements of the PiiEntitiesDetectionMode enum

func PiiEntityType_Values

func PiiEntityType_Values() []string

PiiEntityType_Values returns all elements of the PiiEntityType enum

func SentimentType_Values

func SentimentType_Values() []string

SentimentType_Values returns all elements of the SentimentType enum

func SyntaxLanguageCode_Values

func SyntaxLanguageCode_Values() []string

SyntaxLanguageCode_Values returns all elements of the SyntaxLanguageCode enum

type AugmentedManifestsListItem

type AugmentedManifestsListItem struct {

    // The JSON attribute that contains the annotations for your training documents.
    // The number of attribute names that you specify depends on whether your augmented
    // manifest file is the output of a single labeling job or a chained labeling
    // job.
    //
    // If your file is the output of a single labeling job, specify the LabelAttributeName
    // key that was used when the job was created in Ground Truth.
    //
    // If your file is the output of a chained labeling job, specify the LabelAttributeName
    // key for one or more jobs in the chain. Each LabelAttributeName key provides
    // the annotations from an individual job.
    //
    // AttributeNames is a required field
    AttributeNames []*string `type:"list" required:"true"`

    // The Amazon S3 location of the augmented manifest file.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

func (AugmentedManifestsListItem) GoString

func (s AugmentedManifestsListItem) GoString() string

GoString returns the string representation

func (*AugmentedManifestsListItem) SetAttributeNames

func (s *AugmentedManifestsListItem) SetAttributeNames(v []*string) *AugmentedManifestsListItem

SetAttributeNames sets the AttributeNames field's value.

func (*AugmentedManifestsListItem) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (AugmentedManifestsListItem) String

func (s AugmentedManifestsListItem) String() string

String returns the string representation

func (*AugmentedManifestsListItem) Validate

func (s *AugmentedManifestsListItem) Validate() error

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

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" sensitive:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectDominantLanguageInput) GoString

func (s BatchDetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectDominantLanguageInput) String

func (s BatchDetectDominantLanguageInput) String() string

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate

func (s *BatchDetectDominantLanguageInput) Validate() error

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

type BatchDetectDominantLanguageItemResult

type BatchDetectDominantLanguageItemResult struct {

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

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

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

func (BatchDetectDominantLanguageItemResult) GoString

func (s BatchDetectDominantLanguageItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (*BatchDetectDominantLanguageItemResult) SetLanguages

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

SetLanguages sets the Languages field's value.

func (BatchDetectDominantLanguageItemResult) String

func (s BatchDetectDominantLanguageItemResult) String() string

String returns the string representation

type BatchDetectDominantLanguageOutput

type BatchDetectDominantLanguageOutput struct {

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

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

func (BatchDetectDominantLanguageOutput) GoString

func (s BatchDetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectDominantLanguageOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectDominantLanguageOutput) String

func (s BatchDetectDominantLanguageOutput) String() string

String returns the string representation

type BatchDetectEntitiesInput

type BatchDetectEntitiesInput struct {

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

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

func (BatchDetectEntitiesInput) GoString

func (s BatchDetectEntitiesInput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectEntitiesInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectEntitiesInput) String

func (s BatchDetectEntitiesInput) String() string

String returns the string representation

func (*BatchDetectEntitiesInput) Validate

func (s *BatchDetectEntitiesInput) Validate() error

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

type BatchDetectEntitiesItemResult

type BatchDetectEntitiesItemResult struct {

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

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

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

func (BatchDetectEntitiesItemResult) GoString

func (s BatchDetectEntitiesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesItemResult) SetEntities

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

SetEntities sets the Entities field's value.

func (*BatchDetectEntitiesItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (BatchDetectEntitiesItemResult) String

func (s BatchDetectEntitiesItemResult) String() string

String returns the string representation

type BatchDetectEntitiesOutput

type BatchDetectEntitiesOutput struct {

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

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

func (BatchDetectEntitiesOutput) GoString

func (s BatchDetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectEntitiesOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectEntitiesOutput) String

func (s BatchDetectEntitiesOutput) String() string

String returns the string representation

type BatchDetectKeyPhrasesInput

type BatchDetectKeyPhrasesInput struct {

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

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

func (BatchDetectKeyPhrasesInput) GoString

func (s BatchDetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectKeyPhrasesInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectKeyPhrasesInput) String

func (s BatchDetectKeyPhrasesInput) String() string

String returns the string representation

func (*BatchDetectKeyPhrasesInput) Validate

func (s *BatchDetectKeyPhrasesInput) Validate() error

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

type BatchDetectKeyPhrasesItemResult

type BatchDetectKeyPhrasesItemResult struct {

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

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

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

func (BatchDetectKeyPhrasesItemResult) GoString

func (s BatchDetectKeyPhrasesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (*BatchDetectKeyPhrasesItemResult) SetKeyPhrases

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

SetKeyPhrases sets the KeyPhrases field's value.

func (BatchDetectKeyPhrasesItemResult) String

func (s BatchDetectKeyPhrasesItemResult) String() string

String returns the string representation

type BatchDetectKeyPhrasesOutput

type BatchDetectKeyPhrasesOutput struct {

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

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

func (BatchDetectKeyPhrasesOutput) GoString

func (s BatchDetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectKeyPhrasesOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectKeyPhrasesOutput) String

func (s BatchDetectKeyPhrasesOutput) String() string

String returns the string representation

type BatchDetectSentimentInput

type BatchDetectSentimentInput struct {

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

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

func (BatchDetectSentimentInput) GoString

func (s BatchDetectSentimentInput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSentimentInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectSentimentInput) String

func (s BatchDetectSentimentInput) String() string

String returns the string representation

func (*BatchDetectSentimentInput) Validate

func (s *BatchDetectSentimentInput) Validate() error

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

type BatchDetectSentimentItemResult

type BatchDetectSentimentItemResult struct {

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

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

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

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

func (BatchDetectSentimentItemResult) GoString

func (s BatchDetectSentimentItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (*BatchDetectSentimentItemResult) SetSentiment

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

SetSentiment sets the Sentiment field's value.

func (*BatchDetectSentimentItemResult) SetSentimentScore

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

SetSentimentScore sets the SentimentScore field's value.

func (BatchDetectSentimentItemResult) String

func (s BatchDetectSentimentItemResult) String() string

String returns the string representation

type BatchDetectSentimentOutput

type BatchDetectSentimentOutput struct {

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

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

func (BatchDetectSentimentOutput) GoString

func (s BatchDetectSentimentOutput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSentimentOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectSentimentOutput) String

func (s BatchDetectSentimentOutput) String() string

String returns the string representation

type BatchDetectSyntaxInput

type BatchDetectSyntaxInput struct {

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

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

func (BatchDetectSyntaxInput) GoString

func (s BatchDetectSyntaxInput) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSyntaxInput) SetTextList

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

SetTextList sets the TextList field's value.

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.

func (BatchDetectSyntaxItemResult) GoString

func (s BatchDetectSyntaxItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (*BatchDetectSyntaxItemResult) SetSyntaxTokens

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

SetSyntaxTokens sets the SyntaxTokens field's value.

func (BatchDetectSyntaxItemResult) String

func (s BatchDetectSyntaxItemResult) String() 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
}

func (BatchDetectSyntaxOutput) GoString

func (s BatchDetectSyntaxOutput) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSyntaxOutput) SetResultList

func (s *BatchDetectSyntaxOutput) SetResultList(v []*BatchDetectSyntaxItemResult) *BatchDetectSyntaxOutput

SetResultList sets the ResultList field's value.

func (BatchDetectSyntaxOutput) String

func (s BatchDetectSyntaxOutput) String() string

String returns the string representation

type BatchItemError

type BatchItemError struct {

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

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

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

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

func (BatchItemError) GoString

func (s BatchItemError) GoString() string

GoString returns the string representation

func (*BatchItemError) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchItemError) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchItemError) SetIndex

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

SetIndex sets the Index field's value.

func (BatchItemError) String

func (s BatchItemError) String() string

String returns the string representation

type BatchSizeLimitExceededException

type BatchSizeLimitExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

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

func (*BatchSizeLimitExceededException) Code

func (s *BatchSizeLimitExceededException) Code() string

Code returns the exception type name.

func (*BatchSizeLimitExceededException) Error

func (s *BatchSizeLimitExceededException) Error() string

func (BatchSizeLimitExceededException) GoString

func (s BatchSizeLimitExceededException) GoString() string

GoString returns the string representation

func (*BatchSizeLimitExceededException) Message

func (s *BatchSizeLimitExceededException) Message() string

Message returns the exception's message.

func (*BatchSizeLimitExceededException) OrigErr

func (s *BatchSizeLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BatchSizeLimitExceededException) RequestID

func (s *BatchSizeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BatchSizeLimitExceededException) StatusCode

func (s *BatchSizeLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BatchSizeLimitExceededException) String

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

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

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

    // A measure of the usefulness of the recognizer results in the test data. High
    // precision means that the recognizer returned substantially more relevant
    // results than irrelevant ones. Unlike the Precision metric which comes from
    // averaging the precision of all available labels, this is based on the overall
    // score of all precision scores added together.
    MicroPrecision *float64 `type:"double"`

    // A measure of how complete the classifier results are for the test data. High
    // recall means that the classifier returned most of the relevant results. Specifically,
    // this indicates how many of the correct categories in the text that the model
    // can predict. It is a percentage of correct categories in the text that can
    // found. Instead of averaging the recall scores of all labels (as with Recall),
    // micro Recall is based on the overall score of all recall scores added together.
    MicroRecall *float64 `type:"double"`

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

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

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

func (ClassifierEvaluationMetrics) GoString

func (s ClassifierEvaluationMetrics) GoString() string

GoString returns the string representation

func (*ClassifierEvaluationMetrics) SetAccuracy

func (s *ClassifierEvaluationMetrics) SetAccuracy(v float64) *ClassifierEvaluationMetrics

SetAccuracy sets the Accuracy field's value.

func (*ClassifierEvaluationMetrics) SetF1Score

func (s *ClassifierEvaluationMetrics) SetF1Score(v float64) *ClassifierEvaluationMetrics

SetF1Score sets the F1Score field's value.

func (*ClassifierEvaluationMetrics) SetHammingLoss

func (s *ClassifierEvaluationMetrics) SetHammingLoss(v float64) *ClassifierEvaluationMetrics

SetHammingLoss sets the HammingLoss field's value.

func (*ClassifierEvaluationMetrics) SetMicroF1Score

func (s *ClassifierEvaluationMetrics) SetMicroF1Score(v float64) *ClassifierEvaluationMetrics

SetMicroF1Score sets the MicroF1Score field's value.

func (*ClassifierEvaluationMetrics) SetMicroPrecision

func (s *ClassifierEvaluationMetrics) SetMicroPrecision(v float64) *ClassifierEvaluationMetrics

SetMicroPrecision sets the MicroPrecision field's value.

func (*ClassifierEvaluationMetrics) SetMicroRecall

func (s *ClassifierEvaluationMetrics) SetMicroRecall(v float64) *ClassifierEvaluationMetrics

SetMicroRecall sets the MicroRecall field's value.

func (*ClassifierEvaluationMetrics) SetPrecision

func (s *ClassifierEvaluationMetrics) SetPrecision(v float64) *ClassifierEvaluationMetrics

SetPrecision sets the Precision field's value.

func (*ClassifierEvaluationMetrics) SetRecall

func (s *ClassifierEvaluationMetrics) SetRecall(v float64) *ClassifierEvaluationMetrics

SetRecall sets the Recall field's value.

func (ClassifierEvaluationMetrics) String

func (s ClassifierEvaluationMetrics) String() 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, up to 10,000 documents.
    NumberOfTestDocuments *int64 `type:"integer"`

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

Provides information about a document classifier.

func (ClassifierMetadata) GoString

func (s ClassifierMetadata) GoString() string

GoString returns the string representation

func (*ClassifierMetadata) SetEvaluationMetrics

func (s *ClassifierMetadata) SetEvaluationMetrics(v *ClassifierEvaluationMetrics) *ClassifierMetadata

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*ClassifierMetadata) SetNumberOfLabels

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

SetNumberOfLabels sets the NumberOfLabels field's value.

func (*ClassifierMetadata) SetNumberOfTestDocuments

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

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*ClassifierMetadata) SetNumberOfTrainedDocuments

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

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (ClassifierMetadata) String

func (s ClassifierMetadata) String() string

String returns the string representation

type ClassifyDocumentInput

type ClassifyDocumentInput struct {

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

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

func (ClassifyDocumentInput) GoString

func (s ClassifyDocumentInput) GoString() string

GoString returns the string representation

func (*ClassifyDocumentInput) SetEndpointArn

func (s *ClassifyDocumentInput) SetEndpointArn(v string) *ClassifyDocumentInput

SetEndpointArn sets the EndpointArn field's value.

func (*ClassifyDocumentInput) SetText

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

SetText sets the Text field's value.

func (ClassifyDocumentInput) String

func (s ClassifyDocumentInput) String() string

String returns the string representation

func (*ClassifyDocumentInput) Validate

func (s *ClassifyDocumentInput) Validate() error

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

type ClassifyDocumentOutput

type ClassifyDocumentOutput struct {

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

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

func (ClassifyDocumentOutput) GoString

func (s ClassifyDocumentOutput) GoString() string

GoString returns the string representation

func (*ClassifyDocumentOutput) SetClasses

func (s *ClassifyDocumentOutput) SetClasses(v []*DocumentClass) *ClassifyDocumentOutput

SetClasses sets the Classes field's value.

func (*ClassifyDocumentOutput) SetLabels

func (s *ClassifyDocumentOutput) SetLabels(v []*DocumentLabel) *ClassifyDocumentOutput

SetLabels sets the Labels field's value.

func (ClassifyDocumentOutput) String

func (s ClassifyDocumentOutput) String() string

String returns the string representation

type Comprehend

type Comprehend struct {
    *client.Client
}

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

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

func New

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

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

Example:

mySession := session.Must(session.NewSession())

// Create a Comprehend client from just a session.
svc := comprehend.New(mySession)

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

func (*Comprehend) BatchDetectDominantLanguage

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

BatchDetectDominantLanguage API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) BatchDetectDominantLanguageRequest

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectDominantLanguageWithContext

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

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

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

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

func (*Comprehend) BatchDetectEntities

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

BatchDetectEntities API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) BatchDetectEntitiesRequest

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectEntitiesWithContext

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

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

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

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

func (*Comprehend) BatchDetectKeyPhrases

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

BatchDetectKeyPhrases API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) BatchDetectKeyPhrasesRequest

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectKeyPhrasesWithContext

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

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

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

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

func (*Comprehend) BatchDetectSentiment

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

BatchDetectSentiment API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) BatchDetectSentimentRequest

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectSentimentWithContext

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

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

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

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

func (*Comprehend) BatchDetectSyntax

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

BatchDetectSyntax API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) BatchDetectSyntaxRequest

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectSyntaxWithContext

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

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

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

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

func (*Comprehend) ClassifyDocument

func (c *Comprehend) ClassifyDocument(input *ClassifyDocumentInput) (*ClassifyDocumentOutput, error)

ClassifyDocument API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ClassifyDocumentRequest

func (c *Comprehend) ClassifyDocumentRequest(input *ClassifyDocumentInput) (req *request.Request, output *ClassifyDocumentOutput)

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

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

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

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

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

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

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

func (*Comprehend) ClassifyDocumentWithContext

func (c *Comprehend) ClassifyDocumentWithContext(ctx aws.Context, input *ClassifyDocumentInput, opts ...request.Option) (*ClassifyDocumentOutput, error)

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

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

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

func (*Comprehend) CreateDocumentClassifier

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

CreateDocumentClassifier API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ResourceInUseException
The specified resource name is already in use. Use a different name and try
your request again.

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

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* ResourceLimitExceededException
The maximum number of resources per account has been exceeded. Review the
resources, and then try your request again.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) CreateDocumentClassifierRequest

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

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

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

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

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

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

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

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

func (*Comprehend) CreateDocumentClassifierWithContext

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

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

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

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

func (*Comprehend) CreateEndpoint

func (c *Comprehend) CreateEndpoint(input *CreateEndpointInput) (*CreateEndpointOutput, error)

CreateEndpoint API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ResourceInUseException
The specified resource name is already in use. Use a different name and try
your request again.

* ResourceLimitExceededException
The maximum number of resources per account has been exceeded. Review the
resources, and then try your request again.

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

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) CreateEndpointRequest

func (c *Comprehend) CreateEndpointRequest(input *CreateEndpointInput) (req *request.Request, output *CreateEndpointOutput)

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

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

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

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

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

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

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

func (*Comprehend) CreateEndpointWithContext

func (c *Comprehend) CreateEndpointWithContext(ctx aws.Context, input *CreateEndpointInput, opts ...request.Option) (*CreateEndpointOutput, error)

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

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

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

func (*Comprehend) CreateEntityRecognizer

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

CreateEntityRecognizer API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ResourceInUseException
The specified resource name is already in use. Use a different name and try
your request again.

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

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* ResourceLimitExceededException
The maximum number of resources per account has been exceeded. Review the
resources, and then try your request again.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) CreateEntityRecognizerRequest

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

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

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

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

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

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

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

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

func (*Comprehend) CreateEntityRecognizerWithContext

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

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

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

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

func (*Comprehend) DeleteDocumentClassifier

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

DeleteDocumentClassifier API operation for Amazon Comprehend.

Deletes a previously created document classifier

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

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

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

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* ResourceInUseException
The specified resource name is already in use. Use a different name and try
your request again.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DeleteDocumentClassifierRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DeleteDocumentClassifierWithContext

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

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

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

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

func (*Comprehend) DeleteEndpoint

func (c *Comprehend) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)

DeleteEndpoint API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ResourceInUseException
The specified resource name is already in use. Use a different name and try
your request again.

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

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DeleteEndpointRequest

func (c *Comprehend) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)

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

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

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

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

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

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

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

func (*Comprehend) DeleteEndpointWithContext

func (c *Comprehend) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)

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

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

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

func (*Comprehend) DeleteEntityRecognizer

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

DeleteEntityRecognizer API operation for Amazon Comprehend.

Deletes an entity recognizer.

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

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

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

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* ResourceInUseException
The specified resource name is already in use. Use a different name and try
your request again.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DeleteEntityRecognizerRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DeleteEntityRecognizerWithContext

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

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

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

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

func (*Comprehend) DescribeDocumentClassificationJob

func (c *Comprehend) DescribeDocumentClassificationJob(input *DescribeDocumentClassificationJobInput) (*DescribeDocumentClassificationJobOutput, error)

DescribeDocumentClassificationJob API operation for Amazon Comprehend.

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeDocumentClassificationJobRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeDocumentClassificationJobWithContext

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

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

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

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

func (*Comprehend) DescribeDocumentClassifier

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

DescribeDocumentClassifier API operation for Amazon Comprehend.

Gets the properties associated with a document classifier.

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeDocumentClassifierRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeDocumentClassifierWithContext

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

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

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

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

func (*Comprehend) DescribeDominantLanguageDetectionJob

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

DescribeDominantLanguageDetectionJob API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeDominantLanguageDetectionJobRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeDominantLanguageDetectionJobWithContext

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

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

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

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

func (*Comprehend) DescribeEndpoint

func (c *Comprehend) DescribeEndpoint(input *DescribeEndpointInput) (*DescribeEndpointOutput, error)

DescribeEndpoint API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeEndpointRequest

func (c *Comprehend) DescribeEndpointRequest(input *DescribeEndpointInput) (req *request.Request, output *DescribeEndpointOutput)

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

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

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

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

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

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

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

func (*Comprehend) DescribeEndpointWithContext

func (c *Comprehend) DescribeEndpointWithContext(ctx aws.Context, input *DescribeEndpointInput, opts ...request.Option) (*DescribeEndpointOutput, error)

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

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

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

func (*Comprehend) DescribeEntitiesDetectionJob

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

DescribeEntitiesDetectionJob API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeEntitiesDetectionJobRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeEntitiesDetectionJobWithContext

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

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

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

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

func (*Comprehend) DescribeEntityRecognizer

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

DescribeEntityRecognizer API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

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

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeEntityRecognizerRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeEntityRecognizerWithContext

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

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

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

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

func (*Comprehend) DescribeKeyPhrasesDetectionJob

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

DescribeKeyPhrasesDetectionJob API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeKeyPhrasesDetectionJobRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeKeyPhrasesDetectionJobWithContext

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

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

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

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

func (*Comprehend) DescribePiiEntitiesDetectionJob

func (c *Comprehend) DescribePiiEntitiesDetectionJob(input *DescribePiiEntitiesDetectionJobInput) (*DescribePiiEntitiesDetectionJobOutput, error)

DescribePiiEntitiesDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribePiiEntitiesDetectionJobRequest

func (c *Comprehend) DescribePiiEntitiesDetectionJobRequest(input *DescribePiiEntitiesDetectionJobInput) (req *request.Request, output *DescribePiiEntitiesDetectionJobOutput)

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

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

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

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

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

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

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

func (*Comprehend) DescribePiiEntitiesDetectionJobWithContext

func (c *Comprehend) DescribePiiEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribePiiEntitiesDetectionJobInput, opts ...request.Option) (*DescribePiiEntitiesDetectionJobOutput, error)

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

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

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

func (*Comprehend) DescribeSentimentDetectionJob

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

DescribeSentimentDetectionJob API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeSentimentDetectionJobRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeSentimentDetectionJobWithContext

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

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

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

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

func (*Comprehend) DescribeTopicsDetectionJob

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

DescribeTopicsDetectionJob API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DescribeTopicsDetectionJobRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeTopicsDetectionJobWithContext

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

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

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

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

func (*Comprehend) DetectDominantLanguage

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

DetectDominantLanguage API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DetectDominantLanguageRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DetectDominantLanguageWithContext

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

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

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

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

func (*Comprehend) DetectEntities

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

DetectEntities API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DetectEntitiesRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DetectEntitiesWithContext

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

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

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

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

func (*Comprehend) DetectKeyPhrases

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

DetectKeyPhrases API operation for Amazon Comprehend.

Detects the key noun phrases found in the text.

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DetectKeyPhrasesRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DetectKeyPhrasesWithContext

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

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

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

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

func (*Comprehend) DetectPiiEntities

func (c *Comprehend) DetectPiiEntities(input *DetectPiiEntitiesInput) (*DetectPiiEntitiesOutput, error)

DetectPiiEntities API operation for Amazon Comprehend.

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DetectPiiEntitiesRequest

func (c *Comprehend) DetectPiiEntitiesRequest(input *DetectPiiEntitiesInput) (req *request.Request, output *DetectPiiEntitiesOutput)

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

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

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

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

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

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

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

func (*Comprehend) DetectPiiEntitiesWithContext

func (c *Comprehend) DetectPiiEntitiesWithContext(ctx aws.Context, input *DetectPiiEntitiesInput, opts ...request.Option) (*DetectPiiEntitiesOutput, error)

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

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

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

func (*Comprehend) DetectSentiment

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

DetectSentiment API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DetectSentimentRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DetectSentimentWithContext

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

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

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

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

func (*Comprehend) DetectSyntax

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

DetectSyntax API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TextSizeLimitExceededException
The size of the input text exceeds the limit. Use a smaller document.

* UnsupportedLanguageException
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish,
French, Italian, German, or Portuguese are accepted. For most other APIs,
such as those for Custom Classification, Amazon Comprehend accepts text in
all supported languages. For a list of supported languages, see supported-languages.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) DetectSyntaxRequest

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

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

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

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

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

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

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

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

func (*Comprehend) DetectSyntaxWithContext

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

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

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

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

func (*Comprehend) ListDocumentClassificationJobs

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

ListDocumentClassificationJobs API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListDocumentClassificationJobsPages

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

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

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

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

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

func (*Comprehend) ListDocumentClassificationJobsPagesWithContext

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

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

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

func (*Comprehend) ListDocumentClassificationJobsRequest

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

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

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

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

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

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

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

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

func (*Comprehend) ListDocumentClassificationJobsWithContext

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

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

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

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

func (*Comprehend) ListDocumentClassifiers

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

ListDocumentClassifiers API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListDocumentClassifiersPages

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

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

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

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

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

func (*Comprehend) ListDocumentClassifiersPagesWithContext

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

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

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

func (*Comprehend) ListDocumentClassifiersRequest

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

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

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

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

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

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

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

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

func (*Comprehend) ListDocumentClassifiersWithContext

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

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

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

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

func (*Comprehend) ListDominantLanguageDetectionJobs

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

ListDominantLanguageDetectionJobs API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListDominantLanguageDetectionJobsPages

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

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

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

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

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

func (*Comprehend) ListDominantLanguageDetectionJobsPagesWithContext

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

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

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

func (*Comprehend) ListDominantLanguageDetectionJobsRequest

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

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

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

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

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

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

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

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

func (*Comprehend) ListDominantLanguageDetectionJobsWithContext

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

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

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

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

func (*Comprehend) ListEndpoints

func (c *Comprehend) ListEndpoints(input *ListEndpointsInput) (*ListEndpointsOutput, error)

ListEndpoints API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListEndpointsRequest

func (c *Comprehend) ListEndpointsRequest(input *ListEndpointsInput) (req *request.Request, output *ListEndpointsOutput)

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

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

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

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

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

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

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

func (*Comprehend) ListEndpointsWithContext

func (c *Comprehend) ListEndpointsWithContext(ctx aws.Context, input *ListEndpointsInput, opts ...request.Option) (*ListEndpointsOutput, error)

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

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

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

func (*Comprehend) ListEntitiesDetectionJobs

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

ListEntitiesDetectionJobs API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListEntitiesDetectionJobsPages

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

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

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

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

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

func (*Comprehend) ListEntitiesDetectionJobsPagesWithContext

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

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

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

func (*Comprehend) ListEntitiesDetectionJobsRequest

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

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

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

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

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

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

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

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

func (*Comprehend) ListEntitiesDetectionJobsWithContext

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

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

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

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

func (*Comprehend) ListEntityRecognizers

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

ListEntityRecognizers API operation for Amazon Comprehend.

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

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListEntityRecognizersPages

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

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

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

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

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

func (*Comprehend) ListEntityRecognizersPagesWithContext

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

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

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

func (*Comprehend) ListEntityRecognizersRequest

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

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

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

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

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

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

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

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

func (*Comprehend) ListEntityRecognizersWithContext

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

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

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

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

func (*Comprehend) ListKeyPhrasesDetectionJobs

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

ListKeyPhrasesDetectionJobs API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListKeyPhrasesDetectionJobsPages

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

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

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

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

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

func (*Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext

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

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

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

func (*Comprehend) ListKeyPhrasesDetectionJobsRequest

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

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

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

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

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

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

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

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

func (*Comprehend) ListKeyPhrasesDetectionJobsWithContext

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

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

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

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

func (*Comprehend) ListPiiEntitiesDetectionJobs

func (c *Comprehend) ListPiiEntitiesDetectionJobs(input *ListPiiEntitiesDetectionJobsInput) (*ListPiiEntitiesDetectionJobsOutput, error)

ListPiiEntitiesDetectionJobs API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

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

func (*Comprehend) ListPiiEntitiesDetectionJobsRequest

func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesDetectionJobsInput) (req *request.Request, output *ListPiiEntitiesDetectionJobsOutput)

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

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

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

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

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

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

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

func (*Comprehend) ListPiiEntitiesDetectionJobsWithContext

func (c *Comprehend) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, opts ...request.Option) (*ListPiiEntitiesDetectionJobsOutput, error)

ListPiiEntitiesDetectionJobsWithContext is the same as ListPiiEntitiesDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListPiiEntitiesDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListSentimentDetectionJobs

func (c *Comprehend) ListSentimentDetectionJobs(input *ListSentimentDetectionJobsInput) (*ListSentimentDetectionJobsOutput, error)

ListSentimentDetectionJobs API operation for Amazon Comprehend.

Gets a list of sentiment detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListSentimentDetectionJobs for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs

func (*Comprehend) ListSentimentDetectionJobsPages

func (c *Comprehend) ListSentimentDetectionJobsPages(input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool) error

ListSentimentDetectionJobsPages iterates over the pages of a ListSentimentDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSentimentDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSentimentDetectionJobs operation.
pageNum := 0
err := client.ListSentimentDetectionJobsPages(params,
    func(page *comprehend.ListSentimentDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListSentimentDetectionJobsPagesWithContext

func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListSentimentDetectionJobsPagesWithContext same as ListSentimentDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListSentimentDetectionJobsRequest

func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) (req *request.Request, output *ListSentimentDetectionJobsOutput)

ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListSentimentDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSentimentDetectionJobs for more information on using the ListSentimentDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSentimentDetectionJobsRequest method.
req, resp := client.ListSentimentDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs

func (*Comprehend) ListSentimentDetectionJobsWithContext

func (c *Comprehend) ListSentimentDetectionJobsWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, opts ...request.Option) (*ListSentimentDetectionJobsOutput, error)

ListSentimentDetectionJobsWithContext is the same as ListSentimentDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListSentimentDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTagsForResource

func (c *Comprehend) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Comprehend.

Lists all tags associated with a given Amazon Comprehend resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListTagsForResource for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource

func (*Comprehend) ListTagsForResourceRequest

func (c *Comprehend) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource

func (*Comprehend) ListTagsForResourceWithContext

func (c *Comprehend) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTopicsDetectionJobs

func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error)

ListTopicsDetectionJobs API operation for Amazon Comprehend.

Gets a list of the topic detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListTopicsDetectionJobs for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* InvalidFilterException
The filter specified for the operation is invalid. Specify a different filter.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs

func (*Comprehend) ListTopicsDetectionJobsPages

func (c *Comprehend) ListTopicsDetectionJobsPages(input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool) error

ListTopicsDetectionJobsPages iterates over the pages of a ListTopicsDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTopicsDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTopicsDetectionJobs operation.
pageNum := 0
err := client.ListTopicsDetectionJobsPages(params,
    func(page *comprehend.ListTopicsDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListTopicsDetectionJobsPagesWithContext

func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListTopicsDetectionJobsPagesWithContext same as ListTopicsDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTopicsDetectionJobsRequest

func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput)

ListTopicsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTopicsDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTopicsDetectionJobs for more information on using the ListTopicsDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTopicsDetectionJobsRequest method.
req, resp := client.ListTopicsDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs

func (*Comprehend) ListTopicsDetectionJobsWithContext

func (c *Comprehend) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error)

ListTopicsDetectionJobsWithContext is the same as ListTopicsDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListTopicsDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartDocumentClassificationJob

func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error)

StartDocumentClassificationJob API operation for Amazon Comprehend.

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartDocumentClassificationJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* KmsKeyValidationException
The KMS customer managed key (CMK) entered cannot be validated. Verify the
key and re-enter it.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob

func (*Comprehend) StartDocumentClassificationJobRequest

func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) (req *request.Request, output *StartDocumentClassificationJobOutput)

StartDocumentClassificationJobRequest generates a "aws/request.Request" representing the client's request for the StartDocumentClassificationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDocumentClassificationJob for more information on using the StartDocumentClassificationJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDocumentClassificationJobRequest method.
req, resp := client.StartDocumentClassificationJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob

func (*Comprehend) StartDocumentClassificationJobWithContext

func (c *Comprehend) StartDocumentClassificationJobWithContext(ctx aws.Context, input *StartDocumentClassificationJobInput, opts ...request.Option) (*StartDocumentClassificationJobOutput, error)

StartDocumentClassificationJobWithContext is the same as StartDocumentClassificationJob with the addition of the ability to pass a context and additional request options.

See StartDocumentClassificationJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartDominantLanguageDetectionJob

func (c *Comprehend) StartDominantLanguageDetectionJob(input *StartDominantLanguageDetectionJobInput) (*StartDominantLanguageDetectionJobOutput, error)

StartDominantLanguageDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartDominantLanguageDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* KmsKeyValidationException
The KMS customer managed key (CMK) entered cannot be validated. Verify the
key and re-enter it.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob

func (*Comprehend) StartDominantLanguageDetectionJobRequest

func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) (req *request.Request, output *StartDominantLanguageDetectionJobOutput)

StartDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDominantLanguageDetectionJob for more information on using the StartDominantLanguageDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartDominantLanguageDetectionJobRequest method.
req, resp := client.StartDominantLanguageDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob

func (*Comprehend) StartDominantLanguageDetectionJobWithContext

func (c *Comprehend) StartDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StartDominantLanguageDetectionJobInput, opts ...request.Option) (*StartDominantLanguageDetectionJobOutput, error)

StartDominantLanguageDetectionJobWithContext is the same as StartDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.

See StartDominantLanguageDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartEntitiesDetectionJob

func (c *Comprehend) StartEntitiesDetectionJob(input *StartEntitiesDetectionJobInput) (*StartEntitiesDetectionJobOutput, error)

StartEntitiesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartEntitiesDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* KmsKeyValidationException
The KMS customer managed key (CMK) entered cannot be validated. Verify the
key and re-enter it.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob

func (*Comprehend) StartEntitiesDetectionJobRequest

func (c *Comprehend) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) (req *request.Request, output *StartEntitiesDetectionJobOutput)

StartEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartEntitiesDetectionJob for more information on using the StartEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartEntitiesDetectionJobRequest method.
req, resp := client.StartEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob

func (*Comprehend) StartEntitiesDetectionJobWithContext

func (c *Comprehend) StartEntitiesDetectionJobWithContext(ctx aws.Context, input *StartEntitiesDetectionJobInput, opts ...request.Option) (*StartEntitiesDetectionJobOutput, error)

StartEntitiesDetectionJobWithContext is the same as StartEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StartEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartKeyPhrasesDetectionJob

func (c *Comprehend) StartKeyPhrasesDetectionJob(input *StartKeyPhrasesDetectionJobInput) (*StartKeyPhrasesDetectionJobOutput, error)

StartKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartKeyPhrasesDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* KmsKeyValidationException
The KMS customer managed key (CMK) entered cannot be validated. Verify the
key and re-enter it.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob

func (*Comprehend) StartKeyPhrasesDetectionJobRequest

func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) (req *request.Request, output *StartKeyPhrasesDetectionJobOutput)

StartKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartKeyPhrasesDetectionJob for more information on using the StartKeyPhrasesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartKeyPhrasesDetectionJobRequest method.
req, resp := client.StartKeyPhrasesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob

func (*Comprehend) StartKeyPhrasesDetectionJobWithContext

func (c *Comprehend) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StartKeyPhrasesDetectionJobInput, opts ...request.Option) (*StartKeyPhrasesDetectionJobOutput, error)

StartKeyPhrasesDetectionJobWithContext is the same as StartKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.

See StartKeyPhrasesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartPiiEntitiesDetectionJob

func (c *Comprehend) StartPiiEntitiesDetectionJob(input *StartPiiEntitiesDetectionJobInput) (*StartPiiEntitiesDetectionJobOutput, error)

StartPiiEntitiesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous PII entity detection job for a collection of documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartPiiEntitiesDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* KmsKeyValidationException
The KMS customer managed key (CMK) entered cannot be validated. Verify the
key and re-enter it.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob

func (*Comprehend) StartPiiEntitiesDetectionJobRequest

func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntitiesDetectionJobInput) (req *request.Request, output *StartPiiEntitiesDetectionJobOutput)

StartPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartPiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartPiiEntitiesDetectionJob for more information on using the StartPiiEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartPiiEntitiesDetectionJobRequest method.
req, resp := client.StartPiiEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob

func (*Comprehend) StartPiiEntitiesDetectionJobWithContext

func (c *Comprehend) StartPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StartPiiEntitiesDetectionJobInput, opts ...request.Option) (*StartPiiEntitiesDetectionJobOutput, error)

StartPiiEntitiesDetectionJobWithContext is the same as StartPiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StartPiiEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartSentimentDetectionJob

func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error)

StartSentimentDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartSentimentDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* KmsKeyValidationException
The KMS customer managed key (CMK) entered cannot be validated. Verify the
key and re-enter it.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob

func (*Comprehend) StartSentimentDetectionJobRequest

func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput)

StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartSentimentDetectionJobRequest method.
req, resp := client.StartSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob

func (*Comprehend) StartSentimentDetectionJobWithContext

func (c *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error)

StartSentimentDetectionJobWithContext is the same as StartSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See StartSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartTopicsDetectionJob

func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error)

StartTopicsDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartTopicsDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* KmsKeyValidationException
The KMS customer managed key (CMK) entered cannot be validated. Verify the
key and re-enter it.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob

func (*Comprehend) StartTopicsDetectionJobRequest

func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput)

StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartTopicsDetectionJobRequest method.
req, resp := client.StartTopicsDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob

func (*Comprehend) StartTopicsDetectionJobWithContext

func (c *Comprehend) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error)

StartTopicsDetectionJobWithContext is the same as StartTopicsDetectionJob with the addition of the ability to pass a context and additional request options.

See StartTopicsDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopDominantLanguageDetectionJob

func (c *Comprehend) StopDominantLanguageDetectionJob(input *StopDominantLanguageDetectionJobInput) (*StopDominantLanguageDetectionJobOutput, error)

StopDominantLanguageDetectionJob API operation for Amazon Comprehend.

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopDominantLanguageDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob

func (*Comprehend) StopDominantLanguageDetectionJobRequest

func (c *Comprehend) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) (req *request.Request, output *StopDominantLanguageDetectionJobOutput)

StopDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopDominantLanguageDetectionJob for more information on using the StopDominantLanguageDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopDominantLanguageDetectionJobRequest method.
req, resp := client.StopDominantLanguageDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob

func (*Comprehend) StopDominantLanguageDetectionJobWithContext

func (c *Comprehend) StopDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StopDominantLanguageDetectionJobInput, opts ...request.Option) (*StopDominantLanguageDetectionJobOutput, error)

StopDominantLanguageDetectionJobWithContext is the same as StopDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.

See StopDominantLanguageDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopEntitiesDetectionJob

func (c *Comprehend) StopEntitiesDetectionJob(input *StopEntitiesDetectionJobInput) (*StopEntitiesDetectionJobOutput, error)

StopEntitiesDetectionJob API operation for Amazon Comprehend.

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopEntitiesDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob

func (*Comprehend) StopEntitiesDetectionJobRequest

func (c *Comprehend) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) (req *request.Request, output *StopEntitiesDetectionJobOutput)

StopEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopEntitiesDetectionJob for more information on using the StopEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopEntitiesDetectionJobRequest method.
req, resp := client.StopEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob

func (*Comprehend) StopEntitiesDetectionJobWithContext

func (c *Comprehend) StopEntitiesDetectionJobWithContext(ctx aws.Context, input *StopEntitiesDetectionJobInput, opts ...request.Option) (*StopEntitiesDetectionJobOutput, error)

StopEntitiesDetectionJobWithContext is the same as StopEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StopEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopKeyPhrasesDetectionJob

func (c *Comprehend) StopKeyPhrasesDetectionJob(input *StopKeyPhrasesDetectionJobInput) (*StopKeyPhrasesDetectionJobOutput, error)

StopKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopKeyPhrasesDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob

func (*Comprehend) StopKeyPhrasesDetectionJobRequest

func (c *Comprehend) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) (req *request.Request, output *StopKeyPhrasesDetectionJobOutput)

StopKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopKeyPhrasesDetectionJob for more information on using the StopKeyPhrasesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopKeyPhrasesDetectionJobRequest method.
req, resp := client.StopKeyPhrasesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob

func (*Comprehend) StopKeyPhrasesDetectionJobWithContext

func (c *Comprehend) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StopKeyPhrasesDetectionJobInput, opts ...request.Option) (*StopKeyPhrasesDetectionJobOutput, error)

StopKeyPhrasesDetectionJobWithContext is the same as StopKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.

See StopKeyPhrasesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopPiiEntitiesDetectionJob

func (c *Comprehend) StopPiiEntitiesDetectionJob(input *StopPiiEntitiesDetectionJobInput) (*StopPiiEntitiesDetectionJobOutput, error)

StopPiiEntitiesDetectionJob API operation for Amazon Comprehend.

Stops a PII entities detection job in progress.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopPiiEntitiesDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob

func (*Comprehend) StopPiiEntitiesDetectionJobRequest

func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDetectionJobInput) (req *request.Request, output *StopPiiEntitiesDetectionJobOutput)

StopPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopPiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopPiiEntitiesDetectionJob for more information on using the StopPiiEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopPiiEntitiesDetectionJobRequest method.
req, resp := client.StopPiiEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob

func (*Comprehend) StopPiiEntitiesDetectionJobWithContext

func (c *Comprehend) StopPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StopPiiEntitiesDetectionJobInput, opts ...request.Option) (*StopPiiEntitiesDetectionJobOutput, error)

StopPiiEntitiesDetectionJobWithContext is the same as StopPiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StopPiiEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopSentimentDetectionJob

func (c *Comprehend) StopSentimentDetectionJob(input *StopSentimentDetectionJobInput) (*StopSentimentDetectionJobOutput, error)

StopSentimentDetectionJob API operation for Amazon Comprehend.

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopSentimentDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* JobNotFoundException
The specified job was not found. Check the job ID and try again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob

func (*Comprehend) StopSentimentDetectionJobRequest

func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) (req *request.Request, output *StopSentimentDetectionJobOutput)

StopSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopSentimentDetectionJob for more information on using the StopSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopSentimentDetectionJobRequest method.
req, resp := client.StopSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob

func (*Comprehend) StopSentimentDetectionJobWithContext

func (c *Comprehend) StopSentimentDetectionJobWithContext(ctx aws.Context, input *StopSentimentDetectionJobInput, opts ...request.Option) (*StopSentimentDetectionJobOutput, error)

StopSentimentDetectionJobWithContext is the same as StopSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See StopSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopTrainingDocumentClassifier

func (c *Comprehend) StopTrainingDocumentClassifier(input *StopTrainingDocumentClassifierInput) (*StopTrainingDocumentClassifierOutput, error)

StopTrainingDocumentClassifier API operation for Amazon Comprehend.

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopTrainingDocumentClassifier for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier

func (*Comprehend) StopTrainingDocumentClassifierRequest

func (c *Comprehend) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) (req *request.Request, output *StopTrainingDocumentClassifierOutput)

StopTrainingDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the StopTrainingDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopTrainingDocumentClassifier for more information on using the StopTrainingDocumentClassifier API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopTrainingDocumentClassifierRequest method.
req, resp := client.StopTrainingDocumentClassifierRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier

func (*Comprehend) StopTrainingDocumentClassifierWithContext

func (c *Comprehend) StopTrainingDocumentClassifierWithContext(ctx aws.Context, input *StopTrainingDocumentClassifierInput, opts ...request.Option) (*StopTrainingDocumentClassifierOutput, error)

StopTrainingDocumentClassifierWithContext is the same as StopTrainingDocumentClassifier with the addition of the ability to pass a context and additional request options.

See StopTrainingDocumentClassifier for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopTrainingEntityRecognizer

func (c *Comprehend) StopTrainingEntityRecognizer(input *StopTrainingEntityRecognizerInput) (*StopTrainingEntityRecognizerOutput, error)

StopTrainingEntityRecognizer API operation for Amazon Comprehend.

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopTrainingEntityRecognizer for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer

func (*Comprehend) StopTrainingEntityRecognizerRequest

func (c *Comprehend) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) (req *request.Request, output *StopTrainingEntityRecognizerOutput)

StopTrainingEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the StopTrainingEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopTrainingEntityRecognizer for more information on using the StopTrainingEntityRecognizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopTrainingEntityRecognizerRequest method.
req, resp := client.StopTrainingEntityRecognizerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer

func (*Comprehend) StopTrainingEntityRecognizerWithContext

func (c *Comprehend) StopTrainingEntityRecognizerWithContext(ctx aws.Context, input *StopTrainingEntityRecognizerInput, opts ...request.Option) (*StopTrainingEntityRecognizerOutput, error)

StopTrainingEntityRecognizerWithContext is the same as StopTrainingEntityRecognizer with the addition of the ability to pass a context and additional request options.

See StopTrainingEntityRecognizer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) TagResource

func (c *Comprehend) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Comprehend.

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation TagResource for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* ConcurrentModificationException
Concurrent modification of the tags associated with an Amazon Comprehend
resource is not supported.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* 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.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResource

func (*Comprehend) TagResourceRequest

func (c *Comprehend) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResource

func (*Comprehend) TagResourceWithContext

func (c *Comprehend) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) UntagResource

func (c *Comprehend) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Comprehend.

Removes a specific tag associated with an Amazon Comprehend resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation UntagResource for usage and error information.

Returned Error Types:

* TooManyTagKeysException
The request contains more tag keys than can be associated with a resource
(50 tag keys per resource).

* InvalidRequestException
The request is invalid.

* ConcurrentModificationException
Concurrent modification of the tags associated with an Amazon Comprehend
resource is not supported.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResource

func (*Comprehend) UntagResourceRequest

func (c *Comprehend) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResource

func (*Comprehend) UntagResourceWithContext

func (c *Comprehend) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) UpdateEndpoint

func (c *Comprehend) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error)

UpdateEndpoint API operation for Amazon Comprehend.

Updates information about the specified endpoint.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation UpdateEndpoint for usage and error information.

Returned Error Types:

* InvalidRequestException
The request is invalid.

* TooManyRequestsException
The number of requests exceeds the limit. Resubmit your request later.

* ResourceInUseException
The specified resource name is already in use. Use a different name and try
your request again.

* ResourceLimitExceededException
The maximum number of resources per account has been exceeded. Review the
resources, and then try your request again.

* ResourceNotFoundException
The specified resource ARN was not found. Check the ARN and try your request
again.

* ResourceUnavailableException
The specified resource is not available. Check the resource and try your
request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint

func (*Comprehend) UpdateEndpointRequest

func (c *Comprehend) UpdateEndpointRequest(input *UpdateEndpointInput) (req *request.Request, output *UpdateEndpointOutput)

UpdateEndpointRequest generates a "aws/request.Request" representing the client's request for the UpdateEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEndpoint for more information on using the UpdateEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateEndpointRequest method.
req, resp := client.UpdateEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint

func (*Comprehend) UpdateEndpointWithContext

func (c *Comprehend) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error)

UpdateEndpointWithContext is the same as UpdateEndpoint with the addition of the ability to pass a context and additional request options.

See UpdateEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ConcurrentModificationException

type ConcurrentModificationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

func (*ConcurrentModificationException) Code

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation

func (*ConcurrentModificationException) Message

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String

func (s ConcurrentModificationException) String() string

String returns the string representation

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 any of the following
    // languages supported by Amazon Comprehend: German ("de"), English ("en"),
    // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All
    // documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // Indicates the mode in which the classifier will be trained. The classifier
    // can be trained in multi-class mode, which identifies one and only one class
    // for each document, or multi-label mode, which identifies one or more labels
    // for each document. In multi-label mode, multiple labels for an individual
    // document are separated by a delimiter. The default delimiter between labels
    // is a pipe (|).
    Mode *string `type:"string" enum:"DocumentClassifierMode"`

    // Enables the addition of output results configuration parameters for custom
    // classifier jobs.
    OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

    // Tags to be associated with the document classifier being created. A tag is
    // a key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
    // For example, a tag with "Sales" as the key might be added to a resource to
    // indicate its use by the sales department.
    Tags []*Tag `type:"list"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for an optional private Virtual Private Cloud (VPC)
    // containing the resources you are using for your custom classifier. For more
    // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateDocumentClassifierInput) GoString

func (s CreateDocumentClassifierInput) GoString() string

GoString returns the string representation

func (*CreateDocumentClassifierInput) SetClientRequestToken

func (s *CreateDocumentClassifierInput) SetClientRequestToken(v string) *CreateDocumentClassifierInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDocumentClassifierInput) SetDataAccessRoleArn

func (s *CreateDocumentClassifierInput) SetDataAccessRoleArn(v string) *CreateDocumentClassifierInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateDocumentClassifierInput) SetDocumentClassifierName

func (s *CreateDocumentClassifierInput) SetDocumentClassifierName(v string) *CreateDocumentClassifierInput

SetDocumentClassifierName sets the DocumentClassifierName field's value.

func (*CreateDocumentClassifierInput) SetInputDataConfig

func (s *CreateDocumentClassifierInput) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *CreateDocumentClassifierInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetLanguageCode

func (s *CreateDocumentClassifierInput) SetLanguageCode(v string) *CreateDocumentClassifierInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateDocumentClassifierInput) SetMode

func (s *CreateDocumentClassifierInput) SetMode(v string) *CreateDocumentClassifierInput

SetMode sets the Mode field's value.

func (*CreateDocumentClassifierInput) SetOutputDataConfig

func (s *CreateDocumentClassifierInput) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *CreateDocumentClassifierInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetTags

func (s *CreateDocumentClassifierInput) SetTags(v []*Tag) *CreateDocumentClassifierInput

SetTags sets the Tags field's value.

func (*CreateDocumentClassifierInput) SetVolumeKmsKeyId

func (s *CreateDocumentClassifierInput) SetVolumeKmsKeyId(v string) *CreateDocumentClassifierInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateDocumentClassifierInput) SetVpcConfig

func (s *CreateDocumentClassifierInput) SetVpcConfig(v *VpcConfig) *CreateDocumentClassifierInput

SetVpcConfig sets the VpcConfig field's value.

func (CreateDocumentClassifierInput) String

func (s CreateDocumentClassifierInput) String() 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
}

func (CreateDocumentClassifierOutput) GoString

func (s CreateDocumentClassifierOutput) GoString() string

GoString returns the string representation

func (*CreateDocumentClassifierOutput) SetDocumentClassifierArn

func (s *CreateDocumentClassifierOutput) SetDocumentClassifierArn(v string) *CreateDocumentClassifierOutput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (CreateDocumentClassifierOutput) String

func (s CreateDocumentClassifierOutput) String() string

String returns the string representation

type CreateEndpointInput

type CreateEndpointInput struct {

    // An idempotency token provided by the customer. If this token matches a previous
    // endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The desired number of inference units to be used by the model using this
    // endpoint. Each inference unit represents of a throughput of 100 characters
    // per second.
    //
    // DesiredInferenceUnits is a required field
    DesiredInferenceUnits *int64 `min:"1" type:"integer" required:"true"`

    // This is the descriptive suffix that becomes part of the EndpointArn used
    // for all subsequent requests to this resource.
    //
    // EndpointName is a required field
    EndpointName *string `type:"string" required:"true"`

    // The Amazon Resource Number (ARN) of the model to which the endpoint will
    // be attached.
    //
    // ModelArn is a required field
    ModelArn *string `type:"string" required:"true"`

    // Tags associated with the endpoint being created. A tag is a key-value pair
    // that adds metadata to the endpoint. For example, a tag with "Sales" as the
    // key might be added to an endpoint to indicate its use by the sales department.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateEndpointInput) GoString

func (s CreateEndpointInput) GoString() string

GoString returns the string representation

func (*CreateEndpointInput) SetClientRequestToken

func (s *CreateEndpointInput) SetClientRequestToken(v string) *CreateEndpointInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEndpointInput) SetDesiredInferenceUnits

func (s *CreateEndpointInput) SetDesiredInferenceUnits(v int64) *CreateEndpointInput

SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value.

func (*CreateEndpointInput) SetEndpointName

func (s *CreateEndpointInput) SetEndpointName(v string) *CreateEndpointInput

SetEndpointName sets the EndpointName field's value.

func (*CreateEndpointInput) SetModelArn

func (s *CreateEndpointInput) SetModelArn(v string) *CreateEndpointInput

SetModelArn sets the ModelArn field's value.

func (*CreateEndpointInput) SetTags

func (s *CreateEndpointInput) SetTags(v []*Tag) *CreateEndpointInput

SetTags sets the Tags field's value.

func (CreateEndpointInput) String

func (s CreateEndpointInput) String() string

String returns the string representation

func (*CreateEndpointInput) Validate

func (s *CreateEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEndpointOutput

type CreateEndpointOutput struct {

    // The Amazon Resource Number (ARN) of the endpoint being created.
    EndpointArn *string `type:"string"`
    // contains filtered or unexported fields
}

func (CreateEndpointOutput) GoString

func (s CreateEndpointOutput) GoString() string

GoString returns the string representation

func (*CreateEndpointOutput) SetEndpointArn

func (s *CreateEndpointOutput) SetEndpointArn(v string) *CreateEndpointOutput

SetEndpointArn sets the EndpointArn field's value.

func (CreateEndpointOutput) String

func (s CreateEndpointOutput) String() string

String returns the string representation

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"`

    // You can specify any of the following languages supported by Amazon Comprehend:
    // English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"),
    // or Portuguese ("pt"). All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // The name given to the newly created recognizer. Recognizer names can be a
    // maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
    // (_) are allowed. The name must be unique in the account/region.
    //
    // RecognizerName is a required field
    RecognizerName *string `type:"string" required:"true"`

    // Tags to be associated with the entity recognizer being created. A tag is
    // a key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
    // For example, a tag with "Sales" as the key might be added to a resource to
    // indicate its use by the sales department.
    Tags []*Tag `type:"list"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for an optional private Virtual Private Cloud (VPC)
    // containing the resources you are using for your custom entity recognizer.
    // For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateEntityRecognizerInput) GoString

func (s CreateEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*CreateEntityRecognizerInput) SetClientRequestToken

func (s *CreateEntityRecognizerInput) SetClientRequestToken(v string) *CreateEntityRecognizerInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEntityRecognizerInput) SetDataAccessRoleArn

func (s *CreateEntityRecognizerInput) SetDataAccessRoleArn(v string) *CreateEntityRecognizerInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateEntityRecognizerInput) SetInputDataConfig

func (s *CreateEntityRecognizerInput) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *CreateEntityRecognizerInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateEntityRecognizerInput) SetLanguageCode

func (s *CreateEntityRecognizerInput) SetLanguageCode(v string) *CreateEntityRecognizerInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateEntityRecognizerInput) SetRecognizerName

func (s *CreateEntityRecognizerInput) SetRecognizerName(v string) *CreateEntityRecognizerInput

SetRecognizerName sets the RecognizerName field's value.

func (*CreateEntityRecognizerInput) SetTags

func (s *CreateEntityRecognizerInput) SetTags(v []*Tag) *CreateEntityRecognizerInput

SetTags sets the Tags field's value.

func (*CreateEntityRecognizerInput) SetVolumeKmsKeyId

func (s *CreateEntityRecognizerInput) SetVolumeKmsKeyId(v string) *CreateEntityRecognizerInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateEntityRecognizerInput) SetVpcConfig

func (s *CreateEntityRecognizerInput) SetVpcConfig(v *VpcConfig) *CreateEntityRecognizerInput

SetVpcConfig sets the VpcConfig field's value.

func (CreateEntityRecognizerInput) String

func (s CreateEntityRecognizerInput) String() 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
}

func (CreateEntityRecognizerOutput) GoString

func (s CreateEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (*CreateEntityRecognizerOutput) SetEntityRecognizerArn

func (s *CreateEntityRecognizerOutput) SetEntityRecognizerArn(v string) *CreateEntityRecognizerOutput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (CreateEntityRecognizerOutput) String

func (s CreateEntityRecognizerOutput) String() string

String returns the string representation

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
}

func (DeleteDocumentClassifierInput) GoString

func (s DeleteDocumentClassifierInput) GoString() string

GoString returns the string representation

func (*DeleteDocumentClassifierInput) SetDocumentClassifierArn

func (s *DeleteDocumentClassifierInput) SetDocumentClassifierArn(v string) *DeleteDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DeleteDocumentClassifierInput) String

func (s DeleteDocumentClassifierInput) String() 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
}

func (DeleteDocumentClassifierOutput) GoString

func (s DeleteDocumentClassifierOutput) GoString() string

GoString returns the string representation

func (DeleteDocumentClassifierOutput) String

func (s DeleteDocumentClassifierOutput) String() string

String returns the string representation

type DeleteEndpointInput

type DeleteEndpointInput struct {

    // The Amazon Resource Number (ARN) of the endpoint being deleted.
    //
    // EndpointArn is a required field
    EndpointArn *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteEndpointInput) GoString

func (s DeleteEndpointInput) GoString() string

GoString returns the string representation

func (*DeleteEndpointInput) SetEndpointArn

func (s *DeleteEndpointInput) SetEndpointArn(v string) *DeleteEndpointInput

SetEndpointArn sets the EndpointArn field's value.

func (DeleteEndpointInput) String

func (s DeleteEndpointInput) String() string

String returns the string representation

func (*DeleteEndpointInput) Validate

func (s *DeleteEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEndpointOutput

type DeleteEndpointOutput struct {
    // contains filtered or unexported fields
}

func (DeleteEndpointOutput) GoString

func (s DeleteEndpointOutput) GoString() string

GoString returns the string representation

func (DeleteEndpointOutput) String

func (s DeleteEndpointOutput) String() string

String returns the string representation

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
}

func (DeleteEntityRecognizerInput) GoString

func (s DeleteEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*DeleteEntityRecognizerInput) SetEntityRecognizerArn

func (s *DeleteEntityRecognizerInput) SetEntityRecognizerArn(v string) *DeleteEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DeleteEntityRecognizerInput) String

func (s DeleteEntityRecognizerInput) String() 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
}

func (DeleteEntityRecognizerOutput) GoString

func (s DeleteEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (DeleteEntityRecognizerOutput) String

func (s DeleteEntityRecognizerOutput) String() string

String returns the string representation

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
}

func (DescribeDocumentClassificationJobInput) GoString

func (s DescribeDocumentClassificationJobInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassificationJobInput) SetJobId

func (s *DescribeDocumentClassificationJobInput) SetJobId(v string) *DescribeDocumentClassificationJobInput

SetJobId sets the JobId field's value.

func (DescribeDocumentClassificationJobInput) String

func (s DescribeDocumentClassificationJobInput) String() string

String returns the string representation

func (*DescribeDocumentClassificationJobInput) Validate

func (s *DescribeDocumentClassificationJobInput) Validate() error

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
}

func (DescribeDocumentClassificationJobOutput) GoString

func (s DescribeDocumentClassificationJobOutput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties

func (s *DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties(v *DocumentClassificationJobProperties) *DescribeDocumentClassificationJobOutput

SetDocumentClassificationJobProperties sets the DocumentClassificationJobProperties field's value.

func (DescribeDocumentClassificationJobOutput) String

func (s DescribeDocumentClassificationJobOutput) String() string

String returns the string representation

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
}

func (DescribeDocumentClassifierInput) GoString

func (s DescribeDocumentClassifierInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassifierInput) SetDocumentClassifierArn

func (s *DescribeDocumentClassifierInput) SetDocumentClassifierArn(v string) *DescribeDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DescribeDocumentClassifierInput) String

func (s DescribeDocumentClassifierInput) String() 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
}

func (DescribeDocumentClassifierOutput) GoString

func (s DescribeDocumentClassifierOutput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassifierOutput) SetDocumentClassifierProperties

func (s *DescribeDocumentClassifierOutput) SetDocumentClassifierProperties(v *DocumentClassifierProperties) *DescribeDocumentClassifierOutput

SetDocumentClassifierProperties sets the DocumentClassifierProperties field's value.

func (DescribeDocumentClassifierOutput) String

func (s DescribeDocumentClassifierOutput) String() string

String returns the string representation

type DescribeDominantLanguageDetectionJobInput

type DescribeDominantLanguageDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeDominantLanguageDetectionJobInput) GoString

func (s DescribeDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) SetJobId

func (s *DescribeDominantLanguageDetectionJobInput) SetJobId(v string) *DescribeDominantLanguageDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeDominantLanguageDetectionJobInput) String

func (s DescribeDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) Validate

func (s *DescribeDominantLanguageDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDominantLanguageDetectionJobOutput

type DescribeDominantLanguageDetectionJobOutput struct {

    // An object that contains the properties associated with a dominant language
    // detection job.
    DominantLanguageDetectionJobProperties *DominantLanguageDetectionJobProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeDominantLanguageDetectionJobOutput) GoString

func (s DescribeDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties

func (s *DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties(v *DominantLanguageDetectionJobProperties) *DescribeDominantLanguageDetectionJobOutput

SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value.

func (DescribeDominantLanguageDetectionJobOutput) String

func (s DescribeDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type DescribeEndpointInput

type DescribeEndpointInput struct {

    // The Amazon Resource Number (ARN) of the endpoint being described.
    //
    // EndpointArn is a required field
    EndpointArn *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeEndpointInput) GoString

func (s DescribeEndpointInput) GoString() string

GoString returns the string representation

func (*DescribeEndpointInput) SetEndpointArn

func (s *DescribeEndpointInput) SetEndpointArn(v string) *DescribeEndpointInput

SetEndpointArn sets the EndpointArn field's value.

func (DescribeEndpointInput) String

func (s DescribeEndpointInput) String() string

String returns the string representation

func (*DescribeEndpointInput) Validate

func (s *DescribeEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEndpointOutput

type DescribeEndpointOutput struct {

    // Describes information associated with the specific endpoint.
    EndpointProperties *EndpointProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeEndpointOutput) GoString

func (s DescribeEndpointOutput) GoString() string

GoString returns the string representation

func (*DescribeEndpointOutput) SetEndpointProperties

func (s *DescribeEndpointOutput) SetEndpointProperties(v *EndpointProperties) *DescribeEndpointOutput

SetEndpointProperties sets the EndpointProperties field's value.

func (DescribeEndpointOutput) String

func (s DescribeEndpointOutput) String() string

String returns the string representation

type DescribeEntitiesDetectionJobInput

type DescribeEntitiesDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeEntitiesDetectionJobInput) GoString

func (s DescribeEntitiesDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionJobInput) SetJobId

func (s *DescribeEntitiesDetectionJobInput) SetJobId(v string) *DescribeEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionJobInput) String

func (s DescribeEntitiesDetectionJobInput) String() string

String returns the string representation

func (*DescribeEntitiesDetectionJobInput) Validate

func (s *DescribeEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEntitiesDetectionJobOutput

type DescribeEntitiesDetectionJobOutput struct {

    // An object that contains the properties associated with an entities detection
    // job.
    EntitiesDetectionJobProperties *EntitiesDetectionJobProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeEntitiesDetectionJobOutput) GoString

func (s DescribeEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties

func (s *DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties(v *EntitiesDetectionJobProperties) *DescribeEntitiesDetectionJobOutput

SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value.

func (DescribeEntitiesDetectionJobOutput) String

func (s DescribeEntitiesDetectionJobOutput) String() string

String returns the string representation

type 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
}

func (DescribeEntityRecognizerInput) GoString

func (s DescribeEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*DescribeEntityRecognizerInput) SetEntityRecognizerArn

func (s *DescribeEntityRecognizerInput) SetEntityRecognizerArn(v string) *DescribeEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DescribeEntityRecognizerInput) String

func (s DescribeEntityRecognizerInput) String() 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
}

func (DescribeEntityRecognizerOutput) GoString

func (s DescribeEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (*DescribeEntityRecognizerOutput) SetEntityRecognizerProperties

func (s *DescribeEntityRecognizerOutput) SetEntityRecognizerProperties(v *EntityRecognizerProperties) *DescribeEntityRecognizerOutput

SetEntityRecognizerProperties sets the EntityRecognizerProperties field's value.

func (DescribeEntityRecognizerOutput) String

func (s DescribeEntityRecognizerOutput) String() string

String returns the string representation

type DescribeKeyPhrasesDetectionJobInput

type DescribeKeyPhrasesDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeKeyPhrasesDetectionJobInput) GoString

func (s DescribeKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) SetJobId

func (s *DescribeKeyPhrasesDetectionJobInput) SetJobId(v string) *DescribeKeyPhrasesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeKeyPhrasesDetectionJobInput) String

func (s DescribeKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) Validate

func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeKeyPhrasesDetectionJobOutput

type DescribeKeyPhrasesDetectionJobOutput struct {

    // An object that contains the properties associated with a key phrases detection
    // job.
    KeyPhrasesDetectionJobProperties *KeyPhrasesDetectionJobProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeKeyPhrasesDetectionJobOutput) GoString

func (s DescribeKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties

func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties(v *KeyPhrasesDetectionJobProperties) *DescribeKeyPhrasesDetectionJobOutput

SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value.

func (DescribeKeyPhrasesDetectionJobOutput) String

func (s DescribeKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type DescribePiiEntitiesDetectionJobInput

type DescribePiiEntitiesDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribePiiEntitiesDetectionJobInput) GoString

func (s DescribePiiEntitiesDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribePiiEntitiesDetectionJobInput) SetJobId

func (s *DescribePiiEntitiesDetectionJobInput) SetJobId(v string) *DescribePiiEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribePiiEntitiesDetectionJobInput) String

func (s DescribePiiEntitiesDetectionJobInput) String() string

String returns the string representation

func (*DescribePiiEntitiesDetectionJobInput) Validate

func (s *DescribePiiEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePiiEntitiesDetectionJobOutput

type DescribePiiEntitiesDetectionJobOutput struct {

    // Provides information about a PII entities detection job.
    PiiEntitiesDetectionJobProperties *PiiEntitiesDetectionJobProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribePiiEntitiesDetectionJobOutput) GoString

func (s DescribePiiEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties

func (s *DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties(v *PiiEntitiesDetectionJobProperties) *DescribePiiEntitiesDetectionJobOutput

SetPiiEntitiesDetectionJobProperties sets the PiiEntitiesDetectionJobProperties field's value.

func (DescribePiiEntitiesDetectionJobOutput) String

func (s DescribePiiEntitiesDetectionJobOutput) String() string

String returns the string representation

type DescribeSentimentDetectionJobInput

type DescribeSentimentDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeSentimentDetectionJobInput) GoString

func (s DescribeSentimentDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeSentimentDetectionJobInput) SetJobId

func (s *DescribeSentimentDetectionJobInput) SetJobId(v string) *DescribeSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeSentimentDetectionJobInput) String

func (s DescribeSentimentDetectionJobInput) String() string

String returns the string representation

func (*DescribeSentimentDetectionJobInput) Validate

func (s *DescribeSentimentDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSentimentDetectionJobOutput

type DescribeSentimentDetectionJobOutput struct {

    // An object that contains the properties associated with a sentiment detection
    // job.
    SentimentDetectionJobProperties *SentimentDetectionJobProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeSentimentDetectionJobOutput) GoString

func (s DescribeSentimentDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties

func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties(v *SentimentDetectionJobProperties) *DescribeSentimentDetectionJobOutput

SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value.

func (DescribeSentimentDetectionJobOutput) String

func (s DescribeSentimentDetectionJobOutput) String() string

String returns the string representation

type DescribeTopicsDetectionJobInput

type DescribeTopicsDetectionJobInput struct {

    // The identifier assigned by the user to the detection job.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobInput) GoString

func (s DescribeTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobInput) SetJobId

func (s *DescribeTopicsDetectionJobInput) SetJobId(v string) *DescribeTopicsDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeTopicsDetectionJobInput) String

func (s DescribeTopicsDetectionJobInput) String() string

String returns the string representation

func (*DescribeTopicsDetectionJobInput) Validate

func (s *DescribeTopicsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTopicsDetectionJobOutput

type DescribeTopicsDetectionJobOutput struct {

    // The list of properties for the requested job.
    TopicsDetectionJobProperties *TopicsDetectionJobProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobOutput) GoString

func (s DescribeTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties

func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *TopicsDetectionJobProperties) *DescribeTopicsDetectionJobOutput

SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value.

func (DescribeTopicsDetectionJobOutput) String

func (s DescribeTopicsDetectionJobOutput) String() string

String returns the string representation

type DetectDominantLanguageInput

type DetectDominantLanguageInput struct {

    // A UTF-8 text string. Each string should contain at least 20 characters and
    // must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DetectDominantLanguageInput) GoString

func (s DetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageInput) SetText

func (s *DetectDominantLanguageInput) SetText(v string) *DetectDominantLanguageInput

SetText sets the Text field's value.

func (DetectDominantLanguageInput) String

func (s DetectDominantLanguageInput) String() string

String returns the string representation

func (*DetectDominantLanguageInput) Validate

func (s *DetectDominantLanguageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectDominantLanguageOutput

type DetectDominantLanguageOutput struct {

    // The languages that Amazon Comprehend detected in the input text. For each
    // language, the response returns the RFC 5646 language code and the level of
    // confidence that Amazon Comprehend has in the accuracy of its inference. For
    // more information about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646)
    // on the IETF Tools web site.
    Languages []*DominantLanguage `type:"list"`
    // contains filtered or unexported fields
}

func (DetectDominantLanguageOutput) GoString

func (s DetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageOutput) SetLanguages

func (s *DetectDominantLanguageOutput) SetLanguages(v []*DominantLanguage) *DetectDominantLanguageOutput

SetLanguages sets the Languages field's value.

func (DetectDominantLanguageOutput) String

func (s DetectDominantLanguageOutput) String() string

String returns the string representation

type DetectEntitiesInput

type DetectEntitiesInput struct {

    // The Amazon Resource Name of an endpoint that is associated with a custom
    // entity recognition model. Provide an endpoint if you want to detect entities
    // by using your own custom model instead of the default model that is used
    // by Amazon Comprehend.
    //
    // If you specify an endpoint, Amazon Comprehend uses the language of your custom
    // model, and it ignores any language code that you provide in your request.
    EndpointArn *string `type:"string"`

    // The language of the input documents. You can specify any of the primary languages
    // supported by Amazon Comprehend. All documents must be in the same language.
    //
    // If your request includes the endpoint for a custom entity recognition model,
    // Amazon Comprehend uses the language of your custom model, and it ignores
    // any language code that you specify here.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
    // encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DetectEntitiesInput) GoString

func (s DetectEntitiesInput) GoString() string

GoString returns the string representation

func (*DetectEntitiesInput) SetEndpointArn

func (s *DetectEntitiesInput) SetEndpointArn(v string) *DetectEntitiesInput

SetEndpointArn sets the EndpointArn field's value.

func (*DetectEntitiesInput) SetLanguageCode

func (s *DetectEntitiesInput) SetLanguageCode(v string) *DetectEntitiesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectEntitiesInput) SetText

func (s *DetectEntitiesInput) SetText(v string) *DetectEntitiesInput

SetText sets the Text field's value.

func (DetectEntitiesInput) String

func (s DetectEntitiesInput) String() string

String returns the string representation

func (*DetectEntitiesInput) Validate

func (s *DetectEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectEntitiesOutput

type DetectEntitiesOutput struct {

    // A collection of entities identified in the input text. For each entity, the
    // response provides the entity text, entity type, where the entity text begins
    // and ends, and the level of confidence that Amazon Comprehend has in the detection.
    //
    // If your request uses a custom entity recognition model, Amazon Comprehend
    // detects the entities that the model is trained to recognize. Otherwise, it
    // detects the default entity types. For a list of default entity types, see
    // how-entities.
    Entities []*Entity `type:"list"`
    // contains filtered or unexported fields
}

func (DetectEntitiesOutput) GoString

func (s DetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*DetectEntitiesOutput) SetEntities

func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput

SetEntities sets the Entities field's value.

func (DetectEntitiesOutput) String

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectKeyPhrasesInput

type DetectKeyPhrasesInput struct {

    // The language of the input documents. You can specify any of the primary languages
    // supported by Amazon Comprehend. All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
    // encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DetectKeyPhrasesInput) GoString

func (s DetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesInput) SetLanguageCode

func (s *DetectKeyPhrasesInput) SetLanguageCode(v string) *DetectKeyPhrasesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectKeyPhrasesInput) SetText

func (s *DetectKeyPhrasesInput) SetText(v string) *DetectKeyPhrasesInput

SetText sets the Text field's value.

func (DetectKeyPhrasesInput) String

func (s DetectKeyPhrasesInput) String() string

String returns the string representation

func (*DetectKeyPhrasesInput) Validate

func (s *DetectKeyPhrasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectKeyPhrasesOutput

type DetectKeyPhrasesOutput struct {

    // A collection of key phrases that Amazon Comprehend identified in the input
    // text. For each key phrase, the response provides the text of the key phrase,
    // where the key phrase begins and ends, and the level of confidence that Amazon
    // Comprehend has in the accuracy of the detection.
    KeyPhrases []*KeyPhrase `type:"list"`
    // contains filtered or unexported fields
}

func (DetectKeyPhrasesOutput) GoString

func (s DetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesOutput) SetKeyPhrases

func (s *DetectKeyPhrasesOutput) SetKeyPhrases(v []*KeyPhrase) *DetectKeyPhrasesOutput

SetKeyPhrases sets the KeyPhrases field's value.

func (DetectKeyPhrasesOutput) String

func (s DetectKeyPhrasesOutput) String() string

String returns the string representation

type DetectPiiEntitiesInput

type DetectPiiEntitiesInput struct {

    // The language of the input documents.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
    // encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectPiiEntitiesInput) GoString

func (s DetectPiiEntitiesInput) GoString() string

GoString returns the string representation

func (*DetectPiiEntitiesInput) SetLanguageCode

func (s *DetectPiiEntitiesInput) SetLanguageCode(v string) *DetectPiiEntitiesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectPiiEntitiesInput) SetText

func (s *DetectPiiEntitiesInput) SetText(v string) *DetectPiiEntitiesInput

SetText sets the Text field's value.

func (DetectPiiEntitiesInput) String

func (s DetectPiiEntitiesInput) String() string

String returns the string representation

func (*DetectPiiEntitiesInput) Validate

func (s *DetectPiiEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectPiiEntitiesOutput

type DetectPiiEntitiesOutput struct {

    // A collection of PII entities identified in the input text. For each entity,
    // the response provides the entity type, where the entity text begins and ends,
    // and the level of confidence that Amazon Comprehend has in the detection.
    Entities []*PiiEntity `type:"list"`
    // contains filtered or unexported fields
}

func (DetectPiiEntitiesOutput) GoString

func (s DetectPiiEntitiesOutput) GoString() string

GoString returns the string representation

func (*DetectPiiEntitiesOutput) SetEntities

func (s *DetectPiiEntitiesOutput) SetEntities(v []*PiiEntity) *DetectPiiEntitiesOutput

SetEntities sets the Entities field's value.

func (DetectPiiEntitiesOutput) String

func (s DetectPiiEntitiesOutput) String() string

String returns the string representation

type DetectSentimentInput

type DetectSentimentInput struct {

    // The language of the input documents. You can specify any of the primary languages
    // supported by Amazon Comprehend. All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
    // encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DetectSentimentInput) GoString

func (s DetectSentimentInput) GoString() string

GoString returns the string representation

func (*DetectSentimentInput) SetLanguageCode

func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSentimentInput) SetText

func (s *DetectSentimentInput) SetText(v string) *DetectSentimentInput

SetText sets the Text field's value.

func (DetectSentimentInput) String

func (s DetectSentimentInput) String() string

String returns the string representation

func (*DetectSentimentInput) Validate

func (s *DetectSentimentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectSentimentOutput

type DetectSentimentOutput struct {

    // The inferred sentiment that Amazon Comprehend has the highest level of confidence
    // in.
    Sentiment *string `type:"string" enum:"SentimentType"`

    // An object that lists the sentiments, and their corresponding confidence levels.
    SentimentScore *SentimentScore `type:"structure"`
    // contains filtered or unexported fields
}

func (DetectSentimentOutput) GoString

func (s DetectSentimentOutput) GoString() string

GoString returns the string representation

func (*DetectSentimentOutput) SetSentiment

func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput

SetSentiment sets the Sentiment field's value.

func (*DetectSentimentOutput) SetSentimentScore

func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput

SetSentimentScore sets the SentimentScore field's value.

func (DetectSentimentOutput) String

func (s DetectSentimentOutput) String() string

String returns the string representation

type DetectSyntaxInput

type DetectSyntaxInput struct {

    // The language code of the input documents. You can specify any of the following
    // languages supported by Amazon Comprehend: German ("de"), English ("en"),
    // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"`

    // A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded
    // characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DetectSyntaxInput) GoString

func (s DetectSyntaxInput) GoString() string

GoString returns the string representation

func (*DetectSyntaxInput) SetLanguageCode

func (s *DetectSyntaxInput) SetLanguageCode(v string) *DetectSyntaxInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSyntaxInput) SetText

func (s *DetectSyntaxInput) SetText(v string) *DetectSyntaxInput

SetText sets the Text field's value.

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
}

func (DetectSyntaxOutput) GoString

func (s DetectSyntaxOutput) GoString() string

GoString returns the string representation

func (*DetectSyntaxOutput) SetSyntaxTokens

func (s *DetectSyntaxOutput) SetSyntaxTokens(v []*SyntaxToken) *DetectSyntaxOutput

SetSyntaxTokens sets the SyntaxTokens field's value.

func (DetectSyntaxOutput) String

func (s DetectSyntaxOutput) String() string

String returns the string representation

type DocumentClass

type DocumentClass struct {

    // The name of the class.
    Name *string `min:"1" type:"string"`

    // The confidence score that Amazon Comprehend has this class correctly attributed.
    Score *float64 `type:"float"`
    // contains filtered or unexported fields
}

Specifies the class that categorizes the document being analyzed

func (DocumentClass) GoString

func (s DocumentClass) GoString() string

GoString returns the string representation

func (*DocumentClass) SetName

func (s *DocumentClass) SetName(v string) *DocumentClass

SetName sets the Name field's value.

func (*DocumentClass) SetScore

func (s *DocumentClass) SetScore(v float64) *DocumentClass

SetScore sets the Score field's value.

func (DocumentClass) String

func (s DocumentClass) String() string

String returns the string representation

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 *string `type:"string" enum:"JobStatus"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted after the specified time. Jobs are
    // returned in descending order, newest to oldest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted before the specified time. Jobs are
    // returned in ascending order, oldest to newest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

func (DocumentClassificationJobFilter) GoString

func (s DocumentClassificationJobFilter) GoString() string

GoString returns the string representation

func (*DocumentClassificationJobFilter) SetJobName

func (s *DocumentClassificationJobFilter) SetJobName(v string) *DocumentClassificationJobFilter

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobFilter) SetJobStatus

func (s *DocumentClassificationJobFilter) SetJobStatus(v string) *DocumentClassificationJobFilter

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeAfter

func (s *DocumentClassificationJobFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassificationJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeBefore

func (s *DocumentClassificationJobFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassificationJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassificationJobFilter) String

func (s DocumentClassificationJobFilter) String() 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"`

    // The input data configuration that you supplied when you created the document
    // classification job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the document classification job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned to the document classification job.
    JobName *string `min:"1" type:"string"`

    // The current status of the document classification job. If the status is FAILED,
    // the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // A description of the status of the job.
    Message *string `type:"string"`

    // The output data configuration that you supplied when you created the document
    // classification job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the document classification job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your document classification job. For more
    // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

Provides information about a document classification job.

func (DocumentClassificationJobProperties) GoString

func (s DocumentClassificationJobProperties) GoString() string

GoString returns the string representation

func (*DocumentClassificationJobProperties) SetDataAccessRoleArn

func (s *DocumentClassificationJobProperties) SetDataAccessRoleArn(v string) *DocumentClassificationJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassificationJobProperties) SetDocumentClassifierArn

func (s *DocumentClassificationJobProperties) SetDocumentClassifierArn(v string) *DocumentClassificationJobProperties

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassificationJobProperties) SetEndTime

func (s *DocumentClassificationJobProperties) SetEndTime(v time.Time) *DocumentClassificationJobProperties

SetEndTime sets the EndTime field's value.

func (*DocumentClassificationJobProperties) SetInputDataConfig

func (s *DocumentClassificationJobProperties) SetInputDataConfig(v *InputDataConfig) *DocumentClassificationJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetJobId

func (s *DocumentClassificationJobProperties) SetJobId(v string) *DocumentClassificationJobProperties

SetJobId sets the JobId field's value.

func (*DocumentClassificationJobProperties) SetJobName

func (s *DocumentClassificationJobProperties) SetJobName(v string) *DocumentClassificationJobProperties

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobProperties) SetJobStatus

func (s *DocumentClassificationJobProperties) SetJobStatus(v string) *DocumentClassificationJobProperties

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobProperties) SetMessage

func (s *DocumentClassificationJobProperties) SetMessage(v string) *DocumentClassificationJobProperties

SetMessage sets the Message field's value.

func (*DocumentClassificationJobProperties) SetOutputDataConfig

func (s *DocumentClassificationJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DocumentClassificationJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetSubmitTime

func (s *DocumentClassificationJobProperties) SetSubmitTime(v time.Time) *DocumentClassificationJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassificationJobProperties) SetVolumeKmsKeyId

func (s *DocumentClassificationJobProperties) SetVolumeKmsKeyId(v string) *DocumentClassificationJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassificationJobProperties) SetVpcConfig

func (s *DocumentClassificationJobProperties) SetVpcConfig(v *VpcConfig) *DocumentClassificationJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassificationJobProperties) String

func (s DocumentClassificationJobProperties) String() string

String returns the string representation

type DocumentClassifierFilter

type DocumentClassifierFilter struct {

    // Filters the list of classifiers based on status.
    Status *string `type:"string" enum:"ModelStatus"`

    // Filters the list of classifiers based on the time that the classifier was
    // submitted for processing. Returns only classifiers submitted after the specified
    // time. Classifiers are returned in descending order, newest to oldest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of classifiers based on the time that the classifier was
    // submitted for processing. Returns only classifiers submitted before the specified
    // time. Classifiers are returned in ascending order, oldest to newest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.

func (DocumentClassifierFilter) GoString

func (s DocumentClassifierFilter) GoString() string

GoString returns the string representation

func (*DocumentClassifierFilter) SetStatus

func (s *DocumentClassifierFilter) SetStatus(v string) *DocumentClassifierFilter

SetStatus sets the Status field's value.

func (*DocumentClassifierFilter) SetSubmitTimeAfter

func (s *DocumentClassifierFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassifierFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassifierFilter) SetSubmitTimeBefore

func (s *DocumentClassifierFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassifierFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassifierFilter) String

func (s DocumentClassifierFilter) String() string

String returns the string representation

type DocumentClassifierInputDataConfig

type DocumentClassifierInputDataConfig struct {

    // A list of augmented manifest files that provide training data for your custom
    // model. An augmented manifest file is a labeled dataset that is produced by
    // Amazon SageMaker Ground Truth.
    //
    // This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.
    AugmentedManifests []*AugmentedManifestsListItem `type:"list"`

    // The format of your training data:
    //
    //    * COMPREHEND_CSV: A two-column CSV file, where labels are provided in
    //    the first column, and documents are provided in the second. If you use
    //    this value, you must provide the S3Uri parameter in your request.
    //
    //    * AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker
    //    Ground Truth. This file is in JSON lines format. Each line is a complete
    //    JSON object that contains a training document and its associated labels.
    //    If you use this value, you must provide the AugmentedManifests parameter
    //    in your request.
    //
    // If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the
    // default.
    DataFormat *string `type:"string" enum:"DocumentClassifierDataFormat"`

    // Indicates the delimiter used to separate each label for training a multi-label
    // classifier. The default delimiter between labels is a pipe (|). You can use
    // a different character as a delimiter (if it's an allowed character) by specifying
    // it under Delimiter for labels. If the training documents use a delimiter
    // other than the default or the delimiter you specify, the labels on that line
    // will be combined to make a single unique label, such as LABELLABELLABEL.
    LabelDelimiter *string `min:"1" type:"string"`

    // The Amazon S3 URI for the input data. The S3 bucket must be in the same region
    // as the API endpoint that you are calling. The URI can point to a single input
    // file or it can provide the prefix for a collection of input files.
    //
    // For example, if you use the URI S3://bucketName/prefix, if the prefix is
    // a single file, Amazon Comprehend uses that file as input. If more than one
    // file begins with the prefix, Amazon Comprehend uses all of them as input.
    //
    // This parameter is required if you set DataFormat to COMPREHEND_CSV.
    S3Uri *string `type:"string"`
    // contains filtered or unexported fields
}

The input properties for training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data.

func (DocumentClassifierInputDataConfig) GoString

func (s DocumentClassifierInputDataConfig) GoString() string

GoString returns the string representation

func (*DocumentClassifierInputDataConfig) SetAugmentedManifests

func (s *DocumentClassifierInputDataConfig) SetAugmentedManifests(v []*AugmentedManifestsListItem) *DocumentClassifierInputDataConfig

SetAugmentedManifests sets the AugmentedManifests field's value.

func (*DocumentClassifierInputDataConfig) SetDataFormat

func (s *DocumentClassifierInputDataConfig) SetDataFormat(v string) *DocumentClassifierInputDataConfig

SetDataFormat sets the DataFormat field's value.

func (*DocumentClassifierInputDataConfig) SetLabelDelimiter

func (s *DocumentClassifierInputDataConfig) SetLabelDelimiter(v string) *DocumentClassifierInputDataConfig

SetLabelDelimiter sets the LabelDelimiter field's value.

func (*DocumentClassifierInputDataConfig) SetS3Uri

func (s *DocumentClassifierInputDataConfig) SetS3Uri(v string) *DocumentClassifierInputDataConfig

SetS3Uri sets the S3Uri field's value.

func (DocumentClassifierInputDataConfig) String

func (s DocumentClassifierInputDataConfig) String() string

String returns the string representation

func (*DocumentClassifierInputDataConfig) Validate

func (s *DocumentClassifierInputDataConfig) Validate() error

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.

func (DocumentClassifierOutputDataConfig) GoString

func (s DocumentClassifierOutputDataConfig) GoString() string

GoString returns the string representation

func (*DocumentClassifierOutputDataConfig) SetKmsKeyId

func (s *DocumentClassifierOutputDataConfig) SetKmsKeyId(v string) *DocumentClassifierOutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*DocumentClassifierOutputDataConfig) SetS3Uri

func (s *DocumentClassifierOutputDataConfig) SetS3Uri(v string) *DocumentClassifierOutputDataConfig

SetS3Uri sets the S3Uri field's value.

func (DocumentClassifierOutputDataConfig) String

func (s DocumentClassifierOutputDataConfig) String() 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" sensitive:"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 *string `min:"20" type:"string"`

    // The Amazon Resource Name (ARN) that identifies the document classifier.
    DocumentClassifierArn *string `type:"string"`

    // The time that training the document classifier completed.
    EndTime *time.Time `type:"timestamp"`

    // The input data configuration that you supplied when you created the document
    // classifier for training.
    InputDataConfig *DocumentClassifierInputDataConfig `type:"structure"`

    // The language code for the language of the documents that the classifier was
    // trained on.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // Additional information about the status of the classifier.
    Message *string `type:"string"`

    // Indicates the mode in which the specific classifier was trained. This also
    // indicates the format of input documents and the format of the confusion matrix.
    // Each classifier can only be trained in one mode and this cannot be changed
    // once the classifier is trained.
    Mode *string `type:"string" enum:"DocumentClassifierMode"`

    // Provides output results configuration parameters for custom classifier jobs.
    OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

    // The status of the document classifier. If the status is TRAINED the classifier
    // is ready to use. If the status is FAILED you can see additional information
    // about why the classifier wasn't trained in the Message field.
    Status *string `type:"string" enum:"ModelStatus"`

    // The time that the document classifier was submitted for training.
    SubmitTime *time.Time `type:"timestamp"`

    // The time that training of the document classifier was completed. Indicates
    // the time when the training completes on documentation classifiers. You are
    // billed for the time interval between this time and the value of TrainingStartTime.
    TrainingEndTime *time.Time `type:"timestamp"`

    // Indicates the time when the training starts on documentation classifiers.
    // You are billed for the time interval between this time and the value of TrainingEndTime.
    TrainingStartTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your custom classifier. For more information,
    // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

Provides information about a document classifier.

func (DocumentClassifierProperties) GoString

func (s DocumentClassifierProperties) GoString() string

GoString returns the string representation

func (*DocumentClassifierProperties) SetClassifierMetadata

func (s *DocumentClassifierProperties) SetClassifierMetadata(v *ClassifierMetadata) *DocumentClassifierProperties

SetClassifierMetadata sets the ClassifierMetadata field's value.

func (*DocumentClassifierProperties) SetDataAccessRoleArn

func (s *DocumentClassifierProperties) SetDataAccessRoleArn(v string) *DocumentClassifierProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassifierProperties) SetDocumentClassifierArn

func (s *DocumentClassifierProperties) SetDocumentClassifierArn(v string) *DocumentClassifierProperties

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassifierProperties) SetEndTime

func (s *DocumentClassifierProperties) SetEndTime(v time.Time) *DocumentClassifierProperties

SetEndTime sets the EndTime field's value.

func (*DocumentClassifierProperties) SetInputDataConfig

func (s *DocumentClassifierProperties) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *DocumentClassifierProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassifierProperties) SetLanguageCode

func (s *DocumentClassifierProperties) SetLanguageCode(v string) *DocumentClassifierProperties

SetLanguageCode sets the LanguageCode field's value.

func (*DocumentClassifierProperties) SetMessage

func (s *DocumentClassifierProperties) SetMessage(v string) *DocumentClassifierProperties

SetMessage sets the Message field's value.

func (*DocumentClassifierProperties) SetMode

func (s *DocumentClassifierProperties) SetMode(v string) *DocumentClassifierProperties

SetMode sets the Mode field's value.

func (*DocumentClassifierProperties) SetOutputDataConfig

func (s *DocumentClassifierProperties) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *DocumentClassifierProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassifierProperties) SetStatus

func (s *DocumentClassifierProperties) SetStatus(v string) *DocumentClassifierProperties

SetStatus sets the Status field's value.

func (*DocumentClassifierProperties) SetSubmitTime

func (s *DocumentClassifierProperties) SetSubmitTime(v time.Time) *DocumentClassifierProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassifierProperties) SetTrainingEndTime

func (s *DocumentClassifierProperties) SetTrainingEndTime(v time.Time) *DocumentClassifierProperties

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*DocumentClassifierProperties) SetTrainingStartTime

func (s *DocumentClassifierProperties) SetTrainingStartTime(v time.Time) *DocumentClassifierProperties

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*DocumentClassifierProperties) SetVolumeKmsKeyId

func (s *DocumentClassifierProperties) SetVolumeKmsKeyId(v string) *DocumentClassifierProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassifierProperties) SetVpcConfig

func (s *DocumentClassifierProperties) SetVpcConfig(v *VpcConfig) *DocumentClassifierProperties

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassifierProperties) String

func (s DocumentClassifierProperties) String() string

String returns the string representation

type DocumentLabel

type DocumentLabel struct {

    // The name of the label.
    Name *string `min:"1" type:"string"`

    // The confidence score that Amazon Comprehend has this label correctly attributed.
    Score *float64 `type:"float"`
    // contains filtered or unexported fields
}

Specifies one of the label or labels that categorize the document being analyzed.

func (DocumentLabel) GoString

func (s DocumentLabel) GoString() string

GoString returns the string representation

func (*DocumentLabel) SetName

func (s *DocumentLabel) SetName(v string) *DocumentLabel

SetName sets the Name field's value.

func (*DocumentLabel) SetScore

func (s *DocumentLabel) SetScore(v float64) *DocumentLabel

SetScore sets the Score field's value.

func (DocumentLabel) String

func (s DocumentLabel) String() string

String returns the string representation

type DominantLanguage

type DominantLanguage struct {

    // The RFC 5646 language code for the dominant language. For more information
    // about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646)
    // on the IETF Tools web site.
    LanguageCode *string `min:"1" type:"string"`

    // The level of confidence that Amazon Comprehend has in the accuracy of the
    // detection.
    Score *float64 `type:"float"`
    // contains filtered or unexported fields
}

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

func (DominantLanguage) GoString

func (s DominantLanguage) GoString() string

GoString returns the string representation

func (*DominantLanguage) SetLanguageCode

func (s *DominantLanguage) SetLanguageCode(v string) *DominantLanguage

SetLanguageCode sets the LanguageCode field's value.

func (*DominantLanguage) SetScore

func (s *DominantLanguage) SetScore(v float64) *DominantLanguage

SetScore sets the Score field's value.

func (DominantLanguage) String

func (s DominantLanguage) String() string

String returns the string representation

type DominantLanguageDetectionJobFilter

type DominantLanguageDetectionJobFilter struct {

    // Filters on the name of the job.
    JobName *string `min:"1" type:"string"`

    // Filters the list of jobs based on job status. Returns only jobs with the
    // specified status.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted after the specified time. Jobs are
    // returned in descending order, newest to oldest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted before the specified time. Jobs are
    // returned in ascending order, oldest to newest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (DominantLanguageDetectionJobFilter) GoString

func (s DominantLanguageDetectionJobFilter) GoString() string

GoString returns the string representation

func (*DominantLanguageDetectionJobFilter) SetJobName

func (s *DominantLanguageDetectionJobFilter) SetJobName(v string) *DominantLanguageDetectionJobFilter

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobFilter) SetJobStatus

func (s *DominantLanguageDetectionJobFilter) SetJobStatus(v string) *DominantLanguageDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeAfter

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeBefore

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DominantLanguageDetectionJobFilter) String

func (s DominantLanguageDetectionJobFilter) String() string

String returns the string representation

func (*DominantLanguageDetectionJobFilter) Validate

func (s *DominantLanguageDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DominantLanguageDetectionJobProperties

type DominantLanguageDetectionJobProperties struct {

    // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
    // your input data.
    DataAccessRoleArn *string `min:"20" type:"string"`

    // The time that the dominant language detection job completed.
    EndTime *time.Time `type:"timestamp"`

    // The input data configuration that you supplied when you created the dominant
    // language detection job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the dominant language detection job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned to the dominant language detection job.
    JobName *string `min:"1" type:"string"`

    // The current status of the dominant language detection job. If the status
    // is FAILED, the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // A description for the status of a job.
    Message *string `type:"string"`

    // The output data configuration that you supplied when you created the dominant
    // language detection job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the dominant language detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your dominant language detection job. For
    // more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

Provides information about a dominant language detection job.

func (DominantLanguageDetectionJobProperties) GoString

func (s DominantLanguageDetectionJobProperties) GoString() string

GoString returns the string representation

func (*DominantLanguageDetectionJobProperties) SetDataAccessRoleArn

func (s *DominantLanguageDetectionJobProperties) SetDataAccessRoleArn(v string) *DominantLanguageDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DominantLanguageDetectionJobProperties) SetEndTime

func (s *DominantLanguageDetectionJobProperties) SetEndTime(v time.Time) *DominantLanguageDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*DominantLanguageDetectionJobProperties) SetInputDataConfig

func (s *DominantLanguageDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *DominantLanguageDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetJobId

func (s *DominantLanguageDetectionJobProperties) SetJobId(v string) *DominantLanguageDetectionJobProperties

SetJobId sets the JobId field's value.

func (*DominantLanguageDetectionJobProperties) SetJobName

func (s *DominantLanguageDetectionJobProperties) SetJobName(v string) *DominantLanguageDetectionJobProperties

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobProperties) SetJobStatus

func (s *DominantLanguageDetectionJobProperties) SetJobStatus(v string) *DominantLanguageDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobProperties) SetMessage

func (s *DominantLanguageDetectionJobProperties) SetMessage(v string) *DominantLanguageDetectionJobProperties

SetMessage sets the Message field's value.

func (*DominantLanguageDetectionJobProperties) SetOutputDataConfig

func (s *DominantLanguageDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DominantLanguageDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetSubmitTime

func (s *DominantLanguageDetectionJobProperties) SetSubmitTime(v time.Time) *DominantLanguageDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DominantLanguageDetectionJobProperties) SetVolumeKmsKeyId

func (s *DominantLanguageDetectionJobProperties) SetVolumeKmsKeyId(v string) *DominantLanguageDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DominantLanguageDetectionJobProperties) SetVpcConfig

func (s *DominantLanguageDetectionJobProperties) SetVpcConfig(v *VpcConfig) *DominantLanguageDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (DominantLanguageDetectionJobProperties) String

func (s DominantLanguageDetectionJobProperties) String() string

String returns the string representation

type EndpointFilter

type EndpointFilter struct {

    // Specifies a date after which the returned endpoint or endpoints were created.
    CreationTimeAfter *time.Time `type:"timestamp"`

    // Specifies a date before which the returned endpoint or endpoints were created.
    CreationTimeBefore *time.Time `type:"timestamp"`

    // The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
    ModelArn *string `type:"string"`

    // Specifies the status of the endpoint being returned. Possible values are:
    // Creating, Ready, Updating, Deleting, Failed.
    Status *string `type:"string" enum:"EndpointStatus"`
    // contains filtered or unexported fields
}

The filter used to determine which endpoints are are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

func (EndpointFilter) GoString

func (s EndpointFilter) GoString() string

GoString returns the string representation

func (*EndpointFilter) SetCreationTimeAfter

func (s *EndpointFilter) SetCreationTimeAfter(v time.Time) *EndpointFilter

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*EndpointFilter) SetCreationTimeBefore

func (s *EndpointFilter) SetCreationTimeBefore(v time.Time) *EndpointFilter

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (*EndpointFilter) SetModelArn

func (s *EndpointFilter) SetModelArn(v string) *EndpointFilter

SetModelArn sets the ModelArn field's value.

func (*EndpointFilter) SetStatus

func (s *EndpointFilter) SetStatus(v string) *EndpointFilter

SetStatus sets the Status field's value.

func (EndpointFilter) String

func (s EndpointFilter) String() string

String returns the string representation

type EndpointProperties

type EndpointProperties struct {

    // The creation date and time of the endpoint.
    CreationTime *time.Time `type:"timestamp"`

    // The number of inference units currently used by the model using this endpoint.
    CurrentInferenceUnits *int64 `min:"1" type:"integer"`

    // The desired number of inference units to be used by the model using this
    // endpoint. Each inference unit represents of a throughput of 100 characters
    // per second.
    DesiredInferenceUnits *int64 `min:"1" type:"integer"`

    // The Amazon Resource Number (ARN) of the endpoint.
    EndpointArn *string `type:"string"`

    // The date and time that the endpoint was last modified.
    LastModifiedTime *time.Time `type:"timestamp"`

    // Specifies a reason for failure in cases of Failed status.
    Message *string `type:"string"`

    // The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
    ModelArn *string `type:"string"`

    // Specifies the status of the endpoint. Because the endpoint updates and creation
    // are asynchronous, so customers will need to wait for the endpoint to be Ready
    // status before making inference requests.
    Status *string `type:"string" enum:"EndpointStatus"`
    // contains filtered or unexported fields
}

Specifies information about the specified endpoint.

func (EndpointProperties) GoString

func (s EndpointProperties) GoString() string

GoString returns the string representation

func (*EndpointProperties) SetCreationTime

func (s *EndpointProperties) SetCreationTime(v time.Time) *EndpointProperties

SetCreationTime sets the CreationTime field's value.

func (*EndpointProperties) SetCurrentInferenceUnits

func (s *EndpointProperties) SetCurrentInferenceUnits(v int64) *EndpointProperties

SetCurrentInferenceUnits sets the CurrentInferenceUnits field's value.

func (*EndpointProperties) SetDesiredInferenceUnits

func (s *EndpointProperties) SetDesiredInferenceUnits(v int64) *EndpointProperties

SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value.

func (*EndpointProperties) SetEndpointArn

func (s *EndpointProperties) SetEndpointArn(v string) *EndpointProperties

SetEndpointArn sets the EndpointArn field's value.

func (*EndpointProperties) SetLastModifiedTime

func (s *EndpointProperties) SetLastModifiedTime(v time.Time) *EndpointProperties

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*EndpointProperties) SetMessage

func (s *EndpointProperties) SetMessage(v string) *EndpointProperties

SetMessage sets the Message field's value.

func (*EndpointProperties) SetModelArn

func (s *EndpointProperties) SetModelArn(v string) *EndpointProperties

SetModelArn sets the ModelArn field's value.

func (*EndpointProperties) SetStatus

func (s *EndpointProperties) SetStatus(v string) *EndpointProperties

SetStatus sets the Status field's value.

func (EndpointProperties) String

func (s EndpointProperties) String() string

String returns the string representation

type EntitiesDetectionJobFilter

type EntitiesDetectionJobFilter struct {

    // Filters on the name of the job.
    JobName *string `min:"1" type:"string"`

    // Filters the list of jobs based on job status. Returns only jobs with the
    // specified status.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted after the specified time. Jobs are
    // returned in descending order, newest to oldest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted before the specified time. Jobs are
    // returned in ascending order, oldest to newest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (EntitiesDetectionJobFilter) GoString

func (s EntitiesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*EntitiesDetectionJobFilter) SetJobName

func (s *EntitiesDetectionJobFilter) SetJobName(v string) *EntitiesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobFilter) SetJobStatus

func (s *EntitiesDetectionJobFilter) SetJobStatus(v string) *EntitiesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeAfter

func (s *EntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeBefore

func (s *EntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntitiesDetectionJobFilter) String

func (s EntitiesDetectionJobFilter) String() string

String returns the string representation

func (*EntitiesDetectionJobFilter) Validate

func (s *EntitiesDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntitiesDetectionJobProperties

type EntitiesDetectionJobProperties struct {

    // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
    // your input data.
    DataAccessRoleArn *string `min:"20" type:"string"`

    // The time that the entities detection job completed
    EndTime *time.Time `type:"timestamp"`

    // The Amazon Resource Name (ARN) that identifies the entity recognizer.
    EntityRecognizerArn *string `type:"string"`

    // The input data configuration that you supplied when you created the entities
    // detection job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the entities detection job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned the entities detection job.
    JobName *string `min:"1" type:"string"`

    // The current status of the entities detection job. If the status is FAILED,
    // the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // The language code of the input documents.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // A description of the status of a job.
    Message *string `type:"string"`

    // The output data configuration that you supplied when you created the entities
    // detection job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the entities detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your entity detection job. For more information,
    // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

Provides information about an entities detection job.

func (EntitiesDetectionJobProperties) GoString

func (s EntitiesDetectionJobProperties) GoString() string

GoString returns the string representation

func (*EntitiesDetectionJobProperties) SetDataAccessRoleArn

func (s *EntitiesDetectionJobProperties) SetDataAccessRoleArn(v string) *EntitiesDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntitiesDetectionJobProperties) SetEndTime

func (s *EntitiesDetectionJobProperties) SetEndTime(v time.Time) *EntitiesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*EntitiesDetectionJobProperties) SetEntityRecognizerArn

func (s *EntitiesDetectionJobProperties) SetEntityRecognizerArn(v string) *EntitiesDetectionJobProperties

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntitiesDetectionJobProperties) SetInputDataConfig

func (s *EntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *EntitiesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetJobId

func (s *EntitiesDetectionJobProperties) SetJobId(v string) *EntitiesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*EntitiesDetectionJobProperties) SetJobName

func (s *EntitiesDetectionJobProperties) SetJobName(v string) *EntitiesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobProperties) SetJobStatus

func (s *EntitiesDetectionJobProperties) SetJobStatus(v string) *EntitiesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobProperties) SetLanguageCode

func (s *EntitiesDetectionJobProperties) SetLanguageCode(v string) *EntitiesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*EntitiesDetectionJobProperties) SetMessage

func (s *EntitiesDetectionJobProperties) SetMessage(v string) *EntitiesDetectionJobProperties

SetMessage sets the Message field's value.

func (*EntitiesDetectionJobProperties) SetOutputDataConfig

func (s *EntitiesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *EntitiesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetSubmitTime

func (s *EntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *EntitiesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*EntitiesDetectionJobProperties) SetVolumeKmsKeyId

func (s *EntitiesDetectionJobProperties) SetVolumeKmsKeyId(v string) *EntitiesDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntitiesDetectionJobProperties) SetVpcConfig

func (s *EntitiesDetectionJobProperties) SetVpcConfig(v *VpcConfig) *EntitiesDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (EntitiesDetectionJobProperties) String

func (s EntitiesDetectionJobProperties) String() string

String returns the string representation

type Entity

type Entity struct {

    // A character offset in the input text that shows where the entity begins (the
    // first character is at position 0). The offset returns the position of each
    // UTF-8 code point in the string. A code point is the abstract character from
    // a particular graphical representation. For example, a multi-byte UTF-8 character
    // maps to a single code point.
    BeginOffset *int64 `type:"integer"`

    // A character offset in the input text that shows where the entity ends. The
    // offset returns the position of each UTF-8 code point in the string. A code
    // point is the abstract character from a particular graphical representation.
    // For example, a multi-byte UTF-8 character maps to a single code point.
    EndOffset *int64 `type:"integer"`

    // The level of confidence that Amazon Comprehend has in the accuracy of the
    // detection.
    Score *float64 `type:"float"`

    // The text of the entity.
    Text *string `min:"1" type:"string"`

    // The entity's type.
    Type *string `type:"string" enum:"EntityType"`
    // contains filtered or unexported fields
}

Provides information about an entity.

func (Entity) GoString

func (s Entity) GoString() string

GoString returns the string representation

func (*Entity) SetBeginOffset

func (s *Entity) SetBeginOffset(v int64) *Entity

SetBeginOffset sets the BeginOffset field's value.

func (*Entity) SetEndOffset

func (s *Entity) SetEndOffset(v int64) *Entity

SetEndOffset sets the EndOffset field's value.

func (*Entity) SetScore

func (s *Entity) SetScore(v float64) *Entity

SetScore sets the Score field's value.

func (*Entity) SetText

func (s *Entity) SetText(v string) *Entity

SetText sets the Text field's value.

func (*Entity) SetType

func (s *Entity) SetType(v string) *Entity

SetType sets the Type field's value.

func (Entity) String

func (s Entity) String() string

String returns the string representation

type 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.

func (EntityRecognizerAnnotations) GoString

func (s EntityRecognizerAnnotations) GoString() string

GoString returns the string representation

func (*EntityRecognizerAnnotations) SetS3Uri

func (s *EntityRecognizerAnnotations) SetS3Uri(v string) *EntityRecognizerAnnotations

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerAnnotations) String

func (s EntityRecognizerAnnotations) String() 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.

func (EntityRecognizerDocuments) GoString

func (s EntityRecognizerDocuments) GoString() string

GoString returns the string representation

func (*EntityRecognizerDocuments) SetS3Uri

func (s *EntityRecognizerDocuments) SetS3Uri(v string) *EntityRecognizerDocuments

SetS3Uri sets the S3Uri field's value.

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.

func (EntityRecognizerEntityList) GoString

func (s EntityRecognizerEntityList) GoString() string

GoString returns the string representation

func (*EntityRecognizerEntityList) SetS3Uri

func (s *EntityRecognizerEntityList) SetS3Uri(v string) *EntityRecognizerEntityList

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerEntityList) String

func (s EntityRecognizerEntityList) String() 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.

func (EntityRecognizerEvaluationMetrics) GoString

func (s EntityRecognizerEvaluationMetrics) GoString() string

GoString returns the string representation

func (*EntityRecognizerEvaluationMetrics) SetF1Score

func (s *EntityRecognizerEvaluationMetrics) SetF1Score(v float64) *EntityRecognizerEvaluationMetrics

SetF1Score sets the F1Score field's value.

func (*EntityRecognizerEvaluationMetrics) SetPrecision

func (s *EntityRecognizerEvaluationMetrics) SetPrecision(v float64) *EntityRecognizerEvaluationMetrics

SetPrecision sets the Precision field's value.

func (*EntityRecognizerEvaluationMetrics) SetRecall

func (s *EntityRecognizerEvaluationMetrics) SetRecall(v float64) *EntityRecognizerEvaluationMetrics

SetRecall sets the Recall field's value.

func (EntityRecognizerEvaluationMetrics) String

func (s EntityRecognizerEvaluationMetrics) String() string

String returns the string representation

type EntityRecognizerFilter

type EntityRecognizerFilter struct {

    // The status of an entity recognizer.
    Status *string `type:"string" enum:"ModelStatus"`

    // Filters the list of entities based on the time that the list was submitted
    // for processing. Returns only jobs submitted after the specified time. Jobs
    // are returned in ascending order, oldest to newest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of entities based on the time that the list was submitted
    // for processing. Returns only jobs submitted before the specified time. Jobs
    // are returned in descending order, newest to oldest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>

func (EntityRecognizerFilter) GoString

func (s EntityRecognizerFilter) GoString() string

GoString returns the string representation

func (*EntityRecognizerFilter) SetStatus

func (s *EntityRecognizerFilter) SetStatus(v string) *EntityRecognizerFilter

SetStatus sets the Status field's value.

func (*EntityRecognizerFilter) SetSubmitTimeAfter

func (s *EntityRecognizerFilter) SetSubmitTimeAfter(v time.Time) *EntityRecognizerFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntityRecognizerFilter) SetSubmitTimeBefore

func (s *EntityRecognizerFilter) SetSubmitTimeBefore(v time.Time) *EntityRecognizerFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntityRecognizerFilter) String

func (s EntityRecognizerFilter) String() string

String returns the string representation

type EntityRecognizerInputDataConfig

type EntityRecognizerInputDataConfig struct {

    // The S3 location of the CSV file that annotates your training documents.
    Annotations *EntityRecognizerAnnotations `type:"structure"`

    // A list of augmented manifest files that provide training data for your custom
    // model. An augmented manifest file is a labeled dataset that is produced by
    // Amazon SageMaker Ground Truth.
    //
    // This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.
    AugmentedManifests []*AugmentedManifestsListItem `type:"list"`

    // The format of your training data:
    //
    //    * COMPREHEND_CSV: A CSV file that supplements your training documents.
    //    The CSV file contains information about the custom entities that your
    //    trained model will detect. The required format of the file depends on
    //    whether you are providing annotations or an entity list. If you use this
    //    value, you must provide your CSV file by using either the Annotations
    //    or EntityList parameters. You must provide your training documents by
    //    using the Documents parameter.
    //
    //    * AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker
    //    Ground Truth. This file is in JSON lines format. Each line is a complete
    //    JSON object that contains a training document and its labels. Each label
    //    annotates a named entity in the training document. If you use this value,
    //    you must provide the AugmentedManifests parameter in your request.
    //
    // If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the
    // default.
    DataFormat *string `type:"string" enum:"EntityRecognizerDataFormat"`

    // The S3 location of the folder that contains the training documents for your
    // custom entity recognizer.
    //
    // This parameter is required if you set DataFormat to COMPREHEND_CSV.
    Documents *EntityRecognizerDocuments `type:"structure"`

    // The S3 location of the CSV file that has the entity list for your custom
    // entity recognizer.
    EntityList *EntityRecognizerEntityList `type:"structure"`

    // The entity types in the labeled training data that Amazon Comprehend uses
    // to train the custom entity recognizer. Any entity types that you don't specify
    // are ignored.
    //
    // A maximum of 25 entity types can be used at one time to train an entity recognizer.
    // Entity types must not contain the following invalid characters: \n (line
    // break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage
    // return), \t (tab), \\t (escaped tab), space, and , (comma).
    //
    // EntityTypes is a required field
    EntityTypes []*EntityTypesListItem `type:"list" required:"true"`
    // contains filtered or unexported fields
}

Specifies the format and location of the input data.

func (EntityRecognizerInputDataConfig) GoString

func (s EntityRecognizerInputDataConfig) GoString() string

GoString returns the string representation

func (*EntityRecognizerInputDataConfig) SetAnnotations

func (s *EntityRecognizerInputDataConfig) SetAnnotations(v *EntityRecognizerAnnotations) *EntityRecognizerInputDataConfig

SetAnnotations sets the Annotations field's value.

func (*EntityRecognizerInputDataConfig) SetAugmentedManifests

func (s *EntityRecognizerInputDataConfig) SetAugmentedManifests(v []*AugmentedManifestsListItem) *EntityRecognizerInputDataConfig

SetAugmentedManifests sets the AugmentedManifests field's value.

func (*EntityRecognizerInputDataConfig) SetDataFormat

func (s *EntityRecognizerInputDataConfig) SetDataFormat(v string) *EntityRecognizerInputDataConfig

SetDataFormat sets the DataFormat field's value.

func (*EntityRecognizerInputDataConfig) SetDocuments

func (s *EntityRecognizerInputDataConfig) SetDocuments(v *EntityRecognizerDocuments) *EntityRecognizerInputDataConfig

SetDocuments sets the Documents field's value.

func (*EntityRecognizerInputDataConfig) SetEntityList

func (s *EntityRecognizerInputDataConfig) SetEntityList(v *EntityRecognizerEntityList) *EntityRecognizerInputDataConfig

SetEntityList sets the EntityList field's value.

func (*EntityRecognizerInputDataConfig) SetEntityTypes

func (s *EntityRecognizerInputDataConfig) SetEntityTypes(v []*EntityTypesListItem) *EntityRecognizerInputDataConfig

SetEntityTypes sets the EntityTypes field's value.

func (EntityRecognizerInputDataConfig) String

func (s EntityRecognizerInputDataConfig) String() 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.

func (EntityRecognizerMetadata) GoString

func (s EntityRecognizerMetadata) GoString() string

GoString returns the string representation

func (*EntityRecognizerMetadata) SetEntityTypes

func (s *EntityRecognizerMetadata) SetEntityTypes(v []*EntityRecognizerMetadataEntityTypesListItem) *EntityRecognizerMetadata

SetEntityTypes sets the EntityTypes field's value.

func (*EntityRecognizerMetadata) SetEvaluationMetrics

func (s *EntityRecognizerMetadata) SetEvaluationMetrics(v *EntityRecognizerEvaluationMetrics) *EntityRecognizerMetadata

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadata) SetNumberOfTestDocuments

func (s *EntityRecognizerMetadata) SetNumberOfTestDocuments(v int64) *EntityRecognizerMetadata

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*EntityRecognizerMetadata) SetNumberOfTrainedDocuments

func (s *EntityRecognizerMetadata) SetNumberOfTrainedDocuments(v int64) *EntityRecognizerMetadata

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (EntityRecognizerMetadata) String

func (s EntityRecognizerMetadata) String() string

String returns the string representation

type EntityRecognizerMetadataEntityTypesListItem

type EntityRecognizerMetadataEntityTypesListItem struct {

    // Detailed information about the accuracy of the entity recognizer for a specific
    // item on the list of entity types.
    EvaluationMetrics *EntityTypesEvaluationMetrics `type:"structure"`

    // Indicates the number of times the given entity type was seen in the training
    // data.
    NumberOfTrainMentions *int64 `type:"integer"`

    // Type of entity from the list of entity types in the metadata of an entity
    // recognizer.
    Type *string `type:"string"`
    // contains filtered or unexported fields
}

Individual item from the list of entity types in the metadata of an entity recognizer.

func (EntityRecognizerMetadataEntityTypesListItem) GoString

func (s EntityRecognizerMetadataEntityTypesListItem) GoString() string

GoString returns the string representation

func (*EntityRecognizerMetadataEntityTypesListItem) SetEvaluationMetrics

func (s *EntityRecognizerMetadataEntityTypesListItem) SetEvaluationMetrics(v *EntityTypesEvaluationMetrics) *EntityRecognizerMetadataEntityTypesListItem

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetNumberOfTrainMentions

func (s *EntityRecognizerMetadataEntityTypesListItem) SetNumberOfTrainMentions(v int64) *EntityRecognizerMetadataEntityTypesListItem

SetNumberOfTrainMentions sets the NumberOfTrainMentions field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetType

func (s *EntityRecognizerMetadataEntityTypesListItem) SetType(v string) *EntityRecognizerMetadataEntityTypesListItem

SetType sets the Type field's value.

func (EntityRecognizerMetadataEntityTypesListItem) String

func (s EntityRecognizerMetadataEntityTypesListItem) String() 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"`

    // The Amazon Resource Name (ARN) that identifies the entity recognizer.
    EntityRecognizerArn *string `type:"string"`

    // The input data properties of an entity recognizer.
    InputDataConfig *EntityRecognizerInputDataConfig `type:"structure"`

    // The language of the input documents. All documents must be in the same language.
    // Only English ("en") is currently supported.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // A description of the status of the recognizer.
    Message *string `type:"string"`

    // Provides information about an entity recognizer.
    RecognizerMetadata *EntityRecognizerMetadata `type:"structure" sensitive:"true"`

    // Provides the status of the entity recognizer.
    Status *string `type:"string" enum:"ModelStatus"`

    // The time that the recognizer was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // The time that training of the entity recognizer was completed.
    TrainingEndTime *time.Time `type:"timestamp"`

    // The time that training of the entity recognizer started.
    TrainingStartTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your custom entity recognizer. For more information,
    // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

Describes information about an entity recognizer.

func (EntityRecognizerProperties) GoString

func (s EntityRecognizerProperties) GoString() string

GoString returns the string representation

func (*EntityRecognizerProperties) SetDataAccessRoleArn

func (s *EntityRecognizerProperties) SetDataAccessRoleArn(v string) *EntityRecognizerProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntityRecognizerProperties) SetEndTime

func (s *EntityRecognizerProperties) SetEndTime(v time.Time) *EntityRecognizerProperties

SetEndTime sets the EndTime field's value.

func (*EntityRecognizerProperties) SetEntityRecognizerArn

func (s *EntityRecognizerProperties) SetEntityRecognizerArn(v string) *EntityRecognizerProperties

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntityRecognizerProperties) SetInputDataConfig

func (s *EntityRecognizerProperties) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *EntityRecognizerProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntityRecognizerProperties) SetLanguageCode

func (s *EntityRecognizerProperties) SetLanguageCode(v string) *EntityRecognizerProperties

SetLanguageCode sets the LanguageCode field's value.

func (*EntityRecognizerProperties) SetMessage

func (s *EntityRecognizerProperties) SetMessage(v string) *EntityRecognizerProperties

SetMessage sets the Message field's value.

func (*EntityRecognizerProperties) SetRecognizerMetadata

func (s *EntityRecognizerProperties) SetRecognizerMetadata(v *EntityRecognizerMetadata) *EntityRecognizerProperties

SetRecognizerMetadata sets the RecognizerMetadata field's value.

func (*EntityRecognizerProperties) SetStatus

func (s *EntityRecognizerProperties) SetStatus(v string) *EntityRecognizerProperties

SetStatus sets the Status field's value.

func (*EntityRecognizerProperties) SetSubmitTime

func (s *EntityRecognizerProperties) SetSubmitTime(v time.Time) *EntityRecognizerProperties

SetSubmitTime sets the SubmitTime field's value.

func (*EntityRecognizerProperties) SetTrainingEndTime

func (s *EntityRecognizerProperties) SetTrainingEndTime(v time.Time) *EntityRecognizerProperties

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*EntityRecognizerProperties) SetTrainingStartTime

func (s *EntityRecognizerProperties) SetTrainingStartTime(v time.Time) *EntityRecognizerProperties

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*EntityRecognizerProperties) SetVolumeKmsKeyId

func (s *EntityRecognizerProperties) SetVolumeKmsKeyId(v string) *EntityRecognizerProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntityRecognizerProperties) SetVpcConfig

func (s *EntityRecognizerProperties) SetVpcConfig(v *VpcConfig) *EntityRecognizerProperties

SetVpcConfig sets the VpcConfig field's value.

func (EntityRecognizerProperties) String

func (s EntityRecognizerProperties) String() string

String returns the string representation

type EntityTypesEvaluationMetrics

type EntityTypesEvaluationMetrics struct {

    // A measure of how accurate the recognizer results are for for a specific entity
    // type in the test data. It is derived from the Precision and Recall values.
    // The F1Score is the harmonic average of the two scores. The highest score
    // is 1, and the worst score is 0.
    F1Score *float64 `type:"double"`

    // A measure of the usefulness of the recognizer results for a specific entity
    // type in the test data. High precision means that the recognizer returned
    // substantially more relevant results than irrelevant ones.
    Precision *float64 `type:"double"`

    // A measure of how complete the recognizer results are for a specific entity
    // type in the test data. High recall means that the recognizer returned most
    // of the relevant results.
    Recall *float64 `type:"double"`
    // contains filtered or unexported fields
}

Detailed information about the accuracy of an entity recognizer for a specific entity type.

func (EntityTypesEvaluationMetrics) GoString

func (s EntityTypesEvaluationMetrics) GoString() string

GoString returns the string representation

func (*EntityTypesEvaluationMetrics) SetF1Score

func (s *EntityTypesEvaluationMetrics) SetF1Score(v float64) *EntityTypesEvaluationMetrics

SetF1Score sets the F1Score field's value.

func (*EntityTypesEvaluationMetrics) SetPrecision

func (s *EntityTypesEvaluationMetrics) SetPrecision(v float64) *EntityTypesEvaluationMetrics

SetPrecision sets the Precision field's value.

func (*EntityTypesEvaluationMetrics) SetRecall

func (s *EntityTypesEvaluationMetrics) SetRecall(v float64) *EntityTypesEvaluationMetrics

SetRecall sets the Recall field's value.

func (EntityTypesEvaluationMetrics) String

func (s EntityTypesEvaluationMetrics) String() string

String returns the string representation

type EntityTypesListItem

type EntityTypesListItem struct {

    // An entity type within a labeled training dataset that Amazon Comprehend uses
    // to train a custom entity recognizer.
    //
    // Entity types must not contain the following invalid characters: \n (line
    // break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage
    // return), \t (tab), \\t (escaped tab), space, and , (comma).
    //
    // Type is a required field
    Type *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

func (EntityTypesListItem) GoString

func (s EntityTypesListItem) GoString() string

GoString returns the string representation

func (*EntityTypesListItem) SetType

func (s *EntityTypesListItem) SetType(v string) *EntityTypesListItem

SetType sets the Type field's value.

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 *string `type:"string" enum:"InputFormat"`

    // The Amazon S3 URI for the input data. The URI must be in same region as the
    // API endpoint that you are calling. The URI can point to a single input file
    // or it can provide the prefix for a collection of data files.
    //
    // For example, if you use the URI S3://bucketName/prefix, if the prefix is
    // a single file, Amazon Comprehend uses that file as input. If more than one
    // file begins with the prefix, Amazon Comprehend uses all of them as input.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

The input properties for a topic detection job.

func (InputDataConfig) GoString

func (s InputDataConfig) GoString() string

GoString returns the string representation

func (*InputDataConfig) SetInputFormat

func (s *InputDataConfig) SetInputFormat(v string) *InputDataConfig

SetInputFormat sets the InputFormat field's value.

func (*InputDataConfig) SetS3Uri

func (s *InputDataConfig) SetS3Uri(v string) *InputDataConfig

SetS3Uri sets the S3Uri field's value.

func (InputDataConfig) String

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate

func (s *InputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServerException

type InternalServerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation

type InvalidFilterException

type InvalidFilterException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The filter specified for the operation is invalid. Specify a different filter.

func (*InvalidFilterException) Code

func (s *InvalidFilterException) Code() string

Code returns the exception type name.

func (*InvalidFilterException) Error

func (s *InvalidFilterException) Error() string

func (InvalidFilterException) GoString

func (s InvalidFilterException) GoString() string

GoString returns the string representation

func (*InvalidFilterException) Message

func (s *InvalidFilterException) Message() string

Message returns the exception's message.

func (*InvalidFilterException) OrigErr

func (s *InvalidFilterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidFilterException) RequestID

func (s *InvalidFilterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidFilterException) StatusCode

func (s *InvalidFilterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidFilterException) String

func (s InvalidFilterException) String() string

String returns the string representation

type InvalidRequestException

type InvalidRequestException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The request is invalid.

func (*InvalidRequestException) Code

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (*InvalidRequestException) Message

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String

func (s InvalidRequestException) String() string

String returns the string representation

type JobNotFoundException

type JobNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The specified job was not found. Check the job ID and try again.

func (*JobNotFoundException) Code

func (s *JobNotFoundException) Code() string

Code returns the exception type name.

func (*JobNotFoundException) Error

func (s *JobNotFoundException) Error() string

func (JobNotFoundException) GoString

func (s JobNotFoundException) GoString() string

GoString returns the string representation

func (*JobNotFoundException) Message

func (s *JobNotFoundException) Message() string

Message returns the exception's message.

func (*JobNotFoundException) OrigErr

func (s *JobNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*JobNotFoundException) RequestID

func (s *JobNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*JobNotFoundException) StatusCode

func (s *JobNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (JobNotFoundException) String

func (s JobNotFoundException) String() string

String returns the string representation

type KeyPhrase

type KeyPhrase struct {

    // A character offset in the input text that shows where the key phrase begins
    // (the first character is at position 0). The offset returns the position of
    // each UTF-8 code point in the string. A code point is the abstract character
    // from a particular graphical representation. For example, a multi-byte UTF-8
    // character maps to a single code point.
    BeginOffset *int64 `type:"integer"`

    // A character offset in the input text where the key phrase ends. The offset
    // returns the position of each UTF-8 code point in the string. A code point
    // is the abstract character from a particular graphical representation. For
    // example, a multi-byte UTF-8 character maps to a single code point.
    EndOffset *int64 `type:"integer"`

    // The level of confidence that Amazon Comprehend has in the accuracy of the
    // detection.
    Score *float64 `type:"float"`

    // The text of a key noun phrase.
    Text *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Describes a key noun phrase.

func (KeyPhrase) GoString

func (s KeyPhrase) GoString() string

GoString returns the string representation

func (*KeyPhrase) SetBeginOffset

func (s *KeyPhrase) SetBeginOffset(v int64) *KeyPhrase

SetBeginOffset sets the BeginOffset field's value.

func (*KeyPhrase) SetEndOffset

func (s *KeyPhrase) SetEndOffset(v int64) *KeyPhrase

SetEndOffset sets the EndOffset field's value.

func (*KeyPhrase) SetScore

func (s *KeyPhrase) SetScore(v float64) *KeyPhrase

SetScore sets the Score field's value.

func (*KeyPhrase) SetText

func (s *KeyPhrase) SetText(v string) *KeyPhrase

SetText sets the Text field's value.

func (KeyPhrase) String

func (s KeyPhrase) String() string

String returns the string representation

type KeyPhrasesDetectionJobFilter

type KeyPhrasesDetectionJobFilter struct {

    // Filters on the name of the job.
    JobName *string `min:"1" type:"string"`

    // Filters the list of jobs based on job status. Returns only jobs with the
    // specified status.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted after the specified time. Jobs are
    // returned in descending order, newest to oldest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted before the specified time. Jobs are
    // returned in ascending order, oldest to newest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (KeyPhrasesDetectionJobFilter) GoString

func (s KeyPhrasesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*KeyPhrasesDetectionJobFilter) SetJobName

func (s *KeyPhrasesDetectionJobFilter) SetJobName(v string) *KeyPhrasesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobFilter) SetJobStatus

func (s *KeyPhrasesDetectionJobFilter) SetJobStatus(v string) *KeyPhrasesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeAfter

func (s *KeyPhrasesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *KeyPhrasesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeBefore

func (s *KeyPhrasesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *KeyPhrasesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (KeyPhrasesDetectionJobFilter) String

func (s KeyPhrasesDetectionJobFilter) String() string

String returns the string representation

func (*KeyPhrasesDetectionJobFilter) Validate

func (s *KeyPhrasesDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KeyPhrasesDetectionJobProperties

type KeyPhrasesDetectionJobProperties struct {

    // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
    // your input data.
    DataAccessRoleArn *string `min:"20" type:"string"`

    // The time that the key phrases detection job completed.
    EndTime *time.Time `type:"timestamp"`

    // The input data configuration that you supplied when you created the key phrases
    // detection job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the key phrases detection job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned the key phrases detection job.
    JobName *string `min:"1" type:"string"`

    // The current status of the key phrases detection job. If the status is FAILED,
    // the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // The language code of the input documents.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // A description of the status of a job.
    Message *string `type:"string"`

    // The output data configuration that you supplied when you created the key
    // phrases detection job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the key phrases detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your key phrases detection job. For more
    // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

Provides information about a key phrases detection job.

func (KeyPhrasesDetectionJobProperties) GoString

func (s KeyPhrasesDetectionJobProperties) GoString() string

GoString returns the string representation

func (*KeyPhrasesDetectionJobProperties) SetDataAccessRoleArn

func (s *KeyPhrasesDetectionJobProperties) SetDataAccessRoleArn(v string) *KeyPhrasesDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*KeyPhrasesDetectionJobProperties) SetEndTime

func (s *KeyPhrasesDetectionJobProperties) SetEndTime(v time.Time) *KeyPhrasesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*KeyPhrasesDetectionJobProperties) SetInputDataConfig

func (s *KeyPhrasesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *KeyPhrasesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobId

func (s *KeyPhrasesDetectionJobProperties) SetJobId(v string) *KeyPhrasesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobName

func (s *KeyPhrasesDetectionJobProperties) SetJobName(v string) *KeyPhrasesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobStatus

func (s *KeyPhrasesDetectionJobProperties) SetJobStatus(v string) *KeyPhrasesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobProperties) SetLanguageCode

func (s *KeyPhrasesDetectionJobProperties) SetLanguageCode(v string) *KeyPhrasesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*KeyPhrasesDetectionJobProperties) SetMessage

func (s *KeyPhrasesDetectionJobProperties) SetMessage(v string) *KeyPhrasesDetectionJobProperties

SetMessage sets the Message field's value.

func (*KeyPhrasesDetectionJobProperties) SetOutputDataConfig

func (s *KeyPhrasesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *KeyPhrasesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetSubmitTime

func (s *KeyPhrasesDetectionJobProperties) SetSubmitTime(v time.Time) *KeyPhrasesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*KeyPhrasesDetectionJobProperties) SetVolumeKmsKeyId

func (s *KeyPhrasesDetectionJobProperties) SetVolumeKmsKeyId(v string) *KeyPhrasesDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*KeyPhrasesDetectionJobProperties) SetVpcConfig

func (s *KeyPhrasesDetectionJobProperties) SetVpcConfig(v *VpcConfig) *KeyPhrasesDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (KeyPhrasesDetectionJobProperties) String

func (s KeyPhrasesDetectionJobProperties) String() string

String returns the string representation

type KmsKeyValidationException

type KmsKeyValidationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

func (*KmsKeyValidationException) Code

func (s *KmsKeyValidationException) Code() string

Code returns the exception type name.

func (*KmsKeyValidationException) Error

func (s *KmsKeyValidationException) Error() string

func (KmsKeyValidationException) GoString

func (s KmsKeyValidationException) GoString() string

GoString returns the string representation

func (*KmsKeyValidationException) Message

func (s *KmsKeyValidationException) Message() string

Message returns the exception's message.

func (*KmsKeyValidationException) OrigErr

func (s *KmsKeyValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KmsKeyValidationException) RequestID

func (s *KmsKeyValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KmsKeyValidationException) StatusCode

func (s *KmsKeyValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KmsKeyValidationException) String

func (s KmsKeyValidationException) String() string

String returns the string representation

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
}

func (ListDocumentClassificationJobsInput) GoString

func (s ListDocumentClassificationJobsInput) GoString() string

GoString returns the string representation

func (*ListDocumentClassificationJobsInput) SetFilter

func (s *ListDocumentClassificationJobsInput) SetFilter(v *DocumentClassificationJobFilter) *ListDocumentClassificationJobsInput

SetFilter sets the Filter field's value.

func (*ListDocumentClassificationJobsInput) SetMaxResults

func (s *ListDocumentClassificationJobsInput) SetMaxResults(v int64) *ListDocumentClassificationJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentClassificationJobsInput) SetNextToken

func (s *ListDocumentClassificationJobsInput) SetNextToken(v string) *ListDocumentClassificationJobsInput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassificationJobsInput) String

func (s ListDocumentClassificationJobsInput) String() string

String returns the string representation

func (*ListDocumentClassificationJobsInput) Validate

func (s *ListDocumentClassificationJobsInput) Validate() error

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
}

func (ListDocumentClassificationJobsOutput) GoString

func (s ListDocumentClassificationJobsOutput) GoString() string

GoString returns the string representation

func (*ListDocumentClassificationJobsOutput) SetDocumentClassificationJobPropertiesList

func (s *ListDocumentClassificationJobsOutput) SetDocumentClassificationJobPropertiesList(v []*DocumentClassificationJobProperties) *ListDocumentClassificationJobsOutput

SetDocumentClassificationJobPropertiesList sets the DocumentClassificationJobPropertiesList field's value.

func (*ListDocumentClassificationJobsOutput) SetNextToken

func (s *ListDocumentClassificationJobsOutput) SetNextToken(v string) *ListDocumentClassificationJobsOutput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassificationJobsOutput) String

func (s ListDocumentClassificationJobsOutput) String() string

String returns the string representation

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
}

func (ListDocumentClassifiersInput) GoString

func (s ListDocumentClassifiersInput) GoString() string

GoString returns the string representation

func (*ListDocumentClassifiersInput) SetFilter

func (s *ListDocumentClassifiersInput) SetFilter(v *DocumentClassifierFilter) *ListDocumentClassifiersInput

SetFilter sets the Filter field's value.

func (*ListDocumentClassifiersInput) SetMaxResults

func (s *ListDocumentClassifiersInput) SetMaxResults(v int64) *ListDocumentClassifiersInput

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentClassifiersInput) SetNextToken

func (s *ListDocumentClassifiersInput) SetNextToken(v string) *ListDocumentClassifiersInput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifiersInput) String

func (s ListDocumentClassifiersInput) String() 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
}

func (ListDocumentClassifiersOutput) GoString

func (s ListDocumentClassifiersOutput) GoString() string

GoString returns the string representation

func (*ListDocumentClassifiersOutput) SetDocumentClassifierPropertiesList

func (s *ListDocumentClassifiersOutput) SetDocumentClassifierPropertiesList(v []*DocumentClassifierProperties) *ListDocumentClassifiersOutput

SetDocumentClassifierPropertiesList sets the DocumentClassifierPropertiesList field's value.

func (*ListDocumentClassifiersOutput) SetNextToken

func (s *ListDocumentClassifiersOutput) SetNextToken(v string) *ListDocumentClassifiersOutput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifiersOutput) String

func (s ListDocumentClassifiersOutput) String() string

String returns the string representation

type ListDominantLanguageDetectionJobsInput

type ListDominantLanguageDetectionJobsInput struct {

    // Filters that jobs that are returned. You can filter jobs on their name, status,
    // or the date and time that they were submitted. You can only set one filter
    // at a time.
    Filter *DominantLanguageDetectionJobFilter `type:"structure"`

    // The maximum number of results to return in each page. The default is 100.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListDominantLanguageDetectionJobsInput) GoString

func (s ListDominantLanguageDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListDominantLanguageDetectionJobsInput) SetFilter

func (s *ListDominantLanguageDetectionJobsInput) SetFilter(v *DominantLanguageDetectionJobFilter) *ListDominantLanguageDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListDominantLanguageDetectionJobsInput) SetMaxResults

func (s *ListDominantLanguageDetectionJobsInput) SetMaxResults(v int64) *ListDominantLanguageDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDominantLanguageDetectionJobsInput) SetNextToken

func (s *ListDominantLanguageDetectionJobsInput) SetNextToken(v string) *ListDominantLanguageDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsInput) String

func (s ListDominantLanguageDetectionJobsInput) String() string

String returns the string representation

func (*ListDominantLanguageDetectionJobsInput) Validate

func (s *ListDominantLanguageDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDominantLanguageDetectionJobsOutput

type ListDominantLanguageDetectionJobsOutput struct {

    // A list containing the properties of each job that is returned.
    DominantLanguageDetectionJobPropertiesList []*DominantLanguageDetectionJobProperties `type:"list"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListDominantLanguageDetectionJobsOutput) GoString

func (s ListDominantLanguageDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListDominantLanguageDetectionJobsOutput) SetDominantLanguageDetectionJobPropertiesList

func (s *ListDominantLanguageDetectionJobsOutput) SetDominantLanguageDetectionJobPropertiesList(v []*DominantLanguageDetectionJobProperties) *ListDominantLanguageDetectionJobsOutput

SetDominantLanguageDetectionJobPropertiesList sets the DominantLanguageDetectionJobPropertiesList field's value.

func (*ListDominantLanguageDetectionJobsOutput) SetNextToken

func (s *ListDominantLanguageDetectionJobsOutput) SetNextToken(v string) *ListDominantLanguageDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsOutput) String

func (s ListDominantLanguageDetectionJobsOutput) String() string

String returns the string representation

type ListEndpointsInput

type ListEndpointsInput struct {

    // Filters the endpoints that are returned. You can filter endpoints on their
    // name, model, status, or the date and time that they were created. You can
    // only set one filter at a time.
    Filter *EndpointFilter `type:"structure"`

    // The maximum number of results to return in each page. The default is 100.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListEndpointsInput) GoString

func (s ListEndpointsInput) GoString() string

GoString returns the string representation

func (*ListEndpointsInput) SetFilter

func (s *ListEndpointsInput) SetFilter(v *EndpointFilter) *ListEndpointsInput

SetFilter sets the Filter field's value.

func (*ListEndpointsInput) SetMaxResults

func (s *ListEndpointsInput) SetMaxResults(v int64) *ListEndpointsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEndpointsInput) SetNextToken

func (s *ListEndpointsInput) SetNextToken(v string) *ListEndpointsInput

SetNextToken sets the NextToken field's value.

func (ListEndpointsInput) String

func (s ListEndpointsInput) String() string

String returns the string representation

func (*ListEndpointsInput) Validate

func (s *ListEndpointsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEndpointsOutput

type ListEndpointsOutput struct {

    // Displays a list of endpoint properties being retrieved by the service in
    // response to the request.
    EndpointPropertiesList []*EndpointProperties `type:"list"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListEndpointsOutput) GoString

func (s ListEndpointsOutput) GoString() string

GoString returns the string representation

func (*ListEndpointsOutput) SetEndpointPropertiesList

func (s *ListEndpointsOutput) SetEndpointPropertiesList(v []*EndpointProperties) *ListEndpointsOutput

SetEndpointPropertiesList sets the EndpointPropertiesList field's value.

func (*ListEndpointsOutput) SetNextToken

func (s *ListEndpointsOutput) SetNextToken(v string) *ListEndpointsOutput

SetNextToken sets the NextToken field's value.

func (ListEndpointsOutput) String

func (s ListEndpointsOutput) String() string

String returns the string representation

type ListEntitiesDetectionJobsInput

type ListEntitiesDetectionJobsInput struct {

    // Filters the jobs that are returned. You can filter jobs on their name, status,
    // or the date and time that they were submitted. You can only set one filter
    // at a time.
    Filter *EntitiesDetectionJobFilter `type:"structure"`

    // The maximum number of results to return in each page. The default is 100.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListEntitiesDetectionJobsInput) GoString

func (s ListEntitiesDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListEntitiesDetectionJobsInput) SetFilter

func (s *ListEntitiesDetectionJobsInput) SetFilter(v *EntitiesDetectionJobFilter) *ListEntitiesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListEntitiesDetectionJobsInput) SetMaxResults

func (s *ListEntitiesDetectionJobsInput) SetMaxResults(v int64) *ListEntitiesDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesDetectionJobsInput) SetNextToken

func (s *ListEntitiesDetectionJobsInput) SetNextToken(v string) *ListEntitiesDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsInput) String

func (s ListEntitiesDetectionJobsInput) String() string

String returns the string representation

func (*ListEntitiesDetectionJobsInput) Validate

func (s *ListEntitiesDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntitiesDetectionJobsOutput

type ListEntitiesDetectionJobsOutput struct {

    // A list containing the properties of each job that is returned.
    EntitiesDetectionJobPropertiesList []*EntitiesDetectionJobProperties `type:"list"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListEntitiesDetectionJobsOutput) GoString

func (s ListEntitiesDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListEntitiesDetectionJobsOutput) SetEntitiesDetectionJobPropertiesList

func (s *ListEntitiesDetectionJobsOutput) SetEntitiesDetectionJobPropertiesList(v []*EntitiesDetectionJobProperties) *ListEntitiesDetectionJobsOutput

SetEntitiesDetectionJobPropertiesList sets the EntitiesDetectionJobPropertiesList field's value.

func (*ListEntitiesDetectionJobsOutput) SetNextToken

func (s *ListEntitiesDetectionJobsOutput) SetNextToken(v string) *ListEntitiesDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsOutput) String

func (s ListEntitiesDetectionJobsOutput) String() string

String returns the string representation

type 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
}

func (ListEntityRecognizersInput) GoString

func (s ListEntityRecognizersInput) GoString() string

GoString returns the string representation

func (*ListEntityRecognizersInput) SetFilter

func (s *ListEntityRecognizersInput) SetFilter(v *EntityRecognizerFilter) *ListEntityRecognizersInput

SetFilter sets the Filter field's value.

func (*ListEntityRecognizersInput) SetMaxResults

func (s *ListEntityRecognizersInput) SetMaxResults(v int64) *ListEntityRecognizersInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntityRecognizersInput) SetNextToken

func (s *ListEntityRecognizersInput) SetNextToken(v string) *ListEntityRecognizersInput

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizersInput) String

func (s ListEntityRecognizersInput) String() 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
}

func (ListEntityRecognizersOutput) GoString

func (s ListEntityRecognizersOutput) GoString() string

GoString returns the string representation

func (*ListEntityRecognizersOutput) SetEntityRecognizerPropertiesList

func (s *ListEntityRecognizersOutput) SetEntityRecognizerPropertiesList(v []*EntityRecognizerProperties) *ListEntityRecognizersOutput

SetEntityRecognizerPropertiesList sets the EntityRecognizerPropertiesList field's value.

func (*ListEntityRecognizersOutput) SetNextToken

func (s *ListEntityRecognizersOutput) SetNextToken(v string) *ListEntityRecognizersOutput

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizersOutput) String

func (s ListEntityRecognizersOutput) String() string

String returns the string representation

type ListKeyPhrasesDetectionJobsInput

type ListKeyPhrasesDetectionJobsInput struct {

    // Filters the jobs that are returned. You can filter jobs on their name, status,
    // or the date and time that they were submitted. You can only set one filter
    // at a time.
    Filter *KeyPhrasesDetectionJobFilter `type:"structure"`

    // The maximum number of results to return in each page. The default is 100.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListKeyPhrasesDetectionJobsInput) GoString

func (s ListKeyPhrasesDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) SetFilter

func (s *ListKeyPhrasesDetectionJobsInput) SetFilter(v *KeyPhrasesDetectionJobFilter) *ListKeyPhrasesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetMaxResults

func (s *ListKeyPhrasesDetectionJobsInput) SetMaxResults(v int64) *ListKeyPhrasesDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetNextToken

func (s *ListKeyPhrasesDetectionJobsInput) SetNextToken(v string) *ListKeyPhrasesDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsInput) String

func (s ListKeyPhrasesDetectionJobsInput) String() string

String returns the string representation

func (*ListKeyPhrasesDetectionJobsInput) Validate

func (s *ListKeyPhrasesDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKeyPhrasesDetectionJobsOutput

type ListKeyPhrasesDetectionJobsOutput struct {

    // A list containing the properties of each job that is returned.
    KeyPhrasesDetectionJobPropertiesList []*KeyPhrasesDetectionJobProperties `type:"list"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListKeyPhrasesDetectionJobsOutput) GoString

func (s ListKeyPhrasesDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListKeyPhrasesDetectionJobsOutput) SetKeyPhrasesDetectionJobPropertiesList

func (s *ListKeyPhrasesDetectionJobsOutput) SetKeyPhrasesDetectionJobPropertiesList(v []*KeyPhrasesDetectionJobProperties) *ListKeyPhrasesDetectionJobsOutput

SetKeyPhrasesDetectionJobPropertiesList sets the KeyPhrasesDetectionJobPropertiesList field's value.

func (*ListKeyPhrasesDetectionJobsOutput) SetNextToken

func (s *ListKeyPhrasesDetectionJobsOutput) SetNextToken(v string) *ListKeyPhrasesDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsOutput) String

func (s ListKeyPhrasesDetectionJobsOutput) String() string

String returns the string representation

type ListPiiEntitiesDetectionJobsInput

type ListPiiEntitiesDetectionJobsInput 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 *PiiEntitiesDetectionJobFilter `type:"structure"`

    // The maximum number of results to return in each page.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListPiiEntitiesDetectionJobsInput) GoString

func (s ListPiiEntitiesDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListPiiEntitiesDetectionJobsInput) SetFilter

func (s *ListPiiEntitiesDetectionJobsInput) SetFilter(v *PiiEntitiesDetectionJobFilter) *ListPiiEntitiesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListPiiEntitiesDetectionJobsInput) SetMaxResults

func (s *ListPiiEntitiesDetectionJobsInput) SetMaxResults(v int64) *ListPiiEntitiesDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPiiEntitiesDetectionJobsInput) SetNextToken

func (s *ListPiiEntitiesDetectionJobsInput) SetNextToken(v string) *ListPiiEntitiesDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListPiiEntitiesDetectionJobsInput) String

func (s ListPiiEntitiesDetectionJobsInput) String() string

String returns the string representation

func (*ListPiiEntitiesDetectionJobsInput) Validate

func (s *ListPiiEntitiesDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPiiEntitiesDetectionJobsOutput

type ListPiiEntitiesDetectionJobsOutput 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.
    PiiEntitiesDetectionJobPropertiesList []*PiiEntitiesDetectionJobProperties `type:"list"`
    // contains filtered or unexported fields
}

func (ListPiiEntitiesDetectionJobsOutput) GoString

func (s ListPiiEntitiesDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListPiiEntitiesDetectionJobsOutput) SetNextToken

func (s *ListPiiEntitiesDetectionJobsOutput) SetNextToken(v string) *ListPiiEntitiesDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListPiiEntitiesDetectionJobsOutput) SetPiiEntitiesDetectionJobPropertiesList

func (s *ListPiiEntitiesDetectionJobsOutput) SetPiiEntitiesDetectionJobPropertiesList(v []*PiiEntitiesDetectionJobProperties) *ListPiiEntitiesDetectionJobsOutput

SetPiiEntitiesDetectionJobPropertiesList sets the PiiEntitiesDetectionJobPropertiesList field's value.

func (ListPiiEntitiesDetectionJobsOutput) String

func (s ListPiiEntitiesDetectionJobsOutput) String() string

String returns the string representation

type ListSentimentDetectionJobsInput

type ListSentimentDetectionJobsInput struct {

    // Filters the jobs that are returned. You can filter jobs on their name, status,
    // or the date and time that they were submitted. You can only set one filter
    // at a time.
    Filter *SentimentDetectionJobFilter `type:"structure"`

    // The maximum number of results to return in each page. The default is 100.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListSentimentDetectionJobsInput) GoString

func (s ListSentimentDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListSentimentDetectionJobsInput) SetFilter

func (s *ListSentimentDetectionJobsInput) SetFilter(v *SentimentDetectionJobFilter) *ListSentimentDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListSentimentDetectionJobsInput) SetMaxResults

func (s *ListSentimentDetectionJobsInput) SetMaxResults(v int64) *ListSentimentDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSentimentDetectionJobsInput) SetNextToken

func (s *ListSentimentDetectionJobsInput) SetNextToken(v string) *ListSentimentDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListSentimentDetectionJobsInput) String

func (s ListSentimentDetectionJobsInput) String() string

String returns the string representation

func (*ListSentimentDetectionJobsInput) Validate

func (s *ListSentimentDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSentimentDetectionJobsOutput

type ListSentimentDetectionJobsOutput struct {

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`

    // A list containing the properties of each job that is returned.
    SentimentDetectionJobPropertiesList []*SentimentDetectionJobProperties `type:"list"`
    // contains filtered or unexported fields
}

func (ListSentimentDetectionJobsOutput) GoString

func (s ListSentimentDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListSentimentDetectionJobsOutput) SetNextToken

func (s *ListSentimentDetectionJobsOutput) SetNextToken(v string) *ListSentimentDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListSentimentDetectionJobsOutput) SetSentimentDetectionJobPropertiesList

func (s *ListSentimentDetectionJobsOutput) SetSentimentDetectionJobPropertiesList(v []*SentimentDetectionJobProperties) *ListSentimentDetectionJobsOutput

SetSentimentDetectionJobPropertiesList sets the SentimentDetectionJobPropertiesList field's value.

func (ListSentimentDetectionJobsOutput) String

func (s ListSentimentDetectionJobsOutput) String() string

String returns the string representation

type 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
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

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
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetResourceArn

func (s *ListTagsForResourceOutput) SetResourceArn(v string) *ListTagsForResourceOutput

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetTags

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTopicsDetectionJobsInput

type ListTopicsDetectionJobsInput struct {

    // Filters the jobs that are returned. Jobs can be filtered on their name, status,
    // or the date and time that they were submitted. You can set only one filter
    // at a time.
    Filter *TopicsDetectionJobFilter `type:"structure"`

    // The maximum number of results to return in each page. The default is 100.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListTopicsDetectionJobsInput) GoString

func (s ListTopicsDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListTopicsDetectionJobsInput) SetFilter

func (s *ListTopicsDetectionJobsInput) SetFilter(v *TopicsDetectionJobFilter) *ListTopicsDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListTopicsDetectionJobsInput) SetMaxResults

func (s *ListTopicsDetectionJobsInput) SetMaxResults(v int64) *ListTopicsDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTopicsDetectionJobsInput) SetNextToken

func (s *ListTopicsDetectionJobsInput) SetNextToken(v string) *ListTopicsDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListTopicsDetectionJobsInput) String

func (s ListTopicsDetectionJobsInput) String() string

String returns the string representation

func (*ListTopicsDetectionJobsInput) Validate

func (s *ListTopicsDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTopicsDetectionJobsOutput

type ListTopicsDetectionJobsOutput struct {

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`

    // A list containing the properties of each job that is returned.
    TopicsDetectionJobPropertiesList []*TopicsDetectionJobProperties `type:"list"`
    // contains filtered or unexported fields
}

func (ListTopicsDetectionJobsOutput) GoString

func (s ListTopicsDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListTopicsDetectionJobsOutput) SetNextToken

func (s *ListTopicsDetectionJobsOutput) SetNextToken(v string) *ListTopicsDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList

func (s *ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList(v []*TopicsDetectionJobProperties) *ListTopicsDetectionJobsOutput

SetTopicsDetectionJobPropertiesList sets the TopicsDetectionJobPropertiesList field's value.

func (ListTopicsDetectionJobsOutput) String

func (s ListTopicsDetectionJobsOutput) String() string

String returns the string representation

type OutputDataConfig

type OutputDataConfig struct {

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt the output results from an analysis job. The KmsKeyId can be one
    // of the following formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * KMS Key Alias: "alias/ExampleAlias"
    //
    //    * ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
    KmsKeyId *string `type:"string"`

    // When you use the OutputDataConfig object with asynchronous operations, you
    // specify the Amazon S3 location where you want to write the output data. The
    // URI must be in the same region as the API endpoint that you are calling.
    // The location is used as the prefix for the actual location of the output
    // file.
    //
    // When the topic detection job is finished, the service creates an output file
    // in a directory specific to the job. The S3Uri field contains the location
    // of the output file, called output.tar.gz. It is a compressed archive that
    // contains the ouput of the operation.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides configuration parameters for the output of topic detection jobs.

func (OutputDataConfig) GoString

func (s OutputDataConfig) GoString() string

GoString returns the string representation

func (*OutputDataConfig) SetKmsKeyId

func (s *OutputDataConfig) SetKmsKeyId(v string) *OutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*OutputDataConfig) SetS3Uri

func (s *OutputDataConfig) SetS3Uri(v string) *OutputDataConfig

SetS3Uri sets the S3Uri field's value.

func (OutputDataConfig) String

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate

func (s *OutputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PartOfSpeechTag

type PartOfSpeechTag struct {

    // The confidence that Amazon Comprehend has that the part of speech was correctly
    // identified.
    Score *float64 `type:"float"`

    // Identifies the part of speech that the token represents.
    Tag *string `type:"string" enum:"PartOfSpeechTagType"`
    // contains filtered or unexported fields
}

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.

func (PartOfSpeechTag) GoString

func (s PartOfSpeechTag) GoString() string

GoString returns the string representation

func (*PartOfSpeechTag) SetScore

func (s *PartOfSpeechTag) SetScore(v float64) *PartOfSpeechTag

SetScore sets the Score field's value.

func (*PartOfSpeechTag) SetTag

func (s *PartOfSpeechTag) SetTag(v string) *PartOfSpeechTag

SetTag sets the Tag field's value.

func (PartOfSpeechTag) String

func (s PartOfSpeechTag) String() string

String returns the string representation

type PiiEntitiesDetectionJobFilter

type PiiEntitiesDetectionJobFilter struct {

    // Filters on the name of the job.
    JobName *string `min:"1" type:"string"`

    // Filters the list of jobs based on job status. Returns only jobs with the
    // specified status.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted after the specified time. Jobs are
    // returned in descending order, newest to oldest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted before the specified time. Jobs are
    // returned in ascending order, oldest to newest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of PII entity detection jobs.

func (PiiEntitiesDetectionJobFilter) GoString

func (s PiiEntitiesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*PiiEntitiesDetectionJobFilter) SetJobName

func (s *PiiEntitiesDetectionJobFilter) SetJobName(v string) *PiiEntitiesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*PiiEntitiesDetectionJobFilter) SetJobStatus

func (s *PiiEntitiesDetectionJobFilter) SetJobStatus(v string) *PiiEntitiesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*PiiEntitiesDetectionJobFilter) SetSubmitTimeAfter

func (s *PiiEntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *PiiEntitiesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*PiiEntitiesDetectionJobFilter) SetSubmitTimeBefore

func (s *PiiEntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *PiiEntitiesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (PiiEntitiesDetectionJobFilter) String

func (s PiiEntitiesDetectionJobFilter) String() string

String returns the string representation

func (*PiiEntitiesDetectionJobFilter) Validate

func (s *PiiEntitiesDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PiiEntitiesDetectionJobProperties

type PiiEntitiesDetectionJobProperties 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 PII entities detection job completed.
    EndTime *time.Time `type:"timestamp"`

    // The input properties for a PII entities detection job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the PII entities detection job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned the PII entities detection job.
    JobName *string `min:"1" type:"string"`

    // The current status of the PII entities detection job. If the status is FAILED,
    // the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // The language code of the input documents
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // A description of the status of a job.
    Message *string `type:"string"`

    // Specifies whether the output provides the locations (offsets) of PII entities
    // or a file in which PII entities are redacted.
    Mode *string `type:"string" enum:"PiiEntitiesDetectionMode"`

    // The output data configuration that you supplied when you created the PII
    // entities detection job.
    OutputDataConfig *PiiOutputDataConfig `type:"structure"`

    // Provides configuration parameters for PII entity redaction.
    //
    // This parameter is required if you set the Mode parameter to ONLY_REDACTION.
    // In that case, you must provide a RedactionConfig definition that includes
    // the PiiEntityTypes parameter.
    RedactionConfig *RedactionConfig `type:"structure"`

    // The time that the PII entities detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information about a PII entities detection job.

func (PiiEntitiesDetectionJobProperties) GoString

func (s PiiEntitiesDetectionJobProperties) GoString() string

GoString returns the string representation

func (*PiiEntitiesDetectionJobProperties) SetDataAccessRoleArn

func (s *PiiEntitiesDetectionJobProperties) SetDataAccessRoleArn(v string) *PiiEntitiesDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*PiiEntitiesDetectionJobProperties) SetEndTime

func (s *PiiEntitiesDetectionJobProperties) SetEndTime(v time.Time) *PiiEntitiesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*PiiEntitiesDetectionJobProperties) SetInputDataConfig

func (s *PiiEntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *PiiEntitiesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*PiiEntitiesDetectionJobProperties) SetJobId

func (s *PiiEntitiesDetectionJobProperties) SetJobId(v string) *PiiEntitiesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*PiiEntitiesDetectionJobProperties) SetJobName

func (s *PiiEntitiesDetectionJobProperties) SetJobName(v string) *PiiEntitiesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*PiiEntitiesDetectionJobProperties) SetJobStatus

func (s *PiiEntitiesDetectionJobProperties) SetJobStatus(v string) *PiiEntitiesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*PiiEntitiesDetectionJobProperties) SetLanguageCode

func (s *PiiEntitiesDetectionJobProperties) SetLanguageCode(v string) *PiiEntitiesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*PiiEntitiesDetectionJobProperties) SetMessage

func (s *PiiEntitiesDetectionJobProperties) SetMessage(v string) *PiiEntitiesDetectionJobProperties

SetMessage sets the Message field's value.

func (*PiiEntitiesDetectionJobProperties) SetMode

func (s *PiiEntitiesDetectionJobProperties) SetMode(v string) *PiiEntitiesDetectionJobProperties

SetMode sets the Mode field's value.

func (*PiiEntitiesDetectionJobProperties) SetOutputDataConfig

func (s *PiiEntitiesDetectionJobProperties) SetOutputDataConfig(v *PiiOutputDataConfig) *PiiEntitiesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*PiiEntitiesDetectionJobProperties) SetRedactionConfig

func (s *PiiEntitiesDetectionJobProperties) SetRedactionConfig(v *RedactionConfig) *PiiEntitiesDetectionJobProperties

SetRedactionConfig sets the RedactionConfig field's value.

func (*PiiEntitiesDetectionJobProperties) SetSubmitTime

func (s *PiiEntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *PiiEntitiesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (PiiEntitiesDetectionJobProperties) String

func (s PiiEntitiesDetectionJobProperties) String() string

String returns the string representation

type PiiEntity

type PiiEntity struct {

    // A character offset in the input text that shows where the PII 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 PII 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 entity's type.
    Type *string `type:"string" enum:"PiiEntityType"`
    // contains filtered or unexported fields
}

Provides information about a PII entity.

func (PiiEntity) GoString

func (s PiiEntity) GoString() string

GoString returns the string representation

func (*PiiEntity) SetBeginOffset

func (s *PiiEntity) SetBeginOffset(v int64) *PiiEntity

SetBeginOffset sets the BeginOffset field's value.

func (*PiiEntity) SetEndOffset

func (s *PiiEntity) SetEndOffset(v int64) *PiiEntity

SetEndOffset sets the EndOffset field's value.

func (*PiiEntity) SetScore

func (s *PiiEntity) SetScore(v float64) *PiiEntity

SetScore sets the Score field's value.

func (*PiiEntity) SetType

func (s *PiiEntity) SetType(v string) *PiiEntity

SetType sets the Type field's value.

func (PiiEntity) String

func (s PiiEntity) String() string

String returns the string representation

type PiiOutputDataConfig

type PiiOutputDataConfig struct {

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt the output results from an analysis job.
    KmsKeyId *string `type:"string"`

    // When you use the PiiOutputDataConfig object with asynchronous operations,
    // you specify the Amazon S3 location where you want to write the output data.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides configuration parameters for the output of PII entity detection jobs.

func (PiiOutputDataConfig) GoString

func (s PiiOutputDataConfig) GoString() string

GoString returns the string representation

func (*PiiOutputDataConfig) SetKmsKeyId

func (s *PiiOutputDataConfig) SetKmsKeyId(v string) *PiiOutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*PiiOutputDataConfig) SetS3Uri

func (s *PiiOutputDataConfig) SetS3Uri(v string) *PiiOutputDataConfig

SetS3Uri sets the S3Uri field's value.

func (PiiOutputDataConfig) String

func (s PiiOutputDataConfig) String() string

String returns the string representation

type RedactionConfig

type RedactionConfig struct {

    // A character that replaces each character in the redacted PII entity.
    MaskCharacter *string `min:"1" type:"string"`

    // Specifies whether the PII entity is redacted with the mask character or the
    // entity type.
    MaskMode *string `type:"string" enum:"PiiEntitiesDetectionMaskMode"`

    // An array of the types of PII entities that Amazon Comprehend detects in the
    // input text for your request.
    PiiEntityTypes []*string `type:"list"`
    // contains filtered or unexported fields
}

Provides configuration parameters for PII entity redaction.

func (RedactionConfig) GoString

func (s RedactionConfig) GoString() string

GoString returns the string representation

func (*RedactionConfig) SetMaskCharacter

func (s *RedactionConfig) SetMaskCharacter(v string) *RedactionConfig

SetMaskCharacter sets the MaskCharacter field's value.

func (*RedactionConfig) SetMaskMode

func (s *RedactionConfig) SetMaskMode(v string) *RedactionConfig

SetMaskMode sets the MaskMode field's value.

func (*RedactionConfig) SetPiiEntityTypes

func (s *RedactionConfig) SetPiiEntityTypes(v []*string) *RedactionConfig

SetPiiEntityTypes sets the PiiEntityTypes field's value.

func (RedactionConfig) String

func (s RedactionConfig) String() string

String returns the string representation

func (*RedactionConfig) Validate

func (s *RedactionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceInUseException

type ResourceInUseException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The specified resource name is already in use. Use a different name and try your request again.

func (*ResourceInUseException) Code

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString

func (s ResourceInUseException) GoString() string

GoString returns the string representation

func (*ResourceInUseException) Message

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String

func (s ResourceInUseException) String() string

String returns the string representation

type ResourceLimitExceededException

type ResourceLimitExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

func (*ResourceLimitExceededException) Code

func (s *ResourceLimitExceededException) Code() string

Code returns the exception type name.

func (*ResourceLimitExceededException) Error

func (s *ResourceLimitExceededException) Error() string

func (ResourceLimitExceededException) GoString

func (s ResourceLimitExceededException) GoString() string

GoString returns the string representation

func (*ResourceLimitExceededException) Message

func (s *ResourceLimitExceededException) Message() string

Message returns the exception's message.

func (*ResourceLimitExceededException) OrigErr

func (s *ResourceLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceededException) RequestID

func (s *ResourceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceededException) StatusCode

func (s *ResourceLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitExceededException) String

func (s ResourceLimitExceededException) String() string

String returns the string representation

type ResourceNotFoundException

type ResourceNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The specified resource ARN was not found. Check the ARN and try your request again.

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResourceUnavailableException

type ResourceUnavailableException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The specified resource is not available. Check the resource and try your request again.

func (*ResourceUnavailableException) Code

func (s *ResourceUnavailableException) Code() string

Code returns the exception type name.

func (*ResourceUnavailableException) Error

func (s *ResourceUnavailableException) Error() string

func (ResourceUnavailableException) GoString

func (s ResourceUnavailableException) GoString() string

GoString returns the string representation

func (*ResourceUnavailableException) Message

func (s *ResourceUnavailableException) Message() string

Message returns the exception's message.

func (*ResourceUnavailableException) OrigErr

func (s *ResourceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceUnavailableException) RequestID

func (s *ResourceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceUnavailableException) StatusCode

func (s *ResourceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceUnavailableException) String

func (s ResourceUnavailableException) String() string

String returns the string representation

type SentimentDetectionJobFilter

type SentimentDetectionJobFilter struct {

    // Filters on the name of the job.
    JobName *string `min:"1" type:"string"`

    // Filters the list of jobs based on job status. Returns only jobs with the
    // specified status.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted after the specified time. Jobs are
    // returned in descending order, newest to oldest.
    SubmitTimeAfter *time.Time `type:"timestamp"`

    // Filters the list of jobs based on the time that the job was submitted for
    // processing. Returns only jobs submitted before the specified time. Jobs are
    // returned in ascending order, oldest to newest.
    SubmitTimeBefore *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (SentimentDetectionJobFilter) GoString

func (s SentimentDetectionJobFilter) GoString() string

GoString returns the string representation

func (*SentimentDetectionJobFilter) SetJobName

func (s *SentimentDetectionJobFilter) SetJobName(v string) *SentimentDetectionJobFilter

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobFilter) SetJobStatus

func (s *SentimentDetectionJobFilter) SetJobStatus(v string) *SentimentDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeAfter

func (s *SentimentDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *SentimentDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeBefore

func (s *SentimentDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *SentimentDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (SentimentDetectionJobFilter) String

func (s SentimentDetectionJobFilter) String() string

String returns the string representation

func (*SentimentDetectionJobFilter) Validate

func (s *SentimentDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SentimentDetectionJobProperties

type SentimentDetectionJobProperties struct {

    // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
    // your input data.
    DataAccessRoleArn *string `min:"20" type:"string"`

    // The time that the sentiment detection job ended.
    EndTime *time.Time `type:"timestamp"`

    // The input data configuration that you supplied when you created the sentiment
    // detection job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the sentiment detection job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned to the sentiment detection job
    JobName *string `min:"1" type:"string"`

    // The current status of the sentiment detection job. If the status is FAILED,
    // the Messages field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // The language code of the input documents.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // A description of the status of a job.
    Message *string `type:"string"`

    // The output data configuration that you supplied when you created the sentiment
    // detection job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the sentiment detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your sentiment detection job. For more information,
    // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

Provides information about a sentiment detection job.

func (SentimentDetectionJobProperties) GoString

func (s SentimentDetectionJobProperties) GoString() string

GoString returns the string representation

func (*SentimentDetectionJobProperties) SetDataAccessRoleArn

func (s *SentimentDetectionJobProperties) SetDataAccessRoleArn(v string) *SentimentDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*SentimentDetectionJobProperties) SetEndTime

func (s *SentimentDetectionJobProperties) SetEndTime(v time.Time) *SentimentDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*SentimentDetectionJobProperties) SetInputDataConfig

func (s *SentimentDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *SentimentDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetJobId

func (s *SentimentDetectionJobProperties) SetJobId(v string) *SentimentDetectionJobProperties

SetJobId sets the JobId field's value.

func (*SentimentDetectionJobProperties) SetJobName

func (s *SentimentDetectionJobProperties) SetJobName(v string) *SentimentDetectionJobProperties

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobProperties) SetJobStatus

func (s *SentimentDetectionJobProperties) SetJobStatus(v string) *SentimentDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobProperties) SetLanguageCode

func (s *SentimentDetectionJobProperties) SetLanguageCode(v string) *SentimentDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*SentimentDetectionJobProperties) SetMessage

func (s *SentimentDetectionJobProperties) SetMessage(v string) *SentimentDetectionJobProperties

SetMessage sets the Message field's value.

func (*SentimentDetectionJobProperties) SetOutputDataConfig

func (s *SentimentDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *SentimentDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetSubmitTime

func (s *SentimentDetectionJobProperties) SetSubmitTime(v time.Time) *SentimentDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*SentimentDetectionJobProperties) SetVolumeKmsKeyId

func (s *SentimentDetectionJobProperties) SetVolumeKmsKeyId(v string) *SentimentDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*SentimentDetectionJobProperties) SetVpcConfig

func (s *SentimentDetectionJobProperties) SetVpcConfig(v *VpcConfig) *SentimentDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (SentimentDetectionJobProperties) String

func (s SentimentDetectionJobProperties) String() string

String returns the string representation

type SentimentScore

type SentimentScore struct {

    // The level of confidence that Amazon Comprehend has in the accuracy of its
    // detection of the MIXED sentiment.
    Mixed *float64 `type:"float"`

    // The level of confidence that Amazon Comprehend has in the accuracy of its
    // detection of the NEGATIVE sentiment.
    Negative *float64 `type:"float"`

    // The level of confidence that Amazon Comprehend has in the accuracy of its
    // detection of the NEUTRAL sentiment.
    Neutral *float64 `type:"float"`

    // The level of confidence that Amazon Comprehend has in the accuracy of its
    // detection of the POSITIVE sentiment.
    Positive *float64 `type:"float"`
    // contains filtered or unexported fields
}

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

func (SentimentScore) GoString

func (s SentimentScore) GoString() string

GoString returns the string representation

func (*SentimentScore) SetMixed

func (s *SentimentScore) SetMixed(v float64) *SentimentScore

SetMixed sets the Mixed field's value.

func (*SentimentScore) SetNegative

func (s *SentimentScore) SetNegative(v float64) *SentimentScore

SetNegative sets the Negative field's value.

func (*SentimentScore) SetNeutral

func (s *SentimentScore) SetNeutral(v float64) *SentimentScore

SetNeutral sets the Neutral field's value.

func (*SentimentScore) SetPositive

func (s *SentimentScore) SetPositive(v float64) *SentimentScore

SetPositive sets the Positive field's value.

func (SentimentScore) String

func (s SentimentScore) String() string

String returns the string representation

type 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
}

func (StartDocumentClassificationJobInput) GoString

func (s StartDocumentClassificationJobInput) GoString() string

GoString returns the string representation

func (*StartDocumentClassificationJobInput) SetClientRequestToken

func (s *StartDocumentClassificationJobInput) SetClientRequestToken(v string) *StartDocumentClassificationJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDocumentClassificationJobInput) SetDataAccessRoleArn

func (s *StartDocumentClassificationJobInput) SetDataAccessRoleArn(v string) *StartDocumentClassificationJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartDocumentClassificationJobInput) SetDocumentClassifierArn

func (s *StartDocumentClassificationJobInput) SetDocumentClassifierArn(v string) *StartDocumentClassificationJobInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*StartDocumentClassificationJobInput) SetInputDataConfig

func (s *StartDocumentClassificationJobInput) SetInputDataConfig(v *InputDataConfig) *StartDocumentClassificationJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartDocumentClassificationJobInput) SetJobName

func (s *StartDocumentClassificationJobInput) SetJobName(v string) *StartDocumentClassificationJobInput

SetJobName sets the JobName field's value.

func (*StartDocumentClassificationJobInput) SetOutputDataConfig

func (s *StartDocumentClassificationJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartDocumentClassificationJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartDocumentClassificationJobInput) SetVolumeKmsKeyId

func (s *StartDocumentClassificationJobInput) SetVolumeKmsKeyId(v string) *StartDocumentClassificationJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartDocumentClassificationJobInput) SetVpcConfig

func (s *StartDocumentClassificationJobInput) SetVpcConfig(v *VpcConfig) *StartDocumentClassificationJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartDocumentClassificationJobInput) String

func (s StartDocumentClassificationJobInput) String() string

String returns the string representation

func (*StartDocumentClassificationJobInput) Validate

func (s *StartDocumentClassificationJobInput) Validate() error

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 *string `type:"string" enum:"JobStatus"`
    // contains filtered or unexported fields
}

func (StartDocumentClassificationJobOutput) GoString

func (s StartDocumentClassificationJobOutput) GoString() string

GoString returns the string representation

func (*StartDocumentClassificationJobOutput) SetJobId

func (s *StartDocumentClassificationJobOutput) SetJobId(v string) *StartDocumentClassificationJobOutput

SetJobId sets the JobId field's value.

func (*StartDocumentClassificationJobOutput) SetJobStatus

func (s *StartDocumentClassificationJobOutput) SetJobStatus(v string) *StartDocumentClassificationJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartDocumentClassificationJobOutput) String

func (s StartDocumentClassificationJobOutput) String() string

String returns the string representation

type StartDominantLanguageDetectionJobInput

type StartDominantLanguageDetectionJobInput struct {

    // A unique identifier for the request. If you do not set the client request
    // token, Amazon Comprehend generates one.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The Amazon Resource Name (ARN) of the AWS Identity and Access Management
    // (IAM) role that grants Amazon Comprehend read access to your input data.
    // For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
    // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
    //
    // DataAccessRoleArn is a required field
    DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

    // Specifies the format and location of the input data for the job.
    //
    // InputDataConfig is a required field
    InputDataConfig *InputDataConfig `type:"structure" required:"true"`

    // An identifier for the job.
    JobName *string `min:"1" type:"string"`

    // Specifies where to send the output files.
    //
    // OutputDataConfig is a required field
    OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for an optional private Virtual Private Cloud (VPC)
    // containing the resources you are using for your dominant language detection
    // job. For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (StartDominantLanguageDetectionJobInput) GoString

func (s StartDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartDominantLanguageDetectionJobInput) SetClientRequestToken

func (s *StartDominantLanguageDetectionJobInput) SetClientRequestToken(v string) *StartDominantLanguageDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDominantLanguageDetectionJobInput) SetDataAccessRoleArn

func (s *StartDominantLanguageDetectionJobInput) SetDataAccessRoleArn(v string) *StartDominantLanguageDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartDominantLanguageDetectionJobInput) SetInputDataConfig

func (s *StartDominantLanguageDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartDominantLanguageDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartDominantLanguageDetectionJobInput) SetJobName

func (s *StartDominantLanguageDetectionJobInput) SetJobName(v string) *StartDominantLanguageDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartDominantLanguageDetectionJobInput) SetOutputDataConfig

func (s *StartDominantLanguageDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartDominantLanguageDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartDominantLanguageDetectionJobInput) SetVolumeKmsKeyId

func (s *StartDominantLanguageDetectionJobInput) SetVolumeKmsKeyId(v string) *StartDominantLanguageDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartDominantLanguageDetectionJobInput) SetVpcConfig

func (s *StartDominantLanguageDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartDominantLanguageDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartDominantLanguageDetectionJobInput) String

func (s StartDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*StartDominantLanguageDetectionJobInput) Validate

func (s *StartDominantLanguageDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDominantLanguageDetectionJobOutput

type StartDominantLanguageDetectionJobOutput struct {

    // The identifier generated for the job. To get the status of a job, use this
    // identifier with the operation.
    JobId *string `min:"1" type:"string"`

    // The status of the job.
    //
    //    * SUBMITTED - The job has been received and is queued for processing.
    //
    //    * IN_PROGRESS - Amazon Comprehend is processing the job.
    //
    //    * COMPLETED - The job was successfully completed and the output is available.
    //
    //    * FAILED - The job did not complete. To get details, use the operation.
    JobStatus *string `type:"string" enum:"JobStatus"`
    // contains filtered or unexported fields
}

func (StartDominantLanguageDetectionJobOutput) GoString

func (s StartDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartDominantLanguageDetectionJobOutput) SetJobId

func (s *StartDominantLanguageDetectionJobOutput) SetJobId(v string) *StartDominantLanguageDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartDominantLanguageDetectionJobOutput) SetJobStatus

func (s *StartDominantLanguageDetectionJobOutput) SetJobStatus(v string) *StartDominantLanguageDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartDominantLanguageDetectionJobOutput) String

func (s StartDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type StartEntitiesDetectionJobInput

type StartEntitiesDetectionJobInput struct {

    // A unique identifier for the request. If you don't set the client request
    // token, Amazon Comprehend generates one.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The Amazon Resource Name (ARN) of the AWS Identity and Access Management
    // (IAM) role that grants Amazon Comprehend read access to your input data.
    // For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
    // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
    //
    // DataAccessRoleArn is a required field
    DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) that identifies the specific entity recognizer
    // to be used by the StartEntitiesDetectionJob. This ARN is optional and is
    // only used for a custom entity recognition job.
    EntityRecognizerArn *string `type:"string"`

    // Specifies the format and location of the input data for the job.
    //
    // InputDataConfig is a required field
    InputDataConfig *InputDataConfig `type:"structure" required:"true"`

    // The identifier of the job.
    JobName *string `min:"1" type:"string"`

    // The language of the input documents. All documents must be in the same language.
    // You can specify any of the languages supported by Amazon Comprehend. If custom
    // entities recognition is used, this parameter is ignored and the language
    // used for training the model is used instead.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // Specifies where to send the output files.
    //
    // OutputDataConfig is a required field
    OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for an optional private Virtual Private Cloud (VPC)
    // containing the resources you are using for your entity detection job. For
    // more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (StartEntitiesDetectionJobInput) GoString

func (s StartEntitiesDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartEntitiesDetectionJobInput) SetClientRequestToken

func (s *StartEntitiesDetectionJobInput) SetClientRequestToken(v string) *StartEntitiesDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEntitiesDetectionJobInput) SetDataAccessRoleArn

func (s *StartEntitiesDetectionJobInput) SetDataAccessRoleArn(v string) *StartEntitiesDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEntitiesDetectionJobInput) SetEntityRecognizerArn

func (s *StartEntitiesDetectionJobInput) SetEntityRecognizerArn(v string) *StartEntitiesDetectionJobInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*StartEntitiesDetectionJobInput) SetInputDataConfig

func (s *StartEntitiesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartEntitiesDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEntitiesDetectionJobInput) SetJobName

func (s *StartEntitiesDetectionJobInput) SetJobName(v string) *StartEntitiesDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartEntitiesDetectionJobInput) SetLanguageCode

func (s *StartEntitiesDetectionJobInput) SetLanguageCode(v string) *StartEntitiesDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartEntitiesDetectionJobInput) SetOutputDataConfig

func (s *StartEntitiesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartEntitiesDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartEntitiesDetectionJobInput) SetVolumeKmsKeyId

func (s *StartEntitiesDetectionJobInput) SetVolumeKmsKeyId(v string) *StartEntitiesDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartEntitiesDetectionJobInput) SetVpcConfig

func (s *StartEntitiesDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartEntitiesDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartEntitiesDetectionJobInput) String

func (s StartEntitiesDetectionJobInput) String() string

String returns the string representation

func (*StartEntitiesDetectionJobInput) Validate

func (s *StartEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEntitiesDetectionJobOutput

type StartEntitiesDetectionJobOutput struct {

    // The identifier generated for the job. To get the status of job, use this
    // identifier with the operation.
    JobId *string `min:"1" type:"string"`

    // The status of the job.
    //
    //    * SUBMITTED - The job has been received and is queued for processing.
    //
    //    * IN_PROGRESS - Amazon Comprehend is processing the job.
    //
    //    * COMPLETED - The job was successfully completed and the output is available.
    //
    //    * FAILED - The job did not complete. To get details, use the operation.
    //
    //    * STOP_REQUESTED - Amazon Comprehend has received a stop request for the
    //    job and is processing the request.
    //
    //    * STOPPED - The job was successfully stopped without completing.
    JobStatus *string `type:"string" enum:"JobStatus"`
    // contains filtered or unexported fields
}

func (StartEntitiesDetectionJobOutput) GoString

func (s StartEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartEntitiesDetectionJobOutput) SetJobId

func (s *StartEntitiesDetectionJobOutput) SetJobId(v string) *StartEntitiesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartEntitiesDetectionJobOutput) SetJobStatus

func (s *StartEntitiesDetectionJobOutput) SetJobStatus(v string) *StartEntitiesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartEntitiesDetectionJobOutput) String

func (s StartEntitiesDetectionJobOutput) String() string

String returns the string representation

type StartKeyPhrasesDetectionJobInput

type StartKeyPhrasesDetectionJobInput struct {

    // A unique identifier for the request. If you don't set the client request
    // token, Amazon Comprehend generates one.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The Amazon Resource Name (ARN) of the AWS Identity and Access Management
    // (IAM) role that grants Amazon Comprehend read access to your input data.
    // For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
    // (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
    //
    // DataAccessRoleArn is a required field
    DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

    // Specifies the format and location of the input data for the job.
    //
    // InputDataConfig is a required field
    InputDataConfig *InputDataConfig `type:"structure" required:"true"`

    // The identifier of the job.
    JobName *string `min:"1" type:"string"`

    // The language of the input documents. You can specify any of the primary languages
    // supported by Amazon Comprehend. All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // Specifies where to send the output files.
    //
    // OutputDataConfig is a required field
    OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for an optional private Virtual Private Cloud (VPC)
    // containing the resources you are using for your key phrases detection job.
    // For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
    VpcConfig *VpcConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (StartKeyPhrasesDetectionJobInput) GoString

func (s StartKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartKeyPhrasesDetectionJobInput) SetClientRequestToken

func (s *StartKeyPhrasesDetectionJobInput) SetClientRequestToken(v string) *StartKeyPhrasesDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartKeyPhrasesDetectionJobInput) SetDataAccessRoleArn

func (s *StartKeyPhrasesDetectionJobInput) SetDataAccessRoleArn(v string) *StartKeyPhrasesDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartKeyPhrasesDetectionJobInput) SetInputDataConfig

func (s *StartKeyPhrasesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartKeyPhrasesDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartKeyPhrasesDetectionJobInput) SetJobName

func (s *StartKeyPhrasesDetectionJobInput) SetJobName(v string) *StartKeyPhrasesDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartKeyPhrasesDetectionJobInput) SetLanguageCode

func (s *StartKeyPhrasesDetectionJobInput) SetLanguageCode(v string) *StartKeyPhrasesDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartKeyPhrasesDetectionJobInput) SetOutputDataConfig

func (s *StartKeyPhrasesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartKeyPhrasesDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartKeyPhrasesDetectionJobInput) SetVolumeKmsKeyId

func (s *StartKeyPhrasesDetectionJobInput) SetVolumeKmsKeyId(v string) *StartKeyPhrasesDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartKeyPhrasesDetectionJobInput) SetVpcConfig

func (s *StartKeyPhrasesDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartKeyPhrasesDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartKeyPhrasesDetectionJobInput) String

func (s StartKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*StartKeyPhrasesDetectionJobInput) Validate

func (s *StartKeyPhrasesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartKeyPhrasesDetectionJobOutput

type StartKeyPhrasesDetectionJobOutput struct {

    // The identifier generated for the job. To get the status of a job, use this
    // identifier with the operation.
    JobId *string `min:"1" type:"string"`

    // The status of the job.
    //
    //    * SUBMITTED - The job has been received and is queued for processing.
    //
    //    * IN_PROGRESS - Amazon Comprehend is processing the job.
    //
    //    * COMPLETED - The job was successfully completed and the output is available.
    //
    //    * FAILED - The job did not complete. To get details, use the operation.
    JobStatus *string `type:"string" enum:"JobStatus"`
    // contains filtered or unexported fields
}

func (StartKeyPhrasesDetectionJobOutput) GoString

func (s StartKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartKeyPhrasesDetectionJobOutput) SetJobId

func (s *StartKeyPhrasesDetectionJobOutput) SetJobId(v string) *StartKeyPhrasesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartKeyPhrasesDetectionJobOutput) SetJobStatus

func (s *StartKeyPhrasesDetectionJobOutput) SetJobStatus(v string) *StartKeyPhrasesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartKeyPhrasesDetectionJobOutput) String

func (s StartKeyPhrasesDetectionJobOutput) String() strin