types

package
v1.19.2 Latest Latest
Warning

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

 Go to latest Published: Oct 24, 2022 License: Apache-2.0 Imports: 4 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AugmentedManifestsDocumentTypeFormat added in v1.7.0 

type AugmentedManifestsDocumentTypeFormat string
const (
	AugmentedManifestsDocumentTypeFormatPlainTextDocument      AugmentedManifestsDocumentTypeFormat = "PLAIN_TEXT_DOCUMENT"
	AugmentedManifestsDocumentTypeFormatSemiStructuredDocument AugmentedManifestsDocumentTypeFormat = "SEMI_STRUCTURED_DOCUMENT"
)

Enum values for AugmentedManifestsDocumentTypeFormat

func (AugmentedManifestsDocumentTypeFormat) Values added in v1.7.0 

func (AugmentedManifestsDocumentTypeFormat) Values() []AugmentedManifestsDocumentTypeFormat

Values returns all known values for AugmentedManifestsDocumentTypeFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AugmentedManifestsListItem added in v0.29.0 

type AugmentedManifestsListItem struct {

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

	// The Amazon S3 location of the augmented manifest file.
	//
	// This member is required.
	S3Uri *string

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

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

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

type BatchDetectDominantLanguageItemResult 

type BatchDetectDominantLanguageItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// One or more DominantLanguage objects describing the dominant languages in the
	// document.
	Languages []DominantLanguage
	// 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.

type BatchDetectEntitiesItemResult 

type BatchDetectEntitiesItemResult struct {

	// One or more Entity objects, one for each entity detected in the document.
	Entities []Entity

	// The zero-based index of the document in the input list.
	Index *int32
	// 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.

type BatchDetectKeyPhrasesItemResult 

type BatchDetectKeyPhrasesItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// One or more KeyPhrase objects, one for each key phrase detected in the document.
	KeyPhrases []KeyPhrase
	// 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.

type BatchDetectSentimentItemResult 

type BatchDetectSentimentItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// The sentiment detected in the document.
	Sentiment SentimentType

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// sentiment detection.
	SentimentScore *SentimentScore
	// 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.

type BatchDetectSyntaxItemResult 

type BatchDetectSyntaxItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// The syntax tokens for the words in the document, one token for each word.
	SyntaxTokens []SyntaxToken
	// contains filtered or unexported fields
}

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

type BatchDetectTargetedSentimentItemResult added in v1.19.0 

type BatchDetectTargetedSentimentItemResult struct {

	// An array of targeted sentiment entities.
	Entities []TargetedSentimentEntity

	// The zero-based index of this result in the input list.
	Index *int32
	// contains filtered or unexported fields
}

Analysis results for one of the documents in the batch.

type BatchItemError 

type BatchItemError struct {

	// The numeric error code of the error.
	ErrorCode *string

	// A text description of the error.
	ErrorMessage *string

	// The zero-based index of the document in the input list.
	Index *int32
	// 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.

type BatchSizeLimitExceededException 

type BatchSizeLimitExceededException struct {
	Message *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) Error 

func (e *BatchSizeLimitExceededException) Error() string

func (*BatchSizeLimitExceededException) ErrorCode 

func (e *BatchSizeLimitExceededException) ErrorCode() string

func (*BatchSizeLimitExceededException) ErrorFault 

func (e *BatchSizeLimitExceededException) ErrorFault() smithy.ErrorFault

func (*BatchSizeLimitExceededException) ErrorMessage 

func (e *BatchSizeLimitExceededException) ErrorMessage() string

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

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

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

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

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

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

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

	// 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
	// contains filtered or unexported fields
}

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

type ClassifierMetadata 

type ClassifierMetadata struct {

	// Describes the result metrics for the test data associated with an documentation
	// classifier.
	EvaluationMetrics *ClassifierEvaluationMetrics

	// The number of labels in the input data.
	NumberOfLabels *int32

	// 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 *int32

	// 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 *int32
	// contains filtered or unexported fields
}

Provides information about a document classifier.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string
	// contains filtered or unexported fields
}

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type DocumentClass 

type DocumentClass struct {

	// The name of the class.
	Name *string

	// The confidence score that Amazon Comprehend has this class correctly attributed.
	Score *float32
	// contains filtered or unexported fields
}

Specifies the class that categorizes the document being analyzed

type DocumentClassificationJobFilter 

type DocumentClassificationJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list based on job status. Returns only jobs with the specified
	// status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

type DocumentClassificationJobProperties 

