const ServiceAPIVersion = "2017-11-27"

const ServiceID = "Comprehend"

type BatchDetectDominantLanguageInput struct {
	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document should contain at least 20 characters and
	// must contain fewer than 5,000 bytes of UTF-8 encoded characters.
	TextList []*string
}

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 []*types.BatchItemError
	// 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 []*types.BatchDetectDominantLanguageItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 types.LanguageCode
	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer than 5,000 bytes of
	// UTF-8 encoded characters.
	TextList []*string
}

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 []*types.BatchItemError
	// 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 []*types.BatchDetectEntitiesItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 types.LanguageCode
	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer that 5,000 bytes of
	// UTF-8 encoded characters.
	TextList []*string
}

type BatchDetectKeyPhrasesOutput struct {
	// 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 []*types.BatchDetectKeyPhrasesItemResult
	// 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 []*types.BatchItemError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchDetectSentimentInput struct {
	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer that 5,000 bytes of
	// UTF-8 encoded characters.
	TextList []*string
	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	LanguageCode types.LanguageCode
}

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 []*types.BatchItemError
	// 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 []*types.BatchDetectSentimentItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchDetectSyntaxInput struct {
	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer that 5,000 bytes of
	// UTF-8 encoded characters.
	TextList []*string
	// 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 types.SyntaxLanguageCode
}

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 []*types.BatchItemError
	// 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 []*types.BatchDetectSyntaxItemResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ClassifyDocumentInput struct {
	// The document text to be analyzed.
	Text *string
	// The Amazon Resource Number (ARN) of the endpoint.
	EndpointArn *string
}

