...
AWS SDK for Go API Reference
We announced the upcoming end-of-support for AWS SDK for Go (v1). We recommend that you migrate to AWS SDK for Go v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
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 Amazon Web Services 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.

Operations ▾

BatchDetectDominantLanguage
BatchDetectEntities
BatchDetectKeyPhrases
BatchDetectSentiment
BatchDetectSyntax
BatchDetectTargetedSentiment
ClassifyDocument
ContainsPiiEntities
CreateDataset
CreateDocumentClassifier
CreateEndpoint
CreateEntityRecognizer
CreateFlywheel
DeleteDocumentClassifier
DeleteEndpoint
DeleteEntityRecognizer
DeleteFlywheel
DeleteResourcePolicy
DescribeDataset
DescribeDocumentClassificationJob
DescribeDocumentClassifier
DescribeDominantLanguageDetectionJob
DescribeEndpoint
DescribeEntitiesDetectionJob
DescribeEntityRecognizer
DescribeEventsDetectionJob
DescribeFlywheel
DescribeFlywheelIteration
DescribeKeyPhrasesDetectionJob
DescribePiiEntitiesDetectionJob
DescribeResourcePolicy
DescribeSentimentDetectionJob
DescribeTargetedSentimentDetectionJob
DescribeTopicsDetectionJob
DetectDominantLanguage
DetectEntities
DetectKeyPhrases
DetectPiiEntities
DetectSentiment
DetectSyntax
DetectTargetedSentiment
DetectToxicContent
ImportModel
ListDatasets ( Paginator )
ListDocumentClassificationJobs ( Paginator )
ListDocumentClassifierSummaries ( Paginator )
ListDocumentClassifiers ( Paginator )
ListDominantLanguageDetectionJobs ( Paginator )
ListEndpoints ( Paginator )
ListEntitiesDetectionJobs ( Paginator )
ListEntityRecognizerSummaries ( Paginator )
ListEntityRecognizers ( Paginator )
ListEventsDetectionJobs ( Paginator )
ListFlywheelIterationHistory ( Paginator )
ListFlywheels ( Paginator )
ListKeyPhrasesDetectionJobs ( Paginator )
ListPiiEntitiesDetectionJobs ( Paginator )
ListSentimentDetectionJobs ( Paginator )
ListTagsForResource
ListTargetedSentimentDetectionJobs ( Paginator )
ListTopicsDetectionJobs ( Paginator )
PutResourcePolicy
StartDocumentClassificationJob
StartDominantLanguageDetectionJob
StartEntitiesDetectionJob
StartEventsDetectionJob
StartFlywheelIteration
StartKeyPhrasesDetectionJob
StartPiiEntitiesDetectionJob
StartSentimentDetectionJob
StartTargetedSentimentDetectionJob
StartTopicsDetectionJob
StopDominantLanguageDetectionJob
StopEntitiesDetectionJob
StopEventsDetectionJob
StopKeyPhrasesDetectionJob
StopPiiEntitiesDetectionJob
StopSentimentDetectionJob
StopTargetedSentimentDetectionJob
StopTrainingDocumentClassifier
StopTrainingEntityRecognizer
TagResource
UntagResource
UpdateEndpoint
UpdateFlywheel

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) BatchDetectTargetedSentiment(input *BatchDetectTargetedSentimentInput) (*BatchDetectTargetedSentimentOutput, error)
func (c *Comprehend) BatchDetectTargetedSentimentRequest(input *BatchDetectTargetedSentimentInput) (req *request.Request, output *BatchDetectTargetedSentimentOutput)
func (c *Comprehend) BatchDetectTargetedSentimentWithContext(ctx aws.Context, input *BatchDetectTargetedSentimentInput, opts ...request.Option) (*BatchDetectTargetedSentimentOutput, 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) ContainsPiiEntities(input *ContainsPiiEntitiesInput) (*ContainsPiiEntitiesOutput, error)
func (c *Comprehend) ContainsPiiEntitiesRequest(input *ContainsPiiEntitiesInput) (req *request.Request, output *ContainsPiiEntitiesOutput)
func (c *Comprehend) ContainsPiiEntitiesWithContext(ctx aws.Context, input *ContainsPiiEntitiesInput, opts ...request.Option) (*ContainsPiiEntitiesOutput, error)
func (c *Comprehend) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error)
func (c *Comprehend) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput)
func (c *Comprehend) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, 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) CreateFlywheel(input *CreateFlywheelInput) (*CreateFlywheelOutput, error)
func (c *Comprehend) CreateFlywheelRequest(input *CreateFlywheelInput) (req *request.Request, output *CreateFlywheelOutput)
func (c *Comprehend) CreateFlywheelWithContext(ctx aws.Context, input *CreateFlywheelInput, opts ...request.Option) (*CreateFlywheelOutput, 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) DeleteFlywheel(input *DeleteFlywheelInput) (*DeleteFlywheelOutput, error)
func (c *Comprehend) DeleteFlywheelRequest(input *DeleteFlywheelInput) (req *request.Request, output *DeleteFlywheelOutput)
func (c *Comprehend) DeleteFlywheelWithContext(ctx aws.Context, input *DeleteFlywheelInput, opts ...request.Option) (*DeleteFlywheelOutput, error)
func (c *Comprehend) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error)
func (c *Comprehend) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput)
func (c *Comprehend) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error)
func (c *Comprehend) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error)
func (c *Comprehend) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput)
func (c *Comprehend) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, 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) DescribeEventsDetectionJob(input *DescribeEventsDetectionJobInput) (*DescribeEventsDetectionJobOutput, error)
func (c *Comprehend) DescribeEventsDetectionJobRequest(input *DescribeEventsDetectionJobInput) (req *request.Request, output *DescribeEventsDetectionJobOutput)
func (c *Comprehend) DescribeEventsDetectionJobWithContext(ctx aws.Context, input *DescribeEventsDetectionJobInput, opts ...request.Option) (*DescribeEventsDetectionJobOutput, error)
func (c *Comprehend) DescribeFlywheel(input *DescribeFlywheelInput) (*DescribeFlywheelOutput, error)
func (c *Comprehend) DescribeFlywheelIteration(input *DescribeFlywheelIterationInput) (*DescribeFlywheelIterationOutput, error)
func (c *Comprehend) DescribeFlywheelIterationRequest(input *DescribeFlywheelIterationInput) (req *request.Request, output *DescribeFlywheelIterationOutput)
func (c *Comprehend) DescribeFlywheelIterationWithContext(ctx aws.Context, input *DescribeFlywheelIterationInput, opts ...request.Option) (*DescribeFlywheelIterationOutput, error)
func (c *Comprehend) DescribeFlywheelRequest(input *DescribeFlywheelInput) (req *request.Request, output *DescribeFlywheelOutput)
func (c *Comprehend) DescribeFlywheelWithContext(ctx aws.Context, input *DescribeFlywheelInput, opts ...request.Option) (*DescribeFlywheelOutput, 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) DescribeResourcePolicy(input *DescribeResourcePolicyInput) (*DescribeResourcePolicyOutput, error)
func (c *Comprehend) DescribeResourcePolicyRequest(input *DescribeResourcePolicyInput) (req *request.Request, output *DescribeResourcePolicyOutput)
func (c *Comprehend) DescribeResourcePolicyWithContext(ctx aws.Context, input *DescribeResourcePolicyInput, opts ...request.Option) (*DescribeResourcePolicyOutput, 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) DescribeTargetedSentimentDetectionJob(input *DescribeTargetedSentimentDetectionJobInput) (*DescribeTargetedSentimentDetectionJobOutput, error)
func (c *Comprehend) DescribeTargetedSentimentDetectionJobRequest(input *DescribeTargetedSentimentDetectionJobInput) (req *request.Request, output *DescribeTargetedSentimentDetectionJobOutput)
func (c *Comprehend) DescribeTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeTargetedSentimentDetectionJobInput, opts ...request.Option) (*DescribeTargetedSentimentDetectionJobOutput, 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) DetectTargetedSentiment(input *DetectTargetedSentimentInput) (*DetectTargetedSentimentOutput, error)
func (c *Comprehend) DetectTargetedSentimentRequest(input *DetectTargetedSentimentInput) (req *request.Request, output *DetectTargetedSentimentOutput)
func (c *Comprehend) DetectTargetedSentimentWithContext(ctx aws.Context, input *DetectTargetedSentimentInput, opts ...request.Option) (*DetectTargetedSentimentOutput, error)
func (c *Comprehend) DetectToxicContent(input *DetectToxicContentInput) (*DetectToxicContentOutput, error)
func (c *Comprehend) DetectToxicContentRequest(input *DetectToxicContentInput) (req *request.Request, output *DetectToxicContentOutput)
func (c *Comprehend) DetectToxicContentWithContext(ctx aws.Context, input *DetectToxicContentInput, opts ...request.Option) (*DetectToxicContentOutput, error)
func (c *Comprehend) ImportModel(input *ImportModelInput) (*ImportModelOutput, error)
func (c *Comprehend) ImportModelRequest(input *ImportModelInput) (req *request.Request, output *ImportModelOutput)
func (c *Comprehend) ImportModelWithContext(ctx aws.Context, input *ImportModelInput, opts ...request.Option) (*ImportModelOutput, error)
func (c *Comprehend) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)
func (c *Comprehend) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error
func (c *Comprehend) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)
func (c *Comprehend) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, 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) ListDocumentClassifierSummaries(input *ListDocumentClassifierSummariesInput) (*ListDocumentClassifierSummariesOutput, error)
func (c *Comprehend) ListDocumentClassifierSummariesPages(input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool) error
func (c *Comprehend) ListDocumentClassifierSummariesPagesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentClassifierSummariesInput) (req *request.Request, output *ListDocumentClassifierSummariesOutput)
func (c *Comprehend) ListDocumentClassifierSummariesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, opts ...request.Option) (*ListDocumentClassifierSummariesOutput, 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) ListEndpointsPages(input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool) error
func (c *Comprehend) ListEndpointsPagesWithContext(ctx aws.Context, input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool, opts ...request.Option) 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) ListEntityRecognizerSummaries(input *ListEntityRecognizerSummariesInput) (*ListEntityRecognizerSummariesOutput, error)
func (c *Comprehend) ListEntityRecognizerSummariesPages(input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool) error
func (c *Comprehend) ListEntityRecognizerSummariesPagesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListEntityRecognizerSummariesRequest(input *ListEntityRecognizerSummariesInput) (req *request.Request, output *ListEntityRecognizerSummariesOutput)
func (c *Comprehend) ListEntityRecognizerSummariesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, opts ...request.Option) (*ListEntityRecognizerSummariesOutput, 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) ListEventsDetectionJobs(input *ListEventsDetectionJobsInput) (*ListEventsDetectionJobsOutput, error)
func (c *Comprehend) ListEventsDetectionJobsPages(input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListEventsDetectionJobsPagesWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListEventsDetectionJobsRequest(input *ListEventsDetectionJobsInput) (req *request.Request, output *ListEventsDetectionJobsOutput)
func (c *Comprehend) ListEventsDetectionJobsWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, opts ...request.Option) (*ListEventsDetectionJobsOutput, error)
func (c *Comprehend) ListFlywheelIterationHistory(input *ListFlywheelIterationHistoryInput) (*ListFlywheelIterationHistoryOutput, error)
func (c *Comprehend) ListFlywheelIterationHistoryPages(input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool) error
func (c *Comprehend) ListFlywheelIterationHistoryPagesWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListFlywheelIterationHistoryRequest(input *ListFlywheelIterationHistoryInput) (req *request.Request, output *ListFlywheelIterationHistoryOutput)
func (c *Comprehend) ListFlywheelIterationHistoryWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, opts ...request.Option) (*ListFlywheelIterationHistoryOutput, error)
func (c *Comprehend) ListFlywheels(input *ListFlywheelsInput) (*ListFlywheelsOutput, error)
func (c *Comprehend) ListFlywheelsPages(input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool) error
func (c *Comprehend) ListFlywheelsPagesWithContext(ctx aws.Context, input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListFlywheelsRequest(input *ListFlywheelsInput) (req *request.Request, output *ListFlywheelsOutput)
func (c *Comprehend) ListFlywheelsWithContext(ctx aws.Context, input *ListFlywheelsInput, opts ...request.Option) (*ListFlywheelsOutput, 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) ListPiiEntitiesDetectionJobsPages(input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) 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) ListTargetedSentimentDetectionJobs(input *ListTargetedSentimentDetectionJobsInput) (*ListTargetedSentimentDetectionJobsOutput, error)
func (c *Comprehend) ListTargetedSentimentDetectionJobsPages(input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool) error
func (c *Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error
func (c *Comprehend) ListTargetedSentimentDetectionJobsRequest(input *ListTargetedSentimentDetectionJobsInput) (req *request.Request, output *ListTargetedSentimentDetectionJobsOutput)
func (c *Comprehend) ListTargetedSentimentDetectionJobsWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, opts ...request.Option) (*ListTargetedSentimentDetectionJobsOutput, 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) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)
func (c *Comprehend) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)
func (c *Comprehend) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, 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) StartEventsDetectionJob(input *StartEventsDetectionJobInput) (*StartEventsDetectionJobOutput, error)
func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJobInput) (req *request.Request, output *StartEventsDetectionJobOutput)
func (c *Comprehend) StartEventsDetectionJobWithContext(ctx aws.Context, input *StartEventsDetectionJobInput, opts ...request.Option) (*StartEventsDetectionJobOutput, error)
func (c *Comprehend) StartFlywheelIteration(input *StartFlywheelIterationInput) (*StartFlywheelIterationOutput, error)
func (c *Comprehend) StartFlywheelIterationRequest(input *StartFlywheelIterationInput) (req *request.Request, output *StartFlywheelIterationOutput)
func (c *Comprehend) StartFlywheelIterationWithContext(ctx aws.Context, input *StartFlywheelIterationInput, opts ...request.Option) (*StartFlywheelIterationOutput, 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) StartTargetedSentimentDetectionJob(input *StartTargetedSentimentDetectionJobInput) (*StartTargetedSentimentDetectionJobOutput, error)
func (c *Comprehend) StartTargetedSentimentDetectionJobRequest(input *StartTargetedSentimentDetectionJobInput) (req *request.Request, output *StartTargetedSentimentDetectionJobOutput)
func (c *Comprehend) StartTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StartTargetedSentimentDetectionJobInput, opts ...request.Option) (*StartTargetedSentimentDetectionJobOutput, 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) StopEventsDetectionJob(input *StopEventsDetectionJobInput) (*StopEventsDetectionJobOutput, error)
func (c *Comprehend) StopEventsDetectionJobRequest(input *StopEventsDetectionJobInput) (req *request.Request, output *StopEventsDetectionJobOutput)
func (c *Comprehend) StopEventsDetectionJobWithContext(ctx aws.Context, input *StopEventsDetectionJobInput, opts ...request.Option) (*StopEventsDetectionJobOutput, 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) StopTargetedSentimentDetectionJob(input *StopTargetedSentimentDetectionJobInput) (*StopTargetedSentimentDetectionJobOutput, error)
func (c *Comprehend) StopTargetedSentimentDetectionJobRequest(input *StopTargetedSentimentDetectionJobInput) (req *request.Request, output *StopTargetedSentimentDetectionJobOutput)
func (c *Comprehend) StopTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StopTargetedSentimentDetectionJobInput, opts ...request.Option) (*StopTargetedSentimentDetectionJobOutput, 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 (c *Comprehend) UpdateFlywheel(input *UpdateFlywheelInput) (*UpdateFlywheelOutput, error)
func (c *Comprehend) UpdateFlywheelRequest(input *UpdateFlywheelInput) (req *request.Request, output *UpdateFlywheelOutput)
func (c *Comprehend) UpdateFlywheelWithContext(ctx aws.Context, input *UpdateFlywheelInput, opts ...request.Option) (*UpdateFlywheelOutput, error)
func AugmentedManifestsDocumentTypeFormat_Values() []string
func BlockType_Values() []string
func DatasetDataFormat_Values() []string
func DatasetStatus_Values() []string
func DatasetType_Values() []string
func DocumentClassifierDataFormat_Values() []string
func DocumentClassifierDocumentTypeFormat_Values() []string
func DocumentClassifierMode_Values() []string
func DocumentReadAction_Values() []string
func DocumentReadFeatureTypes_Values() []string
func DocumentReadMode_Values() []string
func DocumentType_Values() []string
func EndpointStatus_Values() []string
func EntityRecognizerDataFormat_Values() []string
func EntityType_Values() []string
func FlywheelIterationStatus_Values() []string
func FlywheelStatus_Values() []string
func InputFormat_Values() []string
func InvalidRequestDetailReason_Values() []string
func InvalidRequestReason_Values() []string
func JobStatus_Values() []string
func LanguageCode_Values() []string
func ModelStatus_Values() []string
func ModelType_Values() []string
func PageBasedErrorCode_Values() []string
func PageBasedWarningCode_Values() []string
func PartOfSpeechTagType_Values() []string
func PiiEntitiesDetectionMaskMode_Values() []string
func PiiEntitiesDetectionMode_Values() []string
func PiiEntityType_Values() []string
func RelationshipType_Values() []string
func SentimentType_Values() []string
func Split_Values() []string
func SyntaxLanguageCode_Values() []string
func TargetedSentimentEntityType_Values() []string
func ToxicContentType_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 BatchDetectTargetedSentimentInput
type BatchDetectTargetedSentimentItemResult
type BatchDetectTargetedSentimentOutput
type BatchItemError
type BatchSizeLimitExceededException
type Block
type BlockReference
type BoundingBox
type ChildBlock
type ClassifierEvaluationMetrics
type ClassifierMetadata
type ClassifyDocumentInput
type ClassifyDocumentOutput
type ConcurrentModificationException
type ContainsPiiEntitiesInput
type ContainsPiiEntitiesOutput
type CreateDatasetInput
type CreateDatasetOutput
type CreateDocumentClassifierInput
type CreateDocumentClassifierOutput
type CreateEndpointInput
type CreateEndpointOutput
type CreateEntityRecognizerInput
type CreateEntityRecognizerOutput
type CreateFlywheelInput
type CreateFlywheelOutput
type DataSecurityConfig
type DatasetAugmentedManifestsListItem
type DatasetDocumentClassifierInputDataConfig
type DatasetEntityRecognizerAnnotations
type DatasetEntityRecognizerDocuments
type DatasetEntityRecognizerEntityList
type DatasetEntityRecognizerInputDataConfig
type DatasetFilter
type DatasetInputDataConfig
type DatasetProperties
type DeleteDocumentClassifierInput
type DeleteDocumentClassifierOutput
type DeleteEndpointInput
type DeleteEndpointOutput
type DeleteEntityRecognizerInput
type DeleteEntityRecognizerOutput
type DeleteFlywheelInput
type DeleteFlywheelOutput
type DeleteResourcePolicyInput
type DeleteResourcePolicyOutput
type DescribeDatasetInput
type DescribeDatasetOutput
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 DescribeEventsDetectionJobInput
type DescribeEventsDetectionJobOutput
type DescribeFlywheelInput
type DescribeFlywheelIterationInput
type DescribeFlywheelIterationOutput
type DescribeFlywheelOutput
type DescribeKeyPhrasesDetectionJobInput
type DescribeKeyPhrasesDetectionJobOutput
type DescribePiiEntitiesDetectionJobInput
type DescribePiiEntitiesDetectionJobOutput
type DescribeResourcePolicyInput
type DescribeResourcePolicyOutput
type DescribeSentimentDetectionJobInput
type DescribeSentimentDetectionJobOutput
type DescribeTargetedSentimentDetectionJobInput
type DescribeTargetedSentimentDetectionJobOutput
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 DetectTargetedSentimentInput
type DetectTargetedSentimentOutput
type DetectToxicContentInput
type DetectToxicContentOutput
type DocumentClass
type DocumentClassificationConfig
type DocumentClassificationJobFilter
type DocumentClassificationJobProperties
type DocumentClassifierDocuments
type DocumentClassifierFilter
type DocumentClassifierInputDataConfig
type DocumentClassifierOutputDataConfig
type DocumentClassifierProperties
type DocumentClassifierSummary
type DocumentLabel
type DocumentMetadata
type DocumentReaderConfig
type DocumentTypeListItem
type DominantLanguage
type DominantLanguageDetectionJobFilter
type DominantLanguageDetectionJobProperties
type EndpointFilter
type EndpointProperties
type EntitiesDetectionJobFilter
type EntitiesDetectionJobProperties
type Entity
type EntityLabel
type EntityRecognitionConfig
type EntityRecognizerAnnotations
type EntityRecognizerDocuments
type EntityRecognizerEntityList
type EntityRecognizerEvaluationMetrics
type EntityRecognizerFilter
type EntityRecognizerInputDataConfig
type EntityRecognizerMetadata
type EntityRecognizerMetadataEntityTypesListItem
type EntityRecognizerOutputDataConfig
type EntityRecognizerProperties
type EntityRecognizerSummary
type EntityTypesEvaluationMetrics
type EntityTypesListItem
type ErrorsListItem
type EventsDetectionJobFilter
type EventsDetectionJobProperties
type ExtractedCharactersListItem
type FlywheelFilter
type FlywheelIterationFilter
type FlywheelIterationProperties
type FlywheelModelEvaluationMetrics
type FlywheelProperties
type FlywheelSummary
type Geometry
type ImportModelInput
type ImportModelOutput
type InputDataConfig
type InternalServerException
type InvalidFilterException
type InvalidRequestDetail
type InvalidRequestException
type JobNotFoundException
type KeyPhrase
type KeyPhrasesDetectionJobFilter
type KeyPhrasesDetectionJobProperties
type KmsKeyValidationException
type ListDatasetsInput
type ListDatasetsOutput
type ListDocumentClassificationJobsInput
type ListDocumentClassificationJobsOutput
type ListDocumentClassifierSummariesInput
type ListDocumentClassifierSummariesOutput
type ListDocumentClassifiersInput
type ListDocumentClassifiersOutput
type ListDominantLanguageDetectionJobsInput
type ListDominantLanguageDetectionJobsOutput
type ListEndpointsInput
type ListEndpointsOutput
type ListEntitiesDetectionJobsInput
type ListEntitiesDetectionJobsOutput
type ListEntityRecognizerSummariesInput
type ListEntityRecognizerSummariesOutput
type ListEntityRecognizersInput
type ListEntityRecognizersOutput
type ListEventsDetectionJobsInput
type ListEventsDetectionJobsOutput
type ListFlywheelIterationHistoryInput
type ListFlywheelIterationHistoryOutput
type ListFlywheelsInput
type ListFlywheelsOutput
type ListKeyPhrasesDetectionJobsInput
type ListKeyPhrasesDetectionJobsOutput
type ListPiiEntitiesDetectionJobsInput
type ListPiiEntitiesDetectionJobsOutput
type ListSentimentDetectionJobsInput
type ListSentimentDetectionJobsOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type ListTargetedSentimentDetectionJobsInput
type ListTargetedSentimentDetectionJobsOutput
type ListTopicsDetectionJobsInput
type ListTopicsDetectionJobsOutput
type MentionSentiment
type OutputDataConfig
type PartOfSpeechTag
type PiiEntitiesDetectionJobFilter
type PiiEntitiesDetectionJobProperties
type PiiEntity
type PiiOutputDataConfig
type Point
type PutResourcePolicyInput
type PutResourcePolicyOutput
type RedactionConfig
type RelationshipsListItem
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 StartEventsDetectionJobInput
type StartEventsDetectionJobOutput
type StartFlywheelIterationInput
type StartFlywheelIterationOutput
type StartKeyPhrasesDetectionJobInput
type StartKeyPhrasesDetectionJobOutput
type StartPiiEntitiesDetectionJobInput
type StartPiiEntitiesDetectionJobOutput
type StartSentimentDetectionJobInput
type StartSentimentDetectionJobOutput
type StartTargetedSentimentDetectionJobInput
type StartTargetedSentimentDetectionJobOutput
type StartTopicsDetectionJobInput
type StartTopicsDetectionJobOutput
type StopDominantLanguageDetectionJobInput
type StopDominantLanguageDetectionJobOutput
type StopEntitiesDetectionJobInput
type StopEntitiesDetectionJobOutput
type StopEventsDetectionJobInput
type StopEventsDetectionJobOutput
type StopKeyPhrasesDetectionJobInput
type StopKeyPhrasesDetectionJobOutput
type StopPiiEntitiesDetectionJobInput
type StopPiiEntitiesDetectionJobOutput
type StopSentimentDetectionJobInput
type StopSentimentDetectionJobOutput
type StopTargetedSentimentDetectionJobInput
type StopTargetedSentimentDetectionJobOutput
type StopTrainingDocumentClassifierInput
type StopTrainingDocumentClassifierOutput
type StopTrainingEntityRecognizerInput
type StopTrainingEntityRecognizerOutput
type SyntaxToken
type Tag
type TagResourceInput
type TagResourceOutput
type TargetedSentimentDetectionJobFilter
type TargetedSentimentDetectionJobProperties
type TargetedSentimentEntity
type TargetedSentimentMention
type TaskConfig
type TextSegment
type TextSizeLimitExceededException
type TooManyRequestsException
type TooManyTagKeysException
type TooManyTagsException
type TopicsDetectionJobFilter
type TopicsDetectionJobProperties
type ToxicContent
type ToxicLabels
type UnsupportedLanguageException
type UntagResourceInput
type UntagResourceOutput
type UpdateDataSecurityConfig
type UpdateEndpointInput
type UpdateEndpointOutput
type UpdateFlywheelInput
type UpdateFlywheelOutput
type VpcConfig
type WarningsListItem

Constants ▾

const (
    // AugmentedManifestsDocumentTypeFormatPlainTextDocument is a AugmentedManifestsDocumentTypeFormat enum value
    AugmentedManifestsDocumentTypeFormatPlainTextDocument = "PLAIN_TEXT_DOCUMENT"

    // AugmentedManifestsDocumentTypeFormatSemiStructuredDocument is a AugmentedManifestsDocumentTypeFormat enum value
    AugmentedManifestsDocumentTypeFormatSemiStructuredDocument = "SEMI_STRUCTURED_DOCUMENT"
)
const (
    // BlockTypeLine is a BlockType enum value
    BlockTypeLine = "LINE"

    // BlockTypeWord is a BlockType enum value
    BlockTypeWord = "WORD"
)
const (
    // DatasetDataFormatComprehendCsv is a DatasetDataFormat enum value
    DatasetDataFormatComprehendCsv = "COMPREHEND_CSV"

    // DatasetDataFormatAugmentedManifest is a DatasetDataFormat enum value
    DatasetDataFormatAugmentedManifest = "AUGMENTED_MANIFEST"
)
const (
    // DatasetStatusCreating is a DatasetStatus enum value
    DatasetStatusCreating = "CREATING"

    // DatasetStatusCompleted is a DatasetStatus enum value
    DatasetStatusCompleted = "COMPLETED"

    // DatasetStatusFailed is a DatasetStatus enum value
    DatasetStatusFailed = "FAILED"
)
const (
    // DatasetTypeTrain is a DatasetType enum value
    DatasetTypeTrain = "TRAIN"

    // DatasetTypeTest is a DatasetType enum value
    DatasetTypeTest = "TEST"
)
const (
    // DocumentClassifierDataFormatComprehendCsv is a DocumentClassifierDataFormat enum value
    DocumentClassifierDataFormatComprehendCsv = "COMPREHEND_CSV"

    // DocumentClassifierDataFormatAugmentedManifest is a DocumentClassifierDataFormat enum value
    DocumentClassifierDataFormatAugmentedManifest = "AUGMENTED_MANIFEST"
)
const (
    // DocumentClassifierDocumentTypeFormatPlainTextDocument is a DocumentClassifierDocumentTypeFormat enum value
    DocumentClassifierDocumentTypeFormatPlainTextDocument = "PLAIN_TEXT_DOCUMENT"

    // DocumentClassifierDocumentTypeFormatSemiStructuredDocument is a DocumentClassifierDocumentTypeFormat enum value
    DocumentClassifierDocumentTypeFormatSemiStructuredDocument = "SEMI_STRUCTURED_DOCUMENT"
)
const (
    // DocumentClassifierModeMultiClass is a DocumentClassifierMode enum value
    DocumentClassifierModeMultiClass = "MULTI_CLASS"

    // DocumentClassifierModeMultiLabel is a DocumentClassifierMode enum value
    DocumentClassifierModeMultiLabel = "MULTI_LABEL"
)
const (
    // DocumentReadActionTextractDetectDocumentText is a DocumentReadAction enum value
    DocumentReadActionTextractDetectDocumentText = "TEXTRACT_DETECT_DOCUMENT_TEXT"

    // DocumentReadActionTextractAnalyzeDocument is a DocumentReadAction enum value
    DocumentReadActionTextractAnalyzeDocument = "TEXTRACT_ANALYZE_DOCUMENT"
)
const (
    // DocumentReadFeatureTypesTables is a DocumentReadFeatureTypes enum value
    DocumentReadFeatureTypesTables = "TABLES"

    // DocumentReadFeatureTypesForms is a DocumentReadFeatureTypes enum value
    DocumentReadFeatureTypesForms = "FORMS"
)

TABLES or FORMS

const (
    // DocumentReadModeServiceDefault is a DocumentReadMode enum value
    DocumentReadModeServiceDefault = "SERVICE_DEFAULT"

    // DocumentReadModeForceDocumentReadAction is a DocumentReadMode enum value
    DocumentReadModeForceDocumentReadAction = "FORCE_DOCUMENT_READ_ACTION"
)
const (
    // DocumentTypeNativePdf is a DocumentType enum value
    DocumentTypeNativePdf = "NATIVE_PDF"

    // DocumentTypeScannedPdf is a DocumentType enum value
    DocumentTypeScannedPdf = "SCANNED_PDF"

    // DocumentTypeMsWord is a DocumentType enum value
    DocumentTypeMsWord = "MS_WORD"

    // DocumentTypeImage is a DocumentType enum value
    DocumentTypeImage = "IMAGE"

    // DocumentTypePlainText is a DocumentType enum value
    DocumentTypePlainText = "PLAIN_TEXT"

    // DocumentTypeTextractDetectDocumentTextJson is a DocumentType enum value
    DocumentTypeTextractDetectDocumentTextJson = "TEXTRACT_DETECT_DOCUMENT_TEXT_JSON"

    // DocumentTypeTextractAnalyzeDocumentJson is a DocumentType enum value
    DocumentTypeTextractAnalyzeDocumentJson = "TEXTRACT_ANALYZE_DOCUMENT_JSON"
)
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 (
    // FlywheelIterationStatusTraining is a FlywheelIterationStatus enum value
    FlywheelIterationStatusTraining = "TRAINING"

    // FlywheelIterationStatusEvaluating is a FlywheelIterationStatus enum value
    FlywheelIterationStatusEvaluating = "EVALUATING"

    // FlywheelIterationStatusCompleted is a FlywheelIterationStatus enum value
    FlywheelIterationStatusCompleted = "COMPLETED"

    // FlywheelIterationStatusFailed is a FlywheelIterationStatus enum value
    FlywheelIterationStatusFailed = "FAILED"

    // FlywheelIterationStatusStopRequested is a FlywheelIterationStatus enum value
    FlywheelIterationStatusStopRequested = "STOP_REQUESTED"

    // FlywheelIterationStatusStopped is a FlywheelIterationStatus enum value
    FlywheelIterationStatusStopped = "STOPPED"
)
const (
    // FlywheelStatusCreating is a FlywheelStatus enum value
    FlywheelStatusCreating = "CREATING"

    // FlywheelStatusActive is a FlywheelStatus enum value
    FlywheelStatusActive = "ACTIVE"

    // FlywheelStatusUpdating is a FlywheelStatus enum value
    FlywheelStatusUpdating = "UPDATING"

    // FlywheelStatusDeleting is a FlywheelStatus enum value
    FlywheelStatusDeleting = "DELETING"

    // FlywheelStatusFailed is a FlywheelStatus enum value
    FlywheelStatusFailed = "FAILED"
)
const (
    // InputFormatOneDocPerFile is a InputFormat enum value
    InputFormatOneDocPerFile = "ONE_DOC_PER_FILE"

    // InputFormatOneDocPerLine is a InputFormat enum value
    InputFormatOneDocPerLine = "ONE_DOC_PER_LINE"
)
const (
    // InvalidRequestDetailReasonDocumentSizeExceeded is a InvalidRequestDetailReason enum value
    InvalidRequestDetailReasonDocumentSizeExceeded = "DOCUMENT_SIZE_EXCEEDED"

    // InvalidRequestDetailReasonUnsupportedDocType is a InvalidRequestDetailReason enum value
    InvalidRequestDetailReasonUnsupportedDocType = "UNSUPPORTED_DOC_TYPE"

    // InvalidRequestDetailReasonPageLimitExceeded is a InvalidRequestDetailReason enum value
    InvalidRequestDetailReasonPageLimitExceeded = "PAGE_LIMIT_EXCEEDED"

    // InvalidRequestDetailReasonTextractAccessDenied is a InvalidRequestDetailReason enum value
    InvalidRequestDetailReasonTextractAccessDenied = "TEXTRACT_ACCESS_DENIED"
)
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"

    // ModelStatusTrainedWithWarning is a ModelStatus enum value
    ModelStatusTrainedWithWarning = "TRAINED_WITH_WARNING"
)
const (
    // ModelTypeDocumentClassifier is a ModelType enum value
    ModelTypeDocumentClassifier = "DOCUMENT_CLASSIFIER"

    // ModelTypeEntityRecognizer is a ModelType enum value
    ModelTypeEntityRecognizer = "ENTITY_RECOGNIZER"
)
const (
    // PageBasedErrorCodeTextractBadPage is a PageBasedErrorCode enum value
    PageBasedErrorCodeTextractBadPage = "TEXTRACT_BAD_PAGE"

    // PageBasedErrorCodeTextractProvisionedThroughputExceeded is a PageBasedErrorCode enum value
    PageBasedErrorCodeTextractProvisionedThroughputExceeded = "TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED"

    // PageBasedErrorCodePageCharactersExceeded is a PageBasedErrorCode enum value
    PageBasedErrorCodePageCharactersExceeded = "PAGE_CHARACTERS_EXCEEDED"

    // PageBasedErrorCodePageSizeExceeded is a PageBasedErrorCode enum value
    PageBasedErrorCodePageSizeExceeded = "PAGE_SIZE_EXCEEDED"

    // PageBasedErrorCodeInternalServerError is a PageBasedErrorCode enum value
    PageBasedErrorCodeInternalServerError = "INTERNAL_SERVER_ERROR"
)
const (
    // PageBasedWarningCodeInferencingPlaintextWithNativeTrainedModel is a PageBasedWarningCode enum value
    PageBasedWarningCodeInferencingPlaintextWithNativeTrainedModel = "INFERENCING_PLAINTEXT_WITH_NATIVE_TRAINED_MODEL"

    // PageBasedWarningCodeInferencingNativeDocumentWithPlaintextTrainedModel is a PageBasedWarningCode enum value
    PageBasedWarningCodeInferencingNativeDocumentWithPlaintextTrainedModel = "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL"
)
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"

    // PiiEntityTypeLicensePlate is a PiiEntityType enum value
    PiiEntityTypeLicensePlate = "LICENSE_PLATE"

    // PiiEntityTypeVehicleIdentificationNumber is a PiiEntityType enum value
    PiiEntityTypeVehicleIdentificationNumber = "VEHICLE_IDENTIFICATION_NUMBER"

    // PiiEntityTypeUkNationalInsuranceNumber is a PiiEntityType enum value
    PiiEntityTypeUkNationalInsuranceNumber = "UK_NATIONAL_INSURANCE_NUMBER"

    // PiiEntityTypeCaSocialInsuranceNumber is a PiiEntityType enum value
    PiiEntityTypeCaSocialInsuranceNumber = "CA_SOCIAL_INSURANCE_NUMBER"

    // PiiEntityTypeUsIndividualTaxIdentificationNumber is a PiiEntityType enum value
    PiiEntityTypeUsIndividualTaxIdentificationNumber = "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"

    // PiiEntityTypeUkUniqueTaxpayerReferenceNumber is a PiiEntityType enum value
    PiiEntityTypeUkUniqueTaxpayerReferenceNumber = "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"

    // PiiEntityTypeInPermanentAccountNumber is a PiiEntityType enum value
    PiiEntityTypeInPermanentAccountNumber = "IN_PERMANENT_ACCOUNT_NUMBER"

    // PiiEntityTypeInNrega is a PiiEntityType enum value
    PiiEntityTypeInNrega = "IN_NREGA"

    // PiiEntityTypeInternationalBankAccountNumber is a PiiEntityType enum value
    PiiEntityTypeInternationalBankAccountNumber = "INTERNATIONAL_BANK_ACCOUNT_NUMBER"

    // PiiEntityTypeSwiftCode is a PiiEntityType enum value
    PiiEntityTypeSwiftCode = "SWIFT_CODE"

    // PiiEntityTypeUkNationalHealthServiceNumber is a PiiEntityType enum value
    PiiEntityTypeUkNationalHealthServiceNumber = "UK_NATIONAL_HEALTH_SERVICE_NUMBER"

    // PiiEntityTypeCaHealthNumber is a PiiEntityType enum value
    PiiEntityTypeCaHealthNumber = "CA_HEALTH_NUMBER"

    // PiiEntityTypeInAadhaar is a PiiEntityType enum value
    PiiEntityTypeInAadhaar = "IN_AADHAAR"

    // PiiEntityTypeInVoterNumber is a PiiEntityType enum value
    PiiEntityTypeInVoterNumber = "IN_VOTER_NUMBER"
)
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 (
    // SplitTrain is a Split enum value
    SplitTrain = "TRAIN"

    // SplitTest is a Split enum value
    SplitTest = "TEST"
)
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 (
    // TargetedSentimentEntityTypePerson is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypePerson = "PERSON"

    // TargetedSentimentEntityTypeLocation is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeLocation = "LOCATION"

    // TargetedSentimentEntityTypeOrganization is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeOrganization = "ORGANIZATION"

    // TargetedSentimentEntityTypeFacility is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeFacility = "FACILITY"

    // TargetedSentimentEntityTypeBrand is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeBrand = "BRAND"

    // TargetedSentimentEntityTypeCommercialItem is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeCommercialItem = "COMMERCIAL_ITEM"

    // TargetedSentimentEntityTypeMovie is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeMovie = "MOVIE"

    // TargetedSentimentEntityTypeMusic is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeMusic = "MUSIC"

    // TargetedSentimentEntityTypeBook is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeBook = "BOOK"

    // TargetedSentimentEntityTypeSoftware is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeSoftware = "SOFTWARE"

    // TargetedSentimentEntityTypeGame is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeGame = "GAME"

    // TargetedSentimentEntityTypePersonalTitle is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypePersonalTitle = "PERSONAL_TITLE"

    // TargetedSentimentEntityTypeEvent is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeEvent = "EVENT"

    // TargetedSentimentEntityTypeDate is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeDate = "DATE"

    // TargetedSentimentEntityTypeQuantity is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeQuantity = "QUANTITY"

    // TargetedSentimentEntityTypeAttribute is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeAttribute = "ATTRIBUTE"

    // TargetedSentimentEntityTypeOther is a TargetedSentimentEntityType enum value
    TargetedSentimentEntityTypeOther = "OTHER"
)
const (
    // ToxicContentTypeGraphic is a ToxicContentType enum value
    ToxicContentTypeGraphic = "GRAPHIC"

    // ToxicContentTypeHarassmentOrAbuse is a ToxicContentType enum value
    ToxicContentTypeHarassmentOrAbuse = "HARASSMENT_OR_ABUSE"

    // ToxicContentTypeHateSpeech is a ToxicContentType enum value
    ToxicContentTypeHateSpeech = "HATE_SPEECH"

    // ToxicContentTypeInsult is a ToxicContentType enum value
    ToxicContentTypeInsult = "INSULT"

    // ToxicContentTypeProfanity is a ToxicContentType enum value
    ToxicContentTypeProfanity = "PROFANITY"

    // ToxicContentTypeSexual is a ToxicContentType enum value
    ToxicContentTypeSexual = "SEXUAL"

    // ToxicContentTypeViolenceOrThreat is a ToxicContentType enum value
    ToxicContentTypeViolenceOrThreat = "VIOLENCE_OR_THREAT"
)
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 a list
    // of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html)
    // in the Comprehend Developer Guide.
    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