type DocumentClassificationJobProperties struct {

	// The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string

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

	// The time that the document classification job completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the document
	// classification job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the document classification job. It is a
	// unique, fully qualified identifier for the job. It includes the AWS account,
	// Region, and the job ID. The format of the ARN is as follows:
	// arn::comprehend:::document-classification-job/ The following is an example job
	// ARN:
	// arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the document classification job.
	JobId *string

	// The name that you assigned to the document classification job.
	JobName *string

	// The current status of the document classification job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus JobStatus

	// A description of the status of the job.
	Message *string

	// The output data configuration that you supplied when you created the document
	// classification job.
	OutputDataConfig *OutputDataConfig

	// The time that the document classification job was submitted for processing.
	SubmitTime *time.Time

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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your document classification job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Provides information about a document classification job.

type DocumentClassifierDataFormat added in v0.29.0 

type DocumentClassifierDataFormat string
const (
	DocumentClassifierDataFormatComprehendCsv     DocumentClassifierDataFormat = "COMPREHEND_CSV"
	DocumentClassifierDataFormatAugmentedManifest DocumentClassifierDataFormat = "AUGMENTED_MANIFEST"
)

Enum values for DocumentClassifierDataFormat

func (DocumentClassifierDataFormat) Values added in v0.29.0 

func (DocumentClassifierDataFormat) Values() []DocumentClassifierDataFormat

Values returns all known values for DocumentClassifierDataFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentClassifierFilter 

type DocumentClassifierFilter struct {

	// The name that you assigned to the document classifier
	DocumentClassifierName *string

	// Filters the list of classifiers based on status.
	Status ModelStatus

	// Filters the list of classifiers based on the time that the classifier was
	// submitted for processing. Returns only classifiers submitted after the specified
	// time. Classifiers are returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

	// Filters the list of classifiers based on the time that the classifier was
	// submitted for processing. Returns only classifiers submitted before the
	// specified time. Classifiers are returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time
	// contains filtered or unexported fields
}

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.

type DocumentClassifierInputDataConfig 

type DocumentClassifierInputDataConfig struct {

	// A list of augmented manifest files that provide training data for your custom
	// model. An augmented manifest file is a labeled dataset that is produced by
	// Amazon SageMaker Ground Truth. This parameter is required if you set DataFormat
	// to AUGMENTED_MANIFEST.
	AugmentedManifests []AugmentedManifestsListItem

	// The format of your training data:
	//
	// * COMPREHEND_CSV: A two-column CSV file,
	// where labels are provided in the first column, and documents are provided in the
	// second. If you use this value, you must provide the S3Uri parameter in your
	// request.
	//
	// * AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon
	// SageMaker Ground Truth. This file is in JSON lines format. Each line is a
	// complete JSON object that contains a training document and its associated
	// labels. If you use this value, you must provide the AugmentedManifests parameter
	// in your request.
	//
	// If you don't specify a value, Amazon Comprehend uses
	// COMPREHEND_CSV as the default.
	DataFormat DocumentClassifierDataFormat

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

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

	// This specifies the Amazon S3 location where the test annotations for an entity
	// recognizer are located. The URI must be in the same AWS Region as the API
	// endpoint that you are calling.
	TestS3Uri *string
	// contains filtered or unexported fields
}

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

type DocumentClassifierMode 

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

Enum values for DocumentClassifierMode

func (DocumentClassifierMode) Values added in v0.29.0 

func (DocumentClassifierMode) Values() []DocumentClassifierMode

Values returns all known values for DocumentClassifierMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentClassifierOutputDataConfig 

type DocumentClassifierOutputDataConfig struct {

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt the output results from an analysis job. The KmsKeyId can be one of the
	// following formats:
	//
	// * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// *
	// Amazon Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// *
	// KMS Key Alias: "alias/ExampleAlias"
	//
	// * ARN of a KMS Key Alias:
	// "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	KmsKeyId *string

	// When you use the OutputDataConfig object while creating a custom classifier, you
	// specify the Amazon S3 location where you want to write the confusion matrix. The
	// URI must be in the same region as the API endpoint that you are calling. The
	// location is used as the prefix for the actual location of this output file. When
	// the custom classifier job is finished, the service creates the output file in a
	// directory specific to the job. The S3Uri field contains the location of the
	// output file, called output.tar.gz. It is a compressed archive that contains the
	// confusion matrix.
	S3Uri *string
	// contains filtered or unexported fields
}

Provides output results configuration parameters for custom classifier jobs.

type DocumentClassifierProperties 

type DocumentClassifierProperties struct {

	// Information about the document classifier, including the number of documents
	// used for training the classifier, the number of documents used for test the
	// classifier, and an accuracy rating.
	ClassifierMetadata *ClassifierMetadata

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

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

	// The time that training the document classifier completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the document
	// classifier for training.
	InputDataConfig *DocumentClassifierInputDataConfig

	// The language code for the language of the documents that the classifier was
	// trained on.
	LanguageCode LanguageCode

	// Additional information about the status of the classifier.
	Message *string

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

	// ID for the AWS Key Management Service (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

	// Provides output results configuration parameters for custom classifier jobs.
	OutputDataConfig *DocumentClassifierOutputDataConfig

	// The Amazon Resource Name (ARN) of the source model. This model was imported from
	// a different AWS account to create the document classifier model in your AWS
	// account.
	SourceModelArn *string

	// The status of the document classifier. If the status is TRAINED the classifier
	// is ready to use. If the status is FAILED you can see additional information
	// about why the classifier wasn't trained in the Message field.
	Status ModelStatus

	// The time that the document classifier was submitted for training.
	SubmitTime *time.Time

	// The time that training of the document classifier was completed. Indicates the
	// time when the training completes on documentation classifiers. You are billed
	// for the time interval between this time and the value of TrainingStartTime.
	TrainingEndTime *time.Time

	// Indicates the time when the training starts on documentation classifiers. You
	// are billed for the time interval between this time and the value of
	// TrainingEndTime.
	TrainingStartTime *time.Time

	// The version name that you assigned to the document classifier.
	VersionName *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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your custom classifier. For more information,
	// see Amazon VPC
	// (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Provides information about a document classifier.

type DocumentClassifierSummary added in v1.8.0 

type DocumentClassifierSummary struct {

	// The name that you assigned the document classifier.
	DocumentClassifierName *string

	// The time that the latest document classifier version was submitted for
	// processing.
	LatestVersionCreatedAt *time.Time

	// The version name you assigned to the latest document classifier version.
	LatestVersionName *string

	// Provides the status of the latest document classifier version.
	LatestVersionStatus ModelStatus

	// The number of versions you created.
	NumberOfVersions *int32
	// contains filtered or unexported fields
}

Describes information about a document classifier and its versions.

type DocumentLabel 

type DocumentLabel struct {

	// The name of the label.
	Name *string

	// The confidence score that Amazon Comprehend has this label correctly attributed.
	Score *float32
	// contains filtered or unexported fields
}

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

type DocumentReadAction added in v1.7.0 

type DocumentReadAction string
const (
	DocumentReadActionTextractDetectDocumentText DocumentReadAction = "TEXTRACT_DETECT_DOCUMENT_TEXT"
	DocumentReadActionTextractAnalyzeDocument    DocumentReadAction = "TEXTRACT_ANALYZE_DOCUMENT"
)

Enum values for DocumentReadAction

func (DocumentReadAction) Values added in v1.7.0 

func (DocumentReadAction) Values() []DocumentReadAction

Values returns all known values for DocumentReadAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentReadFeatureTypes added in v1.7.0 

type DocumentReadFeatureTypes string
const (
	DocumentReadFeatureTypesTables DocumentReadFeatureTypes = "TABLES"
	DocumentReadFeatureTypesForms  DocumentReadFeatureTypes = "FORMS"
)

Enum values for DocumentReadFeatureTypes

func (DocumentReadFeatureTypes) Values added in v1.7.0 

func (DocumentReadFeatureTypes) Values() []DocumentReadFeatureTypes

Values returns all known values for DocumentReadFeatureTypes. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentReadMode added in v1.7.0 

type DocumentReadMode string
const (
	DocumentReadModeServiceDefault          DocumentReadMode = "SERVICE_DEFAULT"
	DocumentReadModeForceDocumentReadAction DocumentReadMode = "FORCE_DOCUMENT_READ_ACTION"
)

Enum values for DocumentReadMode

func (DocumentReadMode) Values added in v1.7.0 

func (DocumentReadMode) Values() []DocumentReadMode

Values returns all known values for DocumentReadMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DocumentReaderConfig added in v1.7.0 

type DocumentReaderConfig struct {

	// This enum field will start with two values which will apply to PDFs:
	//
	// *
	// TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF
	// documents per page.
	//
	// * TEXTRACT_ANALYZE_DOCUMENT - The service calls
	// AnalyzeDocument for PDF documents per page.
	//
	// This member is required.
	DocumentReadAction DocumentReadAction

	// This enum field provides two values:
	//
	// * SERVICE_DEFAULT - use service defaults
	// for Document reading. For Digital PDF it would mean using an internal parser
	// instead of Textract APIs
	//
	// * FORCE_DOCUMENT_READ_ACTION - Always use specified
	// action for DocumentReadAction, including Digital PDF.
	DocumentReadMode DocumentReadMode

	// Specifies how the text in an input file should be processed:
	FeatureTypes []DocumentReadFeatureTypes
	// contains filtered or unexported fields
}

The input properties for a topic detection job.

type DominantLanguage 

type DominantLanguage struct {

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

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32
	// contains filtered or unexported fields
}

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

type DominantLanguageDetectionJobFilter 

type DominantLanguageDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type DominantLanguageDetectionJobProperties 

type DominantLanguageDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the dominant language detection job completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the dominant
	// language detection job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the dominant language detection job. It is a
	// unique, fully qualified identifier for the job. It includes the AWS account,
	// Region, and the job ID. The format of the ARN is as follows:
	// arn::comprehend:::dominant-language-detection-job/ The following is an example
	// job ARN:
	// arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the dominant language detection job.
	JobId *string

	// The name that you assigned to the dominant language detection job.
	JobName *string

	// The current status of the dominant language detection job. If the status is
	// FAILED, the Message field shows the reason for the failure.
	JobStatus JobStatus

	// A description for the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the dominant
	// language detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the dominant language detection job was submitted for processing.
	SubmitTime *time.Time

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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your dominant language detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Provides information about a dominant language detection job.

type EndpointFilter 

type EndpointFilter struct {

	// Specifies a date after which the returned endpoint or endpoints were created.
	CreationTimeAfter *time.Time

	// Specifies a date before which the returned endpoint or endpoints were created.
	CreationTimeBefore *time.Time

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

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

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

type EndpointProperties 

type EndpointProperties struct {

	// The creation date and time of the endpoint.
	CreationTime *time.Time

	// The number of inference units currently used by the model using this endpoint.
	CurrentInferenceUnits *int32

	// The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM)
	// role that grants Amazon Comprehend read access to trained custom models
	// encrypted with a customer managed key (ModelKmsKeyId).
	DataAccessRoleArn *string

	// Data access role ARN to use in case the new model is encrypted with a customer
	// KMS key.
	DesiredDataAccessRoleArn *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

	// ARN of the new model to use for updating an existing endpoint. This ARN is going
	// to be different from the model ARN when the update is in progress
	DesiredModelArn *string

	// The Amazon Resource Number (ARN) of the endpoint.
	EndpointArn *string

	// The date and time that the endpoint was last modified.
	LastModifiedTime *time.Time

	// Specifies a reason for failure in cases of Failed status.
	Message *string

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

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

Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).

type EndpointStatus 

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

Enum values for EndpointStatus

func (EndpointStatus) Values added in v0.29.0 

func (EndpointStatus) Values() []EndpointStatus

Values returns all known values for EndpointStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EntitiesDetectionJobFilter 

type EntitiesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type EntitiesDetectionJobProperties 

type EntitiesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the entities detection job completed
	EndTime *time.Time

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

	// The input data configuration that you supplied when you created the entities
	// detection job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the entities detection job. It is a unique,
	// fully qualified identifier for the job. It includes the AWS account, Region, and
	// the job ID. The format of the ARN is as follows:
	// arn::comprehend:::entities-detection-job/ The following is an example job ARN:
	// arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the entities detection job.
	JobId *string

	// The name that you assigned the entities detection job.
	JobName *string

	// The current status of the entities detection job. If the status is FAILED, the
	// Message field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the entities
	// detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the entities detection job was submitted for processing.
	SubmitTime *time.Time

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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your entity detection job. For more information,
	// see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Provides information about an entities detection job.

type Entity 

type Entity struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the entity.
	BeginOffset *int32

	// The zero-based offset from the beginning of the source text to the last
	// character in the entity.
	EndOffset *int32

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32

	// The text of the entity.
	Text *string

	// The entity's type.
	Type EntityType
	// contains filtered or unexported fields
}

Provides information about an entity.

type EntityLabel added in v1.2.0 

type EntityLabel struct {

	// The name of the label.
	Name PiiEntityType

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32
	// contains filtered or unexported fields
}

Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

type EntityRecognizerAnnotations 

type EntityRecognizerAnnotations struct {

	// Specifies the Amazon S3 location where the annotations for an entity recognizer
	// are located. The URI must be in the same region as the API endpoint that you are
	// calling.
	//
	// This member is required.
	S3Uri *string

	// Specifies the Amazon S3 location where the test annotations for an entity
	// recognizer are located. The URI must be in the same region as the API endpoint
	// that you are calling.
	TestS3Uri *string
	// contains filtered or unexported fields
}

Describes the annotations associated with a entity recognizer.

type EntityRecognizerDataFormat added in v0.29.0 

type EntityRecognizerDataFormat string
const (
	EntityRecognizerDataFormatComprehendCsv     EntityRecognizerDataFormat = "COMPREHEND_CSV"
	EntityRecognizerDataFormatAugmentedManifest EntityRecognizerDataFormat = "AUGMENTED_MANIFEST"
)

Enum values for EntityRecognizerDataFormat

func (EntityRecognizerDataFormat) Values added in v0.29.0 

func (EntityRecognizerDataFormat) Values() []EntityRecognizerDataFormat

Values returns all known values for EntityRecognizerDataFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EntityRecognizerDocuments 

type EntityRecognizerDocuments struct {

	// Specifies the Amazon S3 location where the training documents for an entity
	// recognizer are located. The URI must be in the same region as the API endpoint
	// that you are calling.
	//
	// This member is required.
	S3Uri *string

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

	// Specifies the Amazon S3 location where the test documents for an entity
	// recognizer are located. The URI must be in the same AWS Region as the API
	// endpoint that you are calling.
	TestS3Uri *string
	// contains filtered or unexported fields
}

Describes the training documents submitted with an entity recognizer.

type EntityRecognizerEntityList 

type EntityRecognizerEntityList struct {

	// Specifies the Amazon S3 location where the entity list is located. The URI must
	// be in the same region as the API endpoint that you are calling.
	//
	// This member is required.
	S3Uri *string
	// contains filtered or unexported fields
}

Describes the entity recognizer submitted with an entity recognizer.

type EntityRecognizerEvaluationMetrics 

type EntityRecognizerEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for the test data. It is
	// derived from the Precision and Recall values. The F1Score is the harmonic
	// average of the two scores. For plain text entity recognizer models, the range is
	// 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models,
	// the range is 0 to 1, where 1 is the best score.
	F1Score *float64

	// A measure of the usefulness of the recognizer results in the test data. High
	// precision means that the recognizer returned substantially more relevant results
	// than irrelevant ones.
	Precision *float64

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

Detailed information about the accuracy of an entity recognizer.

type EntityRecognizerFilter 

type EntityRecognizerFilter struct {

	// The name that you assigned the entity recognizer.
	RecognizerName *string

	// The status of an entity recognizer.
	Status ModelStatus

	// Filters the list of entities based on the time that the list was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeAfter *time.Time

	// Filters the list of entities based on the time that the list was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeBefore *time.Time
	// contains filtered or unexported fields
}

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>

type EntityRecognizerInputDataConfig 

type EntityRecognizerInputDataConfig struct {

	// The entity types in the labeled training data that Amazon Comprehend uses to
	// train the custom entity recognizer. Any entity types that you don't specify are
	// ignored. A maximum of 25 entity types can be used at one time to train an entity
	// recognizer. Entity types must not contain the following invalid characters: \n
	// (line break), \\n (escaped line break), \r (carriage return), \\r (escaped
	// carriage return), \t (tab), \\t (escaped tab), space, and , (comma).
	//
	// This member is required.
	EntityTypes []EntityTypesListItem

	// The S3 location of the CSV file that annotates your training documents.
	Annotations *EntityRecognizerAnnotations

	// A list of augmented manifest files that provide training data for your custom
	// model. An augmented manifest file is a labeled dataset that is produced by
	// Amazon SageMaker Ground Truth. This parameter is required if you set DataFormat
	// to AUGMENTED_MANIFEST.
	AugmentedManifests []AugmentedManifestsListItem

	// The format of your training data:
	//
	// * COMPREHEND_CSV: A CSV file that supplements
	// your training documents. The CSV file contains information about the custom
	// entities that your trained model will detect. The required format of the file
	// depends on whether you are providing annotations or an entity list. If you use
	// this value, you must provide your CSV file by using either the Annotations or
	// EntityList parameters. You must provide your training documents by using the
	// Documents parameter.
	//
	// * AUGMENTED_MANIFEST: A labeled dataset that is produced
	// by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line
	// is a complete JSON object that contains a training document and its labels. Each
	// label annotates a named entity in the training document. If you use this value,
	// you must provide the AugmentedManifests parameter in your request.
	//
	// If you don't
	// specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.
	DataFormat EntityRecognizerDataFormat

	// The S3 location of the folder that contains the training documents for your
	// custom entity recognizer. This parameter is required if you set DataFormat to
	// COMPREHEND_CSV.
	Documents *EntityRecognizerDocuments

	// The S3 location of the CSV file that has the entity list for your custom entity
	// recognizer.
	EntityList *EntityRecognizerEntityList
	// contains filtered or unexported fields
}

Specifies the format and location of the input data.

type EntityRecognizerMetadata 

type EntityRecognizerMetadata struct {

	// Entity types from the metadata of an entity recognizer.
	EntityTypes []EntityRecognizerMetadataEntityTypesListItem

	// Detailed information about the accuracy of an entity recognizer.
	EvaluationMetrics *EntityRecognizerEvaluationMetrics

	// The number of documents in the input data that were used to test the entity
	// recognizer. Typically this is 10 to 20 percent of the input documents.
	NumberOfTestDocuments *int32

	// The number of documents in the input data that were used to train the entity
	// recognizer. Typically this is 80 to 90 percent of the input documents.
	NumberOfTrainedDocuments *int32
	// contains filtered or unexported fields
}

Detailed information about an entity recognizer.

type EntityRecognizerMetadataEntityTypesListItem 

type EntityRecognizerMetadataEntityTypesListItem struct {

	// Detailed information about the accuracy of the entity recognizer for a specific
	// item on the list of entity types.
	EvaluationMetrics *EntityTypesEvaluationMetrics

	// Indicates the number of times the given entity type was seen in the training
	// data.
	NumberOfTrainMentions *int32

	// Type of entity from the list of entity types in the metadata of an entity
	// recognizer.
	Type *string
	// contains filtered or unexported fields
}

Individual item from the list of entity types in the metadata of an entity recognizer.

type EntityRecognizerProperties 

type EntityRecognizerProperties struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string

	// The time that the recognizer creation completed.
	EndTime *time.Time

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

	// The input data properties of an entity recognizer.
	InputDataConfig *EntityRecognizerInputDataConfig

	// The language of the input documents. All documents must be in the same language.
	// Only English ("en") is currently supported.
	LanguageCode LanguageCode

	// A description of the status of the recognizer.
	Message *string

	// ID for the AWS Key Management Service (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

	// Provides information about an entity recognizer.
	RecognizerMetadata *EntityRecognizerMetadata

	// The Amazon Resource Name (ARN) of the source model. This model was imported from
	// a different AWS account to create the entity recognizer model in your AWS
	// account.
	SourceModelArn *string

	// Provides the status of the entity recognizer.
	Status ModelStatus

	// The time that the recognizer was submitted for processing.
	SubmitTime *time.Time

	// The time that training of the entity recognizer was completed.
	TrainingEndTime *time.Time

	// The time that training of the entity recognizer started.
	TrainingStartTime *time.Time

	// The version name you assigned to the entity recognizer.
	VersionName *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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your custom entity recognizer. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Describes information about an entity recognizer.

type EntityRecognizerSummary added in v1.8.0 

type EntityRecognizerSummary struct {

	// The time that the latest entity recognizer version was submitted for processing.
	LatestVersionCreatedAt *time.Time

	// The version name you assigned to the latest entity recognizer version.
	LatestVersionName *string

	// Provides the status of the latest entity recognizer version.
	LatestVersionStatus ModelStatus

	// The number of versions you created.
	NumberOfVersions *int32

	// The name that you assigned the entity recognizer.
	RecognizerName *string
	// contains filtered or unexported fields
}

Describes the information about an entity recognizer and its versions.

type EntityType 

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

Enum values for EntityType

func (EntityType) Values added in v0.29.0 

func (EntityType) Values() []EntityType

Values returns all known values for EntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EntityTypesEvaluationMetrics 

type EntityTypesEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for a specific entity type
	// in the test data. It is derived from the Precision and Recall values. The
	// F1Score is the harmonic average of the two scores. The highest score is 1, and
	// the worst score is 0.
	F1Score *float64

	// A measure of the usefulness of the recognizer results for a specific entity type
	// in the test data. High precision means that the recognizer returned
	// substantially more relevant results than irrelevant ones.
	Precision *float64

	// A measure of how complete the recognizer results are for a specific entity type
	// in the test data. High recall means that the recognizer returned most of the
	// relevant results.
	Recall *float64
	// contains filtered or unexported fields
}

Detailed information about the accuracy of an entity recognizer for a specific entity type.

type EntityTypesListItem 

type EntityTypesListItem struct {

	// An entity type within a labeled training dataset that Amazon Comprehend uses to
	// train a custom entity recognizer. Entity types must not contain the following
	// invalid characters: \n (line break), \\n (escaped line break, \r (carriage
	// return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), space, and
	// , (comma).
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

type EventsDetectionJobFilter added in v0.31.0 

type EventsDetectionJobFilter struct {

	// Filters on the name of the events detection job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of event detection jobs.

type EventsDetectionJobProperties added in v0.31.0 

type EventsDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM)
	// role that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string

	// The time that the events detection job completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the events
	// detection job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the events detection job. It is a unique,
	// fully qualified identifier for the job. It includes the AWS account, Region, and
	// the job ID. The format of the ARN is as follows:
	// arn::comprehend:::events-detection-job/ The following is an example job ARN:
	// arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the events detection job.
	JobId *string

	// The name you assigned the events detection job.
	JobName *string

	// The current status of the events detection job.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of the events detection job.
	Message *string

	// The output data configuration that you supplied when you created the events
	// detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the events detection job was submitted for processing.
	SubmitTime *time.Time

	// The types of events that are detected by the job.
	TargetEventTypes []string
	// contains filtered or unexported fields
}

Provides information about an events detection job.

type InputDataConfig 

type InputDataConfig struct {

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

	// The document reader config field applies only for InputDataConfig of
	// StartEntitiesDetectionJob. Use DocumentReaderConfig to provide specifications
	// about how you want your inference documents read. Currently it applies for PDF
	// documents in StartEntitiesDetectionJob custom inference.
	DocumentReaderConfig *DocumentReaderConfig

	// Specifies how the text in an input file should be processed:
	//
	// * ONE_DOC_PER_FILE
	// - Each file is considered a separate document. Use this option when you are
	// processing large documents, such as newspaper articles or scientific papers.
	//
	// *
	// ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use
	// this option when you are processing many short documents, such as text messages.
	InputFormat InputFormat
	// contains filtered or unexported fields
}

The input properties for an inference job.

type InputFormat 

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

Enum values for InputFormat

func (InputFormat) Values added in v0.29.0 

func (InputFormat) Values() []InputFormat

Values returns all known values for InputFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string
	// contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvalidFilterException 

type InvalidFilterException struct {
	Message *string
	// contains filtered or unexported fields
}

The filter specified for the operation is invalid. Specify a different filter.

func (*InvalidFilterException) Error 

func (e *InvalidFilterException) Error() string

func (*InvalidFilterException) ErrorCode 

func (e *InvalidFilterException) ErrorCode() string

func (*InvalidFilterException) ErrorFault 

func (e *InvalidFilterException) ErrorFault() smithy.ErrorFault

func (*InvalidFilterException) ErrorMessage 

func (e *InvalidFilterException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string
	// contains filtered or unexported fields
}

The request is invalid.

func (*InvalidRequestException) Error 

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode 

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault 

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage 

func (e *InvalidRequestException) ErrorMessage() string

type JobNotFoundException 

type JobNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*JobNotFoundException) Error 