type ClassifyDocumentOutput struct {
	// The classes used by the document being analyzed. These are used for multi-class
	// trained models. Individual classes are mutually exclusive and each document is
	// expected to have only a single class assigned to it. For example, an animal can
	// be a dog or a cat, but not both at the same time.
	Classes []*types.DocumentClass
	// The labels used the document being analyzed. These are used for multi-label
	// trained models. Individual labels represent different categories that are
	// related in some manner and are not multually exclusive. For example, a movie can
	// be just an action movie, or it can be an action movie, a science fiction movie,
	// and a comedy, all at the same time.
	Labels []*types.DocumentLabel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateDocumentClassifierInput struct {
	// The name of the document classifier.
	DocumentClassifierName *string
	// Tags to be associated with the document classifier being created. A tag is a
	// key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
	// For example, a tag with "Sales" as the key might be added to a resource to
	// indicate its use by the sales department.
	Tags []*types.Tag
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
	// 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 types.LanguageCode
	// Indicates the mode in which the classifier will be trained. The classifier can
	// be trained in multi-class mode, which identifies one and only one class for each
	// document, or multi-label mode, which identifies one or more labels for each
	// document. In multi-label mode, multiple labels for an individual document are
	// separated by a delimiter. The default delimiter between labels is a pipe (|).
	Mode types.DocumentClassifierMode
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.DocumentClassifierInputDataConfig
	// 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 *types.VpcConfig
	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string
	// Enables the addition of output results configuration parameters for custom
	// classifier jobs.
	OutputDataConfig *types.DocumentClassifierOutputDataConfig
}

type CreateDocumentClassifierOutput struct {
	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateEndpointInput struct {
	// This is the descriptive suffix that becomes part of the EndpointArn used for all
	// subsequent requests to this resource.
	EndpointName *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 *int32
	// 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
	// The Amazon Resource Number (ARN) of the model to which the endpoint will be
	// attached.
	ModelArn *string
	// Tags associated with the endpoint being created. A tag is a key-value pair that
	// adds metadata to the endpoint. For example, a tag with "Sales" as the key might
	// be added to an endpoint to indicate its use by the sales department.
	Tags []*types.Tag
}

type CreateEndpointOutput struct {
	// The Amazon Resource Number (ARN) of the endpoint being created.
	EndpointArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateEntityRecognizerInput struct {
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// 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 *string
	// 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 *types.EntityRecognizerInputDataConfig
	// Tags to be associated with the entity recognizer being created. A tag is a
	// key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
	// For example, a tag with "Sales" as the key might be added to a resource to
	// indicate its use by the sales department.
	Tags []*types.Tag
	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
	// The language of the input documents. All documents must be in the same language.
	// Only English ("en") is currently supported.
	LanguageCode types.LanguageCode
	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string
	// 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 *types.VpcConfig
}

type CreateEntityRecognizerOutput struct {
	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDocumentClassifierInput struct {
	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string
}

type DeleteDocumentClassifierOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteEndpointInput struct {
	// The Amazon Resource Number (ARN) of the endpoint being deleted.
	EndpointArn *string
}

type DeleteEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteEntityRecognizerInput struct {
	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string
}

type DeleteEntityRecognizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDocumentClassificationJobInput struct {
	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	JobId *string
}

type DescribeDocumentClassificationJobOutput struct {
	// An object that describes the properties associated with the document
	// classification job.
	DocumentClassificationJobProperties *types.DocumentClassificationJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDocumentClassifierInput struct {
	// The Amazon Resource Name (ARN) that identifies the document classifier. The
	// operation returns this identifier in its response.
	DocumentClassifierArn *string
}

type DescribeDocumentClassifierOutput struct {
	// An object that contains the properties associated with a document classifier.
	DocumentClassifierProperties *types.DocumentClassifierProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDominantLanguageDetectionJobInput struct {
	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	JobId *string
}

type DescribeDominantLanguageDetectionJobOutput struct {
	// An object that contains the properties associated with a dominant language
	// detection job.
	DominantLanguageDetectionJobProperties *types.DominantLanguageDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeEndpointInput struct {
	// The Amazon Resource Number (ARN) of the endpoint being described.
	EndpointArn *string
}

type DescribeEndpointOutput struct {
	// Describes information associated with the specific endpoint.
	EndpointProperties *types.EndpointProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeEntitiesDetectionJobInput struct {
	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	JobId *string
}

type DescribeEntitiesDetectionJobOutput struct {
	// An object that contains the properties associated with an entities detection
	// job.
	EntitiesDetectionJobProperties *types.EntitiesDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeEntityRecognizerInput struct {
	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string
}

type DescribeEntityRecognizerOutput struct {
	// Describes information associated with an entity recognizer.
	EntityRecognizerProperties *types.EntityRecognizerProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeKeyPhrasesDetectionJobInput struct {
	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	JobId *string
}

type DescribeKeyPhrasesDetectionJobOutput struct {
	// An object that contains the properties associated with a key phrases detection
	// job.
	KeyPhrasesDetectionJobProperties *types.KeyPhrasesDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeSentimentDetectionJobInput struct {
	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	JobId *string
}

type DescribeSentimentDetectionJobOutput struct {
	// An object that contains the properties associated with a sentiment detection
	// job.
	SentimentDetectionJobProperties *types.SentimentDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeTopicsDetectionJobInput struct {
	// The identifier assigned by the user to the detection job.
	JobId *string
}

type DescribeTopicsDetectionJobOutput struct {
	// The list of properties for the requested job.
	TopicsDetectionJobProperties *types.TopicsDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetectDominantLanguageInput struct {
	// A UTF-8 text string. Each string should contain at least 20 characters and must
	// contain fewer that 5,000 bytes of UTF-8 encoded characters.
	Text *string
}

type DetectDominantLanguageOutput struct {
	// The languages that Amazon Comprehend detected in the input text. For each
	// language, the response returns the RFC 5646 language code and the level of
	// confidence that Amazon Comprehend has in the accuracy of its inference. For more
	// information about RFC 5646, see Tags for Identifying Languages
	// (https://tools.ietf.org/html/rfc5646) on the IETF Tools web site.
	Languages []*types.DominantLanguage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetectEntitiesInput struct {
	// The Amazon Resource Name of an endpoint that is associated with a custom entity
	// recognition model. Provide an endpoint if you want to detect entities by using
	// your own custom model instead of the default model that is used by Amazon
	// Comprehend. If you specify an endpoint, Amazon Comprehend uses the language of
	// your custom model, and it ignores any language code that you provide in your
	// request.
	EndpointArn *string
	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language. If your request includes the endpoint for a custom entity recognition
	// model, Amazon Comprehend uses the language of your custom model, and it ignores
	// any language code that you specify here.
	LanguageCode types.LanguageCode
	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	Text *string
}

type DetectEntitiesOutput struct {
	// A collection of entities identified in the input text. For each entity, the
	// response provides the entity text, entity type, where the entity text begins and
	// ends, and the level of confidence that Amazon Comprehend has in the detection.
	// If your request uses a custom entity recognition model, Amazon Comprehend
	// detects the entities that the model is trained to recognize. Otherwise, it
	// detects the default entity types. For a list of default entity types, see
	// how-entities ().
	Entities []*types.Entity

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetectKeyPhrasesInput struct {
	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	Text *string
	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	LanguageCode types.LanguageCode
}

type DetectKeyPhrasesOutput struct {
	// A collection of key phrases that Amazon Comprehend identified in the input text.
	// For each key phrase, the response provides the text of the key phrase, where the
	// key phrase begins and ends, and the level of confidence that Amazon Comprehend
	// has in the accuracy of the detection.
	KeyPhrases []*types.KeyPhrase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetectSentimentInput struct {
	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	Text *string
	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	LanguageCode types.LanguageCode
}

type DetectSentimentOutput struct {
	// An object that lists the sentiments, and their corresponding confidence levels.
	SentimentScore *types.SentimentScore
	// The inferred sentiment that Amazon Comprehend has the highest level of
	// confidence in.
	Sentiment types.SentimentType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DetectSyntaxInput struct {
	// A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded
	// characters.
	Text *string
	// The language code of the input documents. You can specify any of the following
	// languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish
	// ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
	LanguageCode types.SyntaxLanguageCode
}

type DetectSyntaxOutput struct {
	// A collection of syntax tokens describing the text. For each token, the response
	// provides the text, the token type, where the text begins and ends, and the level
	// of confidence that Amazon Comprehend has that the token is correct. For a list
	// of token types, see how-syntax ().
	SyntaxTokens []*types.SyntaxToken

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

type ListDocumentClassificationJobsInput struct {
	// Filters the jobs that are returned. You can filter jobs on their names, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.DocumentClassificationJobFilter
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
	// Identifies the next page of results to return.
	NextToken *string
}

type ListDocumentClassificationJobsOutput struct {
	// A list containing the properties of each job returned.
	DocumentClassificationJobPropertiesList []*types.DocumentClassificationJobProperties
	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDocumentClassifiersInput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.DocumentClassifierFilter
}

type ListDocumentClassifiersOutput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// A list containing the properties of each job returned.
	DocumentClassifierPropertiesList []*types.DocumentClassifierProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDominantLanguageDetectionJobsInput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// Filters that jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.DominantLanguageDetectionJobFilter
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
}

type ListDominantLanguageDetectionJobsOutput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// A list containing the properties of each job that is returned.
	DominantLanguageDetectionJobPropertiesList []*types.DominantLanguageDetectionJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListEndpointsInput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
	// Filters the endpoints that are returned. You can filter endpoints on their name,
	// model, status, or the date and time that they were created. You can only set one
	// filter at a time.
	Filter *types.EndpointFilter
}

type ListEndpointsOutput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// Displays a list of endpoint properties being retrieved by the service in
	// response to the request.
	EndpointPropertiesList []*types.EndpointProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListEntitiesDetectionJobsInput struct {
	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.EntitiesDetectionJobFilter
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
	// Identifies the next page of results to return.
	NextToken *string
}

type ListEntitiesDetectionJobsOutput struct {
	// A list containing the properties of each job that is returned.
	EntitiesDetectionJobPropertiesList []*types.EntitiesDetectionJobProperties
	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListEntityRecognizersInput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// The maximum number of results to return on each page. The default is 100.
	MaxResults *int32
	// Filters the list of entities returned. You can filter on Status,
	// SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.
	Filter *types.EntityRecognizerFilter
}

type ListEntityRecognizersOutput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// The list of properties of an entity recognizer.
	EntityRecognizerPropertiesList []*types.EntityRecognizerProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListKeyPhrasesDetectionJobsInput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.KeyPhrasesDetectionJobFilter
}

type ListKeyPhrasesDetectionJobsOutput struct {
	// A list containing the properties of each job that is returned.
	KeyPhrasesDetectionJobPropertiesList []*types.KeyPhrasesDetectionJobProperties
	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListSentimentDetectionJobsInput struct {
	// Identifies the next page of results to return.
	NextToken *string
	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter at a
	// time.
	Filter *types.SentimentDetectionJobFilter
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
}

type ListSentimentDetectionJobsOutput struct {
	// A list containing the properties of each job that is returned.
	SentimentDetectionJobPropertiesList []*types.SentimentDetectionJobProperties
	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourceInput struct {
	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are
	// querying.
	ResourceArn *string
}

type ListTagsForResourceOutput struct {
	// Tags associated with the Amazon Comprehend resource being queried. A tag is a
	// key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
	// For example, a tag with "Sales" as the key might be added to a resource to
	// indicate its use by the sales department.
	Tags []*types.Tag
	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are
	// querying.
	ResourceArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTopicsDetectionJobsInput struct {
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
	// Filters the jobs that are returned. Jobs can be filtered on their name, status,
	// or the date and time that they were submitted. You can set only one filter at a
	// time.
	Filter *types.TopicsDetectionJobFilter
	// Identifies the next page of results to return.
	NextToken *string
}

type ListTopicsDetectionJobsOutput struct {
	// A list containing the properties of each job that is returned.
	TopicsDetectionJobPropertiesList []*types.TopicsDetectionJobProperties
	// Identifies the next page of results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions = internalendpoints.Options

type StartDocumentClassificationJobInput struct {
	// The Amazon Resource Name (ARN) of the document classifier to use to process the
	// job.
	DocumentClassifierArn *string
	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// The identifier of the job.
	JobName *string
	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your document classification job. For
	// more information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *types.VpcConfig
	// A unique identifier for the request. If you do not set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
}

type StartDocumentClassificationJobOutput struct {
	// The status of the job:
	//
	//     * SUBMITTED - The job has been received and queued
	// for processing.
	//
	//     * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//
	// * COMPLETED - The job was successfully completed and the output is available.
	//
	//
	// * FAILED - The job did not complete. For details, use the operation.
	//
	//     *
	// STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and
	// is processing the request.
	//
	//     * STOPPED - The job was successfully stopped
	// without completing.
	JobStatus types.JobStatus
	// The identifier generated for the job. To get the status of the job, use this
	// identifier with the operation.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartDominantLanguageDetectionJobInput struct {
	// An identifier for the job.
	JobName *string
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data. For more
	// information, see
	// https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	DataAccessRoleArn *string
	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your dominant language detection job.
	// For more information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *types.VpcConfig
	// A unique identifier for the request. If you do not set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
}

type StartDominantLanguageDetectionJobOutput struct {
	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string
	// The status of the job.
	//
	//     * SUBMITTED - The job has been received and is
	// queued for processing.
	//
	//     * IN_PROGRESS - Amazon Comprehend is processing the
	// job.
	//
	//     * COMPLETED - The job was successfully completed and the output is
	// available.
	//
	//     * FAILED - The job did not complete. To get details, use the
	// operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartEntitiesDetectionJobInput struct {
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// The Amazon Resource Name (ARN) that identifies the specific entity recognizer to
	// be used by the StartEntitiesDetectionJob. This ARN is optional and is only used
	// for a custom entity recognition job.
	EntityRecognizerArn *string
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data. For more
	// information, see
	// https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	DataAccessRoleArn *string
	// The identifier of the job.
	JobName *string
	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your entity detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *types.VpcConfig
	// The language of the input documents. All documents must be in the same language.
	// You can specify any of the languages supported by Amazon Comprehend. If custom
	// entities recognition is used, this parameter is ignored and the language used
	// for training the model is used instead.
	LanguageCode types.LanguageCode
	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
}

type StartEntitiesDetectionJobOutput struct {
	// The identifier generated for the job. To get the status of job, use this
	// identifier with the operation.
	JobId *string
	// The status of the job.
	//
	//     * SUBMITTED - The job has been received and is
	// queued for processing.
	//
	//     * IN_PROGRESS - Amazon Comprehend is processing the
	// job.
	//
	//     * COMPLETED - The job was successfully completed and the output is
	// available.
	//
	//     * FAILED - The job did not complete. To get details, use the
	// operation.
	//
	//     * STOP_REQUESTED - Amazon Comprehend has received a stop request
	// for the job and is processing the request.
	//
	//     * STOPPED - The job was
	// successfully stopped without completing.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartKeyPhrasesDetectionJobInput struct {
	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your key phrases detection job. For
	// more information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *types.VpcConfig
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data. For more
	// information, see
	// https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	DataAccessRoleArn *string
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	LanguageCode types.LanguageCode
	// The identifier of the job.
	JobName *string
}

type StartKeyPhrasesDetectionJobOutput struct {
	// The status of the job.
	//
	//     * SUBMITTED - The job has been received and is
	// queued for processing.
	//
	//     * IN_PROGRESS - Amazon Comprehend is processing the
	// job.
	//
	//     * COMPLETED - The job was successfully completed and the output is
	// available.
	//
	//     * FAILED - The job did not complete. To get details, use the
	// operation.
	JobStatus types.JobStatus
	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartSentimentDetectionJobInput struct {
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data. For more
	// information, see
	// https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	DataAccessRoleArn *string
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your sentiment detection job. For
	// more information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *types.VpcConfig
	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
	// The language of the input documents. You can specify any of the primary
	// languages supported by Amazon Comprehend. All documents must be in the same
	// language.
	LanguageCode types.LanguageCode
	// The identifier of the job.
	JobName *string
}

type StartSentimentDetectionJobOutput struct {
	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string
	// The status of the job.
	//
	//     * SUBMITTED - The job has been received and is
	// queued for processing.
	//
	//     * IN_PROGRESS - Amazon Comprehend is processing the
	// job.
	//
	//     * COMPLETED - The job was successfully completed and the output is
	// available.
	//
	//     * FAILED - The job did not complete. To get details, use the
	// operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartTopicsDetectionJobInput struct {
	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data. For more
	// information, see
	// https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	DataAccessRoleArn *string
	// A unique identifier for the request. If you do not set the client request token,
	// Amazon Comprehend generates one.
	ClientRequestToken *string
	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your topic detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *types.VpcConfig
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// The number of topics to detect.
	NumberOfTopics *int32
	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string
	// Specifies where to send the output files. The output is a compressed archive
	// with two files, topic-terms.csv that lists the terms associated with each topic,
	// and doc-topics.csv that lists the documents associated with each topic
	OutputDataConfig *types.OutputDataConfig
	// The identifier of the job.
	JobName *string
}

type StartTopicsDetectionJobOutput struct {
	// The status of the job:
	//
	//     * SUBMITTED - The job has been received and is
	// queued for processing.
	//
	//     * IN_PROGRESS - Amazon Comprehend is processing the
	// job.
	//
	//     * COMPLETED - The job was successfully completed and the output is
	// available.
	//
	//     * FAILED - The job did not complete. To get details, use the
	// DescribeTopicDetectionJob operation.
	JobStatus types.JobStatus
	// The identifier generated for the job. To get the status of the job, use this
	// identifier with the DescribeTopicDetectionJob operation.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopDominantLanguageDetectionJobInput struct {
	// The identifier of the dominant language detection job to stop.
	JobId *string
}

type StopDominantLanguageDetectionJobOutput struct {
	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopDominantLanguageDetectionJob operation.
	JobStatus types.JobStatus
	// The identifier of the dominant language detection job to stop.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopEntitiesDetectionJobInput struct {
	// The identifier of the entities detection job to stop.
	JobId *string
}

type StopEntitiesDetectionJobOutput struct {
	// The identifier of the entities detection job to stop.
	JobId *string
	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopEntitiesDetectionJob operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopKeyPhrasesDetectionJobInput struct {
	// The identifier of the key phrases detection job to stop.
	JobId *string
}

type StopKeyPhrasesDetectionJobOutput struct {
	// The identifier of the key phrases detection job to stop.
	JobId *string
	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopKeyPhrasesDetectionJob operation.
	JobStatus types.JobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopSentimentDetectionJobInput struct {
	// The identifier of the sentiment detection job to stop.
	JobId *string
}

type StopSentimentDetectionJobOutput struct {
	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
	// previously stopped with the StopSentimentDetectionJob operation.
	JobStatus types.JobStatus
	// The identifier of the sentiment detection job to stop.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopTrainingDocumentClassifierInput struct {
	// The Amazon Resource Name (ARN) that identifies the document classifier currently
	// being trained.
	DocumentClassifierArn *string
}

type StopTrainingDocumentClassifierOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopTrainingEntityRecognizerInput struct {
	// The Amazon Resource Name (ARN) that identifies the entity recognizer currently
	// being trained.
	EntityRecognizerArn *string
}

type StopTrainingEntityRecognizerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput struct {
	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which
	// you want to associate the tags.
	ResourceArn *string
	// Tags being associated with a specific Amazon Comprehend resource. There can be a
	// maximum of 50 tags (both existing and pending) associated with a specific
	// resource.
	Tags []*types.Tag
}

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput struct {
	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from
	// which you want to remove the tags.
	ResourceArn *string
	// The initial part of a key-value pair that forms a tag being removed from a given
	// resource. For example, a tag with "Sales" as the key might be added to a
	// resource to indicate its use by the sales department. Keys must be unique and
	// cannot be duplicated for a particular resource.
	TagKeys []*string
}

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateEndpointInput struct {
	// The Amazon Resource Number (ARN) of the endpoint being updated.
	EndpointArn *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 *int32
}

type UpdateEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}