const (
    // InvalidRequestReasonInvalidDocument is a InvalidRequestReason enum value
    InvalidRequestReasonInvalidDocument = "INVALID_DOCUMENT"
)
const (
    // RelationshipTypeChild is a RelationshipType enum value
    RelationshipTypeChild = "CHILD"
)

func AugmentedManifestsDocumentTypeFormat_Values

func AugmentedManifestsDocumentTypeFormat_Values() []string

AugmentedManifestsDocumentTypeFormat_Values returns all elements of the AugmentedManifestsDocumentTypeFormat enum

func BlockType_Values

func BlockType_Values() []string

BlockType_Values returns all elements of the BlockType enum

func DatasetDataFormat_Values

func DatasetDataFormat_Values() []string

DatasetDataFormat_Values returns all elements of the DatasetDataFormat enum

func DatasetStatus_Values

func DatasetStatus_Values() []string

DatasetStatus_Values returns all elements of the DatasetStatus enum

func DatasetType_Values

func DatasetType_Values() []string

DatasetType_Values returns all elements of the DatasetType enum

func DocumentClassifierDataFormat_Values

func DocumentClassifierDataFormat_Values() []string

DocumentClassifierDataFormat_Values returns all elements of the DocumentClassifierDataFormat enum

func DocumentClassifierDocumentTypeFormat_Values