func (e *JobNotFoundException) Error() string

func (*JobNotFoundException) ErrorCode 

func (e *JobNotFoundException) ErrorCode() string

func (*JobNotFoundException) ErrorFault 

func (e *JobNotFoundException) ErrorFault() smithy.ErrorFault

func (*JobNotFoundException) ErrorMessage 

func (e *JobNotFoundException) ErrorMessage() string

type JobStatus 

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

Enum values for JobStatus

func (JobStatus) Values added in v0.29.0 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type KeyPhrase 

type KeyPhrase struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the key phrase.
	BeginOffset *int32

	// The zero-based offset from the beginning of the source text to the last
	// character in the key phrase.
	EndOffset *int32

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32

	// The text of a key noun phrase.
	Text *string
	// contains filtered or unexported fields
}

Describes a key noun phrase.

type KeyPhrasesDetectionJobFilter 

type KeyPhrasesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type KeyPhrasesDetectionJobProperties 

type KeyPhrasesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the key phrases detection job completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the key phrases
	// detection job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique,
	// fully qualified identifier for the job. It includes the AWS account, Region, and
	// the job ID. The format of the ARN is as follows:
	// arn::comprehend:::key-phrases-detection-job/ The following is an example job
	// ARN:
	// arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the key phrases detection job.
	JobId *string

	// The name that you assigned the key phrases detection job.
	JobName *string

	// The current status of the key phrases detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the key phrases
	// detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the key phrases detection job was submitted for processing.
	SubmitTime *time.Time

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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your key phrases detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Provides information about a key phrases detection job.

