func AugmentedManifestsDocumentTypeFormat_Values() []string
AugmentedManifestsDocumentTypeFormat_Values returns all elements of the AugmentedManifestsDocumentTypeFormat enum
func BlockType_Values() []string
BlockType_Values returns all elements of the BlockType enum
func DocumentClassifierDataFormat_Values() []string
DocumentClassifierDataFormat_Values returns all elements of the DocumentClassifierDataFormat enum
func DocumentClassifierMode_Values() []string
DocumentClassifierMode_Values returns all elements of the DocumentClassifierMode enum
func DocumentReadAction_Values() []string
DocumentReadAction_Values returns all elements of the DocumentReadAction enum
func DocumentReadFeatureTypes_Values() []string
DocumentReadFeatureTypes_Values returns all elements of the DocumentReadFeatureTypes enum
func DocumentReadMode_Values() []string
DocumentReadMode_Values returns all elements of the DocumentReadMode enum
func DocumentType_Values() []string
DocumentType_Values returns all elements of the DocumentType enum
func EndpointStatus_Values() []string
EndpointStatus_Values returns all elements of the EndpointStatus enum
func EntityRecognizerDataFormat_Values() []string
EntityRecognizerDataFormat_Values returns all elements of the EntityRecognizerDataFormat enum
func EntityType_Values() []string
EntityType_Values returns all elements of the EntityType enum
func InputFormat_Values() []string
InputFormat_Values returns all elements of the InputFormat enum
func InvalidRequestDetailReason_Values() []string
InvalidRequestDetailReason_Values returns all elements of the InvalidRequestDetailReason enum
func InvalidRequestReason_Values() []string
InvalidRequestReason_Values returns all elements of the InvalidRequestReason enum
func JobStatus_Values() []string
JobStatus_Values returns all elements of the JobStatus enum
func LanguageCode_Values() []string
LanguageCode_Values returns all elements of the LanguageCode enum
func ModelStatus_Values() []string
ModelStatus_Values returns all elements of the ModelStatus enum
func PageBasedErrorCode_Values() []string
PageBasedErrorCode_Values returns all elements of the PageBasedErrorCode enum
func PartOfSpeechTagType_Values() []string
PartOfSpeechTagType_Values returns all elements of the PartOfSpeechTagType enum
func PiiEntitiesDetectionMaskMode_Values() []string
PiiEntitiesDetectionMaskMode_Values returns all elements of the PiiEntitiesDetectionMaskMode enum
func PiiEntitiesDetectionMode_Values() []string
PiiEntitiesDetectionMode_Values returns all elements of the PiiEntitiesDetectionMode enum
func PiiEntityType_Values() []string
PiiEntityType_Values returns all elements of the PiiEntityType enum
func RelationshipType_Values() []string
RelationshipType_Values returns all elements of the RelationshipType enum
func SentimentType_Values() []string
SentimentType_Values returns all elements of the SentimentType enum
func Split_Values() []string
Split_Values returns all elements of the Split enum
func SyntaxLanguageCode_Values() []string
SyntaxLanguageCode_Values returns all elements of the SyntaxLanguageCode enum
func TargetedSentimentEntityType_Values() []string
TargetedSentimentEntityType_Values returns all elements of the TargetedSentimentEntityType enum
type AugmentedManifestsListItem struct { // The S3 prefix to the annotation files that are referred in the augmented // manifest file. AnnotationDataS3Uri *string `type:"string"` // The JSON attribute that contains the annotations for your training documents. // The number of attribute names that you specify depends on whether your augmented // manifest file is the output of a single labeling job or a chained labeling // job. // // If your file is the output of a single labeling job, specify the LabelAttributeName // key that was used when the job was created in Ground Truth. // // If your file is the output of a chained labeling job, specify the LabelAttributeName // key for one or more jobs in the chain. Each LabelAttributeName key provides // the annotations from an individual job. // // AttributeNames is a required field AttributeNames []*string `type:"list" required:"true"` // The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. // If you don't specify, the default is PlainTextDocument. // // * PLAIN_TEXT_DOCUMENT A document type that represents any unicode text // that is encoded in UTF-8. // // * SEMI_STRUCTURED_DOCUMENT A document type with positional and structural // context, like a PDF. For training with Amazon Comprehend, only PDFs are // supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT. DocumentType *string `type:"string" enum:"AugmentedManifestsDocumentTypeFormat"` // The Amazon S3 location of the augmented manifest file. // // S3Uri is a required field S3Uri *string `type:"string" required:"true"` // The S3 prefix to the source files (PDFs) that are referred to in the augmented // manifest file. SourceDocumentsS3Uri *string `type:"string"` // The purpose of the data you've provided in the augmented manifest. You can // either train or test this data. If you don't specify, the default is train. // // TRAIN - all of the documents in the manifest will be used for training. If // no test documents are provided, Amazon Comprehend will automatically reserve // a portion of the training documents for testing. // // TEST - all of the documents in the manifest will be used for testing. Split *string `type:"string" enum:"Split"` // contains filtered or unexported fields }
An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
func (s AugmentedManifestsListItem) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AugmentedManifestsListItem) SetAnnotationDataS3Uri(v string) *AugmentedManifestsListItem
SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value.
func (s *AugmentedManifestsListItem) SetAttributeNames(v []*string) *AugmentedManifestsListItem
SetAttributeNames sets the AttributeNames field's value.
func (s *AugmentedManifestsListItem) SetDocumentType(v string) *AugmentedManifestsListItem
SetDocumentType sets the DocumentType field's value.
func (s *AugmentedManifestsListItem) SetS3Uri(v string) *AugmentedManifestsListItem
SetS3Uri sets the S3Uri field's value.
func (s *AugmentedManifestsListItem) SetSourceDocumentsS3Uri(v string) *AugmentedManifestsListItem
SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value.
func (s *AugmentedManifestsListItem) SetSplit(v string) *AugmentedManifestsListItem
SetSplit sets the Split field's value.
func (s AugmentedManifestsListItem) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AugmentedManifestsListItem) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDetectDominantLanguageInput struct { // A list containing the UTF-8 encoded text of the input documents. The list // can contain a maximum of 25 documents. Each document should contain at least // 20 characters. The maximum size of each document is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectDominantLanguageInput's // String and GoString methods. // // TextList is a required field TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s BatchDetectDominantLanguageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectDominantLanguageInput) SetTextList(v []*string) *BatchDetectDominantLanguageInput
SetTextList sets the TextList field's value.
func (s BatchDetectDominantLanguageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectDominantLanguageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDetectDominantLanguageItemResult struct { // The zero-based index of the document in the input list. Index *int64 `type:"integer"` // One or more DominantLanguage objects describing the dominant languages in // the document. Languages []*DominantLanguage `type:"list"` // contains filtered or unexported fields }
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
func (s BatchDetectDominantLanguageItemResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectDominantLanguageItemResult) SetIndex(v int64) *BatchDetectDominantLanguageItemResult
SetIndex sets the Index field's value.
func (s *BatchDetectDominantLanguageItemResult) SetLanguages(v []*DominantLanguage) *BatchDetectDominantLanguageItemResult
SetLanguages sets the Languages field's value.
func (s BatchDetectDominantLanguageItemResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectDominantLanguageOutput struct { // A list containing one object for each document that contained an error. The // results are sorted in ascending order by the Index field and match the order // of the documents in the input list. If there are no errors in the batch, // the ErrorList is empty. // // ErrorList is a required field ErrorList []*BatchItemError `type:"list" required:"true"` // A list of objects containing the results of the operation. The results are // sorted in ascending order by the Index field and match the order of the documents // in the input list. If all of the documents contain an error, the ResultList // is empty. // // ResultList is a required field ResultList []*BatchDetectDominantLanguageItemResult `type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchDetectDominantLanguageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectDominantLanguageOutput) SetErrorList(v []*BatchItemError) *BatchDetectDominantLanguageOutput
SetErrorList sets the ErrorList field's value.
func (s *BatchDetectDominantLanguageOutput) SetResultList(v []*BatchDetectDominantLanguageItemResult) *BatchDetectDominantLanguageOutput
SetResultList sets the ResultList field's value.
func (s BatchDetectDominantLanguageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectEntitiesInput struct { // The language of the input documents. You can specify any of the primary languages // supported by Amazon Comprehend. All documents must be in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A list containing the UTF-8 encoded text of the input documents. The list // can contain a maximum of 25 documents. The maximum size of each document // is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectEntitiesInput's // String and GoString methods. // // TextList is a required field TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s BatchDetectEntitiesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectEntitiesInput) SetLanguageCode(v string) *BatchDetectEntitiesInput
SetLanguageCode sets the LanguageCode field's value.
func (s *BatchDetectEntitiesInput) SetTextList(v []*string) *BatchDetectEntitiesInput
SetTextList sets the TextList field's value.
func (s BatchDetectEntitiesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectEntitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDetectEntitiesItemResult struct { // One or more Entity objects, one for each entity detected in the document. Entities []*Entity `type:"list"` // The zero-based index of the document in the input list. Index *int64 `type:"integer"` // contains filtered or unexported fields }
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
func (s BatchDetectEntitiesItemResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectEntitiesItemResult) SetEntities(v []*Entity) *BatchDetectEntitiesItemResult
SetEntities sets the Entities field's value.
func (s *BatchDetectEntitiesItemResult) SetIndex(v int64) *BatchDetectEntitiesItemResult
SetIndex sets the Index field's value.
func (s BatchDetectEntitiesItemResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectEntitiesOutput struct { // A list containing one object for each document that contained an error. The // results are sorted in ascending order by the Index field and match the order // of the documents in the input list. If there are no errors in the batch, // the ErrorList is empty. // // ErrorList is a required field ErrorList []*BatchItemError `type:"list" required:"true"` // A list of objects containing the results of the operation. The results are // sorted in ascending order by the Index field and match the order of the documents // in the input list. If all of the documents contain an error, the ResultList // is empty. // // ResultList is a required field ResultList []*BatchDetectEntitiesItemResult `type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchDetectEntitiesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectEntitiesOutput) SetErrorList(v []*BatchItemError) *BatchDetectEntitiesOutput
SetErrorList sets the ErrorList field's value.
func (s *BatchDetectEntitiesOutput) SetResultList(v []*BatchDetectEntitiesItemResult) *BatchDetectEntitiesOutput
SetResultList sets the ResultList field's value.
func (s BatchDetectEntitiesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectKeyPhrasesInput struct { // The language of the input documents. You can specify any of the primary languages // supported by Amazon Comprehend. All documents must be in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A list containing the UTF-8 encoded text of the input documents. The list // can contain a maximum of 25 documents. The maximum size of each document // is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectKeyPhrasesInput's // String and GoString methods. // // TextList is a required field TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s BatchDetectKeyPhrasesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectKeyPhrasesInput) SetLanguageCode(v string) *BatchDetectKeyPhrasesInput
SetLanguageCode sets the LanguageCode field's value.
func (s *BatchDetectKeyPhrasesInput) SetTextList(v []*string) *BatchDetectKeyPhrasesInput
SetTextList sets the TextList field's value.
func (s BatchDetectKeyPhrasesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectKeyPhrasesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDetectKeyPhrasesItemResult struct { // The zero-based index of the document in the input list. Index *int64 `type:"integer"` // One or more KeyPhrase objects, one for each key phrase detected in the document. KeyPhrases []*KeyPhrase `type:"list"` // contains filtered or unexported fields }
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
func (s BatchDetectKeyPhrasesItemResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectKeyPhrasesItemResult) SetIndex(v int64) *BatchDetectKeyPhrasesItemResult
SetIndex sets the Index field's value.
func (s *BatchDetectKeyPhrasesItemResult) SetKeyPhrases(v []*KeyPhrase) *BatchDetectKeyPhrasesItemResult
SetKeyPhrases sets the KeyPhrases field's value.
func (s BatchDetectKeyPhrasesItemResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectKeyPhrasesOutput struct { // A list containing one object for each document that contained an error. The // results are sorted in ascending order by the Index field and match the order // of the documents in the input list. If there are no errors in the batch, // the ErrorList is empty. // // ErrorList is a required field ErrorList []*BatchItemError `type:"list" required:"true"` // A list of objects containing the results of the operation. The results are // sorted in ascending order by the Index field and match the order of the documents // in the input list. If all of the documents contain an error, the ResultList // is empty. // // ResultList is a required field ResultList []*BatchDetectKeyPhrasesItemResult `type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchDetectKeyPhrasesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectKeyPhrasesOutput) SetErrorList(v []*BatchItemError) *BatchDetectKeyPhrasesOutput
SetErrorList sets the ErrorList field's value.
func (s *BatchDetectKeyPhrasesOutput) SetResultList(v []*BatchDetectKeyPhrasesItemResult) *BatchDetectKeyPhrasesOutput
SetResultList sets the ResultList field's value.
func (s BatchDetectKeyPhrasesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectSentimentInput struct { // The language of the input documents. You can specify any of the primary languages // supported by Amazon Comprehend. All documents must be in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A list containing the UTF-8 encoded text of the input documents. The list // can contain a maximum of 25 documents. The maximum size of each document // is 5 KB. // // Amazon Comprehend performs real-time sentiment analysis on the first 500 // characters of the input text and ignores any additional text in the input. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectSentimentInput's // String and GoString methods. // // TextList is a required field TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s BatchDetectSentimentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSentimentInput) SetLanguageCode(v string) *BatchDetectSentimentInput
SetLanguageCode sets the LanguageCode field's value.
func (s *BatchDetectSentimentInput) SetTextList(v []*string) *BatchDetectSentimentInput
SetTextList sets the TextList field's value.
func (s BatchDetectSentimentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSentimentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDetectSentimentItemResult struct { // The zero-based index of the document in the input list. Index *int64 `type:"integer"` // The sentiment detected in the document. Sentiment *string `type:"string" enum:"SentimentType"` // The level of confidence that Amazon Comprehend has in the accuracy of its // sentiment detection. SentimentScore *SentimentScore `type:"structure"` // contains filtered or unexported fields }
The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.
func (s BatchDetectSentimentItemResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSentimentItemResult) SetIndex(v int64) *BatchDetectSentimentItemResult
SetIndex sets the Index field's value.
func (s *BatchDetectSentimentItemResult) SetSentiment(v string) *BatchDetectSentimentItemResult
SetSentiment sets the Sentiment field's value.
func (s *BatchDetectSentimentItemResult) SetSentimentScore(v *SentimentScore) *BatchDetectSentimentItemResult
SetSentimentScore sets the SentimentScore field's value.
func (s BatchDetectSentimentItemResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectSentimentOutput struct { // A list containing one object for each document that contained an error. The // results are sorted in ascending order by the Index field and match the order // of the documents in the input list. If there are no errors in the batch, // the ErrorList is empty. // // ErrorList is a required field ErrorList []*BatchItemError `type:"list" required:"true"` // A list of objects containing the results of the operation. The results are // sorted in ascending order by the Index field and match the order of the documents // in the input list. If all of the documents contain an error, the ResultList // is empty. // // ResultList is a required field ResultList []*BatchDetectSentimentItemResult `type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchDetectSentimentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectSentimentOutput
SetErrorList sets the ErrorList field's value.
func (s *BatchDetectSentimentOutput) SetResultList(v []*BatchDetectSentimentItemResult) *BatchDetectSentimentOutput
SetResultList sets the ResultList field's value.
func (s BatchDetectSentimentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectSyntaxInput struct { // The language of the input documents. You can specify any of the following // languages supported by Amazon Comprehend: German ("de"), English ("en"), // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All // documents must be in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` // A list containing the UTF-8 encoded text of the input documents. The list // can contain a maximum of 25 documents. The maximum size for each document // is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectSyntaxInput's // String and GoString methods. // // TextList is a required field TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s BatchDetectSyntaxInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSyntaxInput) SetLanguageCode(v string) *BatchDetectSyntaxInput
SetLanguageCode sets the LanguageCode field's value.
func (s *BatchDetectSyntaxInput) SetTextList(v []*string) *BatchDetectSyntaxInput
SetTextList sets the TextList field's value.
func (s BatchDetectSyntaxInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSyntaxInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDetectSyntaxItemResult struct { // The zero-based index of the document in the input list. Index *int64 `type:"integer"` // The syntax tokens for the words in the document, one token for each word. SyntaxTokens []*SyntaxToken `type:"list"` // contains filtered or unexported fields }
The result of calling the operation. The operation returns one object that is successfully processed by the operation.
func (s BatchDetectSyntaxItemResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSyntaxItemResult) SetIndex(v int64) *BatchDetectSyntaxItemResult
SetIndex sets the Index field's value.
func (s *BatchDetectSyntaxItemResult) SetSyntaxTokens(v []*SyntaxToken) *BatchDetectSyntaxItemResult
SetSyntaxTokens sets the SyntaxTokens field's value.
func (s BatchDetectSyntaxItemResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectSyntaxOutput struct { // A list containing one object for each document that contained an error. The // results are sorted in ascending order by the Index field and match the order // of the documents in the input list. If there are no errors in the batch, // the ErrorList is empty. // // ErrorList is a required field ErrorList []*BatchItemError `type:"list" required:"true"` // A list of objects containing the results of the operation. The results are // sorted in ascending order by the Index field and match the order of the documents // in the input list. If all of the documents contain an error, the ResultList // is empty. // // ResultList is a required field ResultList []*BatchDetectSyntaxItemResult `type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchDetectSyntaxOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectSyntaxOutput) SetErrorList(v []*BatchItemError) *BatchDetectSyntaxOutput
SetErrorList sets the ErrorList field's value.
func (s *BatchDetectSyntaxOutput) SetResultList(v []*BatchDetectSyntaxItemResult) *BatchDetectSyntaxOutput
SetResultList sets the ResultList field's value.
func (s BatchDetectSyntaxOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectTargetedSentimentInput struct { // The language of the input documents. Currently, English is the only supported // language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A list containing the UTF-8 encoded text of the input documents. The list // can contain a maximum of 25 documents. The maximum size of each document // is 5 KB. // // TextList is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by BatchDetectTargetedSentimentInput's // String and GoString methods. // // TextList is a required field TextList []*string `min:"1" type:"list" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s BatchDetectTargetedSentimentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectTargetedSentimentInput) SetLanguageCode(v string) *BatchDetectTargetedSentimentInput
SetLanguageCode sets the LanguageCode field's value.
func (s *BatchDetectTargetedSentimentInput) SetTextList(v []*string) *BatchDetectTargetedSentimentInput
SetTextList sets the TextList field's value.
func (s BatchDetectTargetedSentimentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectTargetedSentimentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDetectTargetedSentimentItemResult struct { // An array of targeted sentiment entities. Entities []*TargetedSentimentEntity `type:"list"` // The zero-based index of this result in the input list. Index *int64 `type:"integer"` // contains filtered or unexported fields }
Analysis results for one of the documents in the batch.
func (s BatchDetectTargetedSentimentItemResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectTargetedSentimentItemResult) SetEntities(v []*TargetedSentimentEntity) *BatchDetectTargetedSentimentItemResult
SetEntities sets the Entities field's value.
func (s *BatchDetectTargetedSentimentItemResult) SetIndex(v int64) *BatchDetectTargetedSentimentItemResult
SetIndex sets the Index field's value.
func (s BatchDetectTargetedSentimentItemResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDetectTargetedSentimentOutput struct { // List of errors that the operation can return. // // ErrorList is a required field ErrorList []*BatchItemError `type:"list" required:"true"` // A list of objects containing the results of the operation. The results are // sorted in ascending order by the Index field and match the order of the documents // in the input list. If all of the documents contain an error, the ResultList // is empty. // // ResultList is a required field ResultList []*BatchDetectTargetedSentimentItemResult `type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchDetectTargetedSentimentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDetectTargetedSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectTargetedSentimentOutput
SetErrorList sets the ErrorList field's value.
func (s *BatchDetectTargetedSentimentOutput) SetResultList(v []*BatchDetectTargetedSentimentItemResult) *BatchDetectTargetedSentimentOutput
SetResultList sets the ResultList field's value.
func (s BatchDetectTargetedSentimentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchItemError struct { // The numeric error code of the error. ErrorCode *string `min:"1" type:"string"` // A text description of the error. ErrorMessage *string `min:"1" type:"string"` // The zero-based index of the document in the input list. Index *int64 `type:"integer"` // contains filtered or unexported fields }
Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.
func (s BatchItemError) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchItemError) SetErrorCode(v string) *BatchItemError
SetErrorCode sets the ErrorCode field's value.
func (s *BatchItemError) SetErrorMessage(v string) *BatchItemError
SetErrorMessage sets the ErrorMessage field's value.
func (s *BatchItemError) SetIndex(v int64) *BatchItemError
SetIndex sets the Index field's value.
func (s BatchItemError) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchSizeLimitExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
func (s *BatchSizeLimitExceededException) Code() string
Code returns the exception type name.
func (s *BatchSizeLimitExceededException) Error() string
func (s BatchSizeLimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchSizeLimitExceededException) Message() string
Message returns the exception's message.
func (s *BatchSizeLimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *BatchSizeLimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *BatchSizeLimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s BatchSizeLimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Block struct { // The block represents a line of text or one word of text. // // * WORD - A word that's detected on a document page. A word is one or more // ISO basic Latin script characters that aren't separated by spaces. // // * LINE - A string of tab-delimited, contiguous words that are detected // on a document page BlockType *string `type:"string" enum:"BlockType"` // Co-ordinates of the rectangle or polygon that contains the text. Geometry *Geometry `type:"structure"` // Unique identifier for the block. Id *string `min:"1" type:"string"` // Page number where the block appears. Page *int64 `type:"integer"` // A list of child blocks of the current block. For example, a LINE object has // child blocks for each WORD block that's part of the line of text. Relationships []*RelationshipsListItem `type:"list"` // The word or line of text extracted from the block. Text *string `min:"1" type:"string"` // contains filtered or unexported fields }
Information about each word or line of text in the input document.
For additional information, see Block (https://docs.aws.amazon.com/textract/latest/dg/API_Block.html) in the Amazon Textract API reference.
func (s Block) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Block) SetBlockType(v string) *Block
SetBlockType sets the BlockType field's value.
func (s *Block) SetGeometry(v *Geometry) *Block
SetGeometry sets the Geometry field's value.
func (s *Block) SetId(v string) *Block
SetId sets the Id field's value.
func (s *Block) SetPage(v int64) *Block
SetPage sets the Page field's value.
func (s *Block) SetRelationships(v []*RelationshipsListItem) *Block
SetRelationships sets the Relationships field's value.
func (s *Block) SetText(v string) *Block
SetText sets the Text field's value.
func (s Block) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BlockReference struct { // Offset of the start of the block within its parent block. BeginOffset *int64 `type:"integer"` // Unique identifier for the block. BlockId *string `min:"1" type:"string"` // List of child blocks within this block. ChildBlocks []*ChildBlock `type:"list"` // Offset of the end of the block within its parent block. EndOffset *int64 `type:"integer"` // contains filtered or unexported fields }
A reference to a block.
func (s BlockReference) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BlockReference) SetBeginOffset(v int64) *BlockReference
SetBeginOffset sets the BeginOffset field's value.
func (s *BlockReference) SetBlockId(v string) *BlockReference
SetBlockId sets the BlockId field's value.
func (s *BlockReference) SetChildBlocks(v []*ChildBlock) *BlockReference
SetChildBlocks sets the ChildBlocks field's value.
func (s *BlockReference) SetEndOffset(v int64) *BlockReference
SetEndOffset sets the EndOffset field's value.
func (s BlockReference) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BoundingBox struct { // The height of the bounding box as a ratio of the overall document page height. Height *float64 `type:"float"` // The left coordinate of the bounding box as a ratio of overall document page // width. Left *float64 `type:"float"` // The top coordinate of the bounding box as a ratio of overall document page // height. Top *float64 `type:"float"` // The width of the bounding box as a ratio of the overall document page width. Width *float64 `type:"float"` // contains filtered or unexported fields }
The bounding box around the detected page or around an element on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
For additional information, see BoundingBox (https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html) in the Amazon Textract API reference.
func (s BoundingBox) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BoundingBox) SetHeight(v float64) *BoundingBox
SetHeight sets the Height field's value.
func (s *BoundingBox) SetLeft(v float64) *BoundingBox
SetLeft sets the Left field's value.
func (s *BoundingBox) SetTop(v float64) *BoundingBox
SetTop sets the Top field's value.
func (s *BoundingBox) SetWidth(v float64) *BoundingBox
SetWidth sets the Width field's value.
func (s BoundingBox) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ChildBlock struct { // Offset of the start of the child block within its parent block. BeginOffset *int64 `type:"integer"` // Unique identifier for the child block. ChildBlockId *string `min:"1" type:"string"` // Offset of the end of the child block within its parent block. EndOffset *int64 `type:"integer"` // contains filtered or unexported fields }
Nested block contained within a block.
func (s ChildBlock) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ChildBlock) SetBeginOffset(v int64) *ChildBlock
SetBeginOffset sets the BeginOffset field's value.
func (s *ChildBlock) SetChildBlockId(v string) *ChildBlock
SetChildBlockId sets the ChildBlockId field's value.
func (s *ChildBlock) SetEndOffset(v int64) *ChildBlock
SetEndOffset sets the EndOffset field's value.
func (s ChildBlock) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ClassifierEvaluationMetrics struct { // The fraction of the labels that were correct recognized. It is computed by // dividing the number of labels in the test documents that were correctly recognized // by the total number of labels in the test documents. Accuracy *float64 `type:"double"` // A measure of how accurate the classifier results are for the test data. It // is derived from the Precision and Recall values. The F1Score is the harmonic // average of the two scores. The highest score is 1, and the worst score is // 0. F1Score *float64 `type:"double"` // Indicates the fraction of labels that are incorrectly predicted. Also seen // as the fraction of wrong labels compared to the total number of labels. Scores // closer to zero are better. HammingLoss *float64 `type:"double"` // A measure of how accurate the classifier results are for the test data. It // is a combination of the Micro Precision and Micro Recall values. The Micro // F1Score is the harmonic mean of the two scores. The highest score is 1, and // the worst score is 0. MicroF1Score *float64 `type:"double"` // A measure of the usefulness of the recognizer results in the test data. High // precision means that the recognizer returned substantially more relevant // results than irrelevant ones. Unlike the Precision metric which comes from // averaging the precision of all available labels, this is based on the overall // score of all precision scores added together. MicroPrecision *float64 `type:"double"` // A measure of how complete the classifier results are for the test data. High // recall means that the classifier returned most of the relevant results. Specifically, // this indicates how many of the correct categories in the text that the model // can predict. It is a percentage of correct categories in the text that can // found. Instead of averaging the recall scores of all labels (as with Recall), // micro Recall is based on the overall score of all recall scores added together. MicroRecall *float64 `type:"double"` // A measure of the usefulness of the classifier results in the test data. High // precision means that the classifier returned substantially more relevant // results than irrelevant ones. Precision *float64 `type:"double"` // A measure of how complete the classifier results are for the test data. High // recall means that the classifier returned most of the relevant results. Recall *float64 `type:"double"` // contains filtered or unexported fields }
Describes the result metrics for the test data associated with an documentation classifier.
func (s ClassifierEvaluationMetrics) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClassifierEvaluationMetrics) SetAccuracy(v float64) *ClassifierEvaluationMetrics
SetAccuracy sets the Accuracy field's value.
func (s *ClassifierEvaluationMetrics) SetF1Score(v float64) *ClassifierEvaluationMetrics
SetF1Score sets the F1Score field's value.
func (s *ClassifierEvaluationMetrics) SetHammingLoss(v float64) *ClassifierEvaluationMetrics
SetHammingLoss sets the HammingLoss field's value.
func (s *ClassifierEvaluationMetrics) SetMicroF1Score(v float64) *ClassifierEvaluationMetrics
SetMicroF1Score sets the MicroF1Score field's value.
func (s *ClassifierEvaluationMetrics) SetMicroPrecision(v float64) *ClassifierEvaluationMetrics
SetMicroPrecision sets the MicroPrecision field's value.
func (s *ClassifierEvaluationMetrics) SetMicroRecall(v float64) *ClassifierEvaluationMetrics
SetMicroRecall sets the MicroRecall field's value.
func (s *ClassifierEvaluationMetrics) SetPrecision(v float64) *ClassifierEvaluationMetrics
SetPrecision sets the Precision field's value.
func (s *ClassifierEvaluationMetrics) SetRecall(v float64) *ClassifierEvaluationMetrics
SetRecall sets the Recall field's value.
func (s ClassifierEvaluationMetrics) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ClassifierMetadata struct { // Describes the result metrics for the test data associated with an documentation // classifier. EvaluationMetrics *ClassifierEvaluationMetrics `type:"structure"` // The number of labels in the input data. NumberOfLabels *int64 `type:"integer"` // The number of documents in the input data that were used to test the classifier. // Typically this is 10 to 20 percent of the input documents, up to 10,000 documents. NumberOfTestDocuments *int64 `type:"integer"` // The number of documents in the input data that were used to train the classifier. // Typically this is 80 to 90 percent of the input documents. NumberOfTrainedDocuments *int64 `type:"integer"` // contains filtered or unexported fields }
Provides information about a document classifier.
func (s ClassifierMetadata) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClassifierMetadata) SetEvaluationMetrics(v *ClassifierEvaluationMetrics) *ClassifierMetadata
SetEvaluationMetrics sets the EvaluationMetrics field's value.
func (s *ClassifierMetadata) SetNumberOfLabels(v int64) *ClassifierMetadata
SetNumberOfLabels sets the NumberOfLabels field's value.
func (s *ClassifierMetadata) SetNumberOfTestDocuments(v int64) *ClassifierMetadata
SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.
func (s *ClassifierMetadata) SetNumberOfTrainedDocuments(v int64) *ClassifierMetadata
SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.
func (s ClassifierMetadata) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ClassifyDocumentInput struct { // Use the Bytes parameter to input a text, PDF, Word or image file. You can // also use the Bytes parameter to input an Amazon Textract DetectDocumentText // or AnalyzeDocument output file. // // Provide the input document as a sequence of base64-encoded bytes. If your // code uses an Amazon Web Services SDK to classify documents, the SDK may encode // the document file bytes for you. // // The maximum length of this field depends on the input document type. For // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) // in the Comprehend Developer Guide. // // If you use the Bytes parameter, do not use the Text parameter. // Bytes is automatically base64 encoded/decoded by the SDK. Bytes []byte `min:"1" type:"blob"` // Provides configuration parameters to override the default actions for extracting // text from PDF documents and image files. DocumentReaderConfig *DocumentReaderConfig `type:"structure"` // The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, // see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). // // EndpointArn is a required field EndpointArn *string `type:"string" required:"true"` // The document text to be analyzed. If you enter text using this parameter, // do not use the Bytes parameter. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ClassifyDocumentInput's // String and GoString methods. Text *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
func (s ClassifyDocumentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClassifyDocumentInput) SetBytes(v []byte) *ClassifyDocumentInput
SetBytes sets the Bytes field's value.
func (s *ClassifyDocumentInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *ClassifyDocumentInput
SetDocumentReaderConfig sets the DocumentReaderConfig field's value.
func (s *ClassifyDocumentInput) SetEndpointArn(v string) *ClassifyDocumentInput
SetEndpointArn sets the EndpointArn field's value.
func (s *ClassifyDocumentInput) SetText(v string) *ClassifyDocumentInput
SetText sets the Text field's value.
func (s ClassifyDocumentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClassifyDocumentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ClassifyDocumentOutput struct { // The classes used by the document being analyzed. These are used for multi-class // trained models. Individual classes are mutually exclusive and each document // is expected to have only a single class assigned to it. For example, an animal // can be a dog or a cat, but not both at the same time. Classes []*DocumentClass `type:"list"` // Extraction information about the document. This field is present in the response // only if your request includes the Byte parameter. DocumentMetadata *DocumentMetadata `type:"structure"` // The document type for each page in the input document. This field is present // in the response only if your request includes the Byte parameter. DocumentType []*DocumentTypeListItem `type:"list"` // Page-level errors that the system detected while processing the input document. // The field is empty if the system encountered no errors. Errors []*ErrorsListItem `type:"list"` // The labels used the document being analyzed. These are used for multi-label // trained models. Individual labels represent different categories that are // related in some manner and are not mutually exclusive. For example, a movie // can be just an action movie, or it can be an action movie, a science fiction // movie, and a comedy, all at the same time. Labels []*DocumentLabel `type:"list"` // contains filtered or unexported fields }
func (s ClassifyDocumentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ClassifyDocumentOutput) SetClasses(v []*DocumentClass) *ClassifyDocumentOutput
SetClasses sets the Classes field's value.
func (s *ClassifyDocumentOutput) SetDocumentMetadata(v *DocumentMetadata) *ClassifyDocumentOutput
SetDocumentMetadata sets the DocumentMetadata field's value.
func (s *ClassifyDocumentOutput) SetDocumentType(v []*DocumentTypeListItem) *ClassifyDocumentOutput
SetDocumentType sets the DocumentType field's value.
func (s *ClassifyDocumentOutput) SetErrors(v []*ErrorsListItem) *ClassifyDocumentOutput
SetErrors sets the Errors field's value.
func (s *ClassifyDocumentOutput) SetLabels(v []*DocumentLabel) *ClassifyDocumentOutput
SetLabels sets the Labels field's value.
func (s ClassifyDocumentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Comprehend struct { *client.Client }
Comprehend provides the API operation methods for making requests to Amazon Comprehend. See this package's package overview docs for details on the service.
Comprehend methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Comprehend
New creates a new instance of the Comprehend client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a Comprehend client from just a session. svc := comprehend.New(mySession) // Create a Comprehend client with additional configuration svc := comprehend.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *Comprehend) BatchDetectDominantLanguage(input *BatchDetectDominantLanguageInput) (*BatchDetectDominantLanguageOutput, error)
BatchDetectDominantLanguage API operation for Amazon Comprehend.
Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation BatchDetectDominantLanguage for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguage
func (c *Comprehend) BatchDetectDominantLanguageRequest(input *BatchDetectDominantLanguageInput) (req *request.Request, output *BatchDetectDominantLanguageOutput)
BatchDetectDominantLanguageRequest generates a "aws/request.Request" representing the client's request for the BatchDetectDominantLanguage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDetectDominantLanguage for more information on using the BatchDetectDominantLanguage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDetectDominantLanguageRequest method. req, resp := client.BatchDetectDominantLanguageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguage
func (c *Comprehend) BatchDetectDominantLanguageWithContext(ctx aws.Context, input *BatchDetectDominantLanguageInput, opts ...request.Option) (*BatchDetectDominantLanguageOutput, error)
BatchDetectDominantLanguageWithContext is the same as BatchDetectDominantLanguage with the addition of the ability to pass a context and additional request options.
See BatchDetectDominantLanguage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) BatchDetectEntities(input *BatchDetectEntitiesInput) (*BatchDetectEntitiesOutput, error)
BatchDetectEntities API operation for Amazon Comprehend.
Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the Comprehend Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation BatchDetectEntities for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntities
func (c *Comprehend) BatchDetectEntitiesRequest(input *BatchDetectEntitiesInput) (req *request.Request, output *BatchDetectEntitiesOutput)
BatchDetectEntitiesRequest generates a "aws/request.Request" representing the client's request for the BatchDetectEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDetectEntities for more information on using the BatchDetectEntities API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDetectEntitiesRequest method. req, resp := client.BatchDetectEntitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntities
func (c *Comprehend) BatchDetectEntitiesWithContext(ctx aws.Context, input *BatchDetectEntitiesInput, opts ...request.Option) (*BatchDetectEntitiesOutput, error)
BatchDetectEntitiesWithContext is the same as BatchDetectEntities with the addition of the ability to pass a context and additional request options.
See BatchDetectEntities for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) BatchDetectKeyPhrases(input *BatchDetectKeyPhrasesInput) (*BatchDetectKeyPhrasesOutput, error)
BatchDetectKeyPhrases API operation for Amazon Comprehend.
Detects the key noun phrases found in a batch of documents.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation BatchDetectKeyPhrases for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrases
func (c *Comprehend) BatchDetectKeyPhrasesRequest(input *BatchDetectKeyPhrasesInput) (req *request.Request, output *BatchDetectKeyPhrasesOutput)
BatchDetectKeyPhrasesRequest generates a "aws/request.Request" representing the client's request for the BatchDetectKeyPhrases operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDetectKeyPhrases for more information on using the BatchDetectKeyPhrases API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDetectKeyPhrasesRequest method. req, resp := client.BatchDetectKeyPhrasesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrases
func (c *Comprehend) BatchDetectKeyPhrasesWithContext(ctx aws.Context, input *BatchDetectKeyPhrasesInput, opts ...request.Option) (*BatchDetectKeyPhrasesOutput, error)
BatchDetectKeyPhrasesWithContext is the same as BatchDetectKeyPhrases with the addition of the ability to pass a context and additional request options.
See BatchDetectKeyPhrases for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) BatchDetectSentiment(input *BatchDetectSentimentInput) (*BatchDetectSentimentOutput, error)
BatchDetectSentiment API operation for Amazon Comprehend.
Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation BatchDetectSentiment for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentiment
func (c *Comprehend) BatchDetectSentimentRequest(input *BatchDetectSentimentInput) (req *request.Request, output *BatchDetectSentimentOutput)
BatchDetectSentimentRequest generates a "aws/request.Request" representing the client's request for the BatchDetectSentiment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDetectSentiment for more information on using the BatchDetectSentiment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDetectSentimentRequest method. req, resp := client.BatchDetectSentimentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentiment
func (c *Comprehend) BatchDetectSentimentWithContext(ctx aws.Context, input *BatchDetectSentimentInput, opts ...request.Option) (*BatchDetectSentimentOutput, error)
BatchDetectSentimentWithContext is the same as BatchDetectSentiment with the addition of the ability to pass a context and additional request options.
See BatchDetectSentiment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) BatchDetectSyntax(input *BatchDetectSyntaxInput) (*BatchDetectSyntaxOutput, error)
BatchDetectSyntax API operation for Amazon Comprehend.
Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation BatchDetectSyntax for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntax
func (c *Comprehend) BatchDetectSyntaxRequest(input *BatchDetectSyntaxInput) (req *request.Request, output *BatchDetectSyntaxOutput)
BatchDetectSyntaxRequest generates a "aws/request.Request" representing the client's request for the BatchDetectSyntax operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDetectSyntax for more information on using the BatchDetectSyntax API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDetectSyntaxRequest method. req, resp := client.BatchDetectSyntaxRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntax
func (c *Comprehend) BatchDetectSyntaxWithContext(ctx aws.Context, input *BatchDetectSyntaxInput, opts ...request.Option) (*BatchDetectSyntaxOutput, error)
BatchDetectSyntaxWithContext is the same as BatchDetectSyntax with the addition of the ability to pass a context and additional request options.
See BatchDetectSyntax for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) BatchDetectTargetedSentiment(input *BatchDetectTargetedSentimentInput) (*BatchDetectTargetedSentimentOutput, error)
BatchDetectTargetedSentiment API operation for Amazon Comprehend.
Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.
For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation BatchDetectTargetedSentiment for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
BatchSizeLimitExceededException The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentiment
func (c *Comprehend) BatchDetectTargetedSentimentRequest(input *BatchDetectTargetedSentimentInput) (req *request.Request, output *BatchDetectTargetedSentimentOutput)
BatchDetectTargetedSentimentRequest generates a "aws/request.Request" representing the client's request for the BatchDetectTargetedSentiment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDetectTargetedSentiment for more information on using the BatchDetectTargetedSentiment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDetectTargetedSentimentRequest method. req, resp := client.BatchDetectTargetedSentimentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentiment
func (c *Comprehend) BatchDetectTargetedSentimentWithContext(ctx aws.Context, input *BatchDetectTargetedSentimentInput, opts ...request.Option) (*BatchDetectTargetedSentimentOutput, error)
BatchDetectTargetedSentimentWithContext is the same as BatchDetectTargetedSentiment with the addition of the ability to pass a context and additional request options.
See BatchDetectTargetedSentiment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ClassifyDocument(input *ClassifyDocumentInput) (*ClassifyDocumentOutput, error)
ClassifyDocument API operation for Amazon Comprehend.
Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.
You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors that describes the errors.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) in the Comprehend Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ClassifyDocument for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocument
func (c *Comprehend) ClassifyDocumentRequest(input *ClassifyDocumentInput) (req *request.Request, output *ClassifyDocumentOutput)
ClassifyDocumentRequest generates a "aws/request.Request" representing the client's request for the ClassifyDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ClassifyDocument for more information on using the ClassifyDocument API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ClassifyDocumentRequest method. req, resp := client.ClassifyDocumentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocument
func (c *Comprehend) ClassifyDocumentWithContext(ctx aws.Context, input *ClassifyDocumentInput, opts ...request.Option) (*ClassifyDocumentOutput, error)
ClassifyDocumentWithContext is the same as ClassifyDocument with the addition of the ability to pass a context and additional request options.
See ClassifyDocument for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ContainsPiiEntities(input *ContainsPiiEntitiesInput) (*ContainsPiiEntitiesOutput, error)
ContainsPiiEntities API operation for Amazon Comprehend.
Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ContainsPiiEntities for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntities
func (c *Comprehend) ContainsPiiEntitiesRequest(input *ContainsPiiEntitiesInput) (req *request.Request, output *ContainsPiiEntitiesOutput)
ContainsPiiEntitiesRequest generates a "aws/request.Request" representing the client's request for the ContainsPiiEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ContainsPiiEntities for more information on using the ContainsPiiEntities API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ContainsPiiEntitiesRequest method. req, resp := client.ContainsPiiEntitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntities
func (c *Comprehend) ContainsPiiEntitiesWithContext(ctx aws.Context, input *ContainsPiiEntitiesInput, opts ...request.Option) (*ContainsPiiEntitiesOutput, error)
ContainsPiiEntitiesWithContext is the same as ContainsPiiEntities with the addition of the ability to pass a context and additional request options.
See ContainsPiiEntities for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) CreateDocumentClassifier(input *CreateDocumentClassifierInput) (*CreateDocumentClassifierOutput, error)
CreateDocumentClassifier API operation for Amazon Comprehend.
Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification (https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html) in the Comprehend Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation CreateDocumentClassifier for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifier
func (c *Comprehend) CreateDocumentClassifierRequest(input *CreateDocumentClassifierInput) (req *request.Request, output *CreateDocumentClassifierOutput)
CreateDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the CreateDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDocumentClassifier for more information on using the CreateDocumentClassifier API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateDocumentClassifierRequest method. req, resp := client.CreateDocumentClassifierRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifier
func (c *Comprehend) CreateDocumentClassifierWithContext(ctx aws.Context, input *CreateDocumentClassifierInput, opts ...request.Option) (*CreateDocumentClassifierOutput, error)
CreateDocumentClassifierWithContext is the same as CreateDocumentClassifier with the addition of the ability to pass a context and additional request options.
See CreateDocumentClassifier for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) CreateEndpoint(input *CreateEndpointInput) (*CreateEndpointOutput, error)
CreateEndpoint API operation for Amazon Comprehend.
Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation CreateEndpoint for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpoint
func (c *Comprehend) CreateEndpointRequest(input *CreateEndpointInput) (req *request.Request, output *CreateEndpointOutput)
CreateEndpointRequest generates a "aws/request.Request" representing the client's request for the CreateEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateEndpoint for more information on using the CreateEndpoint API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateEndpointRequest method. req, resp := client.CreateEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpoint
func (c *Comprehend) CreateEndpointWithContext(ctx aws.Context, input *CreateEndpointInput, opts ...request.Option) (*CreateEndpointOutput, error)
CreateEndpointWithContext is the same as CreateEndpoint with the addition of the ability to pass a context and additional request options.
See CreateEndpoint for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) CreateEntityRecognizer(input *CreateEntityRecognizerInput) (*CreateEntityRecognizerOutput, error)
CreateEntityRecognizer API operation for Amazon Comprehend.
Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation CreateEntityRecognizer for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizer
func (c *Comprehend) CreateEntityRecognizerRequest(input *CreateEntityRecognizerInput) (req *request.Request, output *CreateEntityRecognizerOutput)
CreateEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the CreateEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateEntityRecognizer for more information on using the CreateEntityRecognizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateEntityRecognizerRequest method. req, resp := client.CreateEntityRecognizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEntityRecognizer
func (c *Comprehend) CreateEntityRecognizerWithContext(ctx aws.Context, input *CreateEntityRecognizerInput, opts ...request.Option) (*CreateEntityRecognizerOutput, error)
CreateEntityRecognizerWithContext is the same as CreateEntityRecognizer with the addition of the ability to pass a context and additional request options.
See CreateEntityRecognizer for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DeleteDocumentClassifier(input *DeleteDocumentClassifierInput) (*DeleteDocumentClassifierOutput, error)
DeleteDocumentClassifier API operation for Amazon Comprehend.
Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DeleteDocumentClassifier for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteDocumentClassifier
func (c *Comprehend) DeleteDocumentClassifierRequest(input *DeleteDocumentClassifierInput) (req *request.Request, output *DeleteDocumentClassifierOutput)
DeleteDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the DeleteDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDocumentClassifier for more information on using the DeleteDocumentClassifier API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteDocumentClassifierRequest method. req, resp := client.DeleteDocumentClassifierRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteDocumentClassifier
func (c *Comprehend) DeleteDocumentClassifierWithContext(ctx aws.Context, input *DeleteDocumentClassifierInput, opts ...request.Option) (*DeleteDocumentClassifierOutput, error)
DeleteDocumentClassifierWithContext is the same as DeleteDocumentClassifier with the addition of the ability to pass a context and additional request options.
See DeleteDocumentClassifier for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
DeleteEndpoint API operation for Amazon Comprehend.
Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DeleteEndpoint for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEndpoint
func (c *Comprehend) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
DeleteEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteEndpoint for more information on using the DeleteEndpoint API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteEndpointRequest method. req, resp := client.DeleteEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEndpoint
func (c *Comprehend) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)
DeleteEndpointWithContext is the same as DeleteEndpoint with the addition of the ability to pass a context and additional request options.
See DeleteEndpoint for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DeleteEntityRecognizer(input *DeleteEntityRecognizerInput) (*DeleteEntityRecognizerOutput, error)
DeleteEntityRecognizer API operation for Amazon Comprehend.
Deletes an entity recognizer.
Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DeleteEntityRecognizer for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizer
func (c *Comprehend) DeleteEntityRecognizerRequest(input *DeleteEntityRecognizerInput) (req *request.Request, output *DeleteEntityRecognizerOutput)
DeleteEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the DeleteEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteEntityRecognizer for more information on using the DeleteEntityRecognizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteEntityRecognizerRequest method. req, resp := client.DeleteEntityRecognizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEntityRecognizer
func (c *Comprehend) DeleteEntityRecognizerWithContext(ctx aws.Context, input *DeleteEntityRecognizerInput, opts ...request.Option) (*DeleteEntityRecognizerOutput, error)
DeleteEntityRecognizerWithContext is the same as DeleteEntityRecognizer with the addition of the ability to pass a context and additional request options.
See DeleteEntityRecognizer for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error)
DeleteResourcePolicy API operation for Amazon Comprehend.
Deletes a resource-based policy that is attached to a custom model.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DeleteResourcePolicy for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteResourcePolicy
func (c *Comprehend) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput)
DeleteResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteResourcePolicy for more information on using the DeleteResourcePolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteResourcePolicyRequest method. req, resp := client.DeleteResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteResourcePolicy
func (c *Comprehend) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error)
DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of the ability to pass a context and additional request options.
See DeleteResourcePolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeDocumentClassificationJob(input *DescribeDocumentClassificationJobInput) (*DescribeDocumentClassificationJobOutput, error)
DescribeDocumentClassificationJob API operation for Amazon Comprehend.
Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeDocumentClassificationJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob
func (c *Comprehend) DescribeDocumentClassificationJobRequest(input *DescribeDocumentClassificationJobInput) (req *request.Request, output *DescribeDocumentClassificationJobOutput)
DescribeDocumentClassificationJobRequest generates a "aws/request.Request" representing the client's request for the DescribeDocumentClassificationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDocumentClassificationJob for more information on using the DescribeDocumentClassificationJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDocumentClassificationJobRequest method. req, resp := client.DescribeDocumentClassificationJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob
func (c *Comprehend) DescribeDocumentClassificationJobWithContext(ctx aws.Context, input *DescribeDocumentClassificationJobInput, opts ...request.Option) (*DescribeDocumentClassificationJobOutput, error)
DescribeDocumentClassificationJobWithContext is the same as DescribeDocumentClassificationJob with the addition of the ability to pass a context and additional request options.
See DescribeDocumentClassificationJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeDocumentClassifier(input *DescribeDocumentClassifierInput) (*DescribeDocumentClassifierOutput, error)
DescribeDocumentClassifier API operation for Amazon Comprehend.
Gets the properties associated with a document classifier.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeDocumentClassifier for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier
func (c *Comprehend) DescribeDocumentClassifierRequest(input *DescribeDocumentClassifierInput) (req *request.Request, output *DescribeDocumentClassifierOutput)
DescribeDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the DescribeDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDocumentClassifier for more information on using the DescribeDocumentClassifier API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDocumentClassifierRequest method. req, resp := client.DescribeDocumentClassifierRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier
func (c *Comprehend) DescribeDocumentClassifierWithContext(ctx aws.Context, input *DescribeDocumentClassifierInput, opts ...request.Option) (*DescribeDocumentClassifierOutput, error)
DescribeDocumentClassifierWithContext is the same as DescribeDocumentClassifier with the addition of the ability to pass a context and additional request options.
See DescribeDocumentClassifier for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeDominantLanguageDetectionJob(input *DescribeDominantLanguageDetectionJobInput) (*DescribeDominantLanguageDetectionJobOutput, error)
DescribeDominantLanguageDetectionJob API operation for Amazon Comprehend.
Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeDominantLanguageDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob
func (c *Comprehend) DescribeDominantLanguageDetectionJobRequest(input *DescribeDominantLanguageDetectionJobInput) (req *request.Request, output *DescribeDominantLanguageDetectionJobOutput)
DescribeDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDominantLanguageDetectionJob for more information on using the DescribeDominantLanguageDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDominantLanguageDetectionJobRequest method. req, resp := client.DescribeDominantLanguageDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob
func (c *Comprehend) DescribeDominantLanguageDetectionJobWithContext(ctx aws.Context, input *DescribeDominantLanguageDetectionJobInput, opts ...request.Option) (*DescribeDominantLanguageDetectionJobOutput, error)
DescribeDominantLanguageDetectionJobWithContext is the same as DescribeDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribeDominantLanguageDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeEndpoint(input *DescribeEndpointInput) (*DescribeEndpointOutput, error)
DescribeEndpoint API operation for Amazon Comprehend.
Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeEndpoint for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint
func (c *Comprehend) DescribeEndpointRequest(input *DescribeEndpointInput) (req *request.Request, output *DescribeEndpointOutput)
DescribeEndpointRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeEndpoint for more information on using the DescribeEndpoint API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeEndpointRequest method. req, resp := client.DescribeEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint
func (c *Comprehend) DescribeEndpointWithContext(ctx aws.Context, input *DescribeEndpointInput, opts ...request.Option) (*DescribeEndpointOutput, error)
DescribeEndpointWithContext is the same as DescribeEndpoint with the addition of the ability to pass a context and additional request options.
See DescribeEndpoint for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeEntitiesDetectionJob(input *DescribeEntitiesDetectionJobInput) (*DescribeEntitiesDetectionJobOutput, error)
DescribeEntitiesDetectionJob API operation for Amazon Comprehend.
Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeEntitiesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob
func (c *Comprehend) DescribeEntitiesDetectionJobRequest(input *DescribeEntitiesDetectionJobInput) (req *request.Request, output *DescribeEntitiesDetectionJobOutput)
DescribeEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeEntitiesDetectionJob for more information on using the DescribeEntitiesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeEntitiesDetectionJobRequest method. req, resp := client.DescribeEntitiesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob
func (c *Comprehend) DescribeEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribeEntitiesDetectionJobInput, opts ...request.Option) (*DescribeEntitiesDetectionJobOutput, error)
DescribeEntitiesDetectionJobWithContext is the same as DescribeEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribeEntitiesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeEntityRecognizer(input *DescribeEntityRecognizerInput) (*DescribeEntityRecognizerOutput, error)
DescribeEntityRecognizer API operation for Amazon Comprehend.
Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeEntityRecognizer for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer
func (c *Comprehend) DescribeEntityRecognizerRequest(input *DescribeEntityRecognizerInput) (req *request.Request, output *DescribeEntityRecognizerOutput)
DescribeEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the DescribeEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeEntityRecognizer for more information on using the DescribeEntityRecognizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeEntityRecognizerRequest method. req, resp := client.DescribeEntityRecognizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer
func (c *Comprehend) DescribeEntityRecognizerWithContext(ctx aws.Context, input *DescribeEntityRecognizerInput, opts ...request.Option) (*DescribeEntityRecognizerOutput, error)
DescribeEntityRecognizerWithContext is the same as DescribeEntityRecognizer with the addition of the ability to pass a context and additional request options.
See DescribeEntityRecognizer for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeEventsDetectionJob(input *DescribeEventsDetectionJobInput) (*DescribeEventsDetectionJobOutput, error)
DescribeEventsDetectionJob API operation for Amazon Comprehend.
Gets the status and details of an events detection job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeEventsDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJob
func (c *Comprehend) DescribeEventsDetectionJobRequest(input *DescribeEventsDetectionJobInput) (req *request.Request, output *DescribeEventsDetectionJobOutput)
DescribeEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeEventsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeEventsDetectionJob for more information on using the DescribeEventsDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeEventsDetectionJobRequest method. req, resp := client.DescribeEventsDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJob
func (c *Comprehend) DescribeEventsDetectionJobWithContext(ctx aws.Context, input *DescribeEventsDetectionJobInput, opts ...request.Option) (*DescribeEventsDetectionJobOutput, error)
DescribeEventsDetectionJobWithContext is the same as DescribeEventsDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribeEventsDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeKeyPhrasesDetectionJob(input *DescribeKeyPhrasesDetectionJobInput) (*DescribeKeyPhrasesDetectionJobOutput, error)
DescribeKeyPhrasesDetectionJob API operation for Amazon Comprehend.
Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeKeyPhrasesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob
func (c *Comprehend) DescribeKeyPhrasesDetectionJobRequest(input *DescribeKeyPhrasesDetectionJobInput) (req *request.Request, output *DescribeKeyPhrasesDetectionJobOutput)
DescribeKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeKeyPhrasesDetectionJob for more information on using the DescribeKeyPhrasesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeKeyPhrasesDetectionJobRequest method. req, resp := client.DescribeKeyPhrasesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob
func (c *Comprehend) DescribeKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *DescribeKeyPhrasesDetectionJobInput, opts ...request.Option) (*DescribeKeyPhrasesDetectionJobOutput, error)
DescribeKeyPhrasesDetectionJobWithContext is the same as DescribeKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribeKeyPhrasesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribePiiEntitiesDetectionJob(input *DescribePiiEntitiesDetectionJobInput) (*DescribePiiEntitiesDetectionJobOutput, error)
DescribePiiEntitiesDetectionJob API operation for Amazon Comprehend.
Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribePiiEntitiesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob
func (c *Comprehend) DescribePiiEntitiesDetectionJobRequest(input *DescribePiiEntitiesDetectionJobInput) (req *request.Request, output *DescribePiiEntitiesDetectionJobOutput)
DescribePiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribePiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribePiiEntitiesDetectionJob for more information on using the DescribePiiEntitiesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribePiiEntitiesDetectionJobRequest method. req, resp := client.DescribePiiEntitiesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob
func (c *Comprehend) DescribePiiEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribePiiEntitiesDetectionJobInput, opts ...request.Option) (*DescribePiiEntitiesDetectionJobOutput, error)
DescribePiiEntitiesDetectionJobWithContext is the same as DescribePiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribePiiEntitiesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeResourcePolicy(input *DescribeResourcePolicyInput) (*DescribeResourcePolicyOutput, error)
DescribeResourcePolicy API operation for Amazon Comprehend.
Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeResourcePolicy for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeResourcePolicy
func (c *Comprehend) DescribeResourcePolicyRequest(input *DescribeResourcePolicyInput) (req *request.Request, output *DescribeResourcePolicyOutput)
DescribeResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DescribeResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeResourcePolicy for more information on using the DescribeResourcePolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeResourcePolicyRequest method. req, resp := client.DescribeResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeResourcePolicy
func (c *Comprehend) DescribeResourcePolicyWithContext(ctx aws.Context, input *DescribeResourcePolicyInput, opts ...request.Option) (*DescribeResourcePolicyOutput, error)
DescribeResourcePolicyWithContext is the same as DescribeResourcePolicy with the addition of the ability to pass a context and additional request options.
See DescribeResourcePolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeSentimentDetectionJob(input *DescribeSentimentDetectionJobInput) (*DescribeSentimentDetectionJobOutput, error)
DescribeSentimentDetectionJob API operation for Amazon Comprehend.
Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeSentimentDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob
func (c *Comprehend) DescribeSentimentDetectionJobRequest(input *DescribeSentimentDetectionJobInput) (req *request.Request, output *DescribeSentimentDetectionJobOutput)
DescribeSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeSentimentDetectionJob for more information on using the DescribeSentimentDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeSentimentDetectionJobRequest method. req, resp := client.DescribeSentimentDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob
func (c *Comprehend) DescribeSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeSentimentDetectionJobInput, opts ...request.Option) (*DescribeSentimentDetectionJobOutput, error)
DescribeSentimentDetectionJobWithContext is the same as DescribeSentimentDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribeSentimentDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeTargetedSentimentDetectionJob(input *DescribeTargetedSentimentDetectionJobInput) (*DescribeTargetedSentimentDetectionJobOutput, error)
DescribeTargetedSentimentDetectionJob API operation for Amazon Comprehend.
Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeTargetedSentimentDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob
func (c *Comprehend) DescribeTargetedSentimentDetectionJobRequest(input *DescribeTargetedSentimentDetectionJobInput) (req *request.Request, output *DescribeTargetedSentimentDetectionJobOutput)
DescribeTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeTargetedSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeTargetedSentimentDetectionJob for more information on using the DescribeTargetedSentimentDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeTargetedSentimentDetectionJobRequest method. req, resp := client.DescribeTargetedSentimentDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob
func (c *Comprehend) DescribeTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeTargetedSentimentDetectionJobInput, opts ...request.Option) (*DescribeTargetedSentimentDetectionJobOutput, error)
DescribeTargetedSentimentDetectionJobWithContext is the same as DescribeTargetedSentimentDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribeTargetedSentimentDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DescribeTopicsDetectionJob(input *DescribeTopicsDetectionJobInput) (*DescribeTopicsDetectionJobOutput, error)
DescribeTopicsDetectionJob API operation for Amazon Comprehend.
Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DescribeTopicsDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob
func (c *Comprehend) DescribeTopicsDetectionJobRequest(input *DescribeTopicsDetectionJobInput) (req *request.Request, output *DescribeTopicsDetectionJobOutput)
DescribeTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeTopicsDetectionJob for more information on using the DescribeTopicsDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeTopicsDetectionJobRequest method. req, resp := client.DescribeTopicsDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob
func (c *Comprehend) DescribeTopicsDetectionJobWithContext(ctx aws.Context, input *DescribeTopicsDetectionJobInput, opts ...request.Option) (*DescribeTopicsDetectionJobOutput, error)
DescribeTopicsDetectionJobWithContext is the same as DescribeTopicsDetectionJob with the addition of the ability to pass a context and additional request options.
See DescribeTopicsDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DetectDominantLanguage(input *DetectDominantLanguageInput) (*DetectDominantLanguageOutput, error)
DetectDominantLanguage API operation for Amazon Comprehend.
Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DetectDominantLanguage for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage
func (c *Comprehend) DetectDominantLanguageRequest(input *DetectDominantLanguageInput) (req *request.Request, output *DetectDominantLanguageOutput)
DetectDominantLanguageRequest generates a "aws/request.Request" representing the client's request for the DetectDominantLanguage operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DetectDominantLanguage for more information on using the DetectDominantLanguage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DetectDominantLanguageRequest method. req, resp := client.DetectDominantLanguageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage
func (c *Comprehend) DetectDominantLanguageWithContext(ctx aws.Context, input *DetectDominantLanguageInput, opts ...request.Option) (*DetectDominantLanguageOutput, error)
DetectDominantLanguageWithContext is the same as DetectDominantLanguage with the addition of the ability to pass a context and additional request options.
See DetectDominantLanguage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DetectEntities(input *DetectEntitiesInput) (*DetectEntitiesOutput, error)
DetectEntities API operation for Amazon Comprehend.
Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.
When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the Comprehend Developer Guide.
When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).
If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.
If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) in the Comprehend Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DetectEntities for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntities
func (c *Comprehend) DetectEntitiesRequest(input *DetectEntitiesInput) (req *request.Request, output *DetectEntitiesOutput)
DetectEntitiesRequest generates a "aws/request.Request" representing the client's request for the DetectEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DetectEntities for more information on using the DetectEntities API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DetectEntitiesRequest method. req, resp := client.DetectEntitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntities
func (c *Comprehend) DetectEntitiesWithContext(ctx aws.Context, input *DetectEntitiesInput, opts ...request.Option) (*DetectEntitiesOutput, error)
DetectEntitiesWithContext is the same as DetectEntities with the addition of the ability to pass a context and additional request options.
See DetectEntities for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DetectKeyPhrases(input *DetectKeyPhrasesInput) (*DetectKeyPhrasesOutput, error)
DetectKeyPhrases API operation for Amazon Comprehend.
Detects the key noun phrases found in the text.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DetectKeyPhrases for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrases
func (c *Comprehend) DetectKeyPhrasesRequest(input *DetectKeyPhrasesInput) (req *request.Request, output *DetectKeyPhrasesOutput)
DetectKeyPhrasesRequest generates a "aws/request.Request" representing the client's request for the DetectKeyPhrases operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DetectKeyPhrases for more information on using the DetectKeyPhrases API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DetectKeyPhrasesRequest method. req, resp := client.DetectKeyPhrasesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrases
func (c *Comprehend) DetectKeyPhrasesWithContext(ctx aws.Context, input *DetectKeyPhrasesInput, opts ...request.Option) (*DetectKeyPhrasesOutput, error)
DetectKeyPhrasesWithContext is the same as DetectKeyPhrases with the addition of the ability to pass a context and additional request options.
See DetectKeyPhrases for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DetectPiiEntities(input *DetectPiiEntitiesInput) (*DetectPiiEntitiesOutput, error)
DetectPiiEntities API operation for Amazon Comprehend.
Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DetectPiiEntities for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities
func (c *Comprehend) DetectPiiEntitiesRequest(input *DetectPiiEntitiesInput) (req *request.Request, output *DetectPiiEntitiesOutput)
DetectPiiEntitiesRequest generates a "aws/request.Request" representing the client's request for the DetectPiiEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DetectPiiEntities for more information on using the DetectPiiEntities API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DetectPiiEntitiesRequest method. req, resp := client.DetectPiiEntitiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities
func (c *Comprehend) DetectPiiEntitiesWithContext(ctx aws.Context, input *DetectPiiEntitiesInput, opts ...request.Option) (*DetectPiiEntitiesOutput, error)
DetectPiiEntitiesWithContext is the same as DetectPiiEntities with the addition of the ability to pass a context and additional request options.
See DetectPiiEntities for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DetectSentiment(input *DetectSentimentInput) (*DetectSentimentOutput, error)
DetectSentiment API operation for Amazon Comprehend.
Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DetectSentiment for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentiment
func (c *Comprehend) DetectSentimentRequest(input *DetectSentimentInput) (req *request.Request, output *DetectSentimentOutput)
DetectSentimentRequest generates a "aws/request.Request" representing the client's request for the DetectSentiment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DetectSentiment for more information on using the DetectSentiment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DetectSentimentRequest method. req, resp := client.DetectSentimentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentiment
func (c *Comprehend) DetectSentimentWithContext(ctx aws.Context, input *DetectSentimentInput, opts ...request.Option) (*DetectSentimentOutput, error)
DetectSentimentWithContext is the same as DetectSentiment with the addition of the ability to pass a context and additional request options.
See DetectSentiment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DetectSyntax(input *DetectSyntaxInput) (*DetectSyntaxOutput, error)
DetectSyntax API operation for Amazon Comprehend.
Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DetectSyntax for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntax
func (c *Comprehend) DetectSyntaxRequest(input *DetectSyntaxInput) (req *request.Request, output *DetectSyntaxOutput)
DetectSyntaxRequest generates a "aws/request.Request" representing the client's request for the DetectSyntax operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DetectSyntax for more information on using the DetectSyntax API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DetectSyntaxRequest method. req, resp := client.DetectSyntaxRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntax
func (c *Comprehend) DetectSyntaxWithContext(ctx aws.Context, input *DetectSyntaxInput, opts ...request.Option) (*DetectSyntaxOutput, error)
DetectSyntaxWithContext is the same as DetectSyntax with the addition of the ability to pass a context and additional request options.
See DetectSyntax for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) DetectTargetedSentiment(input *DetectTargetedSentimentInput) (*DetectTargetedSentimentOutput, error)
DetectTargetedSentiment API operation for Amazon Comprehend.
Inspects the input text and returns a sentiment analysis for each entity identified in the text.
For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation DetectTargetedSentiment for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.
UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentiment
func (c *Comprehend) DetectTargetedSentimentRequest(input *DetectTargetedSentimentInput) (req *request.Request, output *DetectTargetedSentimentOutput)
DetectTargetedSentimentRequest generates a "aws/request.Request" representing the client's request for the DetectTargetedSentiment operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DetectTargetedSentiment for more information on using the DetectTargetedSentiment API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DetectTargetedSentimentRequest method. req, resp := client.DetectTargetedSentimentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentiment
func (c *Comprehend) DetectTargetedSentimentWithContext(ctx aws.Context, input *DetectTargetedSentimentInput, opts ...request.Option) (*DetectTargetedSentimentOutput, error)
DetectTargetedSentimentWithContext is the same as DetectTargetedSentiment with the addition of the ability to pass a context and additional request options.
See DetectTargetedSentiment for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ImportModel(input *ImportModelInput) (*ImportModelOutput, error)
ImportModel API operation for Amazon Comprehend.
Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ImportModel for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ImportModel
func (c *Comprehend) ImportModelRequest(input *ImportModelInput) (req *request.Request, output *ImportModelOutput)
ImportModelRequest generates a "aws/request.Request" representing the client's request for the ImportModel operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ImportModel for more information on using the ImportModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ImportModelRequest method. req, resp := client.ImportModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ImportModel
func (c *Comprehend) ImportModelWithContext(ctx aws.Context, input *ImportModelInput, opts ...request.Option) (*ImportModelOutput, error)
ImportModelWithContext is the same as ImportModel with the addition of the ability to pass a context and additional request options.
See ImportModel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDocumentClassificationJobs(input *ListDocumentClassificationJobsInput) (*ListDocumentClassificationJobsOutput, error)
ListDocumentClassificationJobs API operation for Amazon Comprehend.
Gets a list of the documentation classification jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListDocumentClassificationJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs
func (c *Comprehend) ListDocumentClassificationJobsPages(input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool) error
ListDocumentClassificationJobsPages iterates over the pages of a ListDocumentClassificationJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDocumentClassificationJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDocumentClassificationJobs operation. pageNum := 0 err := client.ListDocumentClassificationJobsPages(params, func(page *comprehend.ListDocumentClassificationJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListDocumentClassificationJobsPagesWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool, opts ...request.Option) error
ListDocumentClassificationJobsPagesWithContext same as ListDocumentClassificationJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentClassificationJobsInput) (req *request.Request, output *ListDocumentClassificationJobsOutput)
ListDocumentClassificationJobsRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassificationJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDocumentClassificationJobs for more information on using the ListDocumentClassificationJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDocumentClassificationJobsRequest method. req, resp := client.ListDocumentClassificationJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs
func (c *Comprehend) ListDocumentClassificationJobsWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, opts ...request.Option) (*ListDocumentClassificationJobsOutput, error)
ListDocumentClassificationJobsWithContext is the same as ListDocumentClassificationJobs with the addition of the ability to pass a context and additional request options.
See ListDocumentClassificationJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDocumentClassifierSummaries(input *ListDocumentClassifierSummariesInput) (*ListDocumentClassifierSummariesOutput, error)
ListDocumentClassifierSummaries API operation for Amazon Comprehend.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListDocumentClassifierSummaries for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries
func (c *Comprehend) ListDocumentClassifierSummariesPages(input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool) error
ListDocumentClassifierSummariesPages iterates over the pages of a ListDocumentClassifierSummaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDocumentClassifierSummaries method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDocumentClassifierSummaries operation. pageNum := 0 err := client.ListDocumentClassifierSummariesPages(params, func(page *comprehend.ListDocumentClassifierSummariesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListDocumentClassifierSummariesPagesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool, opts ...request.Option) error
ListDocumentClassifierSummariesPagesWithContext same as ListDocumentClassifierSummariesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentClassifierSummariesInput) (req *request.Request, output *ListDocumentClassifierSummariesOutput)
ListDocumentClassifierSummariesRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassifierSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDocumentClassifierSummaries for more information on using the ListDocumentClassifierSummaries API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDocumentClassifierSummariesRequest method. req, resp := client.ListDocumentClassifierSummariesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries
func (c *Comprehend) ListDocumentClassifierSummariesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, opts ...request.Option) (*ListDocumentClassifierSummariesOutput, error)
ListDocumentClassifierSummariesWithContext is the same as ListDocumentClassifierSummaries with the addition of the ability to pass a context and additional request options.
See ListDocumentClassifierSummaries for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDocumentClassifiers(input *ListDocumentClassifiersInput) (*ListDocumentClassifiersOutput, error)
ListDocumentClassifiers API operation for Amazon Comprehend.
Gets a list of the document classifiers that you have created.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListDocumentClassifiers for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers
func (c *Comprehend) ListDocumentClassifiersPages(input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool) error
ListDocumentClassifiersPages iterates over the pages of a ListDocumentClassifiers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDocumentClassifiers method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDocumentClassifiers operation. pageNum := 0 err := client.ListDocumentClassifiersPages(params, func(page *comprehend.ListDocumentClassifiersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListDocumentClassifiersPagesWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool, opts ...request.Option) error
ListDocumentClassifiersPagesWithContext same as ListDocumentClassifiersPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDocumentClassifiersRequest(input *ListDocumentClassifiersInput) (req *request.Request, output *ListDocumentClassifiersOutput)
ListDocumentClassifiersRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassifiers operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDocumentClassifiers for more information on using the ListDocumentClassifiers API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDocumentClassifiersRequest method. req, resp := client.ListDocumentClassifiersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers
func (c *Comprehend) ListDocumentClassifiersWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, opts ...request.Option) (*ListDocumentClassifiersOutput, error)
ListDocumentClassifiersWithContext is the same as ListDocumentClassifiers with the addition of the ability to pass a context and additional request options.
See ListDocumentClassifiers for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDominantLanguageDetectionJobs(input *ListDominantLanguageDetectionJobsInput) (*ListDominantLanguageDetectionJobsOutput, error)
ListDominantLanguageDetectionJobs API operation for Amazon Comprehend.
Gets a list of the dominant language detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListDominantLanguageDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs
func (c *Comprehend) ListDominantLanguageDetectionJobsPages(input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool) error
ListDominantLanguageDetectionJobsPages iterates over the pages of a ListDominantLanguageDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListDominantLanguageDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListDominantLanguageDetectionJobs operation. pageNum := 0 err := client.ListDominantLanguageDetectionJobsPages(params, func(page *comprehend.ListDominantLanguageDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListDominantLanguageDetectionJobsPagesWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListDominantLanguageDetectionJobsPagesWithContext same as ListDominantLanguageDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListDominantLanguageDetectionJobsRequest(input *ListDominantLanguageDetectionJobsInput) (req *request.Request, output *ListDominantLanguageDetectionJobsOutput)
ListDominantLanguageDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListDominantLanguageDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDominantLanguageDetectionJobs for more information on using the ListDominantLanguageDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDominantLanguageDetectionJobsRequest method. req, resp := client.ListDominantLanguageDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs
func (c *Comprehend) ListDominantLanguageDetectionJobsWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, opts ...request.Option) (*ListDominantLanguageDetectionJobsOutput, error)
ListDominantLanguageDetectionJobsWithContext is the same as ListDominantLanguageDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListDominantLanguageDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEndpoints(input *ListEndpointsInput) (*ListEndpointsOutput, error)
ListEndpoints API operation for Amazon Comprehend.
Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListEndpoints for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints
func (c *Comprehend) ListEndpointsPages(input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool) error
ListEndpointsPages iterates over the pages of a ListEndpoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListEndpoints method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListEndpoints operation. pageNum := 0 err := client.ListEndpointsPages(params, func(page *comprehend.ListEndpointsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListEndpointsPagesWithContext(ctx aws.Context, input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool, opts ...request.Option) error
ListEndpointsPagesWithContext same as ListEndpointsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEndpointsRequest(input *ListEndpointsInput) (req *request.Request, output *ListEndpointsOutput)
ListEndpointsRequest generates a "aws/request.Request" representing the client's request for the ListEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListEndpoints for more information on using the ListEndpoints API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListEndpointsRequest method. req, resp := client.ListEndpointsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints
func (c *Comprehend) ListEndpointsWithContext(ctx aws.Context, input *ListEndpointsInput, opts ...request.Option) (*ListEndpointsOutput, error)
ListEndpointsWithContext is the same as ListEndpoints with the addition of the ability to pass a context and additional request options.
See ListEndpoints for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEntitiesDetectionJobs(input *ListEntitiesDetectionJobsInput) (*ListEntitiesDetectionJobsOutput, error)
ListEntitiesDetectionJobs API operation for Amazon Comprehend.
Gets a list of the entity detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListEntitiesDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs
func (c *Comprehend) ListEntitiesDetectionJobsPages(input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool) error
ListEntitiesDetectionJobsPages iterates over the pages of a ListEntitiesDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListEntitiesDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListEntitiesDetectionJobs operation. pageNum := 0 err := client.ListEntitiesDetectionJobsPages(params, func(page *comprehend.ListEntitiesDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListEntitiesDetectionJobsPagesWithContext same as ListEntitiesDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEntitiesDetectionJobsRequest(input *ListEntitiesDetectionJobsInput) (req *request.Request, output *ListEntitiesDetectionJobsOutput)
ListEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListEntitiesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListEntitiesDetectionJobs for more information on using the ListEntitiesDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListEntitiesDetectionJobsRequest method. req, resp := client.ListEntitiesDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs
func (c *Comprehend) ListEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, opts ...request.Option) (*ListEntitiesDetectionJobsOutput, error)
ListEntitiesDetectionJobsWithContext is the same as ListEntitiesDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListEntitiesDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEntityRecognizerSummaries(input *ListEntityRecognizerSummariesInput) (*ListEntityRecognizerSummariesOutput, error)
ListEntityRecognizerSummaries API operation for Amazon Comprehend.
Gets a list of summaries for the entity recognizers that you have created.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListEntityRecognizerSummaries for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries
func (c *Comprehend) ListEntityRecognizerSummariesPages(input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool) error
ListEntityRecognizerSummariesPages iterates over the pages of a ListEntityRecognizerSummaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListEntityRecognizerSummaries method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListEntityRecognizerSummaries operation. pageNum := 0 err := client.ListEntityRecognizerSummariesPages(params, func(page *comprehend.ListEntityRecognizerSummariesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListEntityRecognizerSummariesPagesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool, opts ...request.Option) error
ListEntityRecognizerSummariesPagesWithContext same as ListEntityRecognizerSummariesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEntityRecognizerSummariesRequest(input *ListEntityRecognizerSummariesInput) (req *request.Request, output *ListEntityRecognizerSummariesOutput)
ListEntityRecognizerSummariesRequest generates a "aws/request.Request" representing the client's request for the ListEntityRecognizerSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListEntityRecognizerSummaries for more information on using the ListEntityRecognizerSummaries API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListEntityRecognizerSummariesRequest method. req, resp := client.ListEntityRecognizerSummariesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries
func (c *Comprehend) ListEntityRecognizerSummariesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, opts ...request.Option) (*ListEntityRecognizerSummariesOutput, error)
ListEntityRecognizerSummariesWithContext is the same as ListEntityRecognizerSummaries with the addition of the ability to pass a context and additional request options.
See ListEntityRecognizerSummaries for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEntityRecognizers(input *ListEntityRecognizersInput) (*ListEntityRecognizersOutput, error)
ListEntityRecognizers API operation for Amazon Comprehend.
Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.
The results of this list are not in any particular order. Please get the list and sort locally if needed.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListEntityRecognizers for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers
func (c *Comprehend) ListEntityRecognizersPages(input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool) error
ListEntityRecognizersPages iterates over the pages of a ListEntityRecognizers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListEntityRecognizers method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListEntityRecognizers operation. pageNum := 0 err := client.ListEntityRecognizersPages(params, func(page *comprehend.ListEntityRecognizersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListEntityRecognizersPagesWithContext(ctx aws.Context, input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool, opts ...request.Option) error
ListEntityRecognizersPagesWithContext same as ListEntityRecognizersPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEntityRecognizersRequest(input *ListEntityRecognizersInput) (req *request.Request, output *ListEntityRecognizersOutput)
ListEntityRecognizersRequest generates a "aws/request.Request" representing the client's request for the ListEntityRecognizers operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListEntityRecognizers for more information on using the ListEntityRecognizers API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListEntityRecognizersRequest method. req, resp := client.ListEntityRecognizersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers
func (c *Comprehend) ListEntityRecognizersWithContext(ctx aws.Context, input *ListEntityRecognizersInput, opts ...request.Option) (*ListEntityRecognizersOutput, error)
ListEntityRecognizersWithContext is the same as ListEntityRecognizers with the addition of the ability to pass a context and additional request options.
See ListEntityRecognizers for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEventsDetectionJobs(input *ListEventsDetectionJobsInput) (*ListEventsDetectionJobsOutput, error)
ListEventsDetectionJobs API operation for Amazon Comprehend.
Gets a list of the events detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListEventsDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobs
func (c *Comprehend) ListEventsDetectionJobsPages(input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool) error
ListEventsDetectionJobsPages iterates over the pages of a ListEventsDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListEventsDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListEventsDetectionJobs operation. pageNum := 0 err := client.ListEventsDetectionJobsPages(params, func(page *comprehend.ListEventsDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListEventsDetectionJobsPagesWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListEventsDetectionJobsPagesWithContext same as ListEventsDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListEventsDetectionJobsRequest(input *ListEventsDetectionJobsInput) (req *request.Request, output *ListEventsDetectionJobsOutput)
ListEventsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListEventsDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListEventsDetectionJobs for more information on using the ListEventsDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListEventsDetectionJobsRequest method. req, resp := client.ListEventsDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobs
func (c *Comprehend) ListEventsDetectionJobsWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, opts ...request.Option) (*ListEventsDetectionJobsOutput, error)
ListEventsDetectionJobsWithContext is the same as ListEventsDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListEventsDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListKeyPhrasesDetectionJobs(input *ListKeyPhrasesDetectionJobsInput) (*ListKeyPhrasesDetectionJobsOutput, error)
ListKeyPhrasesDetectionJobs API operation for Amazon Comprehend.
Get a list of key phrase detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListKeyPhrasesDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs
func (c *Comprehend) ListKeyPhrasesDetectionJobsPages(input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool) error
ListKeyPhrasesDetectionJobsPages iterates over the pages of a ListKeyPhrasesDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListKeyPhrasesDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListKeyPhrasesDetectionJobs operation. pageNum := 0 err := client.ListKeyPhrasesDetectionJobsPages(params, func(page *comprehend.ListKeyPhrasesDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListKeyPhrasesDetectionJobsPagesWithContext same as ListKeyPhrasesDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDetectionJobsInput) (req *request.Request, output *ListKeyPhrasesDetectionJobsOutput)
ListKeyPhrasesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListKeyPhrasesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListKeyPhrasesDetectionJobs for more information on using the ListKeyPhrasesDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListKeyPhrasesDetectionJobsRequest method. req, resp := client.ListKeyPhrasesDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs
func (c *Comprehend) ListKeyPhrasesDetectionJobsWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, opts ...request.Option) (*ListKeyPhrasesDetectionJobsOutput, error)
ListKeyPhrasesDetectionJobsWithContext is the same as ListKeyPhrasesDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListKeyPhrasesDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListPiiEntitiesDetectionJobs(input *ListPiiEntitiesDetectionJobsInput) (*ListPiiEntitiesDetectionJobsOutput, error)
ListPiiEntitiesDetectionJobs API operation for Amazon Comprehend.
Gets a list of the PII entity detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListPiiEntitiesDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs
func (c *Comprehend) ListPiiEntitiesDetectionJobsPages(input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool) error
ListPiiEntitiesDetectionJobsPages iterates over the pages of a ListPiiEntitiesDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPiiEntitiesDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListPiiEntitiesDetectionJobs operation. pageNum := 0 err := client.ListPiiEntitiesDetectionJobsPages(params, func(page *comprehend.ListPiiEntitiesDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListPiiEntitiesDetectionJobsPagesWithContext same as ListPiiEntitiesDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesDetectionJobsInput) (req *request.Request, output *ListPiiEntitiesDetectionJobsOutput)
ListPiiEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListPiiEntitiesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListPiiEntitiesDetectionJobs for more information on using the ListPiiEntitiesDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListPiiEntitiesDetectionJobsRequest method. req, resp := client.ListPiiEntitiesDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs
func (c *Comprehend) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, opts ...request.Option) (*ListPiiEntitiesDetectionJobsOutput, error)
ListPiiEntitiesDetectionJobsWithContext is the same as ListPiiEntitiesDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListPiiEntitiesDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListSentimentDetectionJobs(input *ListSentimentDetectionJobsInput) (*ListSentimentDetectionJobsOutput, error)
ListSentimentDetectionJobs API operation for Amazon Comprehend.
Gets a list of sentiment detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListSentimentDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs
func (c *Comprehend) ListSentimentDetectionJobsPages(input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool) error
ListSentimentDetectionJobsPages iterates over the pages of a ListSentimentDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListSentimentDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListSentimentDetectionJobs operation. pageNum := 0 err := client.ListSentimentDetectionJobsPages(params, func(page *comprehend.ListSentimentDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListSentimentDetectionJobsPagesWithContext same as ListSentimentDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) (req *request.Request, output *ListSentimentDetectionJobsOutput)
ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListSentimentDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListSentimentDetectionJobs for more information on using the ListSentimentDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListSentimentDetectionJobsRequest method. req, resp := client.ListSentimentDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs
func (c *Comprehend) ListSentimentDetectionJobsWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, opts ...request.Option) (*ListSentimentDetectionJobsOutput, error)
ListSentimentDetectionJobsWithContext is the same as ListSentimentDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListSentimentDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for Amazon Comprehend.
Lists all tags associated with a given Amazon Comprehend resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListTagsForResource for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource
func (c *Comprehend) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource
func (c *Comprehend) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListTargetedSentimentDetectionJobs(input *ListTargetedSentimentDetectionJobsInput) (*ListTargetedSentimentDetectionJobsOutput, error)
ListTargetedSentimentDetectionJobs API operation for Amazon Comprehend.
Gets a list of targeted sentiment detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListTargetedSentimentDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs
func (c *Comprehend) ListTargetedSentimentDetectionJobsPages(input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool) error
ListTargetedSentimentDetectionJobsPages iterates over the pages of a ListTargetedSentimentDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTargetedSentimentDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTargetedSentimentDetectionJobs operation. pageNum := 0 err := client.ListTargetedSentimentDetectionJobsPages(params, func(page *comprehend.ListTargetedSentimentDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListTargetedSentimentDetectionJobsPagesWithContext same as ListTargetedSentimentDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListTargetedSentimentDetectionJobsRequest(input *ListTargetedSentimentDetectionJobsInput) (req *request.Request, output *ListTargetedSentimentDetectionJobsOutput)
ListTargetedSentimentDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTargetedSentimentDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTargetedSentimentDetectionJobs for more information on using the ListTargetedSentimentDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTargetedSentimentDetectionJobsRequest method. req, resp := client.ListTargetedSentimentDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs
func (c *Comprehend) ListTargetedSentimentDetectionJobsWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, opts ...request.Option) (*ListTargetedSentimentDetectionJobsOutput, error)
ListTargetedSentimentDetectionJobsWithContext is the same as ListTargetedSentimentDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListTargetedSentimentDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error)
ListTopicsDetectionJobs API operation for Amazon Comprehend.
Gets a list of the topic detection jobs that you have submitted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation ListTopicsDetectionJobs for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs
func (c *Comprehend) ListTopicsDetectionJobsPages(input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool) error
ListTopicsDetectionJobsPages iterates over the pages of a ListTopicsDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTopicsDetectionJobs method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTopicsDetectionJobs operation. pageNum := 0 err := client.ListTopicsDetectionJobsPages(params, func(page *comprehend.ListTopicsDetectionJobsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error
ListTopicsDetectionJobsPagesWithContext same as ListTopicsDetectionJobsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput)
ListTopicsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTopicsDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTopicsDetectionJobs for more information on using the ListTopicsDetectionJobs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTopicsDetectionJobsRequest method. req, resp := client.ListTopicsDetectionJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs
func (c *Comprehend) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error)
ListTopicsDetectionJobsWithContext is the same as ListTopicsDetectionJobs with the addition of the ability to pass a context and additional request options.
See ListTopicsDetectionJobs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)
PutResourcePolicy API operation for Amazon Comprehend.
Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation PutResourcePolicy for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PutResourcePolicy
func (c *Comprehend) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)
PutResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the PutResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutResourcePolicy for more information on using the PutResourcePolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutResourcePolicyRequest method. req, resp := client.PutResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PutResourcePolicy
func (c *Comprehend) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error)
PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of the ability to pass a context and additional request options.
See PutResourcePolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error)
StartDocumentClassificationJob API operation for Amazon Comprehend.
Starts an asynchronous document classification job. Use the operation to track the progress of the job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartDocumentClassificationJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob
func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) (req *request.Request, output *StartDocumentClassificationJobOutput)
StartDocumentClassificationJobRequest generates a "aws/request.Request" representing the client's request for the StartDocumentClassificationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartDocumentClassificationJob for more information on using the StartDocumentClassificationJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartDocumentClassificationJobRequest method. req, resp := client.StartDocumentClassificationJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob
func (c *Comprehend) StartDocumentClassificationJobWithContext(ctx aws.Context, input *StartDocumentClassificationJobInput, opts ...request.Option) (*StartDocumentClassificationJobOutput, error)
StartDocumentClassificationJobWithContext is the same as StartDocumentClassificationJob with the addition of the ability to pass a context and additional request options.
See StartDocumentClassificationJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartDominantLanguageDetectionJob(input *StartDominantLanguageDetectionJobInput) (*StartDominantLanguageDetectionJobOutput, error)
StartDominantLanguageDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartDominantLanguageDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob
func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) (req *request.Request, output *StartDominantLanguageDetectionJobOutput)
StartDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartDominantLanguageDetectionJob for more information on using the StartDominantLanguageDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartDominantLanguageDetectionJobRequest method. req, resp := client.StartDominantLanguageDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob
func (c *Comprehend) StartDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StartDominantLanguageDetectionJobInput, opts ...request.Option) (*StartDominantLanguageDetectionJobOutput, error)
StartDominantLanguageDetectionJobWithContext is the same as StartDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.
See StartDominantLanguageDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartEntitiesDetectionJob(input *StartEntitiesDetectionJobInput) (*StartEntitiesDetectionJobOutput, error)
StartEntitiesDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartEntitiesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob
func (c *Comprehend) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) (req *request.Request, output *StartEntitiesDetectionJobOutput)
StartEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartEntitiesDetectionJob for more information on using the StartEntitiesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartEntitiesDetectionJobRequest method. req, resp := client.StartEntitiesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob
func (c *Comprehend) StartEntitiesDetectionJobWithContext(ctx aws.Context, input *StartEntitiesDetectionJobInput, opts ...request.Option) (*StartEntitiesDetectionJobOutput, error)
StartEntitiesDetectionJobWithContext is the same as StartEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.
See StartEntitiesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartEventsDetectionJob(input *StartEventsDetectionJobInput) (*StartEventsDetectionJobOutput, error)
StartEventsDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous event detection job for a collection of documents.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartEventsDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob
func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJobInput) (req *request.Request, output *StartEventsDetectionJobOutput)
StartEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartEventsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartEventsDetectionJob for more information on using the StartEventsDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartEventsDetectionJobRequest method. req, resp := client.StartEventsDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob
func (c *Comprehend) StartEventsDetectionJobWithContext(ctx aws.Context, input *StartEventsDetectionJobInput, opts ...request.Option) (*StartEventsDetectionJobOutput, error)
StartEventsDetectionJobWithContext is the same as StartEventsDetectionJob with the addition of the ability to pass a context and additional request options.
See StartEventsDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartKeyPhrasesDetectionJob(input *StartKeyPhrasesDetectionJobInput) (*StartKeyPhrasesDetectionJobOutput, error)
StartKeyPhrasesDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartKeyPhrasesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob
func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) (req *request.Request, output *StartKeyPhrasesDetectionJobOutput)
StartKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartKeyPhrasesDetectionJob for more information on using the StartKeyPhrasesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartKeyPhrasesDetectionJobRequest method. req, resp := client.StartKeyPhrasesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob
func (c *Comprehend) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StartKeyPhrasesDetectionJobInput, opts ...request.Option) (*StartKeyPhrasesDetectionJobOutput, error)
StartKeyPhrasesDetectionJobWithContext is the same as StartKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.
See StartKeyPhrasesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartPiiEntitiesDetectionJob(input *StartPiiEntitiesDetectionJobInput) (*StartPiiEntitiesDetectionJobOutput, error)
StartPiiEntitiesDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous PII entity detection job for a collection of documents.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartPiiEntitiesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob
func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntitiesDetectionJobInput) (req *request.Request, output *StartPiiEntitiesDetectionJobOutput)
StartPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartPiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartPiiEntitiesDetectionJob for more information on using the StartPiiEntitiesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartPiiEntitiesDetectionJobRequest method. req, resp := client.StartPiiEntitiesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob
func (c *Comprehend) StartPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StartPiiEntitiesDetectionJobInput, opts ...request.Option) (*StartPiiEntitiesDetectionJobOutput, error)
StartPiiEntitiesDetectionJobWithContext is the same as StartPiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.
See StartPiiEntitiesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error)
StartSentimentDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartSentimentDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob
func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput)
StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartSentimentDetectionJobRequest method. req, resp := client.StartSentimentDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob
func (c *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error)
StartSentimentDetectionJobWithContext is the same as StartSentimentDetectionJob with the addition of the ability to pass a context and additional request options.
See StartSentimentDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartTargetedSentimentDetectionJob(input *StartTargetedSentimentDetectionJobInput) (*StartTargetedSentimentDetectionJobOutput, error)
StartTargetedSentimentDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartTargetedSentimentDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob
func (c *Comprehend) StartTargetedSentimentDetectionJobRequest(input *StartTargetedSentimentDetectionJobInput) (req *request.Request, output *StartTargetedSentimentDetectionJobOutput)
StartTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTargetedSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartTargetedSentimentDetectionJob for more information on using the StartTargetedSentimentDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartTargetedSentimentDetectionJobRequest method. req, resp := client.StartTargetedSentimentDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob
func (c *Comprehend) StartTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StartTargetedSentimentDetectionJobInput, opts ...request.Option) (*StartTargetedSentimentDetectionJobOutput, error)
StartTargetedSentimentDetectionJobWithContext is the same as StartTargetedSentimentDetectionJob with the addition of the ability to pass a context and additional request options.
See StartTargetedSentimentDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error)
StartTopicsDetectionJob API operation for Amazon Comprehend.
Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StartTopicsDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob
func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput)
StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartTopicsDetectionJobRequest method. req, resp := client.StartTopicsDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob
func (c *Comprehend) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error)
StartTopicsDetectionJobWithContext is the same as StartTopicsDetectionJob with the addition of the ability to pass a context and additional request options.
See StartTopicsDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopDominantLanguageDetectionJob(input *StopDominantLanguageDetectionJobInput) (*StopDominantLanguageDetectionJobOutput, error)
StopDominantLanguageDetectionJob API operation for Amazon Comprehend.
Stops a dominant language detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopDominantLanguageDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob
func (c *Comprehend) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) (req *request.Request, output *StopDominantLanguageDetectionJobOutput)
StopDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopDominantLanguageDetectionJob for more information on using the StopDominantLanguageDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopDominantLanguageDetectionJobRequest method. req, resp := client.StopDominantLanguageDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob
func (c *Comprehend) StopDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StopDominantLanguageDetectionJobInput, opts ...request.Option) (*StopDominantLanguageDetectionJobOutput, error)
StopDominantLanguageDetectionJobWithContext is the same as StopDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.
See StopDominantLanguageDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopEntitiesDetectionJob(input *StopEntitiesDetectionJobInput) (*StopEntitiesDetectionJobOutput, error)
StopEntitiesDetectionJob API operation for Amazon Comprehend.
Stops an entities detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopEntitiesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob
func (c *Comprehend) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) (req *request.Request, output *StopEntitiesDetectionJobOutput)
StopEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopEntitiesDetectionJob for more information on using the StopEntitiesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopEntitiesDetectionJobRequest method. req, resp := client.StopEntitiesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob
func (c *Comprehend) StopEntitiesDetectionJobWithContext(ctx aws.Context, input *StopEntitiesDetectionJobInput, opts ...request.Option) (*StopEntitiesDetectionJobOutput, error)
StopEntitiesDetectionJobWithContext is the same as StopEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.
See StopEntitiesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopEventsDetectionJob(input *StopEventsDetectionJobInput) (*StopEventsDetectionJobOutput, error)
StopEventsDetectionJob API operation for Amazon Comprehend.
Stops an events detection job in progress.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopEventsDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob
func (c *Comprehend) StopEventsDetectionJobRequest(input *StopEventsDetectionJobInput) (req *request.Request, output *StopEventsDetectionJobOutput)
StopEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopEventsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopEventsDetectionJob for more information on using the StopEventsDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopEventsDetectionJobRequest method. req, resp := client.StopEventsDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob
func (c *Comprehend) StopEventsDetectionJobWithContext(ctx aws.Context, input *StopEventsDetectionJobInput, opts ...request.Option) (*StopEventsDetectionJobOutput, error)
StopEventsDetectionJobWithContext is the same as StopEventsDetectionJob with the addition of the ability to pass a context and additional request options.
See StopEventsDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopKeyPhrasesDetectionJob(input *StopKeyPhrasesDetectionJobInput) (*StopKeyPhrasesDetectionJobOutput, error)
StopKeyPhrasesDetectionJob API operation for Amazon Comprehend.
Stops a key phrases detection job in progress.
If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopKeyPhrasesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob
func (c *Comprehend) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) (req *request.Request, output *StopKeyPhrasesDetectionJobOutput)
StopKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopKeyPhrasesDetectionJob for more information on using the StopKeyPhrasesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopKeyPhrasesDetectionJobRequest method. req, resp := client.StopKeyPhrasesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob
func (c *Comprehend) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StopKeyPhrasesDetectionJobInput, opts ...request.Option) (*StopKeyPhrasesDetectionJobOutput, error)
StopKeyPhrasesDetectionJobWithContext is the same as StopKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.
See StopKeyPhrasesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopPiiEntitiesDetectionJob(input *StopPiiEntitiesDetectionJobInput) (*StopPiiEntitiesDetectionJobOutput, error)
StopPiiEntitiesDetectionJob API operation for Amazon Comprehend.
Stops a PII entities detection job in progress.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopPiiEntitiesDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob
func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDetectionJobInput) (req *request.Request, output *StopPiiEntitiesDetectionJobOutput)
StopPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopPiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopPiiEntitiesDetectionJob for more information on using the StopPiiEntitiesDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopPiiEntitiesDetectionJobRequest method. req, resp := client.StopPiiEntitiesDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob
func (c *Comprehend) StopPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StopPiiEntitiesDetectionJobInput, opts ...request.Option) (*StopPiiEntitiesDetectionJobOutput, error)
StopPiiEntitiesDetectionJobWithContext is the same as StopPiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.
See StopPiiEntitiesDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopSentimentDetectionJob(input *StopSentimentDetectionJobInput) (*StopSentimentDetectionJobOutput, error)
StopSentimentDetectionJob API operation for Amazon Comprehend.
Stops a sentiment detection job in progress.
If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopSentimentDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob
func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) (req *request.Request, output *StopSentimentDetectionJobOutput)
StopSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopSentimentDetectionJob for more information on using the StopSentimentDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopSentimentDetectionJobRequest method. req, resp := client.StopSentimentDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob
func (c *Comprehend) StopSentimentDetectionJobWithContext(ctx aws.Context, input *StopSentimentDetectionJobInput, opts ...request.Option) (*StopSentimentDetectionJobOutput, error)
StopSentimentDetectionJobWithContext is the same as StopSentimentDetectionJob with the addition of the ability to pass a context and additional request options.
See StopSentimentDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopTargetedSentimentDetectionJob(input *StopTargetedSentimentDetectionJobInput) (*StopTargetedSentimentDetectionJobOutput, error)
StopTargetedSentimentDetectionJob API operation for Amazon Comprehend.
Stops a targeted sentiment detection job in progress.
If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.
When a job is stopped, any documents already processed are written to the output location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopTargetedSentimentDetectionJob for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob
func (c *Comprehend) StopTargetedSentimentDetectionJobRequest(input *StopTargetedSentimentDetectionJobInput) (req *request.Request, output *StopTargetedSentimentDetectionJobOutput)
StopTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopTargetedSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopTargetedSentimentDetectionJob for more information on using the StopTargetedSentimentDetectionJob API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopTargetedSentimentDetectionJobRequest method. req, resp := client.StopTargetedSentimentDetectionJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob
func (c *Comprehend) StopTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StopTargetedSentimentDetectionJobInput, opts ...request.Option) (*StopTargetedSentimentDetectionJobOutput, error)
StopTargetedSentimentDetectionJobWithContext is the same as StopTargetedSentimentDetectionJob with the addition of the ability to pass a context and additional request options.
See StopTargetedSentimentDetectionJob for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopTrainingDocumentClassifier(input *StopTrainingDocumentClassifierInput) (*StopTrainingDocumentClassifierOutput, error)
StopTrainingDocumentClassifier API operation for Amazon Comprehend.
Stops a document classifier training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopTrainingDocumentClassifier for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier
func (c *Comprehend) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) (req *request.Request, output *StopTrainingDocumentClassifierOutput)
StopTrainingDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the StopTrainingDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopTrainingDocumentClassifier for more information on using the StopTrainingDocumentClassifier API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopTrainingDocumentClassifierRequest method. req, resp := client.StopTrainingDocumentClassifierRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier
func (c *Comprehend) StopTrainingDocumentClassifierWithContext(ctx aws.Context, input *StopTrainingDocumentClassifierInput, opts ...request.Option) (*StopTrainingDocumentClassifierOutput, error)
StopTrainingDocumentClassifierWithContext is the same as StopTrainingDocumentClassifier with the addition of the ability to pass a context and additional request options.
See StopTrainingDocumentClassifier for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) StopTrainingEntityRecognizer(input *StopTrainingEntityRecognizerInput) (*StopTrainingEntityRecognizerOutput, error)
StopTrainingEntityRecognizer API operation for Amazon Comprehend.
Stops an entity recognizer training job while in progress.
If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation StopTrainingEntityRecognizer for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer
func (c *Comprehend) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) (req *request.Request, output *StopTrainingEntityRecognizerOutput)
StopTrainingEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the StopTrainingEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopTrainingEntityRecognizer for more information on using the StopTrainingEntityRecognizer API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopTrainingEntityRecognizerRequest method. req, resp := client.StopTrainingEntityRecognizerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer
func (c *Comprehend) StopTrainingEntityRecognizerWithContext(ctx aws.Context, input *StopTrainingEntityRecognizerInput, opts ...request.Option) (*StopTrainingEntityRecognizerOutput, error)
StopTrainingEntityRecognizerWithContext is the same as StopTrainingEntityRecognizer with the addition of the ability to pass a context and additional request options.
See StopTrainingEntityRecognizer for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for Amazon Comprehend.
Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation TagResource for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResource
func (c *Comprehend) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagResource for more information on using the TagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResource
func (c *Comprehend) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for Amazon Comprehend.
Removes a specific tag associated with an Amazon Comprehend resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation UntagResource for usage and error information.
Returned Error Types:
TooManyTagKeysException The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
InvalidRequestException The request is invalid.
ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResource
func (c *Comprehend) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagResource for more information on using the UntagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResource
func (c *Comprehend) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *Comprehend) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error)
UpdateEndpoint API operation for Amazon Comprehend.
Updates information about the specified endpoint. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Comprehend's API operation UpdateEndpoint for usage and error information.
Returned Error Types:
InvalidRequestException The request is invalid.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
InternalServerException An internal server error occurred. Retry your request.
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint
func (c *Comprehend) UpdateEndpointRequest(input *UpdateEndpointInput) (req *request.Request, output *UpdateEndpointOutput)
UpdateEndpointRequest generates a "aws/request.Request" representing the client's request for the UpdateEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateEndpoint for more information on using the UpdateEndpoint API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateEndpointRequest method. req, resp := client.UpdateEndpointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint
func (c *Comprehend) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error)
UpdateEndpointWithContext is the same as UpdateEndpoint with the addition of the ability to pass a context and additional request options.
See UpdateEndpoint for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type ConcurrentModificationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" min:"1" type:"string"` // contains filtered or unexported fields }
Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.
func (s *ConcurrentModificationException) Code() string
Code returns the exception type name.
func (s *ConcurrentModificationException) Error() string
func (s ConcurrentModificationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConcurrentModificationException) Message() string
Message returns the exception's message.
func (s *ConcurrentModificationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConcurrentModificationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConcurrentModificationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConcurrentModificationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ContainsPiiEntitiesInput struct { // The language of the input documents. Currently, English is the only valid // language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A UTF-8 text string. The maximum string size is 100 KB. // // Text is a required field Text *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ContainsPiiEntitiesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ContainsPiiEntitiesInput) SetLanguageCode(v string) *ContainsPiiEntitiesInput
SetLanguageCode sets the LanguageCode field's value.
func (s *ContainsPiiEntitiesInput) SetText(v string) *ContainsPiiEntitiesInput
SetText sets the Text field's value.
func (s ContainsPiiEntitiesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ContainsPiiEntitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ContainsPiiEntitiesOutput struct { // The labels used in the document being analyzed. Individual labels represent // personally identifiable information (PII) entity types. Labels []*EntityLabel `type:"list"` // contains filtered or unexported fields }
func (s ContainsPiiEntitiesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ContainsPiiEntitiesOutput) SetLabels(v []*EntityLabel) *ContainsPiiEntitiesOutput
SetLabels sets the Labels field's value.
func (s ContainsPiiEntitiesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateDocumentClassifierInput struct { // A unique identifier for the request. If you don't set the client request // token, Amazon Comprehend generates one. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role // that grants Amazon Comprehend read access to your input data. // // DataAccessRoleArn is a required field DataAccessRoleArn *string `min:"20" type:"string" required:"true"` // The name of the document classifier. // // DocumentClassifierName is a required field DocumentClassifierName *string `type:"string" required:"true"` // Specifies the format and location of the input data for the job. // // InputDataConfig is a required field InputDataConfig *DocumentClassifierInputDataConfig `type:"structure" required:"true"` // The language of the input documents. You can specify any of the following // languages supported by Amazon Comprehend: German ("de"), English ("en"), // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All // documents must be in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // Indicates the mode in which the classifier will be trained. The classifier // can be trained in multi-class mode, which identifies one and only one class // for each document, or multi-label mode, which identifies one or more labels // for each document. In multi-label mode, multiple labels for an individual // document are separated by a delimiter. The default delimiter between labels // is a pipe (|). Mode *string `type:"string" enum:"DocumentClassifierMode"` // 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 `type:"string"` // The resource-based policy to attach to your custom document classifier model. // You can use this policy to allow another AWS account to import your custom // model. // // Provide your policy as a JSON body that you enter as a UTF-8 encoded string // without line breaks. To provide valid JSON, enclose the attribute names and // values in double quotes. If the JSON body is also enclosed in double quotes, // then you must escape the double quotes that are inside the policy: // // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" // // To avoid escaping quotes, you can use single quotes to enclose the policy // and double quotes to enclose the JSON names and values: // // '{"attribute": "value", "attribute": ["value"]}' ModelPolicy *string `min:"1" type:"string"` // Enables the addition of output results configuration parameters for custom // classifier jobs. OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"` // Tags to be associated with the document classifier being created. A tag is // a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. // For example, a tag with "Sales" as the key might be added to a resource to // indicate its use by the sales department. Tags []*Tag `type:"list"` // The version name given to the newly created classifier. Version names can // have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and // underscores (_) are allowed. The version name must be unique among all models // with the same classifier name in the account/AWS Region. VersionName *string `type:"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 `type:"string"` // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your custom classifier. For more // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *VpcConfig `type:"structure"` // contains filtered or unexported fields }
func (s CreateDocumentClassifierInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDocumentClassifierInput) SetClientRequestToken(v string) *CreateDocumentClassifierInput
SetClientRequestToken sets the ClientRequestToken field's value.
func (s *CreateDocumentClassifierInput) SetDataAccessRoleArn(v string) *CreateDocumentClassifierInput
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *CreateDocumentClassifierInput) SetDocumentClassifierName(v string) *CreateDocumentClassifierInput
SetDocumentClassifierName sets the DocumentClassifierName field's value.
func (s *CreateDocumentClassifierInput) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *CreateDocumentClassifierInput
SetInputDataConfig sets the InputDataConfig field's value.
func (s *CreateDocumentClassifierInput) SetLanguageCode(v string) *CreateDocumentClassifierInput
SetLanguageCode sets the LanguageCode field's value.
func (s *CreateDocumentClassifierInput) SetMode(v string) *CreateDocumentClassifierInput
SetMode sets the Mode field's value.
func (s *CreateDocumentClassifierInput) SetModelKmsKeyId(v string) *CreateDocumentClassifierInput
SetModelKmsKeyId sets the ModelKmsKeyId field's value.
func (s *CreateDocumentClassifierInput) SetModelPolicy(v string) *CreateDocumentClassifierInput
SetModelPolicy sets the ModelPolicy field's value.
func (s *CreateDocumentClassifierInput) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *CreateDocumentClassifierInput
SetOutputDataConfig sets the OutputDataConfig field's value.
func (s *CreateDocumentClassifierInput) SetTags(v []*Tag) *CreateDocumentClassifierInput
SetTags sets the Tags field's value.
func (s *CreateDocumentClassifierInput) SetVersionName(v string) *CreateDocumentClassifierInput
SetVersionName sets the VersionName field's value.
func (s *CreateDocumentClassifierInput) SetVolumeKmsKeyId(v string) *CreateDocumentClassifierInput
SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.
func (s *CreateDocumentClassifierInput) SetVpcConfig(v *VpcConfig) *CreateDocumentClassifierInput
SetVpcConfig sets the VpcConfig field's value.
func (s CreateDocumentClassifierInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDocumentClassifierInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDocumentClassifierOutput struct { // The Amazon Resource Name (ARN) that identifies the document classifier. DocumentClassifierArn *string `type:"string"` // contains filtered or unexported fields }
func (s CreateDocumentClassifierOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDocumentClassifierOutput) SetDocumentClassifierArn(v string) *CreateDocumentClassifierOutput
SetDocumentClassifierArn sets the DocumentClassifierArn field's value.
func (s CreateDocumentClassifierOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateEndpointInput struct { // An idempotency token provided by the customer. If this token matches a previous // endpoint creation request, Amazon Comprehend will not return a ResourceInUseException. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The Amazon Resource Name (ARN) of the 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 `min:"20" type:"string"` // The desired number of inference units to be used by the model using this // endpoint. Each inference unit represents of a throughput of 100 characters // per second. // // DesiredInferenceUnits is a required field DesiredInferenceUnits *int64 `min:"1" type:"integer" required:"true"` // This is the descriptive suffix that becomes part of the EndpointArn used // for all subsequent requests to this resource. // // EndpointName is a required field EndpointName *string `type:"string" required:"true"` // The Amazon Resource Number (ARN) of the model to which the endpoint will // be attached. // // ModelArn is a required field ModelArn *string `type:"string" required:"true"` // Tags associated with the endpoint being created. A tag is a key-value pair // that adds metadata to the endpoint. For example, a tag with "Sales" as the // key might be added to an endpoint to indicate its use by the sales department. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
func (s CreateEndpointInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEndpointInput) SetClientRequestToken(v string) *CreateEndpointInput
SetClientRequestToken sets the ClientRequestToken field's value.
func (s *CreateEndpointInput) SetDataAccessRoleArn(v string) *CreateEndpointInput
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *CreateEndpointInput) SetDesiredInferenceUnits(v int64) *CreateEndpointInput
SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value.
func (s *CreateEndpointInput) SetEndpointName(v string) *CreateEndpointInput
SetEndpointName sets the EndpointName field's value.
func (s *CreateEndpointInput) SetModelArn(v string) *CreateEndpointInput
SetModelArn sets the ModelArn field's value.
func (s *CreateEndpointInput) SetTags(v []*Tag) *CreateEndpointInput
SetTags sets the Tags field's value.
func (s CreateEndpointInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateEndpointOutput struct { // The Amazon Resource Number (ARN) of the endpoint being created. EndpointArn *string `type:"string"` // contains filtered or unexported fields }
func (s CreateEndpointOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEndpointOutput) SetEndpointArn(v string) *CreateEndpointOutput
SetEndpointArn sets the EndpointArn field's value.
func (s CreateEndpointOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateEntityRecognizerInput struct { // A unique identifier for the request. If you don't set the client request // token, Amazon Comprehend generates one. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role // that grants Amazon Comprehend read access to your input data. // // DataAccessRoleArn is a required field DataAccessRoleArn *string `min:"20" type:"string" required:"true"` // Specifies the format and location of the input data. The S3 bucket containing // the input data must be located in the same region as the entity recognizer // being created. // // InputDataConfig is a required field InputDataConfig *EntityRecognizerInputDataConfig `type:"structure" required:"true"` // You can specify any of the following languages: English ("en"), Spanish ("es"), // French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you // plan to use this entity recognizer with PDF, Word, or image input files, // you must specify English as the language. All training documents must be // in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // ID for the 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 `type:"string"` // The JSON resource-based policy to attach to your custom entity recognizer // model. You can use this policy to allow another AWS account to import your // custom model. // // Provide your JSON as a UTF-8 encoded string without line breaks. To provide // valid JSON for your policy, enclose the attribute names and values in double // quotes. If the JSON body is also enclosed in double quotes, then you must // escape the double quotes that are inside the policy: // // "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" // // To avoid escaping quotes, you can use single quotes to enclose the policy // and double quotes to enclose the JSON names and values: // // '{"attribute": "value", "attribute": ["value"]}' ModelPolicy *string `min:"1" type:"string"` // The name given to the newly created recognizer. Recognizer names can be a // maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores // (_) are allowed. The name must be unique in the account/region. // // RecognizerName is a required field RecognizerName *string `type:"string" required:"true"` // Tags to be associated with the entity recognizer being created. A tag is // a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. // For example, a tag with "Sales" as the key might be added to a resource to // indicate its use by the sales department. Tags []*Tag `type:"list"` // The version name given to the newly created recognizer. Version names can // be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and // underscores (_) are allowed. The version name must be unique among all models // with the same recognizer name in the account/ AWS Region. VersionName *string `type:"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 `type:"string"` // Configuration parameters for an optional private Virtual Private Cloud (VPC) // containing the resources you are using for your custom entity recognizer. // For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *VpcConfig `type:"structure"` // contains filtered or unexported fields }
func (s CreateEntityRecognizerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEntityRecognizerInput) SetClientRequestToken(v string) *CreateEntityRecognizerInput
SetClientRequestToken sets the ClientRequestToken field's value.
func (s *CreateEntityRecognizerInput) SetDataAccessRoleArn(v string) *CreateEntityRecognizerInput
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *CreateEntityRecognizerInput) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *CreateEntityRecognizerInput
SetInputDataConfig sets the InputDataConfig field's value.
func (s *CreateEntityRecognizerInput) SetLanguageCode(v string) *CreateEntityRecognizerInput
SetLanguageCode sets the LanguageCode field's value.
func (s *CreateEntityRecognizerInput) SetModelKmsKeyId(v string) *CreateEntityRecognizerInput
SetModelKmsKeyId sets the ModelKmsKeyId field's value.
func (s *CreateEntityRecognizerInput) SetModelPolicy(v string) *CreateEntityRecognizerInput
SetModelPolicy sets the ModelPolicy field's value.
func (s *CreateEntityRecognizerInput) SetRecognizerName(v string) *CreateEntityRecognizerInput
SetRecognizerName sets the RecognizerName field's value.
func (s *CreateEntityRecognizerInput) SetTags(v []*Tag) *CreateEntityRecognizerInput
SetTags sets the Tags field's value.
func (s *CreateEntityRecognizerInput) SetVersionName(v string) *CreateEntityRecognizerInput
SetVersionName sets the VersionName field's value.
func (s *CreateEntityRecognizerInput) SetVolumeKmsKeyId(v string) *CreateEntityRecognizerInput
SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.
func (s *CreateEntityRecognizerInput) SetVpcConfig(v *VpcConfig) *CreateEntityRecognizerInput
SetVpcConfig sets the VpcConfig field's value.
func (s CreateEntityRecognizerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEntityRecognizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateEntityRecognizerOutput struct { // The Amazon Resource Name (ARN) that identifies the entity recognizer. EntityRecognizerArn *string `type:"string"` // contains filtered or unexported fields }
func (s CreateEntityRecognizerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateEntityRecognizerOutput) SetEntityRecognizerArn(v string) *CreateEntityRecognizerOutput
SetEntityRecognizerArn sets the EntityRecognizerArn field's value.
func (s CreateEntityRecognizerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteDocumentClassifierInput struct { // The Amazon Resource Name (ARN) that identifies the document classifier. // // DocumentClassifierArn is a required field DocumentClassifierArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteDocumentClassifierInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDocumentClassifierInput) SetDocumentClassifierArn(v string) *DeleteDocumentClassifierInput
SetDocumentClassifierArn sets the DocumentClassifierArn field's value.
func (s DeleteDocumentClassifierInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDocumentClassifierInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDocumentClassifierOutput struct {
// contains filtered or unexported fields
}
func (s DeleteDocumentClassifierOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteDocumentClassifierOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteEndpointInput struct { // The Amazon Resource Number (ARN) of the endpoint being deleted. // // EndpointArn is a required field EndpointArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteEndpointInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteEndpointInput) SetEndpointArn(v string) *DeleteEndpointInput
SetEndpointArn sets the EndpointArn field's value.
func (s DeleteEndpointInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEndpointOutput struct {
// contains filtered or unexported fields
}
func (s DeleteEndpointOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteEndpointOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteEntityRecognizerInput struct { // The Amazon Resource Name (ARN) that identifies the entity recognizer. // // EntityRecognizerArn is a required field EntityRecognizerArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteEntityRecognizerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteEntityRecognizerInput) SetEntityRecognizerArn(v string) *DeleteEntityRecognizerInput
SetEntityRecognizerArn sets the EntityRecognizerArn field's value.
func (s DeleteEntityRecognizerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteEntityRecognizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEntityRecognizerOutput struct {
// contains filtered or unexported fields
}
func (s DeleteEntityRecognizerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteEntityRecognizerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteResourcePolicyInput struct { // The revision ID of the policy to delete. PolicyRevisionId *string `type:"string"` // The Amazon Resource Name (ARN) of the custom model version that has the policy // to delete. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteResourcePolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteResourcePolicyInput) SetPolicyRevisionId(v string) *DeleteResourcePolicyInput
SetPolicyRevisionId sets the PolicyRevisionId field's value.
func (s *DeleteResourcePolicyInput) SetResourceArn(v string) *DeleteResourcePolicyInput
SetResourceArn sets the ResourceArn field's value.
func (s DeleteResourcePolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteResourcePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteResourcePolicyOutput struct {
// contains filtered or unexported fields
}
func (s DeleteResourcePolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteResourcePolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDocumentClassificationJobInput struct { // The identifier that Amazon Comprehend generated for the job. The operation // returns this identifier in its response. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeDocumentClassificationJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDocumentClassificationJobInput) SetJobId(v string) *DescribeDocumentClassificationJobInput
SetJobId sets the JobId field's value.
func (s DescribeDocumentClassificationJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDocumentClassificationJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDocumentClassificationJobOutput struct { // An object that describes the properties associated with the document classification // job. DocumentClassificationJobProperties *DocumentClassificationJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeDocumentClassificationJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties(v *DocumentClassificationJobProperties) *DescribeDocumentClassificationJobOutput
SetDocumentClassificationJobProperties sets the DocumentClassificationJobProperties field's value.
func (s DescribeDocumentClassificationJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDocumentClassifierInput struct { // The Amazon Resource Name (ARN) that identifies the document classifier. The // operation returns this identifier in its response. // // DocumentClassifierArn is a required field DocumentClassifierArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeDocumentClassifierInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDocumentClassifierInput) SetDocumentClassifierArn(v string) *DescribeDocumentClassifierInput
SetDocumentClassifierArn sets the DocumentClassifierArn field's value.
func (s DescribeDocumentClassifierInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDocumentClassifierInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDocumentClassifierOutput struct { // An object that contains the properties associated with a document classifier. DocumentClassifierProperties *DocumentClassifierProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeDocumentClassifierOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDocumentClassifierOutput) SetDocumentClassifierProperties(v *DocumentClassifierProperties) *DescribeDocumentClassifierOutput
SetDocumentClassifierProperties sets the DocumentClassifierProperties field's value.
func (s DescribeDocumentClassifierOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDominantLanguageDetectionJobInput struct { // The identifier that Amazon Comprehend generated for the job. The operation // returns this identifier in its response. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeDominantLanguageDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDominantLanguageDetectionJobInput) SetJobId(v string) *DescribeDominantLanguageDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribeDominantLanguageDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDominantLanguageDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDominantLanguageDetectionJobOutput struct { // An object that contains the properties associated with a dominant language // detection job. DominantLanguageDetectionJobProperties *DominantLanguageDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeDominantLanguageDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties(v *DominantLanguageDetectionJobProperties) *DescribeDominantLanguageDetectionJobOutput
SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value.
func (s DescribeDominantLanguageDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeEndpointInput struct { // The Amazon Resource Number (ARN) of the endpoint being described. // // EndpointArn is a required field EndpointArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeEndpointInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEndpointInput) SetEndpointArn(v string) *DescribeEndpointInput
SetEndpointArn sets the EndpointArn field's value.
func (s DescribeEndpointInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeEndpointOutput struct { // Describes information associated with the specific endpoint. EndpointProperties *EndpointProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeEndpointOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEndpointOutput) SetEndpointProperties(v *EndpointProperties) *DescribeEndpointOutput
SetEndpointProperties sets the EndpointProperties field's value.
func (s DescribeEndpointOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeEntitiesDetectionJobInput struct { // The identifier that Amazon Comprehend generated for the job. The operation // returns this identifier in its response. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeEntitiesDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEntitiesDetectionJobInput) SetJobId(v string) *DescribeEntitiesDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribeEntitiesDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEntitiesDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeEntitiesDetectionJobOutput struct { // An object that contains the properties associated with an entities detection // job. EntitiesDetectionJobProperties *EntitiesDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeEntitiesDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties(v *EntitiesDetectionJobProperties) *DescribeEntitiesDetectionJobOutput
SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value.
func (s DescribeEntitiesDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeEntityRecognizerInput struct { // The Amazon Resource Name (ARN) that identifies the entity recognizer. // // EntityRecognizerArn is a required field EntityRecognizerArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeEntityRecognizerInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEntityRecognizerInput) SetEntityRecognizerArn(v string) *DescribeEntityRecognizerInput
SetEntityRecognizerArn sets the EntityRecognizerArn field's value.
func (s DescribeEntityRecognizerInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEntityRecognizerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeEntityRecognizerOutput struct { // Describes information associated with an entity recognizer. EntityRecognizerProperties *EntityRecognizerProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeEntityRecognizerOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEntityRecognizerOutput) SetEntityRecognizerProperties(v *EntityRecognizerProperties) *DescribeEntityRecognizerOutput
SetEntityRecognizerProperties sets the EntityRecognizerProperties field's value.
func (s DescribeEntityRecognizerOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeEventsDetectionJobInput struct { // The identifier of the events detection job. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeEventsDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEventsDetectionJobInput) SetJobId(v string) *DescribeEventsDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribeEventsDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEventsDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeEventsDetectionJobOutput struct { // An object that contains the properties associated with an event detection // job. EventsDetectionJobProperties *EventsDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeEventsDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeEventsDetectionJobOutput) SetEventsDetectionJobProperties(v *EventsDetectionJobProperties) *DescribeEventsDetectionJobOutput
SetEventsDetectionJobProperties sets the EventsDetectionJobProperties field's value.
func (s DescribeEventsDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeKeyPhrasesDetectionJobInput struct { // The identifier that Amazon Comprehend generated for the job. The operation // returns this identifier in its response. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeKeyPhrasesDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeKeyPhrasesDetectionJobInput) SetJobId(v string) *DescribeKeyPhrasesDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribeKeyPhrasesDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeKeyPhrasesDetectionJobOutput struct { // An object that contains the properties associated with a key phrases detection // job. KeyPhrasesDetectionJobProperties *KeyPhrasesDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeKeyPhrasesDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties(v *KeyPhrasesDetectionJobProperties) *DescribeKeyPhrasesDetectionJobOutput
SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value.
func (s DescribeKeyPhrasesDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribePiiEntitiesDetectionJobInput struct { // The identifier that Amazon Comprehend generated for the job. The operation // returns this identifier in its response. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribePiiEntitiesDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePiiEntitiesDetectionJobInput) SetJobId(v string) *DescribePiiEntitiesDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribePiiEntitiesDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePiiEntitiesDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribePiiEntitiesDetectionJobOutput struct { // Provides information about a PII entities detection job. PiiEntitiesDetectionJobProperties *PiiEntitiesDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribePiiEntitiesDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties(v *PiiEntitiesDetectionJobProperties) *DescribePiiEntitiesDetectionJobOutput
SetPiiEntitiesDetectionJobProperties sets the PiiEntitiesDetectionJobProperties field's value.
func (s DescribePiiEntitiesDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeResourcePolicyInput struct { // The Amazon Resource Name (ARN) of the custom model version that has the resource // policy. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeResourcePolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeResourcePolicyInput) SetResourceArn(v string) *DescribeResourcePolicyInput
SetResourceArn sets the ResourceArn field's value.
func (s DescribeResourcePolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeResourcePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeResourcePolicyOutput struct { // The time at which the policy was created. CreationTime *time.Time `type:"timestamp"` // The time at which the policy was last modified. LastModifiedTime *time.Time `type:"timestamp"` // The revision ID of the policy. Each time you modify a policy, Amazon Comprehend // assigns a new revision ID, and it deletes the prior version of the policy. PolicyRevisionId *string `type:"string"` // The JSON body of the resource-based policy. ResourcePolicy *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s DescribeResourcePolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeResourcePolicyOutput) SetCreationTime(v time.Time) *DescribeResourcePolicyOutput
SetCreationTime sets the CreationTime field's value.
func (s *DescribeResourcePolicyOutput) SetLastModifiedTime(v time.Time) *DescribeResourcePolicyOutput
SetLastModifiedTime sets the LastModifiedTime field's value.
func (s *DescribeResourcePolicyOutput) SetPolicyRevisionId(v string) *DescribeResourcePolicyOutput
SetPolicyRevisionId sets the PolicyRevisionId field's value.
func (s *DescribeResourcePolicyOutput) SetResourcePolicy(v string) *DescribeResourcePolicyOutput
SetResourcePolicy sets the ResourcePolicy field's value.
func (s DescribeResourcePolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeSentimentDetectionJobInput struct { // The identifier that Amazon Comprehend generated for the job. The operation // returns this identifier in its response. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeSentimentDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeSentimentDetectionJobInput) SetJobId(v string) *DescribeSentimentDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribeSentimentDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeSentimentDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeSentimentDetectionJobOutput struct { // An object that contains the properties associated with a sentiment detection // job. SentimentDetectionJobProperties *SentimentDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeSentimentDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties(v *SentimentDetectionJobProperties) *DescribeSentimentDetectionJobOutput
SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value.
func (s DescribeSentimentDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeTargetedSentimentDetectionJobInput struct { // The identifier that Amazon Comprehend generated for the job. The operation // returns this identifier in its response. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeTargetedSentimentDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTargetedSentimentDetectionJobInput) SetJobId(v string) *DescribeTargetedSentimentDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribeTargetedSentimentDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTargetedSentimentDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTargetedSentimentDetectionJobOutput struct { // An object that contains the properties associated with a targeted sentiment // detection job. TargetedSentimentDetectionJobProperties *TargetedSentimentDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeTargetedSentimentDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties(v *TargetedSentimentDetectionJobProperties) *DescribeTargetedSentimentDetectionJobOutput
SetTargetedSentimentDetectionJobProperties sets the TargetedSentimentDetectionJobProperties field's value.
func (s DescribeTargetedSentimentDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeTopicsDetectionJobInput struct { // The identifier assigned by the user to the detection job. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeTopicsDetectionJobInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTopicsDetectionJobInput) SetJobId(v string) *DescribeTopicsDetectionJobInput
SetJobId sets the JobId field's value.
func (s DescribeTopicsDetectionJobInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTopicsDetectionJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTopicsDetectionJobOutput struct { // The list of properties for the requested job. TopicsDetectionJobProperties *TopicsDetectionJobProperties `type:"structure"` // contains filtered or unexported fields }
func (s DescribeTopicsDetectionJobOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *TopicsDetectionJobProperties) *DescribeTopicsDetectionJobOutput
SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value.
func (s DescribeTopicsDetectionJobOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetectDominantLanguageInput struct { // A UTF-8 text string. The string must contain at least 20 characters. The // maximum string size is 100 KB. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectDominantLanguageInput's // String and GoString methods. // // Text is a required field Text *string `min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s DetectDominantLanguageInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectDominantLanguageInput) SetText(v string) *DetectDominantLanguageInput
SetText sets the Text field's value.
func (s DetectDominantLanguageInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectDominantLanguageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectDominantLanguageOutput struct { // The languages that Amazon Comprehend detected in the input text. For each // language, the response returns the RFC 5646 language code and the level of // confidence that Amazon Comprehend has in the accuracy of its inference. For // more information about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646) // on the IETF Tools web site. Languages []*DominantLanguage `type:"list"` // contains filtered or unexported fields }
func (s DetectDominantLanguageOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectDominantLanguageOutput) SetLanguages(v []*DominantLanguage) *DetectDominantLanguageOutput
SetLanguages sets the Languages field's value.
func (s DetectDominantLanguageOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetectEntitiesInput struct { // This field applies only when you use a custom entity recognition model that // was trained with PDF annotations. For other cases, enter your text input // in the Text field. // // Use the Bytes parameter to input a text, PDF, Word or image file. Using a // plain-text file in the Bytes parameter is equivelent to using the Text parameter // (the Entities field in the response is identical). // // You can also use the Bytes parameter to input an Amazon Textract DetectDocumentText // or AnalyzeDocument output file. // // Provide the input document as a sequence of base64-encoded bytes. If your // code uses an Amazon Web Services SDK to detect entities, the SDK may encode // the document file bytes for you. // // The maximum length of this field depends on the input document type. For // details, see Inputs for real-time custom analysis (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html) // in the Comprehend Developer Guide. // // If you use the Bytes parameter, do not use the Text parameter. // Bytes is automatically base64 encoded/decoded by the SDK. Bytes []byte `min:"1" type:"blob"` // Provides configuration parameters to override the default actions for extracting // text from PDF documents and image files. DocumentReaderConfig *DocumentReaderConfig `type:"structure"` // The Amazon Resource Name of an endpoint that is associated with a custom // entity recognition model. Provide an endpoint if you want to detect entities // by using your own custom model instead of the default model that is used // by Amazon Comprehend. // // If you specify an endpoint, Amazon Comprehend uses the language of your custom // model, and it ignores any language code that you provide in your request. // // For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html). EndpointArn *string `type:"string"` // The language of the input documents. You can specify any of the primary languages // supported by Amazon Comprehend. If your request includes the endpoint for // a custom entity recognition model, Amazon Comprehend uses the language of // your custom model, and it ignores any language code that you specify here. // // All input documents must be in the same language. LanguageCode *string `type:"string" enum:"LanguageCode"` // A UTF-8 text string. The maximum string size is 100 KB. If you enter text // using this parameter, do not use the Bytes parameter. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectEntitiesInput's // String and GoString methods. Text *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
func (s DetectEntitiesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectEntitiesInput) SetBytes(v []byte) *DetectEntitiesInput
SetBytes sets the Bytes field's value.
func (s *DetectEntitiesInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *DetectEntitiesInput
SetDocumentReaderConfig sets the DocumentReaderConfig field's value.
func (s *DetectEntitiesInput) SetEndpointArn(v string) *DetectEntitiesInput
SetEndpointArn sets the EndpointArn field's value.
func (s *DetectEntitiesInput) SetLanguageCode(v string) *DetectEntitiesInput
SetLanguageCode sets the LanguageCode field's value.
func (s *DetectEntitiesInput) SetText(v string) *DetectEntitiesInput
SetText sets the Text field's value.
func (s DetectEntitiesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectEntitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectEntitiesOutput struct { // Information about each block of text in the input document. Blocks are nested. // A page block contains a block for each line of text, which contains a block // for each word. // // The Block content for a Word input document does not include a Geometry field. // // The Block field is not present in the response for plain-text inputs. Blocks []*Block `type:"list"` // Information about the document, discovered during text extraction. This field // is present in the response only if your request used the Byte parameter. DocumentMetadata *DocumentMetadata `type:"structure"` // The document type for each page in the input document. This field is present // in the response only if your request used the Byte parameter. DocumentType []*DocumentTypeListItem `type:"list"` // A collection of entities identified in the input text. For each entity, the // response provides the entity text, entity type, where the entity text begins // and ends, and the level of confidence that Amazon Comprehend has in the detection. // // If your request uses a custom entity recognition model, Amazon Comprehend // detects the entities that the model is trained to recognize. Otherwise, it // detects the default entity types. For a list of default entity types, see // Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) // in the Comprehend Developer Guide. Entities []*Entity `type:"list"` // Page-level errors that the system detected while processing the input document. // The field is empty if the system encountered no errors. Errors []*ErrorsListItem `type:"list"` // contains filtered or unexported fields }
func (s DetectEntitiesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectEntitiesOutput) SetBlocks(v []*Block) *DetectEntitiesOutput
SetBlocks sets the Blocks field's value.
func (s *DetectEntitiesOutput) SetDocumentMetadata(v *DocumentMetadata) *DetectEntitiesOutput
SetDocumentMetadata sets the DocumentMetadata field's value.
func (s *DetectEntitiesOutput) SetDocumentType(v []*DocumentTypeListItem) *DetectEntitiesOutput
SetDocumentType sets the DocumentType field's value.
func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput
SetEntities sets the Entities field's value.
func (s *DetectEntitiesOutput) SetErrors(v []*ErrorsListItem) *DetectEntitiesOutput
SetErrors sets the Errors field's value.
func (s DetectEntitiesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetectKeyPhrasesInput struct { // The language of the input documents. You can specify any of the primary languages // supported by Amazon Comprehend. All documents must be in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded // characters. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectKeyPhrasesInput's // String and GoString methods. // // Text is a required field Text *string `min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s DetectKeyPhrasesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectKeyPhrasesInput) SetLanguageCode(v string) *DetectKeyPhrasesInput
SetLanguageCode sets the LanguageCode field's value.
func (s *DetectKeyPhrasesInput) SetText(v string) *DetectKeyPhrasesInput
SetText sets the Text field's value.
func (s DetectKeyPhrasesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectKeyPhrasesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectKeyPhrasesOutput struct { // A collection of key phrases that Amazon Comprehend identified in the input // text. For each key phrase, the response provides the text of the key phrase, // where the key phrase begins and ends, and the level of confidence that Amazon // Comprehend has in the accuracy of the detection. KeyPhrases []*KeyPhrase `type:"list"` // contains filtered or unexported fields }
func (s DetectKeyPhrasesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectKeyPhrasesOutput) SetKeyPhrases(v []*KeyPhrase) *DetectKeyPhrasesOutput
SetKeyPhrases sets the KeyPhrases field's value.
func (s DetectKeyPhrasesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetectPiiEntitiesInput struct { // The language of the input documents. Currently, English is the only valid // language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A UTF-8 text string. The maximum string size is 100 KB. // // Text is a required field Text *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DetectPiiEntitiesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectPiiEntitiesInput) SetLanguageCode(v string) *DetectPiiEntitiesInput
SetLanguageCode sets the LanguageCode field's value.
func (s *DetectPiiEntitiesInput) SetText(v string) *DetectPiiEntitiesInput
SetText sets the Text field's value.
func (s DetectPiiEntitiesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectPiiEntitiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectPiiEntitiesOutput struct { // A collection of PII entities identified in the input text. For each entity, // the response provides the entity type, where the entity text begins and ends, // and the level of confidence that Amazon Comprehend has in the detection. Entities []*PiiEntity `type:"list"` // contains filtered or unexported fields }
func (s DetectPiiEntitiesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectPiiEntitiesOutput) SetEntities(v []*PiiEntity) *DetectPiiEntitiesOutput
SetEntities sets the Entities field's value.
func (s DetectPiiEntitiesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetectSentimentInput struct { // The language of the input documents. You can specify any of the primary languages // supported by Amazon Comprehend. All documents must be in the same language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A UTF-8 text string. The maximum string size is 5 KB. // // Amazon Comprehend performs real-time sentiment analysis on the first 500 // characters of the input text and ignores any additional text in the input. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectSentimentInput's // String and GoString methods. // // Text is a required field Text *string `min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s DetectSentimentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput
SetLanguageCode sets the LanguageCode field's value.
func (s *DetectSentimentInput) SetText(v string) *DetectSentimentInput
SetText sets the Text field's value.
func (s DetectSentimentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectSentimentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectSentimentOutput struct { // The inferred sentiment that Amazon Comprehend has the highest level of confidence // in. Sentiment *string `type:"string" enum:"SentimentType"` // An object that lists the sentiments, and their corresponding confidence levels. SentimentScore *SentimentScore `type:"structure"` // contains filtered or unexported fields }
func (s DetectSentimentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput
SetSentiment sets the Sentiment field's value.
func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput
SetSentimentScore sets the SentimentScore field's value.
func (s DetectSentimentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetectSyntaxInput struct { // The language code of the input documents. You can specify any of the following // languages supported by Amazon Comprehend: German ("de"), English ("en"), // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` // A UTF-8 string. The maximum string size is 5 KB. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectSyntaxInput's // String and GoString methods. // // Text is a required field Text *string `min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s DetectSyntaxInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectSyntaxInput) SetLanguageCode(v string) *DetectSyntaxInput
SetLanguageCode sets the LanguageCode field's value.
func (s *DetectSyntaxInput) SetText(v string) *DetectSyntaxInput
SetText sets the Text field's value.
func (s DetectSyntaxInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectSyntaxInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectSyntaxOutput struct { // A collection of syntax tokens describing the text. For each token, the response // provides the text, the token type, where the text begins and ends, and the // level of confidence that Amazon Comprehend has that the token is correct. // For a list of token types, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) // in the Comprehend Developer Guide. SyntaxTokens []*SyntaxToken `type:"list"` // contains filtered or unexported fields }
func (s DetectSyntaxOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectSyntaxOutput) SetSyntaxTokens(v []*SyntaxToken) *DetectSyntaxOutput
SetSyntaxTokens sets the SyntaxTokens field's value.
func (s DetectSyntaxOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetectTargetedSentimentInput struct { // The language of the input documents. Currently, English is the only supported // language. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` // A UTF-8 text string. The maximum string length is 5 KB. // // Text is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DetectTargetedSentimentInput's // String and GoString methods. // // Text is a required field Text *string `min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (s DetectTargetedSentimentInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectTargetedSentimentInput) SetLanguageCode(v string) *DetectTargetedSentimentInput
SetLanguageCode sets the LanguageCode field's value.
func (s *DetectTargetedSentimentInput) SetText(v string) *DetectTargetedSentimentInput
SetText sets the Text field's value.
func (s DetectTargetedSentimentInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectTargetedSentimentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectTargetedSentimentOutput struct { // Targeted sentiment analysis for each of the entities identified in the input // text. Entities []*TargetedSentimentEntity `type:"list"` // contains filtered or unexported fields }
func (s DetectTargetedSentimentOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetectTargetedSentimentOutput) SetEntities(v []*TargetedSentimentEntity) *DetectTargetedSentimentOutput
SetEntities sets the Entities field's value.
func (s DetectTargetedSentimentOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentClass struct { // The name of the class. Name *string `min:"1" type:"string"` // Page number in the input document. This field is present in the response // only if your request includes the Byte parameter. Page *int64 `type:"integer"` // The confidence score that Amazon Comprehend has this class correctly attributed. Score *float64 `type:"float"` // contains filtered or unexported fields }
Specifies the class that categorizes the document being analyzed
func (s DocumentClass) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClass) SetName(v string) *DocumentClass
SetName sets the Name field's value.
func (s *DocumentClass) SetPage(v int64) *DocumentClass
SetPage sets the Page field's value.
func (s *DocumentClass) SetScore(v float64) *DocumentClass
SetScore sets the Score field's value.
func (s DocumentClass) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentClassificationJobFilter struct { // Filters on the name of the job. JobName *string `min:"1" type:"string"` // Filters the list based on job status. Returns only jobs with the specified // status. JobStatus *string `type:"string" enum:"JobStatus"` // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted after the specified time. Jobs are // returned in descending order, newest to oldest. SubmitTimeAfter *time.Time `type:"timestamp"` // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted before the specified time. Jobs are // returned in ascending order, oldest to newest. SubmitTimeBefore *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.
func (s DocumentClassificationJobFilter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassificationJobFilter) SetJobName(v string) *DocumentClassificationJobFilter
SetJobName sets the JobName field's value.
func (s *DocumentClassificationJobFilter) SetJobStatus(v string) *DocumentClassificationJobFilter
SetJobStatus sets the JobStatus field's value.
func (s *DocumentClassificationJobFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassificationJobFilter
SetSubmitTimeAfter sets the SubmitTimeAfter field's value.
func (s *DocumentClassificationJobFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassificationJobFilter
SetSubmitTimeBefore sets the SubmitTimeBefore field's value.
func (s DocumentClassificationJobFilter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassificationJobFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentClassificationJobProperties struct { // The Amazon Resource Name (ARN) of the AWS identity and Access Management // (IAM) role that grants Amazon Comprehend read access to your input data. DataAccessRoleArn *string `min:"20" type:"string"` // The Amazon Resource Name (ARN) that identifies the document classifier. DocumentClassifierArn *string `type:"string"` // The time that the document classification job completed. EndTime *time.Time `type:"timestamp"` // The input data configuration that you supplied when you created the document // classification job. InputDataConfig *InputDataConfig `type:"structure"` // The 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:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id> // // The following is an example job ARN: // // arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab JobArn *string `type:"string"` // The identifier assigned to the document classification job. JobId *string `min:"1" type:"string"` // The name that you assigned to the document classification job. JobName *string `min:"1" type:"string"` // The current status of the document classification job. If the status is FAILED, // the Message field shows the reason for the failure. JobStatus *string `type:"string" enum:"JobStatus"` // A description of the status of the job. Message *string `type:"string"` // The output data configuration that you supplied when you created the document // classification job. OutputDataConfig *OutputDataConfig `type:"structure"` // The time that the document classification job was submitted for processing. SubmitTime *time.Time `type:"timestamp"` // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses // to encrypt data on the storage volume attached to the ML compute instance(s) // that process the analysis job. The VolumeKmsKeyId can be either of the following // formats: // // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string `type:"string"` // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your document classification job. For more // information, see Amazon VPC (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *VpcConfig `type:"structure"` // contains filtered or unexported fields }
Provides information about a document classification job.
func (s DocumentClassificationJobProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassificationJobProperties) SetDataAccessRoleArn(v string) *DocumentClassificationJobProperties
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *DocumentClassificationJobProperties) SetDocumentClassifierArn(v string) *DocumentClassificationJobProperties
SetDocumentClassifierArn sets the DocumentClassifierArn field's value.
func (s *DocumentClassificationJobProperties) SetEndTime(v time.Time) *DocumentClassificationJobProperties
SetEndTime sets the EndTime field's value.
func (s *DocumentClassificationJobProperties) SetInputDataConfig(v *InputDataConfig) *DocumentClassificationJobProperties
SetInputDataConfig sets the InputDataConfig field's value.
func (s *DocumentClassificationJobProperties) SetJobArn(v string) *DocumentClassificationJobProperties
SetJobArn sets the JobArn field's value.
func (s *DocumentClassificationJobProperties) SetJobId(v string) *DocumentClassificationJobProperties
SetJobId sets the JobId field's value.
func (s *DocumentClassificationJobProperties) SetJobName(v string) *DocumentClassificationJobProperties
SetJobName sets the JobName field's value.
func (s *DocumentClassificationJobProperties) SetJobStatus(v string) *DocumentClassificationJobProperties
SetJobStatus sets the JobStatus field's value.
func (s *DocumentClassificationJobProperties) SetMessage(v string) *DocumentClassificationJobProperties
SetMessage sets the Message field's value.
func (s *DocumentClassificationJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DocumentClassificationJobProperties
SetOutputDataConfig sets the OutputDataConfig field's value.
func (s *DocumentClassificationJobProperties) SetSubmitTime(v time.Time) *DocumentClassificationJobProperties
SetSubmitTime sets the SubmitTime field's value.
func (s *DocumentClassificationJobProperties) SetVolumeKmsKeyId(v string) *DocumentClassificationJobProperties
SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.
func (s *DocumentClassificationJobProperties) SetVpcConfig(v *VpcConfig) *DocumentClassificationJobProperties
SetVpcConfig sets the VpcConfig field's value.
func (s DocumentClassificationJobProperties) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentClassifierFilter struct { // The name that you assigned to the document classifier DocumentClassifierName *string `type:"string"` // Filters the list of classifiers based on status. Status *string `type:"string" enum:"ModelStatus"` // Filters the list of classifiers based on the time that the classifier was // submitted for processing. Returns only classifiers submitted after the specified // time. Classifiers are returned in descending order, newest to oldest. SubmitTimeAfter *time.Time `type:"timestamp"` // Filters the list of classifiers based on the time that the classifier was // submitted for processing. Returns only classifiers submitted before the specified // time. Classifiers are returned in ascending order, oldest to newest. SubmitTimeBefore *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.
func (s DocumentClassifierFilter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassifierFilter) SetDocumentClassifierName(v string) *DocumentClassifierFilter
SetDocumentClassifierName sets the DocumentClassifierName field's value.
func (s *DocumentClassifierFilter) SetStatus(v string) *DocumentClassifierFilter
SetStatus sets the Status field's value.
func (s *DocumentClassifierFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassifierFilter
SetSubmitTimeAfter sets the SubmitTimeAfter field's value.
func (s *DocumentClassifierFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassifierFilter
SetSubmitTimeBefore sets the SubmitTimeBefore field's value.
func (s DocumentClassifierFilter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentClassifierInputDataConfig struct { // A list of augmented manifest files that provide training data for your custom // model. An augmented manifest file is a labeled dataset that is produced by // Amazon SageMaker Ground Truth. // // This parameter is required if you set DataFormat to AUGMENTED_MANIFEST. AugmentedManifests []*AugmentedManifestsListItem `type:"list"` // The format of your training data: // // * COMPREHEND_CSV: A two-column CSV file, where labels are provided in // the first column, and documents are provided in the second. If you use // this value, you must provide the S3Uri parameter in your request. // // * AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker // Ground Truth. This file is in JSON lines format. Each line is a complete // JSON object that contains a training document and its associated labels. // If you use this value, you must provide the AugmentedManifests parameter // in your request. // // If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the // default. DataFormat *string `type:"string" enum:"DocumentClassifierDataFormat"` // Indicates the delimiter used to separate each label for training a multi-label // classifier. The default delimiter between labels is a pipe (|). You can use // a different character as a delimiter (if it's an allowed character) by specifying // it under Delimiter for labels. If the training documents use a delimiter // other than the default or the delimiter you specify, the labels on that line // will be combined to make a single unique label, such as LABELLABELLABEL. LabelDelimiter *string `min:"1" type:"string"` // The Amazon S3 URI for the input data. The S3 bucket must be in the same region // as the API endpoint that you are calling. The URI can point to a single input // file or it can provide the prefix for a collection of input files. // // For example, if you use the URI S3://bucketName/prefix, if the prefix is // a single file, Amazon Comprehend uses that file as input. If more than one // file begins with the prefix, Amazon Comprehend uses all of them as input. // // This parameter is required if you set DataFormat to COMPREHEND_CSV. S3Uri *string `type:"string"` // 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 `type:"string"` // contains filtered or unexported fields }
The input properties for training a document classifier.
For more information on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in the Comprehend Developer Guide.
func (s DocumentClassifierInputDataConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassifierInputDataConfig) SetAugmentedManifests(v []*AugmentedManifestsListItem) *DocumentClassifierInputDataConfig
SetAugmentedManifests sets the AugmentedManifests field's value.
func (s *DocumentClassifierInputDataConfig) SetDataFormat(v string) *DocumentClassifierInputDataConfig
SetDataFormat sets the DataFormat field's value.
func (s *DocumentClassifierInputDataConfig) SetLabelDelimiter(v string) *DocumentClassifierInputDataConfig
SetLabelDelimiter sets the LabelDelimiter field's value.
func (s *DocumentClassifierInputDataConfig) SetS3Uri(v string) *DocumentClassifierInputDataConfig
SetS3Uri sets the S3Uri field's value.
func (s *DocumentClassifierInputDataConfig) SetTestS3Uri(v string) *DocumentClassifierInputDataConfig
SetTestS3Uri sets the TestS3Uri field's value.
func (s DocumentClassifierInputDataConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassifierInputDataConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentClassifierOutputDataConfig struct { // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses // to encrypt the output results from an analysis job. The KmsKeyId can be one // of the following formats: // // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" // // * KMS Key Alias: "alias/ExampleAlias" // // * ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" KmsKeyId *string `type:"string"` // When you use the OutputDataConfig object while creating a custom classifier, // you specify the Amazon S3 location where you want to write the confusion // matrix. The URI must be in the same region as the API endpoint that you are // calling. The location is used as the prefix for the actual location of this // output file. // // When the custom classifier job is finished, the service creates the output // file in a directory specific to the job. The S3Uri field contains the location // of the output file, called output.tar.gz. It is a compressed archive that // contains the confusion matrix. S3Uri *string `type:"string"` // contains filtered or unexported fields }
Provides output results configuration parameters for custom classifier jobs.
func (s DocumentClassifierOutputDataConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassifierOutputDataConfig) SetKmsKeyId(v string) *DocumentClassifierOutputDataConfig
SetKmsKeyId sets the KmsKeyId field's value.
func (s *DocumentClassifierOutputDataConfig) SetS3Uri(v string) *DocumentClassifierOutputDataConfig
SetS3Uri sets the S3Uri field's value.
func (s DocumentClassifierOutputDataConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type 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 is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DocumentClassifierProperties's // String and GoString methods. ClassifierMetadata *ClassifierMetadata `type:"structure" sensitive:"true"` // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role // that grants Amazon Comprehend read access to your input data. DataAccessRoleArn *string `min:"20" type:"string"` // The Amazon Resource Name (ARN) that identifies the document classifier. DocumentClassifierArn *string `type:"string"` // The time that training the document classifier completed. EndTime *time.Time `type:"timestamp"` // The input data configuration that you supplied when you created the document // classifier for training. InputDataConfig *DocumentClassifierInputDataConfig `type:"structure"` // The language code for the language of the documents that the classifier was // trained on. LanguageCode *string `type:"string" enum:"LanguageCode"` // Additional information about the status of the classifier. Message *string `type:"string"` // Indicates the mode in which the specific classifier was trained. This also // indicates the format of input documents and the format of the confusion matrix. // Each classifier can only be trained in one mode and this cannot be changed // once the classifier is trained. Mode *string `type:"string" enum:"DocumentClassifierMode"` // 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 `type:"string"` // Provides output results configuration parameters for custom classifier jobs. OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"` // 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 `type:"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 *string `type:"string" enum:"ModelStatus"` // The time that the document classifier was submitted for training. SubmitTime *time.Time `type:"timestamp"` // The time that training of the document classifier was completed. Indicates // the time when the training completes on documentation classifiers. You are // billed for the time interval between this time and the value of TrainingStartTime. TrainingEndTime *time.Time `type:"timestamp"` // Indicates the time when the training starts on documentation classifiers. // You are billed for the time interval between this time and the value of TrainingEndTime. TrainingStartTime *time.Time `type:"timestamp"` // The version name that you assigned to the document classifier. VersionName *string `type:"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 `type:"string"` // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your custom classifier. For more information, // see Amazon VPC (https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *VpcConfig `type:"structure"` // contains filtered or unexported fields }
Provides information about a document classifier.
func (s DocumentClassifierProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassifierProperties) SetClassifierMetadata(v *ClassifierMetadata) *DocumentClassifierProperties
SetClassifierMetadata sets the ClassifierMetadata field's value.
func (s *DocumentClassifierProperties) SetDataAccessRoleArn(v string) *DocumentClassifierProperties
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *DocumentClassifierProperties) SetDocumentClassifierArn(v string) *DocumentClassifierProperties
SetDocumentClassifierArn sets the DocumentClassifierArn field's value.
func (s *DocumentClassifierProperties) SetEndTime(v time.Time) *DocumentClassifierProperties
SetEndTime sets the EndTime field's value.
func (s *DocumentClassifierProperties) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *DocumentClassifierProperties
SetInputDataConfig sets the InputDataConfig field's value.
func (s *DocumentClassifierProperties) SetLanguageCode(v string) *DocumentClassifierProperties
SetLanguageCode sets the LanguageCode field's value.
func (s *DocumentClassifierProperties) SetMessage(v string) *DocumentClassifierProperties
SetMessage sets the Message field's value.
func (s *DocumentClassifierProperties) SetMode(v string) *DocumentClassifierProperties
SetMode sets the Mode field's value.
func (s *DocumentClassifierProperties) SetModelKmsKeyId(v string) *DocumentClassifierProperties
SetModelKmsKeyId sets the ModelKmsKeyId field's value.
func (s *DocumentClassifierProperties) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *DocumentClassifierProperties
SetOutputDataConfig sets the OutputDataConfig field's value.
func (s *DocumentClassifierProperties) SetSourceModelArn(v string) *DocumentClassifierProperties
SetSourceModelArn sets the SourceModelArn field's value.
func (s *DocumentClassifierProperties) SetStatus(v string) *DocumentClassifierProperties
SetStatus sets the Status field's value.
func (s *DocumentClassifierProperties) SetSubmitTime(v time.Time) *DocumentClassifierProperties
SetSubmitTime sets the SubmitTime field's value.
func (s *DocumentClassifierProperties) SetTrainingEndTime(v time.Time) *DocumentClassifierProperties
SetTrainingEndTime sets the TrainingEndTime field's value.
func (s *DocumentClassifierProperties) SetTrainingStartTime(v time.Time) *DocumentClassifierProperties
SetTrainingStartTime sets the TrainingStartTime field's value.
func (s *DocumentClassifierProperties) SetVersionName(v string) *DocumentClassifierProperties
SetVersionName sets the VersionName field's value.
func (s *DocumentClassifierProperties) SetVolumeKmsKeyId(v string) *DocumentClassifierProperties
SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.
func (s *DocumentClassifierProperties) SetVpcConfig(v *VpcConfig) *DocumentClassifierProperties
SetVpcConfig sets the VpcConfig field's value.
func (s DocumentClassifierProperties) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentClassifierSummary struct { // The name that you assigned the document classifier. DocumentClassifierName *string `type:"string"` // The time that the latest document classifier version was submitted for processing. LatestVersionCreatedAt *time.Time `type:"timestamp"` // The version name you assigned to the latest document classifier version. LatestVersionName *string `type:"string"` // Provides the status of the latest document classifier version. LatestVersionStatus *string `type:"string" enum:"ModelStatus"` // The number of versions you created. NumberOfVersions *int64 `type:"integer"` // contains filtered or unexported fields }
Describes information about a document classifier and its versions.
func (s DocumentClassifierSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentClassifierSummary) SetDocumentClassifierName(v string) *DocumentClassifierSummary
SetDocumentClassifierName sets the DocumentClassifierName field's value.
func (s *DocumentClassifierSummary) SetLatestVersionCreatedAt(v time.Time) *DocumentClassifierSummary
SetLatestVersionCreatedAt sets the LatestVersionCreatedAt field's value.
func (s *DocumentClassifierSummary) SetLatestVersionName(v string) *DocumentClassifierSummary
SetLatestVersionName sets the LatestVersionName field's value.
func (s *DocumentClassifierSummary) SetLatestVersionStatus(v string) *DocumentClassifierSummary
SetLatestVersionStatus sets the LatestVersionStatus field's value.
func (s *DocumentClassifierSummary) SetNumberOfVersions(v int64) *DocumentClassifierSummary
SetNumberOfVersions sets the NumberOfVersions field's value.
func (s DocumentClassifierSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentLabel struct { // The name of the label. Name *string `min:"1" type:"string"` // Page number where the label occurs. This field is present in the response // only if your request includes the Byte parameter. Page *int64 `type:"integer"` // The confidence score that Amazon Comprehend has this label correctly attributed. Score *float64 `type:"float"` // contains filtered or unexported fields }
Specifies one of the label or labels that categorize the document being analyzed.
func (s DocumentLabel) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentLabel) SetName(v string) *DocumentLabel
SetName sets the Name field's value.
func (s *DocumentLabel) SetPage(v int64) *DocumentLabel
SetPage sets the Page field's value.
func (s *DocumentLabel) SetScore(v float64) *DocumentLabel
SetScore sets the Score field's value.
func (s DocumentLabel) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentMetadata struct { // List of pages in the document, with the number of characters extracted from // each page. ExtractedCharacters []*ExtractedCharactersListItem `type:"list"` // Number of pages in the document. Pages *int64 `type:"integer"` // contains filtered or unexported fields }
Information about the document, discovered during text extraction.
func (s DocumentMetadata) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentMetadata) SetExtractedCharacters(v []*ExtractedCharactersListItem) *DocumentMetadata
SetExtractedCharacters sets the ExtractedCharacters field's value.
func (s *DocumentMetadata) SetPages(v int64) *DocumentMetadata
SetPages sets the Pages field's value.
func (s DocumentMetadata) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DocumentReaderConfig struct { // This field defines the Amazon Textract API operation that Amazon Comprehend // uses to extract text from PDF files and image files. Enter one of the following // values: // // * TEXTRACT_DETECT_DOCUMENT_TEXT - The Amazon Comprehend service uses the // DetectDocumentText API operation. // // * TEXTRACT_ANALYZE_DOCUMENT - The Amazon Comprehend service uses the AnalyzeDocument // API operation. // // DocumentReadAction is a required field DocumentReadAction *string `type:"string" required:"true" enum:"DocumentReadAction"` // Determines the text extraction actions for PDF files. Enter one of the following // values: // // * SERVICE_DEFAULT - use the Amazon Comprehend service defaults for PDF // files. // // * FORCE_DOCUMENT_READ_ACTION - Amazon Comprehend uses the Textract API // specified by DocumentReadAction for all PDF files, including digital PDF // files. DocumentReadMode *string `type:"string" enum:"DocumentReadMode"` // Specifies the type of Amazon Textract features to apply. If you chose TEXTRACT_ANALYZE_DOCUMENT // as the read action, you must specify one or both of the following values: // // * TABLES - Returns information about any tables that are detected in the // input document. // // * FORMS - Returns information and the data from any forms that are detected // in the input document. FeatureTypes []*string `min:"1" type:"list" enum:"DocumentReadFeatureTypes"` // contains filtered or unexported fields }
Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
By default, Amazon Comprehend performs the following actions to extract text from files, based on the input file type:
Word files - Amazon Comprehend parser extracts the text.
Digital PDF files - Amazon Comprehend parser extracts the text.
Image files and scanned PDF files - Amazon Comprehend uses the Amazon Textract DetectDocumentText API to extract the text.
DocumentReaderConfig does not apply to plain text files or Word files.
For image files and PDF documents, you can override these default actions using the fields listed below. For more information, see Setting text extraction options (https://docs.aws.amazon.com/comprehend/latest/dg/detecting-cer.html#detecting-cer-pdf).
func (s DocumentReaderConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentReaderConfig) SetDocumentReadAction(v string) *DocumentReaderConfig
SetDocumentReadAction sets the DocumentReadAction field's value.
func (s *DocumentReaderConfig) SetDocumentReadMode(v string) *DocumentReaderConfig
SetDocumentReadMode sets the DocumentReadMode field's value.
func (s *DocumentReaderConfig) SetFeatureTypes(v []*string) *DocumentReaderConfig
SetFeatureTypes sets the FeatureTypes field's value.
func (s DocumentReaderConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentReaderConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DocumentTypeListItem struct { // Page number. Page *int64 `type:"integer"` // Document type. Type *string `type:"string" enum:"DocumentType"` // contains filtered or unexported fields }
Document type for each page in the document.
func (s DocumentTypeListItem) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DocumentTypeListItem) SetPage(v int64) *DocumentTypeListItem
SetPage sets the Page field's value.
func (s *DocumentTypeListItem) SetType(v string) *DocumentTypeListItem
SetType sets the Type field's value.
func (s DocumentTypeListItem) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DominantLanguage struct { // The RFC 5646 language code for the dominant language. For more information // about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646) // on the IETF Tools web site. LanguageCode *string `min:"1" type:"string"` // The level of confidence that Amazon Comprehend has in the accuracy of the // detection. Score *float64 `type:"float"` // contains filtered or unexported fields }
Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.
func (s DominantLanguage) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DominantLanguage) SetLanguageCode(v string) *DominantLanguage
SetLanguageCode sets the LanguageCode field's value.
func (s *DominantLanguage) SetScore(v float64) *DominantLanguage
SetScore sets the Score field's value.
func (s DominantLanguage) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DominantLanguageDetectionJobFilter struct { // Filters on the name of the job. JobName *string `min:"1" type:"string"` // Filters the list of jobs based on job status. Returns only jobs with the // specified status. JobStatus *string `type:"string" enum:"JobStatus"` // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted after the specified time. Jobs are // returned in descending order, newest to oldest. SubmitTimeAfter *time.Time `type:"timestamp"` // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted before the specified time. Jobs are // returned in ascending order, oldest to newest. SubmitTimeBefore *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
func (s DominantLanguageDetectionJobFilter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DominantLanguageDetectionJobFilter) SetJobName(v string) *DominantLanguageDetectionJobFilter
SetJobName sets the JobName field's value.
func (s *DominantLanguageDetectionJobFilter) SetJobStatus(v string) *DominantLanguageDetectionJobFilter
SetJobStatus sets the JobStatus field's value.
func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *DominantLanguageDetectionJobFilter
SetSubmitTimeAfter sets the SubmitTimeAfter field's value.
func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *DominantLanguageDetectionJobFilter
SetSubmitTimeBefore sets the SubmitTimeBefore field's value.
func (s DominantLanguageDetectionJobFilter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DominantLanguageDetectionJobFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DominantLanguageDetectionJobProperties struct { // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to // your input data. DataAccessRoleArn *string `min:"20" type:"string"` // The time that the dominant language detection job completed. EndTime *time.Time `type:"timestamp"` // The input data configuration that you supplied when you created the dominant // language detection job. InputDataConfig *InputDataConfig `type:"structure"` // The 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:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id> // // The following is an example job ARN: // // arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string `type:"string"` // The identifier assigned to the dominant language detection job. JobId *string `min:"1" type:"string"` // The name that you assigned to the dominant language detection job. JobName *string `min:"1" type:"string"` // The current status of the dominant language detection job. If the status // is FAILED, the Message field shows the reason for the failure. JobStatus *string `type:"string" enum:"JobStatus"` // A description for the status of a job. Message *string `type:"string"` // The output data configuration that you supplied when you created the dominant // language detection job. OutputDataConfig *OutputDataConfig `type:"structure"` // The time that the dominant language detection job was submitted for processing. SubmitTime *time.Time `type:"timestamp"` // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses // to encrypt data on the storage volume attached to the ML compute instance(s) // that process the analysis job. The VolumeKmsKeyId can be either of the following // formats: // // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string `type:"string"` // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your dominant language detection job. For // more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *VpcConfig `type:"structure"` // contains filtered or unexported fields }
Provides information about a dominant language detection job.
func (s DominantLanguageDetectionJobProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DominantLanguageDetectionJobProperties) SetDataAccessRoleArn(v string) *DominantLanguageDetectionJobProperties
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *DominantLanguageDetectionJobProperties) SetEndTime(v time.Time) *DominantLanguageDetectionJobProperties
SetEndTime sets the EndTime field's value.
func (s *DominantLanguageDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *DominantLanguageDetectionJobProperties
SetInputDataConfig sets the InputDataConfig field's value.
func (s *DominantLanguageDetectionJobProperties) SetJobArn(v string) *DominantLanguageDetectionJobProperties
SetJobArn sets the JobArn field's value.
func (s *DominantLanguageDetectionJobProperties) SetJobId(v string) *DominantLanguageDetectionJobProperties
SetJobId sets the JobId field's value.
func (s *DominantLanguageDetectionJobProperties) SetJobName(v string) *DominantLanguageDetectionJobProperties
SetJobName sets the JobName field's value.
func (s *DominantLanguageDetectionJobProperties) SetJobStatus(v string) *DominantLanguageDetectionJobProperties
SetJobStatus sets the JobStatus field's value.
func (s *DominantLanguageDetectionJobProperties) SetMessage(v string) *DominantLanguageDetectionJobProperties
SetMessage sets the Message field's value.
func (s *DominantLanguageDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DominantLanguageDetectionJobProperties
SetOutputDataConfig sets the OutputDataConfig field's value.
func (s *DominantLanguageDetectionJobProperties) SetSubmitTime(v time.Time) *DominantLanguageDetectionJobProperties
SetSubmitTime sets the SubmitTime field's value.
func (s *DominantLanguageDetectionJobProperties) SetVolumeKmsKeyId(v string) *DominantLanguageDetectionJobProperties
SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.
func (s *DominantLanguageDetectionJobProperties) SetVpcConfig(v *VpcConfig) *DominantLanguageDetectionJobProperties
SetVpcConfig sets the VpcConfig field's value.
func (s DominantLanguageDetectionJobProperties) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EndpointFilter struct { // Specifies a date after which the returned endpoint or endpoints were created. CreationTimeAfter *time.Time `type:"timestamp"` // Specifies a date before which the returned endpoint or endpoints were created. CreationTimeBefore *time.Time `type:"timestamp"` // The Amazon Resource Number (ARN) of the model to which the endpoint is attached. ModelArn *string `type:"string"` // Specifies the status of the endpoint being returned. Possible values are: // Creating, Ready, Updating, Deleting, Failed. Status *string `type:"string" enum:"EndpointStatus"` // contains filtered or unexported fields }
The filter used to determine which endpoints are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.
func (s EndpointFilter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EndpointFilter) SetCreationTimeAfter(v time.Time) *EndpointFilter
SetCreationTimeAfter sets the CreationTimeAfter field's value.
func (s *EndpointFilter) SetCreationTimeBefore(v time.Time) *EndpointFilter
SetCreationTimeBefore sets the CreationTimeBefore field's value.
func (s *EndpointFilter) SetModelArn(v string) *EndpointFilter
SetModelArn sets the ModelArn field's value.
func (s *EndpointFilter) SetStatus(v string) *EndpointFilter
SetStatus sets the Status field's value.
func (s EndpointFilter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EndpointProperties struct { // The creation date and time of the endpoint. CreationTime *time.Time `type:"timestamp"` // The number of inference units currently used by the model using this endpoint. CurrentInferenceUnits *int64 `min:"1" type:"integer"` // The 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 `min:"20" type:"string"` // Data access role ARN to use in case the new model is encrypted with a customer // KMS key. DesiredDataAccessRoleArn *string `min:"20" type:"string"` // The desired number of inference units to be used by the model using this // endpoint. Each inference unit represents of a throughput of 100 characters // per second. DesiredInferenceUnits *int64 `min:"1" type:"integer"` // 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 `type:"string"` // The Amazon Resource Number (ARN) of the endpoint. EndpointArn *string `type:"string"` // The date and time that the endpoint was last modified. LastModifiedTime *time.Time `type:"timestamp"` // Specifies a reason for failure in cases of Failed status. Message *string `type:"string"` // The Amazon Resource Number (ARN) of the model to which the endpoint is attached. ModelArn *string `type:"string"` // Specifies the status of the endpoint. Because the endpoint updates and creation // are asynchronous, so customers will need to wait for the endpoint to be Ready // status before making inference requests. Status *string `type:"string" enum:"EndpointStatus"` // contains filtered or unexported fields }
Specifies information about the specified endpoint. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).
func (s EndpointProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EndpointProperties) SetCreationTime(v time.Time) *EndpointProperties
SetCreationTime sets the CreationTime field's value.
func (s *EndpointProperties) SetCurrentInferenceUnits(v int64) *EndpointProperties
SetCurrentInferenceUnits sets the CurrentInferenceUnits field's value.
func (s *EndpointProperties) SetDataAccessRoleArn(v string) *EndpointProperties
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *EndpointProperties) SetDesiredDataAccessRoleArn(v string) *EndpointProperties
SetDesiredDataAccessRoleArn sets the DesiredDataAccessRoleArn field's value.
func (s *EndpointProperties) SetDesiredInferenceUnits(v int64) *EndpointProperties
SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value.
func (s *EndpointProperties) SetDesiredModelArn(v string) *EndpointProperties
SetDesiredModelArn sets the DesiredModelArn field's value.
func (s *EndpointProperties) SetEndpointArn(v string) *EndpointProperties
SetEndpointArn sets the EndpointArn field's value.
func (s *EndpointProperties) SetLastModifiedTime(v time.Time) *EndpointProperties
SetLastModifiedTime sets the LastModifiedTime field's value.
func (s *EndpointProperties) SetMessage(v string) *EndpointProperties
SetMessage sets the Message field's value.
func (s *EndpointProperties) SetModelArn(v string) *EndpointProperties
SetModelArn sets the ModelArn field's value.
func (s *EndpointProperties) SetStatus(v string) *EndpointProperties
SetStatus sets the Status field's value.
func (s EndpointProperties) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EntitiesDetectionJobFilter struct { // Filters on the name of the job. JobName *string `min:"1" type:"string"` // Filters the list of jobs based on job status. Returns only jobs with the // specified status. JobStatus *string `type:"string" enum:"JobStatus"` // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted after the specified time. Jobs are // returned in descending order, newest to oldest. SubmitTimeAfter *time.Time `type:"timestamp"` // Filters the list of jobs based on the time that the job was submitted for // processing. Returns only jobs submitted before the specified time. Jobs are // returned in ascending order, oldest to newest. SubmitTimeBefore *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.
func (s EntitiesDetectionJobFilter) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EntitiesDetectionJobFilter) SetJobName(v string) *EntitiesDetectionJobFilter
SetJobName sets the JobName field's value.
func (s *EntitiesDetectionJobFilter) SetJobStatus(v string) *EntitiesDetectionJobFilter
SetJobStatus sets the JobStatus field's value.
func (s *EntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *EntitiesDetectionJobFilter
SetSubmitTimeAfter sets the SubmitTimeAfter field's value.
func (s *EntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *EntitiesDetectionJobFilter
SetSubmitTimeBefore sets the SubmitTimeBefore field's value.
func (s EntitiesDetectionJobFilter) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EntitiesDetectionJobFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EntitiesDetectionJobProperties struct { // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to // your input data. DataAccessRoleArn *string `min:"20" type:"string"` // The time that the entities detection job completed EndTime *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) that identifies the entity recognizer. EntityRecognizerArn *string `type:"string"` // The input data configuration that you supplied when you created the entities // detection job. InputDataConfig *InputDataConfig `type:"structure"` // The 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:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id> // // The following is an example job ARN: // // arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab JobArn *string `type:"string"` // The identifier assigned to the entities detection job. JobId *string `min:"1" type:"string"` // The name that you assigned the entities detection job. JobName *string `min:"1" type:"string"` // The current status of the entities detection job. If the status is FAILED, // the Message field shows the reason for the failure. JobStatus *string `type:"string" enum:"JobStatus"` // The language code of the input documents. LanguageCode *string `type:"string" enum:"LanguageCode"` // A description of the status of a job. Message *string `type:"string"` // The output data configuration that you supplied when you created the entities // detection job. OutputDataConfig *OutputDataConfig `type:"structure"` // The time that the entities detection job was submitted for processing. SubmitTime *time.Time `type:"timestamp"` // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses // to encrypt data on the storage volume attached to the ML compute instance(s) // that process the analysis job. The VolumeKmsKeyId can be either of the following // formats: // // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" // // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" VolumeKmsKeyId *string `type:"string"` // Configuration parameters for a private Virtual Private Cloud (VPC) containing // the resources you are using for your entity detection job. For more information, // see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). VpcConfig *VpcConfig `type:"structure"` // contains filtered or unexported fields }
Provides information about an entities detection job.
func (s EntitiesDetectionJobProperties) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EntitiesDetectionJobProperties) SetDataAccessRoleArn(v string) *EntitiesDetectionJobProperties
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *EntitiesDetectionJobProperties) SetEndTime(v time.Time) *EntitiesDetectionJobProperties
SetEndTime sets the EndTime field's value.
func (s *EntitiesDetectionJobProperties) SetEntityRecognizerArn(v string) *EntitiesDetectionJobProperties
SetEntityRecognizerArn sets the EntityRecognizerArn field's value.
func (s *EntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *EntitiesDetectionJobProperties
SetInputDataConfig sets the InputDataConfig field's value.
func (s *EntitiesDetectionJobProperties) SetJobArn(v string) *EntitiesDetectionJobProperties
SetJobArn sets the JobArn field's value.
func (s *EntitiesDetectionJobProperties) SetJobId(v string) *EntitiesDetectionJobProperties
SetJobId sets the JobId field's value.
func (s *EntitiesDetectionJobProperties) SetJobName(v string) *EntitiesDetectionJobProperties
SetJobName sets the JobName field's value.
func (s *EntitiesDetectionJobProperties) SetJobStatus(v string) *EntitiesDetectionJobProperties
SetJobStatus sets the JobStatus field's value.
func (s *EntitiesDetectionJobProperties) SetLanguageCode(v string) *EntitiesDetectionJobProperties
SetLanguageCode sets the LanguageCode field's value.
func (s *EntitiesDetectionJobProperties) SetMessage(v string) *EntitiesDetectionJobProperties
SetMessage sets the Message field's value.
func (s *EntitiesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *EntitiesDetectionJobProperties
SetOutputDataConfig sets the OutputDataConfig field's value.