func DocumentClassifierDocumentTypeFormat_Values() []string

DocumentClassifierDocumentTypeFormat_Values returns all elements of the DocumentClassifierDocumentTypeFormat enum

func DocumentClassifierMode_Values

func DocumentClassifierMode_Values() []string

DocumentClassifierMode_Values returns all elements of the DocumentClassifierMode enum

func DocumentReadAction_Values

func DocumentReadAction_Values() []string

DocumentReadAction_Values returns all elements of the DocumentReadAction enum

func DocumentReadFeatureTypes_Values

func DocumentReadFeatureTypes_Values() []string

DocumentReadFeatureTypes_Values returns all elements of the DocumentReadFeatureTypes enum

func DocumentReadMode_Values

func DocumentReadMode_Values() []string

DocumentReadMode_Values returns all elements of the DocumentReadMode enum

func DocumentType_Values

func DocumentType_Values() []string

DocumentType_Values returns all elements of the DocumentType 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 FlywheelIterationStatus_Values

func FlywheelIterationStatus_Values() []string

FlywheelIterationStatus_Values returns all elements of the FlywheelIterationStatus enum

func FlywheelStatus_Values

func FlywheelStatus_Values() []string

FlywheelStatus_Values returns all elements of the FlywheelStatus enum

func InputFormat_Values

func InputFormat_Values() []string

InputFormat_Values returns all elements of the InputFormat enum

func InvalidRequestDetailReason_Values

func InvalidRequestDetailReason_Values() []string

InvalidRequestDetailReason_Values returns all elements of the InvalidRequestDetailReason enum

func InvalidRequestReason_Values

func InvalidRequestReason_Values() []string

InvalidRequestReason_Values returns all elements of the InvalidRequestReason 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 ModelType_Values

func ModelType_Values() []string

ModelType_Values returns all elements of the ModelType enum

func PageBasedErrorCode_Values

func PageBasedErrorCode_Values() []string

PageBasedErrorCode_Values returns all elements of the PageBasedErrorCode enum

func PageBasedWarningCode_Values

func PageBasedWarningCode_Values() []string

PageBasedWarningCode_Values returns all elements of the PageBasedWarningCode 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 RelationshipType_Values

func RelationshipType_Values() []string

RelationshipType_Values returns all elements of the RelationshipType enum

func SentimentType_Values

func SentimentType_Values() []string

SentimentType_Values returns all elements of the SentimentType enum

func Split_Values

func Split_Values() []string

Split_Values returns all elements of the Split enum

func SyntaxLanguageCode_Values

func SyntaxLanguageCode_Values() []string

SyntaxLanguageCode_Values returns all elements of the SyntaxLanguageCode enum

func TargetedSentimentEntityType_Values

func TargetedSentimentEntityType_Values() []string

TargetedSentimentEntityType_Values returns all elements of the TargetedSentimentEntityType enum

func ToxicContentType_Values

func ToxicContentType_Values() []string

ToxicContentType_Values returns all elements of the ToxicContentType enum

type AugmentedManifestsListItem

type AugmentedManifestsListItem struct {

    // The S3 prefix to the annotation files that are referred in the augmented
    // manifest file.
    AnnotationDataS3Uri *string `type:"string"`

    // 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 type of augmented manifest. PlainTextDocument or SemiStructuredDocument.
    // If you don't specify, the default is PlainTextDocument.
    //
    //    * PLAIN_TEXT_DOCUMENT A document type that represents any unicode text
    //    that is encoded in UTF-8.
    //
    //    * SEMI_STRUCTURED_DOCUMENT A document type with positional and structural
    //    context, like a PDF. For training with Amazon Comprehend, only PDFs are
    //    supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.
    DocumentType *string `type:"string" enum:"AugmentedManifestsDocumentTypeFormat"`

    // The Amazon S3 location of the augmented manifest file.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`

    // The S3 prefix to the source files (PDFs) that are referred to in the augmented
    // manifest file.
    SourceDocumentsS3Uri *string `type:"string"`

    // The purpose of the data you've provided in the augmented manifest. You can
    // either train or test this data. If you don't specify, the default is train.
    //
    // TRAIN - all of the documents in the manifest will be used for training. If
    // no test documents are provided, Amazon Comprehend will automatically reserve
    // a portion of the training documents for testing.
    //
    // TEST - all of the documents in the manifest will be used for testing.
    Split *string `type:"string" enum:"Split"`
    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AugmentedManifestsListItem) SetAnnotationDataS3Uri

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

SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value.

func (*AugmentedManifestsListItem) SetAttributeNames

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

SetAttributeNames sets the AttributeNames field's value.

func (*AugmentedManifestsListItem) SetDocumentType

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

SetDocumentType sets the DocumentType field's value.

func (*AugmentedManifestsListItem) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (*AugmentedManifestsListItem) SetSourceDocumentsS3Uri

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

SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value.

func (*AugmentedManifestsListItem) SetSplit

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

SetSplit sets the Split field's value.

func (AugmentedManifestsListItem) String

func (s AugmentedManifestsListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 UTF-8 encoded text of the input documents. The list
    // can contain a maximum of 25 documents. Each document should contain at least
    // 20 characters. The maximum size of each document is 5 KB.
    //
    // TextList is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by BatchDetectDominantLanguageInput's
    // String and GoString methods.
    //
    // TextList is a required field
    TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectDominantLanguageInput) GoString

func (s BatchDetectDominantLanguageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 UTF-8 encoded text of the input documents. The list
    // can contain a maximum of 25 documents. The maximum size of each document
    // is 5 KB.
    //
    // TextList is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by BatchDetectEntitiesInput's
    // String and GoString methods.
    //
    // TextList is a required field
    TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectEntitiesInput) GoString

func (s BatchDetectEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 UTF-8 encoded text of the input documents. The list
    // can contain a maximum of 25 documents. The maximum size of each document
    // is 5 KB.
    //
    // TextList is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by BatchDetectKeyPhrasesInput's
    // String and GoString methods.
    //
    // TextList is a required field
    TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectKeyPhrasesInput) GoString

func (s BatchDetectKeyPhrasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 UTF-8 encoded text of the input documents. The list
    // can contain a maximum of 25 documents. The maximum size of each document
    // is 5 KB.
    //
    // TextList is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by BatchDetectSentimentInput's
    // String and GoString methods.
    //
    // TextList is a required field
    TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectSentimentInput) GoString