type KmsKeyValidationException 

type KmsKeyValidationException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*KmsKeyValidationException) Error 

func (e *KmsKeyValidationException) Error() string

func (*KmsKeyValidationException) ErrorCode 

func (e *KmsKeyValidationException) ErrorCode() string

func (*KmsKeyValidationException) ErrorFault 

func (e *KmsKeyValidationException) ErrorFault() smithy.ErrorFault

func (*KmsKeyValidationException) ErrorMessage 

func (e *KmsKeyValidationException) ErrorMessage() string

type LanguageCode 

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

Enum values for LanguageCode

func (LanguageCode) Values added in v0.29.0 

func (LanguageCode) Values() []LanguageCode

Values returns all known values for LanguageCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MentionSentiment added in v1.19.0 

type MentionSentiment struct {

	// The sentiment of the mention.
	Sentiment SentimentType

	// Describes the level of confidence that Amazon Comprehend has in the accuracy of
	// its detection of sentiments.
	SentimentScore *SentimentScore
	// contains filtered or unexported fields
}

Contains the sentiment and sentiment score for one mention of an entity. For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).

type ModelStatus 

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

Enum values for ModelStatus

func (ModelStatus) Values added in v0.29.0 

func (ModelStatus) Values() []ModelStatus

Values returns all known values for ModelStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OutputDataConfig 