func (s BatchDetectSentimentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 UTF-8 encoded text of the input documents. The list
    // can contain a maximum of 25 documents. The maximum size for each document
    // is 5 KB.
    //
    // TextList is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by BatchDetectSyntaxInput's
    // String and GoString methods.
    //
    // TextList is a required field
    TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectSyntaxInput) GoString

func (s BatchDetectSyntaxInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDetectTargetedSentimentInput

type BatchDetectTargetedSentimentInput struct {

    // The language of the input documents. Currently, English is the only supported
    // language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // A list containing the UTF-8 encoded text of the input documents. The list
    // can contain a maximum of 25 documents. The maximum size of each document
    // is 5 KB.
    //
    // TextList is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by BatchDetectTargetedSentimentInput's
    // String and GoString methods.
    //
    // TextList is a required field
    TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectTargetedSentimentInput) GoString

func (s BatchDetectTargetedSentimentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDetectTargetedSentimentInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectTargetedSentimentInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectTargetedSentimentInput) String

func (s BatchDetectTargetedSentimentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDetectTargetedSentimentInput) Validate

func (s *BatchDetectTargetedSentimentInput) Validate() error

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

type BatchDetectTargetedSentimentItemResult

type BatchDetectTargetedSentimentItemResult struct {

    // An array of targeted sentiment entities.
    Entities []*TargetedSentimentEntity `type:"list"`

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

Analysis results for one of the documents in the batch.

func (BatchDetectTargetedSentimentItemResult) GoString

func (s BatchDetectTargetedSentimentItemResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDetectTargetedSentimentItemResult) SetEntities

func (s *BatchDetectTargetedSentimentItemResult) SetEntities(v []*TargetedSentimentEntity) *BatchDetectTargetedSentimentItemResult

SetEntities sets the Entities field's value.

func (*BatchDetectTargetedSentimentItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (BatchDetectTargetedSentimentItemResult) String

func (s BatchDetectTargetedSentimentItemResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDetectTargetedSentimentOutput

type BatchDetectTargetedSentimentOutput struct {

    // List of errors that the operation can return.
    //
    // 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 []*BatchDetectTargetedSentimentItemResult `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectTargetedSentimentOutput) GoString

func (s BatchDetectTargetedSentimentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDetectTargetedSentimentOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectTargetedSentimentOutput) SetResultList

func (s *BatchDetectTargetedSentimentOutput) SetResultList(v []*BatchDetectTargetedSentimentItemResult) *BatchDetectTargetedSentimentOutput

SetResultList sets the ResultList field's value.

func (BatchDetectTargetedSentimentOutput) String

func (s BatchDetectTargetedSentimentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Block

type Block struct {

    // The block represents a line of text or one word of text.
    //
    //    * WORD - A word that's detected on a document page. A word is one or more
    //    ISO basic Latin script characters that aren't separated by spaces.
    //
    //    * LINE - A string of tab-delimited, contiguous words that are detected
    //    on a document page
    BlockType *string `type:"string" enum:"BlockType"`

    // Co-ordinates of the rectangle or polygon that contains the text.
    Geometry *Geometry `type:"structure"`

    // Unique identifier for the block.
    Id *string `min:"1" type:"string"`

    // Page number where the block appears.
    Page *int64 `type:"integer"`

    // A list of child blocks of the current block. For example, a LINE object has
    // child blocks for each WORD block that's part of the line of text.
    Relationships []*RelationshipsListItem `type:"list"`

    // The word or line of text extracted from the block.
    Text *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Information about each word or line of text in the input document.

For additional information, see Block (https://docs.aws.amazon.com/textract/latest/dg/API_Block.html) in the Amazon Textract API reference.

func (Block) GoString

func (s Block) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Block) SetBlockType

func (s *Block) SetBlockType(v string) *Block

SetBlockType sets the BlockType field's value.

func (*Block) SetGeometry

func (s *Block) SetGeometry(v *Geometry) *Block

SetGeometry sets the Geometry field's value.

func (*Block) SetId

func (s *Block) SetId(v string) *Block

SetId sets the Id field's value.

func (*Block) SetPage

func (s *Block) SetPage(v int64) *Block

SetPage sets the Page field's value.

func (*Block) SetRelationships

func (s *Block) SetRelationships(v []*RelationshipsListItem) *Block

SetRelationships sets the Relationships field's value.

func (*Block) SetText

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

SetText sets the Text field's value.

func (Block) String

func (s Block) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BlockReference

type BlockReference struct {

    // Offset of the start of the block within its parent block.
    BeginOffset *int64 `type:"integer"`

    // Unique identifier for the block.
    BlockId *string `min:"1" type:"string"`

    // List of child blocks within this block.
    ChildBlocks []*ChildBlock `type:"list"`

    // Offset of the end of the block within its parent block.
    EndOffset *int64 `type:"integer"`
    // contains filtered or unexported fields
}

A reference to a block.

func (BlockReference) GoString

func (s BlockReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BlockReference) SetBeginOffset

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

SetBeginOffset sets the BeginOffset field's value.

func (*BlockReference) SetBlockId

func (s *BlockReference) SetBlockId(v string) *BlockReference

SetBlockId sets the BlockId field's value.

func (*BlockReference) SetChildBlocks

func (s *BlockReference) SetChildBlocks(v []*ChildBlock) *BlockReference

SetChildBlocks sets the ChildBlocks field's value.

func (*BlockReference) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (BlockReference) String

func (s BlockReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BoundingBox

type BoundingBox struct {

    // The height of the bounding box as a ratio of the overall document page height.
    Height *float64 `type:"float"`

    // The left coordinate of the bounding box as a ratio of overall document page
    // width.
    Left *float64 `type:"float"`

    // The top coordinate of the bounding box as a ratio of overall document page
    // height.
    Top *float64 `type:"float"`

    // The width of the bounding box as a ratio of the overall document page width.
    Width *float64 `type:"float"`
    // contains filtered or unexported fields
}

The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

For additional information, see BoundingBox (https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html) in the Amazon Textract API reference.

func (BoundingBox) GoString

func (s BoundingBox) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BoundingBox) SetHeight

func (s *BoundingBox) SetHeight(v float64) *BoundingBox

SetHeight sets the Height field's value.

func (*BoundingBox) SetLeft

func (s *BoundingBox) SetLeft(v float64) *BoundingBox

SetLeft sets the Left field's value.

func (*BoundingBox) SetTop

func (s *BoundingBox) SetTop(v float64) *BoundingBox

SetTop sets the Top field's value.

func (*BoundingBox) SetWidth

func (s *BoundingBox) SetWidth(v float64) *BoundingBox

SetWidth sets the Width field's value.

func (BoundingBox) String

func (s BoundingBox) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChildBlock

type ChildBlock struct {

    // Offset of the start of the child block within its parent block.
    BeginOffset *int64 `type:"integer"`

    // Unique identifier for the child block.
    ChildBlockId *string `min:"1" type:"string"`

    // Offset of the end of the child block within its parent block.
    EndOffset *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Nested block contained within a block.

func (ChildBlock) GoString

func (s ChildBlock) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChildBlock) SetBeginOffset

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

SetBeginOffset sets the BeginOffset field's value.

func (*ChildBlock) SetChildBlockId

func (s *ChildBlock) SetChildBlockId(v string) *ChildBlock

SetChildBlockId sets the ChildBlockId field's value.

func (*ChildBlock) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (ChildBlock) String

func (s ChildBlock) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClassifyDocumentInput

type ClassifyDocumentInput struct {

    // Use the Bytes parameter to input a text, PDF, Word or image file.
    //
    // When you classify a document using a custom model, you can also use the Bytes
    // parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument
    // output file.
    //
    // To classify a document using the prompt safety classifier, use the Text parameter
    // for input.
    //
    // Provide the input document as a sequence of base64-encoded bytes. If your
    // code uses an Amazon Web Services SDK to classify documents, the SDK may encode
    // the document file bytes for you.
    //
    // The maximum length of this field depends on the input document type. For
    // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html)
    // in the Comprehend Developer Guide.
    //
    // If you use the Bytes parameter, do not use the Text parameter.
    // Bytes is automatically base64 encoded/decoded by the SDK.
    Bytes []byte `min:"1" type:"blob"`

    // Provides configuration parameters to override the default actions for extracting
    // text from PDF documents and image files.
    DocumentReaderConfig *DocumentReaderConfig `type:"structure"`

    // The Amazon Resource Number (ARN) of the endpoint.
    //
    // For prompt safety classification, Amazon Comprehend provides the endpoint
    // ARN. For more information about prompt safety classifiers, see Prompt safety
    // classification (https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification)
    // in the Amazon Comprehend Developer Guide
    //
    // For custom classification, you create an endpoint for your custom model.
    // For more information, see Using Amazon Comprehend endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html).
    //
    // EndpointArn is a required field
    EndpointArn *string `type:"string" required:"true"`

    // The document text to be analyzed. If you enter text using this parameter,
    // do not use the Bytes parameter.
    //
    // Text is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ClassifyDocumentInput's
    // String and GoString methods.
    Text *string `min:"1" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

func (ClassifyDocumentInput) GoString

func (s ClassifyDocumentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClassifyDocumentInput) SetBytes

func (s *ClassifyDocumentInput) SetBytes(v []byte) *ClassifyDocumentInput

SetBytes sets the Bytes field's value.

func (*ClassifyDocumentInput) SetDocumentReaderConfig

func (s *ClassifyDocumentInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *ClassifyDocumentInput

SetDocumentReaderConfig sets the DocumentReaderConfig field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 models
    // trained in multi-class mode. 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.
    //
    // For prompt safety classification, the response includes only two classes
    // (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class.
    // The value range of the score is zero to one, where one is the highest confidence.
    Classes []*DocumentClass `type:"list"`

    // Extraction information about the document. This field is present in the response
    // only if your request includes the Byte parameter.
    DocumentMetadata *DocumentMetadata `type:"structure"`

    // The document type for each page in the input document. This field is present
    // in the response only if your request includes the Byte parameter.
    DocumentType []*DocumentTypeListItem `type:"list"`

    // Page-level errors that the system detected while processing the input document.
    // The field is empty if the system encountered no errors.
    Errors []*ErrorsListItem `type:"list"`

    // The labels used in 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 mutually 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"`

    // Warnings detected while processing the input document. The response includes
    // a warning if there is a mismatch between the input document type and the
    // model type associated with the endpoint that you specified. The response
    // can also include warnings for individual pages that have a mismatch.
    //
    // The field is empty if the system generated no warnings.
    Warnings []*WarningsListItem `type:"list"`
    // contains filtered or unexported fields
}

func (ClassifyDocumentOutput) GoString

func (s ClassifyDocumentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClassifyDocumentOutput) SetClasses

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

SetClasses sets the Classes field's value.

func (*ClassifyDocumentOutput) SetDocumentMetadata

func (s *ClassifyDocumentOutput) SetDocumentMetadata(v *DocumentMetadata) *ClassifyDocumentOutput

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*ClassifyDocumentOutput) SetDocumentType

func (s *ClassifyDocumentOutput) SetDocumentType(v []*DocumentTypeListItem) *ClassifyDocumentOutput

SetDocumentType sets the DocumentType field's value.

func (*ClassifyDocumentOutput) SetErrors

func (s *ClassifyDocumentOutput) SetErrors(v []*ErrorsListItem) *ClassifyDocumentOutput

SetErrors sets the Errors field's value.

func (*ClassifyDocumentOutput) SetLabels

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

SetLabels sets the Labels field's value.

func (*ClassifyDocumentOutput) SetWarnings

func (s *ClassifyDocumentOutput) SetWarnings(v []*WarningsListItem) *ClassifyDocumentOutput

SetWarnings sets the Warnings field's value.

func (ClassifyDocumentOutput) String

func (s ClassifyDocumentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the Comprehend Developer Guide.

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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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 Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.

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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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) BatchDetectTargetedSentiment

func (c *Comprehend) BatchDetectTargetedSentiment(input *BatchDetectTargetedSentimentInput) (*BatchDetectTargetedSentimentOutput, error)

BatchDetectTargetedSentiment API operation for Amazon Comprehend.

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) in the Amazon Comprehend Developer Guide.

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 BatchDetectTargetedSentiment 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

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

func (*Comprehend) BatchDetectTargetedSentimentRequest

func (c *Comprehend) BatchDetectTargetedSentimentRequest(input *BatchDetectTargetedSentimentInput) (req *request.Request, output *BatchDetectTargetedSentimentOutput)

BatchDetectTargetedSentimentRequest generates a "aws/request.Request" representing the client's request for the BatchDetectTargetedSentiment 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 BatchDetectTargetedSentiment for more information on using the BatchDetectTargetedSentiment 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 BatchDetectTargetedSentimentRequest method.
req, resp := client.BatchDetectTargetedSentimentRequest(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/BatchDetectTargetedSentiment

func (*Comprehend) BatchDetectTargetedSentimentWithContext

func (c *Comprehend) BatchDetectTargetedSentimentWithContext(ctx aws.Context, input *BatchDetectTargetedSentimentInput, opts ...request.Option) (*BatchDetectTargetedSentimentOutput, error)

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

See BatchDetectTargetedSentiment 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 classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

  • Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification (https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the Amazon Comprehend Developer Guide.

  • Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification (https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification) in the Amazon Comprehend Developer Guide.

If the system detects errors while processing a page in the input document, the API response includes an Errors field that describes the errors.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) in the Comprehend Developer Guide.

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

func (c *Comprehend) ContainsPiiEntities(input *ContainsPiiEntitiesInput) (*ContainsPiiEntitiesOutput, error)

ContainsPiiEntities API operation for Amazon Comprehend.

Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.

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 ContainsPiiEntities 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

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

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

func (*Comprehend) ContainsPiiEntitiesRequest

func (c *Comprehend) ContainsPiiEntitiesRequest(input *ContainsPiiEntitiesInput) (req *request.Request, output *ContainsPiiEntitiesOutput)

ContainsPiiEntitiesRequest generates a "aws/request.Request" representing the client's request for the ContainsPiiEntities 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 ContainsPiiEntities for more information on using the ContainsPiiEntities 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 ContainsPiiEntitiesRequest method.
req, resp := client.ContainsPiiEntitiesRequest(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/ContainsPiiEntities

func (*Comprehend) ContainsPiiEntitiesWithContext

func (c *Comprehend) ContainsPiiEntitiesWithContext(ctx aws.Context, input *ContainsPiiEntitiesInput, opts ...request.Option) (*ContainsPiiEntitiesOutput, error)

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

See ContainsPiiEntities 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) CreateDataset

func (c *Comprehend) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error)

CreateDataset API operation for Amazon Comprehend.

Creates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

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

func (*Comprehend) CreateDatasetRequest

func (c *Comprehend) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput)

CreateDatasetRequest generates a "aws/request.Request" representing the client's request for the CreateDataset 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 CreateDataset for more information on using the CreateDataset 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 CreateDatasetRequest method.
req, resp := client.CreateDatasetRequest(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/CreateDataset

func (*Comprehend) CreateDatasetWithContext

func (c *Comprehend) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, error)

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

See CreateDataset 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 are labeled with the categories that you want to use. For more information, see Training classifier models (https://docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html) in the Comprehend Developer Guide.

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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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 For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.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 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 DescribeEntityRecognizer 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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) CreateFlywheel

func (c *Comprehend) CreateFlywheel(input *CreateFlywheelInput) (*CreateFlywheelOutput, error)

CreateFlywheel API operation for Amazon Comprehend.

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model.

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model.

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake.

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel.

For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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 CreateFlywheel 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

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

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

func (*Comprehend) CreateFlywheelRequest

func (c *Comprehend) CreateFlywheelRequest(input *CreateFlywheelInput) (req *request.Request, output *CreateFlywheelOutput)

CreateFlywheelRequest generates a "aws/request.Request" representing the client's request for the CreateFlywheel 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 CreateFlywheel for more information on using the CreateFlywheel 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 CreateFlywheelRequest method.
req, resp := client.CreateFlywheelRequest(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/CreateFlywheel

func (*Comprehend) CreateFlywheelWithContext

func (c *Comprehend) CreateFlywheelWithContext(ctx aws.Context, input *CreateFlywheelInput, opts ...request.Option) (*CreateFlywheelOutput, error)

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

See CreateFlywheel 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. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.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 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) DeleteFlywheel

func (c *Comprehend) DeleteFlywheel(input *DeleteFlywheelInput) (*DeleteFlywheelOutput, error)

DeleteFlywheel API operation for Amazon Comprehend.

Deletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel.

For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

func (*Comprehend) DeleteFlywheelRequest

func (c *Comprehend) DeleteFlywheelRequest(input *DeleteFlywheelInput) (req *request.Request, output *DeleteFlywheelOutput)

DeleteFlywheelRequest generates a "aws/request.Request" representing the client's request for the DeleteFlywheel 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 DeleteFlywheel for more information on using the DeleteFlywheel 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 DeleteFlywheelRequest method.
req, resp := client.DeleteFlywheelRequest(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/DeleteFlywheel

func (*Comprehend) DeleteFlywheelWithContext

func (c *Comprehend) DeleteFlywheelWithContext(ctx aws.Context, input *DeleteFlywheelInput, opts ...request.Option) (*DeleteFlywheelOutput, error)

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

See DeleteFlywheel 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) DeleteResourcePolicy

func (c *Comprehend) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error)

DeleteResourcePolicy API operation for Amazon Comprehend.

Deletes a resource-based policy that is attached to a 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 DeleteResourcePolicy 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/DeleteResourcePolicy

func (*Comprehend) DeleteResourcePolicyRequest

func (c *Comprehend) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput)

DeleteResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteResourcePolicy 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 DeleteResourcePolicy for more information on using the DeleteResourcePolicy 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 DeleteResourcePolicyRequest method.
req, resp := client.DeleteResourcePolicyRequest(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/DeleteResourcePolicy

func (*Comprehend) DeleteResourcePolicyWithContext

func (c *Comprehend) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error)

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

See DeleteResourcePolicy 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) DescribeDataset

func (c *Comprehend) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error)