type OutputDataConfig struct {

	// When you use the OutputDataConfig object with asynchronous operations, you
	// specify the Amazon S3 location where you want to write the output data. The URI
	// must be in the same region as the API endpoint that you are calling. The
	// location is used as the prefix for the actual location of the output file. When
	// the topic detection job is finished, the service creates an output file in a
	// directory specific to the job. The S3Uri field contains the location of the
	// output file, called output.tar.gz. It is a compressed archive that contains the
	// ouput of the operation. For a PII entity detection job, the output file is plain
	// text, not a compressed archive. The output file name is the same as the input
	// file, with .out appended at the end.
	//
	// This member is required.
	S3Uri *string

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt the output results from an analysis job. The KmsKeyId can be one of the
	// following formats:
	//
	// * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// *
	// Amazon Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// *
	// KMS Key Alias: "alias/ExampleAlias"
	//
	// * ARN of a KMS Key Alias:
	// "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	KmsKeyId *string
	// contains filtered or unexported fields
}

Provides configuration parameters for the output of inference jobs.

type PartOfSpeechTag 

type PartOfSpeechTag struct {

	// The confidence that Amazon Comprehend has that the part of speech was correctly
	// identified.
	Score *float32

	// Identifies the part of speech that the token represents.
	Tag PartOfSpeechTagType
	// contains filtered or unexported fields
}

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.

type PartOfSpeechTagType 

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

Enum values for PartOfSpeechTagType