DescribeDataset API operation for Amazon Comprehend.

Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

func (*Comprehend) DescribeDatasetRequest

func (c *Comprehend) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput)

DescribeDatasetRequest generates a "aws/request.Request" representing the client's request for the DescribeDataset 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 DescribeDataset for more information on using the DescribeDataset 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 DescribeDatasetRequest method.
req, resp := client.DescribeDatasetRequest(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/DescribeDataset

func (*Comprehend) DescribeDatasetWithContext

func (c *Comprehend) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, error)

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

See DescribeDataset 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. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.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 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) DescribeEventsDetectionJob

func (c *Comprehend) DescribeEventsDetectionJob(input *DescribeEventsDetectionJobInput) (*DescribeEventsDetectionJobOutput, error)

DescribeEventsDetectionJob API operation for Amazon Comprehend.

Gets the status and details of an events 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 DescribeEventsDetectionJob 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/DescribeEventsDetectionJob

func (*Comprehend) DescribeEventsDetectionJobRequest

func (c *Comprehend) DescribeEventsDetectionJobRequest(input *DescribeEventsDetectionJobInput) (req *request.Request, output *DescribeEventsDetectionJobOutput)

DescribeEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeEventsDetectionJob 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 DescribeEventsDetectionJob for more information on using the DescribeEventsDetectionJob 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 DescribeEventsDetectionJobRequest method.
req, resp := client.DescribeEventsDetectionJobRequest(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/DescribeEventsDetectionJob

func (*Comprehend) DescribeEventsDetectionJobWithContext

func (c *Comprehend) DescribeEventsDetectionJobWithContext(ctx aws.Context, input *DescribeEventsDetectionJobInput, opts ...request.Option) (*DescribeEventsDetectionJobOutput, error)

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

See DescribeEventsDetectionJob 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) DescribeFlywheel

func (c *Comprehend) DescribeFlywheel(input *DescribeFlywheelInput) (*DescribeFlywheelOutput, error)

DescribeFlywheel API operation for Amazon Comprehend.

Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

func (*Comprehend) DescribeFlywheelIteration

func (c *Comprehend) DescribeFlywheelIteration(input *DescribeFlywheelIterationInput) (*DescribeFlywheelIterationOutput, error)

DescribeFlywheelIteration API operation for Amazon Comprehend.

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

func (*Comprehend) DescribeFlywheelIterationRequest

func (c *Comprehend) DescribeFlywheelIterationRequest(input *DescribeFlywheelIterationInput) (req *request.Request, output *DescribeFlywheelIterationOutput)

DescribeFlywheelIterationRequest generates a "aws/request.Request" representing the client's request for the DescribeFlywheelIteration 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 DescribeFlywheelIteration for more information on using the DescribeFlywheelIteration 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 DescribeFlywheelIterationRequest method.
req, resp := client.DescribeFlywheelIterationRequest(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/DescribeFlywheelIteration

func (*Comprehend) DescribeFlywheelIterationWithContext

func (c *Comprehend) DescribeFlywheelIterationWithContext(ctx aws.Context, input *DescribeFlywheelIterationInput, opts ...request.Option) (*DescribeFlywheelIterationOutput, error)

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

See DescribeFlywheelIteration 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) DescribeFlywheelRequest

func (c *Comprehend) DescribeFlywheelRequest(input *DescribeFlywheelInput) (req *request.Request, output *DescribeFlywheelOutput)

DescribeFlywheelRequest generates a "aws/request.Request" representing the client's request for the DescribeFlywheel 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 DescribeFlywheel for more information on using the DescribeFlywheel 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 DescribeFlywheelRequest method.
req, resp := client.DescribeFlywheelRequest(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/DescribeFlywheel

func (*Comprehend) DescribeFlywheelWithContext

func (c *Comprehend) DescribeFlywheelWithContext(ctx aws.Context, input *DescribeFlywheelInput, opts ...request.Option) (*DescribeFlywheelOutput, error)

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

See DescribeFlywheel 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) DescribeResourcePolicy

func (c *Comprehend) DescribeResourcePolicy(input *DescribeResourcePolicyInput) (*DescribeResourcePolicyOutput, error)

DescribeResourcePolicy API operation for Amazon Comprehend.

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

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

func (*Comprehend) DescribeResourcePolicyRequest

func (c *Comprehend) DescribeResourcePolicyRequest(input *DescribeResourcePolicyInput) (req *request.Request, output *DescribeResourcePolicyOutput)

DescribeResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DescribeResourcePolicy 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 DescribeResourcePolicy for more information on using the DescribeResourcePolicy 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 DescribeResourcePolicyRequest method.
req, resp := client.DescribeResourcePolicyRequest(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/DescribeResourcePolicy

func (*Comprehend) DescribeResourcePolicyWithContext

func (c *Comprehend) DescribeResourcePolicyWithContext(ctx aws.Context, input *DescribeResourcePolicyInput, opts ...request.Option) (*DescribeResourcePolicyOutput, error)

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

See DescribeResourcePolicy 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) DescribeTargetedSentimentDetectionJob

func (c *Comprehend) DescribeTargetedSentimentDetectionJob(input *DescribeTargetedSentimentDetectionJobInput) (*DescribeTargetedSentimentDetectionJobOutput, error)

DescribeTargetedSentimentDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status 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 DescribeTargetedSentimentDetectionJob 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/DescribeTargetedSentimentDetectionJob

func (*Comprehend) DescribeTargetedSentimentDetectionJobRequest

func (c *Comprehend) DescribeTargetedSentimentDetectionJobRequest(input *DescribeTargetedSentimentDetectionJobInput) (req *request.Request, output *DescribeTargetedSentimentDetectionJobOutput)

DescribeTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeTargetedSentimentDetectionJob 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 DescribeTargetedSentimentDetectionJob for more information on using the DescribeTargetedSentimentDetectionJob 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 DescribeTargetedSentimentDetectionJobRequest method.
req, resp := client.DescribeTargetedSentimentDetectionJobRequest(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/DescribeTargetedSentimentDetectionJob

func (*Comprehend) DescribeTargetedSentimentDetectionJobWithContext

func (c *Comprehend) DescribeTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeTargetedSentimentDetectionJobInput, opts ...request.Option) (*DescribeTargetedSentimentDetectionJobOutput, error)

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

See DescribeTargetedSentimentDetectionJob 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.

Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the Comprehend Developer Guide.

When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) in the Comprehend Developer Guide.

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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.

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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

  • 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) DetectTargetedSentiment

func (c *Comprehend) DetectTargetedSentiment(input *DetectTargetedSentimentInput) (*DetectTargetedSentimentOutput, error)

DetectTargetedSentiment API operation for Amazon Comprehend.

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html) in the Amazon Comprehend Developer Guide.

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 DetectTargetedSentiment 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

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

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

func (*Comprehend) DetectTargetedSentimentRequest

func (c *Comprehend) DetectTargetedSentimentRequest(input *DetectTargetedSentimentInput) (req *request.Request, output *DetectTargetedSentimentOutput)

DetectTargetedSentimentRequest generates a "aws/request.Request" representing the client's request for the DetectTargetedSentiment 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 DetectTargetedSentiment for more information on using the DetectTargetedSentiment 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 DetectTargetedSentimentRequest method.
req, resp := client.DetectTargetedSentimentRequest(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/DetectTargetedSentiment

func (*Comprehend) DetectTargetedSentimentWithContext

func (c *Comprehend) DetectTargetedSentimentWithContext(ctx aws.Context, input *DetectTargetedSentimentInput, opts ...request.Option) (*DetectTargetedSentimentOutput, error)

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

See DetectTargetedSentiment 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) DetectToxicContent

func (c *Comprehend) DetectToxicContent(input *DetectToxicContentInput) (*DetectToxicContentOutput, error)

DetectToxicContent API operation for Amazon Comprehend.

Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection (https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html) in the Amazon Comprehend Developer Guide.

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 DetectToxicContent 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 a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

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

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

func (*Comprehend) DetectToxicContentRequest

func (c *Comprehend) DetectToxicContentRequest(input *DetectToxicContentInput) (req *request.Request, output *DetectToxicContentOutput)

DetectToxicContentRequest generates a "aws/request.Request" representing the client's request for the DetectToxicContent 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 DetectToxicContent for more information on using the DetectToxicContent 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 DetectToxicContentRequest method.
req, resp := client.DetectToxicContentRequest(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/DetectToxicContent

func (*Comprehend) DetectToxicContentWithContext

func (c *Comprehend) DetectToxicContentWithContext(ctx aws.Context, input *DetectToxicContentInput, opts ...request.Option) (*DetectToxicContentOutput, error)

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

See DetectToxicContent 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) ImportModel

func (c *Comprehend) ImportModel(input *ImportModelInput) (*ImportModelOutput, error)

ImportModel API operation for Amazon Comprehend.

Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.

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

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

  • ResourceUnavailableException The specified resource is not available. Check the resource 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.

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

func (*Comprehend) ImportModelRequest

func (c *Comprehend) ImportModelRequest(input *ImportModelInput) (req *request.Request, output *ImportModelOutput)

ImportModelRequest generates a "aws/request.Request" representing the client's request for the ImportModel 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 ImportModel for more information on using the ImportModel 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 ImportModelRequest method.
req, resp := client.ImportModelRequest(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/ImportModel

func (*Comprehend) ImportModelWithContext

func (c *Comprehend) ImportModelWithContext(ctx aws.Context, input *ImportModelInput, opts ...request.Option) (*ImportModelOutput, error)

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

See ImportModel 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) ListDatasets

func (c *Comprehend) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)

ListDatasets API operation for Amazon Comprehend.

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

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

func (*Comprehend) ListDatasetsPages

func (c *Comprehend) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error

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

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

func (*Comprehend) ListDatasetsPagesWithContext

func (c *Comprehend) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error

ListDatasetsPagesWithContext same as ListDatasetsPages 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) ListDatasetsRequest

func (c *Comprehend) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)

ListDatasetsRequest generates a "aws/request.Request" representing the client's request for the ListDatasets 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 ListDatasets for more information on using the ListDatasets 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 ListDatasetsRequest method.
req, resp := client.ListDatasetsRequest(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/ListDatasets

func (*Comprehend) ListDatasetsWithContext

func (c *Comprehend) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error)

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

See ListDatasets 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) ListDocumentClassifierSummaries

func (c *Comprehend) ListDocumentClassifierSummaries(input *ListDocumentClassifierSummariesInput) (*ListDocumentClassifierSummariesOutput, error)

ListDocumentClassifierSummaries API operation for Amazon Comprehend.

Gets a list of summaries 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 ListDocumentClassifierSummaries 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/ListDocumentClassifierSummaries

func (*Comprehend) ListDocumentClassifierSummariesPages

func (c *Comprehend) ListDocumentClassifierSummariesPages(input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool) error

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

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

func (*Comprehend) ListDocumentClassifierSummariesPagesWithContext

func (c *Comprehend) ListDocumentClassifierSummariesPagesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool, opts ...request.Option) error

ListDocumentClassifierSummariesPagesWithContext same as ListDocumentClassifierSummariesPages 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) ListDocumentClassifierSummariesRequest

func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentClassifierSummariesInput) (req *request.Request, output *ListDocumentClassifierSummariesOutput)

ListDocumentClassifierSummariesRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassifierSummaries 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 ListDocumentClassifierSummaries for more information on using the ListDocumentClassifierSummaries 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 ListDocumentClassifierSummariesRequest method.
req, resp := client.ListDocumentClassifierSummariesRequest(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/ListDocumentClassifierSummaries

func (*Comprehend) ListDocumentClassifierSummariesWithContext

func (c *Comprehend) ListDocumentClassifierSummariesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, opts ...request.Option) (*ListDocumentClassifierSummariesOutput, error)

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

See ListDocumentClassifierSummaries 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. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.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 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) ListEndpointsPages

func (c *Comprehend) ListEndpointsPages(input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool) error

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

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

func (*Comprehend) ListEndpointsPagesWithContext

func (c *Comprehend) ListEndpointsPagesWithContext(ctx aws.Context, input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool, opts ...request.Option) error

ListEndpointsPagesWithContext same as ListEndpointsPages 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) 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) ListEntityRecognizerSummaries

func (c *Comprehend) ListEntityRecognizerSummaries(input *ListEntityRecognizerSummariesInput) (*ListEntityRecognizerSummariesOutput, error)

ListEntityRecognizerSummaries API operation for Amazon Comprehend.

Gets a list of summaries for the entity recognizers 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 ListEntityRecognizerSummaries 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/ListEntityRecognizerSummaries

func (*Comprehend) ListEntityRecognizerSummariesPages

func (c *Comprehend) ListEntityRecognizerSummariesPages(input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool) error

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

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

func (*Comprehend) ListEntityRecognizerSummariesPagesWithContext

func (c *Comprehend) ListEntityRecognizerSummariesPagesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool, opts ...request.Option) error

ListEntityRecognizerSummariesPagesWithContext same as ListEntityRecognizerSummariesPages 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) ListEntityRecognizerSummariesRequest

func (c *Comprehend) ListEntityRecognizerSummariesRequest(input *ListEntityRecognizerSummariesInput) (req *request.Request, output *ListEntityRecognizerSummariesOutput)

ListEntityRecognizerSummariesRequest generates a "aws/request.Request" representing the client's request for the ListEntityRecognizerSummaries 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 ListEntityRecognizerSummaries for more information on using the ListEntityRecognizerSummaries 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 ListEntityRecognizerSummariesRequest method.
req, resp := client.ListEntityRecognizerSummariesRequest(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/ListEntityRecognizerSummaries

func (*Comprehend) ListEntityRecognizerSummariesWithContext

func (c *Comprehend) ListEntityRecognizerSummariesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, opts ...request.Option) (*ListEntityRecognizerSummariesOutput, error)

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

See ListEntityRecognizerSummaries 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) ListEventsDetectionJobs

func (c *Comprehend) ListEventsDetectionJobs(input *ListEventsDetectionJobsInput) (*ListEventsDetectionJobsOutput, error)

ListEventsDetectionJobs API operation for Amazon Comprehend.

Gets a list of the events 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 ListEventsDetectionJobs 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/ListEventsDetectionJobs

func (*Comprehend) ListEventsDetectionJobsPages

func (c *Comprehend) ListEventsDetectionJobsPages(input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool) error

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

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

func (*Comprehend) ListEventsDetectionJobsPagesWithContext

func (c *Comprehend) ListEventsDetectionJobsPagesWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListEventsDetectionJobsPagesWithContext same as ListEventsDetectionJobsPages 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) ListEventsDetectionJobsRequest

func (c *Comprehend) ListEventsDetectionJobsRequest(input *ListEventsDetectionJobsInput) (req *request.Request, output *ListEventsDetectionJobsOutput)

ListEventsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListEventsDetectionJobs 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 ListEventsDetectionJobs for more information on using the ListEventsDetectionJobs 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 ListEventsDetectionJobsRequest method.
req, resp := client.ListEventsDetectionJobsRequest(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/ListEventsDetectionJobs

func (*Comprehend) ListEventsDetectionJobsWithContext

func (c *Comprehend) ListEventsDetectionJobsWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, opts ...request.Option) (*ListEventsDetectionJobsOutput, error)

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

See ListEventsDetectionJobs 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) ListFlywheelIterationHistory

func (c *Comprehend) ListFlywheelIterationHistory(input *ListFlywheelIterationHistoryInput) (*ListFlywheelIterationHistoryOutput, error)

ListFlywheelIterationHistory API operation for Amazon Comprehend.

Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

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

func (*Comprehend) ListFlywheelIterationHistoryPages

func (c *Comprehend) ListFlywheelIterationHistoryPages(input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool) error

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

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

func (*Comprehend) ListFlywheelIterationHistoryPagesWithContext

func (c *Comprehend) ListFlywheelIterationHistoryPagesWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool, opts ...request.Option) error

ListFlywheelIterationHistoryPagesWithContext same as ListFlywheelIterationHistoryPages 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) ListFlywheelIterationHistoryRequest

func (c *Comprehend) ListFlywheelIterationHistoryRequest(input *ListFlywheelIterationHistoryInput) (req *request.Request, output *ListFlywheelIterationHistoryOutput)

ListFlywheelIterationHistoryRequest generates a "aws/request.Request" representing the client's request for the ListFlywheelIterationHistory 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 ListFlywheelIterationHistory for more information on using the ListFlywheelIterationHistory 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 ListFlywheelIterationHistoryRequest method.
req, resp := client.ListFlywheelIterationHistoryRequest(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/ListFlywheelIterationHistory

func (*Comprehend) ListFlywheelIterationHistoryWithContext

func (c *Comprehend) ListFlywheelIterationHistoryWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, opts ...request.Option) (*ListFlywheelIterationHistoryOutput, error)

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

See ListFlywheelIterationHistory 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) ListFlywheels

func (c *Comprehend) ListFlywheels(input *ListFlywheelsInput) (*ListFlywheelsOutput, error)

ListFlywheels API operation for Amazon Comprehend.

Gets a list of the flywheels 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 ListFlywheels 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/ListFlywheels

func (*Comprehend) ListFlywheelsPages

func (c *Comprehend) ListFlywheelsPages(input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool) error

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

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

func (*Comprehend) ListFlywheelsPagesWithContext

func (c *Comprehend) ListFlywheelsPagesWithContext(ctx aws.Context, input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool, opts ...request.Option) error

ListFlywheelsPagesWithContext same as ListFlywheelsPages 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) ListFlywheelsRequest

func (c *Comprehend) ListFlywheelsRequest(input *ListFlywheelsInput) (req *request.Request, output *ListFlywheelsOutput)

ListFlywheelsRequest generates a "aws/request.Request" representing the client's request for the ListFlywheels 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 ListFlywheels for more information on using the ListFlywheels 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 ListFlywheelsRequest method.
req, resp := client.ListFlywheelsRequest(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/ListFlywheels

func (*Comprehend) ListFlywheelsWithContext

func (c *Comprehend) ListFlywheelsWithContext(ctx aws.Context, input *ListFlywheelsInput, opts ...request.Option) (*ListFlywheelsOutput, error)

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

See ListFlywheels 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) ListPiiEntitiesDetectionJobsPages

func (c *Comprehend) ListPiiEntitiesDetectionJobsPages(input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool) error

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

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

func (*Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext

func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListPiiEntitiesDetectionJobsPagesWithContext same as ListPiiEntitiesDetectionJobsPages 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) 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) ListTargetedSentimentDetectionJobs

func (c *Comprehend) ListTargetedSentimentDetectionJobs(input *ListTargetedSentimentDetectionJobsInput) (*ListTargetedSentimentDetectionJobsOutput, error)

ListTargetedSentimentDetectionJobs API operation for Amazon Comprehend.

Gets a list of targeted 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 ListTargetedSentimentDetectionJobs 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/ListTargetedSentimentDetectionJobs

func (*Comprehend) ListTargetedSentimentDetectionJobsPages

func (c *Comprehend) ListTargetedSentimentDetectionJobsPages(input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool) error

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

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

func (*Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext

func (c *Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListTargetedSentimentDetectionJobsPagesWithContext same as ListTargetedSentimentDetectionJobsPages 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) ListTargetedSentimentDetectionJobsRequest

func (c *Comprehend) ListTargetedSentimentDetectionJobsRequest(input *ListTargetedSentimentDetectionJobsInput) (req *request.Request, output *ListTargetedSentimentDetectionJobsOutput)

ListTargetedSentimentDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTargetedSentimentDetectionJobs 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 ListTargetedSentimentDetectionJobs for more information on using the ListTargetedSentimentDetectionJobs 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 ListTargetedSentimentDetectionJobsRequest method.
req, resp := client.ListTargetedSentimentDetectionJobsRequest(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/ListTargetedSentimentDetectionJobs

func (*Comprehend) ListTargetedSentimentDetectionJobsWithContext

func (c *Comprehend) ListTargetedSentimentDetectionJobsWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, opts ...request.Option) (*ListTargetedSentimentDetectionJobsOutput, error)

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

See ListTargetedSentimentDetectionJobs 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) PutResourcePolicy

func (c *Comprehend) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)

PutResourcePolicy API operation for Amazon Comprehend.

Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.

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

func (*Comprehend) PutResourcePolicyRequest

func (c *Comprehend) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)

PutResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the PutResourcePolicy 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 PutResourcePolicy for more information on using the PutResourcePolicy 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 PutResourcePolicyRequest method.
req, resp := client.PutResourcePolicyRequest(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/PutResourcePolicy

func (*Comprehend) PutResourcePolicyWithContext

func (c *Comprehend) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error)

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

See PutResourcePolicy 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 using a custom classification model. Use the DescribeDocumentClassificationJob 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.

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

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

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

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

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

  • 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/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) StartEventsDetectionJob

func (c *Comprehend) StartEventsDetectionJob(input *StartEventsDetectionJobInput) (*StartEventsDetectionJobOutput, error)

StartEventsDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous event 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 StartEventsDetectionJob 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.

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

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

func (*Comprehend) StartEventsDetectionJobRequest

func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJobInput) (req *request.Request, output *StartEventsDetectionJobOutput)

StartEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartEventsDetectionJob 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 StartEventsDetectionJob for more information on using the StartEventsDetectionJob 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 StartEventsDetectionJobRequest method.
req, resp := client.StartEventsDetectionJobRequest(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/StartEventsDetectionJob

func (*Comprehend) StartEventsDetectionJobWithContext

func (c *Comprehend) StartEventsDetectionJobWithContext(ctx aws.Context, input *StartEventsDetectionJobInput, opts ...request.Option) (*StartEventsDetectionJobOutput, error)

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

See StartEventsDetectionJob 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) StartFlywheelIteration

func (c *Comprehend) StartFlywheelIteration(input *StartFlywheelIterationInput) (*StartFlywheelIterationOutput, error)

StartFlywheelIteration API operation for Amazon Comprehend.

Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

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

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

func (*Comprehend) StartFlywheelIterationRequest

func (c *Comprehend) StartFlywheelIterationRequest(input *StartFlywheelIterationInput) (req *request.Request, output *StartFlywheelIterationOutput)

StartFlywheelIterationRequest generates a "aws/request.Request" representing the client's request for the StartFlywheelIteration 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 StartFlywheelIteration for more information on using the StartFlywheelIteration 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 StartFlywheelIterationRequest method.
req, resp := client.StartFlywheelIterationRequest(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/StartFlywheelIteration

func (*Comprehend) StartFlywheelIterationWithContext

func (c *Comprehend) StartFlywheelIterationWithContext(ctx aws.Context, input *StartFlywheelIterationInput, opts ...request.Option) (*StartFlywheelIterationOutput, error)

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

See StartFlywheelIteration 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.

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

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

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

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

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

  • 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/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) StartTargetedSentimentDetectionJob

func (c *Comprehend) StartTargetedSentimentDetectionJob(input *StartTargetedSentimentDetectionJobInput) (*StartTargetedSentimentDetectionJobOutput, error)

StartTargetedSentimentDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob 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 StartTargetedSentimentDetectionJob 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.

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

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

func (*Comprehend) StartTargetedSentimentDetectionJobRequest

func (c *Comprehend) StartTargetedSentimentDetectionJobRequest(input *StartTargetedSentimentDetectionJobInput) (req *request.Request, output *StartTargetedSentimentDetectionJobOutput)

StartTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTargetedSentimentDetectionJob 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 StartTargetedSentimentDetectionJob for more information on using the StartTargetedSentimentDetectionJob 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 StartTargetedSentimentDetectionJobRequest method.
req, resp := client.StartTargetedSentimentDetectionJobRequest(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/StartTargetedSentimentDetectionJob

func (*Comprehend) StartTargetedSentimentDetectionJobWithContext

func (c *Comprehend) StartTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StartTargetedSentimentDetectionJobInput, opts ...request.Option) (*StartTargetedSentimentDetectionJobOutput, error)

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

See StartTargetedSentimentDetectionJob 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.

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

  • 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/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) StopEventsDetectionJob

func (c *Comprehend) StopEventsDetectionJob(input *StopEventsDetectionJobInput) (*StopEventsDetectionJobOutput, error)

StopEventsDetectionJob API operation for Amazon Comprehend.

Stops an events 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 StopEventsDetectionJob 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/StopEventsDetectionJob

func (*Comprehend) StopEventsDetectionJobRequest

func (c *Comprehend) StopEventsDetectionJobRequest(input *StopEventsDetectionJobInput) (req *request.Request, output *StopEventsDetectionJobOutput)

StopEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopEventsDetectionJob 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 StopEventsDetectionJob for more information on using the StopEventsDetectionJob 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 StopEventsDetectionJobRequest method.
req, resp := client.StopEventsDetectionJobRequest(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/StopEventsDetectionJob

func (*Comprehend) StopEventsDetectionJobWithContext

func (c *Comprehend) StopEventsDetectionJobWithContext(ctx aws.Context, input *StopEventsDetectionJobInput, opts ...request.Option) (*StopEventsDetectionJobOutput, error)

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

See StopEventsDetectionJob 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) StopTargetedSentimentDetectionJob

func (c *Comprehend) StopTargetedSentimentDetectionJob(input *StopTargetedSentimentDetectionJobInput) (*StopTargetedSentimentDetectionJobOutput, error)

StopTargetedSentimentDetectionJob API operation for Amazon Comprehend.

Stops a targeted 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 StopTargetedSentimentDetectionJob 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/StopTargetedSentimentDetectionJob

func (*Comprehend) StopTargetedSentimentDetectionJobRequest

func (c *Comprehend) StopTargetedSentimentDetectionJobRequest(input *StopTargetedSentimentDetectionJobInput) (req *request.Request, output *StopTargetedSentimentDetectionJobOutput)

StopTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopTargetedSentimentDetectionJob 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 StopTargetedSentimentDetectionJob for more information on using the StopTargetedSentimentDetectionJob 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 StopTargetedSentimentDetectionJobRequest method.
req, resp := client.StopTargetedSentimentDetectionJobRequest(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/StopTargetedSentimentDetectionJob

func (*Comprehend) StopTargetedSentimentDetectionJobWithContext

func (c *Comprehend) StopTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StopTargetedSentimentDetectionJobInput, opts ...request.Option) (*StopTargetedSentimentDetectionJobOutput, error)

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

See StopTargetedSentimentDetectionJob 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. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.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 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.

func (*Comprehend) UpdateFlywheel

func (c *Comprehend) UpdateFlywheel(input *UpdateFlywheelInput) (*UpdateFlywheelOutput, error)

UpdateFlywheel API operation for Amazon Comprehend.

Update the configuration information for an existing flywheel.

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

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

func (*Comprehend) UpdateFlywheelRequest

func (c *Comprehend) UpdateFlywheelRequest(input *UpdateFlywheelInput) (req *request.Request, output *UpdateFlywheelOutput)

UpdateFlywheelRequest generates a "aws/request.Request" representing the client's request for the UpdateFlywheel 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 UpdateFlywheel for more information on using the UpdateFlywheel 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 UpdateFlywheelRequest method.
req, resp := client.UpdateFlywheelRequest(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/UpdateFlywheel

func (*Comprehend) UpdateFlywheelWithContext

func (c *Comprehend) UpdateFlywheelWithContext(ctx aws.Context, input *UpdateFlywheelInput, opts ...request.Option) (*UpdateFlywheelOutput, error)

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

See UpdateFlywheel 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainsPiiEntitiesInput

type ContainsPiiEntitiesInput 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. The maximum string size is 100 KB.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ContainsPiiEntitiesInput) GoString

func (s ContainsPiiEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainsPiiEntitiesInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*ContainsPiiEntitiesInput) SetText

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

SetText sets the Text field's value.

func (ContainsPiiEntitiesInput) String

func (s ContainsPiiEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainsPiiEntitiesInput) Validate

func (s *ContainsPiiEntitiesInput) Validate() error

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

type ContainsPiiEntitiesOutput

type ContainsPiiEntitiesOutput struct {

    // The labels used in the document being analyzed. Individual labels represent
    // personally identifiable information (PII) entity types.
    Labels []*EntityLabel `type:"list"`
    // contains filtered or unexported fields
}

func (ContainsPiiEntitiesOutput) GoString

func (s ContainsPiiEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainsPiiEntitiesOutput) SetLabels

func (s *ContainsPiiEntitiesOutput) SetLabels(v []*EntityLabel) *ContainsPiiEntitiesOutput

SetLabels sets the Labels field's value.

func (ContainsPiiEntitiesOutput) String

func (s ContainsPiiEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDatasetInput

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

    // Name of the dataset.
    //
    // DatasetName is a required field
    DatasetName *string `type:"string" required:"true"`

    // The dataset type. You can specify that the data in a dataset is for training
    // the model or for testing the model.
    DatasetType *string `type:"string" enum:"DatasetType"`

    // Description of the dataset.
    Description *string `type:"string"`

    // The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive
    // the data.
    //
    // FlywheelArn is a required field
    FlywheelArn *string `type:"string" required:"true"`

    // Information about the input data configuration. The type of input data varies
    // based on the format of the input and whether the data is for a classifier
    // model or an entity recognition model.
    //
    // InputDataConfig is a required field
    InputDataConfig *DatasetInputDataConfig `type:"structure" required:"true"`

    // Tags for the dataset.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateDatasetInput) GoString

func (s CreateDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetInput) SetClientRequestToken

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDatasetInput) SetDatasetName

func (s *CreateDatasetInput) SetDatasetName(v string) *CreateDatasetInput

SetDatasetName sets the DatasetName field's value.

func (*CreateDatasetInput) SetDatasetType

func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput

SetDatasetType sets the DatasetType field's value.

func (*CreateDatasetInput) SetDescription

func (s *CreateDatasetInput) SetDescription(v string) *CreateDatasetInput

SetDescription sets the Description field's value.

func (*CreateDatasetInput) SetFlywheelArn

func (s *CreateDatasetInput) SetFlywheelArn(v string) *CreateDatasetInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*CreateDatasetInput) SetInputDataConfig

func (s *CreateDatasetInput) SetInputDataConfig(v *DatasetInputDataConfig) *CreateDatasetInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateDatasetInput) SetTags

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

SetTags sets the Tags field's value.

func (CreateDatasetInput) String

func (s CreateDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetInput) Validate

func (s *CreateDatasetInput) Validate() error

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

type CreateDatasetOutput

type CreateDatasetOutput struct {

    // The ARN of the dataset.
    DatasetArn *string `type:"string"`
    // contains filtered or unexported fields
}