func (PartOfSpeechTagType) Values added in v0.29.0 

func (PartOfSpeechTagType) Values() []PartOfSpeechTagType

Values returns all known values for PartOfSpeechTagType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PiiEntitiesDetectionJobFilter added in v0.29.0 

type PiiEntitiesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of PII entity detection jobs.

type PiiEntitiesDetectionJobProperties added in v0.29.0 

type PiiEntitiesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the PII entities detection job completed.
	EndTime *time.Time

	// The input properties for a PII entities detection job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the PII entities detection job. It is a
	// unique, fully qualified identifier for the job. It includes the AWS account,
	// Region, and the job ID. The format of the ARN is as follows:
	// arn::comprehend:::pii-entities-detection-job/ The following is an example job
	// ARN:
	// arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the PII entities detection job.
	JobId *string

	// The name that you assigned the PII entities detection job.
	JobName *string

	// The current status of the PII entities detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// Specifies whether the output provides the locations (offsets) of PII entities or
	// a file in which PII entities are redacted.
	Mode PiiEntitiesDetectionMode

	// The output data configuration that you supplied when you created the PII
	// entities detection job.
	OutputDataConfig *PiiOutputDataConfig

	// Provides configuration parameters for PII entity redaction. This parameter is
	// required if you set the Mode parameter to ONLY_REDACTION. In that case, you must
	// provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
	RedactionConfig *RedactionConfig

	// The time that the PII entities detection job was submitted for processing.
	SubmitTime *time.Time
	// contains filtered or unexported fields
}

Provides information about a PII entities detection job.

type PiiEntitiesDetectionMaskMode added in v0.29.0 

type PiiEntitiesDetectionMaskMode string
const (
	PiiEntitiesDetectionMaskModeMask                     PiiEntitiesDetectionMaskMode = "MASK"
	PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType PiiEntitiesDetectionMaskMode = "REPLACE_WITH_PII_ENTITY_TYPE"
)

Enum values for PiiEntitiesDetectionMaskMode

func (PiiEntitiesDetectionMaskMode) Values added in v0.29.0 

func (PiiEntitiesDetectionMaskMode) Values() []PiiEntitiesDetectionMaskMode

Values returns all known values for PiiEntitiesDetectionMaskMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PiiEntitiesDetectionMode added in v0.29.0 

type PiiEntitiesDetectionMode string
const (
	PiiEntitiesDetectionModeOnlyRedaction PiiEntitiesDetectionMode = "ONLY_REDACTION"
	PiiEntitiesDetectionModeOnlyOffsets   PiiEntitiesDetectionMode = "ONLY_OFFSETS"
)

Enum values for PiiEntitiesDetectionMode

func (PiiEntitiesDetectionMode) Values added in v0.29.0 

func (PiiEntitiesDetectionMode) Values() []PiiEntitiesDetectionMode

Values returns all known values for PiiEntitiesDetectionMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PiiEntity added in v0.29.0 

type PiiEntity struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the entity.
	BeginOffset *int32

	// The zero-based offset from the beginning of the source text to the last
	// character in the entity.
	EndOffset *int32

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32

	// The entity's type.
	Type PiiEntityType
	// contains filtered or unexported fields
}

Provides information about a PII entity.

type PiiEntityType added in v0.29.0 

type PiiEntityType string
const (
	PiiEntityTypeBankAccountNumber                   PiiEntityType = "BANK_ACCOUNT_NUMBER"
	PiiEntityTypeBankRouting                         PiiEntityType = "BANK_ROUTING"
	PiiEntityTypeCreditDebitNumber                   PiiEntityType = "CREDIT_DEBIT_NUMBER"
	PiiEntityTypeCreditDebitCvv                      PiiEntityType = "CREDIT_DEBIT_CVV"
	PiiEntityTypeCreditDebitExpiry                   PiiEntityType = "CREDIT_DEBIT_EXPIRY"
	PiiEntityTypePin                                 PiiEntityType = "PIN"
	PiiEntityTypeEmail                               PiiEntityType = "EMAIL"
	PiiEntityTypeAddress                             PiiEntityType = "ADDRESS"
	PiiEntityTypeName                                PiiEntityType = "NAME"
	PiiEntityTypePhone                               PiiEntityType = "PHONE"
	PiiEntityTypeSsn                                 PiiEntityType = "SSN"
	PiiEntityTypeDateTime                            PiiEntityType = "DATE_TIME"
	PiiEntityTypePassportNumber                      PiiEntityType = "PASSPORT_NUMBER"
	PiiEntityTypeDriverId                            PiiEntityType = "DRIVER_ID"
	PiiEntityTypeUrl                                 PiiEntityType = "URL"
	PiiEntityTypeAge                                 PiiEntityType = "AGE"
	PiiEntityTypeUsername                            PiiEntityType = "USERNAME"
	PiiEntityTypePassword                            PiiEntityType = "PASSWORD"
	PiiEntityTypeAwsAccessKey                        PiiEntityType = "AWS_ACCESS_KEY"
	PiiEntityTypeAwsSecretKey                        PiiEntityType = "AWS_SECRET_KEY"
	PiiEntityTypeIpAddress                           PiiEntityType = "IP_ADDRESS"
	PiiEntityTypeMacAddress                          PiiEntityType = "MAC_ADDRESS"
	PiiEntityTypeAll                                 PiiEntityType = "ALL"
	PiiEntityTypeLicensePlate                        PiiEntityType = "LICENSE_PLATE"
	PiiEntityTypeVehicleIdentificationNumber         PiiEntityType = "VEHICLE_IDENTIFICATION_NUMBER"
	PiiEntityTypeUkNationalInsuranceNumber           PiiEntityType = "UK_NATIONAL_INSURANCE_NUMBER"
	PiiEntityTypeCaSocialInsuranceNumber             PiiEntityType = "CA_SOCIAL_INSURANCE_NUMBER"
	PiiEntityTypeUsIndividualTaxIdentificationNumber PiiEntityType = "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
	PiiEntityTypeUkUniqueTaxpayerReferenceNumber     PiiEntityType = "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
	PiiEntityTypeInPermanentAccountNumber            PiiEntityType = "IN_PERMANENT_ACCOUNT_NUMBER"
	PiiEntityTypeInNrega                             PiiEntityType = "IN_NREGA"
	PiiEntityTypeInternationalBankAccountNumber      PiiEntityType = "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
	PiiEntityTypeSwiftCode                           PiiEntityType = "SWIFT_CODE"
	PiiEntityTypeUkNationalHealthServiceNumber       PiiEntityType = "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
	PiiEntityTypeCaHealthNumber                      PiiEntityType = "CA_HEALTH_NUMBER"
	PiiEntityTypeInAadhaar                           PiiEntityType = "IN_AADHAAR"
	PiiEntityTypeInVoterNumber                       PiiEntityType = "IN_VOTER_NUMBER"
)