func (CreateDatasetOutput) GoString

func (s CreateDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetOutput) SetDatasetArn

func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput

SetDatasetArn sets the DatasetArn field's value.

func (CreateDatasetOutput) String

func (s CreateDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

    // Indicates the mode in which the classifier will be trained. The classifier
    // can be trained in multi-class (single-label) mode or multi-label mode. Multi-class
    // mode identifies a single class label for each document and multi-label mode
    // identifies one or more class labels for each document. 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"`

    // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
    // models. The ModelKmsKeyId 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"
    ModelKmsKeyId *string `type:"string"`

    // The resource-based policy to attach to your custom document classifier model.
    // You can use this policy to allow another Amazon Web Services account to import
    // your custom model.
    //
    // Provide your policy as a JSON body that you enter as a UTF-8 encoded string
    // without line breaks. To provide valid JSON, enclose the attribute names and
    // values in double quotes. If the JSON body is also enclosed in double quotes,
    // then you must escape the double quotes that are inside the policy:
    //
    // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
    //
    // To avoid escaping quotes, you can use single quotes to enclose the policy
    // and double quotes to enclose the JSON names and values:
    //
    // '{"attribute": "value", "attribute": ["value"]}'
    ModelPolicy *string `min:"1" type:"string"`

    // Specifies the location for the output files from a custom classifier job.
    // This parameter is required for a request that creates a native document model.
    OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

    // Tags to associate with the document classifier. 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"`

    // The version name given to the newly created classifier. Version names can
    // have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and
    // underscores (_) are allowed. The version name must be unique among all models
    // with the same classifier name in the Amazon Web Services account/Amazon Web
    // Services Region.
    VersionName *string `type:"string"`

    // ID for the Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*CreateDocumentClassifierInput) SetModelPolicy

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

SetModelPolicy sets the ModelPolicy 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) SetVersionName

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

SetVersionName sets the VersionName 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
    // read access to trained custom models encrypted with a customer managed key
    // (ModelKmsKeyId).
    DataAccessRoleArn *string `min:"20" type:"string"`

    // 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 flywheel to which the endpoint will
    // be attached.
    FlywheelArn *string `type:"string"`

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

    // Tags to associate with the endpoint. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointInput) SetClientRequestToken

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEndpointInput) SetDataAccessRoleArn

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

SetDataAccessRoleArn sets the DataAccessRoleArn 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) SetFlywheelArn

func (s *CreateEndpointInput) SetFlywheelArn(v string) *CreateEndpointInput

SetFlywheelArn sets the FlywheelArn 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

func (CreateEndpointOutput) GoString

func (s CreateEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointOutput) SetEndpointArn

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

SetEndpointArn sets the EndpointArn field's value.

func (*CreateEndpointOutput) SetModelArn

func (s *CreateEndpointOutput) SetModelArn(v string) *CreateEndpointOutput

SetModelArn sets the ModelArn field's value.

func (CreateEndpointOutput) String

func (s CreateEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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: English ("en"), Spanish ("es"),
    // French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you
    // plan to use this entity recognizer with PDF, Word, or image input files,
    // you must specify English as the language. All training documents must be
    // in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
    // models. The ModelKmsKeyId 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"
    ModelKmsKeyId *string `type:"string"`

    // The JSON resource-based policy to attach to your custom entity recognizer
    // model. You can use this policy to allow another Amazon Web Services account
    // to import your custom model.
    //
    // Provide your JSON as a UTF-8 encoded string without line breaks. To provide
    // valid JSON for your policy, enclose the attribute names and values in double
    // quotes. If the JSON body is also enclosed in double quotes, then you must
    // escape the double quotes that are inside the policy:
    //
    // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
    //
    // To avoid escaping quotes, you can use single quotes to enclose the policy
    // and double quotes to enclose the JSON names and values:
    //
    // '{"attribute": "value", "attribute": ["value"]}'
    ModelPolicy *string `min:"1" type:"string"`

    // 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 associate with the entity recognizer. 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"`

    // The version name given to the newly created recognizer. Version names can
    // be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and
    // underscores (_) are allowed. The version name must be unique among all models
    // with the same recognizer name in the account/Region.
    VersionName *string `type:"string"`

    // ID for the Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*CreateEntityRecognizerInput) SetModelPolicy

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

SetModelPolicy sets the ModelPolicy 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) SetVersionName

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

SetVersionName sets the VersionName 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFlywheelInput

type CreateFlywheelInput struct {

    // To associate an existing model with the flywheel, specify the Amazon Resource
    // Number (ARN) of the model version. Do not set TaskConfig or ModelType if
    // you specify an ActiveModelArn.
    ActiveModelArn *string `type:"string"`

    // 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 IAM role that grants Amazon Comprehend
    // the permissions required to access the flywheel data in the data lake.
    //
    // DataAccessRoleArn is a required field
    DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

    // Enter the S3 location for the data lake. You can specify a new S3 bucket
    // or a new folder of an existing S3 bucket. The flywheel creates the data lake
    // at this location.
    //
    // DataLakeS3Uri is a required field
    DataLakeS3Uri *string `type:"string" required:"true"`

    // Data security configurations.
    DataSecurityConfig *DataSecurityConfig `type:"structure"`

    // Name for the flywheel.
    //
    // FlywheelName is a required field
    FlywheelName *string `type:"string" required:"true"`

    // The model type. You need to set ModelType if you are creating a flywheel
    // for a new model.
    ModelType *string `type:"string" enum:"ModelType"`

    // The tags to associate with this flywheel.
    Tags []*Tag `type:"list"`

    // Configuration about the model associated with the flywheel. You need to set
    // TaskConfig if you are creating a flywheel for a new model.
    TaskConfig *TaskConfig `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateFlywheelInput) GoString

func (s CreateFlywheelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlywheelInput) SetActiveModelArn

func (s *CreateFlywheelInput) SetActiveModelArn(v string) *CreateFlywheelInput

SetActiveModelArn sets the ActiveModelArn field's value.

func (*CreateFlywheelInput) SetClientRequestToken

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateFlywheelInput) SetDataAccessRoleArn

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateFlywheelInput) SetDataLakeS3Uri

func (s *CreateFlywheelInput) SetDataLakeS3Uri(v string) *CreateFlywheelInput

SetDataLakeS3Uri sets the DataLakeS3Uri field's value.

func (*CreateFlywheelInput) SetDataSecurityConfig

func (s *CreateFlywheelInput) SetDataSecurityConfig(v *DataSecurityConfig) *CreateFlywheelInput

SetDataSecurityConfig sets the DataSecurityConfig field's value.

func (*CreateFlywheelInput) SetFlywheelName

func (s *CreateFlywheelInput) SetFlywheelName(v string) *CreateFlywheelInput

SetFlywheelName sets the FlywheelName field's value.

func (*CreateFlywheelInput) SetModelType

func (s *CreateFlywheelInput) SetModelType(v string) *CreateFlywheelInput

SetModelType sets the ModelType field's value.

func (*CreateFlywheelInput) SetTags

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

SetTags sets the Tags field's value.

func (*CreateFlywheelInput) SetTaskConfig

func (s *CreateFlywheelInput) SetTaskConfig(v *TaskConfig) *CreateFlywheelInput

SetTaskConfig sets the TaskConfig field's value.

func (CreateFlywheelInput) String

func (s CreateFlywheelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlywheelInput) Validate

func (s *CreateFlywheelInput) Validate() error

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

type CreateFlywheelOutput

type CreateFlywheelOutput struct {

    // The Amazon Resource Number (ARN) of the active model version.
    ActiveModelArn *string `type:"string"`

    // The Amazon Resource Number (ARN) of the flywheel.
    FlywheelArn *string `type:"string"`
    // contains filtered or unexported fields
}

func (CreateFlywheelOutput) GoString

func (s CreateFlywheelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlywheelOutput) SetActiveModelArn

func (s *CreateFlywheelOutput) SetActiveModelArn(v string) *CreateFlywheelOutput

SetActiveModelArn sets the ActiveModelArn field's value.

func (*CreateFlywheelOutput) SetFlywheelArn

func (s *CreateFlywheelOutput) SetFlywheelArn(v string) *CreateFlywheelOutput

SetFlywheelArn sets the FlywheelArn field's value.

func (CreateFlywheelOutput) String

func (s CreateFlywheelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSecurityConfig

type DataSecurityConfig struct {

    // ID for the KMS key that Amazon Comprehend uses to encrypt the data in the
    // data lake.
    DataLakeKmsKeyId *string `type:"string"`

    // ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
    // models. The ModelKmsKeyId 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"
    ModelKmsKeyId *string `type:"string"`

    // ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for an optional private Virtual Private Cloud (VPC)
    // containing the resources you are using for the 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
}

Data security configuration.

func (DataSecurityConfig) GoString

func (s DataSecurityConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSecurityConfig) SetDataLakeKmsKeyId

func (s *DataSecurityConfig) SetDataLakeKmsKeyId(v string) *DataSecurityConfig

SetDataLakeKmsKeyId sets the DataLakeKmsKeyId field's value.

func (*DataSecurityConfig) SetModelKmsKeyId

func (s *DataSecurityConfig) SetModelKmsKeyId(v string) *DataSecurityConfig

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*DataSecurityConfig) SetVolumeKmsKeyId

func (s *DataSecurityConfig) SetVolumeKmsKeyId(v string) *DataSecurityConfig

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DataSecurityConfig) SetVpcConfig

func (s *DataSecurityConfig) SetVpcConfig(v *VpcConfig) *DataSecurityConfig

SetVpcConfig sets the VpcConfig field's value.

func (DataSecurityConfig) String

func (s DataSecurityConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSecurityConfig) Validate

func (s *DataSecurityConfig) Validate() error

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

type DatasetAugmentedManifestsListItem

type DatasetAugmentedManifestsListItem struct {

    // The S3 prefix to the annotation files that are referred in the augmented
    // manifest file.
    AnnotationDataS3Uri *string `type:"string"`

    // 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 type of augmented manifest. If you don't specify, the default is PlainTextDocument.
    //
    // PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that
    // is encoded in UTF-8.
    DocumentType *string `type:"string" enum:"AugmentedManifestsDocumentTypeFormat"`

    // The Amazon S3 location of the augmented manifest file.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`

    // The S3 prefix to the source files (PDFs) that are referred to in the augmented
    // manifest file.
    SourceDocumentsS3Uri *string `type:"string"`
    // 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 (DatasetAugmentedManifestsListItem) GoString

func (s DatasetAugmentedManifestsListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetAugmentedManifestsListItem) SetAnnotationDataS3Uri

func (s *DatasetAugmentedManifestsListItem) SetAnnotationDataS3Uri(v string) *DatasetAugmentedManifestsListItem

SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value.

func (*DatasetAugmentedManifestsListItem) SetAttributeNames

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

SetAttributeNames sets the AttributeNames field's value.

func (*DatasetAugmentedManifestsListItem) SetDocumentType

func (s *DatasetAugmentedManifestsListItem) SetDocumentType(v string) *DatasetAugmentedManifestsListItem

SetDocumentType sets the DocumentType field's value.

func (*DatasetAugmentedManifestsListItem) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (*DatasetAugmentedManifestsListItem) SetSourceDocumentsS3Uri

func (s *DatasetAugmentedManifestsListItem) SetSourceDocumentsS3Uri(v string) *DatasetAugmentedManifestsListItem

SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value.

func (DatasetAugmentedManifestsListItem) String

func (s DatasetAugmentedManifestsListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetAugmentedManifestsListItem) Validate

func (s *DatasetAugmentedManifestsListItem) Validate() error

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

type DatasetDocumentClassifierInputDataConfig

type DatasetDocumentClassifierInputDataConfig struct {

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

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

Describes the dataset input data configuration for a document classifier model.

For more information on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in the Comprehend Developer Guide.

func (DatasetDocumentClassifierInputDataConfig) GoString

func (s DatasetDocumentClassifierInputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetDocumentClassifierInputDataConfig) SetLabelDelimiter

func (s *DatasetDocumentClassifierInputDataConfig) SetLabelDelimiter(v string) *DatasetDocumentClassifierInputDataConfig

SetLabelDelimiter sets the LabelDelimiter field's value.

func (*DatasetDocumentClassifierInputDataConfig) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (DatasetDocumentClassifierInputDataConfig) String

func (s DatasetDocumentClassifierInputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetDocumentClassifierInputDataConfig) Validate

func (s *DatasetDocumentClassifierInputDataConfig) Validate() error

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

type DatasetEntityRecognizerAnnotations

type DatasetEntityRecognizerAnnotations 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 annotations associated with a entity recognizer.

func (DatasetEntityRecognizerAnnotations) GoString

func (s DatasetEntityRecognizerAnnotations) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerAnnotations) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (DatasetEntityRecognizerAnnotations) String

func (s DatasetEntityRecognizerAnnotations) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerAnnotations) Validate

func (s *DatasetEntityRecognizerAnnotations) Validate() error

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

type DatasetEntityRecognizerDocuments

type DatasetEntityRecognizerDocuments struct {

    // Specifies how the text in an input file should be processed. This is optional,
    // and the default is ONE_DOC_PER_LINE. 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"`

    // Specifies the Amazon S3 location where the documents for the dataset are
    // located.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Describes the documents submitted with a dataset for an entity recognizer model.

func (DatasetEntityRecognizerDocuments) GoString

func (s DatasetEntityRecognizerDocuments) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerDocuments) SetInputFormat

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

SetInputFormat sets the InputFormat field's value.

func (*DatasetEntityRecognizerDocuments) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (DatasetEntityRecognizerDocuments) String

func (s DatasetEntityRecognizerDocuments) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerDocuments) Validate

func (s *DatasetEntityRecognizerDocuments) Validate() error

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

type DatasetEntityRecognizerEntityList

type DatasetEntityRecognizerEntityList struct {

    // Specifies the Amazon S3 location where the entity list is located.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Describes the dataset entity list for an entity recognizer model.

For more information on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html) in the Comprehend Developer Guide.

func (DatasetEntityRecognizerEntityList) GoString

func (s DatasetEntityRecognizerEntityList) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerEntityList) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (DatasetEntityRecognizerEntityList) String

func (s DatasetEntityRecognizerEntityList) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerEntityList) Validate

func (s *DatasetEntityRecognizerEntityList) Validate() error

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

type DatasetEntityRecognizerInputDataConfig

type DatasetEntityRecognizerInputDataConfig struct {

    // The S3 location of the annotation documents for your custom entity recognizer.
    Annotations *DatasetEntityRecognizerAnnotations `type:"structure"`

    // The format and location of the training documents for your custom entity
    // recognizer.
    //
    // Documents is a required field
    Documents *DatasetEntityRecognizerDocuments `type:"structure" required:"true"`

    // The S3 location of the entity list for your custom entity recognizer.
    EntityList *DatasetEntityRecognizerEntityList `type:"structure"`
    // contains filtered or unexported fields
}

Specifies the format and location of the input data. You must provide either the Annotations parameter or the EntityList parameter.

func (DatasetEntityRecognizerInputDataConfig) GoString

func (s DatasetEntityRecognizerInputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerInputDataConfig) SetAnnotations

func (s *DatasetEntityRecognizerInputDataConfig) SetAnnotations(v *DatasetEntityRecognizerAnnotations) *DatasetEntityRecognizerInputDataConfig

SetAnnotations sets the Annotations field's value.

func (*DatasetEntityRecognizerInputDataConfig) SetDocuments

func (s *DatasetEntityRecognizerInputDataConfig) SetDocuments(v *DatasetEntityRecognizerDocuments) *DatasetEntityRecognizerInputDataConfig

SetDocuments sets the Documents field's value.

func (*DatasetEntityRecognizerInputDataConfig) SetEntityList

func (s *DatasetEntityRecognizerInputDataConfig) SetEntityList(v *DatasetEntityRecognizerEntityList) *DatasetEntityRecognizerInputDataConfig

SetEntityList sets the EntityList field's value.

func (DatasetEntityRecognizerInputDataConfig) String

func (s DatasetEntityRecognizerInputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerInputDataConfig) Validate

func (s *DatasetEntityRecognizerInputDataConfig) Validate() error

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