Enum values for PiiEntityType

func (PiiEntityType) Values added in v0.29.0 

func (PiiEntityType) Values() []PiiEntityType

Values returns all known values for PiiEntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PiiOutputDataConfig added in v0.29.0 

type PiiOutputDataConfig struct {

	// When you use the PiiOutputDataConfig object with asynchronous operations, you
	// specify the Amazon S3 location where you want to write the output data. For a
	// PII entity detection job, the output file is plain text, not a compressed
	// archive. The output file name is the same as the input file, with .out appended
	// at the end.
	//
	// This member is required.
	S3Uri *string

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt the output results from an analysis job.
	KmsKeyId *string
	// contains filtered or unexported fields
}

Provides configuration parameters for the output of PII entity detection jobs.

type RedactionConfig added in v0.29.0 

type RedactionConfig struct {

	// A character that replaces each character in the redacted PII entity.
	MaskCharacter *string

	// Specifies whether the PII entity is redacted with the mask character or the
	// entity type.
	MaskMode PiiEntitiesDetectionMaskMode

	// An array of the types of PII entities that Amazon Comprehend detects in the
	// input text for your request.
	PiiEntityTypes []PiiEntityType
	// contains filtered or unexported fields
}

Provides configuration parameters for PII entity redaction.

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceLimitExceededException 

type ResourceLimitExceededException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*ResourceLimitExceededException) Error 

func (e *ResourceLimitExceededException) Error() string

func (*ResourceLimitExceededException) ErrorCode 

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault 

func (e *ResourceLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ResourceLimitExceededException) ErrorMessage 

func (e *ResourceLimitExceededException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceUnavailableException 

type ResourceUnavailableException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*ResourceUnavailableException) Error 

func (e *ResourceUnavailableException) Error() string

func (*ResourceUnavailableException) ErrorCode 

func (e *ResourceUnavailableException) ErrorCode() string

func (*ResourceUnavailableException) ErrorFault 

func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ResourceUnavailableException) ErrorMessage 

func (e *ResourceUnavailableException) ErrorMessage() string

type SentimentDetectionJobFilter 

type SentimentDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type SentimentDetectionJobProperties 

type SentimentDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the sentiment detection job ended.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the sentiment
	// detection job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique,
	// fully qualified identifier for the job. It includes the AWS account, Region, and
	// the job ID. The format of the ARN is as follows:
	// arn::comprehend:::sentiment-detection-job/ The following is an example job ARN:
	// arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the sentiment detection job.
	JobId *string

	// The name that you assigned to the sentiment detection job
	JobName *string

	// The current status of the sentiment detection job. If the status is FAILED, the
	// Messages field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the sentiment
	// detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the sentiment detection job was submitted for processing.
	SubmitTime *time.Time

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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your sentiment detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Provides information about a sentiment detection job.

type SentimentScore 

type SentimentScore struct {

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the MIXED sentiment.
	Mixed *float32

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEGATIVE sentiment.
	Negative *float32

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEUTRAL sentiment.
	Neutral *float32

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the POSITIVE sentiment.
	Positive *float32
	// contains filtered or unexported fields
}

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

type SentimentType 

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

Enum values for SentimentType

func (SentimentType) Values added in v0.29.0 

func (SentimentType) Values() []SentimentType

Values returns all known values for SentimentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Split added in v1.8.0 

type Split string
const (
	SplitTrain Split = "TRAIN"
	SplitTest  Split = "TEST"
)

Enum values for Split

func (Split) Values added in v1.8.0 

func (Split) Values() []Split

Values returns all known values for Split. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SyntaxLanguageCode 

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

Enum values for SyntaxLanguageCode

func (SyntaxLanguageCode) Values added in v0.29.0 

func (SyntaxLanguageCode) Values() []SyntaxLanguageCode

Values returns all known values for SyntaxLanguageCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SyntaxToken 

type SyntaxToken struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the word.
	BeginOffset *int32

	// The zero-based offset from the beginning of the source text to the last
	// character in the word.
	EndOffset *int32

	// Provides the part of speech label and the confidence level that Amazon
	// Comprehend has that the part of speech was correctly identified. For more
	// information, see Syntax
	// (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the
	// Comprehend Developer Guide.
	PartOfSpeech *PartOfSpeechTag

	// The word that was recognized in the source text.
	Text *string

	// A unique identifier for a token.
	TokenId *int32
	// contains filtered or unexported fields
}

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

type Tag 

type Tag struct {

	// The initial part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the key portion of the pair, with
	// multiple possible values such as “sales,” “legal,” and “administration.”
	//
	// This member is required.
	Key *string

	// The second part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the initial (key) portion of the
	// pair, with a value of “sales” to indicate the sales department.
	Value *string
	// contains filtered or unexported fields
}

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

type TargetedSentimentDetectionJobFilter added in v1.17.0 

type TargetedSentimentDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type TargetedSentimentDetectionJobProperties added in v1.17.0 

type TargetedSentimentDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the targeted sentiment detection job ended.
	EndTime *time.Time

	// The input properties for an inference job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a
	// unique, fully qualified identifier for the job. It includes the AWS account,
	// Region, and the job ID. The format of the ARN is as follows:
	// arn::comprehend:::targeted-sentiment-detection-job/ The following is an example
	// job ARN:
	// arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the targeted sentiment detection job.
	JobId *string

	// The name that you assigned to the targeted sentiment detection job.
	JobName *string

	// The current status of the targeted sentiment detection job. If the status is
	// FAILED, the Messages field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// Provides configuration parameters for the output of inference jobs.
	OutputDataConfig *OutputDataConfig

	// The time that the targeted sentiment detection job was submitted for processing.
	SubmitTime *time.Time

	// 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 targeted sentiment detection 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

	// 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
	// contains filtered or unexported fields
}

Provides information about a targeted sentiment detection job.

type TargetedSentimentEntity added in v1.19.0 

type TargetedSentimentEntity struct {

	// One or more index into the Mentions array that provides the best name for the
	// entity group.
	DescriptiveMentionIndex []int32

	// An array of mentions of the entity in the document. The array represents a
	// co-reference group. See  Co-reference group
	// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values)
	// for an example.
	Mentions []TargetedSentimentMention
	// contains filtered or unexported fields
}

Information about one of the entities found by targeted sentiment analysis. For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).

type TargetedSentimentEntityType added in v1.19.0 

type TargetedSentimentEntityType string
const (
	TargetedSentimentEntityTypePerson         TargetedSentimentEntityType = "PERSON"
	TargetedSentimentEntityTypeLocation       TargetedSentimentEntityType = "LOCATION"
	TargetedSentimentEntityTypeOrganization   TargetedSentimentEntityType = "ORGANIZATION"
	TargetedSentimentEntityTypeFacility       TargetedSentimentEntityType = "FACILITY"
	TargetedSentimentEntityTypeBrand          TargetedSentimentEntityType = "BRAND"
	TargetedSentimentEntityTypeCommercialItem TargetedSentimentEntityType = "COMMERCIAL_ITEM"
	TargetedSentimentEntityTypeMovie          TargetedSentimentEntityType = "MOVIE"
	TargetedSentimentEntityTypeMusic          TargetedSentimentEntityType = "MUSIC"
	TargetedSentimentEntityTypeBook           TargetedSentimentEntityType = "BOOK"
	TargetedSentimentEntityTypeSoftware       TargetedSentimentEntityType = "SOFTWARE"
	TargetedSentimentEntityTypeGame           TargetedSentimentEntityType = "GAME"
	TargetedSentimentEntityTypePersonalTitle  TargetedSentimentEntityType = "PERSONAL_TITLE"
	TargetedSentimentEntityTypeEvent          TargetedSentimentEntityType = "EVENT"
	TargetedSentimentEntityTypeDate           TargetedSentimentEntityType = "DATE"
	TargetedSentimentEntityTypeQuantity       TargetedSentimentEntityType = "QUANTITY"
	TargetedSentimentEntityTypeAttribute      TargetedSentimentEntityType = "ATTRIBUTE"
	TargetedSentimentEntityTypeOther          TargetedSentimentEntityType = "OTHER"
)

Enum values for TargetedSentimentEntityType

func (TargetedSentimentEntityType) Values added in v1.19.0 

func (TargetedSentimentEntityType) Values() []TargetedSentimentEntityType

Values returns all known values for TargetedSentimentEntityType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TargetedSentimentMention added in v1.19.0 

type TargetedSentimentMention struct {

	// The offset into the document text where the mention begins.
	BeginOffset *int32

	// The offset into the document text where the mention ends.
	EndOffset *int32

	// The confidence that all the entities mentioned in the group relate to the same
	// entity.
	GroupScore *float32

	// Contains the sentiment and sentiment score for the mention.
	MentionSentiment *MentionSentiment

	// Model confidence that the entity is relevant. Value range is zero to one, where
	// one is highest confidence.
	Score *float32

	// The text in the document that identifies the entity.
	Text *string

	// The type of the entity. Amazon Comprehend supports a variety of entity types
	// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities).
	Type TargetedSentimentEntityType
	// contains filtered or unexported fields
}

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention. For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).

type TextSizeLimitExceededException 

type TextSizeLimitExceededException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*TextSizeLimitExceededException) Error 

func (e *TextSizeLimitExceededException) Error() string

func (*TextSizeLimitExceededException) ErrorCode 

func (e *TextSizeLimitExceededException) ErrorCode() string

func (*TextSizeLimitExceededException) ErrorFault 

func (e *TextSizeLimitExceededException) ErrorFault() smithy.ErrorFault

func (*TextSizeLimitExceededException) ErrorMessage 

func (e *TextSizeLimitExceededException) ErrorMessage() string

type TooManyRequestsException 

type TooManyRequestsException struct {
	Message *string
	// contains filtered or unexported fields
}

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

func (*TooManyRequestsException) Error 

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode 

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault 

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage 

func (e *TooManyRequestsException) ErrorMessage() string

type TooManyTagKeysException 

type TooManyTagKeysException struct {
	Message *string
	// contains filtered or unexported fields
}

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

func (*TooManyTagKeysException) Error 

func (e *TooManyTagKeysException) Error() string

func (*TooManyTagKeysException) ErrorCode 

func (e *TooManyTagKeysException) ErrorCode() string

func (*TooManyTagKeysException) ErrorFault 

func (e *TooManyTagKeysException) ErrorFault() smithy.ErrorFault

func (*TooManyTagKeysException) ErrorMessage 

func (e *TooManyTagKeysException) ErrorMessage() string

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string
	// contains filtered or unexported fields
}

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.

func (*TooManyTagsException) Error 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault 

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage 

func (e *TooManyTagsException) ErrorMessage() string

type TopicsDetectionJobFilter 

type TopicsDetectionJobFilter struct {

	//
	JobName *string

	// Filters the list of topic detection jobs based on job status. Returns only jobs
	// with the specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Only returns jobs submitted after the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeAfter *time.Time

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

Provides information for filtering topic detection jobs. For more information, see .

type TopicsDetectionJobProperties 

type TopicsDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your job data.
	DataAccessRoleArn *string

	// The time that the topic detection job was completed.
	EndTime *time.Time

	// The input data configuration supplied when you created the topic detection job.
	InputDataConfig *InputDataConfig

	// The Amazon Resource Name (ARN) of the topics detection job. It is a unique,
	// fully qualified identifier for the job. It includes the AWS account, Region, and
	// the job ID. The format of the ARN is as follows:
	// arn::comprehend:::topics-detection-job/ The following is an example job ARN:
	// arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string

	// The identifier assigned to the topic detection job.
	JobId *string

	// The name of the topic detection job.
	JobName *string

	// The current status of the topic detection job. If the status is Failed, the
	// reason for the failure is shown in the Message field.
	JobStatus JobStatus

	// A description for the status of a job.
	Message *string

	// The number of topics to detect supplied when you created the topic detection
	// job. The default is 10.
	NumberOfTopics *int32

	// The output data configuration supplied when you created the topic detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the topic detection job was submitted for processing.
	SubmitTime *time.Time

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

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your topic detection job. For more information,
	// see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
	// contains filtered or unexported fields
}

Provides information about a topic detection job.

type UnsupportedLanguageException 

type UnsupportedLanguageException struct {
	Message *string
	// contains filtered or unexported fields
}

Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

func (*UnsupportedLanguageException) Error 

func (e *UnsupportedLanguageException) Error() string

func (*UnsupportedLanguageException) ErrorCode 

func (e *UnsupportedLanguageException) ErrorCode() string

func (*UnsupportedLanguageException) ErrorFault 

func (e *UnsupportedLanguageException) ErrorFault() smithy.ErrorFault

func (*UnsupportedLanguageException) ErrorMessage 

func (e *UnsupportedLanguageException) ErrorMessage() string

type VpcConfig 

type VpcConfig struct {

	// The ID number for a security group on an instance of your private VPC. Security
	// groups on your VPC function serve as a virtual firewall to control inbound and
	// outbound traffic and provides security for the resources that you’ll be
	// accessing on the VPC. This ID number is preceded by "sg-", for instance:
	// "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html).
	//
	// This member is required.
	SecurityGroupIds []string

	// The ID for each subnet being used in your private VPC. This subnet is a subset
	// of the a range of IPv4 addresses used by the VPC and is specific to a given
	// availability zone in the VPC’s region. This ID number is preceded by "subnet-",
	// for instance: "subnet-04ccf456919e69055". For more information, see VPCs and
	// Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html).
	//
	// This member is required.
	Subnets []string
	// contains filtered or unexported fields
}

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.