type DatasetFilter

type DatasetFilter struct {

    // Filter the datasets to include datasets created after the specified time.
    CreationTimeAfter *time.Time `type:"timestamp"`

    // Filter the datasets to include datasets created before the specified time.
    CreationTimeBefore *time.Time `type:"timestamp"`

    // Filter the datasets based on the dataset type.
    DatasetType *string `type:"string" enum:"DatasetType"`

    // Filter the datasets based on the dataset status.
    Status *string `type:"string" enum:"DatasetStatus"`
    // contains filtered or unexported fields
}

Filter the datasets based on creation time or dataset status.

func (DatasetFilter) GoString

func (s DatasetFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetFilter) SetCreationTimeAfter

func (s *DatasetFilter) SetCreationTimeAfter(v time.Time) *DatasetFilter

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*DatasetFilter) SetCreationTimeBefore

func (s *DatasetFilter) SetCreationTimeBefore(v time.Time) *DatasetFilter

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (*DatasetFilter) SetDatasetType

func (s *DatasetFilter) SetDatasetType(v string) *DatasetFilter

SetDatasetType sets the DatasetType field's value.

func (*DatasetFilter) SetStatus

func (s *DatasetFilter) SetStatus(v string) *DatasetFilter

SetStatus sets the Status field's value.

func (DatasetFilter) String

func (s DatasetFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetInputDataConfig

type DatasetInputDataConfig 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.
    AugmentedManifests []*DatasetAugmentedManifestsListItem `type:"list"`

    // COMPREHEND_CSV: The data format is a two-column CSV file, where the first
    // column contains labels and the second column contains documents.
    //
    // AUGMENTED_MANIFEST: The data format
    DataFormat *string `type:"string" enum:"DatasetDataFormat"`

    // The input properties for training a document classifier model.
    //
    // For more information on how the input file is formatted, see Preparing training
    // data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html)
    // in the Comprehend Developer Guide.
    DocumentClassifierInputDataConfig *DatasetDocumentClassifierInputDataConfig `type:"structure"`

    // The input properties for training an entity recognizer model.
    EntityRecognizerInputDataConfig *DatasetEntityRecognizerInputDataConfig `type:"structure"`
    // contains filtered or unexported fields
}

Specifies the format and location of the input data for the dataset.

func (DatasetInputDataConfig) GoString

func (s DatasetInputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetInputDataConfig) SetAugmentedManifests

func (s *DatasetInputDataConfig) SetAugmentedManifests(v []*DatasetAugmentedManifestsListItem) *DatasetInputDataConfig

SetAugmentedManifests sets the AugmentedManifests field's value.

func (*DatasetInputDataConfig) SetDataFormat

func (s *DatasetInputDataConfig) SetDataFormat(v string) *DatasetInputDataConfig

SetDataFormat sets the DataFormat field's value.

func (*DatasetInputDataConfig) SetDocumentClassifierInputDataConfig

func (s *DatasetInputDataConfig) SetDocumentClassifierInputDataConfig(v *DatasetDocumentClassifierInputDataConfig) *DatasetInputDataConfig

SetDocumentClassifierInputDataConfig sets the DocumentClassifierInputDataConfig field's value.

func (*DatasetInputDataConfig) SetEntityRecognizerInputDataConfig

func (s *DatasetInputDataConfig) SetEntityRecognizerInputDataConfig(v *DatasetEntityRecognizerInputDataConfig) *DatasetInputDataConfig

SetEntityRecognizerInputDataConfig sets the EntityRecognizerInputDataConfig field's value.

func (DatasetInputDataConfig) String

func (s DatasetInputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetInputDataConfig) Validate

func (s *DatasetInputDataConfig) Validate() error

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

type DatasetProperties

type DatasetProperties struct {

    // Creation time of the dataset.
    CreationTime *time.Time `type:"timestamp"`

    // The ARN of the dataset.
    DatasetArn *string `type:"string"`

    // The name of the dataset.
    DatasetName *string `type:"string"`

    // The S3 URI where the dataset is stored.
    DatasetS3Uri *string `type:"string"`

    // The dataset type (training data or test data).
    DatasetType *string `type:"string" enum:"DatasetType"`

    // Description of the dataset.
    Description *string `type:"string"`

    // Time when the data from the dataset becomes available in the data lake.
    EndTime *time.Time `type:"timestamp"`

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

    // The number of documents in the dataset.
    NumberOfDocuments *int64 `type:"long"`

    // The dataset status. While the system creates the dataset, the status is CREATING.
    // When the dataset is ready to use, the status changes to COMPLETED.
    Status *string `type:"string" enum:"DatasetStatus"`
    // contains filtered or unexported fields
}

Properties associated with the dataset.

func (DatasetProperties) GoString

func (s DatasetProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetProperties) SetCreationTime

func (s *DatasetProperties) SetCreationTime(v time.Time) *DatasetProperties

SetCreationTime sets the CreationTime field's value.

func (*DatasetProperties) SetDatasetArn

func (s *DatasetProperties) SetDatasetArn(v string) *DatasetProperties

SetDatasetArn sets the DatasetArn field's value.

func (*DatasetProperties) SetDatasetName

func (s *DatasetProperties) SetDatasetName(v string) *DatasetProperties

SetDatasetName sets the DatasetName field's value.

func (*DatasetProperties) SetDatasetS3Uri

func (s *DatasetProperties) SetDatasetS3Uri(v string) *DatasetProperties

SetDatasetS3Uri sets the DatasetS3Uri field's value.

func (*DatasetProperties) SetDatasetType

func (s *DatasetProperties) SetDatasetType(v string) *DatasetProperties

SetDatasetType sets the DatasetType field's value.

func (*DatasetProperties) SetDescription

func (s *DatasetProperties) SetDescription(v string) *DatasetProperties

SetDescription sets the Description field's value.

func (*DatasetProperties) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*DatasetProperties) SetMessage

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

SetMessage sets the Message field's value.

func (*DatasetProperties) SetNumberOfDocuments

func (s *DatasetProperties) SetNumberOfDocuments(v int64) *DatasetProperties

SetNumberOfDocuments sets the NumberOfDocuments field's value.

func (*DatasetProperties) SetStatus

func (s *DatasetProperties) SetStatus(v string) *DatasetProperties

SetStatus sets the Status field's value.

func (DatasetProperties) String

func (s DatasetProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDocumentClassifierOutput) String

func (s DeleteDocumentClassifierOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEndpointOutput) String

func (s DeleteEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEntityRecognizerOutput) String

func (s DeleteEntityRecognizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFlywheelInput

type DeleteFlywheelInput struct {

    // The Amazon Resource Number (ARN) of the flywheel to delete.
    //
    // FlywheelArn is a required field
    FlywheelArn *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteFlywheelInput) GoString

func (s DeleteFlywheelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFlywheelInput) SetFlywheelArn

func (s *DeleteFlywheelInput) SetFlywheelArn(v string) *DeleteFlywheelInput

SetFlywheelArn sets the FlywheelArn field's value.

func (DeleteFlywheelInput) String

func (s DeleteFlywheelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFlywheelInput) Validate

func (s *DeleteFlywheelInput) Validate() error

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

type DeleteFlywheelOutput

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

func (DeleteFlywheelOutput) GoString

func (s DeleteFlywheelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFlywheelOutput) String

func (s DeleteFlywheelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteResourcePolicyInput

type DeleteResourcePolicyInput struct {

    // The revision ID of the policy to delete.
    PolicyRevisionId *string `type:"string"`

    // The Amazon Resource Name (ARN) of the custom model version that has the policy
    // to delete.
    //
    // ResourceArn is a required field
    ResourceArn *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteResourcePolicyInput) GoString

func (s DeleteResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourcePolicyInput) SetPolicyRevisionId

func (s *DeleteResourcePolicyInput) SetPolicyRevisionId(v string) *DeleteResourcePolicyInput

SetPolicyRevisionId sets the PolicyRevisionId field's value.

func (*DeleteResourcePolicyInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (DeleteResourcePolicyInput) String

func (s DeleteResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourcePolicyInput) Validate

func (s *DeleteResourcePolicyInput) Validate() error

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

type DeleteResourcePolicyOutput

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

func (DeleteResourcePolicyOutput) GoString

func (s DeleteResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteResourcePolicyOutput) String

func (s DeleteResourcePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDatasetInput

type DescribeDatasetInput struct {

    // The ARN of the dataset.
    //
    // DatasetArn is a required field
    DatasetArn *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeDatasetInput) GoString

func (s DescribeDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetInput) SetDatasetArn

func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DescribeDatasetInput) String

func (s DescribeDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetInput) Validate

func (s *DescribeDatasetInput) Validate() error

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

type DescribeDatasetOutput

type DescribeDatasetOutput struct {

    // The dataset properties.
    DatasetProperties *DatasetProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeDatasetOutput) GoString

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetOutput) SetDatasetProperties

func (s *DescribeDatasetOutput) SetDatasetProperties(v *DatasetProperties) *DescribeDatasetOutput

SetDatasetProperties sets the DatasetProperties field's value.

func (DescribeDatasetOutput) String

func (s DescribeDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDocumentClassificationJobInput

type DescribeDocumentClassificationJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob
    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDocumentClassifierInput

type DescribeDocumentClassifierInput struct {

    // The Amazon Resource Name (ARN) that identifies the document classifier. The
    // CreateDocumentClassifier 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDominantLanguageDetectionJobInput

type DescribeDominantLanguageDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob
    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEntitiesDetectionJobInput

type DescribeEntitiesDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob
    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventsDetectionJobInput

type DescribeEventsDetectionJobInput struct {

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

func (DescribeEventsDetectionJobInput) GoString

func (s DescribeEventsDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsDetectionJobInput) SetJobId

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

SetJobId sets the JobId field's value.

func (DescribeEventsDetectionJobInput) String

func (s DescribeEventsDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsDetectionJobInput) Validate

func (s *DescribeEventsDetectionJobInput) Validate() error

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

type DescribeEventsDetectionJobOutput

type DescribeEventsDetectionJobOutput struct {

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

func (DescribeEventsDetectionJobOutput) GoString

func (s DescribeEventsDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsDetectionJobOutput) SetEventsDetectionJobProperties

func (s *DescribeEventsDetectionJobOutput) SetEventsDetectionJobProperties(v *EventsDetectionJobProperties) *DescribeEventsDetectionJobOutput

SetEventsDetectionJobProperties sets the EventsDetectionJobProperties field's value.

func (DescribeEventsDetectionJobOutput) String

func (s DescribeEventsDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFlywheelInput

type DescribeFlywheelInput struct {

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

func (DescribeFlywheelInput) GoString

func (s DescribeFlywheelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelInput) SetFlywheelArn

func (s *DescribeFlywheelInput) SetFlywheelArn(v string) *DescribeFlywheelInput

SetFlywheelArn sets the FlywheelArn field's value.

func (DescribeFlywheelInput) String

func (s DescribeFlywheelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelInput) Validate

func (s *DescribeFlywheelInput) Validate() error

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

type DescribeFlywheelIterationInput

type DescribeFlywheelIterationInput struct {

    // FlywheelArn is a required field
    FlywheelArn *string `type:"string" required:"true"`

    // FlywheelIterationId is a required field
    FlywheelIterationId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeFlywheelIterationInput) GoString

func (s DescribeFlywheelIterationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelIterationInput) SetFlywheelArn

func (s *DescribeFlywheelIterationInput) SetFlywheelArn(v string) *DescribeFlywheelIterationInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*DescribeFlywheelIterationInput) SetFlywheelIterationId

func (s *DescribeFlywheelIterationInput) SetFlywheelIterationId(v string) *DescribeFlywheelIterationInput

SetFlywheelIterationId sets the FlywheelIterationId field's value.

func (DescribeFlywheelIterationInput) String

func (s DescribeFlywheelIterationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelIterationInput) Validate

func (s *DescribeFlywheelIterationInput) Validate() error

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

type DescribeFlywheelIterationOutput

type DescribeFlywheelIterationOutput struct {

    // The configuration properties of a flywheel iteration.
    FlywheelIterationProperties *FlywheelIterationProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeFlywheelIterationOutput) GoString

func (s DescribeFlywheelIterationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelIterationOutput) SetFlywheelIterationProperties

func (s *DescribeFlywheelIterationOutput) SetFlywheelIterationProperties(v *FlywheelIterationProperties) *DescribeFlywheelIterationOutput

SetFlywheelIterationProperties sets the FlywheelIterationProperties field's value.

func (DescribeFlywheelIterationOutput) String

func (s DescribeFlywheelIterationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFlywheelOutput

type DescribeFlywheelOutput struct {

    // The flywheel properties.
    FlywheelProperties *FlywheelProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeFlywheelOutput) GoString

func (s DescribeFlywheelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelOutput) SetFlywheelProperties

func (s *DescribeFlywheelOutput) SetFlywheelProperties(v *FlywheelProperties) *DescribeFlywheelOutput

SetFlywheelProperties sets the FlywheelProperties field's value.

func (DescribeFlywheelOutput) String

func (s DescribeFlywheelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeKeyPhrasesDetectionJobInput

type DescribeKeyPhrasesDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob
    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeResourcePolicyInput

type DescribeResourcePolicyInput struct {

    // The Amazon Resource Name (ARN) of the custom model version that has the resource
    // policy.
    //
    // ResourceArn is a required field
    ResourceArn *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeResourcePolicyInput) GoString

func (s DescribeResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (DescribeResourcePolicyInput) String

func (s DescribeResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyInput) Validate

func (s *DescribeResourcePolicyInput) Validate() error

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

type DescribeResourcePolicyOutput

type DescribeResourcePolicyOutput struct {

    // The time at which the policy was created.
    CreationTime *time.Time `type:"timestamp"`

    // The time at which the policy was last modified.
    LastModifiedTime *time.Time `type:"timestamp"`

    // The revision ID of the policy. Each time you modify a policy, Amazon Comprehend
    // assigns a new revision ID, and it deletes the prior version of the policy.
    PolicyRevisionId *string `type:"string"`

    // The JSON body of the resource-based policy.
    ResourcePolicy *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeResourcePolicyOutput) GoString

func (s DescribeResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyOutput) SetCreationTime

func (s *DescribeResourcePolicyOutput) SetCreationTime(v time.Time) *DescribeResourcePolicyOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeResourcePolicyOutput) SetLastModifiedTime

func (s *DescribeResourcePolicyOutput) SetLastModifiedTime(v time.Time) *DescribeResourcePolicyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DescribeResourcePolicyOutput) SetPolicyRevisionId

func (s *DescribeResourcePolicyOutput) SetPolicyRevisionId(v string) *DescribeResourcePolicyOutput

SetPolicyRevisionId sets the PolicyRevisionId field's value.

func (*DescribeResourcePolicyOutput) SetResourcePolicy

func (s *DescribeResourcePolicyOutput) SetResourcePolicy(v string) *DescribeResourcePolicyOutput

SetResourcePolicy sets the ResourcePolicy field's value.

func (DescribeResourcePolicyOutput) String

func (s DescribeResourcePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTargetedSentimentDetectionJobInput

type DescribeTargetedSentimentDetectionJobInput struct {

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

func (s DescribeTargetedSentimentDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTargetedSentimentDetectionJobInput) SetJobId

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

SetJobId sets the JobId field's value.

func (DescribeTargetedSentimentDetectionJobInput) String

func (s DescribeTargetedSentimentDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTargetedSentimentDetectionJobInput) Validate

func (s *DescribeTargetedSentimentDetectionJobInput) Validate() error

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

type DescribeTargetedSentimentDetectionJobOutput

type DescribeTargetedSentimentDetectionJobOutput struct {

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

func (DescribeTargetedSentimentDetectionJobOutput) GoString

func (s DescribeTargetedSentimentDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties

func (s *DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties(v *TargetedSentimentDetectionJobProperties) *DescribeTargetedSentimentDetectionJobOutput

SetTargetedSentimentDetectionJobProperties sets the TargetedSentimentDetectionJobProperties field's value.

func (DescribeTargetedSentimentDetectionJobOutput) String

func (s DescribeTargetedSentimentDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTopicsDetectionJobInput) SetJobId<