comprehend

package
v1.42.9 Latest Latest
Warning

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

 Go to latest Published: Aug 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

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

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

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

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

Using the Client

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

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

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

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

Index

Constants

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

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

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

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

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

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

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

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

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

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

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

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

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 additional information about any tables that are detected in the input document.

  • FORMS - Returns additional information about any forms that are detected in the input document.

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

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

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

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

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

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

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

	// DocumentTypeTextractAnalyzeDocumentJson is a DocumentType enum value
	DocumentTypeTextractAnalyzeDocumentJson = "TEXTRACT_ANALYZE_DOCUMENT_JSON"
)
View Source 
const (
	// EndpointStatusCreating is a EndpointStatus enum value
	EndpointStatusCreating = "CREATING"

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

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

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

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

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

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

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

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

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

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

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

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

	// EntityTypeOther is a EntityType enum value
	EntityTypeOther = "OTHER"
)
View Source 
const (
	// FlywheelIterationStatusTraining is a FlywheelIterationStatus enum value
	FlywheelIterationStatusTraining = "TRAINING"

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

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

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

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

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

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

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

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

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

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

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

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

	// InvalidRequestDetailReasonTextractAccessDenied is a InvalidRequestDetailReason enum value
	InvalidRequestDetailReasonTextractAccessDenied = "TEXTRACT_ACCESS_DENIED"
)
View Source 
const (
	// JobStatusSubmitted is a JobStatus enum value
	JobStatusSubmitted = "SUBMITTED"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// ModelStatusTrained is a ModelStatus enum value
	ModelStatusTrained = "TRAINED"

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

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

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

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

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

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

	// PageBasedWarningCodeInferencingNativeDocumentWithPlaintextTrainedModel is a PageBasedWarningCode enum value
	PageBasedWarningCodeInferencingNativeDocumentWithPlaintextTrainedModel = "INFERENCING_NATIVE_DOCUMENT_WITH_PLAINTEXT_TRAINED_MODEL"
)
View Source 
const (
	// PartOfSpeechTagTypeAdj is a PartOfSpeechTagType enum value
	PartOfSpeechTagTypeAdj = "ADJ"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// PiiEntityTypeAll is a PiiEntityType enum value
	PiiEntityTypeAll = "ALL"

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

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

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

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

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

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

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

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

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

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

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

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

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

	// PiiEntityTypeInVoterNumber is a PiiEntityType enum value
	PiiEntityTypeInVoterNumber = "IN_VOTER_NUMBER"
)
View Source 
const (
	// SentimentTypePositive is a SentimentType enum value
	SentimentTypePositive = "POSITIVE"

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

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

	// SentimentTypeMixed is a SentimentType enum value
	SentimentTypeMixed = "MIXED"
)
View Source 
const (
	// SplitTrain is a Split enum value
	SplitTrain = "TRAIN"

	// SplitTest is a Split enum value
	SplitTest = "TEST"
)
View Source 
const (
	// SyntaxLanguageCodeEn is a SyntaxLanguageCode enum value
	SyntaxLanguageCodeEn = "en"

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

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

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

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

	// SyntaxLanguageCodePt is a SyntaxLanguageCode enum value
	SyntaxLanguageCodePt = "pt"
)
View Source 
const (
	// TargetedSentimentEntityTypePerson is a TargetedSentimentEntityType enum value
	TargetedSentimentEntityTypePerson = "PERSON"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// TargetedSentimentEntityTypeOther is a TargetedSentimentEntityType enum value
	TargetedSentimentEntityTypeOther = "OTHER"
)
View Source 
const (

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

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

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

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

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

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

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

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource name is already in use. Use a different name and try
	// your request again.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// The maximum number of resources per account has been exceeded. Review the
	// resources, and then try your request again.
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource ARN was not found. Check the ARN and try your request
	// again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceUnavailableException for service response error code
	// "ResourceUnavailableException".
	//
	// The specified resource is not available. Check the resource and try your
	// request again.
	ErrCodeResourceUnavailableException = "ResourceUnavailableException"

	// ErrCodeTextSizeLimitExceededException for service response error code
	// "TextSizeLimitExceededException".
	//
	// The size of the input text exceeds the limit. Use a smaller document.
	ErrCodeTextSizeLimitExceededException = "TextSizeLimitExceededException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// The number of requests exceeds the limit. Resubmit your request later.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeTooManyTagKeysException for service response error code
	// "TooManyTagKeysException".
	//
	// The request contains more tag keys than can be associated with a resource
	// (50 tag keys per resource).
	ErrCodeTooManyTagKeysException = "TooManyTagKeysException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// The request contains more tags than can be associated with a resource (50
	// tags per resource). The maximum number of tags includes both existing tags
	// and those included in your current request.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeUnsupportedLanguageException for service response error code
	// "UnsupportedLanguageException".
	//
	// Amazon Comprehend can't process the language of the input text. For 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.
	ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException"
)
View Source 
const (
	ServiceName = "comprehend" // Name of service.
	EndpointsID = ServiceName  // ID to lookup a service endpoint with.
	ServiceID   = "Comprehend" // ServiceID is a unique identifier of a specific service.
)

Service information constants

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

Variables

This section is empty.

Functions

func AugmentedManifestsDocumentTypeFormat_Values 

func AugmentedManifestsDocumentTypeFormat_Values() []string

AugmentedManifestsDocumentTypeFormat_Values returns all elements of the AugmentedManifestsDocumentTypeFormat enum

func BlockType_Values added in v1.42.9 

func BlockType_Values() []string

BlockType_Values returns all elements of the BlockType enum

func DatasetDataFormat_Values added in v1.42.9 

func DatasetDataFormat_Values() []string

DatasetDataFormat_Values returns all elements of the DatasetDataFormat enum

func DatasetStatus_Values added in v1.42.9 

func DatasetStatus_Values() []string

DatasetStatus_Values returns all elements of the DatasetStatus enum

func DatasetType_Values added in v1.42.9 

func DatasetType_Values() []string

DatasetType_Values returns all elements of the DatasetType enum

func DocumentClassifierDataFormat_Values 

func DocumentClassifierDataFormat_Values() []string

DocumentClassifierDataFormat_Values returns all elements of the DocumentClassifierDataFormat enum

func DocumentClassifierDocumentTypeFormat_Values added in v1.42.9 

func DocumentClassifierDocumentTypeFormat_Values() []string

DocumentClassifierDocumentTypeFormat_Values returns all elements of the DocumentClassifierDocumentTypeFormat enum

func DocumentClassifierMode_Values 

func DocumentClassifierMode_Values() []string

DocumentClassifierMode_Values returns all elements of the DocumentClassifierMode enum

func DocumentReadAction_Values 

func DocumentReadAction_Values() []string

DocumentReadAction_Values returns all elements of the DocumentReadAction enum

func DocumentReadFeatureTypes_Values 

func DocumentReadFeatureTypes_Values() []string

DocumentReadFeatureTypes_Values returns all elements of the DocumentReadFeatureTypes enum

func DocumentReadMode_Values 

func DocumentReadMode_Values() []string

DocumentReadMode_Values returns all elements of the DocumentReadMode enum

func DocumentType_Values added in v1.42.9 

func DocumentType_Values() []string

DocumentType_Values returns all elements of the DocumentType enum

func EndpointStatus_Values 

func EndpointStatus_Values() []string

EndpointStatus_Values returns all elements of the EndpointStatus enum

func EntityRecognizerDataFormat_Values 

func EntityRecognizerDataFormat_Values() []string

EntityRecognizerDataFormat_Values returns all elements of the EntityRecognizerDataFormat enum

func EntityType_Values 

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func FlywheelIterationStatus_Values added in v1.42.9 

func FlywheelIterationStatus_Values() []string

FlywheelIterationStatus_Values returns all elements of the FlywheelIterationStatus enum

func FlywheelStatus_Values added in v1.42.9 

func FlywheelStatus_Values() []string

FlywheelStatus_Values returns all elements of the FlywheelStatus enum

func InputFormat_Values 

func InputFormat_Values() []string

InputFormat_Values returns all elements of the InputFormat enum

func InvalidRequestDetailReason_Values added in v1.42.9 

func InvalidRequestDetailReason_Values() []string

InvalidRequestDetailReason_Values returns all elements of the InvalidRequestDetailReason enum

func InvalidRequestReason_Values added in v1.42.9 

func InvalidRequestReason_Values() []string

InvalidRequestReason_Values returns all elements of the InvalidRequestReason enum

func JobStatus_Values 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func LanguageCode_Values 

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func ModelStatus_Values 

func ModelStatus_Values() []string

ModelStatus_Values returns all elements of the ModelStatus enum

func ModelType_Values added in v1.42.9 

func ModelType_Values() []string

ModelType_Values returns all elements of the ModelType enum

func PageBasedErrorCode_Values added in v1.42.9 

func PageBasedErrorCode_Values() []string

PageBasedErrorCode_Values returns all elements of the PageBasedErrorCode enum

func PageBasedWarningCode_Values added in v1.42.9 

func PageBasedWarningCode_Values() []string

PageBasedWarningCode_Values returns all elements of the PageBasedWarningCode enum

func PartOfSpeechTagType_Values 

func PartOfSpeechTagType_Values() []string

PartOfSpeechTagType_Values returns all elements of the PartOfSpeechTagType enum

func PiiEntitiesDetectionMaskMode_Values 

func PiiEntitiesDetectionMaskMode_Values() []string

PiiEntitiesDetectionMaskMode_Values returns all elements of the PiiEntitiesDetectionMaskMode enum

func PiiEntitiesDetectionMode_Values 

func PiiEntitiesDetectionMode_Values() []string

PiiEntitiesDetectionMode_Values returns all elements of the PiiEntitiesDetectionMode enum

func PiiEntityType_Values 

func PiiEntityType_Values() []string

PiiEntityType_Values returns all elements of the PiiEntityType enum

func RelationshipType_Values added in v1.42.9 

func RelationshipType_Values() []string

RelationshipType_Values returns all elements of the RelationshipType enum

func SentimentType_Values 

func SentimentType_Values() []string

SentimentType_Values returns all elements of the SentimentType enum

func Split_Values 

func Split_Values() []string

Split_Values returns all elements of the Split enum

func SyntaxLanguageCode_Values 

func SyntaxLanguageCode_Values() []string

SyntaxLanguageCode_Values returns all elements of the SyntaxLanguageCode enum

func TargetedSentimentEntityType_Values added in v1.42.9 

func TargetedSentimentEntityType_Values() []string

TargetedSentimentEntityType_Values returns all elements of the TargetedSentimentEntityType enum

Types

type AugmentedManifestsListItem 

type AugmentedManifestsListItem struct {

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

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

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

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

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

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

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

func (AugmentedManifestsListItem) GoString 

func (s AugmentedManifestsListItem) GoString() string

GoString returns the string representation.

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

func (*AugmentedManifestsListItem) SetAnnotationDataS3Uri 

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

SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value.

func (*AugmentedManifestsListItem) SetAttributeNames 

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

SetAttributeNames sets the AttributeNames field's value.

func (*AugmentedManifestsListItem) SetDocumentType 

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

SetDocumentType sets the DocumentType field's value.

func (*AugmentedManifestsListItem) SetS3Uri 

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

SetS3Uri sets the S3Uri field's value.

func (*AugmentedManifestsListItem) SetSourceDocumentsS3Uri 

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

SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value.

func (*AugmentedManifestsListItem) SetSplit 

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

SetSplit sets the Split field's value.

func (AugmentedManifestsListItem) String 

func (s AugmentedManifestsListItem) String() string

String returns the string representation.

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

func (*AugmentedManifestsListItem) Validate 

func (s *AugmentedManifestsListItem) Validate() error

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

type BatchDetectDominantLanguageInput 

type BatchDetectDominantLanguageInput struct {

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

func (BatchDetectDominantLanguageInput) GoString 

func (s BatchDetectDominantLanguageInput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectDominantLanguageInput) SetTextList 

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

SetTextList sets the TextList field's value.

func (BatchDetectDominantLanguageInput) String 

func (s BatchDetectDominantLanguageInput) String() string

String returns the string representation.

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

func (*BatchDetectDominantLanguageInput) Validate 

func (s *BatchDetectDominantLanguageInput) Validate() error

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

type BatchDetectDominantLanguageItemResult 

type BatchDetectDominantLanguageItemResult struct {

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

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

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

func (BatchDetectDominantLanguageItemResult) GoString 

func (s BatchDetectDominantLanguageItemResult) GoString() string

GoString returns the string representation.

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

func (*BatchDetectDominantLanguageItemResult) SetIndex 

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

SetIndex sets the Index field's value.

func (*BatchDetectDominantLanguageItemResult) SetLanguages 

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

SetLanguages sets the Languages field's value.

func (BatchDetectDominantLanguageItemResult) String 

func (s BatchDetectDominantLanguageItemResult) String() string

String returns the string representation.

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

type BatchDetectDominantLanguageOutput 

type BatchDetectDominantLanguageOutput struct {

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

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

func (BatchDetectDominantLanguageOutput) GoString 

func (s BatchDetectDominantLanguageOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectDominantLanguageOutput) SetErrorList 

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectDominantLanguageOutput) SetResultList 

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

SetResultList sets the ResultList field's value.

func (BatchDetectDominantLanguageOutput) String 

func (s BatchDetectDominantLanguageOutput) String() string

String returns the string representation.

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

type BatchDetectEntitiesInput 

type BatchDetectEntitiesInput struct {

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

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

func (BatchDetectEntitiesInput) GoString 

func (s BatchDetectEntitiesInput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectEntitiesInput) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectEntitiesInput) SetTextList 

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

SetTextList sets the TextList field's value.

func (BatchDetectEntitiesInput) String 

func (s BatchDetectEntitiesInput) String() string

String returns the string representation.

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

func (*BatchDetectEntitiesInput) Validate 

func (s *BatchDetectEntitiesInput) Validate() error

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

type BatchDetectEntitiesItemResult 

type BatchDetectEntitiesItemResult struct {

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

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

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

func (BatchDetectEntitiesItemResult) GoString 

func (s BatchDetectEntitiesItemResult) GoString() string

GoString returns the string representation.

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

func (*BatchDetectEntitiesItemResult) SetEntities 

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

SetEntities sets the Entities field's value.

func (*BatchDetectEntitiesItemResult) SetIndex 

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

SetIndex sets the Index field's value.

func (BatchDetectEntitiesItemResult) String 

func (s BatchDetectEntitiesItemResult) String() string

String returns the string representation.

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

type BatchDetectEntitiesOutput 

type BatchDetectEntitiesOutput struct {

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

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

func (BatchDetectEntitiesOutput) GoString 

func (s BatchDetectEntitiesOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectEntitiesOutput) SetErrorList 

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectEntitiesOutput) SetResultList 

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

SetResultList sets the ResultList field's value.

func (BatchDetectEntitiesOutput) String 

func (s BatchDetectEntitiesOutput) String() string

String returns the string representation.

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

type BatchDetectKeyPhrasesInput 

type BatchDetectKeyPhrasesInput struct {

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

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

func (BatchDetectKeyPhrasesInput) GoString 

func (s BatchDetectKeyPhrasesInput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectKeyPhrasesInput) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectKeyPhrasesInput) SetTextList 

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

SetTextList sets the TextList field's value.

func (BatchDetectKeyPhrasesInput) String 

func (s BatchDetectKeyPhrasesInput) String() string

String returns the string representation.

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

func (*BatchDetectKeyPhrasesInput) Validate 

func (s *BatchDetectKeyPhrasesInput) Validate() error

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

type BatchDetectKeyPhrasesItemResult 

type BatchDetectKeyPhrasesItemResult struct {

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

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

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

func (BatchDetectKeyPhrasesItemResult) GoString 

func (s BatchDetectKeyPhrasesItemResult) GoString() string

GoString returns the string representation.

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

func (*BatchDetectKeyPhrasesItemResult) SetIndex 

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

SetIndex sets the Index field's value.

func (*BatchDetectKeyPhrasesItemResult) SetKeyPhrases 

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

SetKeyPhrases sets the KeyPhrases field's value.

func (BatchDetectKeyPhrasesItemResult) String 

func (s BatchDetectKeyPhrasesItemResult) String() string

String returns the string representation.

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

type BatchDetectKeyPhrasesOutput 

type BatchDetectKeyPhrasesOutput struct {

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

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

func (BatchDetectKeyPhrasesOutput) GoString 

func (s BatchDetectKeyPhrasesOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectKeyPhrasesOutput) SetErrorList 

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectKeyPhrasesOutput) SetResultList 

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

SetResultList sets the ResultList field's value.

func (BatchDetectKeyPhrasesOutput) String 

func (s BatchDetectKeyPhrasesOutput) String() string

String returns the string representation.

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

type BatchDetectSentimentInput 

type BatchDetectSentimentInput struct {

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

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

func (BatchDetectSentimentInput) GoString 

func (s BatchDetectSentimentInput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectSentimentInput) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSentimentInput) SetTextList 

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

SetTextList sets the TextList field's value.

func (BatchDetectSentimentInput) String 

func (s BatchDetectSentimentInput) String() string

String returns the string representation.

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

func (*BatchDetectSentimentInput) Validate 

func (s *BatchDetectSentimentInput) Validate() error

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

type BatchDetectSentimentItemResult 

type BatchDetectSentimentItemResult struct {

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

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

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

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

func (BatchDetectSentimentItemResult) GoString 

func (s BatchDetectSentimentItemResult) GoString() string

GoString returns the string representation.

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

func (*BatchDetectSentimentItemResult) SetIndex 

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

SetIndex sets the Index field's value.

func (*BatchDetectSentimentItemResult) SetSentiment 

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

SetSentiment sets the Sentiment field's value.

func (*BatchDetectSentimentItemResult) SetSentimentScore 

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

SetSentimentScore sets the SentimentScore field's value.

func (BatchDetectSentimentItemResult) String 

func (s BatchDetectSentimentItemResult) String() string

String returns the string representation.

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

type BatchDetectSentimentOutput 

type BatchDetectSentimentOutput struct {

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

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

func (BatchDetectSentimentOutput) GoString 

func (s BatchDetectSentimentOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectSentimentOutput) SetErrorList 

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSentimentOutput) SetResultList 

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

SetResultList sets the ResultList field's value.

func (BatchDetectSentimentOutput) String 

func (s BatchDetectSentimentOutput) String() string

String returns the string representation.

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

type BatchDetectSyntaxInput 

type BatchDetectSyntaxInput struct {

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

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

func (BatchDetectSyntaxInput) GoString 

func (s BatchDetectSyntaxInput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectSyntaxInput) SetLanguageCode 

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSyntaxInput) SetTextList 

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

SetTextList sets the TextList field's value.

func (BatchDetectSyntaxInput) String 

func (s BatchDetectSyntaxInput) String() string

String returns the string representation.

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

func (*BatchDetectSyntaxInput) Validate 

func (s *BatchDetectSyntaxInput) Validate() error

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

type BatchDetectSyntaxItemResult 

type BatchDetectSyntaxItemResult struct {

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

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

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

func (BatchDetectSyntaxItemResult) GoString 

func (s BatchDetectSyntaxItemResult) GoString() string

GoString returns the string representation.

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

func (*BatchDetectSyntaxItemResult) SetIndex 

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

SetIndex sets the Index field's value.

func (*BatchDetectSyntaxItemResult) SetSyntaxTokens 

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

SetSyntaxTokens sets the SyntaxTokens field's value.

func (BatchDetectSyntaxItemResult) String 

func (s BatchDetectSyntaxItemResult) String() string

String returns the string representation.

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

type BatchDetectSyntaxOutput 

type BatchDetectSyntaxOutput struct {

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

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

func (BatchDetectSyntaxOutput) GoString 

func (s BatchDetectSyntaxOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectSyntaxOutput) SetErrorList 

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSyntaxOutput) SetResultList 

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

SetResultList sets the ResultList field's value.

func (BatchDetectSyntaxOutput) String 

func (s BatchDetectSyntaxOutput) String() string

String returns the string representation.

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

type BatchDetectTargetedSentimentInput added in v1.42.9 

type BatchDetectTargetedSentimentInput struct {

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

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

func (BatchDetectTargetedSentimentInput) GoString added in v1.42.9 

func (s BatchDetectTargetedSentimentInput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectTargetedSentimentInput) SetLanguageCode added in v1.42.9 

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectTargetedSentimentInput) SetTextList added in v1.42.9 

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

SetTextList sets the TextList field's value.

func (BatchDetectTargetedSentimentInput) String added in v1.42.9 

func (s BatchDetectTargetedSentimentInput) String() string

String returns the string representation.

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

func (*BatchDetectTargetedSentimentInput) Validate added in v1.42.9 

func (s *BatchDetectTargetedSentimentInput) Validate() error

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

type BatchDetectTargetedSentimentItemResult added in v1.42.9 

type BatchDetectTargetedSentimentItemResult struct {

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

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

Analysis results for one of the documents in the batch.

func (BatchDetectTargetedSentimentItemResult) GoString added in v1.42.9 

func (s BatchDetectTargetedSentimentItemResult) GoString() string

GoString returns the string representation.

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

func (*BatchDetectTargetedSentimentItemResult) SetEntities added in v1.42.9 

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

SetEntities sets the Entities field's value.

func (*BatchDetectTargetedSentimentItemResult) SetIndex added in v1.42.9 

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

SetIndex sets the Index field's value.

func (BatchDetectTargetedSentimentItemResult) String added in v1.42.9 

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 added in v1.42.9 

type BatchDetectTargetedSentimentOutput struct {

	// List of errors that the operation can return.
	//
	// ErrorList is a required field
	ErrorList []*BatchItemError `type:"list" required:"true"`

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

func (BatchDetectTargetedSentimentOutput) GoString added in v1.42.9 

func (s BatchDetectTargetedSentimentOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDetectTargetedSentimentOutput) SetErrorList added in v1.42.9 

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectTargetedSentimentOutput) SetResultList added in v1.42.9 

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

SetResultList sets the ResultList field's value.

func (BatchDetectTargetedSentimentOutput) String added in v1.42.9 

func (s BatchDetectTargetedSentimentOutput) String() string

String returns the string representation.

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

type BatchItemError 

type BatchItemError struct {

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

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

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

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

func (BatchItemError) GoString 

func (s BatchItemError) GoString() string

GoString returns the string representation.

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

func (*BatchItemError) SetErrorCode 

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchItemError) SetErrorMessage 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchItemError) SetIndex 

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

SetIndex sets the Index field's value.

func (BatchItemError) String 

func (s BatchItemError) String() string

String returns the string representation.

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

type BatchSizeLimitExceededException 

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

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

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

func (*BatchSizeLimitExceededException) Code 

func (s *BatchSizeLimitExceededException) Code() string

Code returns the exception type name.

func (*BatchSizeLimitExceededException) Error 

func (s *BatchSizeLimitExceededException) Error() string

func (BatchSizeLimitExceededException) GoString 

func (s BatchSizeLimitExceededException) GoString() string

GoString returns the string representation.

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

func (*BatchSizeLimitExceededException) Message 

func (s *BatchSizeLimitExceededException) Message() string

Message returns the exception's message.

func (*BatchSizeLimitExceededException) OrigErr 

func (s *BatchSizeLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BatchSizeLimitExceededException) RequestID 

func (s *BatchSizeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BatchSizeLimitExceededException) StatusCode 

func (s *BatchSizeLimitExceededException) StatusCode() int

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

func (BatchSizeLimitExceededException) String 

func (s BatchSizeLimitExceededException) String() string

String returns the string representation.

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

type Block added in v1.42.9 

type Block struct {

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

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

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

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

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

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

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

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

func (Block) GoString added in v1.42.9 

func (s Block) GoString() string

GoString returns the string representation.

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

func (*Block) SetBlockType added in v1.42.9 

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

SetBlockType sets the BlockType field's value.

func (*Block) SetGeometry added in v1.42.9 

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

SetGeometry sets the Geometry field's value.

func (*Block) SetId added in v1.42.9 

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

SetId sets the Id field's value.

func (*Block) SetPage added in v1.42.9 

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

SetPage sets the Page field's value.

func (*Block) SetRelationships added in v1.42.9 

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

SetRelationships sets the Relationships field's value.

func (*Block) SetText added in v1.42.9 

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

SetText sets the Text field's value.

func (Block) String added in v1.42.9 

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 added in v1.42.9 

type BlockReference struct {

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

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

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

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

A reference to a block.

func (BlockReference) GoString added in v1.42.9 

func (s BlockReference) GoString() string

GoString returns the string representation.

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

func (*BlockReference) SetBeginOffset added in v1.42.9 

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

SetBeginOffset sets the BeginOffset field's value.

func (*BlockReference) SetBlockId added in v1.42.9 

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

SetBlockId sets the BlockId field's value.

func (*BlockReference) SetChildBlocks added in v1.42.9 

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

SetChildBlocks sets the ChildBlocks field's value.

func (*BlockReference) SetEndOffset added in v1.42.9 

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

SetEndOffset sets the EndOffset field's value.

func (BlockReference) String added in v1.42.9 

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 added in v1.42.9 

type BoundingBox struct {

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

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

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

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

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

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

func (BoundingBox) GoString added in v1.42.9 

func (s BoundingBox) GoString() string

GoString returns the string representation.

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

func (*BoundingBox) SetHeight added in v1.42.9 

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

SetHeight sets the Height field's value.

func (*BoundingBox) SetLeft added in v1.42.9 

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

SetLeft sets the Left field's value.

func (*BoundingBox) SetTop added in v1.42.9 

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

SetTop sets the Top field's value.

func (*BoundingBox) SetWidth added in v1.42.9 

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

SetWidth sets the Width field's value.

func (BoundingBox) String added in v1.42.9 

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 added in v1.42.9 

type ChildBlock struct {

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

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

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

Nested block contained within a block.

func (ChildBlock) GoString added in v1.42.9 

func (s ChildBlock) GoString() string

GoString returns the string representation.

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

func (*ChildBlock) SetBeginOffset added in v1.42.9 

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

SetBeginOffset sets the BeginOffset field's value.

func (*ChildBlock) SetChildBlockId added in v1.42.9 

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

SetChildBlockId sets the ChildBlockId field's value.

func (*ChildBlock) SetEndOffset added in v1.42.9 

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

SetEndOffset sets the EndOffset field's value.

func (ChildBlock) String added in v1.42.9 

func (s ChildBlock) String() string

String returns the string representation.

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

type ClassifierEvaluationMetrics 

type ClassifierEvaluationMetrics struct {

	// The fraction of the labels that were correct recognized. It is computed by
	// dividing the number of labels in the test documents that were correctly recognized
	// by the total number of labels in the test documents.
	Accuracy *float64 `type:"double"`

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

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

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

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

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

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

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

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

func (ClassifierEvaluationMetrics) GoString 

func (s ClassifierEvaluationMetrics) GoString() string

GoString returns the string representation.

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

func (*ClassifierEvaluationMetrics) SetAccuracy 

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

SetAccuracy sets the Accuracy field's value.

func (*ClassifierEvaluationMetrics) SetF1Score 

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

SetF1Score sets the F1Score field's value.

func (*ClassifierEvaluationMetrics) SetHammingLoss 

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

SetHammingLoss sets the HammingLoss field's value.

func (*ClassifierEvaluationMetrics) SetMicroF1Score 

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

SetMicroF1Score sets the MicroF1Score field's value.

func (*ClassifierEvaluationMetrics) SetMicroPrecision 

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

SetMicroPrecision sets the MicroPrecision field's value.

func (*ClassifierEvaluationMetrics) SetMicroRecall 

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

SetMicroRecall sets the MicroRecall field's value.

func (*ClassifierEvaluationMetrics) SetPrecision 

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

SetPrecision sets the Precision field's value.

func (*ClassifierEvaluationMetrics) SetRecall 

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

SetRecall sets the Recall field's value.

func (ClassifierEvaluationMetrics) String 

func (s ClassifierEvaluationMetrics) String() string

String returns the string representation.

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

type ClassifierMetadata 

type ClassifierMetadata struct {

	// Describes the result metrics for the test data associated with an documentation
	// classifier.
	EvaluationMetrics *ClassifierEvaluationMetrics `type:"structure"`

	// The number of labels in the input data.
	NumberOfLabels *int64 `type:"integer"`

	// The number of documents in the input data that were used to test the classifier.
	// Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.
	NumberOfTestDocuments *int64 `type:"integer"`

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

Provides information about a document classifier.

func (ClassifierMetadata) GoString 

func (s ClassifierMetadata) GoString() string

GoString returns the string representation.

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

func (*ClassifierMetadata) SetEvaluationMetrics 

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

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*ClassifierMetadata) SetNumberOfLabels 

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

SetNumberOfLabels sets the NumberOfLabels field's value.

func (*ClassifierMetadata) SetNumberOfTestDocuments 

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

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*ClassifierMetadata) SetNumberOfTrainedDocuments 

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

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (ClassifierMetadata) String 

func (s ClassifierMetadata) String() string

String returns the string representation.

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

type ClassifyDocumentInput 

type ClassifyDocumentInput struct {

	// Use the Bytes parameter to input a text, PDF, Word or image file. 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 (ClassifyDocumentInput) GoString 

func (s ClassifyDocumentInput) GoString() string

GoString returns the string representation.

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

func (*ClassifyDocumentInput) SetBytes added in v1.42.9 

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

SetBytes sets the Bytes field's value.

func (*ClassifyDocumentInput) SetDocumentReaderConfig added in v1.42.9 

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

SetDocumentReaderConfig sets the DocumentReaderConfig field's value.

func (*ClassifyDocumentInput) SetEndpointArn 

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

SetEndpointArn sets the EndpointArn field's value.

func (*ClassifyDocumentInput) SetText 

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

SetText sets the Text field's value.

func (ClassifyDocumentInput) String 

func (s ClassifyDocumentInput) String() string

String returns the string representation.

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

func (*ClassifyDocumentInput) Validate 

func (s *ClassifyDocumentInput) Validate() error

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

type ClassifyDocumentOutput 

type ClassifyDocumentOutput struct {

	// The classes used by the document being analyzed. These are used for 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"`

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

func (ClassifyDocumentOutput) GoString 

func (s ClassifyDocumentOutput) GoString() string

GoString returns the string representation.

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

func (*ClassifyDocumentOutput) SetClasses 

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

SetClasses sets the Classes field's value.

func (*ClassifyDocumentOutput) SetDocumentMetadata added in v1.42.9 

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

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*ClassifyDocumentOutput) SetDocumentType added in v1.42.9 

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

SetDocumentType sets the DocumentType field's value.

func (*ClassifyDocumentOutput) SetErrors added in v1.42.9 

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

SetErrors sets the Errors field's value.

func (*ClassifyDocumentOutput) SetLabels 

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

SetLabels sets the Labels field's value.

func (*ClassifyDocumentOutput) SetWarnings added in v1.42.9 

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

SetWarnings sets the Warnings field's value.

func (ClassifyDocumentOutput) String 

func (s ClassifyDocumentOutput) String() string

String returns the string representation.

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

type Comprehend 

type Comprehend struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

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

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

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

func (*Comprehend) BatchDetectDominantLanguage 

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

BatchDetectDominantLanguage API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

func (*Comprehend) BatchDetectDominantLanguageRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectDominantLanguageWithContext 

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

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

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

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

func (*Comprehend) BatchDetectEntities 

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

BatchDetectEntities API operation for Amazon Comprehend.

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the Comprehend Developer Guide.

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) BatchDetectEntitiesRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectEntitiesWithContext 

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

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

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

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

func (*Comprehend) BatchDetectKeyPhrases 

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

BatchDetectKeyPhrases API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) BatchDetectKeyPhrasesRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectKeyPhrasesWithContext 

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

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

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

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

func (*Comprehend) BatchDetectSentiment 

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

BatchDetectSentiment API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) BatchDetectSentimentRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectSentimentWithContext 

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

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

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

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

func (*Comprehend) BatchDetectSyntax 

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

BatchDetectSyntax API operation for Amazon Comprehend.

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) BatchDetectSyntaxRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectSyntaxWithContext 

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

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

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

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

func (*Comprehend) BatchDetectTargetedSentiment added in v1.42.9 

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 (*Comprehend) BatchDetectTargetedSentimentRequest added in v1.42.9 

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

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

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

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

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

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

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

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

func (*Comprehend) BatchDetectTargetedSentimentWithContext added in v1.42.9 

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

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

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

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

func (*Comprehend) ClassifyDocument 

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

ClassifyDocument API operation for Amazon Comprehend.

Creates a 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 (*Comprehend) ClassifyDocumentRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) ClassifyDocumentWithContext 

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

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

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

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

func (*Comprehend) ContainsPiiEntities 

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

ContainsPiiEntities API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) ContainsPiiEntitiesRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) ContainsPiiEntitiesWithContext 

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

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

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

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

func (*Comprehend) CreateDataset added in v1.42.9 

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

CreateDataset API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

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

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

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

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

func (*Comprehend) CreateDatasetRequest added in v1.42.9 

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

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

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

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

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

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

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

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

func (*Comprehend) CreateDatasetWithContext added in v1.42.9 

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

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

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

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

func (*Comprehend) CreateDocumentClassifier 

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

CreateDocumentClassifier API operation for Amazon Comprehend.

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models (https://docs.aws.amazon.com/comprehend/latest/dg/training-classifier-model.html) in the Comprehend Developer Guide.

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) CreateDocumentClassifierRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) CreateDocumentClassifierWithContext 

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

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

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

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

func (*Comprehend) CreateEndpoint 

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

CreateEndpoint API operation for Amazon Comprehend.

Creates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

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

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

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

func (*Comprehend) CreateEndpointRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) CreateEndpointWithContext 

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

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

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

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

func (*Comprehend) CreateEntityRecognizer 

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

CreateEntityRecognizer API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) CreateEntityRecognizerRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) CreateEntityRecognizerWithContext 

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

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

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

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

func (*Comprehend) CreateFlywheel added in v1.42.9 

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

CreateFlywheel API operation for Amazon Comprehend.

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

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

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

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

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

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

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

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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.

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

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

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

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

func (*Comprehend) CreateFlywheelRequest added in v1.42.9 

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

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

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

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

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

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

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

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

func (*Comprehend) CreateFlywheelWithContext added in v1.42.9 

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

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

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

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

func (*Comprehend) DeleteDocumentClassifier 

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

DeleteDocumentClassifier API operation for Amazon Comprehend.

Deletes a previously created document classifier

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

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

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

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

func (*Comprehend) DeleteDocumentClassifierRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) DeleteDocumentClassifierWithContext 

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

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

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

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

func (*Comprehend) DeleteEndpoint 

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

DeleteEndpoint API operation for Amazon Comprehend.

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints must be deleted in order for the model to be deleted. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

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

func (*Comprehend) DeleteEndpointRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) DeleteEndpointWithContext 

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

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

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

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

func (*Comprehend) DeleteEntityRecognizer 

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

DeleteEntityRecognizer API operation for Amazon Comprehend.

Deletes an entity recognizer.

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

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

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

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

func (*Comprehend) DeleteEntityRecognizerRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) DeleteEntityRecognizerWithContext 

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

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

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

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

func (*Comprehend) DeleteFlywheel added in v1.42.9 

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

DeleteFlywheel API operation for Amazon Comprehend.

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

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

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

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

func (*Comprehend) DeleteFlywheelRequest added in v1.42.9 

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

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

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

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

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

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

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

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

func (*Comprehend) DeleteFlywheelWithContext added in v1.42.9 

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

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

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

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

func (*Comprehend) DeleteResourcePolicy added in v1.42.9 

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

DeleteResourcePolicy API operation for Amazon Comprehend.

Deletes a resource-based policy that is attached to a custom model.

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

func (*Comprehend) DeleteResourcePolicyRequest added in v1.42.9 

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

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

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

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

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

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

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

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

func (*Comprehend) DeleteResourcePolicyWithContext added in v1.42.9 

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

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

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

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

func (*Comprehend) DescribeDataset added in v1.42.9 

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

DescribeDataset API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

func (*Comprehend) DescribeDatasetRequest added in v1.42.9 

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeDatasetWithContext added in v1.42.9 

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

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

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

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

func (*Comprehend) DescribeDocumentClassificationJob 

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

DescribeDocumentClassificationJob API operation for Amazon Comprehend.

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

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

func (*Comprehend) DescribeDocumentClassificationJobRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeDocumentClassificationJobWithContext 

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

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

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

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

func (*Comprehend) DescribeDocumentClassifier 

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

DescribeDocumentClassifier API operation for Amazon Comprehend.

Gets the properties associated with a document classifier.

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

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

Returned Error Types:

  • InvalidRequestException The request is invalid.

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

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

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

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

func (*Comprehend) DescribeDocumentClassifierRequest 

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

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

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

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

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

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

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

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

func (*Comprehend) DescribeDocumentClassifierWithContext 

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

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

See DescribeDocumentClassifier for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeDominantLanguageDetectionJob 

func (c *Comprehend) DescribeDominantLanguageDetectionJob(input *DescribeDominantLanguageDetectionJobInput) (*DescribeDominantLanguageDetectionJobOutput, error)

DescribeDominantLanguageDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeDominantLanguageDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob

func (*Comprehend) DescribeDominantLanguageDetectionJobRequest 

func (c *Comprehend) DescribeDominantLanguageDetectionJobRequest(input *DescribeDominantLanguageDetectionJobInput) (req *request.Request, output *DescribeDominantLanguageDetectionJobOutput)

DescribeDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDominantLanguageDetectionJob for more information on using the DescribeDominantLanguageDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDominantLanguageDetectionJobRequest method.
req, resp := client.DescribeDominantLanguageDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob

func (*Comprehend) DescribeDominantLanguageDetectionJobWithContext 

func (c *Comprehend) DescribeDominantLanguageDetectionJobWithContext(ctx aws.Context, input *DescribeDominantLanguageDetectionJobInput, opts ...request.Option) (*DescribeDominantLanguageDetectionJobOutput, error)

DescribeDominantLanguageDetectionJobWithContext is the same as DescribeDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribeDominantLanguageDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeEndpoint 

func (c *Comprehend) DescribeEndpoint(input *DescribeEndpointInput) (*DescribeEndpointOutput, error)

DescribeEndpoint API operation for Amazon Comprehend.

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeEndpoint for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint

func (*Comprehend) DescribeEndpointRequest 

func (c *Comprehend) DescribeEndpointRequest(input *DescribeEndpointInput) (req *request.Request, output *DescribeEndpointOutput)

DescribeEndpointRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEndpoint for more information on using the DescribeEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEndpointRequest method.
req, resp := client.DescribeEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint

func (*Comprehend) DescribeEndpointWithContext 

func (c *Comprehend) DescribeEndpointWithContext(ctx aws.Context, input *DescribeEndpointInput, opts ...request.Option) (*DescribeEndpointOutput, error)

DescribeEndpointWithContext is the same as DescribeEndpoint with the addition of the ability to pass a context and additional request options.

See DescribeEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeEntitiesDetectionJob 

func (c *Comprehend) DescribeEntitiesDetectionJob(input *DescribeEntitiesDetectionJobInput) (*DescribeEntitiesDetectionJobOutput, error)

DescribeEntitiesDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeEntitiesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob

func (*Comprehend) DescribeEntitiesDetectionJobRequest 

func (c *Comprehend) DescribeEntitiesDetectionJobRequest(input *DescribeEntitiesDetectionJobInput) (req *request.Request, output *DescribeEntitiesDetectionJobOutput)

DescribeEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEntitiesDetectionJob for more information on using the DescribeEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEntitiesDetectionJobRequest method.
req, resp := client.DescribeEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob

func (*Comprehend) DescribeEntitiesDetectionJobWithContext 

func (c *Comprehend) DescribeEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribeEntitiesDetectionJobInput, opts ...request.Option) (*DescribeEntitiesDetectionJobOutput, error)

DescribeEntitiesDetectionJobWithContext is the same as DescribeEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribeEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeEntityRecognizer 

func (c *Comprehend) DescribeEntityRecognizer(input *DescribeEntityRecognizerInput) (*DescribeEntityRecognizerOutput, error)

DescribeEntityRecognizer API operation for Amazon Comprehend.

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeEntityRecognizer for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer

func (*Comprehend) DescribeEntityRecognizerRequest 

func (c *Comprehend) DescribeEntityRecognizerRequest(input *DescribeEntityRecognizerInput) (req *request.Request, output *DescribeEntityRecognizerOutput)

DescribeEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the DescribeEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEntityRecognizer for more information on using the DescribeEntityRecognizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEntityRecognizerRequest method.
req, resp := client.DescribeEntityRecognizerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer

func (*Comprehend) DescribeEntityRecognizerWithContext 

func (c *Comprehend) DescribeEntityRecognizerWithContext(ctx aws.Context, input *DescribeEntityRecognizerInput, opts ...request.Option) (*DescribeEntityRecognizerOutput, error)

DescribeEntityRecognizerWithContext is the same as DescribeEntityRecognizer with the addition of the ability to pass a context and additional request options.

See DescribeEntityRecognizer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeEventsDetectionJob 

func (c *Comprehend) DescribeEventsDetectionJob(input *DescribeEventsDetectionJobInput) (*DescribeEventsDetectionJobOutput, error)

DescribeEventsDetectionJob API operation for Amazon Comprehend.

Gets the status and details of an events detection job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeEventsDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJob

func (*Comprehend) DescribeEventsDetectionJobRequest 

func (c *Comprehend) DescribeEventsDetectionJobRequest(input *DescribeEventsDetectionJobInput) (req *request.Request, output *DescribeEventsDetectionJobOutput)

DescribeEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeEventsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventsDetectionJob for more information on using the DescribeEventsDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventsDetectionJobRequest method.
req, resp := client.DescribeEventsDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJob

func (*Comprehend) DescribeEventsDetectionJobWithContext 

func (c *Comprehend) DescribeEventsDetectionJobWithContext(ctx aws.Context, input *DescribeEventsDetectionJobInput, opts ...request.Option) (*DescribeEventsDetectionJobOutput, error)

DescribeEventsDetectionJobWithContext is the same as DescribeEventsDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribeEventsDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeFlywheel added in v1.42.9 

func (c *Comprehend) DescribeFlywheel(input *DescribeFlywheelInput) (*DescribeFlywheelOutput, error)

DescribeFlywheel API operation for Amazon Comprehend.

Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeFlywheel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheel

func (*Comprehend) DescribeFlywheelIteration added in v1.42.9 

func (c *Comprehend) DescribeFlywheelIteration(input *DescribeFlywheelIterationInput) (*DescribeFlywheelIterationOutput, error)

DescribeFlywheelIteration API operation for Amazon Comprehend.

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeFlywheelIteration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIteration

func (*Comprehend) DescribeFlywheelIterationRequest added in v1.42.9 

func (c *Comprehend) DescribeFlywheelIterationRequest(input *DescribeFlywheelIterationInput) (req *request.Request, output *DescribeFlywheelIterationOutput)

DescribeFlywheelIterationRequest generates a "aws/request.Request" representing the client's request for the DescribeFlywheelIteration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFlywheelIteration for more information on using the DescribeFlywheelIteration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFlywheelIterationRequest method.
req, resp := client.DescribeFlywheelIterationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIteration

func (*Comprehend) DescribeFlywheelIterationWithContext added in v1.42.9 

func (c *Comprehend) DescribeFlywheelIterationWithContext(ctx aws.Context, input *DescribeFlywheelIterationInput, opts ...request.Option) (*DescribeFlywheelIterationOutput, error)

DescribeFlywheelIterationWithContext is the same as DescribeFlywheelIteration with the addition of the ability to pass a context and additional request options.

See DescribeFlywheelIteration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeFlywheelRequest added in v1.42.9 

func (c *Comprehend) DescribeFlywheelRequest(input *DescribeFlywheelInput) (req *request.Request, output *DescribeFlywheelOutput)

DescribeFlywheelRequest generates a "aws/request.Request" representing the client's request for the DescribeFlywheel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFlywheel for more information on using the DescribeFlywheel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFlywheelRequest method.
req, resp := client.DescribeFlywheelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheel

func (*Comprehend) DescribeFlywheelWithContext added in v1.42.9 

func (c *Comprehend) DescribeFlywheelWithContext(ctx aws.Context, input *DescribeFlywheelInput, opts ...request.Option) (*DescribeFlywheelOutput, error)

DescribeFlywheelWithContext is the same as DescribeFlywheel with the addition of the ability to pass a context and additional request options.

See DescribeFlywheel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeKeyPhrasesDetectionJob 

func (c *Comprehend) DescribeKeyPhrasesDetectionJob(input *DescribeKeyPhrasesDetectionJobInput) (*DescribeKeyPhrasesDetectionJobOutput, error)

DescribeKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeKeyPhrasesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob

func (*Comprehend) DescribeKeyPhrasesDetectionJobRequest 

func (c *Comprehend) DescribeKeyPhrasesDetectionJobRequest(input *DescribeKeyPhrasesDetectionJobInput) (req *request.Request, output *DescribeKeyPhrasesDetectionJobOutput)

DescribeKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeKeyPhrasesDetectionJob for more information on using the DescribeKeyPhrasesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeKeyPhrasesDetectionJobRequest method.
req, resp := client.DescribeKeyPhrasesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob

func (*Comprehend) DescribeKeyPhrasesDetectionJobWithContext 

func (c *Comprehend) DescribeKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *DescribeKeyPhrasesDetectionJobInput, opts ...request.Option) (*DescribeKeyPhrasesDetectionJobOutput, error)

DescribeKeyPhrasesDetectionJobWithContext is the same as DescribeKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribeKeyPhrasesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribePiiEntitiesDetectionJob 

func (c *Comprehend) DescribePiiEntitiesDetectionJob(input *DescribePiiEntitiesDetectionJobInput) (*DescribePiiEntitiesDetectionJobOutput, error)

DescribePiiEntitiesDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribePiiEntitiesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob

func (*Comprehend) DescribePiiEntitiesDetectionJobRequest 

func (c *Comprehend) DescribePiiEntitiesDetectionJobRequest(input *DescribePiiEntitiesDetectionJobInput) (req *request.Request, output *DescribePiiEntitiesDetectionJobOutput)

DescribePiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribePiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePiiEntitiesDetectionJob for more information on using the DescribePiiEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribePiiEntitiesDetectionJobRequest method.
req, resp := client.DescribePiiEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob

func (*Comprehend) DescribePiiEntitiesDetectionJobWithContext 

func (c *Comprehend) DescribePiiEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribePiiEntitiesDetectionJobInput, opts ...request.Option) (*DescribePiiEntitiesDetectionJobOutput, error)

DescribePiiEntitiesDetectionJobWithContext is the same as DescribePiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribePiiEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeResourcePolicy added in v1.42.9 

func (c *Comprehend) DescribeResourcePolicy(input *DescribeResourcePolicyInput) (*DescribeResourcePolicyOutput, error)

DescribeResourcePolicy API operation for Amazon Comprehend.

Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeResourcePolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeResourcePolicy

func (*Comprehend) DescribeResourcePolicyRequest added in v1.42.9 

func (c *Comprehend) DescribeResourcePolicyRequest(input *DescribeResourcePolicyInput) (req *request.Request, output *DescribeResourcePolicyOutput)

DescribeResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DescribeResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeResourcePolicy for more information on using the DescribeResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeResourcePolicyRequest method.
req, resp := client.DescribeResourcePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeResourcePolicy

func (*Comprehend) DescribeResourcePolicyWithContext added in v1.42.9 

func (c *Comprehend) DescribeResourcePolicyWithContext(ctx aws.Context, input *DescribeResourcePolicyInput, opts ...request.Option) (*DescribeResourcePolicyOutput, error)

DescribeResourcePolicyWithContext is the same as DescribeResourcePolicy with the addition of the ability to pass a context and additional request options.

See DescribeResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeSentimentDetectionJob 

func (c *Comprehend) DescribeSentimentDetectionJob(input *DescribeSentimentDetectionJobInput) (*DescribeSentimentDetectionJobOutput, error)

DescribeSentimentDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeSentimentDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob

func (*Comprehend) DescribeSentimentDetectionJobRequest 

func (c *Comprehend) DescribeSentimentDetectionJobRequest(input *DescribeSentimentDetectionJobInput) (req *request.Request, output *DescribeSentimentDetectionJobOutput)

DescribeSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSentimentDetectionJob for more information on using the DescribeSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeSentimentDetectionJobRequest method.
req, resp := client.DescribeSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob

func (*Comprehend) DescribeSentimentDetectionJobWithContext 

func (c *Comprehend) DescribeSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeSentimentDetectionJobInput, opts ...request.Option) (*DescribeSentimentDetectionJobOutput, error)

DescribeSentimentDetectionJobWithContext is the same as DescribeSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribeSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeTargetedSentimentDetectionJob added in v1.42.9 

func (c *Comprehend) DescribeTargetedSentimentDetectionJob(input *DescribeTargetedSentimentDetectionJobInput) (*DescribeTargetedSentimentDetectionJobOutput, error)

DescribeTargetedSentimentDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeTargetedSentimentDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob

func (*Comprehend) DescribeTargetedSentimentDetectionJobRequest added in v1.42.9 

func (c *Comprehend) DescribeTargetedSentimentDetectionJobRequest(input *DescribeTargetedSentimentDetectionJobInput) (req *request.Request, output *DescribeTargetedSentimentDetectionJobOutput)

DescribeTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeTargetedSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTargetedSentimentDetectionJob for more information on using the DescribeTargetedSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTargetedSentimentDetectionJobRequest method.
req, resp := client.DescribeTargetedSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTargetedSentimentDetectionJob

func (*Comprehend) DescribeTargetedSentimentDetectionJobWithContext added in v1.42.9 

func (c *Comprehend) DescribeTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *DescribeTargetedSentimentDetectionJobInput, opts ...request.Option) (*DescribeTargetedSentimentDetectionJobOutput, error)

DescribeTargetedSentimentDetectionJobWithContext is the same as DescribeTargetedSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribeTargetedSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DescribeTopicsDetectionJob 

func (c *Comprehend) DescribeTopicsDetectionJob(input *DescribeTopicsDetectionJobInput) (*DescribeTopicsDetectionJobOutput, error)

DescribeTopicsDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DescribeTopicsDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob

func (*Comprehend) DescribeTopicsDetectionJobRequest 

func (c *Comprehend) DescribeTopicsDetectionJobRequest(input *DescribeTopicsDetectionJobInput) (req *request.Request, output *DescribeTopicsDetectionJobOutput)

DescribeTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribeTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTopicsDetectionJob for more information on using the DescribeTopicsDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTopicsDetectionJobRequest method.
req, resp := client.DescribeTopicsDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob

func (*Comprehend) DescribeTopicsDetectionJobWithContext 

func (c *Comprehend) DescribeTopicsDetectionJobWithContext(ctx aws.Context, input *DescribeTopicsDetectionJobInput, opts ...request.Option) (*DescribeTopicsDetectionJobOutput, error)

DescribeTopicsDetectionJobWithContext is the same as DescribeTopicsDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribeTopicsDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DetectDominantLanguage 

func (c *Comprehend) DetectDominantLanguage(input *DetectDominantLanguageInput) (*DetectDominantLanguageOutput, error)

DetectDominantLanguage API operation for Amazon Comprehend.

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DetectDominantLanguage for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage

func (*Comprehend) DetectDominantLanguageRequest 

func (c *Comprehend) DetectDominantLanguageRequest(input *DetectDominantLanguageInput) (req *request.Request, output *DetectDominantLanguageOutput)

DetectDominantLanguageRequest generates a "aws/request.Request" representing the client's request for the DetectDominantLanguage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectDominantLanguage for more information on using the DetectDominantLanguage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectDominantLanguageRequest method.
req, resp := client.DetectDominantLanguageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage

func (*Comprehend) DetectDominantLanguageWithContext 

func (c *Comprehend) DetectDominantLanguageWithContext(ctx aws.Context, input *DetectDominantLanguageInput, opts ...request.Option) (*DetectDominantLanguageOutput, error)

DetectDominantLanguageWithContext is the same as DetectDominantLanguage with the addition of the ability to pass a context and additional request options.

See DetectDominantLanguage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DetectEntities 

func (c *Comprehend) DetectEntities(input *DetectEntitiesInput) (*DetectEntitiesOutput, error)

DetectEntities API operation for Amazon Comprehend.

Detects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model.

When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities (https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html) in the Comprehend Developer Guide.

When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

If the system detects errors while processing a page in the input document, the API response includes an entry in Errors for each error.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents (https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html) in the Comprehend Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DetectEntities for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.

  • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) DetectEntitiesRequest 

func (c *Comprehend) DetectEntitiesRequest(input *DetectEntitiesInput) (req *request.Request, output *DetectEntitiesOutput)

DetectEntitiesRequest generates a "aws/request.Request" representing the client's request for the DetectEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectEntities for more information on using the DetectEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectEntitiesRequest method.
req, resp := client.DetectEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntities

func (*Comprehend) DetectEntitiesWithContext 

func (c *Comprehend) DetectEntitiesWithContext(ctx aws.Context, input *DetectEntitiesInput, opts ...request.Option) (*DetectEntitiesOutput, error)

DetectEntitiesWithContext is the same as DetectEntities with the addition of the ability to pass a context and additional request options.

See DetectEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DetectKeyPhrases 

func (c *Comprehend) DetectKeyPhrases(input *DetectKeyPhrasesInput) (*DetectKeyPhrasesOutput, error)

DetectKeyPhrases API operation for Amazon Comprehend.

Detects the key noun phrases found in the text.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DetectKeyPhrases for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) DetectKeyPhrasesRequest 

func (c *Comprehend) DetectKeyPhrasesRequest(input *DetectKeyPhrasesInput) (req *request.Request, output *DetectKeyPhrasesOutput)

DetectKeyPhrasesRequest generates a "aws/request.Request" representing the client's request for the DetectKeyPhrases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectKeyPhrases for more information on using the DetectKeyPhrases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectKeyPhrasesRequest method.
req, resp := client.DetectKeyPhrasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrases

func (*Comprehend) DetectKeyPhrasesWithContext 

func (c *Comprehend) DetectKeyPhrasesWithContext(ctx aws.Context, input *DetectKeyPhrasesInput, opts ...request.Option) (*DetectKeyPhrasesOutput, error)

DetectKeyPhrasesWithContext is the same as DetectKeyPhrases with the addition of the ability to pass a context and additional request options.

See DetectKeyPhrases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DetectPiiEntities 

func (c *Comprehend) DetectPiiEntities(input *DetectPiiEntitiesInput) (*DetectPiiEntitiesOutput, error)

DetectPiiEntities API operation for Amazon Comprehend.

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DetectPiiEntities for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) DetectPiiEntitiesRequest 

func (c *Comprehend) DetectPiiEntitiesRequest(input *DetectPiiEntitiesInput) (req *request.Request, output *DetectPiiEntitiesOutput)

DetectPiiEntitiesRequest generates a "aws/request.Request" representing the client's request for the DetectPiiEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectPiiEntities for more information on using the DetectPiiEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectPiiEntitiesRequest method.
req, resp := client.DetectPiiEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities

func (*Comprehend) DetectPiiEntitiesWithContext 

func (c *Comprehend) DetectPiiEntitiesWithContext(ctx aws.Context, input *DetectPiiEntitiesInput, opts ...request.Option) (*DetectPiiEntitiesOutput, error)

DetectPiiEntitiesWithContext is the same as DetectPiiEntities with the addition of the ability to pass a context and additional request options.

See DetectPiiEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DetectSentiment 

func (c *Comprehend) DetectSentiment(input *DetectSentimentInput) (*DetectSentimentOutput, error)

DetectSentiment API operation for Amazon Comprehend.

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DetectSentiment for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) DetectSentimentRequest 

func (c *Comprehend) DetectSentimentRequest(input *DetectSentimentInput) (req *request.Request, output *DetectSentimentOutput)

DetectSentimentRequest generates a "aws/request.Request" representing the client's request for the DetectSentiment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectSentiment for more information on using the DetectSentiment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectSentimentRequest method.
req, resp := client.DetectSentimentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentiment

func (*Comprehend) DetectSentimentWithContext 

func (c *Comprehend) DetectSentimentWithContext(ctx aws.Context, input *DetectSentimentInput, opts ...request.Option) (*DetectSentimentOutput, error)

DetectSentimentWithContext is the same as DetectSentiment with the addition of the ability to pass a context and additional request options.

See DetectSentiment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DetectSyntax 

func (c *Comprehend) DetectSyntax(input *DetectSyntaxInput) (*DetectSyntaxOutput, error)

DetectSyntax API operation for Amazon Comprehend.

Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation DetectSyntax for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TextSizeLimitExceededException The size of the input text exceeds the limit. Use a smaller document.

  • UnsupportedLanguageException Amazon Comprehend can't process the language of the input text. For 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 (*Comprehend) DetectSyntaxRequest 

func (c *Comprehend) DetectSyntaxRequest(input *DetectSyntaxInput) (req *request.Request, output *DetectSyntaxOutput)

DetectSyntaxRequest generates a "aws/request.Request" representing the client's request for the DetectSyntax operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectSyntax for more information on using the DetectSyntax API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectSyntaxRequest method.
req, resp := client.DetectSyntaxRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntax

func (*Comprehend) DetectSyntaxWithContext 

func (c *Comprehend) DetectSyntaxWithContext(ctx aws.Context, input *DetectSyntaxInput, opts ...request.Option) (*DetectSyntaxOutput, error)

DetectSyntaxWithContext is the same as DetectSyntax with the addition of the ability to pass a context and additional request options.

See DetectSyntax for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) DetectTargetedSentiment added in v1.42.9 

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 (*Comprehend) DetectTargetedSentimentRequest added in v1.42.9 

func (c *Comprehend) DetectTargetedSentimentRequest(input *DetectTargetedSentimentInput) (req *request.Request, output *DetectTargetedSentimentOutput)

DetectTargetedSentimentRequest generates a "aws/request.Request" representing the client's request for the DetectTargetedSentiment operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectTargetedSentiment for more information on using the DetectTargetedSentiment API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectTargetedSentimentRequest method.
req, resp := client.DetectTargetedSentimentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentiment

func (*Comprehend) DetectTargetedSentimentWithContext added in v1.42.9 

func (c *Comprehend) DetectTargetedSentimentWithContext(ctx aws.Context, input *DetectTargetedSentimentInput, opts ...request.Option) (*DetectTargetedSentimentOutput, error)

DetectTargetedSentimentWithContext is the same as DetectTargetedSentiment with the addition of the ability to pass a context and additional request options.

See DetectTargetedSentiment for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ImportModel added in v1.42.9 

func (c *Comprehend) ImportModel(input *ImportModelInput) (*ImportModelOutput, error)

ImportModel API operation for Amazon Comprehend.

Creates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one.

If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it.

The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ImportModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ImportModel

func (*Comprehend) ImportModelRequest added in v1.42.9 

func (c *Comprehend) ImportModelRequest(input *ImportModelInput) (req *request.Request, output *ImportModelOutput)

ImportModelRequest generates a "aws/request.Request" representing the client's request for the ImportModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportModel for more information on using the ImportModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ImportModelRequest method.
req, resp := client.ImportModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ImportModel

func (*Comprehend) ImportModelWithContext added in v1.42.9 

func (c *Comprehend) ImportModelWithContext(ctx aws.Context, input *ImportModelInput, opts ...request.Option) (*ImportModelOutput, error)

ImportModelWithContext is the same as ImportModel with the addition of the ability to pass a context and additional request options.

See ImportModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDatasets added in v1.42.9 

func (c *Comprehend) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)

ListDatasets API operation for Amazon Comprehend.

List the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListDatasets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasets

func (*Comprehend) ListDatasetsPages added in v1.42.9 

func (c *Comprehend) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error

ListDatasetsPages iterates over the pages of a ListDatasets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatasets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDatasets operation.
pageNum := 0
err := client.ListDatasetsPages(params,
    func(page *comprehend.ListDatasetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListDatasetsPagesWithContext added in v1.42.9 

func (c *Comprehend) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error

ListDatasetsPagesWithContext same as ListDatasetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDatasetsRequest added in v1.42.9 

func (c *Comprehend) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)

ListDatasetsRequest generates a "aws/request.Request" representing the client's request for the ListDatasets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDatasets for more information on using the ListDatasets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDatasetsRequest method.
req, resp := client.ListDatasetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasets

func (*Comprehend) ListDatasetsWithContext added in v1.42.9 

func (c *Comprehend) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error)

ListDatasetsWithContext is the same as ListDatasets with the addition of the ability to pass a context and additional request options.

See ListDatasets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDocumentClassificationJobs 

func (c *Comprehend) ListDocumentClassificationJobs(input *ListDocumentClassificationJobsInput) (*ListDocumentClassificationJobsOutput, error)

ListDocumentClassificationJobs API operation for Amazon Comprehend.

Gets a list of the documentation classification jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListDocumentClassificationJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs

func (*Comprehend) ListDocumentClassificationJobsPages 

func (c *Comprehend) ListDocumentClassificationJobsPages(input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool) error

ListDocumentClassificationJobsPages iterates over the pages of a ListDocumentClassificationJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDocumentClassificationJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDocumentClassificationJobs operation.
pageNum := 0
err := client.ListDocumentClassificationJobsPages(params,
    func(page *comprehend.ListDocumentClassificationJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListDocumentClassificationJobsPagesWithContext 

func (c *Comprehend) ListDocumentClassificationJobsPagesWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, fn func(*ListDocumentClassificationJobsOutput, bool) bool, opts ...request.Option) error

ListDocumentClassificationJobsPagesWithContext same as ListDocumentClassificationJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDocumentClassificationJobsRequest 

func (c *Comprehend) ListDocumentClassificationJobsRequest(input *ListDocumentClassificationJobsInput) (req *request.Request, output *ListDocumentClassificationJobsOutput)

ListDocumentClassificationJobsRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassificationJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDocumentClassificationJobs for more information on using the ListDocumentClassificationJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDocumentClassificationJobsRequest method.
req, resp := client.ListDocumentClassificationJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs

func (*Comprehend) ListDocumentClassificationJobsWithContext 

func (c *Comprehend) ListDocumentClassificationJobsWithContext(ctx aws.Context, input *ListDocumentClassificationJobsInput, opts ...request.Option) (*ListDocumentClassificationJobsOutput, error)

ListDocumentClassificationJobsWithContext is the same as ListDocumentClassificationJobs with the addition of the ability to pass a context and additional request options.

See ListDocumentClassificationJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDocumentClassifierSummaries 

func (c *Comprehend) ListDocumentClassifierSummaries(input *ListDocumentClassifierSummariesInput) (*ListDocumentClassifierSummariesOutput, error)

ListDocumentClassifierSummaries API operation for Amazon Comprehend.

Gets a list of summaries of the document classifiers that you have created

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListDocumentClassifierSummaries for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries

func (*Comprehend) ListDocumentClassifierSummariesPages 

func (c *Comprehend) ListDocumentClassifierSummariesPages(input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool) error

ListDocumentClassifierSummariesPages iterates over the pages of a ListDocumentClassifierSummaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDocumentClassifierSummaries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDocumentClassifierSummaries operation.
pageNum := 0
err := client.ListDocumentClassifierSummariesPages(params,
    func(page *comprehend.ListDocumentClassifierSummariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListDocumentClassifierSummariesPagesWithContext 

func (c *Comprehend) ListDocumentClassifierSummariesPagesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, fn func(*ListDocumentClassifierSummariesOutput, bool) bool, opts ...request.Option) error

ListDocumentClassifierSummariesPagesWithContext same as ListDocumentClassifierSummariesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDocumentClassifierSummariesRequest 

func (c *Comprehend) ListDocumentClassifierSummariesRequest(input *ListDocumentClassifierSummariesInput) (req *request.Request, output *ListDocumentClassifierSummariesOutput)

ListDocumentClassifierSummariesRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassifierSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDocumentClassifierSummaries for more information on using the ListDocumentClassifierSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDocumentClassifierSummariesRequest method.
req, resp := client.ListDocumentClassifierSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries

func (*Comprehend) ListDocumentClassifierSummariesWithContext 

func (c *Comprehend) ListDocumentClassifierSummariesWithContext(ctx aws.Context, input *ListDocumentClassifierSummariesInput, opts ...request.Option) (*ListDocumentClassifierSummariesOutput, error)

ListDocumentClassifierSummariesWithContext is the same as ListDocumentClassifierSummaries with the addition of the ability to pass a context and additional request options.

See ListDocumentClassifierSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDocumentClassifiers 

func (c *Comprehend) ListDocumentClassifiers(input *ListDocumentClassifiersInput) (*ListDocumentClassifiersOutput, error)

ListDocumentClassifiers API operation for Amazon Comprehend.

Gets a list of the document classifiers that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListDocumentClassifiers for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers

func (*Comprehend) ListDocumentClassifiersPages 

func (c *Comprehend) ListDocumentClassifiersPages(input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool) error

ListDocumentClassifiersPages iterates over the pages of a ListDocumentClassifiers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDocumentClassifiers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDocumentClassifiers operation.
pageNum := 0
err := client.ListDocumentClassifiersPages(params,
    func(page *comprehend.ListDocumentClassifiersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListDocumentClassifiersPagesWithContext 

func (c *Comprehend) ListDocumentClassifiersPagesWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, fn func(*ListDocumentClassifiersOutput, bool) bool, opts ...request.Option) error

ListDocumentClassifiersPagesWithContext same as ListDocumentClassifiersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDocumentClassifiersRequest 

func (c *Comprehend) ListDocumentClassifiersRequest(input *ListDocumentClassifiersInput) (req *request.Request, output *ListDocumentClassifiersOutput)

ListDocumentClassifiersRequest generates a "aws/request.Request" representing the client's request for the ListDocumentClassifiers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDocumentClassifiers for more information on using the ListDocumentClassifiers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDocumentClassifiersRequest method.
req, resp := client.ListDocumentClassifiersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers

func (*Comprehend) ListDocumentClassifiersWithContext 

func (c *Comprehend) ListDocumentClassifiersWithContext(ctx aws.Context, input *ListDocumentClassifiersInput, opts ...request.Option) (*ListDocumentClassifiersOutput, error)

ListDocumentClassifiersWithContext is the same as ListDocumentClassifiers with the addition of the ability to pass a context and additional request options.

See ListDocumentClassifiers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDominantLanguageDetectionJobs 

func (c *Comprehend) ListDominantLanguageDetectionJobs(input *ListDominantLanguageDetectionJobsInput) (*ListDominantLanguageDetectionJobsOutput, error)

ListDominantLanguageDetectionJobs API operation for Amazon Comprehend.

Gets a list of the dominant language detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListDominantLanguageDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs

func (*Comprehend) ListDominantLanguageDetectionJobsPages 

func (c *Comprehend) ListDominantLanguageDetectionJobsPages(input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool) error

ListDominantLanguageDetectionJobsPages iterates over the pages of a ListDominantLanguageDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDominantLanguageDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDominantLanguageDetectionJobs operation.
pageNum := 0
err := client.ListDominantLanguageDetectionJobsPages(params,
    func(page *comprehend.ListDominantLanguageDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListDominantLanguageDetectionJobsPagesWithContext 

func (c *Comprehend) ListDominantLanguageDetectionJobsPagesWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, fn func(*ListDominantLanguageDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListDominantLanguageDetectionJobsPagesWithContext same as ListDominantLanguageDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListDominantLanguageDetectionJobsRequest 

func (c *Comprehend) ListDominantLanguageDetectionJobsRequest(input *ListDominantLanguageDetectionJobsInput) (req *request.Request, output *ListDominantLanguageDetectionJobsOutput)

ListDominantLanguageDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListDominantLanguageDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDominantLanguageDetectionJobs for more information on using the ListDominantLanguageDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDominantLanguageDetectionJobsRequest method.
req, resp := client.ListDominantLanguageDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs

func (*Comprehend) ListDominantLanguageDetectionJobsWithContext 

func (c *Comprehend) ListDominantLanguageDetectionJobsWithContext(ctx aws.Context, input *ListDominantLanguageDetectionJobsInput, opts ...request.Option) (*ListDominantLanguageDetectionJobsOutput, error)

ListDominantLanguageDetectionJobsWithContext is the same as ListDominantLanguageDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListDominantLanguageDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEndpoints 

func (c *Comprehend) ListEndpoints(input *ListEndpointsInput) (*ListEndpointsOutput, error)

ListEndpoints API operation for Amazon Comprehend.

Gets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListEndpoints for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints

func (*Comprehend) ListEndpointsPages added in v1.42.9 

func (c *Comprehend) ListEndpointsPages(input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool) error

ListEndpointsPages iterates over the pages of a ListEndpoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEndpoints method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEndpoints operation.
pageNum := 0
err := client.ListEndpointsPages(params,
    func(page *comprehend.ListEndpointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListEndpointsPagesWithContext added in v1.42.9 

func (c *Comprehend) ListEndpointsPagesWithContext(ctx aws.Context, input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool, opts ...request.Option) error

ListEndpointsPagesWithContext same as ListEndpointsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEndpointsRequest 

func (c *Comprehend) ListEndpointsRequest(input *ListEndpointsInput) (req *request.Request, output *ListEndpointsOutput)

ListEndpointsRequest generates a "aws/request.Request" representing the client's request for the ListEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEndpoints for more information on using the ListEndpoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEndpointsRequest method.
req, resp := client.ListEndpointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints

func (*Comprehend) ListEndpointsWithContext 

func (c *Comprehend) ListEndpointsWithContext(ctx aws.Context, input *ListEndpointsInput, opts ...request.Option) (*ListEndpointsOutput, error)

ListEndpointsWithContext is the same as ListEndpoints with the addition of the ability to pass a context and additional request options.

See ListEndpoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEntitiesDetectionJobs 

func (c *Comprehend) ListEntitiesDetectionJobs(input *ListEntitiesDetectionJobsInput) (*ListEntitiesDetectionJobsOutput, error)

ListEntitiesDetectionJobs API operation for Amazon Comprehend.

Gets a list of the entity detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListEntitiesDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs

func (*Comprehend) ListEntitiesDetectionJobsPages 

func (c *Comprehend) ListEntitiesDetectionJobsPages(input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool) error

ListEntitiesDetectionJobsPages iterates over the pages of a ListEntitiesDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEntitiesDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEntitiesDetectionJobs operation.
pageNum := 0
err := client.ListEntitiesDetectionJobsPages(params,
    func(page *comprehend.ListEntitiesDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListEntitiesDetectionJobsPagesWithContext 

func (c *Comprehend) ListEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, fn func(*ListEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListEntitiesDetectionJobsPagesWithContext same as ListEntitiesDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEntitiesDetectionJobsRequest 

func (c *Comprehend) ListEntitiesDetectionJobsRequest(input *ListEntitiesDetectionJobsInput) (req *request.Request, output *ListEntitiesDetectionJobsOutput)

ListEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListEntitiesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEntitiesDetectionJobs for more information on using the ListEntitiesDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEntitiesDetectionJobsRequest method.
req, resp := client.ListEntitiesDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs

func (*Comprehend) ListEntitiesDetectionJobsWithContext 

func (c *Comprehend) ListEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListEntitiesDetectionJobsInput, opts ...request.Option) (*ListEntitiesDetectionJobsOutput, error)

ListEntitiesDetectionJobsWithContext is the same as ListEntitiesDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListEntitiesDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEntityRecognizerSummaries 

func (c *Comprehend) ListEntityRecognizerSummaries(input *ListEntityRecognizerSummariesInput) (*ListEntityRecognizerSummariesOutput, error)

ListEntityRecognizerSummaries API operation for Amazon Comprehend.

Gets a list of summaries for the entity recognizers that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListEntityRecognizerSummaries for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries

func (*Comprehend) ListEntityRecognizerSummariesPages 

func (c *Comprehend) ListEntityRecognizerSummariesPages(input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool) error

ListEntityRecognizerSummariesPages iterates over the pages of a ListEntityRecognizerSummaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEntityRecognizerSummaries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEntityRecognizerSummaries operation.
pageNum := 0
err := client.ListEntityRecognizerSummariesPages(params,
    func(page *comprehend.ListEntityRecognizerSummariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListEntityRecognizerSummariesPagesWithContext 

func (c *Comprehend) ListEntityRecognizerSummariesPagesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, fn func(*ListEntityRecognizerSummariesOutput, bool) bool, opts ...request.Option) error

ListEntityRecognizerSummariesPagesWithContext same as ListEntityRecognizerSummariesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEntityRecognizerSummariesRequest 

func (c *Comprehend) ListEntityRecognizerSummariesRequest(input *ListEntityRecognizerSummariesInput) (req *request.Request, output *ListEntityRecognizerSummariesOutput)

ListEntityRecognizerSummariesRequest generates a "aws/request.Request" representing the client's request for the ListEntityRecognizerSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEntityRecognizerSummaries for more information on using the ListEntityRecognizerSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEntityRecognizerSummariesRequest method.
req, resp := client.ListEntityRecognizerSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries

func (*Comprehend) ListEntityRecognizerSummariesWithContext 

func (c *Comprehend) ListEntityRecognizerSummariesWithContext(ctx aws.Context, input *ListEntityRecognizerSummariesInput, opts ...request.Option) (*ListEntityRecognizerSummariesOutput, error)

ListEntityRecognizerSummariesWithContext is the same as ListEntityRecognizerSummaries with the addition of the ability to pass a context and additional request options.

See ListEntityRecognizerSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEntityRecognizers 

func (c *Comprehend) ListEntityRecognizers(input *ListEntityRecognizersInput) (*ListEntityRecognizersOutput, error)

ListEntityRecognizers API operation for Amazon Comprehend.

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListEntityRecognizers for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers

func (*Comprehend) ListEntityRecognizersPages 

func (c *Comprehend) ListEntityRecognizersPages(input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool) error

ListEntityRecognizersPages iterates over the pages of a ListEntityRecognizers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEntityRecognizers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEntityRecognizers operation.
pageNum := 0
err := client.ListEntityRecognizersPages(params,
    func(page *comprehend.ListEntityRecognizersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListEntityRecognizersPagesWithContext 

func (c *Comprehend) ListEntityRecognizersPagesWithContext(ctx aws.Context, input *ListEntityRecognizersInput, fn func(*ListEntityRecognizersOutput, bool) bool, opts ...request.Option) error

ListEntityRecognizersPagesWithContext same as ListEntityRecognizersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEntityRecognizersRequest 

func (c *Comprehend) ListEntityRecognizersRequest(input *ListEntityRecognizersInput) (req *request.Request, output *ListEntityRecognizersOutput)

ListEntityRecognizersRequest generates a "aws/request.Request" representing the client's request for the ListEntityRecognizers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEntityRecognizers for more information on using the ListEntityRecognizers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEntityRecognizersRequest method.
req, resp := client.ListEntityRecognizersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers

func (*Comprehend) ListEntityRecognizersWithContext 

func (c *Comprehend) ListEntityRecognizersWithContext(ctx aws.Context, input *ListEntityRecognizersInput, opts ...request.Option) (*ListEntityRecognizersOutput, error)

ListEntityRecognizersWithContext is the same as ListEntityRecognizers with the addition of the ability to pass a context and additional request options.

See ListEntityRecognizers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEventsDetectionJobs 

func (c *Comprehend) ListEventsDetectionJobs(input *ListEventsDetectionJobsInput) (*ListEventsDetectionJobsOutput, error)

ListEventsDetectionJobs API operation for Amazon Comprehend.

Gets a list of the events detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListEventsDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobs

func (*Comprehend) ListEventsDetectionJobsPages 

func (c *Comprehend) ListEventsDetectionJobsPages(input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool) error

ListEventsDetectionJobsPages iterates over the pages of a ListEventsDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEventsDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEventsDetectionJobs operation.
pageNum := 0
err := client.ListEventsDetectionJobsPages(params,
    func(page *comprehend.ListEventsDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListEventsDetectionJobsPagesWithContext 

func (c *Comprehend) ListEventsDetectionJobsPagesWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, fn func(*ListEventsDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListEventsDetectionJobsPagesWithContext same as ListEventsDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListEventsDetectionJobsRequest 

func (c *Comprehend) ListEventsDetectionJobsRequest(input *ListEventsDetectionJobsInput) (req *request.Request, output *ListEventsDetectionJobsOutput)

ListEventsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListEventsDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEventsDetectionJobs for more information on using the ListEventsDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEventsDetectionJobsRequest method.
req, resp := client.ListEventsDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobs

func (*Comprehend) ListEventsDetectionJobsWithContext 

func (c *Comprehend) ListEventsDetectionJobsWithContext(ctx aws.Context, input *ListEventsDetectionJobsInput, opts ...request.Option) (*ListEventsDetectionJobsOutput, error)

ListEventsDetectionJobsWithContext is the same as ListEventsDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListEventsDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListFlywheelIterationHistory added in v1.42.9 

func (c *Comprehend) ListFlywheelIterationHistory(input *ListFlywheelIterationHistoryInput) (*ListFlywheelIterationHistoryOutput, error)

ListFlywheelIterationHistory API operation for Amazon Comprehend.

Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListFlywheelIterationHistory for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistory

func (*Comprehend) ListFlywheelIterationHistoryPages added in v1.42.9 

func (c *Comprehend) ListFlywheelIterationHistoryPages(input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool) error

ListFlywheelIterationHistoryPages iterates over the pages of a ListFlywheelIterationHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFlywheelIterationHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFlywheelIterationHistory operation.
pageNum := 0
err := client.ListFlywheelIterationHistoryPages(params,
    func(page *comprehend.ListFlywheelIterationHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListFlywheelIterationHistoryPagesWithContext added in v1.42.9 

func (c *Comprehend) ListFlywheelIterationHistoryPagesWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, fn func(*ListFlywheelIterationHistoryOutput, bool) bool, opts ...request.Option) error

ListFlywheelIterationHistoryPagesWithContext same as ListFlywheelIterationHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListFlywheelIterationHistoryRequest added in v1.42.9 

func (c *Comprehend) ListFlywheelIterationHistoryRequest(input *ListFlywheelIterationHistoryInput) (req *request.Request, output *ListFlywheelIterationHistoryOutput)

ListFlywheelIterationHistoryRequest generates a "aws/request.Request" representing the client's request for the ListFlywheelIterationHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFlywheelIterationHistory for more information on using the ListFlywheelIterationHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFlywheelIterationHistoryRequest method.
req, resp := client.ListFlywheelIterationHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistory

func (*Comprehend) ListFlywheelIterationHistoryWithContext added in v1.42.9 

func (c *Comprehend) ListFlywheelIterationHistoryWithContext(ctx aws.Context, input *ListFlywheelIterationHistoryInput, opts ...request.Option) (*ListFlywheelIterationHistoryOutput, error)

ListFlywheelIterationHistoryWithContext is the same as ListFlywheelIterationHistory with the addition of the ability to pass a context and additional request options.

See ListFlywheelIterationHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListFlywheels added in v1.42.9 

func (c *Comprehend) ListFlywheels(input *ListFlywheelsInput) (*ListFlywheelsOutput, error)

ListFlywheels API operation for Amazon Comprehend.

Gets a list of the flywheels that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListFlywheels for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheels

func (*Comprehend) ListFlywheelsPages added in v1.42.9 

func (c *Comprehend) ListFlywheelsPages(input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool) error

ListFlywheelsPages iterates over the pages of a ListFlywheels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFlywheels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFlywheels operation.
pageNum := 0
err := client.ListFlywheelsPages(params,
    func(page *comprehend.ListFlywheelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListFlywheelsPagesWithContext added in v1.42.9 

func (c *Comprehend) ListFlywheelsPagesWithContext(ctx aws.Context, input *ListFlywheelsInput, fn func(*ListFlywheelsOutput, bool) bool, opts ...request.Option) error

ListFlywheelsPagesWithContext same as ListFlywheelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListFlywheelsRequest added in v1.42.9 

func (c *Comprehend) ListFlywheelsRequest(input *ListFlywheelsInput) (req *request.Request, output *ListFlywheelsOutput)

ListFlywheelsRequest generates a "aws/request.Request" representing the client's request for the ListFlywheels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFlywheels for more information on using the ListFlywheels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFlywheelsRequest method.
req, resp := client.ListFlywheelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheels

func (*Comprehend) ListFlywheelsWithContext added in v1.42.9 

func (c *Comprehend) ListFlywheelsWithContext(ctx aws.Context, input *ListFlywheelsInput, opts ...request.Option) (*ListFlywheelsOutput, error)

ListFlywheelsWithContext is the same as ListFlywheels with the addition of the ability to pass a context and additional request options.

See ListFlywheels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListKeyPhrasesDetectionJobs 

func (c *Comprehend) ListKeyPhrasesDetectionJobs(input *ListKeyPhrasesDetectionJobsInput) (*ListKeyPhrasesDetectionJobsOutput, error)

ListKeyPhrasesDetectionJobs API operation for Amazon Comprehend.

Get a list of key phrase detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListKeyPhrasesDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs

func (*Comprehend) ListKeyPhrasesDetectionJobsPages 

func (c *Comprehend) ListKeyPhrasesDetectionJobsPages(input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool) error

ListKeyPhrasesDetectionJobsPages iterates over the pages of a ListKeyPhrasesDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKeyPhrasesDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListKeyPhrasesDetectionJobs operation.
pageNum := 0
err := client.ListKeyPhrasesDetectionJobsPages(params,
    func(page *comprehend.ListKeyPhrasesDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext 

func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, fn func(*ListKeyPhrasesDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListKeyPhrasesDetectionJobsPagesWithContext same as ListKeyPhrasesDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListKeyPhrasesDetectionJobsRequest 

func (c *Comprehend) ListKeyPhrasesDetectionJobsRequest(input *ListKeyPhrasesDetectionJobsInput) (req *request.Request, output *ListKeyPhrasesDetectionJobsOutput)

ListKeyPhrasesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListKeyPhrasesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKeyPhrasesDetectionJobs for more information on using the ListKeyPhrasesDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListKeyPhrasesDetectionJobsRequest method.
req, resp := client.ListKeyPhrasesDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs

func (*Comprehend) ListKeyPhrasesDetectionJobsWithContext 

func (c *Comprehend) ListKeyPhrasesDetectionJobsWithContext(ctx aws.Context, input *ListKeyPhrasesDetectionJobsInput, opts ...request.Option) (*ListKeyPhrasesDetectionJobsOutput, error)

ListKeyPhrasesDetectionJobsWithContext is the same as ListKeyPhrasesDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListKeyPhrasesDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListPiiEntitiesDetectionJobs 

func (c *Comprehend) ListPiiEntitiesDetectionJobs(input *ListPiiEntitiesDetectionJobsInput) (*ListPiiEntitiesDetectionJobsOutput, error)

ListPiiEntitiesDetectionJobs API operation for Amazon Comprehend.

Gets a list of the PII entity detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListPiiEntitiesDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs

func (*Comprehend) ListPiiEntitiesDetectionJobsPages added in v1.42.9 

func (c *Comprehend) ListPiiEntitiesDetectionJobsPages(input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool) error

ListPiiEntitiesDetectionJobsPages iterates over the pages of a ListPiiEntitiesDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPiiEntitiesDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPiiEntitiesDetectionJobs operation.
pageNum := 0
err := client.ListPiiEntitiesDetectionJobsPages(params,
    func(page *comprehend.ListPiiEntitiesDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext added in v1.42.9 

func (c *Comprehend) ListPiiEntitiesDetectionJobsPagesWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, fn func(*ListPiiEntitiesDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListPiiEntitiesDetectionJobsPagesWithContext same as ListPiiEntitiesDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListPiiEntitiesDetectionJobsRequest 

func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesDetectionJobsInput) (req *request.Request, output *ListPiiEntitiesDetectionJobsOutput)

ListPiiEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListPiiEntitiesDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPiiEntitiesDetectionJobs for more information on using the ListPiiEntitiesDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPiiEntitiesDetectionJobsRequest method.
req, resp := client.ListPiiEntitiesDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs

func (*Comprehend) ListPiiEntitiesDetectionJobsWithContext 

func (c *Comprehend) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, opts ...request.Option) (*ListPiiEntitiesDetectionJobsOutput, error)

ListPiiEntitiesDetectionJobsWithContext is the same as ListPiiEntitiesDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListPiiEntitiesDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListSentimentDetectionJobs 

func (c *Comprehend) ListSentimentDetectionJobs(input *ListSentimentDetectionJobsInput) (*ListSentimentDetectionJobsOutput, error)

ListSentimentDetectionJobs API operation for Amazon Comprehend.

Gets a list of sentiment detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListSentimentDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs

func (*Comprehend) ListSentimentDetectionJobsPages 

func (c *Comprehend) ListSentimentDetectionJobsPages(input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool) error

ListSentimentDetectionJobsPages iterates over the pages of a ListSentimentDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSentimentDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListSentimentDetectionJobs operation.
pageNum := 0
err := client.ListSentimentDetectionJobsPages(params,
    func(page *comprehend.ListSentimentDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListSentimentDetectionJobsPagesWithContext 

func (c *Comprehend) ListSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, fn func(*ListSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListSentimentDetectionJobsPagesWithContext same as ListSentimentDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListSentimentDetectionJobsRequest 

func (c *Comprehend) ListSentimentDetectionJobsRequest(input *ListSentimentDetectionJobsInput) (req *request.Request, output *ListSentimentDetectionJobsOutput)

ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListSentimentDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSentimentDetectionJobs for more information on using the ListSentimentDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListSentimentDetectionJobsRequest method.
req, resp := client.ListSentimentDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs

func (*Comprehend) ListSentimentDetectionJobsWithContext 

func (c *Comprehend) ListSentimentDetectionJobsWithContext(ctx aws.Context, input *ListSentimentDetectionJobsInput, opts ...request.Option) (*ListSentimentDetectionJobsOutput, error)

ListSentimentDetectionJobsWithContext is the same as ListSentimentDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListSentimentDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTagsForResource 

func (c *Comprehend) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Comprehend.

Lists all tags associated with a given Amazon Comprehend resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource

func (*Comprehend) ListTagsForResourceRequest 

func (c *Comprehend) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTagsForResource

func (*Comprehend) ListTagsForResourceWithContext 

func (c *Comprehend) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTargetedSentimentDetectionJobs added in v1.42.9 

func (c *Comprehend) ListTargetedSentimentDetectionJobs(input *ListTargetedSentimentDetectionJobsInput) (*ListTargetedSentimentDetectionJobsOutput, error)

ListTargetedSentimentDetectionJobs API operation for Amazon Comprehend.

Gets a list of targeted sentiment detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListTargetedSentimentDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs

func (*Comprehend) ListTargetedSentimentDetectionJobsPages added in v1.42.9 

func (c *Comprehend) ListTargetedSentimentDetectionJobsPages(input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool) error

ListTargetedSentimentDetectionJobsPages iterates over the pages of a ListTargetedSentimentDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTargetedSentimentDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTargetedSentimentDetectionJobs operation.
pageNum := 0
err := client.ListTargetedSentimentDetectionJobsPages(params,
    func(page *comprehend.ListTargetedSentimentDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext added in v1.42.9 

func (c *Comprehend) ListTargetedSentimentDetectionJobsPagesWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, fn func(*ListTargetedSentimentDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListTargetedSentimentDetectionJobsPagesWithContext same as ListTargetedSentimentDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTargetedSentimentDetectionJobsRequest added in v1.42.9 

func (c *Comprehend) ListTargetedSentimentDetectionJobsRequest(input *ListTargetedSentimentDetectionJobsInput) (req *request.Request, output *ListTargetedSentimentDetectionJobsOutput)

ListTargetedSentimentDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTargetedSentimentDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTargetedSentimentDetectionJobs for more information on using the ListTargetedSentimentDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTargetedSentimentDetectionJobsRequest method.
req, resp := client.ListTargetedSentimentDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs

func (*Comprehend) ListTargetedSentimentDetectionJobsWithContext added in v1.42.9 

func (c *Comprehend) ListTargetedSentimentDetectionJobsWithContext(ctx aws.Context, input *ListTargetedSentimentDetectionJobsInput, opts ...request.Option) (*ListTargetedSentimentDetectionJobsOutput, error)

ListTargetedSentimentDetectionJobsWithContext is the same as ListTargetedSentimentDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListTargetedSentimentDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTopicsDetectionJobs 

func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error)

ListTopicsDetectionJobs API operation for Amazon Comprehend.

Gets a list of the topic detection jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation ListTopicsDetectionJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • InvalidFilterException The filter specified for the operation is invalid. Specify a different filter.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs

func (*Comprehend) ListTopicsDetectionJobsPages 

func (c *Comprehend) ListTopicsDetectionJobsPages(input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool) error

ListTopicsDetectionJobsPages iterates over the pages of a ListTopicsDetectionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTopicsDetectionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTopicsDetectionJobs operation.
pageNum := 0
err := client.ListTopicsDetectionJobsPages(params,
    func(page *comprehend.ListTopicsDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListTopicsDetectionJobsPagesWithContext 

func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListTopicsDetectionJobsPagesWithContext same as ListTopicsDetectionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) ListTopicsDetectionJobsRequest 

func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput)

ListTopicsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTopicsDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTopicsDetectionJobs for more information on using the ListTopicsDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTopicsDetectionJobsRequest method.
req, resp := client.ListTopicsDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs

func (*Comprehend) ListTopicsDetectionJobsWithContext 

func (c *Comprehend) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error)

ListTopicsDetectionJobsWithContext is the same as ListTopicsDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListTopicsDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) PutResourcePolicy added in v1.42.9 

func (c *Comprehend) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)

PutResourcePolicy API operation for Amazon Comprehend.

Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation PutResourcePolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PutResourcePolicy

func (*Comprehend) PutResourcePolicyRequest added in v1.42.9 

func (c *Comprehend) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)

PutResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the PutResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutResourcePolicy for more information on using the PutResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutResourcePolicyRequest method.
req, resp := client.PutResourcePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PutResourcePolicy

func (*Comprehend) PutResourcePolicyWithContext added in v1.42.9 

func (c *Comprehend) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error)

PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of the ability to pass a context and additional request options.

See PutResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartDocumentClassificationJob 

func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error)

StartDocumentClassificationJob API operation for Amazon Comprehend.

Starts an asynchronous document classification job. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartDocumentClassificationJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob

func (*Comprehend) StartDocumentClassificationJobRequest 

func (c *Comprehend) StartDocumentClassificationJobRequest(input *StartDocumentClassificationJobInput) (req *request.Request, output *StartDocumentClassificationJobOutput)

StartDocumentClassificationJobRequest generates a "aws/request.Request" representing the client's request for the StartDocumentClassificationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDocumentClassificationJob for more information on using the StartDocumentClassificationJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartDocumentClassificationJobRequest method.
req, resp := client.StartDocumentClassificationJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob

func (*Comprehend) StartDocumentClassificationJobWithContext 

func (c *Comprehend) StartDocumentClassificationJobWithContext(ctx aws.Context, input *StartDocumentClassificationJobInput, opts ...request.Option) (*StartDocumentClassificationJobOutput, error)

StartDocumentClassificationJobWithContext is the same as StartDocumentClassificationJob with the addition of the ability to pass a context and additional request options.

See StartDocumentClassificationJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartDominantLanguageDetectionJob 

func (c *Comprehend) StartDominantLanguageDetectionJob(input *StartDominantLanguageDetectionJobInput) (*StartDominantLanguageDetectionJobOutput, error)

StartDominantLanguageDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartDominantLanguageDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob

func (*Comprehend) StartDominantLanguageDetectionJobRequest 

func (c *Comprehend) StartDominantLanguageDetectionJobRequest(input *StartDominantLanguageDetectionJobInput) (req *request.Request, output *StartDominantLanguageDetectionJobOutput)

StartDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDominantLanguageDetectionJob for more information on using the StartDominantLanguageDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartDominantLanguageDetectionJobRequest method.
req, resp := client.StartDominantLanguageDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJob

func (*Comprehend) StartDominantLanguageDetectionJobWithContext 

func (c *Comprehend) StartDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StartDominantLanguageDetectionJobInput, opts ...request.Option) (*StartDominantLanguageDetectionJobOutput, error)

StartDominantLanguageDetectionJobWithContext is the same as StartDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.

See StartDominantLanguageDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartEntitiesDetectionJob 

func (c *Comprehend) StartEntitiesDetectionJob(input *StartEntitiesDetectionJobInput) (*StartEntitiesDetectionJobOutput, error)

StartEntitiesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartEntitiesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob

func (*Comprehend) StartEntitiesDetectionJobRequest 

func (c *Comprehend) StartEntitiesDetectionJobRequest(input *StartEntitiesDetectionJobInput) (req *request.Request, output *StartEntitiesDetectionJobOutput)

StartEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartEntitiesDetectionJob for more information on using the StartEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartEntitiesDetectionJobRequest method.
req, resp := client.StartEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob

func (*Comprehend) StartEntitiesDetectionJobWithContext 

func (c *Comprehend) StartEntitiesDetectionJobWithContext(ctx aws.Context, input *StartEntitiesDetectionJobInput, opts ...request.Option) (*StartEntitiesDetectionJobOutput, error)

StartEntitiesDetectionJobWithContext is the same as StartEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StartEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartEventsDetectionJob 

func (c *Comprehend) StartEventsDetectionJob(input *StartEventsDetectionJobInput) (*StartEventsDetectionJobOutput, error)

StartEventsDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous event detection job for a collection of documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartEventsDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob

func (*Comprehend) StartEventsDetectionJobRequest 

func (c *Comprehend) StartEventsDetectionJobRequest(input *StartEventsDetectionJobInput) (req *request.Request, output *StartEventsDetectionJobOutput)

StartEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartEventsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartEventsDetectionJob for more information on using the StartEventsDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartEventsDetectionJobRequest method.
req, resp := client.StartEventsDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob

func (*Comprehend) StartEventsDetectionJobWithContext 

func (c *Comprehend) StartEventsDetectionJobWithContext(ctx aws.Context, input *StartEventsDetectionJobInput, opts ...request.Option) (*StartEventsDetectionJobOutput, error)

StartEventsDetectionJobWithContext is the same as StartEventsDetectionJob with the addition of the ability to pass a context and additional request options.

See StartEventsDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartFlywheelIteration added in v1.42.9 

func (c *Comprehend) StartFlywheelIteration(input *StartFlywheelIterationInput) (*StartFlywheelIterationOutput, error)

StartFlywheelIteration API operation for Amazon Comprehend.

Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview (https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html) in the Amazon Comprehend Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartFlywheelIteration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIteration

func (*Comprehend) StartFlywheelIterationRequest added in v1.42.9 

func (c *Comprehend) StartFlywheelIterationRequest(input *StartFlywheelIterationInput) (req *request.Request, output *StartFlywheelIterationOutput)

StartFlywheelIterationRequest generates a "aws/request.Request" representing the client's request for the StartFlywheelIteration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartFlywheelIteration for more information on using the StartFlywheelIteration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartFlywheelIterationRequest method.
req, resp := client.StartFlywheelIterationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIteration

func (*Comprehend) StartFlywheelIterationWithContext added in v1.42.9 

func (c *Comprehend) StartFlywheelIterationWithContext(ctx aws.Context, input *StartFlywheelIterationInput, opts ...request.Option) (*StartFlywheelIterationOutput, error)

StartFlywheelIterationWithContext is the same as StartFlywheelIteration with the addition of the ability to pass a context and additional request options.

See StartFlywheelIteration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartKeyPhrasesDetectionJob 

func (c *Comprehend) StartKeyPhrasesDetectionJob(input *StartKeyPhrasesDetectionJobInput) (*StartKeyPhrasesDetectionJobOutput, error)

StartKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartKeyPhrasesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob

func (*Comprehend) StartKeyPhrasesDetectionJobRequest 

func (c *Comprehend) StartKeyPhrasesDetectionJobRequest(input *StartKeyPhrasesDetectionJobInput) (req *request.Request, output *StartKeyPhrasesDetectionJobOutput)

StartKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartKeyPhrasesDetectionJob for more information on using the StartKeyPhrasesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartKeyPhrasesDetectionJobRequest method.
req, resp := client.StartKeyPhrasesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJob

func (*Comprehend) StartKeyPhrasesDetectionJobWithContext 

func (c *Comprehend) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StartKeyPhrasesDetectionJobInput, opts ...request.Option) (*StartKeyPhrasesDetectionJobOutput, error)

StartKeyPhrasesDetectionJobWithContext is the same as StartKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.

See StartKeyPhrasesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartPiiEntitiesDetectionJob 

func (c *Comprehend) StartPiiEntitiesDetectionJob(input *StartPiiEntitiesDetectionJobInput) (*StartPiiEntitiesDetectionJobOutput, error)

StartPiiEntitiesDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous PII entity detection job for a collection of documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartPiiEntitiesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob

func (*Comprehend) StartPiiEntitiesDetectionJobRequest 

func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntitiesDetectionJobInput) (req *request.Request, output *StartPiiEntitiesDetectionJobOutput)

StartPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartPiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartPiiEntitiesDetectionJob for more information on using the StartPiiEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartPiiEntitiesDetectionJobRequest method.
req, resp := client.StartPiiEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob

func (*Comprehend) StartPiiEntitiesDetectionJobWithContext 

func (c *Comprehend) StartPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StartPiiEntitiesDetectionJobInput, opts ...request.Option) (*StartPiiEntitiesDetectionJobOutput, error)

StartPiiEntitiesDetectionJobWithContext is the same as StartPiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StartPiiEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartSentimentDetectionJob 

func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error)

StartSentimentDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartSentimentDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob

func (*Comprehend) StartSentimentDetectionJobRequest 

func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput)

StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartSentimentDetectionJobRequest method.
req, resp := client.StartSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob

func (*Comprehend) StartSentimentDetectionJobWithContext 

func (c *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error)

StartSentimentDetectionJobWithContext is the same as StartSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See StartSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartTargetedSentimentDetectionJob added in v1.42.9 

func (c *Comprehend) StartTargetedSentimentDetectionJob(input *StartTargetedSentimentDetectionJobInput) (*StartTargetedSentimentDetectionJobOutput, error)

StartTargetedSentimentDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartTargetedSentimentDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob

func (*Comprehend) StartTargetedSentimentDetectionJobRequest added in v1.42.9 

func (c *Comprehend) StartTargetedSentimentDetectionJobRequest(input *StartTargetedSentimentDetectionJobInput) (req *request.Request, output *StartTargetedSentimentDetectionJobOutput)

StartTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTargetedSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartTargetedSentimentDetectionJob for more information on using the StartTargetedSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartTargetedSentimentDetectionJobRequest method.
req, resp := client.StartTargetedSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTargetedSentimentDetectionJob

func (*Comprehend) StartTargetedSentimentDetectionJobWithContext added in v1.42.9 

func (c *Comprehend) StartTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StartTargetedSentimentDetectionJobInput, opts ...request.Option) (*StartTargetedSentimentDetectionJobOutput, error)

StartTargetedSentimentDetectionJobWithContext is the same as StartTargetedSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See StartTargetedSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StartTopicsDetectionJob 

func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error)

StartTopicsDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StartTopicsDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob

func (*Comprehend) StartTopicsDetectionJobRequest 

func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput)

StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartTopicsDetectionJobRequest method.
req, resp := client.StartTopicsDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob

func (*Comprehend) StartTopicsDetectionJobWithContext 

func (c *Comprehend) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error)

StartTopicsDetectionJobWithContext is the same as StartTopicsDetectionJob with the addition of the ability to pass a context and additional request options.

See StartTopicsDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopDominantLanguageDetectionJob 

func (c *Comprehend) StopDominantLanguageDetectionJob(input *StopDominantLanguageDetectionJobInput) (*StopDominantLanguageDetectionJobOutput, error)

StopDominantLanguageDetectionJob API operation for Amazon Comprehend.

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopDominantLanguageDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob

func (*Comprehend) StopDominantLanguageDetectionJobRequest 

func (c *Comprehend) StopDominantLanguageDetectionJobRequest(input *StopDominantLanguageDetectionJobInput) (req *request.Request, output *StopDominantLanguageDetectionJobOutput)

StopDominantLanguageDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopDominantLanguageDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopDominantLanguageDetectionJob for more information on using the StopDominantLanguageDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopDominantLanguageDetectionJobRequest method.
req, resp := client.StopDominantLanguageDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopDominantLanguageDetectionJob

func (*Comprehend) StopDominantLanguageDetectionJobWithContext 

func (c *Comprehend) StopDominantLanguageDetectionJobWithContext(ctx aws.Context, input *StopDominantLanguageDetectionJobInput, opts ...request.Option) (*StopDominantLanguageDetectionJobOutput, error)

StopDominantLanguageDetectionJobWithContext is the same as StopDominantLanguageDetectionJob with the addition of the ability to pass a context and additional request options.

See StopDominantLanguageDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopEntitiesDetectionJob 

func (c *Comprehend) StopEntitiesDetectionJob(input *StopEntitiesDetectionJobInput) (*StopEntitiesDetectionJobOutput, error)

StopEntitiesDetectionJob API operation for Amazon Comprehend.

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopEntitiesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob

func (*Comprehend) StopEntitiesDetectionJobRequest 

func (c *Comprehend) StopEntitiesDetectionJobRequest(input *StopEntitiesDetectionJobInput) (req *request.Request, output *StopEntitiesDetectionJobOutput)

StopEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopEntitiesDetectionJob for more information on using the StopEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopEntitiesDetectionJobRequest method.
req, resp := client.StopEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJob

func (*Comprehend) StopEntitiesDetectionJobWithContext 

func (c *Comprehend) StopEntitiesDetectionJobWithContext(ctx aws.Context, input *StopEntitiesDetectionJobInput, opts ...request.Option) (*StopEntitiesDetectionJobOutput, error)

StopEntitiesDetectionJobWithContext is the same as StopEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StopEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopEventsDetectionJob 

func (c *Comprehend) StopEventsDetectionJob(input *StopEventsDetectionJobInput) (*StopEventsDetectionJobOutput, error)

StopEventsDetectionJob API operation for Amazon Comprehend.

Stops an events detection job in progress.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopEventsDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob

func (*Comprehend) StopEventsDetectionJobRequest 

func (c *Comprehend) StopEventsDetectionJobRequest(input *StopEventsDetectionJobInput) (req *request.Request, output *StopEventsDetectionJobOutput)

StopEventsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopEventsDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopEventsDetectionJob for more information on using the StopEventsDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopEventsDetectionJobRequest method.
req, resp := client.StopEventsDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob

func (*Comprehend) StopEventsDetectionJobWithContext 

func (c *Comprehend) StopEventsDetectionJobWithContext(ctx aws.Context, input *StopEventsDetectionJobInput, opts ...request.Option) (*StopEventsDetectionJobOutput, error)

StopEventsDetectionJobWithContext is the same as StopEventsDetectionJob with the addition of the ability to pass a context and additional request options.

See StopEventsDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopKeyPhrasesDetectionJob 

func (c *Comprehend) StopKeyPhrasesDetectionJob(input *StopKeyPhrasesDetectionJobInput) (*StopKeyPhrasesDetectionJobOutput, error)

StopKeyPhrasesDetectionJob API operation for Amazon Comprehend.

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopKeyPhrasesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob

func (*Comprehend) StopKeyPhrasesDetectionJobRequest 

func (c *Comprehend) StopKeyPhrasesDetectionJobRequest(input *StopKeyPhrasesDetectionJobInput) (req *request.Request, output *StopKeyPhrasesDetectionJobOutput)

StopKeyPhrasesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopKeyPhrasesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopKeyPhrasesDetectionJob for more information on using the StopKeyPhrasesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopKeyPhrasesDetectionJobRequest method.
req, resp := client.StopKeyPhrasesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJob

func (*Comprehend) StopKeyPhrasesDetectionJobWithContext 

func (c *Comprehend) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, input *StopKeyPhrasesDetectionJobInput, opts ...request.Option) (*StopKeyPhrasesDetectionJobOutput, error)

StopKeyPhrasesDetectionJobWithContext is the same as StopKeyPhrasesDetectionJob with the addition of the ability to pass a context and additional request options.

See StopKeyPhrasesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopPiiEntitiesDetectionJob 

func (c *Comprehend) StopPiiEntitiesDetectionJob(input *StopPiiEntitiesDetectionJobInput) (*StopPiiEntitiesDetectionJobOutput, error)

StopPiiEntitiesDetectionJob API operation for Amazon Comprehend.

Stops a PII entities detection job in progress.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopPiiEntitiesDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob

func (*Comprehend) StopPiiEntitiesDetectionJobRequest 

func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDetectionJobInput) (req *request.Request, output *StopPiiEntitiesDetectionJobOutput)

StopPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopPiiEntitiesDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopPiiEntitiesDetectionJob for more information on using the StopPiiEntitiesDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopPiiEntitiesDetectionJobRequest method.
req, resp := client.StopPiiEntitiesDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob

func (*Comprehend) StopPiiEntitiesDetectionJobWithContext 

func (c *Comprehend) StopPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StopPiiEntitiesDetectionJobInput, opts ...request.Option) (*StopPiiEntitiesDetectionJobOutput, error)

StopPiiEntitiesDetectionJobWithContext is the same as StopPiiEntitiesDetectionJob with the addition of the ability to pass a context and additional request options.

See StopPiiEntitiesDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopSentimentDetectionJob 

func (c *Comprehend) StopSentimentDetectionJob(input *StopSentimentDetectionJobInput) (*StopSentimentDetectionJobOutput, error)

StopSentimentDetectionJob API operation for Amazon Comprehend.

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopSentimentDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob

func (*Comprehend) StopSentimentDetectionJobRequest 

func (c *Comprehend) StopSentimentDetectionJobRequest(input *StopSentimentDetectionJobInput) (req *request.Request, output *StopSentimentDetectionJobOutput)

StopSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopSentimentDetectionJob for more information on using the StopSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopSentimentDetectionJobRequest method.
req, resp := client.StopSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJob

func (*Comprehend) StopSentimentDetectionJobWithContext 

func (c *Comprehend) StopSentimentDetectionJobWithContext(ctx aws.Context, input *StopSentimentDetectionJobInput, opts ...request.Option) (*StopSentimentDetectionJobOutput, error)

StopSentimentDetectionJobWithContext is the same as StopSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See StopSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopTargetedSentimentDetectionJob added in v1.42.9 

func (c *Comprehend) StopTargetedSentimentDetectionJob(input *StopTargetedSentimentDetectionJobInput) (*StopTargetedSentimentDetectionJobOutput, error)

StopTargetedSentimentDetectionJob API operation for Amazon Comprehend.

Stops a targeted sentiment detection job in progress.

If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopTargetedSentimentDetectionJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • JobNotFoundException The specified job was not found. Check the job ID and try again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob

func (*Comprehend) StopTargetedSentimentDetectionJobRequest added in v1.42.9 

func (c *Comprehend) StopTargetedSentimentDetectionJobRequest(input *StopTargetedSentimentDetectionJobInput) (req *request.Request, output *StopTargetedSentimentDetectionJobOutput)

StopTargetedSentimentDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopTargetedSentimentDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopTargetedSentimentDetectionJob for more information on using the StopTargetedSentimentDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopTargetedSentimentDetectionJobRequest method.
req, resp := client.StopTargetedSentimentDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTargetedSentimentDetectionJob

func (*Comprehend) StopTargetedSentimentDetectionJobWithContext added in v1.42.9 

func (c *Comprehend) StopTargetedSentimentDetectionJobWithContext(ctx aws.Context, input *StopTargetedSentimentDetectionJobInput, opts ...request.Option) (*StopTargetedSentimentDetectionJobOutput, error)

StopTargetedSentimentDetectionJobWithContext is the same as StopTargetedSentimentDetectionJob with the addition of the ability to pass a context and additional request options.

See StopTargetedSentimentDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopTrainingDocumentClassifier 

func (c *Comprehend) StopTrainingDocumentClassifier(input *StopTrainingDocumentClassifierInput) (*StopTrainingDocumentClassifierOutput, error)

StopTrainingDocumentClassifier API operation for Amazon Comprehend.

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopTrainingDocumentClassifier for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier

func (*Comprehend) StopTrainingDocumentClassifierRequest 

func (c *Comprehend) StopTrainingDocumentClassifierRequest(input *StopTrainingDocumentClassifierInput) (req *request.Request, output *StopTrainingDocumentClassifierOutput)

StopTrainingDocumentClassifierRequest generates a "aws/request.Request" representing the client's request for the StopTrainingDocumentClassifier operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopTrainingDocumentClassifier for more information on using the StopTrainingDocumentClassifier API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopTrainingDocumentClassifierRequest method.
req, resp := client.StopTrainingDocumentClassifierRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingDocumentClassifier

func (*Comprehend) StopTrainingDocumentClassifierWithContext 

func (c *Comprehend) StopTrainingDocumentClassifierWithContext(ctx aws.Context, input *StopTrainingDocumentClassifierInput, opts ...request.Option) (*StopTrainingDocumentClassifierOutput, error)

StopTrainingDocumentClassifierWithContext is the same as StopTrainingDocumentClassifier with the addition of the ability to pass a context and additional request options.

See StopTrainingDocumentClassifier for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) StopTrainingEntityRecognizer 

func (c *Comprehend) StopTrainingEntityRecognizer(input *StopTrainingEntityRecognizerInput) (*StopTrainingEntityRecognizerOutput, error)

StopTrainingEntityRecognizer API operation for Amazon Comprehend.

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation StopTrainingEntityRecognizer for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer

func (*Comprehend) StopTrainingEntityRecognizerRequest 

func (c *Comprehend) StopTrainingEntityRecognizerRequest(input *StopTrainingEntityRecognizerInput) (req *request.Request, output *StopTrainingEntityRecognizerOutput)

StopTrainingEntityRecognizerRequest generates a "aws/request.Request" representing the client's request for the StopTrainingEntityRecognizer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopTrainingEntityRecognizer for more information on using the StopTrainingEntityRecognizer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopTrainingEntityRecognizerRequest method.
req, resp := client.StopTrainingEntityRecognizerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopTrainingEntityRecognizer

func (*Comprehend) StopTrainingEntityRecognizerWithContext 

func (c *Comprehend) StopTrainingEntityRecognizerWithContext(ctx aws.Context, input *StopTrainingEntityRecognizerInput, opts ...request.Option) (*StopTrainingEntityRecognizerOutput, error)

StopTrainingEntityRecognizerWithContext is the same as StopTrainingEntityRecognizer with the addition of the ability to pass a context and additional request options.

See StopTrainingEntityRecognizer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) TagResource 

func (c *Comprehend) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Comprehend.

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation TagResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResource

func (*Comprehend) TagResourceRequest 

func (c *Comprehend) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TagResource

func (*Comprehend) TagResourceWithContext 

func (c *Comprehend) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) UntagResource 

func (c *Comprehend) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Comprehend.

Removes a specific tag associated with an Amazon Comprehend resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation UntagResource for usage and error information.

Returned Error Types:

  • TooManyTagKeysException The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

  • InvalidRequestException The request is invalid.

  • ConcurrentModificationException Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResource

func (*Comprehend) UntagResourceRequest 

func (c *Comprehend) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UntagResource

func (*Comprehend) UntagResourceWithContext 

func (c *Comprehend) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) UpdateEndpoint 

func (c *Comprehend) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error)

UpdateEndpoint API operation for Amazon Comprehend.

Updates information about the specified endpoint. For information about endpoints, see Managing endpoints (https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation UpdateEndpoint for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.

  • ResourceLimitExceededException The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint

func (*Comprehend) UpdateEndpointRequest 

func (c *Comprehend) UpdateEndpointRequest(input *UpdateEndpointInput) (req *request.Request, output *UpdateEndpointOutput)

UpdateEndpointRequest generates a "aws/request.Request" representing the client's request for the UpdateEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEndpoint for more information on using the UpdateEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateEndpointRequest method.
req, resp := client.UpdateEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint

func (*Comprehend) UpdateEndpointWithContext 

func (c *Comprehend) UpdateEndpointWithContext(ctx aws.Context, input *UpdateEndpointInput, opts ...request.Option) (*UpdateEndpointOutput, error)

UpdateEndpointWithContext is the same as UpdateEndpoint with the addition of the ability to pass a context and additional request options.

See UpdateEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Comprehend) UpdateFlywheel added in v1.42.9 

func (c *Comprehend) UpdateFlywheel(input *UpdateFlywheelInput) (*UpdateFlywheelOutput, error)

UpdateFlywheel API operation for Amazon Comprehend.

Update the configuration information for an existing flywheel.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Comprehend's API operation UpdateFlywheel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is invalid.

  • TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.

  • KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

  • ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheel

func (*Comprehend) UpdateFlywheelRequest added in v1.42.9 

func (c *Comprehend) UpdateFlywheelRequest(input *UpdateFlywheelInput) (req *request.Request, output *UpdateFlywheelOutput)

UpdateFlywheelRequest generates a "aws/request.Request" representing the client's request for the UpdateFlywheel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFlywheel for more information on using the UpdateFlywheel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateFlywheelRequest method.
req, resp := client.UpdateFlywheelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheel

func (*Comprehend) UpdateFlywheelWithContext added in v1.42.9 

func (c *Comprehend) UpdateFlywheelWithContext(ctx aws.Context, input *UpdateFlywheelInput, opts ...request.Option) (*UpdateFlywheelOutput, error)

UpdateFlywheelWithContext is the same as UpdateFlywheel with the addition of the ability to pass a context and additional request options.

See UpdateFlywheel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

func (*ConcurrentModificationException) Code 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString 

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentModificationException) Message 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String 

func (s ConcurrentModificationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ContainsPiiEntitiesInput 

type ContainsPiiEntitiesInput struct {

	// The language of the input documents. 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 (ContainsPiiEntitiesInput) GoString 

func (s ContainsPiiEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainsPiiEntitiesInput) SetLanguageCode 

func (s *ContainsPiiEntitiesInput) SetLanguageCode(v string) *ContainsPiiEntitiesInput

SetLanguageCode sets the LanguageCode field's value.

func (*ContainsPiiEntitiesInput) SetText 

func (s *ContainsPiiEntitiesInput) SetText(v string) *ContainsPiiEntitiesInput

SetText sets the Text field's value.

func (ContainsPiiEntitiesInput) String 

func (s ContainsPiiEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainsPiiEntitiesInput) Validate 

func (s *ContainsPiiEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContainsPiiEntitiesOutput 

type ContainsPiiEntitiesOutput struct {

	// The labels used in the document being analyzed. Individual labels represent
	// personally identifiable information (PII) entity types.
	Labels []*EntityLabel `type:"list"`
	// contains filtered or unexported fields
}

func (ContainsPiiEntitiesOutput) GoString 

func (s ContainsPiiEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainsPiiEntitiesOutput) SetLabels 

func (s *ContainsPiiEntitiesOutput) SetLabels(v []*EntityLabel) *ContainsPiiEntitiesOutput

SetLabels sets the Labels field's value.

func (ContainsPiiEntitiesOutput) String 

func (s ContainsPiiEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDatasetInput added in v1.42.9 

type CreateDatasetInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Name of the dataset.
	//
	// DatasetName is a required field
	DatasetName *string `type:"string" required:"true"`

	// The dataset type. You can specify that the data in a dataset is for training
	// the model or for testing the model.
	DatasetType *string `type:"string" enum:"DatasetType"`

	// Description of the dataset.
	Description *string `type:"string"`

	// The Amazon Resource Number (ARN) of the flywheel of the flywheel to receive
	// the data.
	//
	// FlywheelArn is a required field
	FlywheelArn *string `type:"string" required:"true"`

	// Information about the input data configuration. The type of input data varies
	// based on the format of the input and whether the data is for a classifier
	// model or an entity recognition model.
	//
	// InputDataConfig is a required field
	InputDataConfig *DatasetInputDataConfig `type:"structure" required:"true"`

	// Tags for the dataset.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateDatasetInput) GoString added in v1.42.9 

func (s CreateDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetInput) SetClientRequestToken added in v1.42.9 

func (s *CreateDatasetInput) SetClientRequestToken(v string) *CreateDatasetInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDatasetInput) SetDatasetName added in v1.42.9 

func (s *CreateDatasetInput) SetDatasetName(v string) *CreateDatasetInput

SetDatasetName sets the DatasetName field's value.

func (*CreateDatasetInput) SetDatasetType added in v1.42.9 

func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput

SetDatasetType sets the DatasetType field's value.

func (*CreateDatasetInput) SetDescription added in v1.42.9 

func (s *CreateDatasetInput) SetDescription(v string) *CreateDatasetInput

SetDescription sets the Description field's value.

func (*CreateDatasetInput) SetFlywheelArn added in v1.42.9 

func (s *CreateDatasetInput) SetFlywheelArn(v string) *CreateDatasetInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*CreateDatasetInput) SetInputDataConfig added in v1.42.9 

func (s *CreateDatasetInput) SetInputDataConfig(v *DatasetInputDataConfig) *CreateDatasetInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateDatasetInput) SetTags added in v1.42.9 

func (s *CreateDatasetInput) SetTags(v []*Tag) *CreateDatasetInput

SetTags sets the Tags field's value.

func (CreateDatasetInput) String added in v1.42.9 

func (s CreateDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetInput) Validate added in v1.42.9 

func (s *CreateDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetOutput added in v1.42.9 

type CreateDatasetOutput struct {

	// The ARN of the dataset.
	DatasetArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetOutput) GoString added in v1.42.9 

func (s CreateDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDatasetOutput) SetDatasetArn added in v1.42.9 

func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput

SetDatasetArn sets the DatasetArn field's value.

func (CreateDatasetOutput) String added in v1.42.9 

func (s CreateDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDocumentClassifierInput 

type CreateDocumentClassifierInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The name of the document classifier.
	//
	// DocumentClassifierName is a required field
	DocumentClassifierName *string `type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *DocumentClassifierInputDataConfig `type:"structure" required:"true"`

	// The language of the input documents. You can specify any of the languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Indicates the mode in which the classifier will be trained. The classifier
	// can be trained in multi-class 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 KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string `type:"string"`

	// The resource-based policy to attach to your custom document classifier model.
	// You can use this policy to allow another Amazon Web Services account to import
	// your custom model.
	//
	// Provide your policy as a JSON body that you enter as a UTF-8 encoded string
	// without line breaks. To provide valid JSON, enclose the attribute names and
	// values in double quotes. If the JSON body is also enclosed in double quotes,
	// then you must escape the double quotes that are inside the policy:
	//
	// "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
	//
	// To avoid escaping quotes, you can use single quotes to enclose the policy
	// and double quotes to enclose the JSON names and values:
	//
	// '{"attribute": "value", "attribute": ["value"]}'
	ModelPolicy *string `min:"1" type:"string"`

	// Specifies the location for the output files from a custom classifier job.
	// This parameter is required for a request that creates a native classifier
	// model.
	OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

	// Tags to associate with the document classifier. A tag is a key-value pair
	// that adds as a metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// The version name given to the newly created classifier. Version names can
	// have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and
	// underscores (_) are allowed. The version name must be unique among all models
	// with the same classifier name in the Amazon Web Services account/Amazon Web
	// Services Region.
	VersionName *string `type:"string"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your custom classifier. For more
	// information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDocumentClassifierInput) GoString 

func (s CreateDocumentClassifierInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDocumentClassifierInput) SetClientRequestToken 

func (s *CreateDocumentClassifierInput) SetClientRequestToken(v string) *CreateDocumentClassifierInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDocumentClassifierInput) SetDataAccessRoleArn 

func (s *CreateDocumentClassifierInput) SetDataAccessRoleArn(v string) *CreateDocumentClassifierInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateDocumentClassifierInput) SetDocumentClassifierName 

func (s *CreateDocumentClassifierInput) SetDocumentClassifierName(v string) *CreateDocumentClassifierInput

SetDocumentClassifierName sets the DocumentClassifierName field's value.

func (*CreateDocumentClassifierInput) SetInputDataConfig 

func (s *CreateDocumentClassifierInput) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *CreateDocumentClassifierInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetLanguageCode 

func (s *CreateDocumentClassifierInput) SetLanguageCode(v string) *CreateDocumentClassifierInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateDocumentClassifierInput) SetMode 

func (s *CreateDocumentClassifierInput) SetMode(v string) *CreateDocumentClassifierInput

SetMode sets the Mode field's value.

func (*CreateDocumentClassifierInput) SetModelKmsKeyId 

func (s *CreateDocumentClassifierInput) SetModelKmsKeyId(v string) *CreateDocumentClassifierInput

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*CreateDocumentClassifierInput) SetModelPolicy added in v1.42.9 

func (s *CreateDocumentClassifierInput) SetModelPolicy(v string) *CreateDocumentClassifierInput

SetModelPolicy sets the ModelPolicy field's value.

func (*CreateDocumentClassifierInput) SetOutputDataConfig 

func (s *CreateDocumentClassifierInput) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *CreateDocumentClassifierInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetTags 

func (s *CreateDocumentClassifierInput) SetTags(v []*Tag) *CreateDocumentClassifierInput

SetTags sets the Tags field's value.

func (*CreateDocumentClassifierInput) SetVersionName 

func (s *CreateDocumentClassifierInput) SetVersionName(v string) *CreateDocumentClassifierInput

SetVersionName sets the VersionName field's value.

func (*CreateDocumentClassifierInput) SetVolumeKmsKeyId 

func (s *CreateDocumentClassifierInput) SetVolumeKmsKeyId(v string) *CreateDocumentClassifierInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateDocumentClassifierInput) SetVpcConfig 

func (s *CreateDocumentClassifierInput) SetVpcConfig(v *VpcConfig) *CreateDocumentClassifierInput

SetVpcConfig sets the VpcConfig field's value.

func (CreateDocumentClassifierInput) String 

func (s CreateDocumentClassifierInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDocumentClassifierInput) Validate 

func (s *CreateDocumentClassifierInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDocumentClassifierOutput 

type CreateDocumentClassifierOutput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateDocumentClassifierOutput) GoString 

func (s CreateDocumentClassifierOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDocumentClassifierOutput) SetDocumentClassifierArn 

func (s *CreateDocumentClassifierOutput) SetDocumentClassifierArn(v string) *CreateDocumentClassifierOutput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (CreateDocumentClassifierOutput) String 

func (s CreateDocumentClassifierOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEndpointInput 

type CreateEndpointInput struct {

	// An idempotency token provided by the customer. If this token matches a previous
	// endpoint creation request, Amazon Comprehend will not return a ResourceInUseException.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to trained custom models encrypted with a customer managed key
	// (ModelKmsKeyId).
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The desired number of inference units to be used by the model using this
	// endpoint. Each inference unit represents of a throughput of 100 characters
	// per second.
	//
	// DesiredInferenceUnits is a required field
	DesiredInferenceUnits *int64 `min:"1" type:"integer" required:"true"`

	// This is the descriptive suffix that becomes part of the EndpointArn used
	// for all subsequent requests to this resource.
	//
	// EndpointName is a required field
	EndpointName *string `type:"string" required:"true"`

	// The Amazon Resource Number (ARN) of the flywheel to which the endpoint will
	// be attached.
	FlywheelArn *string `type:"string"`

	// The Amazon Resource Number (ARN) of the model to which the endpoint will
	// be attached.
	ModelArn *string `type:"string"`

	// Tags to associate with the endpoint. A tag is a key-value pair that adds
	// metadata to the endpoint. For example, a tag with "Sales" as the key might
	// be added to an endpoint to indicate its use by the sales department.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateEndpointInput) GoString 

func (s CreateEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointInput) SetClientRequestToken 

func (s *CreateEndpointInput) SetClientRequestToken(v string) *CreateEndpointInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEndpointInput) SetDataAccessRoleArn 

func (s *CreateEndpointInput) SetDataAccessRoleArn(v string) *CreateEndpointInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateEndpointInput) SetDesiredInferenceUnits 

func (s *CreateEndpointInput) SetDesiredInferenceUnits(v int64) *CreateEndpointInput

SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value.

func (*CreateEndpointInput) SetEndpointName 

func (s *CreateEndpointInput) SetEndpointName(v string) *CreateEndpointInput

SetEndpointName sets the EndpointName field's value.

func (*CreateEndpointInput) SetFlywheelArn added in v1.42.9 

func (s *CreateEndpointInput) SetFlywheelArn(v string) *CreateEndpointInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*CreateEndpointInput) SetModelArn 

func (s *CreateEndpointInput) SetModelArn(v string) *CreateEndpointInput

SetModelArn sets the ModelArn field's value.

func (*CreateEndpointInput) SetTags 

func (s *CreateEndpointInput) SetTags(v []*Tag) *CreateEndpointInput

SetTags sets the Tags field's value.

func (CreateEndpointInput) String 

func (s CreateEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointInput) Validate 

func (s *CreateEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEndpointOutput 

type CreateEndpointOutput struct {

	// The Amazon Resource Number (ARN) of the endpoint being created.
	EndpointArn *string `type:"string"`

	// The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
	ModelArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateEndpointOutput) GoString 

func (s CreateEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointOutput) SetEndpointArn 

func (s *CreateEndpointOutput) SetEndpointArn(v string) *CreateEndpointOutput

SetEndpointArn sets the EndpointArn field's value.

func (*CreateEndpointOutput) SetModelArn added in v1.42.9 

func (s *CreateEndpointOutput) SetModelArn(v string) *CreateEndpointOutput

SetModelArn sets the ModelArn field's value.

func (CreateEndpointOutput) String 

func (s CreateEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEntityRecognizerInput 

type CreateEntityRecognizerInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data. The S3 bucket containing
	// the input data must be located in the same Region as the entity recognizer
	// being created.
	//
	// InputDataConfig is a required field
	InputDataConfig *EntityRecognizerInputDataConfig `type:"structure" required:"true"`

	// You can specify any of the following languages: English ("en"), Spanish ("es"),
	// French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you
	// plan to use this entity recognizer with PDF, Word, or image input files,
	// you must specify English as the language. All training documents must be
	// in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string `type:"string"`

	// The JSON resource-based policy to attach to your custom entity recognizer
	// model. You can use this policy to allow another Amazon Web Services account
	// to import your custom model.
	//
	// Provide your JSON as a UTF-8 encoded string without line breaks. To provide
	// valid JSON for your policy, enclose the attribute names and values in double
	// quotes. If the JSON body is also enclosed in double quotes, then you must
	// escape the double quotes that are inside the policy:
	//
	// "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
	//
	// To avoid escaping quotes, you can use single quotes to enclose the policy
	// and double quotes to enclose the JSON names and values:
	//
	// '{"attribute": "value", "attribute": ["value"]}'
	ModelPolicy *string `min:"1" type:"string"`

	// The name given to the newly created recognizer. Recognizer names can be a
	// maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
	// (_) are allowed. The name must be unique in the account/Region.
	//
	// RecognizerName is a required field
	RecognizerName *string `type:"string" required:"true"`

	// Tags to associate with the entity recognizer. A tag is a key-value pair that
	// adds as a metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// The version name given to the newly created recognizer. Version names can
	// be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and
	// underscores (_) are allowed. The version name must be unique among all models
	// with the same recognizer name in the account/Region.
	VersionName *string `type:"string"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your custom entity recognizer.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateEntityRecognizerInput) GoString 

func (s CreateEntityRecognizerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEntityRecognizerInput) SetClientRequestToken 

func (s *CreateEntityRecognizerInput) SetClientRequestToken(v string) *CreateEntityRecognizerInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEntityRecognizerInput) SetDataAccessRoleArn 

func (s *CreateEntityRecognizerInput) SetDataAccessRoleArn(v string) *CreateEntityRecognizerInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateEntityRecognizerInput) SetInputDataConfig 

func (s *CreateEntityRecognizerInput) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *CreateEntityRecognizerInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateEntityRecognizerInput) SetLanguageCode 

func (s *CreateEntityRecognizerInput) SetLanguageCode(v string) *CreateEntityRecognizerInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateEntityRecognizerInput) SetModelKmsKeyId 

func (s *CreateEntityRecognizerInput) SetModelKmsKeyId(v string) *CreateEntityRecognizerInput

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*CreateEntityRecognizerInput) SetModelPolicy added in v1.42.9 

func (s *CreateEntityRecognizerInput) SetModelPolicy(v string) *CreateEntityRecognizerInput

SetModelPolicy sets the ModelPolicy field's value.

func (*CreateEntityRecognizerInput) SetRecognizerName 

func (s *CreateEntityRecognizerInput) SetRecognizerName(v string) *CreateEntityRecognizerInput

SetRecognizerName sets the RecognizerName field's value.

func (*CreateEntityRecognizerInput) SetTags 

func (s *CreateEntityRecognizerInput) SetTags(v []*Tag) *CreateEntityRecognizerInput

SetTags sets the Tags field's value.

func (*CreateEntityRecognizerInput) SetVersionName 

func (s *CreateEntityRecognizerInput) SetVersionName(v string) *CreateEntityRecognizerInput

SetVersionName sets the VersionName field's value.

func (*CreateEntityRecognizerInput) SetVolumeKmsKeyId 

func (s *CreateEntityRecognizerInput) SetVolumeKmsKeyId(v string) *CreateEntityRecognizerInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateEntityRecognizerInput) SetVpcConfig 

func (s *CreateEntityRecognizerInput) SetVpcConfig(v *VpcConfig) *CreateEntityRecognizerInput

SetVpcConfig sets the VpcConfig field's value.

func (CreateEntityRecognizerInput) String 

func (s CreateEntityRecognizerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEntityRecognizerInput) Validate 

func (s *CreateEntityRecognizerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEntityRecognizerOutput 

type CreateEntityRecognizerOutput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateEntityRecognizerOutput) GoString 

func (s CreateEntityRecognizerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEntityRecognizerOutput) SetEntityRecognizerArn 

func (s *CreateEntityRecognizerOutput) SetEntityRecognizerArn(v string) *CreateEntityRecognizerOutput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (CreateEntityRecognizerOutput) String 

func (s CreateEntityRecognizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFlywheelInput added in v1.42.9 

type CreateFlywheelInput struct {

	// To associate an existing model with the flywheel, specify the Amazon Resource
	// Number (ARN) of the model version.
	ActiveModelArn *string `type:"string"`

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// the permissions required to access the flywheel data in the data lake.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Enter the S3 location for the data lake. You can specify a new S3 bucket
	// or a new folder of an existing S3 bucket. The flywheel creates the data lake
	// at this location.
	//
	// DataLakeS3Uri is a required field
	DataLakeS3Uri *string `type:"string" required:"true"`

	// Data security configurations.
	DataSecurityConfig *DataSecurityConfig `type:"structure"`

	// Name for the flywheel.
	//
	// FlywheelName is a required field
	FlywheelName *string `type:"string" required:"true"`

	// The model type.
	ModelType *string `type:"string" enum:"ModelType"`

	// The tags to associate with this flywheel.
	Tags []*Tag `type:"list"`

	// Configuration about the custom classifier associated with the flywheel.
	TaskConfig *TaskConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateFlywheelInput) GoString added in v1.42.9 

func (s CreateFlywheelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlywheelInput) SetActiveModelArn added in v1.42.9 

func (s *CreateFlywheelInput) SetActiveModelArn(v string) *CreateFlywheelInput

SetActiveModelArn sets the ActiveModelArn field's value.

func (*CreateFlywheelInput) SetClientRequestToken added in v1.42.9 

func (s *CreateFlywheelInput) SetClientRequestToken(v string) *CreateFlywheelInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateFlywheelInput) SetDataAccessRoleArn added in v1.42.9 

func (s *CreateFlywheelInput) SetDataAccessRoleArn(v string) *CreateFlywheelInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateFlywheelInput) SetDataLakeS3Uri added in v1.42.9 

func (s *CreateFlywheelInput) SetDataLakeS3Uri(v string) *CreateFlywheelInput

SetDataLakeS3Uri sets the DataLakeS3Uri field's value.

func (*CreateFlywheelInput) SetDataSecurityConfig added in v1.42.9 

func (s *CreateFlywheelInput) SetDataSecurityConfig(v *DataSecurityConfig) *CreateFlywheelInput

SetDataSecurityConfig sets the DataSecurityConfig field's value.

func (*CreateFlywheelInput) SetFlywheelName added in v1.42.9 

func (s *CreateFlywheelInput) SetFlywheelName(v string) *CreateFlywheelInput

SetFlywheelName sets the FlywheelName field's value.

func (*CreateFlywheelInput) SetModelType added in v1.42.9 

func (s *CreateFlywheelInput) SetModelType(v string) *CreateFlywheelInput

SetModelType sets the ModelType field's value.

func (*CreateFlywheelInput) SetTags added in v1.42.9 

func (s *CreateFlywheelInput) SetTags(v []*Tag) *CreateFlywheelInput

SetTags sets the Tags field's value.

func (*CreateFlywheelInput) SetTaskConfig added in v1.42.9 

func (s *CreateFlywheelInput) SetTaskConfig(v *TaskConfig) *CreateFlywheelInput

SetTaskConfig sets the TaskConfig field's value.

func (CreateFlywheelInput) String added in v1.42.9 

func (s CreateFlywheelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlywheelInput) Validate added in v1.42.9 

func (s *CreateFlywheelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFlywheelOutput added in v1.42.9 

type CreateFlywheelOutput struct {

	// The Amazon Resource Number (ARN) of the active model version.
	ActiveModelArn *string `type:"string"`

	// The Amazon Resource Number (ARN) of the flywheel.
	FlywheelArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateFlywheelOutput) GoString added in v1.42.9 

func (s CreateFlywheelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFlywheelOutput) SetActiveModelArn added in v1.42.9 

func (s *CreateFlywheelOutput) SetActiveModelArn(v string) *CreateFlywheelOutput

SetActiveModelArn sets the ActiveModelArn field's value.

func (*CreateFlywheelOutput) SetFlywheelArn added in v1.42.9 

func (s *CreateFlywheelOutput) SetFlywheelArn(v string) *CreateFlywheelOutput

SetFlywheelArn sets the FlywheelArn field's value.

func (CreateFlywheelOutput) String added in v1.42.9 

func (s CreateFlywheelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSecurityConfig added in v1.42.9 

type DataSecurityConfig struct {

	// ID for the KMS key that Amazon Comprehend uses to encrypt the data in the
	// data lake.
	DataLakeKmsKeyId *string `type:"string"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string `type:"string"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for the job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Data security configuration.

func (DataSecurityConfig) GoString added in v1.42.9 

func (s DataSecurityConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSecurityConfig) SetDataLakeKmsKeyId added in v1.42.9 

func (s *DataSecurityConfig) SetDataLakeKmsKeyId(v string) *DataSecurityConfig

SetDataLakeKmsKeyId sets the DataLakeKmsKeyId field's value.

func (*DataSecurityConfig) SetModelKmsKeyId added in v1.42.9 

func (s *DataSecurityConfig) SetModelKmsKeyId(v string) *DataSecurityConfig

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*DataSecurityConfig) SetVolumeKmsKeyId added in v1.42.9 

func (s *DataSecurityConfig) SetVolumeKmsKeyId(v string) *DataSecurityConfig

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DataSecurityConfig) SetVpcConfig added in v1.42.9 

func (s *DataSecurityConfig) SetVpcConfig(v *VpcConfig) *DataSecurityConfig

SetVpcConfig sets the VpcConfig field's value.

func (DataSecurityConfig) String added in v1.42.9 

func (s DataSecurityConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSecurityConfig) Validate added in v1.42.9 

func (s *DataSecurityConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetAugmentedManifestsListItem added in v1.42.9 

type DatasetAugmentedManifestsListItem struct {

	// The S3 prefix to the annotation files that are referred in the augmented
	// manifest file.
	AnnotationDataS3Uri *string `type:"string"`

	// The JSON attribute that contains the annotations for your training documents.
	// The number of attribute names that you specify depends on whether your augmented
	// manifest file is the output of a single labeling job or a chained labeling
	// job.
	//
	// If your file is the output of a single labeling job, specify the LabelAttributeName
	// key that was used when the job was created in Ground Truth.
	//
	// If your file is the output of a chained labeling job, specify the LabelAttributeName
	// key for one or more jobs in the chain. Each LabelAttributeName key provides
	// the annotations from an individual job.
	//
	// AttributeNames is a required field
	AttributeNames []*string `type:"list" required:"true"`

	// The type of augmented manifest. If you don't specify, the default is PlainTextDocument.
	//
	// PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that
	// is encoded in UTF-8.
	DocumentType *string `type:"string" enum:"AugmentedManifestsDocumentTypeFormat"`

	// The Amazon S3 location of the augmented manifest file.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`

	// The S3 prefix to the source files (PDFs) that are referred to in the augmented
	// manifest file.
	SourceDocumentsS3Uri *string `type:"string"`
	// contains filtered or unexported fields
}

An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

func (DatasetAugmentedManifestsListItem) GoString added in v1.42.9 

func (s DatasetAugmentedManifestsListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetAugmentedManifestsListItem) SetAnnotationDataS3Uri added in v1.42.9 

func (s *DatasetAugmentedManifestsListItem) SetAnnotationDataS3Uri(v string) *DatasetAugmentedManifestsListItem

SetAnnotationDataS3Uri sets the AnnotationDataS3Uri field's value.

func (*DatasetAugmentedManifestsListItem) SetAttributeNames added in v1.42.9 

func (s *DatasetAugmentedManifestsListItem) SetAttributeNames(v []*string) *DatasetAugmentedManifestsListItem

SetAttributeNames sets the AttributeNames field's value.

func (*DatasetAugmentedManifestsListItem) SetDocumentType added in v1.42.9 

func (s *DatasetAugmentedManifestsListItem) SetDocumentType(v string) *DatasetAugmentedManifestsListItem

SetDocumentType sets the DocumentType field's value.

func (*DatasetAugmentedManifestsListItem) SetS3Uri added in v1.42.9 

func (s *DatasetAugmentedManifestsListItem) SetS3Uri(v string) *DatasetAugmentedManifestsListItem

SetS3Uri sets the S3Uri field's value.

func (*DatasetAugmentedManifestsListItem) SetSourceDocumentsS3Uri added in v1.42.9 

func (s *DatasetAugmentedManifestsListItem) SetSourceDocumentsS3Uri(v string) *DatasetAugmentedManifestsListItem

SetSourceDocumentsS3Uri sets the SourceDocumentsS3Uri field's value.

func (DatasetAugmentedManifestsListItem) String added in v1.42.9 

func (s DatasetAugmentedManifestsListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetAugmentedManifestsListItem) Validate added in v1.42.9 

func (s *DatasetAugmentedManifestsListItem) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetDocumentClassifierInputDataConfig added in v1.42.9 

type DatasetDocumentClassifierInputDataConfig struct {

	// Indicates the delimiter used to separate each label for training a multi-label
	// classifier. The default delimiter between labels is a pipe (|). You can use
	// a different character as a delimiter (if it's an allowed character) by specifying
	// it under Delimiter for labels. If the training documents use a delimiter
	// other than the default or the delimiter you specify, the labels on that line
	// will be combined to make a single unique label, such as LABELLABELLABEL.
	LabelDelimiter *string `min:"1" type:"string"`

	// The Amazon S3 URI for the input data. The S3 bucket must be in the same Region
	// as the API endpoint that you are calling. The URI can point to a single input
	// file or it can provide the prefix for a collection of input files.
	//
	// For example, if you use the URI S3://bucketName/prefix, if the prefix is
	// a single file, Amazon Comprehend uses that file as input. If more than one
	// file begins with the prefix, Amazon Comprehend uses all of them as input.
	//
	// This parameter is required if you set DataFormat to COMPREHEND_CSV.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the dataset input data configuration for a document classifier model.

For more information on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html) in the Comprehend Developer Guide.

func (DatasetDocumentClassifierInputDataConfig) GoString added in v1.42.9 

func (s DatasetDocumentClassifierInputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetDocumentClassifierInputDataConfig) SetLabelDelimiter added in v1.42.9 

func (s *DatasetDocumentClassifierInputDataConfig) SetLabelDelimiter(v string) *DatasetDocumentClassifierInputDataConfig

SetLabelDelimiter sets the LabelDelimiter field's value.

func (*DatasetDocumentClassifierInputDataConfig) SetS3Uri added in v1.42.9 

func (s *DatasetDocumentClassifierInputDataConfig) SetS3Uri(v string) *DatasetDocumentClassifierInputDataConfig

SetS3Uri sets the S3Uri field's value.

func (DatasetDocumentClassifierInputDataConfig) String added in v1.42.9 

func (s DatasetDocumentClassifierInputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetDocumentClassifierInputDataConfig) Validate added in v1.42.9 

func (s *DatasetDocumentClassifierInputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetEntityRecognizerAnnotations added in v1.42.9 

type DatasetEntityRecognizerAnnotations struct {

	// Specifies the Amazon S3 location where the training documents for an entity
	// recognizer are located. The URI must be in the same Region as the API endpoint
	// that you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the annotations associated with a entity recognizer.

func (DatasetEntityRecognizerAnnotations) GoString added in v1.42.9 

func (s DatasetEntityRecognizerAnnotations) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerAnnotations) SetS3Uri added in v1.42.9 

func (s *DatasetEntityRecognizerAnnotations) SetS3Uri(v string) *DatasetEntityRecognizerAnnotations

SetS3Uri sets the S3Uri field's value.

func (DatasetEntityRecognizerAnnotations) String added in v1.42.9 

func (s DatasetEntityRecognizerAnnotations) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerAnnotations) Validate added in v1.42.9 

func (s *DatasetEntityRecognizerAnnotations) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetEntityRecognizerDocuments added in v1.42.9 

type DatasetEntityRecognizerDocuments struct {

	// Specifies how the text in an input file should be processed. This is optional,
	// and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered
	// a separate document. Use this option when you are processing large documents,
	// such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each
	// line in a file is considered a separate document. Use this option when you
	// are processing many short documents, such as text messages.
	InputFormat *string `type:"string" enum:"InputFormat"`

	// Specifies the Amazon S3 location where the documents for the dataset are
	// located.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the documents submitted with a dataset for an entity recognizer model.

func (DatasetEntityRecognizerDocuments) GoString added in v1.42.9 

func (s DatasetEntityRecognizerDocuments) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerDocuments) SetInputFormat added in v1.42.9 

func (s *DatasetEntityRecognizerDocuments) SetInputFormat(v string) *DatasetEntityRecognizerDocuments

SetInputFormat sets the InputFormat field's value.

func (*DatasetEntityRecognizerDocuments) SetS3Uri added in v1.42.9 

func (s *DatasetEntityRecognizerDocuments) SetS3Uri(v string) *DatasetEntityRecognizerDocuments

SetS3Uri sets the S3Uri field's value.

func (DatasetEntityRecognizerDocuments) String added in v1.42.9 

func (s DatasetEntityRecognizerDocuments) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerDocuments) Validate added in v1.42.9 

func (s *DatasetEntityRecognizerDocuments) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetEntityRecognizerEntityList added in v1.42.9 

type DatasetEntityRecognizerEntityList struct {

	// Specifies the Amazon S3 location where the entity list is located.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the dataset entity list for an entity recognizer model.

For more information on how the input file is formatted, see Preparing training data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-training-data-cer.html) in the Comprehend Developer Guide.

func (DatasetEntityRecognizerEntityList) GoString added in v1.42.9 

func (s DatasetEntityRecognizerEntityList) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerEntityList) SetS3Uri added in v1.42.9 

func (s *DatasetEntityRecognizerEntityList) SetS3Uri(v string) *DatasetEntityRecognizerEntityList

SetS3Uri sets the S3Uri field's value.

func (DatasetEntityRecognizerEntityList) String added in v1.42.9 

func (s DatasetEntityRecognizerEntityList) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerEntityList) Validate added in v1.42.9 

func (s *DatasetEntityRecognizerEntityList) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetEntityRecognizerInputDataConfig added in v1.42.9 

type DatasetEntityRecognizerInputDataConfig struct {

	// The S3 location of the annotation documents for your custom entity recognizer.
	Annotations *DatasetEntityRecognizerAnnotations `type:"structure"`

	// The format and location of the training documents for your custom entity
	// recognizer.
	//
	// Documents is a required field
	Documents *DatasetEntityRecognizerDocuments `type:"structure" required:"true"`

	// The S3 location of the entity list for your custom entity recognizer.
	EntityList *DatasetEntityRecognizerEntityList `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the format and location of the input data. You must provide either the Annotations parameter or the EntityList parameter.

func (DatasetEntityRecognizerInputDataConfig) GoString added in v1.42.9 

func (s DatasetEntityRecognizerInputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerInputDataConfig) SetAnnotations added in v1.42.9 

func (s *DatasetEntityRecognizerInputDataConfig) SetAnnotations(v *DatasetEntityRecognizerAnnotations) *DatasetEntityRecognizerInputDataConfig

SetAnnotations sets the Annotations field's value.

func (*DatasetEntityRecognizerInputDataConfig) SetDocuments added in v1.42.9 

func (s *DatasetEntityRecognizerInputDataConfig) SetDocuments(v *DatasetEntityRecognizerDocuments) *DatasetEntityRecognizerInputDataConfig

SetDocuments sets the Documents field's value.

func (*DatasetEntityRecognizerInputDataConfig) SetEntityList added in v1.42.9 

func (s *DatasetEntityRecognizerInputDataConfig) SetEntityList(v *DatasetEntityRecognizerEntityList) *DatasetEntityRecognizerInputDataConfig

SetEntityList sets the EntityList field's value.

func (DatasetEntityRecognizerInputDataConfig) String added in v1.42.9 

func (s DatasetEntityRecognizerInputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetEntityRecognizerInputDataConfig) Validate added in v1.42.9 

func (s *DatasetEntityRecognizerInputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetFilter added in v1.42.9 

type DatasetFilter struct {

	// Filter the datasets to include datasets created after the specified time.
	CreationTimeAfter *time.Time `type:"timestamp"`

	// Filter the datasets to include datasets created before the specified time.
	CreationTimeBefore *time.Time `type:"timestamp"`

	// Filter the datasets based on the dataset type.
	DatasetType *string `type:"string" enum:"DatasetType"`

	// Filter the datasets based on the dataset status.
	Status *string `type:"string" enum:"DatasetStatus"`
	// contains filtered or unexported fields
}

Filter the datasets based on creation time or dataset status.

func (DatasetFilter) GoString added in v1.42.9 

func (s DatasetFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetFilter) SetCreationTimeAfter added in v1.42.9 

func (s *DatasetFilter) SetCreationTimeAfter(v time.Time) *DatasetFilter

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*DatasetFilter) SetCreationTimeBefore added in v1.42.9 

func (s *DatasetFilter) SetCreationTimeBefore(v time.Time) *DatasetFilter

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (*DatasetFilter) SetDatasetType added in v1.42.9 

func (s *DatasetFilter) SetDatasetType(v string) *DatasetFilter

SetDatasetType sets the DatasetType field's value.

func (*DatasetFilter) SetStatus added in v1.42.9 

func (s *DatasetFilter) SetStatus(v string) *DatasetFilter

SetStatus sets the Status field's value.

func (DatasetFilter) String added in v1.42.9 

func (s DatasetFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DatasetInputDataConfig added in v1.42.9 

type DatasetInputDataConfig struct {

	// A list of augmented manifest files that provide training data for your custom
	// model. An augmented manifest file is a labeled dataset that is produced by
	// Amazon SageMaker Ground Truth.
	AugmentedManifests []*DatasetAugmentedManifestsListItem `type:"list"`

	// COMPREHEND_CSV: The data format is a two-column CSV file, where the first
	// column contains labels and the second column contains documents.
	//
	// AUGMENTED_MANIFEST: The data format
	DataFormat *string `type:"string" enum:"DatasetDataFormat"`

	// The input properties for training a document classifier model.
	//
	// For more information on how the input file is formatted, see Preparing training
	// data (https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html)
	// in the Comprehend Developer Guide.
	DocumentClassifierInputDataConfig *DatasetDocumentClassifierInputDataConfig `type:"structure"`

	// The input properties for training an entity recognizer model.
	EntityRecognizerInputDataConfig *DatasetEntityRecognizerInputDataConfig `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the format and location of the input data for the dataset.

func (DatasetInputDataConfig) GoString added in v1.42.9 

func (s DatasetInputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetInputDataConfig) SetAugmentedManifests added in v1.42.9 

func (s *DatasetInputDataConfig) SetAugmentedManifests(v []*DatasetAugmentedManifestsListItem) *DatasetInputDataConfig

SetAugmentedManifests sets the AugmentedManifests field's value.

func (*DatasetInputDataConfig) SetDataFormat added in v1.42.9 

func (s *DatasetInputDataConfig) SetDataFormat(v string) *DatasetInputDataConfig

SetDataFormat sets the DataFormat field's value.

func (*DatasetInputDataConfig) SetDocumentClassifierInputDataConfig added in v1.42.9 

func (s *DatasetInputDataConfig) SetDocumentClassifierInputDataConfig(v *DatasetDocumentClassifierInputDataConfig) *DatasetInputDataConfig

SetDocumentClassifierInputDataConfig sets the DocumentClassifierInputDataConfig field's value.

func (*DatasetInputDataConfig) SetEntityRecognizerInputDataConfig added in v1.42.9 

func (s *DatasetInputDataConfig) SetEntityRecognizerInputDataConfig(v *DatasetEntityRecognizerInputDataConfig) *DatasetInputDataConfig

SetEntityRecognizerInputDataConfig sets the EntityRecognizerInputDataConfig field's value.

func (DatasetInputDataConfig) String added in v1.42.9 

func (s DatasetInputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetInputDataConfig) Validate added in v1.42.9 

func (s *DatasetInputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetProperties added in v1.42.9 

type DatasetProperties struct {

	// Creation time of the dataset.
	CreationTime *time.Time `type:"timestamp"`

	// The ARN of the dataset.
	DatasetArn *string `type:"string"`

	// The name of the dataset.
	DatasetName *string `type:"string"`

	// The S3 URI where the dataset is stored.
	DatasetS3Uri *string `type:"string"`

	// The dataset type (training data or test data).
	DatasetType *string `type:"string" enum:"DatasetType"`

	// Description of the dataset.
	Description *string `type:"string"`

	// Time when the data from the dataset becomes available in the data lake.
	EndTime *time.Time `type:"timestamp"`

	// A description of the status of the dataset.
	Message *string `type:"string"`

	// The number of documents in the dataset.
	NumberOfDocuments *int64 `type:"long"`

	// The dataset status. While the system creates the dataset, the status is CREATING.
	// When the dataset is ready to use, the status changes to COMPLETED.
	Status *string `type:"string" enum:"DatasetStatus"`
	// contains filtered or unexported fields
}

Properties associated with the dataset.

func (DatasetProperties) GoString added in v1.42.9 

func (s DatasetProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetProperties) SetCreationTime added in v1.42.9 

func (s *DatasetProperties) SetCreationTime(v time.Time) *DatasetProperties

SetCreationTime sets the CreationTime field's value.

func (*DatasetProperties) SetDatasetArn added in v1.42.9 

func (s *DatasetProperties) SetDatasetArn(v string) *DatasetProperties

SetDatasetArn sets the DatasetArn field's value.

func (*DatasetProperties) SetDatasetName added in v1.42.9 

func (s *DatasetProperties) SetDatasetName(v string) *DatasetProperties

SetDatasetName sets the DatasetName field's value.

func (*DatasetProperties) SetDatasetS3Uri added in v1.42.9 

func (s *DatasetProperties) SetDatasetS3Uri(v string) *DatasetProperties

SetDatasetS3Uri sets the DatasetS3Uri field's value.

func (*DatasetProperties) SetDatasetType added in v1.42.9 

func (s *DatasetProperties) SetDatasetType(v string) *DatasetProperties

SetDatasetType sets the DatasetType field's value.

func (*DatasetProperties) SetDescription added in v1.42.9 

func (s *DatasetProperties) SetDescription(v string) *DatasetProperties

SetDescription sets the Description field's value.

func (*DatasetProperties) SetEndTime added in v1.42.9 

func (s *DatasetProperties) SetEndTime(v time.Time) *DatasetProperties

SetEndTime sets the EndTime field's value.

func (*DatasetProperties) SetMessage added in v1.42.9 

func (s *DatasetProperties) SetMessage(v string) *DatasetProperties

SetMessage sets the Message field's value.

func (*DatasetProperties) SetNumberOfDocuments added in v1.42.9 

func (s *DatasetProperties) SetNumberOfDocuments(v int64) *DatasetProperties

SetNumberOfDocuments sets the NumberOfDocuments field's value.

func (*DatasetProperties) SetStatus added in v1.42.9 

func (s *DatasetProperties) SetStatus(v string) *DatasetProperties

SetStatus sets the Status field's value.

func (DatasetProperties) String added in v1.42.9 

func (s DatasetProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDocumentClassifierInput 

type DeleteDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	//
	// DocumentClassifierArn is a required field
	DocumentClassifierArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDocumentClassifierInput) GoString 

func (s DeleteDocumentClassifierInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDocumentClassifierInput) SetDocumentClassifierArn 

func (s *DeleteDocumentClassifierInput) SetDocumentClassifierArn(v string) *DeleteDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DeleteDocumentClassifierInput) String 

func (s DeleteDocumentClassifierInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDocumentClassifierInput) Validate 

func (s *DeleteDocumentClassifierInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDocumentClassifierOutput 

type DeleteDocumentClassifierOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDocumentClassifierOutput) GoString 

func (s DeleteDocumentClassifierOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDocumentClassifierOutput) String 

func (s DeleteDocumentClassifierOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEndpointInput 

type DeleteEndpointInput struct {

	// The Amazon Resource Number (ARN) of the endpoint being deleted.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEndpointInput) GoString 

func (s DeleteEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEndpointInput) SetEndpointArn 

func (s *DeleteEndpointInput) SetEndpointArn(v string) *DeleteEndpointInput

SetEndpointArn sets the EndpointArn field's value.

func (DeleteEndpointInput) String 

func (s DeleteEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEndpointInput) Validate 

func (s *DeleteEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEndpointOutput 

type DeleteEndpointOutput struct {
	// contains filtered or unexported fields
}

func (DeleteEndpointOutput) GoString 

func (s DeleteEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEndpointOutput) String 

func (s DeleteEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEntityRecognizerInput 

type DeleteEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	//
	// EntityRecognizerArn is a required field
	EntityRecognizerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEntityRecognizerInput) GoString 

func (s DeleteEntityRecognizerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEntityRecognizerInput) SetEntityRecognizerArn 

func (s *DeleteEntityRecognizerInput) SetEntityRecognizerArn(v string) *DeleteEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DeleteEntityRecognizerInput) String 

func (s DeleteEntityRecognizerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEntityRecognizerInput) Validate 

func (s *DeleteEntityRecognizerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEntityRecognizerOutput 

type DeleteEntityRecognizerOutput struct {
	// contains filtered or unexported fields
}

func (DeleteEntityRecognizerOutput) GoString 

func (s DeleteEntityRecognizerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEntityRecognizerOutput) String 

func (s DeleteEntityRecognizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFlywheelInput added in v1.42.9 

type DeleteFlywheelInput struct {

	// The Amazon Resource Number (ARN) of the flywheel to delete.
	//
	// FlywheelArn is a required field
	FlywheelArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFlywheelInput) GoString added in v1.42.9 

func (s DeleteFlywheelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFlywheelInput) SetFlywheelArn added in v1.42.9 

func (s *DeleteFlywheelInput) SetFlywheelArn(v string) *DeleteFlywheelInput

SetFlywheelArn sets the FlywheelArn field's value.

func (DeleteFlywheelInput) String added in v1.42.9 

func (s DeleteFlywheelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFlywheelInput) Validate added in v1.42.9 

func (s *DeleteFlywheelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFlywheelOutput added in v1.42.9 

type DeleteFlywheelOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFlywheelOutput) GoString added in v1.42.9 

func (s DeleteFlywheelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFlywheelOutput) String added in v1.42.9 

func (s DeleteFlywheelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteResourcePolicyInput added in v1.42.9 

type DeleteResourcePolicyInput struct {

	// The revision ID of the policy to delete.
	PolicyRevisionId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the custom model version that has the policy
	// to delete.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteResourcePolicyInput) GoString added in v1.42.9 

func (s DeleteResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourcePolicyInput) SetPolicyRevisionId added in v1.42.9 

func (s *DeleteResourcePolicyInput) SetPolicyRevisionId(v string) *DeleteResourcePolicyInput

SetPolicyRevisionId sets the PolicyRevisionId field's value.

func (*DeleteResourcePolicyInput) SetResourceArn added in v1.42.9 

func (s *DeleteResourcePolicyInput) SetResourceArn(v string) *DeleteResourcePolicyInput

SetResourceArn sets the ResourceArn field's value.

func (DeleteResourcePolicyInput) String added in v1.42.9 

func (s DeleteResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourcePolicyInput) Validate added in v1.42.9 

func (s *DeleteResourcePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteResourcePolicyOutput added in v1.42.9 

type DeleteResourcePolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteResourcePolicyOutput) GoString added in v1.42.9 

func (s DeleteResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteResourcePolicyOutput) String added in v1.42.9 

func (s DeleteResourcePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDatasetInput added in v1.42.9 

type DescribeDatasetInput struct {

	// The ARN of the dataset.
	//
	// DatasetArn is a required field
	DatasetArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetInput) GoString added in v1.42.9 

func (s DescribeDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetInput) SetDatasetArn added in v1.42.9 

func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DescribeDatasetInput) String added in v1.42.9 

func (s DescribeDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetInput) Validate added in v1.42.9 

func (s *DescribeDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetOutput added in v1.42.9 

type DescribeDatasetOutput struct {

	// The dataset properties.
	DatasetProperties *DatasetProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatasetOutput) GoString added in v1.42.9 

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDatasetOutput) SetDatasetProperties added in v1.42.9 

func (s *DescribeDatasetOutput) SetDatasetProperties(v *DatasetProperties) *DescribeDatasetOutput

SetDatasetProperties sets the DatasetProperties field's value.

func (DescribeDatasetOutput) String added in v1.42.9 

func (s DescribeDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDocumentClassificationJobInput 

type DescribeDocumentClassificationJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The StartDocumentClassificationJob
	// operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDocumentClassificationJobInput) GoString 

func (s DescribeDocumentClassificationJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentClassificationJobInput) SetJobId 

func (s *DescribeDocumentClassificationJobInput) SetJobId(v string) *DescribeDocumentClassificationJobInput

SetJobId sets the JobId field's value.

func (DescribeDocumentClassificationJobInput) String 

func (s DescribeDocumentClassificationJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentClassificationJobInput) Validate 

func (s *DescribeDocumentClassificationJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDocumentClassificationJobOutput 

type DescribeDocumentClassificationJobOutput struct {

	// An object that describes the properties associated with the document classification
	// job.
	DocumentClassificationJobProperties *DocumentClassificationJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDocumentClassificationJobOutput) GoString 

func (s DescribeDocumentClassificationJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties 

func (s *DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties(v *DocumentClassificationJobProperties) *DescribeDocumentClassificationJobOutput

SetDocumentClassificationJobProperties sets the DocumentClassificationJobProperties field's value.

func (DescribeDocumentClassificationJobOutput) String 

func (s DescribeDocumentClassificationJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDocumentClassifierInput 

type DescribeDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier. The
	// CreateDocumentClassifier operation returns this identifier in its response.
	//
	// DocumentClassifierArn is a required field
	DocumentClassifierArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDocumentClassifierInput) GoString 

func (s DescribeDocumentClassifierInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentClassifierInput) SetDocumentClassifierArn 

func (s *DescribeDocumentClassifierInput) SetDocumentClassifierArn(v string) *DescribeDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DescribeDocumentClassifierInput) String 

func (s DescribeDocumentClassifierInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentClassifierInput) Validate 

func (s *DescribeDocumentClassifierInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDocumentClassifierOutput 

type DescribeDocumentClassifierOutput struct {

	// An object that contains the properties associated with a document classifier.
	DocumentClassifierProperties *DocumentClassifierProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDocumentClassifierOutput) GoString 

func (s DescribeDocumentClassifierOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDocumentClassifierOutput) SetDocumentClassifierProperties 

func (s *DescribeDocumentClassifierOutput) SetDocumentClassifierProperties(v *DocumentClassifierProperties) *DescribeDocumentClassifierOutput

SetDocumentClassifierProperties sets the DocumentClassifierProperties field's value.

func (DescribeDocumentClassifierOutput) String 

func (s DescribeDocumentClassifierOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDominantLanguageDetectionJobInput 

type DescribeDominantLanguageDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The StartDominantLanguageDetectionJob
	// operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDominantLanguageDetectionJobInput) GoString 

func (s DescribeDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDominantLanguageDetectionJobInput) SetJobId 

func (s *DescribeDominantLanguageDetectionJobInput) SetJobId(v string) *DescribeDominantLanguageDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeDominantLanguageDetectionJobInput) String 

func (s DescribeDominantLanguageDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDominantLanguageDetectionJobInput) Validate 

func (s *DescribeDominantLanguageDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDominantLanguageDetectionJobOutput 

type DescribeDominantLanguageDetectionJobOutput struct {

	// An object that contains the properties associated with a dominant language
	// detection job.
	DominantLanguageDetectionJobProperties *DominantLanguageDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDominantLanguageDetectionJobOutput) GoString 

func (s DescribeDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties 

func (s *DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties(v *DominantLanguageDetectionJobProperties) *DescribeDominantLanguageDetectionJobOutput

SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value.

func (DescribeDominantLanguageDetectionJobOutput) String 

func (s DescribeDominantLanguageDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEndpointInput 

type DescribeEndpointInput struct {

	// The Amazon Resource Number (ARN) of the endpoint being described.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEndpointInput) GoString 

func (s DescribeEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEndpointInput) SetEndpointArn 

func (s *DescribeEndpointInput) SetEndpointArn(v string) *DescribeEndpointInput

SetEndpointArn sets the EndpointArn field's value.

func (DescribeEndpointInput) String 

func (s DescribeEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEndpointInput) Validate 

func (s *DescribeEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEndpointOutput 

type DescribeEndpointOutput struct {

	// Describes information associated with the specific endpoint.
	EndpointProperties *EndpointProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEndpointOutput) GoString 

func (s DescribeEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEndpointOutput) SetEndpointProperties 

func (s *DescribeEndpointOutput) SetEndpointProperties(v *EndpointProperties) *DescribeEndpointOutput

SetEndpointProperties sets the EndpointProperties field's value.

func (DescribeEndpointOutput) String 

func (s DescribeEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEntitiesDetectionJobInput 

type DescribeEntitiesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob
	// operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEntitiesDetectionJobInput) GoString 

func (s DescribeEntitiesDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntitiesDetectionJobInput) SetJobId 

func (s *DescribeEntitiesDetectionJobInput) SetJobId(v string) *DescribeEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionJobInput) String 

func (s DescribeEntitiesDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntitiesDetectionJobInput) Validate 

func (s *DescribeEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEntitiesDetectionJobOutput 

type DescribeEntitiesDetectionJobOutput struct {

	// An object that contains the properties associated with an entities detection
	// job.
	EntitiesDetectionJobProperties *EntitiesDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEntitiesDetectionJobOutput) GoString 

func (s DescribeEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties 

func (s *DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties(v *EntitiesDetectionJobProperties) *DescribeEntitiesDetectionJobOutput

SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value.

func (DescribeEntitiesDetectionJobOutput) String 

func (s DescribeEntitiesDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEntityRecognizerInput 

type DescribeEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	//
	// EntityRecognizerArn is a required field
	EntityRecognizerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEntityRecognizerInput) GoString 

func (s DescribeEntityRecognizerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntityRecognizerInput) SetEntityRecognizerArn 

func (s *DescribeEntityRecognizerInput) SetEntityRecognizerArn(v string) *DescribeEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DescribeEntityRecognizerInput) String 

func (s DescribeEntityRecognizerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntityRecognizerInput) Validate 

func (s *DescribeEntityRecognizerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEntityRecognizerOutput 

type DescribeEntityRecognizerOutput struct {

	// Describes information associated with an entity recognizer.
	EntityRecognizerProperties *EntityRecognizerProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEntityRecognizerOutput) GoString 

func (s DescribeEntityRecognizerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntityRecognizerOutput) SetEntityRecognizerProperties 

func (s *DescribeEntityRecognizerOutput) SetEntityRecognizerProperties(v *EntityRecognizerProperties) *DescribeEntityRecognizerOutput

SetEntityRecognizerProperties sets the EntityRecognizerProperties field's value.

func (DescribeEntityRecognizerOutput) String 

func (s DescribeEntityRecognizerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventsDetectionJobInput 

type DescribeEventsDetectionJobInput struct {

	// The identifier of the events detection job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEventsDetectionJobInput) GoString 

func (s DescribeEventsDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsDetectionJobInput) SetJobId 

func (s *DescribeEventsDetectionJobInput) SetJobId(v string) *DescribeEventsDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeEventsDetectionJobInput) String 

func (s DescribeEventsDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsDetectionJobInput) Validate 

func (s *DescribeEventsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventsDetectionJobOutput 

type DescribeEventsDetectionJobOutput struct {

	// An object that contains the properties associated with an event detection
	// job.
	EventsDetectionJobProperties *EventsDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEventsDetectionJobOutput) GoString 

func (s DescribeEventsDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventsDetectionJobOutput) SetEventsDetectionJobProperties 

func (s *DescribeEventsDetectionJobOutput) SetEventsDetectionJobProperties(v *EventsDetectionJobProperties) *DescribeEventsDetectionJobOutput

SetEventsDetectionJobProperties sets the EventsDetectionJobProperties field's value.

func (DescribeEventsDetectionJobOutput) String 

func (s DescribeEventsDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFlywheelInput added in v1.42.9 

type DescribeFlywheelInput struct {

	// The Amazon Resource Number (ARN) of the flywheel.
	//
	// FlywheelArn is a required field
	FlywheelArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFlywheelInput) GoString added in v1.42.9 

func (s DescribeFlywheelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelInput) SetFlywheelArn added in v1.42.9 

func (s *DescribeFlywheelInput) SetFlywheelArn(v string) *DescribeFlywheelInput

SetFlywheelArn sets the FlywheelArn field's value.

func (DescribeFlywheelInput) String added in v1.42.9 

func (s DescribeFlywheelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelInput) Validate added in v1.42.9 

func (s *DescribeFlywheelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFlywheelIterationInput added in v1.42.9 

type DescribeFlywheelIterationInput struct {

	// FlywheelArn is a required field
	FlywheelArn *string `type:"string" required:"true"`

	// FlywheelIterationId is a required field
	FlywheelIterationId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFlywheelIterationInput) GoString added in v1.42.9 

func (s DescribeFlywheelIterationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelIterationInput) SetFlywheelArn added in v1.42.9 

func (s *DescribeFlywheelIterationInput) SetFlywheelArn(v string) *DescribeFlywheelIterationInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*DescribeFlywheelIterationInput) SetFlywheelIterationId added in v1.42.9 

func (s *DescribeFlywheelIterationInput) SetFlywheelIterationId(v string) *DescribeFlywheelIterationInput

SetFlywheelIterationId sets the FlywheelIterationId field's value.

func (DescribeFlywheelIterationInput) String added in v1.42.9 

func (s DescribeFlywheelIterationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelIterationInput) Validate added in v1.42.9 

func (s *DescribeFlywheelIterationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFlywheelIterationOutput added in v1.42.9 

type DescribeFlywheelIterationOutput struct {

	// The configuration properties of a flywheel iteration.
	FlywheelIterationProperties *FlywheelIterationProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFlywheelIterationOutput) GoString added in v1.42.9 

func (s DescribeFlywheelIterationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelIterationOutput) SetFlywheelIterationProperties added in v1.42.9 

func (s *DescribeFlywheelIterationOutput) SetFlywheelIterationProperties(v *FlywheelIterationProperties) *DescribeFlywheelIterationOutput

SetFlywheelIterationProperties sets the FlywheelIterationProperties field's value.

func (DescribeFlywheelIterationOutput) String added in v1.42.9 

func (s DescribeFlywheelIterationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFlywheelOutput added in v1.42.9 

type DescribeFlywheelOutput struct {

	// The flywheel properties.
	FlywheelProperties *FlywheelProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFlywheelOutput) GoString added in v1.42.9 

func (s DescribeFlywheelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFlywheelOutput) SetFlywheelProperties added in v1.42.9 

func (s *DescribeFlywheelOutput) SetFlywheelProperties(v *FlywheelProperties) *DescribeFlywheelOutput

SetFlywheelProperties sets the FlywheelProperties field's value.

func (DescribeFlywheelOutput) String added in v1.42.9 

func (s DescribeFlywheelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeKeyPhrasesDetectionJobInput 

type DescribeKeyPhrasesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The StartKeyPhrasesDetectionJob
	// operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeKeyPhrasesDetectionJobInput) GoString 

func (s DescribeKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeKeyPhrasesDetectionJobInput) SetJobId 

func (s *DescribeKeyPhrasesDetectionJobInput) SetJobId(v string) *DescribeKeyPhrasesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeKeyPhrasesDetectionJobInput) String 

func (s DescribeKeyPhrasesDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeKeyPhrasesDetectionJobInput) Validate 

func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeKeyPhrasesDetectionJobOutput 

type DescribeKeyPhrasesDetectionJobOutput struct {

	// An object that contains the properties associated with a key phrases detection
	// job.
	KeyPhrasesDetectionJobProperties *KeyPhrasesDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeKeyPhrasesDetectionJobOutput) GoString 

func (s DescribeKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties 

func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties(v *KeyPhrasesDetectionJobProperties) *DescribeKeyPhrasesDetectionJobOutput

SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value.

func (DescribeKeyPhrasesDetectionJobOutput) String 

func (s DescribeKeyPhrasesDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePiiEntitiesDetectionJobInput 

type DescribePiiEntitiesDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePiiEntitiesDetectionJobInput) GoString 

func (s DescribePiiEntitiesDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePiiEntitiesDetectionJobInput) SetJobId 

func (s *DescribePiiEntitiesDetectionJobInput) SetJobId(v string) *DescribePiiEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribePiiEntitiesDetectionJobInput) String 

func (s DescribePiiEntitiesDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePiiEntitiesDetectionJobInput) Validate 

func (s *DescribePiiEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePiiEntitiesDetectionJobOutput 

type DescribePiiEntitiesDetectionJobOutput struct {

	// Provides information about a PII entities detection job.
	PiiEntitiesDetectionJobProperties *PiiEntitiesDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribePiiEntitiesDetectionJobOutput) GoString 

func (s DescribePiiEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties 

func (s *DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties(v *PiiEntitiesDetectionJobProperties) *DescribePiiEntitiesDetectionJobOutput

SetPiiEntitiesDetectionJobProperties sets the PiiEntitiesDetectionJobProperties field's value.

func (DescribePiiEntitiesDetectionJobOutput) String 

func (s DescribePiiEntitiesDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeResourcePolicyInput added in v1.42.9 

type DescribeResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the custom model version that has the resource
	// policy.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeResourcePolicyInput) GoString added in v1.42.9 

func (s DescribeResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyInput) SetResourceArn added in v1.42.9 

func (s *DescribeResourcePolicyInput) SetResourceArn(v string) *DescribeResourcePolicyInput

SetResourceArn sets the ResourceArn field's value.

func (DescribeResourcePolicyInput) String added in v1.42.9 

func (s DescribeResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyInput) Validate added in v1.42.9 

func (s *DescribeResourcePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeResourcePolicyOutput added in v1.42.9 

type DescribeResourcePolicyOutput struct {

	// The time at which the policy was created.
	CreationTime *time.Time `type:"timestamp"`

	// The time at which the policy was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The revision ID of the policy. Each time you modify a policy, Amazon Comprehend
	// assigns a new revision ID, and it deletes the prior version of the policy.
	PolicyRevisionId *string `type:"string"`

	// The JSON body of the resource-based policy.
	ResourcePolicy *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeResourcePolicyOutput) GoString added in v1.42.9 

func (s DescribeResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyOutput) SetCreationTime added in v1.42.9 

func (s *DescribeResourcePolicyOutput) SetCreationTime(v time.Time) *DescribeResourcePolicyOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeResourcePolicyOutput) SetLastModifiedTime added in v1.42.9 

func (s *DescribeResourcePolicyOutput) SetLastModifiedTime(v time.Time) *DescribeResourcePolicyOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DescribeResourcePolicyOutput) SetPolicyRevisionId added in v1.42.9 

func (s *DescribeResourcePolicyOutput) SetPolicyRevisionId(v string) *DescribeResourcePolicyOutput

SetPolicyRevisionId sets the PolicyRevisionId field's value.

func (*DescribeResourcePolicyOutput) SetResourcePolicy added in v1.42.9 

func (s *DescribeResourcePolicyOutput) SetResourcePolicy(v string) *DescribeResourcePolicyOutput

SetResourcePolicy sets the ResourcePolicy field's value.

func (DescribeResourcePolicyOutput) String added in v1.42.9 

func (s DescribeResourcePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSentimentDetectionJobInput 

type DescribeSentimentDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The operation
	// returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSentimentDetectionJobInput) GoString 

func (s DescribeSentimentDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSentimentDetectionJobInput) SetJobId 

func (s *DescribeSentimentDetectionJobInput) SetJobId(v string) *DescribeSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeSentimentDetectionJobInput) String 

func (s DescribeSentimentDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSentimentDetectionJobInput) Validate 

func (s *DescribeSentimentDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSentimentDetectionJobOutput 

type DescribeSentimentDetectionJobOutput struct {

	// An object that contains the properties associated with a sentiment detection
	// job.
	SentimentDetectionJobProperties *SentimentDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSentimentDetectionJobOutput) GoString 

func (s DescribeSentimentDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties 

func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties(v *SentimentDetectionJobProperties) *DescribeSentimentDetectionJobOutput

SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value.

func (DescribeSentimentDetectionJobOutput) String 

func (s DescribeSentimentDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTargetedSentimentDetectionJobInput added in v1.42.9 

type DescribeTargetedSentimentDetectionJobInput struct {

	// The identifier that Amazon Comprehend generated for the job. The StartTargetedSentimentDetectionJob
	// operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTargetedSentimentDetectionJobInput) GoString added in v1.42.9 

func (s DescribeTargetedSentimentDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTargetedSentimentDetectionJobInput) SetJobId added in v1.42.9 

func (s *DescribeTargetedSentimentDetectionJobInput) SetJobId(v string) *DescribeTargetedSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeTargetedSentimentDetectionJobInput) String added in v1.42.9 

func (s DescribeTargetedSentimentDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTargetedSentimentDetectionJobInput) Validate added in v1.42.9 

func (s *DescribeTargetedSentimentDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTargetedSentimentDetectionJobOutput added in v1.42.9 

type DescribeTargetedSentimentDetectionJobOutput struct {

	// An object that contains the properties associated with a targeted sentiment
	// detection job.
	TargetedSentimentDetectionJobProperties *TargetedSentimentDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTargetedSentimentDetectionJobOutput) GoString added in v1.42.9 

func (s DescribeTargetedSentimentDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties added in v1.42.9 

func (s *DescribeTargetedSentimentDetectionJobOutput) SetTargetedSentimentDetectionJobProperties(v *TargetedSentimentDetectionJobProperties) *DescribeTargetedSentimentDetectionJobOutput

SetTargetedSentimentDetectionJobProperties sets the TargetedSentimentDetectionJobProperties field's value.

func (DescribeTargetedSentimentDetectionJobOutput) String added in v1.42.9 

func (s DescribeTargetedSentimentDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTopicsDetectionJobInput 

type DescribeTopicsDetectionJobInput struct {

	// The identifier assigned by the user to the detection job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobInput) GoString 

func (s DescribeTopicsDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTopicsDetectionJobInput) SetJobId 

func (s *DescribeTopicsDetectionJobInput) SetJobId(v string) *DescribeTopicsDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeTopicsDetectionJobInput) String 

func (s DescribeTopicsDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTopicsDetectionJobInput) Validate 

func (s *DescribeTopicsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTopicsDetectionJobOutput 

type DescribeTopicsDetectionJobOutput struct {

	// The list of properties for the requested job.
	TopicsDetectionJobProperties *TopicsDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobOutput) GoString 

func (s DescribeTopicsDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties 

func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *TopicsDetectionJobProperties) *DescribeTopicsDetectionJobOutput

SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value.

func (DescribeTopicsDetectionJobOutput) String 

func (s DescribeTopicsDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 (DetectDominantLanguageInput) GoString 

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 (*DetectDominantLanguageInput) SetText 

func (s *DetectDominantLanguageInput) SetText(v string) *DetectDominantLanguageInput

SetText sets the Text field's value.

func (DetectDominantLanguageInput) String 

func (s DetectDominantLanguageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectDominantLanguageInput) Validate 

func (s *DetectDominantLanguageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectDominantLanguageOutput 

type DetectDominantLanguageOutput struct {

	// Array of languages that Amazon Comprehend detected in the input text. The
	// array is sorted in descending order of the score (the dominant language is
	// always the first element in the array).
	//
	// For each language, the response returns the RFC 5646 language code and the
	// level of confidence that Amazon Comprehend has in the accuracy of its inference.
	// For more information about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646)
	// on the IETF Tools web site.
	Languages []*DominantLanguage `type:"list"`
	// contains filtered or unexported fields
}

func (DetectDominantLanguageOutput) GoString 

func (s DetectDominantLanguageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectDominantLanguageOutput) SetLanguages 

func (s *DetectDominantLanguageOutput) SetLanguages(v []*DominantLanguage) *DetectDominantLanguageOutput

SetLanguages sets the Languages field's value.

func (DetectDominantLanguageOutput) String 

func (s DetectDominantLanguageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 (DetectEntitiesInput) GoString 

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 (*DetectEntitiesInput) SetBytes added in v1.42.9 

func (s *DetectEntitiesInput) SetBytes(v []byte) *DetectEntitiesInput

SetBytes sets the Bytes field's value.

func (*DetectEntitiesInput) SetDocumentReaderConfig added in v1.42.9 

func (s *DetectEntitiesInput) SetDocumentReaderConfig(v *DocumentReaderConfig) *DetectEntitiesInput

SetDocumentReaderConfig sets the DocumentReaderConfig field's value.

func (*DetectEntitiesInput) SetEndpointArn 

func (s *DetectEntitiesInput) SetEndpointArn(v string) *DetectEntitiesInput

SetEndpointArn sets the EndpointArn field's value.

func (*DetectEntitiesInput) SetLanguageCode 

func (s *DetectEntitiesInput) SetLanguageCode(v string) *DetectEntitiesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectEntitiesInput) SetText 

func (s *DetectEntitiesInput) SetText(v string) *DetectEntitiesInput

SetText sets the Text field's value.

func (DetectEntitiesInput) String 

func (s DetectEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectEntitiesInput) Validate 

func (s *DetectEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectEntitiesOutput 

type DetectEntitiesOutput struct {

	// 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 (DetectEntitiesOutput) GoString 

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 (*DetectEntitiesOutput) SetBlocks added in v1.42.9 

func (s *DetectEntitiesOutput) SetBlocks(v []*Block) *DetectEntitiesOutput

SetBlocks sets the Blocks field's value.

func (*DetectEntitiesOutput) SetDocumentMetadata added in v1.42.9 

func (s *DetectEntitiesOutput) SetDocumentMetadata(v *DocumentMetadata) *DetectEntitiesOutput

SetDocumentMetadata sets the DocumentMetadata field's value.

func (*DetectEntitiesOutput) SetDocumentType added in v1.42.9 

func (s *DetectEntitiesOutput) SetDocumentType(v []*DocumentTypeListItem) *DetectEntitiesOutput

SetDocumentType sets the DocumentType field's value.

func (*DetectEntitiesOutput) SetEntities 

func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput

SetEntities sets the Entities field's value.

func (*DetectEntitiesOutput) SetErrors added in v1.42.9 

func (s *DetectEntitiesOutput) SetErrors(v []*ErrorsListItem) *DetectEntitiesOutput

SetErrors sets the Errors field's value.

func (DetectEntitiesOutput) String 

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 

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 (DetectKeyPhrasesInput) GoString 

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 (*DetectKeyPhrasesInput) SetLanguageCode 

func (s *DetectKeyPhrasesInput) SetLanguageCode(v string) *DetectKeyPhrasesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectKeyPhrasesInput) SetText 

func (s *DetectKeyPhrasesInput) SetText(v string) *DetectKeyPhrasesInput

SetText sets the Text field's value.

func (DetectKeyPhrasesInput) String 

func (s DetectKeyPhrasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectKeyPhrasesInput) Validate 

func (s *DetectKeyPhrasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectKeyPhrasesOutput 

type DetectKeyPhrasesOutput struct {

	// A collection of key phrases that Amazon Comprehend identified in the input
	// text. For each key phrase, the response provides the text of the key phrase,
	// where the key phrase begins and ends, and the level of confidence that Amazon
	// Comprehend has in the accuracy of the detection.
	KeyPhrases []*KeyPhrase `type:"list"`
	// contains filtered or unexported fields
}

func (DetectKeyPhrasesOutput) GoString 

func (s DetectKeyPhrasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectKeyPhrasesOutput) SetKeyPhrases 

func (s *DetectKeyPhrasesOutput) SetKeyPhrases(v []*KeyPhrase) *DetectKeyPhrasesOutput

SetKeyPhrases sets the KeyPhrases field's value.

func (DetectKeyPhrasesOutput) String 

func (s DetectKeyPhrasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 (DetectPiiEntitiesInput) GoString 

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 (*DetectPiiEntitiesInput) SetLanguageCode 

func (s *DetectPiiEntitiesInput) SetLanguageCode(v string) *DetectPiiEntitiesInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectPiiEntitiesInput) SetText 

func (s *DetectPiiEntitiesInput) SetText(v string) *DetectPiiEntitiesInput

SetText sets the Text field's value.

func (DetectPiiEntitiesInput) String 

func (s DetectPiiEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectPiiEntitiesInput) Validate 

func (s *DetectPiiEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectPiiEntitiesOutput 

type DetectPiiEntitiesOutput struct {

	// A collection of PII entities identified in the input text. For each entity,
	// the response provides the entity type, where the entity text begins and ends,
	// and the level of confidence that Amazon Comprehend has in the detection.
	Entities []*PiiEntity `type:"list"`
	// contains filtered or unexported fields
}

func (DetectPiiEntitiesOutput) GoString 

func (s DetectPiiEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectPiiEntitiesOutput) SetEntities 

func (s *DetectPiiEntitiesOutput) SetEntities(v []*PiiEntity) *DetectPiiEntitiesOutput

SetEntities sets the Entities field's value.

func (DetectPiiEntitiesOutput) String 

func (s DetectPiiEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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.
	//
	// 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 (DetectSentimentInput) GoString 

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 (*DetectSentimentInput) SetLanguageCode 

func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSentimentInput) SetText 

func (s *DetectSentimentInput) SetText(v string) *DetectSentimentInput

SetText sets the Text field's value.

func (DetectSentimentInput) String 

func (s DetectSentimentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectSentimentInput) Validate 

func (s *DetectSentimentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectSentimentOutput 

type DetectSentimentOutput struct {

	// The inferred sentiment that Amazon Comprehend has the highest level of confidence
	// in.
	Sentiment *string `type:"string" enum:"SentimentType"`

	// An object that lists the sentiments, and their corresponding confidence levels.
	SentimentScore *SentimentScore `type:"structure"`
	// contains filtered or unexported fields
}

func (DetectSentimentOutput) GoString 

func (s DetectSentimentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectSentimentOutput) SetSentiment 

func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput

SetSentiment sets the Sentiment field's value.

func (*DetectSentimentOutput) SetSentimentScore 

func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput

SetSentimentScore sets the SentimentScore field's value.

func (DetectSentimentOutput) String 

func (s DetectSentimentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 (DetectSyntaxInput) GoString 

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 (*DetectSyntaxInput) SetLanguageCode 

func (s *DetectSyntaxInput) SetLanguageCode(v string) *DetectSyntaxInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSyntaxInput) SetText 

func (s *DetectSyntaxInput) SetText(v string) *DetectSyntaxInput

SetText sets the Text field's value.

func (DetectSyntaxInput) String 

func (s DetectSyntaxInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectSyntaxInput) Validate 

func (s *DetectSyntaxInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectSyntaxOutput 

type DetectSyntaxOutput struct {

	// A collection of syntax tokens describing the text. For each token, the response
	// provides the text, the token type, where the text begins and ends, and the
	// level of confidence that Amazon Comprehend has that the token is correct.
	// For a list of token types, see 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 (DetectSyntaxOutput) GoString 

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 (*DetectSyntaxOutput) SetSyntaxTokens 

func (s *DetectSyntaxOutput) SetSyntaxTokens(v []*SyntaxToken) *DetectSyntaxOutput

SetSyntaxTokens sets the SyntaxTokens field's value.

func (DetectSyntaxOutput) String 

func (s DetectSyntaxOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 added in v1.42.9 

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 (DetectTargetedSentimentInput) GoString added in v1.42.9 

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 (*DetectTargetedSentimentInput) SetLanguageCode added in v1.42.9 

func (s *DetectTargetedSentimentInput) SetLanguageCode(v string) *DetectTargetedSentimentInput

SetLanguageCode sets the LanguageCode field's value.

func (*DetectTargetedSentimentInput) SetText added in v1.42.9 

func (s *DetectTargetedSentimentInput) SetText(v string) *DetectTargetedSentimentInput

SetText sets the Text field's value.

func (DetectTargetedSentimentInput) String added in v1.42.9 

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 (*DetectTargetedSentimentInput) Validate added in v1.42.9 

func (s *DetectTargetedSentimentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectTargetedSentimentOutput added in v1.42.9 

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 (DetectTargetedSentimentOutput) GoString added in v1.42.9 

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 (*DetectTargetedSentimentOutput) SetEntities added in v1.42.9 

func (s *DetectTargetedSentimentOutput) SetEntities(v []*TargetedSentimentEntity) *DetectTargetedSentimentOutput

SetEntities sets the Entities field's value.

func (DetectTargetedSentimentOutput) String added in v1.42.9 

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 

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 (DocumentClass) GoString 

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 (*DocumentClass) SetName 

func (s *DocumentClass) SetName(v string) *DocumentClass

SetName sets the Name field's value.

func (*DocumentClass) SetPage added in v1.42.9 

func (s *DocumentClass) SetPage(v int64) *DocumentClass

SetPage sets the Page field's value.

func (*DocumentClass) SetScore 

func (s *DocumentClass) SetScore(v float64) *DocumentClass

SetScore sets the Score field's value.

func (DocumentClass) String 

func (s DocumentClass) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 DocumentClassificationConfig added in v1.42.9 

type DocumentClassificationConfig struct {

	// One or more labels to associate with the custom classifier.
	Labels []*string `type:"list"`

	// Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
	//
	// Mode is a required field
	Mode *string `type:"string" required:"true" enum:"DocumentClassifierMode"`
	// contains filtered or unexported fields
}

Configuration required for a custom classification model.

func (DocumentClassificationConfig) GoString added in v1.42.9 

func (s DocumentClassificationConfig) 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 (*DocumentClassificationConfig) SetLabels added in v1.42.9 

func (s *DocumentClassificationConfig) SetLabels(v []*string) *DocumentClassificationConfig

SetLabels sets the Labels field's value.

func (*DocumentClassificationConfig) SetMode added in v1.42.9 

func (s *DocumentClassificationConfig) SetMode(v string) *DocumentClassificationConfig

SetMode sets the Mode field's value.

func (DocumentClassificationConfig) String added in v1.42.9 

func (s DocumentClassificationConfig) 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 (*DocumentClassificationConfig) Validate added in v1.42.9 

func (s *DocumentClassificationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentClassificationJobFilter 

type DocumentClassificationJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list based on job status. Returns only jobs with the specified
	// status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

func (DocumentClassificationJobFilter) GoString 

func (s DocumentClassificationJobFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentClassificationJobFilter) SetJobName 

func (s *DocumentClassificationJobFilter) SetJobName(v string) *DocumentClassificationJobFilter

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobFilter) SetJobStatus 

func (s *DocumentClassificationJobFilter) SetJobStatus(v string) *DocumentClassificationJobFilter

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeAfter 

func (s *DocumentClassificationJobFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassificationJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeBefore 

func (s *DocumentClassificationJobFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassificationJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassificationJobFilter) String 

func (s DocumentClassificationJobFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentClassificationJobFilter) Validate 

func (s *DocumentClassificationJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentClassificationJobProperties 

type DocumentClassificationJobProperties struct {

	// The Amazon Resource Name (ARN) of the 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 Amazon Resource Number (ARN) of the flywheel
	FlywheelArn *string `type:"string"`

	// 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 Amazon
	// Web Services account, Amazon Web Services 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 Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for 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 (DocumentClassificationJobProperties) GoString 

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 (*DocumentClassificationJobProperties) SetDataAccessRoleArn 

func (s *DocumentClassificationJobProperties) SetDataAccessRoleArn(v string) *DocumentClassificationJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassificationJobProperties) SetDocumentClassifierArn 

func (s *DocumentClassificationJobProperties) SetDocumentClassifierArn(v string) *DocumentClassificationJobProperties

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassificationJobProperties) SetEndTime 

func (s *DocumentClassificationJobProperties) SetEndTime(v time.Time) *DocumentClassificationJobProperties

SetEndTime sets the EndTime field's value.

func (*DocumentClassificationJobProperties) SetFlywheelArn added in v1.42.9 

func (s *DocumentClassificationJobProperties) SetFlywheelArn(v string) *DocumentClassificationJobProperties

SetFlywheelArn sets the FlywheelArn field's value.

func (*DocumentClassificationJobProperties) SetInputDataConfig 

func (s *DocumentClassificationJobProperties) SetInputDataConfig(v *InputDataConfig) *DocumentClassificationJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetJobArn 

func (s *DocumentClassificationJobProperties) SetJobArn(v string) *DocumentClassificationJobProperties

SetJobArn sets the JobArn field's value.

func (*DocumentClassificationJobProperties) SetJobId 

func (s *DocumentClassificationJobProperties) SetJobId(v string) *DocumentClassificationJobProperties

SetJobId sets the JobId field's value.

func (*DocumentClassificationJobProperties) SetJobName 

func (s *DocumentClassificationJobProperties) SetJobName(v string) *DocumentClassificationJobProperties

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobProperties) SetJobStatus 

func (s *DocumentClassificationJobProperties) SetJobStatus(v string) *DocumentClassificationJobProperties

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobProperties) SetMessage 

func (s *DocumentClassificationJobProperties) SetMessage(v string) *DocumentClassificationJobProperties

SetMessage sets the Message field's value.

func (*DocumentClassificationJobProperties) SetOutputDataConfig 

func (s *DocumentClassificationJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DocumentClassificationJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetSubmitTime 

func (s *DocumentClassificationJobProperties) SetSubmitTime(v time.Time) *DocumentClassificationJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassificationJobProperties) SetVolumeKmsKeyId 

func (s *DocumentClassificationJobProperties) SetVolumeKmsKeyId(v string) *DocumentClassificationJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassificationJobProperties) SetVpcConfig 

func (s *DocumentClassificationJobProperties) SetVpcConfig(v *VpcConfig) *DocumentClassificationJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassificationJobProperties) String 

func (s DocumentClassificationJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 DocumentClassifierDocuments added in v1.42.9 

type DocumentClassifierDocuments struct {

	// The S3 URI location of the training documents specified in the S3Uri CSV
	// file.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`

	// The S3 URI location of the test documents included in the TestS3Uri CSV file.
	// This field is not required if you do not specify a test CSV file.
	TestS3Uri *string `type:"string"`
	// contains filtered or unexported fields
}

The location of the training documents. This parameter is required in a request to create a native classifier model.

func (DocumentClassifierDocuments) GoString added in v1.42.9 

func (s DocumentClassifierDocuments) 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 (*DocumentClassifierDocuments) SetS3Uri added in v1.42.9 

func (s *DocumentClassifierDocuments) SetS3Uri(v string) *DocumentClassifierDocuments

SetS3Uri sets the S3Uri field's value.

func (*DocumentClassifierDocuments) SetTestS3Uri added in v1.42.9 

func (s *DocumentClassifierDocuments) SetTestS3Uri(v string) *DocumentClassifierDocuments

SetTestS3Uri sets the TestS3Uri field's value.

func (DocumentClassifierDocuments) String added in v1.42.9 

func (s DocumentClassifierDocuments) 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 (*DocumentClassifierDocuments) Validate added in v1.42.9 

func (s *DocumentClassifierDocuments) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentClassifierFilter 

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 ListDocumentClassifiers operation.

func (DocumentClassifierFilter) GoString 

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 (*DocumentClassifierFilter) SetDocumentClassifierName 

func (s *DocumentClassifierFilter) SetDocumentClassifierName(v string) *DocumentClassifierFilter

SetDocumentClassifierName sets the DocumentClassifierName field's value.

func (*DocumentClassifierFilter) SetStatus 

func (s *DocumentClassifierFilter) SetStatus(v string) *DocumentClassifierFilter

SetStatus sets the Status field's value.

func (*DocumentClassifierFilter) SetSubmitTimeAfter 

func (s *DocumentClassifierFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassifierFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassifierFilter) SetSubmitTimeBefore 

func (s *DocumentClassifierFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassifierFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassifierFilter) String 

func (s DocumentClassifierFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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"`

	// 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/idp-set-textract-options.html)
	// in the Comprehend Developer Guide.
	DocumentReaderConfig *DocumentReaderConfig `type:"structure"`

	// The type of input documents for training the model. Provide plain-text documents
	// to create a plain-text model, and provide semi-structured documents to create
	// a native model.
	DocumentType *string `type:"string" enum:"DocumentClassifierDocumentTypeFormat"`

	// The S3 location of the training documents. This parameter is required in
	// a request to create a native classifier model.
	Documents *DocumentClassifierDocuments `type:"structure"`

	// 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 Amazon Web Services 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 (DocumentClassifierInputDataConfig) GoString 

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 (*DocumentClassifierInputDataConfig) SetAugmentedManifests 

func (s *DocumentClassifierInputDataConfig) SetAugmentedManifests(v []*AugmentedManifestsListItem) *DocumentClassifierInputDataConfig

SetAugmentedManifests sets the AugmentedManifests field's value.

func (*DocumentClassifierInputDataConfig) SetDataFormat 

func (s *DocumentClassifierInputDataConfig) SetDataFormat(v string) *DocumentClassifierInputDataConfig

SetDataFormat sets the DataFormat field's value.

func (*DocumentClassifierInputDataConfig) SetDocumentReaderConfig added in v1.42.9 

func (s *DocumentClassifierInputDataConfig) SetDocumentReaderConfig(v *DocumentReaderConfig) *DocumentClassifierInputDataConfig

SetDocumentReaderConfig sets the DocumentReaderConfig field's value.

func (*DocumentClassifierInputDataConfig) SetDocumentType added in v1.42.9 

func (s *DocumentClassifierInputDataConfig) SetDocumentType(v string) *DocumentClassifierInputDataConfig

SetDocumentType sets the DocumentType field's value.

func (*DocumentClassifierInputDataConfig) SetDocuments added in v1.42.9 

func (s *DocumentClassifierInputDataConfig) SetDocuments(v *DocumentClassifierDocuments) *DocumentClassifierInputDataConfig

SetDocuments sets the Documents field's value.

func (*DocumentClassifierInputDataConfig) SetLabelDelimiter 

func (s *DocumentClassifierInputDataConfig) SetLabelDelimiter(v string) *DocumentClassifierInputDataConfig

SetLabelDelimiter sets the LabelDelimiter field's value.

func (*DocumentClassifierInputDataConfig) SetS3Uri 

func (s *DocumentClassifierInputDataConfig) SetS3Uri(v string) *DocumentClassifierInputDataConfig

SetS3Uri sets the S3Uri field's value.

func (*DocumentClassifierInputDataConfig) SetTestS3Uri 

func (s *DocumentClassifierInputDataConfig) SetTestS3Uri(v string) *DocumentClassifierInputDataConfig

SetTestS3Uri sets the TestS3Uri field's value.

func (DocumentClassifierInputDataConfig) String 

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 (*DocumentClassifierInputDataConfig) Validate 

func (s *DocumentClassifierInputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentClassifierOutputDataConfig 

type DocumentClassifierOutputDataConfig struct {

	// The Amazon S3 prefix for the data lake location of the flywheel statistics.
	FlywheelStatsS3Prefix *string `type:"string"`

	// ID for the Amazon Web Services 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 and other output files. 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
}

Provide the location for output data from a custom classifier job. This field is mandatory if you are training a native classifier model.

func (DocumentClassifierOutputDataConfig) GoString 

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 (*DocumentClassifierOutputDataConfig) SetFlywheelStatsS3Prefix added in v1.42.9 

func (s *DocumentClassifierOutputDataConfig) SetFlywheelStatsS3Prefix(v string) *DocumentClassifierOutputDataConfig

SetFlywheelStatsS3Prefix sets the FlywheelStatsS3Prefix field's value.

func (*DocumentClassifierOutputDataConfig) SetKmsKeyId 

func (s *DocumentClassifierOutputDataConfig) SetKmsKeyId(v string) *DocumentClassifierOutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*DocumentClassifierOutputDataConfig) SetS3Uri 

func (s *DocumentClassifierOutputDataConfig) SetS3Uri(v string) *DocumentClassifierOutputDataConfig

SetS3Uri sets the S3Uri field's value.

func (DocumentClassifierOutputDataConfig) String 

func (s DocumentClassifierOutputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 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 Amazon Resource Number (ARN) of the flywheel
	FlywheelArn *string `type:"string"`

	// 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 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 Amazon Web Services account to create the document classifier
	// model in your Amazon Web Services 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 TRAINED_WITH_WARNINGS the classifier training
	// succeeded, but you should review the warnings returned in the CreateDocumentClassifier
	// response.
	//
	// 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 Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for 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 (DocumentClassifierProperties) GoString 

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 (*DocumentClassifierProperties) SetClassifierMetadata 

func (s *DocumentClassifierProperties) SetClassifierMetadata(v *ClassifierMetadata) *DocumentClassifierProperties

SetClassifierMetadata sets the ClassifierMetadata field's value.

func (*DocumentClassifierProperties) SetDataAccessRoleArn 

func (s *DocumentClassifierProperties) SetDataAccessRoleArn(v string) *DocumentClassifierProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassifierProperties) SetDocumentClassifierArn 

func (s *DocumentClassifierProperties) SetDocumentClassifierArn(v string) *DocumentClassifierProperties

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassifierProperties) SetEndTime 

func (s *DocumentClassifierProperties) SetEndTime(v time.Time) *DocumentClassifierProperties

SetEndTime sets the EndTime field's value.

func (*DocumentClassifierProperties) SetFlywheelArn added in v1.42.9 

func (s *DocumentClassifierProperties) SetFlywheelArn(v string) *DocumentClassifierProperties

SetFlywheelArn sets the FlywheelArn field's value.

func (*DocumentClassifierProperties) SetInputDataConfig 

func (s *DocumentClassifierProperties) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *DocumentClassifierProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassifierProperties) SetLanguageCode 

func (s *DocumentClassifierProperties) SetLanguageCode(v string) *DocumentClassifierProperties

SetLanguageCode sets the LanguageCode field's value.

func (*DocumentClassifierProperties) SetMessage 

func (s *DocumentClassifierProperties) SetMessage(v string) *DocumentClassifierProperties

SetMessage sets the Message field's value.

func (*DocumentClassifierProperties) SetMode 

func (s *DocumentClassifierProperties) SetMode(v string) *DocumentClassifierProperties

SetMode sets the Mode field's value.

func (*DocumentClassifierProperties) SetModelKmsKeyId 

func (s *DocumentClassifierProperties) SetModelKmsKeyId(v string) *DocumentClassifierProperties

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*DocumentClassifierProperties) SetOutputDataConfig 

func (s *DocumentClassifierProperties) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *DocumentClassifierProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassifierProperties) SetSourceModelArn added in v1.42.9 

func (s *DocumentClassifierProperties) SetSourceModelArn(v string) *DocumentClassifierProperties

SetSourceModelArn sets the SourceModelArn field's value.

func (*DocumentClassifierProperties) SetStatus 

func (s *DocumentClassifierProperties) SetStatus(v string) *DocumentClassifierProperties

SetStatus sets the Status field's value.

func (*DocumentClassifierProperties) SetSubmitTime 

func (s *DocumentClassifierProperties) SetSubmitTime(v time.Time) *DocumentClassifierProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassifierProperties) SetTrainingEndTime 

func (s *DocumentClassifierProperties) SetTrainingEndTime(v time.Time) *DocumentClassifierProperties

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*DocumentClassifierProperties) SetTrainingStartTime 

func (s *DocumentClassifierProperties) SetTrainingStartTime(v time.Time) *DocumentClassifierProperties

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*DocumentClassifierProperties) SetVersionName 

func (s *DocumentClassifierProperties) SetVersionName(v string) *DocumentClassifierProperties

SetVersionName sets the VersionName field's value.

func (*DocumentClassifierProperties) SetVolumeKmsKeyId 

func (s *DocumentClassifierProperties) SetVolumeKmsKeyId(v string) *DocumentClassifierProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassifierProperties) SetVpcConfig 

func (s *DocumentClassifierProperties) SetVpcConfig(v *VpcConfig) *DocumentClassifierProperties

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassifierProperties) String 

func (s DocumentClassifierProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 (DocumentClassifierSummary) GoString 

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 (*DocumentClassifierSummary) SetDocumentClassifierName 

func (s *DocumentClassifierSummary) SetDocumentClassifierName(v string) *DocumentClassifierSummary

SetDocumentClassifierName sets the DocumentClassifierName field's value.

func (*DocumentClassifierSummary) SetLatestVersionCreatedAt 

func (s *DocumentClassifierSummary) SetLatestVersionCreatedAt(v time.Time) *DocumentClassifierSummary

SetLatestVersionCreatedAt sets the LatestVersionCreatedAt field's value.

func (*DocumentClassifierSummary) SetLatestVersionName 

func (s *DocumentClassifierSummary) SetLatestVersionName(v string) *DocumentClassifierSummary

SetLatestVersionName sets the LatestVersionName field's value.

func (*DocumentClassifierSummary) SetLatestVersionStatus 

func (s *DocumentClassifierSummary) SetLatestVersionStatus(v string) *DocumentClassifierSummary

SetLatestVersionStatus sets the LatestVersionStatus field's value.

func (*DocumentClassifierSummary) SetNumberOfVersions 

func (s *DocumentClassifierSummary) SetNumberOfVersions(v int64) *DocumentClassifierSummary

SetNumberOfVersions sets the NumberOfVersions field's value.

func (DocumentClassifierSummary) String 

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 

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 (DocumentLabel) GoString 

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 (*DocumentLabel) SetName 

func (s *DocumentLabel) SetName(v string) *DocumentLabel

SetName sets the Name field's value.

func (*DocumentLabel) SetPage added in v1.42.9 

func (s *DocumentLabel) SetPage(v int64) *DocumentLabel

SetPage sets the Page field's value.

func (*DocumentLabel) SetScore 

func (s *DocumentLabel) SetScore(v float64) *DocumentLabel

SetScore sets the Score field's value.

func (DocumentLabel) String 

func (s DocumentLabel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 added in v1.42.9 

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 (DocumentMetadata) GoString added in v1.42.9 

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 (*DocumentMetadata) SetExtractedCharacters added in v1.42.9 

func (s *DocumentMetadata) SetExtractedCharacters(v []*ExtractedCharactersListItem) *DocumentMetadata

SetExtractedCharacters sets the ExtractedCharacters field's value.

func (*DocumentMetadata) SetPages added in v1.42.9 

func (s *DocumentMetadata) SetPages(v int64) *DocumentMetadata

SetPages sets the Pages field's value.

func (DocumentMetadata) String added in v1.42.9 

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 

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/idp-set-textract-options.html) in the Comprehend Developer Guide.

func (DocumentReaderConfig) GoString 

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 (*DocumentReaderConfig) SetDocumentReadAction 

func (s *DocumentReaderConfig) SetDocumentReadAction(v string) *DocumentReaderConfig

SetDocumentReadAction sets the DocumentReadAction field's value.

func (*DocumentReaderConfig) SetDocumentReadMode 

func (s *DocumentReaderConfig) SetDocumentReadMode(v string) *DocumentReaderConfig

SetDocumentReadMode sets the DocumentReadMode field's value.

func (*DocumentReaderConfig) SetFeatureTypes 

func (s *DocumentReaderConfig) SetFeatureTypes(v []*string) *DocumentReaderConfig

SetFeatureTypes sets the FeatureTypes field's value.

func (DocumentReaderConfig) String 

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 (*DocumentReaderConfig) Validate 

func (s *DocumentReaderConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentTypeListItem added in v1.42.9 

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 (DocumentTypeListItem) GoString added in v1.42.9 

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 (*DocumentTypeListItem) SetPage added in v1.42.9 

func (s *DocumentTypeListItem) SetPage(v int64) *DocumentTypeListItem

SetPage sets the Page field's value.

func (*DocumentTypeListItem) SetType added in v1.42.9 

func (s *DocumentTypeListItem) SetType(v string) *DocumentTypeListItem

SetType sets the Type field's value.

func (DocumentTypeListItem) String added in v1.42.9 

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 

type DominantLanguage struct {

	// The RFC 5646 language code for the dominant language. For more information
	// about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646)
	// on the IETF Tools web site.
	LanguageCode *string `min:"1" type:"string"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

func (DominantLanguage) GoString 

func (s DominantLanguage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DominantLanguage) SetLanguageCode 

func (s *DominantLanguage) SetLanguageCode(v string) *DominantLanguage

SetLanguageCode sets the LanguageCode field's value.

func (*DominantLanguage) SetScore 

func (s *DominantLanguage) SetScore(v float64) *DominantLanguage

SetScore sets the Score field's value.

func (DominantLanguage) String 

func (s DominantLanguage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

type DominantLanguageDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (DominantLanguageDetectionJobFilter) GoString 

func (s DominantLanguageDetectionJobFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DominantLanguageDetectionJobFilter) SetJobName 

func (s *DominantLanguageDetectionJobFilter) SetJobName(v string) *DominantLanguageDetectionJobFilter

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobFilter) SetJobStatus 

func (s *DominantLanguageDetectionJobFilter) SetJobStatus(v string) *DominantLanguageDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeAfter 

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeBefore 

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DominantLanguageDetectionJobFilter) String 

func (s DominantLanguageDetectionJobFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DominantLanguageDetectionJobFilter) Validate 

func (s *DominantLanguageDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DominantLanguageDetectionJobProperties 

type DominantLanguageDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants 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 Amazon
	// Web Services account, Amazon Web Services 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 Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your dominant language detection job. For
	// more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a dominant language detection job.

func (DominantLanguageDetectionJobProperties) GoString 

func (s DominantLanguageDetectionJobProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DominantLanguageDetectionJobProperties) SetDataAccessRoleArn 

func (s *DominantLanguageDetectionJobProperties) SetDataAccessRoleArn(v string) *DominantLanguageDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DominantLanguageDetectionJobProperties) SetEndTime 

func (s *DominantLanguageDetectionJobProperties) SetEndTime(v time.Time) *DominantLanguageDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*DominantLanguageDetectionJobProperties) SetInputDataConfig 

func (s *DominantLanguageDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *DominantLanguageDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetJobArn 

func (s *DominantLanguageDetectionJobProperties) SetJobArn(v string) *DominantLanguageDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*DominantLanguageDetectionJobProperties) SetJobId 

func (s *DominantLanguageDetectionJobProperties) SetJobId(v string) *DominantLanguageDetectionJobProperties

SetJobId sets the JobId field's value.

func (*DominantLanguageDetectionJobProperties) SetJobName 

func (s *DominantLanguageDetectionJobProperties) SetJobName(v string) *DominantLanguageDetectionJobProperties

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobProperties) SetJobStatus 

func (s *DominantLanguageDetectionJobProperties) SetJobStatus(v string) *DominantLanguageDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobProperties) SetMessage 

func (s *DominantLanguageDetectionJobProperties) SetMessage(v string) *DominantLanguageDetectionJobProperties

SetMessage sets the Message field's value.

func (*DominantLanguageDetectionJobProperties) SetOutputDataConfig 

func (s *DominantLanguageDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DominantLanguageDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetSubmitTime 

func (s *DominantLanguageDetectionJobProperties) SetSubmitTime(v time.Time) *DominantLanguageDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DominantLanguageDetectionJobProperties) SetVolumeKmsKeyId 

func (s *DominantLanguageDetectionJobProperties) SetVolumeKmsKeyId(v string) *DominantLanguageDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DominantLanguageDetectionJobProperties) SetVpcConfig 

func (s *DominantLanguageDetectionJobProperties) SetVpcConfig(v *VpcConfig) *DominantLanguageDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (DominantLanguageDetectionJobProperties) String 

func (s DominantLanguageDetectionJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 (EndpointFilter) GoString 

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 (*EndpointFilter) SetCreationTimeAfter 

func (s *EndpointFilter) SetCreationTimeAfter(v time.Time) *EndpointFilter

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*EndpointFilter) SetCreationTimeBefore 

func (s *EndpointFilter) SetCreationTimeBefore(v time.Time) *EndpointFilter

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (*EndpointFilter) SetModelArn 

func (s *EndpointFilter) SetModelArn(v string) *EndpointFilter

SetModelArn sets the ModelArn field's value.

func (*EndpointFilter) SetStatus 

func (s *EndpointFilter) SetStatus(v string) *EndpointFilter

SetStatus sets the Status field's value.

func (EndpointFilter) String 

func (s EndpointFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

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 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 Amazon Resource Number (ARN) of the flywheel
	FlywheelArn *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 (EndpointProperties) GoString 

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 (*EndpointProperties) SetCreationTime 

func (s *EndpointProperties) SetCreationTime(v time.Time) *EndpointProperties

SetCreationTime sets the CreationTime field's value.

func (*EndpointProperties) SetCurrentInferenceUnits 

func (s *EndpointProperties) SetCurrentInferenceUnits(v int64) *EndpointProperties

SetCurrentInferenceUnits sets the CurrentInferenceUnits field's value.

func (*EndpointProperties) SetDataAccessRoleArn 

func (s *EndpointProperties) SetDataAccessRoleArn(v string) *EndpointProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EndpointProperties) SetDesiredDataAccessRoleArn 

func (s *EndpointProperties) SetDesiredDataAccessRoleArn(v string) *EndpointProperties

SetDesiredDataAccessRoleArn sets the DesiredDataAccessRoleArn field's value.

func (*EndpointProperties) SetDesiredInferenceUnits 

func (s *EndpointProperties) SetDesiredInferenceUnits(v int64) *EndpointProperties

SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value.

func (*EndpointProperties) SetDesiredModelArn 

func (s *EndpointProperties) SetDesiredModelArn(v string) *EndpointProperties

SetDesiredModelArn sets the DesiredModelArn field's value.

func (*EndpointProperties) SetEndpointArn 

func (s *EndpointProperties) SetEndpointArn(v string) *EndpointProperties

SetEndpointArn sets the EndpointArn field's value.

func (*EndpointProperties) SetFlywheelArn added in v1.42.9 

func (s *EndpointProperties) SetFlywheelArn(v string) *EndpointProperties

SetFlywheelArn sets the FlywheelArn field's value.

func (*EndpointProperties) SetLastModifiedTime 

func (s *EndpointProperties) SetLastModifiedTime(v time.Time) *EndpointProperties

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*EndpointProperties) SetMessage 

func (s *EndpointProperties) SetMessage(v string) *EndpointProperties

SetMessage sets the Message field's value.

func (*EndpointProperties) SetModelArn 

func (s *EndpointProperties) SetModelArn(v string) *EndpointProperties

SetModelArn sets the ModelArn field's value.

func (*EndpointProperties) SetStatus 

func (s *EndpointProperties) SetStatus(v string) *EndpointProperties

SetStatus sets the Status field's value.

func (EndpointProperties) String 

func (s EndpointProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 

type EntitiesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (EntitiesDetectionJobFilter) GoString 

func (s EntitiesDetectionJobFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntitiesDetectionJobFilter) SetJobName 

func (s *EntitiesDetectionJobFilter) SetJobName(v string) *EntitiesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobFilter) SetJobStatus 

func (s *EntitiesDetectionJobFilter) SetJobStatus(v string) *EntitiesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeAfter 

func (s *EntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeBefore 

func (s *EntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntitiesDetectionJobFilter) String 

func (s EntitiesDetectionJobFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntitiesDetectionJobFilter) Validate 

func (s *EntitiesDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntitiesDetectionJobProperties 

type EntitiesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants 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 Amazon Resource Name (ARN) of the flywheel associated with this job.
	FlywheelArn *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 Amazon Web Services
	// account, Amazon Web Services 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 Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your entity detection job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about an entities detection job.

func (EntitiesDetectionJobProperties) GoString 

func (s EntitiesDetectionJobProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntitiesDetectionJobProperties) SetDataAccessRoleArn 

func (s *EntitiesDetectionJobProperties) SetDataAccessRoleArn(v string) *EntitiesDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntitiesDetectionJobProperties) SetEndTime 

func (s *EntitiesDetectionJobProperties) SetEndTime(v time.Time) *EntitiesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*EntitiesDetectionJobProperties) SetEntityRecognizerArn 

func (s *EntitiesDetectionJobProperties) SetEntityRecognizerArn(v string) *EntitiesDetectionJobProperties

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntitiesDetectionJobProperties) SetFlywheelArn added in v1.42.9 

func (s *EntitiesDetectionJobProperties) SetFlywheelArn(v string) *EntitiesDetectionJobProperties

SetFlywheelArn sets the FlywheelArn field's value.

func (*EntitiesDetectionJobProperties) SetInputDataConfig 

func (s *EntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *EntitiesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetJobArn 

func (s *EntitiesDetectionJobProperties) SetJobArn(v string) *EntitiesDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*EntitiesDetectionJobProperties) SetJobId 

func (s *EntitiesDetectionJobProperties) SetJobId(v string) *EntitiesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*EntitiesDetectionJobProperties) SetJobName 

func (s *EntitiesDetectionJobProperties) SetJobName(v string) *EntitiesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobProperties) SetJobStatus 

func (s *EntitiesDetectionJobProperties) SetJobStatus(v string) *EntitiesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobProperties) SetLanguageCode 

func (s *EntitiesDetectionJobProperties) SetLanguageCode(v string) *EntitiesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*EntitiesDetectionJobProperties) SetMessage 

func (s *EntitiesDetectionJobProperties) SetMessage(v string) *EntitiesDetectionJobProperties

SetMessage sets the Message field's value.

func (*EntitiesDetectionJobProperties) SetOutputDataConfig 

func (s *EntitiesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *EntitiesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetSubmitTime 

func (s *EntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *EntitiesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*EntitiesDetectionJobProperties) SetVolumeKmsKeyId 

func (s *EntitiesDetectionJobProperties) SetVolumeKmsKeyId(v string) *EntitiesDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntitiesDetectionJobProperties) SetVpcConfig 

func (s *EntitiesDetectionJobProperties) SetVpcConfig(v *VpcConfig) *EntitiesDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (EntitiesDetectionJobProperties) String 

func (s EntitiesDetectionJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 Entity 

type Entity struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the entity.
	//
	// This field is empty for non-text input.
	BeginOffset *int64 `type:"integer"`

	// A reference to each block for this entity. This field is empty for plain-text
	// input.
	BlockReferences []*BlockReference `type:"list"`

	// The zero-based offset from the beginning of the source text to the last character
	// in the entity.
	//
	// This field is empty for non-text input.
	EndOffset *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`

	// The text of the entity.
	Text *string `min:"1" type:"string"`

	// The entity type. For entity detection using the built-in model, this field
	// contains one of the standard entity types listed below.
	//
	// For custom entity detection, this field contains one of the entity types
	// that you specified when you trained your custom model.
	Type *string `type:"string" enum:"EntityType"`
	// contains filtered or unexported fields
}

Provides information about an entity.

func (Entity) GoString 

func (s Entity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Entity) SetBeginOffset 

func (s *Entity) SetBeginOffset(v int64) *Entity

SetBeginOffset sets the BeginOffset field's value.

func (*Entity) SetBlockReferences added in v1.42.9 

func (s *Entity) SetBlockReferences(v []*BlockReference) *Entity

SetBlockReferences sets the BlockReferences field's value.

func (*Entity) SetEndOffset 

func (s *Entity) SetEndOffset(v int64) *Entity

SetEndOffset sets the EndOffset field's value.

func (*Entity) SetScore 

func (s *Entity) SetScore(v float64) *Entity

SetScore sets the Score field's value.

func (*Entity) SetText 

func (s *Entity) SetText(v string) *Entity

SetText sets the Text field's value.

func (*Entity) SetType 

func (s *Entity) SetType(v string) *Entity

SetType sets the Type field's value.

func (Entity) String 

func (s Entity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EntityLabel 

type EntityLabel struct {

	// The name of the label.
	Name *string `type:"string" enum:"PiiEntityType"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.

func (EntityLabel) GoString 

func (s EntityLabel) 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 (*EntityLabel) SetName 

func (s *EntityLabel) SetName(v string) *EntityLabel

SetName sets the Name field's value.

func (*EntityLabel) SetScore 

func (s *EntityLabel) SetScore(v float64) *EntityLabel

SetScore sets the Score field's value.

func (EntityLabel) String 

func (s EntityLabel) 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 EntityRecognitionConfig added in v1.42.9 

type EntityRecognitionConfig struct {

	// Up to 25 entity types that the model is trained to recognize.
	//
	// EntityTypes is a required field
	EntityTypes []*EntityTypesListItem `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Configuration required for an entity recognition model.

func (EntityRecognitionConfig) GoString added in v1.42.9 

func (s EntityRecognitionConfig) 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 (*EntityRecognitionConfig) SetEntityTypes added in v1.42.9 

func (s *EntityRecognitionConfig) SetEntityTypes(v []*EntityTypesListItem) *EntityRecognitionConfig

SetEntityTypes sets the EntityTypes field's value.

func (EntityRecognitionConfig) String added in v1.42.9 

func (s EntityRecognitionConfig) 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 (*EntityRecognitionConfig) Validate added in v1.42.9 

func (s *EntityRecognitionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityRecognizerAnnotations 

type EntityRecognizerAnnotations struct {

	// Specifies the Amazon S3 location where the annotations for an entity recognizer
	// are located. The URI must be in the same Region as the API endpoint that
	// you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`

	// Specifies the Amazon S3 location where the test annotations for an entity
	// recognizer are located. The URI must be in the same Region as the API endpoint
	// that you are calling.
	TestS3Uri *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the annotations associated with a entity recognizer.

func (EntityRecognizerAnnotations) GoString 

func (s EntityRecognizerAnnotations) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerAnnotations) SetS3Uri 

func (s *EntityRecognizerAnnotations) SetS3Uri(v string) *EntityRecognizerAnnotations

SetS3Uri sets the S3Uri field's value.

func (*EntityRecognizerAnnotations) SetTestS3Uri 

func (s *EntityRecognizerAnnotations) SetTestS3Uri(v string) *EntityRecognizerAnnotations

SetTestS3Uri sets the TestS3Uri field's value.

func (EntityRecognizerAnnotations) String 

func (s EntityRecognizerAnnotations) 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 (*EntityRecognizerAnnotations) Validate 

func (s *EntityRecognizerAnnotations) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityRecognizerDocuments 

type EntityRecognizerDocuments struct {

	// Specifies how the text in an input file should be processed. This is optional,
	// and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered
	// a separate document. Use this option when you are processing large documents,
	// such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each
	// line in a file is considered a separate document. Use this option when you
	// are processing many short documents, such as text messages.
	InputFormat *string `type:"string" enum:"InputFormat"`

	// Specifies the Amazon S3 location where the training documents for an entity
	// recognizer are located. The URI must be in the same Region as the API endpoint
	// that you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`

	// Specifies the Amazon S3 location where the test documents for an entity recognizer
	// are located. The URI must be in the same Amazon Web Services Region as the
	// API endpoint that you are calling.
	TestS3Uri *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the training documents submitted with an entity recognizer.

func (EntityRecognizerDocuments) GoString 

func (s EntityRecognizerDocuments) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerDocuments) SetInputFormat 

func (s *EntityRecognizerDocuments) SetInputFormat(v string) *EntityRecognizerDocuments

SetInputFormat sets the InputFormat field's value.

func (*EntityRecognizerDocuments) SetS3Uri 

func (s *EntityRecognizerDocuments) SetS3Uri(v string) *EntityRecognizerDocuments

SetS3Uri sets the S3Uri field's value.

func (*EntityRecognizerDocuments) SetTestS3Uri 

func (s *EntityRecognizerDocuments) SetTestS3Uri(v string) *EntityRecognizerDocuments

SetTestS3Uri sets the TestS3Uri field's value.

func (EntityRecognizerDocuments) String 

func (s EntityRecognizerDocuments) 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 (*EntityRecognizerDocuments) Validate 

func (s *EntityRecognizerDocuments) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityRecognizerEntityList 

type EntityRecognizerEntityList struct {

	// Specifies the Amazon S3 location where the entity list is located. The URI
	// must be in the same Region as the API endpoint that you are calling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the entity list submitted with an entity recognizer.

func (EntityRecognizerEntityList) GoString 

func (s EntityRecognizerEntityList) 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 (*EntityRecognizerEntityList) SetS3Uri 

func (s *EntityRecognizerEntityList) SetS3Uri(v string) *EntityRecognizerEntityList

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerEntityList) String 

func (s EntityRecognizerEntityList) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerEntityList) Validate 

func (s *EntityRecognizerEntityList) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityRecognizerEvaluationMetrics 

type EntityRecognizerEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for the test data. It
	// is derived from the Precision and Recall values. The F1Score is the harmonic
	// average of the two scores. For plain text entity recognizer models, the range
	// is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer
	// models, the range is 0 to 1, where 1 is the best score.
	F1Score *float64 `type:"double"`

	// A measure of the usefulness of the recognizer results in the test data. High
	// precision means that the recognizer returned substantially more relevant
	// results than irrelevant ones.
	Precision *float64 `type:"double"`

	// A measure of how complete the recognizer results are for the test data. High
	// recall means that the recognizer returned most of the relevant results.
	Recall *float64 `type:"double"`
	// contains filtered or unexported fields
}

Detailed information about the accuracy of an entity recognizer.

func (EntityRecognizerEvaluationMetrics) GoString 

func (s EntityRecognizerEvaluationMetrics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerEvaluationMetrics) SetF1Score 

func (s *EntityRecognizerEvaluationMetrics) SetF1Score(v float64) *EntityRecognizerEvaluationMetrics

SetF1Score sets the F1Score field's value.

func (*EntityRecognizerEvaluationMetrics) SetPrecision 

func (s *EntityRecognizerEvaluationMetrics) SetPrecision(v float64) *EntityRecognizerEvaluationMetrics

SetPrecision sets the Precision field's value.

func (*EntityRecognizerEvaluationMetrics) SetRecall 

func (s *EntityRecognizerEvaluationMetrics) SetRecall(v float64) *EntityRecognizerEvaluationMetrics

SetRecall sets the Recall field's value.

func (EntityRecognizerEvaluationMetrics) String 

func (s EntityRecognizerEvaluationMetrics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EntityRecognizerFilter 

type EntityRecognizerFilter struct {

	// The name that you assigned the entity recognizer.
	RecognizerName *string `type:"string"`

	// The status of an entity recognizer.
	Status *string `type:"string" enum:"ModelStatus"`

	// Filters the list of entities based on the time that the list was submitted
	// for processing. Returns only jobs submitted after the specified time. Jobs
	// are returned in ascending order, oldest to newest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of entities based on the time that the list was submitted
	// for processing. Returns only jobs submitted before the specified time. Jobs
	// are returned in descending order, newest to oldest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the ListEntityRecognizers operation./>

func (EntityRecognizerFilter) GoString 

func (s EntityRecognizerFilter) 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 (*EntityRecognizerFilter) SetRecognizerName 

func (s *EntityRecognizerFilter) SetRecognizerName(v string) *EntityRecognizerFilter

SetRecognizerName sets the RecognizerName field's value.

func (*EntityRecognizerFilter) SetStatus 

func (s *EntityRecognizerFilter) SetStatus(v string) *EntityRecognizerFilter

SetStatus sets the Status field's value.

func (*EntityRecognizerFilter) SetSubmitTimeAfter 

func (s *EntityRecognizerFilter) SetSubmitTimeAfter(v time.Time) *EntityRecognizerFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntityRecognizerFilter) SetSubmitTimeBefore 

func (s *EntityRecognizerFilter) SetSubmitTimeBefore(v time.Time) *EntityRecognizerFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntityRecognizerFilter) String 

func (s EntityRecognizerFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EntityRecognizerInputDataConfig 

type EntityRecognizerInputDataConfig struct {

	// The S3 location of the CSV file that annotates your training documents.
	Annotations *EntityRecognizerAnnotations `type:"structure"`

	// A list of augmented manifest files that provide training data for your custom
	// model. An augmented manifest file is a labeled dataset that is produced by
	// Amazon SageMaker Ground Truth.
	//
	// This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.
	AugmentedManifests []*AugmentedManifestsListItem `type:"list"`

	// The format of your training data:
	//
	//    * COMPREHEND_CSV: A CSV file that supplements your training documents.
	//    The CSV file contains information about the custom entities that your
	//    trained model will detect. The required format of the file depends on
	//    whether you are providing annotations or an entity list. If you use this
	//    value, you must provide your CSV file by using either the Annotations
	//    or EntityList parameters. You must provide your training documents by
	//    using the Documents parameter.
	//
	//    * AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker
	//    Ground Truth. This file is in JSON lines format. Each line is a complete
	//    JSON object that contains a training document and its labels. Each label
	//    annotates a named entity in the training document. If you use this value,
	//    you must provide the AugmentedManifests parameter in your request.
	//
	// If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the
	// default.
	DataFormat *string `type:"string" enum:"EntityRecognizerDataFormat"`

	// The S3 location of the folder that contains the training documents for your
	// custom entity recognizer.
	//
	// This parameter is required if you set DataFormat to COMPREHEND_CSV.
	Documents *EntityRecognizerDocuments `type:"structure"`

	// The S3 location of the CSV file that has the entity list for your custom
	// entity recognizer.
	EntityList *EntityRecognizerEntityList `type:"structure"`

	// The entity types in the labeled training data that Amazon Comprehend uses
	// to train the custom entity recognizer. Any entity types that you don't specify
	// are ignored.
	//
	// A maximum of 25 entity types can be used at one time to train an entity recognizer.
	// Entity types must not contain the following invalid characters: \n (line
	// break), \\n (escaped line break), \r (carriage return), \\r (escaped carriage
	// return), \t (tab), \\t (escaped tab), space, and , (comma).
	//
	// EntityTypes is a required field
	EntityTypes []*EntityTypesListItem `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies the format and location of the input data.

func (EntityRecognizerInputDataConfig) GoString 

func (s EntityRecognizerInputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerInputDataConfig) SetAnnotations 

func (s *EntityRecognizerInputDataConfig) SetAnnotations(v *EntityRecognizerAnnotations) *EntityRecognizerInputDataConfig

SetAnnotations sets the Annotations field's value.

func (*EntityRecognizerInputDataConfig) SetAugmentedManifests 

func (s *EntityRecognizerInputDataConfig) SetAugmentedManifests(v []*AugmentedManifestsListItem) *EntityRecognizerInputDataConfig

SetAugmentedManifests sets the AugmentedManifests field's value.

func (*EntityRecognizerInputDataConfig) SetDataFormat 

func (s *EntityRecognizerInputDataConfig) SetDataFormat(v string) *EntityRecognizerInputDataConfig

SetDataFormat sets the DataFormat field's value.

func (*EntityRecognizerInputDataConfig) SetDocuments 

func (s *EntityRecognizerInputDataConfig) SetDocuments(v *EntityRecognizerDocuments) *EntityRecognizerInputDataConfig

SetDocuments sets the Documents field's value.

func (*EntityRecognizerInputDataConfig) SetEntityList 

func (s *EntityRecognizerInputDataConfig) SetEntityList(v *EntityRecognizerEntityList) *EntityRecognizerInputDataConfig

SetEntityList sets the EntityList field's value.

func (*EntityRecognizerInputDataConfig) SetEntityTypes 

func (s *EntityRecognizerInputDataConfig) SetEntityTypes(v []*EntityTypesListItem) *EntityRecognizerInputDataConfig

SetEntityTypes sets the EntityTypes field's value.

func (EntityRecognizerInputDataConfig) String 

func (s EntityRecognizerInputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerInputDataConfig) Validate 

func (s *EntityRecognizerInputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityRecognizerMetadata 

type EntityRecognizerMetadata struct {

	// Entity types from the metadata of an entity recognizer.
	EntityTypes []*EntityRecognizerMetadataEntityTypesListItem `type:"list"`

	// Detailed information about the accuracy of an entity recognizer.
	EvaluationMetrics *EntityRecognizerEvaluationMetrics `type:"structure"`

	// The number of documents in the input data that were used to test the entity
	// recognizer. Typically this is 10 to 20 percent of the input documents.
	NumberOfTestDocuments *int64 `type:"integer"`

	// The number of documents in the input data that were used to train the entity
	// recognizer. Typically this is 80 to 90 percent of the input documents.
	NumberOfTrainedDocuments *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Detailed information about an entity recognizer.

func (EntityRecognizerMetadata) GoString 

func (s EntityRecognizerMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerMetadata) SetEntityTypes 

func (s *EntityRecognizerMetadata) SetEntityTypes(v []*EntityRecognizerMetadataEntityTypesListItem) *EntityRecognizerMetadata

SetEntityTypes sets the EntityTypes field's value.

func (*EntityRecognizerMetadata) SetEvaluationMetrics 

func (s *EntityRecognizerMetadata) SetEvaluationMetrics(v *EntityRecognizerEvaluationMetrics) *EntityRecognizerMetadata

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadata) SetNumberOfTestDocuments 

func (s *EntityRecognizerMetadata) SetNumberOfTestDocuments(v int64) *EntityRecognizerMetadata

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*EntityRecognizerMetadata) SetNumberOfTrainedDocuments 

func (s *EntityRecognizerMetadata) SetNumberOfTrainedDocuments(v int64) *EntityRecognizerMetadata

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (EntityRecognizerMetadata) String 

func (s EntityRecognizerMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EntityRecognizerMetadataEntityTypesListItem 

type EntityRecognizerMetadataEntityTypesListItem struct {

	// Detailed information about the accuracy of the entity recognizer for a specific
	// item on the list of entity types.
	EvaluationMetrics *EntityTypesEvaluationMetrics `type:"structure"`

	// Indicates the number of times the given entity type was seen in the training
	// data.
	NumberOfTrainMentions *int64 `type:"integer"`

	// Type of entity from the list of entity types in the metadata of an entity
	// recognizer.
	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Individual item from the list of entity types in the metadata of an entity recognizer.

func (EntityRecognizerMetadataEntityTypesListItem) GoString 

func (s EntityRecognizerMetadataEntityTypesListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerMetadataEntityTypesListItem) SetEvaluationMetrics 

func (s *EntityRecognizerMetadataEntityTypesListItem) SetEvaluationMetrics(v *EntityTypesEvaluationMetrics) *EntityRecognizerMetadataEntityTypesListItem

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetNumberOfTrainMentions 

func (s *EntityRecognizerMetadataEntityTypesListItem) SetNumberOfTrainMentions(v int64) *EntityRecognizerMetadataEntityTypesListItem

SetNumberOfTrainMentions sets the NumberOfTrainMentions field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetType 

func (s *EntityRecognizerMetadataEntityTypesListItem) SetType(v string) *EntityRecognizerMetadataEntityTypesListItem

SetType sets the Type field's value.

func (EntityRecognizerMetadataEntityTypesListItem) String 

func (s EntityRecognizerMetadataEntityTypesListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EntityRecognizerOutputDataConfig added in v1.42.9 

type EntityRecognizerOutputDataConfig struct {

	// The Amazon S3 prefix for the data lake location of the flywheel statistics.
	FlywheelStatsS3Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

Output data configuration.

func (EntityRecognizerOutputDataConfig) GoString added in v1.42.9 

func (s EntityRecognizerOutputDataConfig) 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 (*EntityRecognizerOutputDataConfig) SetFlywheelStatsS3Prefix added in v1.42.9 

func (s *EntityRecognizerOutputDataConfig) SetFlywheelStatsS3Prefix(v string) *EntityRecognizerOutputDataConfig

SetFlywheelStatsS3Prefix sets the FlywheelStatsS3Prefix field's value.

func (EntityRecognizerOutputDataConfig) String added in v1.42.9 

func (s EntityRecognizerOutputDataConfig) 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 EntityRecognizerProperties 

type EntityRecognizerProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the recognizer creation completed.
	EndTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string `type:"string"`

	// The Amazon Resource Number (ARN) of the flywheel
	FlywheelArn *string `type:"string"`

	// The input data properties of an entity recognizer.
	InputDataConfig *EntityRecognizerInputDataConfig `type:"structure"`

	// The language of the input documents. All documents must be in the same language.
	// Only English ("en") is currently supported.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// A description of the status of the recognizer.
	Message *string `type:"string"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string `type:"string"`

	// Output data configuration.
	OutputDataConfig *EntityRecognizerOutputDataConfig `type:"structure"`

	// Provides information about an entity recognizer.
	//
	// RecognizerMetadata is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EntityRecognizerProperties's
	// String and GoString methods.
	RecognizerMetadata *EntityRecognizerMetadata `type:"structure" sensitive:"true"`

	// The Amazon Resource Name (ARN) of the source model. This model was imported
	// from a different Amazon Web Services account to create the entity recognizer
	// model in your Amazon Web Services account.
	SourceModelArn *string `type:"string"`

	// Provides the status of the entity recognizer.
	Status *string `type:"string" enum:"ModelStatus"`

	// The time that the recognizer was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// The time that training of the entity recognizer was completed.
	TrainingEndTime *time.Time `type:"timestamp"`

	// The time that training of the entity recognizer started.
	TrainingStartTime *time.Time `type:"timestamp"`

	// The version name you assigned to the entity recognizer.
	VersionName *string `type:"string"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your custom entity recognizer. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Describes information about an entity recognizer.

func (EntityRecognizerProperties) GoString 

func (s EntityRecognizerProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityRecognizerProperties) SetDataAccessRoleArn 

func (s *EntityRecognizerProperties) SetDataAccessRoleArn(v string) *EntityRecognizerProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntityRecognizerProperties) SetEndTime 

func (s *EntityRecognizerProperties) SetEndTime(v time.Time) *EntityRecognizerProperties

SetEndTime sets the EndTime field's value.

func (*EntityRecognizerProperties) SetEntityRecognizerArn 

func (s *EntityRecognizerProperties) SetEntityRecognizerArn(v string) *EntityRecognizerProperties

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntityRecognizerProperties) SetFlywheelArn added in v1.42.9 

func (s *EntityRecognizerProperties) SetFlywheelArn(v string) *EntityRecognizerProperties

SetFlywheelArn sets the FlywheelArn field's value.

func (*EntityRecognizerProperties) SetInputDataConfig 

func (s *EntityRecognizerProperties) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *EntityRecognizerProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntityRecognizerProperties) SetLanguageCode 

func (s *EntityRecognizerProperties) SetLanguageCode(v string) *EntityRecognizerProperties

SetLanguageCode sets the LanguageCode field's value.

func (*EntityRecognizerProperties) SetMessage 

func (s *EntityRecognizerProperties) SetMessage(v string) *EntityRecognizerProperties

SetMessage sets the Message field's value.

func (*EntityRecognizerProperties) SetModelKmsKeyId 

func (s *EntityRecognizerProperties) SetModelKmsKeyId(v string) *EntityRecognizerProperties

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*EntityRecognizerProperties) SetOutputDataConfig added in v1.42.9 

func (s *EntityRecognizerProperties) SetOutputDataConfig(v *EntityRecognizerOutputDataConfig) *EntityRecognizerProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*EntityRecognizerProperties) SetRecognizerMetadata 

func (s *EntityRecognizerProperties) SetRecognizerMetadata(v *EntityRecognizerMetadata) *EntityRecognizerProperties

SetRecognizerMetadata sets the RecognizerMetadata field's value.

func (*EntityRecognizerProperties) SetSourceModelArn added in v1.42.9 

func (s *EntityRecognizerProperties) SetSourceModelArn(v string) *EntityRecognizerProperties

SetSourceModelArn sets the SourceModelArn field's value.

func (*EntityRecognizerProperties) SetStatus 

func (s *EntityRecognizerProperties) SetStatus(v string) *EntityRecognizerProperties

SetStatus sets the Status field's value.

func (*EntityRecognizerProperties) SetSubmitTime 

func (s *EntityRecognizerProperties) SetSubmitTime(v time.Time) *EntityRecognizerProperties

SetSubmitTime sets the SubmitTime field's value.

func (*EntityRecognizerProperties) SetTrainingEndTime 

func (s *EntityRecognizerProperties) SetTrainingEndTime(v time.Time) *EntityRecognizerProperties

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*EntityRecognizerProperties) SetTrainingStartTime 

func (s *EntityRecognizerProperties) SetTrainingStartTime(v time.Time) *EntityRecognizerProperties

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*EntityRecognizerProperties) SetVersionName 

func (s *EntityRecognizerProperties) SetVersionName(v string) *EntityRecognizerProperties

SetVersionName sets the VersionName field's value.

func (*EntityRecognizerProperties) SetVolumeKmsKeyId 

func (s *EntityRecognizerProperties) SetVolumeKmsKeyId(v string) *EntityRecognizerProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntityRecognizerProperties) SetVpcConfig 

func (s *EntityRecognizerProperties) SetVpcConfig(v *VpcConfig) *EntityRecognizerProperties

SetVpcConfig sets the VpcConfig field's value.

func (EntityRecognizerProperties) String 

func (s EntityRecognizerProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EntityRecognizerSummary 

type EntityRecognizerSummary struct {

	// The time that the latest entity recognizer version was submitted for processing.
	LatestVersionCreatedAt *time.Time `type:"timestamp"`

	// The version name you assigned to the latest entity recognizer version.
	LatestVersionName *string `type:"string"`

	// Provides the status of the latest entity recognizer version.
	LatestVersionStatus *string `type:"string" enum:"ModelStatus"`

	// The number of versions you created.
	NumberOfVersions *int64 `type:"integer"`

	// The name that you assigned the entity recognizer.
	RecognizerName *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the information about an entity recognizer and its versions.

func (EntityRecognizerSummary) GoString 

func (s EntityRecognizerSummary) 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 (*EntityRecognizerSummary) SetLatestVersionCreatedAt 

func (s *EntityRecognizerSummary) SetLatestVersionCreatedAt(v time.Time) *EntityRecognizerSummary

SetLatestVersionCreatedAt sets the LatestVersionCreatedAt field's value.

func (*EntityRecognizerSummary) SetLatestVersionName 

func (s *EntityRecognizerSummary) SetLatestVersionName(v string) *EntityRecognizerSummary

SetLatestVersionName sets the LatestVersionName field's value.

func (*EntityRecognizerSummary) SetLatestVersionStatus 

func (s *EntityRecognizerSummary) SetLatestVersionStatus(v string) *EntityRecognizerSummary

SetLatestVersionStatus sets the LatestVersionStatus field's value.

func (*EntityRecognizerSummary) SetNumberOfVersions 

func (s *EntityRecognizerSummary) SetNumberOfVersions(v int64) *EntityRecognizerSummary

SetNumberOfVersions sets the NumberOfVersions field's value.

func (*EntityRecognizerSummary) SetRecognizerName 

func (s *EntityRecognizerSummary) SetRecognizerName(v string) *EntityRecognizerSummary

SetRecognizerName sets the RecognizerName field's value.

func (EntityRecognizerSummary) String 

func (s EntityRecognizerSummary) 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 EntityTypesEvaluationMetrics 

type EntityTypesEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for a specific entity
	// type in the test data. It is derived from the Precision and Recall values.
	// The F1Score is the harmonic average of the two scores. The highest score
	// is 1, and the worst score is 0.
	F1Score *float64 `type:"double"`

	// A measure of the usefulness of the recognizer results for a specific entity
	// type in the test data. High precision means that the recognizer returned
	// substantially more relevant results than irrelevant ones.
	Precision *float64 `type:"double"`

	// A measure of how complete the recognizer results are for a specific entity
	// type in the test data. High recall means that the recognizer returned most
	// of the relevant results.
	Recall *float64 `type:"double"`
	// contains filtered or unexported fields
}

Detailed information about the accuracy of an entity recognizer for a specific entity type.

func (EntityTypesEvaluationMetrics) GoString 

func (s EntityTypesEvaluationMetrics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityTypesEvaluationMetrics) SetF1Score 

func (s *EntityTypesEvaluationMetrics) SetF1Score(v float64) *EntityTypesEvaluationMetrics

SetF1Score sets the F1Score field's value.

func (*EntityTypesEvaluationMetrics) SetPrecision 

func (s *EntityTypesEvaluationMetrics) SetPrecision(v float64) *EntityTypesEvaluationMetrics

SetPrecision sets the Precision field's value.

func (*EntityTypesEvaluationMetrics) SetRecall 

func (s *EntityTypesEvaluationMetrics) SetRecall(v float64) *EntityTypesEvaluationMetrics

SetRecall sets the Recall field's value.

func (EntityTypesEvaluationMetrics) String 

func (s EntityTypesEvaluationMetrics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EntityTypesListItem 

type EntityTypesListItem struct {

	// An entity type within a labeled training dataset that Amazon Comprehend uses
	// to train a custom entity recognizer.
	//
	// Entity types must not contain the following invalid characters: \n (line
	// break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage
	// return), \t (tab), \\t (escaped tab), space, and , (comma).
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

func (EntityTypesListItem) GoString 

func (s EntityTypesListItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityTypesListItem) SetType 

func (s *EntityTypesListItem) SetType(v string) *EntityTypesListItem

SetType sets the Type field's value.

func (EntityTypesListItem) String 

func (s EntityTypesListItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityTypesListItem) Validate 

func (s *EntityTypesListItem) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ErrorsListItem added in v1.42.9 

type ErrorsListItem struct {

	// Error code for the cause of the error.
	ErrorCode *string `type:"string" enum:"PageBasedErrorCode"`

	// Text message explaining the reason for the error.
	ErrorMessage *string `min:"1" type:"string"`

	// Page number where the error occurred.
	Page *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Text extraction encountered one or more page-level errors in the input document.

The ErrorCode contains one of the following values:

  • TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information about page limits in Amazon Textract, see Page Quotas in Amazon Textract (https://docs.aws.amazon.com/textract/latest/dg/limits-document.html).

  • TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit. For more information about throughput quotas in Amazon Textract, see Default quotas in Amazon Textract (https://docs.aws.amazon.com/textract/latest/dg/limits-quotas-explained.html).

  • PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).

  • PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.

  • INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.

func (ErrorsListItem) GoString added in v1.42.9 

func (s ErrorsListItem) 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 (*ErrorsListItem) SetErrorCode added in v1.42.9 

func (s *ErrorsListItem) SetErrorCode(v string) *ErrorsListItem

SetErrorCode sets the ErrorCode field's value.

func (*ErrorsListItem) SetErrorMessage added in v1.42.9 

func (s *ErrorsListItem) SetErrorMessage(v string) *ErrorsListItem

SetErrorMessage sets the ErrorMessage field's value.

func (*ErrorsListItem) SetPage added in v1.42.9 

func (s *ErrorsListItem) SetPage(v int64) *ErrorsListItem

SetPage sets the Page field's value.

func (ErrorsListItem) String added in v1.42.9 

func (s ErrorsListItem) 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 EventsDetectionJobFilter 

type EventsDetectionJobFilter struct {

	// Filters on the name of the events detection 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 event detection jobs.

func (EventsDetectionJobFilter) GoString 

func (s EventsDetectionJobFilter) 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 (*EventsDetectionJobFilter) SetJobName 

func (s *EventsDetectionJobFilter) SetJobName(v string) *EventsDetectionJobFilter

SetJobName sets the JobName field's value.

func (*EventsDetectionJobFilter) SetJobStatus 

func (s *EventsDetectionJobFilter) SetJobStatus(v string) *EventsDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*EventsDetectionJobFilter) SetSubmitTimeAfter 

func (s *EventsDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *EventsDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EventsDetectionJobFilter) SetSubmitTimeBefore 

func (s *EventsDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *EventsDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EventsDetectionJobFilter) String 

func (s EventsDetectionJobFilter) 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 (*EventsDetectionJobFilter) Validate 

func (s *EventsDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EventsDetectionJobProperties 

type EventsDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the events detection job completed.
	EndTime *time.Time `type:"timestamp"`

	// The input data configuration that you supplied when you created the events
	// detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the events detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier assigned to the events detection job.
	JobId *string `min:"1" type:"string"`

	// The name you assigned the events detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the events detection job.
	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 the events detection job.
	Message *string `type:"string"`

	// The output data configuration that you supplied when you created the events
	// detection job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the events detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// The types of events that are detected by the job.
	TargetEventTypes []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides information about an events detection job.

func (EventsDetectionJobProperties) GoString 

func (s EventsDetectionJobProperties) 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 (*EventsDetectionJobProperties) SetDataAccessRoleArn 

func (s *EventsDetectionJobProperties) SetDataAccessRoleArn(v string) *EventsDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EventsDetectionJobProperties) SetEndTime 

func (s *EventsDetectionJobProperties) SetEndTime(v time.Time) *EventsDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*EventsDetectionJobProperties) SetInputDataConfig 

func (s *EventsDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *EventsDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EventsDetectionJobProperties) SetJobArn 

func (s *EventsDetectionJobProperties) SetJobArn(v string) *EventsDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*EventsDetectionJobProperties) SetJobId 

func (s *EventsDetectionJobProperties) SetJobId(v string) *EventsDetectionJobProperties

SetJobId sets the JobId field's value.

func (*EventsDetectionJobProperties) SetJobName 

func (s *EventsDetectionJobProperties) SetJobName(v string) *EventsDetectionJobProperties

SetJobName sets the JobName field's value.

func (*EventsDetectionJobProperties) SetJobStatus 

func (s *EventsDetectionJobProperties) SetJobStatus(v string) *EventsDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*EventsDetectionJobProperties) SetLanguageCode 

func (s *EventsDetectionJobProperties) SetLanguageCode(v string) *EventsDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*EventsDetectionJobProperties) SetMessage 

func (s *EventsDetectionJobProperties) SetMessage(v string) *EventsDetectionJobProperties

SetMessage sets the Message field's value.

func (*EventsDetectionJobProperties) SetOutputDataConfig 

func (s *EventsDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *EventsDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*EventsDetectionJobProperties) SetSubmitTime 

func (s *EventsDetectionJobProperties) SetSubmitTime(v time.Time) *EventsDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*EventsDetectionJobProperties) SetTargetEventTypes 

func (s *EventsDetectionJobProperties) SetTargetEventTypes(v []*string) *EventsDetectionJobProperties

SetTargetEventTypes sets the TargetEventTypes field's value.

func (EventsDetectionJobProperties) String 

func (s EventsDetectionJobProperties) 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 ExtractedCharactersListItem added in v1.42.9 

type ExtractedCharactersListItem struct {

	// Number of characters extracted from each page.
	Count *int64 `type:"integer"`

	// Page number.
	Page *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Array of the number of characters extracted from each page.

func (ExtractedCharactersListItem) GoString added in v1.42.9 

func (s ExtractedCharactersListItem) 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 (*ExtractedCharactersListItem) SetCount added in v1.42.9 

func (s *ExtractedCharactersListItem) SetCount(v int64) *ExtractedCharactersListItem

SetCount sets the Count field's value.

func (*ExtractedCharactersListItem) SetPage added in v1.42.9 

func (s *ExtractedCharactersListItem) SetPage(v int64) *ExtractedCharactersListItem

SetPage sets the Page field's value.

func (ExtractedCharactersListItem) String added in v1.42.9 

func (s ExtractedCharactersListItem) 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 FlywheelFilter added in v1.42.9 

type FlywheelFilter struct {

	// Filter the flywheels to include flywheels created after the specified time.
	CreationTimeAfter *time.Time `type:"timestamp"`

	// Filter the flywheels to include flywheels created before the specified time.
	CreationTimeBefore *time.Time `type:"timestamp"`

	// Filter the flywheels based on the flywheel status.
	Status *string `type:"string" enum:"FlywheelStatus"`
	// contains filtered or unexported fields
}

Filter the flywheels based on creation time or flywheel status.

func (FlywheelFilter) GoString added in v1.42.9 

func (s FlywheelFilter) 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 (*FlywheelFilter) SetCreationTimeAfter added in v1.42.9 

func (s *FlywheelFilter) SetCreationTimeAfter(v time.Time) *FlywheelFilter

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*FlywheelFilter) SetCreationTimeBefore added in v1.42.9 

func (s *FlywheelFilter) SetCreationTimeBefore(v time.Time) *FlywheelFilter

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (*FlywheelFilter) SetStatus added in v1.42.9 

func (s *FlywheelFilter) SetStatus(v string) *FlywheelFilter

SetStatus sets the Status field's value.

func (FlywheelFilter) String added in v1.42.9 

func (s FlywheelFilter) 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 FlywheelIterationFilter added in v1.42.9 

type FlywheelIterationFilter struct {

	// Filter the flywheel iterations to include iterations created after the specified
	// time.
	CreationTimeAfter *time.Time `type:"timestamp"`

	// Filter the flywheel iterations to include iterations created before the specified
	// time.
	CreationTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Filter the flywheel iterations based on creation time.

func (FlywheelIterationFilter) GoString added in v1.42.9 

func (s FlywheelIterationFilter) 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 (*FlywheelIterationFilter) SetCreationTimeAfter added in v1.42.9 

func (s *FlywheelIterationFilter) SetCreationTimeAfter(v time.Time) *FlywheelIterationFilter

SetCreationTimeAfter sets the CreationTimeAfter field's value.

func (*FlywheelIterationFilter) SetCreationTimeBefore added in v1.42.9 

func (s *FlywheelIterationFilter) SetCreationTimeBefore(v time.Time) *FlywheelIterationFilter

SetCreationTimeBefore sets the CreationTimeBefore field's value.

func (FlywheelIterationFilter) String added in v1.42.9 

func (s FlywheelIterationFilter) 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 FlywheelIterationProperties added in v1.42.9 

type FlywheelIterationProperties struct {

	// The creation start time of the flywheel iteration.
	CreationTime *time.Time `type:"timestamp"`

	// The completion time of this flywheel iteration.
	EndTime *time.Time `type:"timestamp"`

	// The ARN of the evaluated model associated with this flywheel iteration.
	EvaluatedModelArn *string `type:"string"`

	// The evaluation metrics associated with the evaluated model.
	EvaluatedModelMetrics *FlywheelModelEvaluationMetrics `type:"structure"`

	EvaluationManifestS3Prefix *string `type:"string"`

	FlywheelArn *string `type:"string"`

	FlywheelIterationId *string `type:"string"`

	// A description of the status of the flywheel iteration.
	Message *string `type:"string"`

	// The status of the flywheel iteration.
	Status *string `type:"string" enum:"FlywheelIterationStatus"`

	// The ARN of the trained model associated with this flywheel iteration.
	TrainedModelArn *string `type:"string"`

	// The metrics associated with the trained model.
	TrainedModelMetrics *FlywheelModelEvaluationMetrics `type:"structure"`
	// contains filtered or unexported fields
}

The configuration properties of a flywheel iteration.

func (FlywheelIterationProperties) GoString added in v1.42.9 

func (s FlywheelIterationProperties) 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 (*FlywheelIterationProperties) SetCreationTime added in v1.42.9 

func (s *FlywheelIterationProperties) SetCreationTime(v time.Time) *FlywheelIterationProperties

SetCreationTime sets the CreationTime field's value.

func (*FlywheelIterationProperties) SetEndTime added in v1.42.9 

func (s *FlywheelIterationProperties) SetEndTime(v time.Time) *FlywheelIterationProperties

SetEndTime sets the EndTime field's value.

func (*FlywheelIterationProperties) SetEvaluatedModelArn added in v1.42.9 

func (s *FlywheelIterationProperties) SetEvaluatedModelArn(v string) *FlywheelIterationProperties

SetEvaluatedModelArn sets the EvaluatedModelArn field's value.

func (*FlywheelIterationProperties) SetEvaluatedModelMetrics added in v1.42.9 

func (s *FlywheelIterationProperties) SetEvaluatedModelMetrics(v *FlywheelModelEvaluationMetrics) *FlywheelIterationProperties

SetEvaluatedModelMetrics sets the EvaluatedModelMetrics field's value.

func (*FlywheelIterationProperties) SetEvaluationManifestS3Prefix added in v1.42.9 

func (s *FlywheelIterationProperties) SetEvaluationManifestS3Prefix(v string) *FlywheelIterationProperties

SetEvaluationManifestS3Prefix sets the EvaluationManifestS3Prefix field's value.

func (*FlywheelIterationProperties) SetFlywheelArn added in v1.42.9 

func (s *FlywheelIterationProperties) SetFlywheelArn(v string) *FlywheelIterationProperties

SetFlywheelArn sets the FlywheelArn field's value.

func (*FlywheelIterationProperties) SetFlywheelIterationId added in v1.42.9 

func (s *FlywheelIterationProperties) SetFlywheelIterationId(v string) *FlywheelIterationProperties

SetFlywheelIterationId sets the FlywheelIterationId field's value.

func (*FlywheelIterationProperties) SetMessage added in v1.42.9 

func (s *FlywheelIterationProperties) SetMessage(v string) *FlywheelIterationProperties

SetMessage sets the Message field's value.

func (*FlywheelIterationProperties) SetStatus added in v1.42.9 

func (s *FlywheelIterationProperties) SetStatus(v string) *FlywheelIterationProperties

SetStatus sets the Status field's value.

func (*FlywheelIterationProperties) SetTrainedModelArn added in v1.42.9 

func (s *FlywheelIterationProperties) SetTrainedModelArn(v string) *FlywheelIterationProperties

SetTrainedModelArn sets the TrainedModelArn field's value.

func (*FlywheelIterationProperties) SetTrainedModelMetrics added in v1.42.9 

func (s *FlywheelIterationProperties) SetTrainedModelMetrics(v *FlywheelModelEvaluationMetrics) *FlywheelIterationProperties

SetTrainedModelMetrics sets the TrainedModelMetrics field's value.

func (FlywheelIterationProperties) String added in v1.42.9 

func (s FlywheelIterationProperties) 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 FlywheelModelEvaluationMetrics added in v1.42.9 

type FlywheelModelEvaluationMetrics struct {

	// Average accuracy metric for the model.
	AverageAccuracy *float64 `type:"double"`

	// The average F1 score from the evaluation metrics.
	AverageF1Score *float64 `type:"double"`

	// Average precision metric for the model.
	AveragePrecision *float64 `type:"double"`

	// Average recall metric for the model.
	AverageRecall *float64 `type:"double"`
	// contains filtered or unexported fields
}

The evaluation metrics associated with the evaluated model.

func (FlywheelModelEvaluationMetrics) GoString added in v1.42.9 

func (s FlywheelModelEvaluationMetrics) 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 (*FlywheelModelEvaluationMetrics) SetAverageAccuracy added in v1.42.9 

func (s *FlywheelModelEvaluationMetrics) SetAverageAccuracy(v float64) *FlywheelModelEvaluationMetrics

SetAverageAccuracy sets the AverageAccuracy field's value.

func (*FlywheelModelEvaluationMetrics) SetAverageF1Score added in v1.42.9 

func (s *FlywheelModelEvaluationMetrics) SetAverageF1Score(v float64) *FlywheelModelEvaluationMetrics

SetAverageF1Score sets the AverageF1Score field's value.

func (*FlywheelModelEvaluationMetrics) SetAveragePrecision added in v1.42.9 

func (s *FlywheelModelEvaluationMetrics) SetAveragePrecision(v float64) *FlywheelModelEvaluationMetrics

SetAveragePrecision sets the AveragePrecision field's value.

func (*FlywheelModelEvaluationMetrics) SetAverageRecall added in v1.42.9 

func (s *FlywheelModelEvaluationMetrics) SetAverageRecall(v float64) *FlywheelModelEvaluationMetrics

SetAverageRecall sets the AverageRecall field's value.

func (FlywheelModelEvaluationMetrics) String added in v1.42.9 

func (s FlywheelModelEvaluationMetrics) 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 FlywheelProperties added in v1.42.9 

type FlywheelProperties struct {

	// The Amazon Resource Number (ARN) of the active model version.
	ActiveModelArn *string `type:"string"`

	// Creation time of the flywheel.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// permission to access the flywheel data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// Amazon S3 URI of the data lake location.
	DataLakeS3Uri *string `type:"string"`

	// Data security configuration.
	DataSecurityConfig *DataSecurityConfig `type:"structure"`

	// The Amazon Resource Number (ARN) of the flywheel.
	FlywheelArn *string `type:"string"`

	// Last modified time for the flywheel.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The most recent flywheel iteration.
	LatestFlywheelIteration *string `type:"string"`

	// A description of the status of the flywheel.
	Message *string `type:"string"`

	// Model type of the flywheel's model.
	ModelType *string `type:"string" enum:"ModelType"`

	// The status of the flywheel.
	Status *string `type:"string" enum:"FlywheelStatus"`

	// Configuration about the custom classifier associated with the flywheel.
	TaskConfig *TaskConfig `type:"structure"`
	// contains filtered or unexported fields
}

The flywheel properties.

func (FlywheelProperties) GoString added in v1.42.9 

func (s FlywheelProperties) 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 (*FlywheelProperties) SetActiveModelArn added in v1.42.9 

func (s *FlywheelProperties) SetActiveModelArn(v string) *FlywheelProperties

SetActiveModelArn sets the ActiveModelArn field's value.

func (*FlywheelProperties) SetCreationTime added in v1.42.9 

func (s *FlywheelProperties) SetCreationTime(v time.Time) *FlywheelProperties

SetCreationTime sets the CreationTime field's value.

func (*FlywheelProperties) SetDataAccessRoleArn added in v1.42.9 

func (s *FlywheelProperties) SetDataAccessRoleArn(v string) *FlywheelProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*FlywheelProperties) SetDataLakeS3Uri added in v1.42.9 

func (s *FlywheelProperties) SetDataLakeS3Uri(v string) *FlywheelProperties

SetDataLakeS3Uri sets the DataLakeS3Uri field's value.

func (*FlywheelProperties) SetDataSecurityConfig added in v1.42.9 

func (s *FlywheelProperties) SetDataSecurityConfig(v *DataSecurityConfig) *FlywheelProperties

SetDataSecurityConfig sets the DataSecurityConfig field's value.

func (*FlywheelProperties) SetFlywheelArn added in v1.42.9 

func (s *FlywheelProperties) SetFlywheelArn(v string) *FlywheelProperties

SetFlywheelArn sets the FlywheelArn field's value.

func (*FlywheelProperties) SetLastModifiedTime added in v1.42.9 

func (s *FlywheelProperties) SetLastModifiedTime(v time.Time) *FlywheelProperties

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*FlywheelProperties) SetLatestFlywheelIteration added in v1.42.9 

func (s *FlywheelProperties) SetLatestFlywheelIteration(v string) *FlywheelProperties

SetLatestFlywheelIteration sets the LatestFlywheelIteration field's value.

func (*FlywheelProperties) SetMessage added in v1.42.9 

func (s *FlywheelProperties) SetMessage(v string) *FlywheelProperties

SetMessage sets the Message field's value.

func (*FlywheelProperties) SetModelType added in v1.42.9 

func (s *FlywheelProperties) SetModelType(v string) *FlywheelProperties

SetModelType sets the ModelType field's value.

func (*FlywheelProperties) SetStatus added in v1.42.9 

func (s *FlywheelProperties) SetStatus(v string) *FlywheelProperties

SetStatus sets the Status field's value.

func (*FlywheelProperties) SetTaskConfig added in v1.42.9 

func (s *FlywheelProperties) SetTaskConfig(v *TaskConfig) *FlywheelProperties

SetTaskConfig sets the TaskConfig field's value.

func (FlywheelProperties) String added in v1.42.9 

func (s FlywheelProperties) 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 FlywheelSummary added in v1.42.9 

type FlywheelSummary struct {

	// ARN of the active model version for the flywheel.
	ActiveModelArn *string `type:"string"`

	// Creation time of the flywheel.
	CreationTime *time.Time `type:"timestamp"`

	// Amazon S3 URI of the data lake location.
	DataLakeS3Uri *string `type:"string"`

	// The Amazon Resource Number (ARN) of the flywheel
	FlywheelArn *string `type:"string"`

	// Last modified time for the flywheel.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The most recent flywheel iteration.
	LatestFlywheelIteration *string `type:"string"`

	// A description of the status of the flywheel.
	Message *string `type:"string"`

	// Model type of the flywheel's model.
	ModelType *string `type:"string" enum:"ModelType"`

	// The status of the flywheel.
	Status *string `type:"string" enum:"FlywheelStatus"`
	// contains filtered or unexported fields
}

Flywheel summary information.

func (FlywheelSummary) GoString added in v1.42.9 

func (s FlywheelSummary) 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 (*FlywheelSummary) SetActiveModelArn added in v1.42.9 

func (s *FlywheelSummary) SetActiveModelArn(v string) *FlywheelSummary

SetActiveModelArn sets the ActiveModelArn field's value.

func (*FlywheelSummary) SetCreationTime added in v1.42.9 

func (s *FlywheelSummary) SetCreationTime(v time.Time) *FlywheelSummary

SetCreationTime sets the CreationTime field's value.

func (*FlywheelSummary) SetDataLakeS3Uri added in v1.42.9 

func (s *FlywheelSummary) SetDataLakeS3Uri(v string) *FlywheelSummary

SetDataLakeS3Uri sets the DataLakeS3Uri field's value.

func (*FlywheelSummary) SetFlywheelArn added in v1.42.9 

func (s *FlywheelSummary) SetFlywheelArn(v string) *FlywheelSummary

SetFlywheelArn sets the FlywheelArn field's value.

func (*FlywheelSummary) SetLastModifiedTime added in v1.42.9 

func (s *FlywheelSummary) SetLastModifiedTime(v time.Time) *FlywheelSummary

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*FlywheelSummary) SetLatestFlywheelIteration added in v1.42.9 

func (s *FlywheelSummary) SetLatestFlywheelIteration(v string) *FlywheelSummary

SetLatestFlywheelIteration sets the LatestFlywheelIteration field's value.

func (*FlywheelSummary) SetMessage added in v1.42.9 

func (s *FlywheelSummary) SetMessage(v string) *FlywheelSummary

SetMessage sets the Message field's value.

func (*FlywheelSummary) SetModelType added in v1.42.9 

func (s *FlywheelSummary) SetModelType(v string) *FlywheelSummary

SetModelType sets the ModelType field's value.

func (*FlywheelSummary) SetStatus added in v1.42.9 

func (s *FlywheelSummary) SetStatus(v string) *FlywheelSummary

SetStatus sets the Status field's value.

func (FlywheelSummary) String added in v1.42.9 

func (s FlywheelSummary) 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 Geometry added in v1.42.9 

type Geometry struct {

	// An axis-aligned coarse representation of the location of the recognized item
	// on the document page.
	BoundingBox *BoundingBox `type:"structure"`

	// Within the bounding box, a fine-grained polygon around the recognized item.
	Polygon []*Point `type:"list"`
	// contains filtered or unexported fields
}

Information about the location of items on a document page.

For additional information, see Geometry (https://docs.aws.amazon.com/textract/latest/dg/API_Geometry.html) in the Amazon Textract API reference.

func (Geometry) GoString added in v1.42.9 

func (s Geometry) 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 (*Geometry) SetBoundingBox added in v1.42.9 

func (s *Geometry) SetBoundingBox(v *BoundingBox) *Geometry

SetBoundingBox sets the BoundingBox field's value.

func (*Geometry) SetPolygon added in v1.42.9 

func (s *Geometry) SetPolygon(v []*Point) *Geometry

SetPolygon sets the Polygon field's value.

func (Geometry) String added in v1.42.9 

func (s Geometry) 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 ImportModelInput added in v1.42.9 

type ImportModelInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// permission to use Amazon Key Management Service (KMS) to encrypt or decrypt
	// the custom model.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string `type:"string"`

	// The name to assign to the custom model that is created in Amazon Comprehend
	// by this import.
	ModelName *string `type:"string"`

	// The Amazon Resource Name (ARN) of the custom model to import.
	//
	// SourceModelArn is a required field
	SourceModelArn *string `type:"string" required:"true"`

	// Tags to associate with the custom model that is created by this import. 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 custom model that is created by this import.
	// 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/Region.
	VersionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ImportModelInput) GoString added in v1.42.9 

func (s ImportModelInput) 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 (*ImportModelInput) SetDataAccessRoleArn added in v1.42.9 

func (s *ImportModelInput) SetDataAccessRoleArn(v string) *ImportModelInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*ImportModelInput) SetModelKmsKeyId added in v1.42.9 

func (s *ImportModelInput) SetModelKmsKeyId(v string) *ImportModelInput

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*ImportModelInput) SetModelName added in v1.42.9 

func (s *ImportModelInput) SetModelName(v string) *ImportModelInput

SetModelName sets the ModelName field's value.

func (*ImportModelInput) SetSourceModelArn added in v1.42.9 

func (s *ImportModelInput) SetSourceModelArn(v string) *ImportModelInput

SetSourceModelArn sets the SourceModelArn field's value.

func (*ImportModelInput) SetTags added in v1.42.9 

func (s *ImportModelInput) SetTags(v []*Tag) *ImportModelInput

SetTags sets the Tags field's value.

func (*ImportModelInput) SetVersionName added in v1.42.9 

func (s *ImportModelInput) SetVersionName(v string) *ImportModelInput

SetVersionName sets the VersionName field's value.

func (ImportModelInput) String added in v1.42.9 

func (s ImportModelInput) 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 (*ImportModelInput) Validate added in v1.42.9 

func (s *ImportModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportModelOutput added in v1.42.9 

type ImportModelOutput struct {

	// The Amazon Resource Name (ARN) of the custom model being imported.
	ModelArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ImportModelOutput) GoString added in v1.42.9 

func (s ImportModelOutput) 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 (*ImportModelOutput) SetModelArn added in v1.42.9 

func (s *ImportModelOutput) SetModelArn(v string) *ImportModelOutput

SetModelArn sets the ModelArn field's value.

func (ImportModelOutput) String added in v1.42.9 

func (s ImportModelOutput) 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 InputDataConfig 

type InputDataConfig struct {

	// Provides configuration parameters to override the default actions for extracting
	// text from PDF documents and image files.
	DocumentReaderConfig *DocumentReaderConfig `type:"structure"`

	// Specifies how the text in an input file should be processed:
	//
	//    * ONE_DOC_PER_FILE - Each file is considered a separate document. Use
	//    this option when you are processing large documents, such as newspaper
	//    articles or scientific papers.
	//
	//    * ONE_DOC_PER_LINE - Each line in a file is considered a separate document.
	//    Use this option when you are processing many short documents, such as
	//    text messages.
	InputFormat *string `type:"string" enum:"InputFormat"`

	// The Amazon S3 URI for the input data. The URI must be in same Region as the
	// API endpoint that you are calling. The URI can point to a single input file
	// or it can provide the prefix for a collection of data files.
	//
	// For example, if you use the URI S3://bucketName/prefix, if the prefix is
	// a single file, Amazon Comprehend uses that file as input. If more than one
	// file begins with the prefix, Amazon Comprehend uses all of them as input.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

func (InputDataConfig) GoString 

func (s InputDataConfig) 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 (*InputDataConfig) SetDocumentReaderConfig 

func (s *InputDataConfig) SetDocumentReaderConfig(v *DocumentReaderConfig) *InputDataConfig

SetDocumentReaderConfig sets the DocumentReaderConfig field's value.

func (*InputDataConfig) SetInputFormat 

func (s *InputDataConfig) SetInputFormat(v string) *InputDataConfig

SetInputFormat sets the InputFormat field's value.

func (*InputDataConfig) SetS3Uri 

func (s *InputDataConfig) SetS3Uri(v string) *InputDataConfig

SetS3Uri sets the S3Uri field's value.

func (InputDataConfig) String 

func (s InputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDataConfig) Validate 

func (s *InputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 InvalidFilterException 

type InvalidFilterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The filter specified for the operation is invalid. Specify a different filter.

func (*InvalidFilterException) Code 

func (s *InvalidFilterException) Code() string

Code returns the exception type name.

func (*InvalidFilterException) Error 

func (s *InvalidFilterException) Error() string

func (InvalidFilterException) GoString 

func (s InvalidFilterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidFilterException) Message 

func (s *InvalidFilterException) Message() string

Message returns the exception's message.

func (*InvalidFilterException) OrigErr 

func (s *InvalidFilterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidFilterException) RequestID 

func (s *InvalidFilterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidFilterException) StatusCode 

func (s *InvalidFilterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidFilterException) String 

func (s InvalidFilterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 InvalidRequestDetail added in v1.42.9 

type InvalidRequestDetail struct {

	// Reason code is INVALID_DOCUMENT.
	Reason *string `type:"string" enum:"InvalidRequestDetailReason"`
	// contains filtered or unexported fields
}

Provides additional detail about why the request failed:

  • Document size is too large - Check the size of your file and resubmit the request.

  • Document type is not supported - Check the file type and resubmit the request.

  • Too many pages in the document - Check the number of pages in your file and resubmit the request.

  • Access denied to Amazon Textract - Verify that your account has permission to use Amazon Textract API operations and resubmit the request.

func (InvalidRequestDetail) GoString added in v1.42.9 

func (s InvalidRequestDetail) 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 (*InvalidRequestDetail) SetReason added in v1.42.9 

func (s *InvalidRequestDetail) SetReason(v string) *InvalidRequestDetail

SetReason sets the Reason field's value.

func (InvalidRequestDetail) String added in v1.42.9 

func (s InvalidRequestDetail) 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 InvalidRequestException 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Provides additional detail about why the request failed:
	//
	//    * Document size is too large - Check the size of your file and resubmit
	//    the request.
	//
	//    * Document type is not supported - Check the file type and resubmit the
	//    request.
	//
	//    * Too many pages in the document - Check the number of pages in your file
	//    and resubmit the request.
	//
	//    * Access denied to Amazon Textract - Verify that your account has permission
	//    to use Amazon Textract API operations and resubmit the request.
	Detail *InvalidRequestDetail `type:"structure"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`

	Reason *string `type:"string" enum:"InvalidRequestReason"`
	// contains filtered or unexported fields
}

The request is invalid.

func (*InvalidRequestException) Code 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 JobNotFoundException 

type JobNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified job was not found. Check the job ID and try again.

func (*JobNotFoundException) Code 

func (s *JobNotFoundException) Code() string

Code returns the exception type name.

func (*JobNotFoundException) Error 

func (s *JobNotFoundException) Error() string

func (JobNotFoundException) GoString 

func (s JobNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobNotFoundException) Message 

func (s *JobNotFoundException) Message() string

Message returns the exception's message.

func (*JobNotFoundException) OrigErr 

func (s *JobNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*JobNotFoundException) RequestID 

func (s *JobNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*JobNotFoundException) StatusCode 

func (s *JobNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (JobNotFoundException) String 

func (s JobNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 KeyPhrase 

type KeyPhrase struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the key phrase.
	BeginOffset *int64 `type:"integer"`

	// The zero-based offset from the beginning of the source text to the last character
	// in the key phrase.
	EndOffset *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`

	// The text of a key noun phrase.
	Text *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a key noun phrase.

func (KeyPhrase) GoString 

func (s KeyPhrase) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KeyPhrase) SetBeginOffset 

func (s *KeyPhrase) SetBeginOffset(v int64) *KeyPhrase

SetBeginOffset sets the BeginOffset field's value.

func (*KeyPhrase) SetEndOffset 

func (s *KeyPhrase) SetEndOffset(v int64) *KeyPhrase

SetEndOffset sets the EndOffset field's value.

func (*KeyPhrase) SetScore 

func (s *KeyPhrase) SetScore(v float64) *KeyPhrase

SetScore sets the Score field's value.

func (*KeyPhrase) SetText 

func (s *KeyPhrase) SetText(v string) *KeyPhrase

SetText sets the Text field's value.

func (KeyPhrase) String 

func (s KeyPhrase) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 KeyPhrasesDetectionJobFilter 

type KeyPhrasesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (KeyPhrasesDetectionJobFilter) GoString 

func (s KeyPhrasesDetectionJobFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KeyPhrasesDetectionJobFilter) SetJobName 

func (s *KeyPhrasesDetectionJobFilter) SetJobName(v string) *KeyPhrasesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobFilter) SetJobStatus 

func (s *KeyPhrasesDetectionJobFilter) SetJobStatus(v string) *KeyPhrasesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeAfter 

func (s *KeyPhrasesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *KeyPhrasesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*KeyPhrasesDetectionJobFilter) SetSubmitTimeBefore 

func (s *KeyPhrasesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *KeyPhrasesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (KeyPhrasesDetectionJobFilter) String 

func (s KeyPhrasesDetectionJobFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KeyPhrasesDetectionJobFilter) Validate 

func (s *KeyPhrasesDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KeyPhrasesDetectionJobProperties 

type KeyPhrasesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the key phrases detection job completed.
	EndTime *time.Time `type:"timestamp"`

	// The input data configuration that you supplied when you created the key phrases
	// detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the key phrases detection job. It is a
	// unique, fully qualified identifier for the job. It includes the Amazon Web
	// Services account, Amazon Web Services Region, and the job ID. The format
	// of the ARN is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier assigned to the key phrases detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned the key phrases detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the key phrases detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The language code of the input documents.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// A description of the status of a job.
	Message *string `type:"string"`

	// The output data configuration that you supplied when you created the key
	// phrases detection job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the key phrases detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage
	// volume attached to the ML compute instance(s) that process the analysis job.
	// The VolumeKmsKeyId can be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your key phrases detection job. For more
	// information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a key phrases detection job.

func (KeyPhrasesDetectionJobProperties) GoString 

func (s KeyPhrasesDetectionJobProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KeyPhrasesDetectionJobProperties) SetDataAccessRoleArn 

func (s *KeyPhrasesDetectionJobProperties) SetDataAccessRoleArn(v string) *KeyPhrasesDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*KeyPhrasesDetectionJobProperties) SetEndTime 

func (s *KeyPhrasesDetectionJobProperties) SetEndTime(v time.Time) *KeyPhrasesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*KeyPhrasesDetectionJobProperties) SetInputDataConfig 

func (s *KeyPhrasesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *KeyPhrasesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobArn 

func (s *KeyPhrasesDetectionJobProperties) SetJobArn(v string) *KeyPhrasesDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobId 

func (s *KeyPhrasesDetectionJobProperties) SetJobId(v string) *KeyPhrasesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobName 

func (s *KeyPhrasesDetectionJobProperties) SetJobName(v string) *KeyPhrasesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*KeyPhrasesDetectionJobProperties) SetJobStatus 

func (s *KeyPhrasesDetectionJobProperties) SetJobStatus(v string) *KeyPhrasesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*KeyPhrasesDetectionJobProperties) SetLanguageCode 

func (s *KeyPhrasesDetectionJobProperties) SetLanguageCode(v string) *KeyPhrasesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*KeyPhrasesDetectionJobProperties) SetMessage 

func (s *KeyPhrasesDetectionJobProperties) SetMessage(v string) *KeyPhrasesDetectionJobProperties

SetMessage sets the Message field's value.

func (*KeyPhrasesDetectionJobProperties) SetOutputDataConfig 

func (s *KeyPhrasesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *KeyPhrasesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*KeyPhrasesDetectionJobProperties) SetSubmitTime 

func (s *KeyPhrasesDetectionJobProperties) SetSubmitTime(v time.Time) *KeyPhrasesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*KeyPhrasesDetectionJobProperties) SetVolumeKmsKeyId 

func (s *KeyPhrasesDetectionJobProperties) SetVolumeKmsKeyId(v string) *KeyPhrasesDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*KeyPhrasesDetectionJobProperties) SetVpcConfig 

func (s *KeyPhrasesDetectionJobProperties) SetVpcConfig(v *VpcConfig) *KeyPhrasesDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (KeyPhrasesDetectionJobProperties) String 

func (s KeyPhrasesDetectionJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 KmsKeyValidationException 

type KmsKeyValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

func (*KmsKeyValidationException) Code 

func (s *KmsKeyValidationException) Code() string

Code returns the exception type name.

func (*KmsKeyValidationException) Error 

func (s *KmsKeyValidationException) Error() string

func (KmsKeyValidationException) GoString 

func (s KmsKeyValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KmsKeyValidationException) Message 

func (s *KmsKeyValidationException) Message() string

Message returns the exception's message.

func (*KmsKeyValidationException) OrigErr 

func (s *KmsKeyValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KmsKeyValidationException) RequestID 

func (s *KmsKeyValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KmsKeyValidationException) StatusCode 

func (s *KmsKeyValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KmsKeyValidationException) String 

func (s KmsKeyValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListDatasetsInput added in v1.42.9 

type ListDatasetsInput struct {

	// Filters the datasets to be returned in the response.
	Filter *DatasetFilter `type:"structure"`

	// The Amazon Resource Number (ARN) of the flywheel.
	FlywheelArn *string `type:"string"`

	// Maximum number of results to return in a response. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetsInput) GoString added in v1.42.9 

func (s ListDatasetsInput) 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 (*ListDatasetsInput) SetFilter added in v1.42.9 

func (s *ListDatasetsInput) SetFilter(v *DatasetFilter) *ListDatasetsInput

SetFilter sets the Filter field's value.

func (*ListDatasetsInput) SetFlywheelArn added in v1.42.9 

func (s *ListDatasetsInput) SetFlywheelArn(v string) *ListDatasetsInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*ListDatasetsInput) SetMaxResults added in v1.42.9 

func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetsInput) SetNextToken added in v1.42.9 

func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput

SetNextToken sets the NextToken field's value.

func (ListDatasetsInput) String added in v1.42.9 

func (s ListDatasetsInput) 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 (*ListDatasetsInput) Validate added in v1.42.9 

func (s *ListDatasetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetsOutput added in v1.42.9 

type ListDatasetsOutput struct {

	// The dataset properties list.
	DatasetPropertiesList []*DatasetProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetsOutput) GoString added in v1.42.9 

func (s ListDatasetsOutput) 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 (*ListDatasetsOutput) SetDatasetPropertiesList added in v1.42.9 

func (s *ListDatasetsOutput) SetDatasetPropertiesList(v []*DatasetProperties) *ListDatasetsOutput

SetDatasetPropertiesList sets the DatasetPropertiesList field's value.

func (*ListDatasetsOutput) SetNextToken added in v1.42.9 

func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput

SetNextToken sets the NextToken field's value.

func (ListDatasetsOutput) String added in v1.42.9 

func (s ListDatasetsOutput) 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 ListDocumentClassificationJobsInput 

type ListDocumentClassificationJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their names, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *DocumentClassificationJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentClassificationJobsInput) GoString 

func (s ListDocumentClassificationJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDocumentClassificationJobsInput) SetFilter 

func (s *ListDocumentClassificationJobsInput) SetFilter(v *DocumentClassificationJobFilter) *ListDocumentClassificationJobsInput

SetFilter sets the Filter field's value.

func (*ListDocumentClassificationJobsInput) SetMaxResults 

func (s *ListDocumentClassificationJobsInput) SetMaxResults(v int64) *ListDocumentClassificationJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentClassificationJobsInput) SetNextToken 

func (s *ListDocumentClassificationJobsInput) SetNextToken(v string) *ListDocumentClassificationJobsInput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassificationJobsInput) String 

func (s ListDocumentClassificationJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDocumentClassificationJobsInput) Validate 

func (s *ListDocumentClassificationJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDocumentClassificationJobsOutput 

type ListDocumentClassificationJobsOutput struct {

	// A list containing the properties of each job returned.
	DocumentClassificationJobPropertiesList []*DocumentClassificationJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentClassificationJobsOutput) GoString 

func (s ListDocumentClassificationJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDocumentClassificationJobsOutput) SetDocumentClassificationJobPropertiesList 

func (s *ListDocumentClassificationJobsOutput) SetDocumentClassificationJobPropertiesList(v []*DocumentClassificationJobProperties) *ListDocumentClassificationJobsOutput

SetDocumentClassificationJobPropertiesList sets the DocumentClassificationJobPropertiesList field's value.

func (*ListDocumentClassificationJobsOutput) SetNextToken 

func (s *ListDocumentClassificationJobsOutput) SetNextToken(v string) *ListDocumentClassificationJobsOutput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassificationJobsOutput) String 

func (s ListDocumentClassificationJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListDocumentClassifierSummariesInput 

type ListDocumentClassifierSummariesInput struct {

	// The maximum number of results to return on each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentClassifierSummariesInput) GoString 

func (s ListDocumentClassifierSummariesInput) 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 (*ListDocumentClassifierSummariesInput) SetMaxResults 

func (s *ListDocumentClassifierSummariesInput) SetMaxResults(v int64) *ListDocumentClassifierSummariesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentClassifierSummariesInput) SetNextToken 

func (s *ListDocumentClassifierSummariesInput) SetNextToken(v string) *ListDocumentClassifierSummariesInput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifierSummariesInput) String 

func (s ListDocumentClassifierSummariesInput) 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 (*ListDocumentClassifierSummariesInput) Validate 

func (s *ListDocumentClassifierSummariesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDocumentClassifierSummariesOutput 

type ListDocumentClassifierSummariesOutput struct {

	// The list of summaries of document classifiers.
	DocumentClassifierSummariesList []*DocumentClassifierSummary `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentClassifierSummariesOutput) GoString 

func (s ListDocumentClassifierSummariesOutput) 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 (*ListDocumentClassifierSummariesOutput) SetDocumentClassifierSummariesList 

func (s *ListDocumentClassifierSummariesOutput) SetDocumentClassifierSummariesList(v []*DocumentClassifierSummary) *ListDocumentClassifierSummariesOutput

SetDocumentClassifierSummariesList sets the DocumentClassifierSummariesList field's value.

func (*ListDocumentClassifierSummariesOutput) SetNextToken 

func (s *ListDocumentClassifierSummariesOutput) SetNextToken(v string) *ListDocumentClassifierSummariesOutput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifierSummariesOutput) String 

func (s ListDocumentClassifierSummariesOutput) 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 ListDocumentClassifiersInput 

type ListDocumentClassifiersInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *DocumentClassifierFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentClassifiersInput) GoString 

func (s ListDocumentClassifiersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDocumentClassifiersInput) SetFilter 

func (s *ListDocumentClassifiersInput) SetFilter(v *DocumentClassifierFilter) *ListDocumentClassifiersInput

SetFilter sets the Filter field's value.

func (*ListDocumentClassifiersInput) SetMaxResults 

func (s *ListDocumentClassifiersInput) SetMaxResults(v int64) *ListDocumentClassifiersInput

SetMaxResults sets the MaxResults field's value.

func (*ListDocumentClassifiersInput) SetNextToken 

func (s *ListDocumentClassifiersInput) SetNextToken(v string) *ListDocumentClassifiersInput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifiersInput) String 

func (s ListDocumentClassifiersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDocumentClassifiersInput) Validate 

func (s *ListDocumentClassifiersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDocumentClassifiersOutput 

type ListDocumentClassifiersOutput struct {

	// A list containing the properties of each job returned.
	DocumentClassifierPropertiesList []*DocumentClassifierProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDocumentClassifiersOutput) GoString 

func (s ListDocumentClassifiersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDocumentClassifiersOutput) SetDocumentClassifierPropertiesList 

func (s *ListDocumentClassifiersOutput) SetDocumentClassifierPropertiesList(v []*DocumentClassifierProperties) *ListDocumentClassifiersOutput

SetDocumentClassifierPropertiesList sets the DocumentClassifierPropertiesList field's value.

func (*ListDocumentClassifiersOutput) SetNextToken 

func (s *ListDocumentClassifiersOutput) SetNextToken(v string) *ListDocumentClassifiersOutput

SetNextToken sets the NextToken field's value.

func (ListDocumentClassifiersOutput) String 

func (s ListDocumentClassifiersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListDominantLanguageDetectionJobsInput 

type ListDominantLanguageDetectionJobsInput struct {

	// Filters that jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *DominantLanguageDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDominantLanguageDetectionJobsInput) GoString 

func (s ListDominantLanguageDetectionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDominantLanguageDetectionJobsInput) SetFilter 

func (s *ListDominantLanguageDetectionJobsInput) SetFilter(v *DominantLanguageDetectionJobFilter) *ListDominantLanguageDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListDominantLanguageDetectionJobsInput) SetMaxResults 

func (s *ListDominantLanguageDetectionJobsInput) SetMaxResults(v int64) *ListDominantLanguageDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDominantLanguageDetectionJobsInput) SetNextToken 

func (s *ListDominantLanguageDetectionJobsInput) SetNextToken(v string) *ListDominantLanguageDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsInput) String 

func (s ListDominantLanguageDetectionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDominantLanguageDetectionJobsInput) Validate 

func (s *ListDominantLanguageDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDominantLanguageDetectionJobsOutput 

type ListDominantLanguageDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	DominantLanguageDetectionJobPropertiesList []*DominantLanguageDetectionJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDominantLanguageDetectionJobsOutput) GoString 

func (s ListDominantLanguageDetectionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDominantLanguageDetectionJobsOutput) SetDominantLanguageDetectionJobPropertiesList 

func (s *ListDominantLanguageDetectionJobsOutput) SetDominantLanguageDetectionJobPropertiesList(v []*DominantLanguageDetectionJobProperties) *ListDominantLanguageDetectionJobsOutput

SetDominantLanguageDetectionJobPropertiesList sets the DominantLanguageDetectionJobPropertiesList field's value.

func (*ListDominantLanguageDetectionJobsOutput) SetNextToken 

func (s *ListDominantLanguageDetectionJobsOutput) SetNextToken(v string) *ListDominantLanguageDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListDominantLanguageDetectionJobsOutput) String 

func (s ListDominantLanguageDetectionJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListEndpointsInput 

type ListEndpointsInput struct {

	// Filters the endpoints that are returned. You can filter endpoints on their
	// name, model, status, or the date and time that they were created. You can
	// only set one filter at a time.
	Filter *EndpointFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEndpointsInput) GoString 

func (s ListEndpointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEndpointsInput) SetFilter 

func (s *ListEndpointsInput) SetFilter(v *EndpointFilter) *ListEndpointsInput

SetFilter sets the Filter field's value.

func (*ListEndpointsInput) SetMaxResults 

func (s *ListEndpointsInput) SetMaxResults(v int64) *ListEndpointsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEndpointsInput) SetNextToken 

func (s *ListEndpointsInput) SetNextToken(v string) *ListEndpointsInput

SetNextToken sets the NextToken field's value.

func (ListEndpointsInput) String 

func (s ListEndpointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEndpointsInput) Validate 

func (s *ListEndpointsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEndpointsOutput 

type ListEndpointsOutput struct {

	// Displays a list of endpoint properties being retrieved by the service in
	// response to the request.
	EndpointPropertiesList []*EndpointProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEndpointsOutput) GoString 

func (s ListEndpointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEndpointsOutput) SetEndpointPropertiesList 

func (s *ListEndpointsOutput) SetEndpointPropertiesList(v []*EndpointProperties) *ListEndpointsOutput

SetEndpointPropertiesList sets the EndpointPropertiesList field's value.

func (*ListEndpointsOutput) SetNextToken 

func (s *ListEndpointsOutput) SetNextToken(v string) *ListEndpointsOutput

SetNextToken sets the NextToken field's value.

func (ListEndpointsOutput) String 

func (s ListEndpointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListEntitiesDetectionJobsInput 

type ListEntitiesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *EntitiesDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionJobsInput) GoString 

func (s ListEntitiesDetectionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesDetectionJobsInput) SetFilter 

func (s *ListEntitiesDetectionJobsInput) SetFilter(v *EntitiesDetectionJobFilter) *ListEntitiesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListEntitiesDetectionJobsInput) SetMaxResults 

func (s *ListEntitiesDetectionJobsInput) SetMaxResults(v int64) *ListEntitiesDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesDetectionJobsInput) SetNextToken 

func (s *ListEntitiesDetectionJobsInput) SetNextToken(v string) *ListEntitiesDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsInput) String 

func (s ListEntitiesDetectionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesDetectionJobsInput) Validate 

func (s *ListEntitiesDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntitiesDetectionJobsOutput 

type ListEntitiesDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	EntitiesDetectionJobPropertiesList []*EntitiesDetectionJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionJobsOutput) GoString 

func (s ListEntitiesDetectionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesDetectionJobsOutput) SetEntitiesDetectionJobPropertiesList 

func (s *ListEntitiesDetectionJobsOutput) SetEntitiesDetectionJobPropertiesList(v []*EntitiesDetectionJobProperties) *ListEntitiesDetectionJobsOutput

SetEntitiesDetectionJobPropertiesList sets the EntitiesDetectionJobPropertiesList field's value.

func (*ListEntitiesDetectionJobsOutput) SetNextToken 

func (s *ListEntitiesDetectionJobsOutput) SetNextToken(v string) *ListEntitiesDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionJobsOutput) String 

func (s ListEntitiesDetectionJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListEntityRecognizerSummariesInput 

type ListEntityRecognizerSummariesInput struct {

	// The maximum number of results to return on each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntityRecognizerSummariesInput) GoString 

func (s ListEntityRecognizerSummariesInput) 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 (*ListEntityRecognizerSummariesInput) SetMaxResults 

func (s *ListEntityRecognizerSummariesInput) SetMaxResults(v int64) *ListEntityRecognizerSummariesInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntityRecognizerSummariesInput) SetNextToken 

func (s *ListEntityRecognizerSummariesInput) SetNextToken(v string) *ListEntityRecognizerSummariesInput

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizerSummariesInput) String 

func (s ListEntityRecognizerSummariesInput) 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 (*ListEntityRecognizerSummariesInput) Validate 

func (s *ListEntityRecognizerSummariesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntityRecognizerSummariesOutput 

type ListEntityRecognizerSummariesOutput struct {

	// The list entity recognizer summaries.
	EntityRecognizerSummariesList []*EntityRecognizerSummary `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntityRecognizerSummariesOutput) GoString 

func (s ListEntityRecognizerSummariesOutput) 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 (*ListEntityRecognizerSummariesOutput) SetEntityRecognizerSummariesList 

func (s *ListEntityRecognizerSummariesOutput) SetEntityRecognizerSummariesList(v []*EntityRecognizerSummary) *ListEntityRecognizerSummariesOutput

SetEntityRecognizerSummariesList sets the EntityRecognizerSummariesList field's value.

func (*ListEntityRecognizerSummariesOutput) SetNextToken 

func (s *ListEntityRecognizerSummariesOutput) SetNextToken(v string) *ListEntityRecognizerSummariesOutput

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizerSummariesOutput) String 

func (s ListEntityRecognizerSummariesOutput) 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 ListEntityRecognizersInput 

type ListEntityRecognizersInput struct {

	// Filters the list of entities returned. You can filter on Status, SubmitTimeBefore,
	// or SubmitTimeAfter. You can only set one filter at a time.
	Filter *EntityRecognizerFilter `type:"structure"`

	// The maximum number of results to return on each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntityRecognizersInput) GoString 

func (s ListEntityRecognizersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntityRecognizersInput) SetFilter 

func (s *ListEntityRecognizersInput) SetFilter(v *EntityRecognizerFilter) *ListEntityRecognizersInput

SetFilter sets the Filter field's value.

func (*ListEntityRecognizersInput) SetMaxResults 

func (s *ListEntityRecognizersInput) SetMaxResults(v int64) *ListEntityRecognizersInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntityRecognizersInput) SetNextToken 

func (s *ListEntityRecognizersInput) SetNextToken(v string) *ListEntityRecognizersInput

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizersInput) String 

func (s ListEntityRecognizersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntityRecognizersInput) Validate 

func (s *ListEntityRecognizersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntityRecognizersOutput 

type ListEntityRecognizersOutput struct {

	// The list of properties of an entity recognizer.
	EntityRecognizerPropertiesList []*EntityRecognizerProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntityRecognizersOutput) GoString 

func (s ListEntityRecognizersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntityRecognizersOutput) SetEntityRecognizerPropertiesList 

func (s *ListEntityRecognizersOutput) SetEntityRecognizerPropertiesList(v []*EntityRecognizerProperties) *ListEntityRecognizersOutput

SetEntityRecognizerPropertiesList sets the EntityRecognizerPropertiesList field's value.

func (*ListEntityRecognizersOutput) SetNextToken 

func (s *ListEntityRecognizersOutput) SetNextToken(v string) *ListEntityRecognizersOutput

SetNextToken sets the NextToken field's value.

func (ListEntityRecognizersOutput) String 

func (s ListEntityRecognizersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListEventsDetectionJobsInput 

type ListEventsDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *EventsDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventsDetectionJobsInput) GoString 

func (s ListEventsDetectionJobsInput) 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 (*ListEventsDetectionJobsInput) SetFilter 

func (s *ListEventsDetectionJobsInput) SetFilter(v *EventsDetectionJobFilter) *ListEventsDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListEventsDetectionJobsInput) SetMaxResults 

func (s *ListEventsDetectionJobsInput) SetMaxResults(v int64) *ListEventsDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEventsDetectionJobsInput) SetNextToken 

func (s *ListEventsDetectionJobsInput) SetNextToken(v string) *ListEventsDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListEventsDetectionJobsInput) String 

func (s ListEventsDetectionJobsInput) 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 (*ListEventsDetectionJobsInput) Validate 

func (s *ListEventsDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEventsDetectionJobsOutput 

type ListEventsDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	EventsDetectionJobPropertiesList []*EventsDetectionJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventsDetectionJobsOutput) GoString 

func (s ListEventsDetectionJobsOutput) 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 (*ListEventsDetectionJobsOutput) SetEventsDetectionJobPropertiesList 

func (s *ListEventsDetectionJobsOutput) SetEventsDetectionJobPropertiesList(v []*EventsDetectionJobProperties) *ListEventsDetectionJobsOutput

SetEventsDetectionJobPropertiesList sets the EventsDetectionJobPropertiesList field's value.

func (*ListEventsDetectionJobsOutput) SetNextToken 

func (s *ListEventsDetectionJobsOutput) SetNextToken(v string) *ListEventsDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListEventsDetectionJobsOutput) String 

func (s ListEventsDetectionJobsOutput) 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 ListFlywheelIterationHistoryInput added in v1.42.9 

type ListFlywheelIterationHistoryInput struct {

	// Filter the flywheel iteration history based on creation time.
	Filter *FlywheelIterationFilter `type:"structure"`

	// The ARN of the flywheel.
	//
	// FlywheelArn is a required field
	FlywheelArn *string `type:"string" required:"true"`

	// Maximum number of iteration history results to return
	MaxResults *int64 `min:"1" type:"integer"`

	// Next token
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlywheelIterationHistoryInput) GoString added in v1.42.9 

func (s ListFlywheelIterationHistoryInput) 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 (*ListFlywheelIterationHistoryInput) SetFilter added in v1.42.9 

func (s *ListFlywheelIterationHistoryInput) SetFilter(v *FlywheelIterationFilter) *ListFlywheelIterationHistoryInput

SetFilter sets the Filter field's value.

func (*ListFlywheelIterationHistoryInput) SetFlywheelArn added in v1.42.9 

func (s *ListFlywheelIterationHistoryInput) SetFlywheelArn(v string) *ListFlywheelIterationHistoryInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*ListFlywheelIterationHistoryInput) SetMaxResults added in v1.42.9 

func (s *ListFlywheelIterationHistoryInput) SetMaxResults(v int64) *ListFlywheelIterationHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*ListFlywheelIterationHistoryInput) SetNextToken added in v1.42.9 

func (s *ListFlywheelIterationHistoryInput) SetNextToken(v string) *ListFlywheelIterationHistoryInput

SetNextToken sets the NextToken field's value.

func (ListFlywheelIterationHistoryInput) String added in v1.42.9 

func (s ListFlywheelIterationHistoryInput) 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 (*ListFlywheelIterationHistoryInput) Validate added in v1.42.9 

func (s *ListFlywheelIterationHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFlywheelIterationHistoryOutput added in v1.42.9 

type ListFlywheelIterationHistoryOutput struct {

	// List of flywheel iteration properties
	FlywheelIterationPropertiesList []*FlywheelIterationProperties `type:"list"`

	// Next token
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlywheelIterationHistoryOutput) GoString added in v1.42.9 

func (s ListFlywheelIterationHistoryOutput) 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 (*ListFlywheelIterationHistoryOutput) SetFlywheelIterationPropertiesList added in v1.42.9 

func (s *ListFlywheelIterationHistoryOutput) SetFlywheelIterationPropertiesList(v []*FlywheelIterationProperties) *ListFlywheelIterationHistoryOutput

SetFlywheelIterationPropertiesList sets the FlywheelIterationPropertiesList field's value.

func (*ListFlywheelIterationHistoryOutput) SetNextToken added in v1.42.9 

func (s *ListFlywheelIterationHistoryOutput) SetNextToken(v string) *ListFlywheelIterationHistoryOutput

SetNextToken sets the NextToken field's value.

func (ListFlywheelIterationHistoryOutput) String added in v1.42.9 

func (s ListFlywheelIterationHistoryOutput) 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 ListFlywheelsInput added in v1.42.9 

type ListFlywheelsInput struct {

	// Filters the flywheels that are returned. You can filter flywheels on their
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *FlywheelFilter `type:"structure"`

	// Maximum number of results to return in a response. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlywheelsInput) GoString added in v1.42.9 

func (s ListFlywheelsInput) 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 (*ListFlywheelsInput) SetFilter added in v1.42.9 

func (s *ListFlywheelsInput) SetFilter(v *FlywheelFilter) *ListFlywheelsInput

SetFilter sets the Filter field's value.

func (*ListFlywheelsInput) SetMaxResults added in v1.42.9 

func (s *ListFlywheelsInput) SetMaxResults(v int64) *ListFlywheelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFlywheelsInput) SetNextToken added in v1.42.9 

func (s *ListFlywheelsInput) SetNextToken(v string) *ListFlywheelsInput

SetNextToken sets the NextToken field's value.

func (ListFlywheelsInput) String added in v1.42.9 

func (s ListFlywheelsInput) 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 (*ListFlywheelsInput) Validate added in v1.42.9 

func (s *ListFlywheelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFlywheelsOutput added in v1.42.9 

type ListFlywheelsOutput struct {

	// A list of flywheel properties retrieved by the service in response to the
	// request.
	FlywheelSummaryList []*FlywheelSummary `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlywheelsOutput) GoString added in v1.42.9 

func (s ListFlywheelsOutput) 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 (*ListFlywheelsOutput) SetFlywheelSummaryList added in v1.42.9 

func (s *ListFlywheelsOutput) SetFlywheelSummaryList(v []*FlywheelSummary) *ListFlywheelsOutput

SetFlywheelSummaryList sets the FlywheelSummaryList field's value.

func (*ListFlywheelsOutput) SetNextToken added in v1.42.9 

func (s *ListFlywheelsOutput) SetNextToken(v string) *ListFlywheelsOutput

SetNextToken sets the NextToken field's value.

func (ListFlywheelsOutput) String added in v1.42.9 

func (s ListFlywheelsOutput) 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 ListKeyPhrasesDetectionJobsInput 

type ListKeyPhrasesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *KeyPhrasesDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeyPhrasesDetectionJobsInput) GoString 

func (s ListKeyPhrasesDetectionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeyPhrasesDetectionJobsInput) SetFilter 

func (s *ListKeyPhrasesDetectionJobsInput) SetFilter(v *KeyPhrasesDetectionJobFilter) *ListKeyPhrasesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetMaxResults 

func (s *ListKeyPhrasesDetectionJobsInput) SetMaxResults(v int64) *ListKeyPhrasesDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListKeyPhrasesDetectionJobsInput) SetNextToken 

func (s *ListKeyPhrasesDetectionJobsInput) SetNextToken(v string) *ListKeyPhrasesDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsInput) String 

func (s ListKeyPhrasesDetectionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeyPhrasesDetectionJobsInput) Validate 

func (s *ListKeyPhrasesDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKeyPhrasesDetectionJobsOutput 

type ListKeyPhrasesDetectionJobsOutput struct {

	// A list containing the properties of each job that is returned.
	KeyPhrasesDetectionJobPropertiesList []*KeyPhrasesDetectionJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeyPhrasesDetectionJobsOutput) GoString 

func (s ListKeyPhrasesDetectionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeyPhrasesDetectionJobsOutput) SetKeyPhrasesDetectionJobPropertiesList 

func (s *ListKeyPhrasesDetectionJobsOutput) SetKeyPhrasesDetectionJobPropertiesList(v []*KeyPhrasesDetectionJobProperties) *ListKeyPhrasesDetectionJobsOutput

SetKeyPhrasesDetectionJobPropertiesList sets the KeyPhrasesDetectionJobPropertiesList field's value.

func (*ListKeyPhrasesDetectionJobsOutput) SetNextToken 

func (s *ListKeyPhrasesDetectionJobsOutput) SetNextToken(v string) *ListKeyPhrasesDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListKeyPhrasesDetectionJobsOutput) String 

func (s ListKeyPhrasesDetectionJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListPiiEntitiesDetectionJobsInput 

type ListPiiEntitiesDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *PiiEntitiesDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPiiEntitiesDetectionJobsInput) GoString 

func (s ListPiiEntitiesDetectionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPiiEntitiesDetectionJobsInput) SetFilter 

func (s *ListPiiEntitiesDetectionJobsInput) SetFilter(v *PiiEntitiesDetectionJobFilter) *ListPiiEntitiesDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListPiiEntitiesDetectionJobsInput) SetMaxResults 

func (s *ListPiiEntitiesDetectionJobsInput) SetMaxResults(v int64) *ListPiiEntitiesDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPiiEntitiesDetectionJobsInput) SetNextToken 

func (s *ListPiiEntitiesDetectionJobsInput) SetNextToken(v string) *ListPiiEntitiesDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListPiiEntitiesDetectionJobsInput) String 

func (s ListPiiEntitiesDetectionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPiiEntitiesDetectionJobsInput) Validate 

func (s *ListPiiEntitiesDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPiiEntitiesDetectionJobsOutput 

type ListPiiEntitiesDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`

	// A list containing the properties of each job that is returned.
	PiiEntitiesDetectionJobPropertiesList []*PiiEntitiesDetectionJobProperties `type:"list"`
	// contains filtered or unexported fields
}

func (ListPiiEntitiesDetectionJobsOutput) GoString 

func (s ListPiiEntitiesDetectionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPiiEntitiesDetectionJobsOutput) SetNextToken 

func (s *ListPiiEntitiesDetectionJobsOutput) SetNextToken(v string) *ListPiiEntitiesDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListPiiEntitiesDetectionJobsOutput) SetPiiEntitiesDetectionJobPropertiesList 

func (s *ListPiiEntitiesDetectionJobsOutput) SetPiiEntitiesDetectionJobPropertiesList(v []*PiiEntitiesDetectionJobProperties) *ListPiiEntitiesDetectionJobsOutput

SetPiiEntitiesDetectionJobPropertiesList sets the PiiEntitiesDetectionJobPropertiesList field's value.

func (ListPiiEntitiesDetectionJobsOutput) String 

func (s ListPiiEntitiesDetectionJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListSentimentDetectionJobsInput 

type ListSentimentDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *SentimentDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListSentimentDetectionJobsInput) GoString 

func (s ListSentimentDetectionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSentimentDetectionJobsInput) SetFilter 

func (s *ListSentimentDetectionJobsInput) SetFilter(v *SentimentDetectionJobFilter) *ListSentimentDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListSentimentDetectionJobsInput) SetMaxResults 

func (s *ListSentimentDetectionJobsInput) SetMaxResults(v int64) *ListSentimentDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSentimentDetectionJobsInput) SetNextToken 

func (s *ListSentimentDetectionJobsInput) SetNextToken(v string) *ListSentimentDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListSentimentDetectionJobsInput) String 

func (s ListSentimentDetectionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSentimentDetectionJobsInput) Validate 

func (s *ListSentimentDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSentimentDetectionJobsOutput 

type ListSentimentDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`

	// A list containing the properties of each job that is returned.
	SentimentDetectionJobPropertiesList []*SentimentDetectionJobProperties `type:"list"`
	// contains filtered or unexported fields
}

func (ListSentimentDetectionJobsOutput) GoString 

func (s ListSentimentDetectionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSentimentDetectionJobsOutput) SetNextToken 

func (s *ListSentimentDetectionJobsOutput) SetNextToken(v string) *ListSentimentDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListSentimentDetectionJobsOutput) SetSentimentDetectionJobPropertiesList 

func (s *ListSentimentDetectionJobsOutput) SetSentimentDetectionJobPropertiesList(v []*SentimentDetectionJobProperties) *ListSentimentDetectionJobsOutput

SetSentimentDetectionJobPropertiesList sets the SentimentDetectionJobPropertiesList field's value.

func (ListSentimentDetectionJobsOutput) String 

func (s ListSentimentDetectionJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you
	// are querying.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you
	// are querying.
	ResourceArn *string `type:"string"`

	// Tags associated with the Amazon Comprehend resource being queried. A tag
	// is a key-value pair that adds as a metadata to a resource used by Amazon
	// Comprehend. For example, a tag with "Sales" as the key might be added to
	// a resource to indicate its use by the sales department.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetResourceArn 

func (s *ListTagsForResourceOutput) SetResourceArn(v string) *ListTagsForResourceOutput

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListTargetedSentimentDetectionJobsInput added in v1.42.9 

type ListTargetedSentimentDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs on their name, status,
	// or the date and time that they were submitted. You can only set one filter
	// at a time.
	Filter *TargetedSentimentDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTargetedSentimentDetectionJobsInput) GoString added in v1.42.9 

func (s ListTargetedSentimentDetectionJobsInput) 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 (*ListTargetedSentimentDetectionJobsInput) SetFilter added in v1.42.9 

func (s *ListTargetedSentimentDetectionJobsInput) SetFilter(v *TargetedSentimentDetectionJobFilter) *ListTargetedSentimentDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListTargetedSentimentDetectionJobsInput) SetMaxResults added in v1.42.9 

func (s *ListTargetedSentimentDetectionJobsInput) SetMaxResults(v int64) *ListTargetedSentimentDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTargetedSentimentDetectionJobsInput) SetNextToken added in v1.42.9 

func (s *ListTargetedSentimentDetectionJobsInput) SetNextToken(v string) *ListTargetedSentimentDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListTargetedSentimentDetectionJobsInput) String added in v1.42.9 

func (s ListTargetedSentimentDetectionJobsInput) 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 (*ListTargetedSentimentDetectionJobsInput) Validate added in v1.42.9 

func (s *ListTargetedSentimentDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTargetedSentimentDetectionJobsOutput added in v1.42.9 

type ListTargetedSentimentDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`

	// A list containing the properties of each job that is returned.
	TargetedSentimentDetectionJobPropertiesList []*TargetedSentimentDetectionJobProperties `type:"list"`
	// contains filtered or unexported fields
}

func (ListTargetedSentimentDetectionJobsOutput) GoString added in v1.42.9 

func (s ListTargetedSentimentDetectionJobsOutput) 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 (*ListTargetedSentimentDetectionJobsOutput) SetNextToken added in v1.42.9 

func (s *ListTargetedSentimentDetectionJobsOutput) SetNextToken(v string) *ListTargetedSentimentDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListTargetedSentimentDetectionJobsOutput) SetTargetedSentimentDetectionJobPropertiesList added in v1.42.9 

func (s *ListTargetedSentimentDetectionJobsOutput) SetTargetedSentimentDetectionJobPropertiesList(v []*TargetedSentimentDetectionJobProperties) *ListTargetedSentimentDetectionJobsOutput

SetTargetedSentimentDetectionJobPropertiesList sets the TargetedSentimentDetectionJobPropertiesList field's value.

func (ListTargetedSentimentDetectionJobsOutput) String added in v1.42.9 

func (s ListTargetedSentimentDetectionJobsOutput) 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 ListTopicsDetectionJobsInput 

type ListTopicsDetectionJobsInput struct {

	// Filters the jobs that are returned. Jobs can be filtered on their name, status,
	// or the date and time that they were submitted. You can set only one filter
	// at a time.
	Filter *TopicsDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTopicsDetectionJobsInput) GoString 

func (s ListTopicsDetectionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTopicsDetectionJobsInput) SetFilter 

func (s *ListTopicsDetectionJobsInput) SetFilter(v *TopicsDetectionJobFilter) *ListTopicsDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListTopicsDetectionJobsInput) SetMaxResults 

func (s *ListTopicsDetectionJobsInput) SetMaxResults(v int64) *ListTopicsDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTopicsDetectionJobsInput) SetNextToken 

func (s *ListTopicsDetectionJobsInput) SetNextToken(v string) *ListTopicsDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListTopicsDetectionJobsInput) String 

func (s ListTopicsDetectionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTopicsDetectionJobsInput) Validate 

func (s *ListTopicsDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTopicsDetectionJobsOutput 

type ListTopicsDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`

	// A list containing the properties of each job that is returned.
	TopicsDetectionJobPropertiesList []*TopicsDetectionJobProperties `type:"list"`
	// contains filtered or unexported fields
}

func (ListTopicsDetectionJobsOutput) GoString 

func (s ListTopicsDetectionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTopicsDetectionJobsOutput) SetNextToken 

func (s *ListTopicsDetectionJobsOutput) SetNextToken(v string) *ListTopicsDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList 

func (s *ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList(v []*TopicsDetectionJobProperties) *ListTopicsDetectionJobsOutput

SetTopicsDetectionJobPropertiesList sets the TopicsDetectionJobPropertiesList field's value.

func (ListTopicsDetectionJobsOutput) String 

func (s ListTopicsDetectionJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 MentionSentiment added in v1.42.9 

type MentionSentiment struct {

	// The sentiment of the mention.
	Sentiment *string `type:"string" enum:"SentimentType"`

	// Describes the level of confidence that Amazon Comprehend has in the accuracy
	// of its detection of sentiments.
	SentimentScore *SentimentScore `type:"structure"`
	// contains filtered or unexported fields
}

Contains the sentiment and sentiment score for one mention of an entity.

For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).

func (MentionSentiment) GoString added in v1.42.9 

func (s MentionSentiment) 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 (*MentionSentiment) SetSentiment added in v1.42.9 

func (s *MentionSentiment) SetSentiment(v string) *MentionSentiment

SetSentiment sets the Sentiment field's value.

func (*MentionSentiment) SetSentimentScore added in v1.42.9 

func (s *MentionSentiment) SetSentimentScore(v *SentimentScore) *MentionSentiment

SetSentimentScore sets the SentimentScore field's value.

func (MentionSentiment) String added in v1.42.9 

func (s MentionSentiment) 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 OutputDataConfig 

type OutputDataConfig struct {

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId
	// can be one of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * KMS Key Alias: "alias/ExampleAlias"
	//
	//    * ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	KmsKeyId *string `type:"string"`

	// When you use the OutputDataConfig object with asynchronous operations, you
	// specify the Amazon S3 location where you want to write the output data. The
	// URI must be in the same Region as the API endpoint that you are calling.
	// The location is used as the prefix for the actual location of the output
	// file.
	//
	// When the topic detection job is finished, the service creates an output file
	// in a directory specific to the job. The S3Uri field contains the location
	// of the output file, called output.tar.gz. It is a compressed archive that
	// contains the ouput of the operation.
	//
	// For a PII entity detection job, the output file is plain text, not a compressed
	// archive. The output file name is the same as the input file, with .out appended
	// at the end.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides configuration parameters for the output of inference jobs.

func (OutputDataConfig) GoString 

func (s OutputDataConfig) 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 (*OutputDataConfig) SetKmsKeyId 

func (s *OutputDataConfig) SetKmsKeyId(v string) *OutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*OutputDataConfig) SetS3Uri 

func (s *OutputDataConfig) SetS3Uri(v string) *OutputDataConfig

SetS3Uri sets the S3Uri field's value.

func (OutputDataConfig) String 

func (s OutputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputDataConfig) Validate 

func (s *OutputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PartOfSpeechTag 

type PartOfSpeechTag struct {

	// The confidence that Amazon Comprehend has that the part of speech was correctly
	// identified.
	Score *float64 `type:"float"`

	// Identifies the part of speech that the token represents.
	Tag *string `type:"string" enum:"PartOfSpeechTagType"`
	// contains filtered or unexported fields
}

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html) in the Comprehend Developer Guide.

func (PartOfSpeechTag) GoString 

func (s PartOfSpeechTag) 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 (*PartOfSpeechTag) SetScore 

func (s *PartOfSpeechTag) SetScore(v float64) *PartOfSpeechTag

SetScore sets the Score field's value.

func (*PartOfSpeechTag) SetTag 

func (s *PartOfSpeechTag) SetTag(v string) *PartOfSpeechTag

SetTag sets the Tag field's value.

func (PartOfSpeechTag) String 

func (s PartOfSpeechTag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 PiiEntitiesDetectionJobFilter 

type PiiEntitiesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of PII entity detection jobs.

func (PiiEntitiesDetectionJobFilter) GoString 

func (s PiiEntitiesDetectionJobFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PiiEntitiesDetectionJobFilter) SetJobName 

func (s *PiiEntitiesDetectionJobFilter) SetJobName(v string) *PiiEntitiesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*PiiEntitiesDetectionJobFilter) SetJobStatus 

func (s *PiiEntitiesDetectionJobFilter) SetJobStatus(v string) *PiiEntitiesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*PiiEntitiesDetectionJobFilter) SetSubmitTimeAfter 

func (s *PiiEntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *PiiEntitiesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*PiiEntitiesDetectionJobFilter) SetSubmitTimeBefore 

func (s *PiiEntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *PiiEntitiesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (PiiEntitiesDetectionJobFilter) String 

func (s PiiEntitiesDetectionJobFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PiiEntitiesDetectionJobFilter) Validate 

func (s *PiiEntitiesDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PiiEntitiesDetectionJobProperties 

type PiiEntitiesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the PII entities detection job completed.
	EndTime *time.Time `type:"timestamp"`

	// The input properties for a PII entities detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the PII entities detection job. It is a
	// unique, fully qualified identifier for the job. It includes the Amazon Web
	// Services account, Amazon Web Services Region, and the job ID. The format
	// of the ARN is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier assigned to the PII entities detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned the PII entities detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the PII entities detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The language code of the input documents
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// A description of the status of a job.
	Message *string `type:"string"`

	// Specifies whether the output provides the locations (offsets) of PII entities
	// or a file in which PII entities are redacted.
	Mode *string `type:"string" enum:"PiiEntitiesDetectionMode"`

	// The output data configuration that you supplied when you created the PII
	// entities detection job.
	OutputDataConfig *PiiOutputDataConfig `type:"structure"`

	// Provides configuration parameters for PII entity redaction.
	//
	// This parameter is required if you set the Mode parameter to ONLY_REDACTION.
	// In that case, you must provide a RedactionConfig definition that includes
	// the PiiEntityTypes parameter.
	RedactionConfig *RedactionConfig `type:"structure"`

	// The time that the PII entities detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information about a PII entities detection job.

func (PiiEntitiesDetectionJobProperties) GoString 

func (s PiiEntitiesDetectionJobProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PiiEntitiesDetectionJobProperties) SetDataAccessRoleArn 

func (s *PiiEntitiesDetectionJobProperties) SetDataAccessRoleArn(v string) *PiiEntitiesDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*PiiEntitiesDetectionJobProperties) SetEndTime 

func (s *PiiEntitiesDetectionJobProperties) SetEndTime(v time.Time) *PiiEntitiesDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*PiiEntitiesDetectionJobProperties) SetInputDataConfig 

func (s *PiiEntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *PiiEntitiesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*PiiEntitiesDetectionJobProperties) SetJobArn 

func (s *PiiEntitiesDetectionJobProperties) SetJobArn(v string) *PiiEntitiesDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*PiiEntitiesDetectionJobProperties) SetJobId 

func (s *PiiEntitiesDetectionJobProperties) SetJobId(v string) *PiiEntitiesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*PiiEntitiesDetectionJobProperties) SetJobName 

func (s *PiiEntitiesDetectionJobProperties) SetJobName(v string) *PiiEntitiesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*PiiEntitiesDetectionJobProperties) SetJobStatus 

func (s *PiiEntitiesDetectionJobProperties) SetJobStatus(v string) *PiiEntitiesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*PiiEntitiesDetectionJobProperties) SetLanguageCode 

func (s *PiiEntitiesDetectionJobProperties) SetLanguageCode(v string) *PiiEntitiesDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*PiiEntitiesDetectionJobProperties) SetMessage 

func (s *PiiEntitiesDetectionJobProperties) SetMessage(v string) *PiiEntitiesDetectionJobProperties

SetMessage sets the Message field's value.

func (*PiiEntitiesDetectionJobProperties) SetMode 

func (s *PiiEntitiesDetectionJobProperties) SetMode(v string) *PiiEntitiesDetectionJobProperties

SetMode sets the Mode field's value.

func (*PiiEntitiesDetectionJobProperties) SetOutputDataConfig 

func (s *PiiEntitiesDetectionJobProperties) SetOutputDataConfig(v *PiiOutputDataConfig) *PiiEntitiesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*PiiEntitiesDetectionJobProperties) SetRedactionConfig 

func (s *PiiEntitiesDetectionJobProperties) SetRedactionConfig(v *RedactionConfig) *PiiEntitiesDetectionJobProperties

SetRedactionConfig sets the RedactionConfig field's value.

func (*PiiEntitiesDetectionJobProperties) SetSubmitTime 

func (s *PiiEntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *PiiEntitiesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (PiiEntitiesDetectionJobProperties) String 

func (s PiiEntitiesDetectionJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 PiiEntity 

type PiiEntity struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the entity.
	BeginOffset *int64 `type:"integer"`

	// The zero-based offset from the beginning of the source text to the last character
	// in the entity.
	EndOffset *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`

	// The entity's type.
	Type *string `type:"string" enum:"PiiEntityType"`
	// contains filtered or unexported fields
}

Provides information about a PII entity.

func (PiiEntity) GoString 

func (s PiiEntity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PiiEntity) SetBeginOffset 

func (s *PiiEntity) SetBeginOffset(v int64) *PiiEntity

SetBeginOffset sets the BeginOffset field's value.

func (*PiiEntity) SetEndOffset 

func (s *PiiEntity) SetEndOffset(v int64) *PiiEntity

SetEndOffset sets the EndOffset field's value.

func (*PiiEntity) SetScore 

func (s *PiiEntity) SetScore(v float64) *PiiEntity

SetScore sets the Score field's value.

func (*PiiEntity) SetType 

func (s *PiiEntity) SetType(v string) *PiiEntity

SetType sets the Type field's value.

func (PiiEntity) String 

func (s PiiEntity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 PiiOutputDataConfig 

type PiiOutputDataConfig struct {

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt the output results from an analysis job.
	KmsKeyId *string `type:"string"`

	// When you use the PiiOutputDataConfig object with asynchronous operations,
	// you specify the Amazon S3 location where you want to write the output data.
	//
	// For a PII entity detection job, the output file is plain text, not a compressed
	// archive. The output file name is the same as the input file, with .out appended
	// at the end.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides configuration parameters for the output of PII entity detection jobs.

func (PiiOutputDataConfig) GoString 

func (s PiiOutputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PiiOutputDataConfig) SetKmsKeyId 

func (s *PiiOutputDataConfig) SetKmsKeyId(v string) *PiiOutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*PiiOutputDataConfig) SetS3Uri 

func (s *PiiOutputDataConfig) SetS3Uri(v string) *PiiOutputDataConfig

SetS3Uri sets the S3Uri field's value.

func (PiiOutputDataConfig) String 

func (s PiiOutputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 Point added in v1.42.9 

type Point struct {

	// The value of the X coordinate for a point on a polygon
	X *float64 `type:"float"`

	// The value of the Y coordinate for a point on a polygon
	Y *float64 `type:"float"`
	// contains filtered or unexported fields
}

The X and Y coordinates of a point on a document page.

For additional information, see Point (https://docs.aws.amazon.com/textract/latest/dg/API_Point.html) in the Amazon Textract API reference.

func (Point) GoString added in v1.42.9 

func (s Point) 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 (*Point) SetX added in v1.42.9 

func (s *Point) SetX(v float64) *Point

SetX sets the X field's value.

func (*Point) SetY added in v1.42.9 

func (s *Point) SetY(v float64) *Point

SetY sets the Y field's value.

func (Point) String added in v1.42.9 

func (s Point) 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 PutResourcePolicyInput added in v1.42.9 

type PutResourcePolicyInput struct {

	// The revision ID that Amazon Comprehend assigned to the policy that you are
	// updating. If you are creating a new policy that has no prior version, don't
	// use this parameter. Amazon Comprehend creates the revision ID for you.
	PolicyRevisionId *string `type:"string"`

	// The Amazon Resource Name (ARN) of the custom model to attach the policy to.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The JSON resource-based policy to attach to 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"]}'
	//
	// ResourcePolicy is a required field
	ResourcePolicy *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutResourcePolicyInput) GoString added in v1.42.9 

func (s PutResourcePolicyInput) 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 (*PutResourcePolicyInput) SetPolicyRevisionId added in v1.42.9 

func (s *PutResourcePolicyInput) SetPolicyRevisionId(v string) *PutResourcePolicyInput

SetPolicyRevisionId sets the PolicyRevisionId field's value.

func (*PutResourcePolicyInput) SetResourceArn added in v1.42.9 

func (s *PutResourcePolicyInput) SetResourceArn(v string) *PutResourcePolicyInput

SetResourceArn sets the ResourceArn field's value.

func (*PutResourcePolicyInput) SetResourcePolicy added in v1.42.9 

func (s *PutResourcePolicyInput) SetResourcePolicy(v string) *PutResourcePolicyInput

SetResourcePolicy sets the ResourcePolicy field's value.

func (PutResourcePolicyInput) String added in v1.42.9 

func (s PutResourcePolicyInput) 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 (*PutResourcePolicyInput) Validate added in v1.42.9 

func (s *PutResourcePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutResourcePolicyOutput added in v1.42.9 

type PutResourcePolicyOutput struct {

	// 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"`
	// contains filtered or unexported fields
}

func (PutResourcePolicyOutput) GoString added in v1.42.9 

func (s PutResourcePolicyOutput) 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 (*PutResourcePolicyOutput) SetPolicyRevisionId added in v1.42.9 

func (s *PutResourcePolicyOutput) SetPolicyRevisionId(v string) *PutResourcePolicyOutput

SetPolicyRevisionId sets the PolicyRevisionId field's value.

func (PutResourcePolicyOutput) String added in v1.42.9 

func (s PutResourcePolicyOutput) 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 RedactionConfig 

type RedactionConfig struct {

	// A character that replaces each character in the redacted PII entity.
	MaskCharacter *string `min:"1" type:"string"`

	// Specifies whether the PII entity is redacted with the mask character or the
	// entity type.
	MaskMode *string `type:"string" enum:"PiiEntitiesDetectionMaskMode"`

	// An array of the types of PII entities that Amazon Comprehend detects in the
	// input text for your request.
	PiiEntityTypes []*string `type:"list" enum:"PiiEntityType"`
	// contains filtered or unexported fields
}

Provides configuration parameters for PII entity redaction.

func (RedactionConfig) GoString 

func (s RedactionConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedactionConfig) SetMaskCharacter 

func (s *RedactionConfig) SetMaskCharacter(v string) *RedactionConfig

SetMaskCharacter sets the MaskCharacter field's value.

func (*RedactionConfig) SetMaskMode 

func (s *RedactionConfig) SetMaskMode(v string) *RedactionConfig

SetMaskMode sets the MaskMode field's value.

func (*RedactionConfig) SetPiiEntityTypes 

func (s *RedactionConfig) SetPiiEntityTypes(v []*string) *RedactionConfig

SetPiiEntityTypes sets the PiiEntityTypes field's value.

func (RedactionConfig) String 

func (s RedactionConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedactionConfig) Validate 

func (s *RedactionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RelationshipsListItem added in v1.42.9 

type RelationshipsListItem struct {

	// Identifers of the child blocks.
	Ids []*string `type:"list"`

	// Only supported relationship is a child relationship.
	Type *string `type:"string" enum:"RelationshipType"`
	// contains filtered or unexported fields
}

List of child blocks for the current block.

func (RelationshipsListItem) GoString added in v1.42.9 

func (s RelationshipsListItem) 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 (*RelationshipsListItem) SetIds added in v1.42.9 

func (s *RelationshipsListItem) SetIds(v []*string) *RelationshipsListItem

SetIds sets the Ids field's value.

func (*RelationshipsListItem) SetType added in v1.42.9 

func (s *RelationshipsListItem) SetType(v string) *RelationshipsListItem

SetType sets the Type field's value.

func (RelationshipsListItem) String added in v1.42.9 

func (s RelationshipsListItem) 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 ResourceInUseException 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified resource name is already in use. Use a different name and try your request again.

func (*ResourceInUseException) Code 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ResourceLimitExceededException 

type ResourceLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

func (*ResourceLimitExceededException) Code 

func (s *ResourceLimitExceededException) Code() string

Code returns the exception type name.

func (*ResourceLimitExceededException) Error 

func (s *ResourceLimitExceededException) Error() string

func (ResourceLimitExceededException) GoString 

func (s ResourceLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceLimitExceededException) Message 

func (s *ResourceLimitExceededException) Message() string

Message returns the exception's message.

func (*ResourceLimitExceededException) OrigErr 

func (s *ResourceLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceededException) RequestID 

func (s *ResourceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceededException) StatusCode 

func (s *ResourceLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitExceededException) String 

func (s ResourceLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified resource ARN was not found. Check the ARN and try your request again.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ResourceUnavailableException 

type ResourceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is not available. Check the resource and try your request again.

func (*ResourceUnavailableException) Code 

func (s *ResourceUnavailableException) Code() string

Code returns the exception type name.

func (*ResourceUnavailableException) Error 

func (s *ResourceUnavailableException) Error() string

func (ResourceUnavailableException) GoString 

func (s ResourceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceUnavailableException) Message 

func (s *ResourceUnavailableException) Message() string

Message returns the exception's message.

func (*ResourceUnavailableException) OrigErr 

func (s *ResourceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceUnavailableException) RequestID 

func (s *ResourceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceUnavailableException) StatusCode 

func (s *ResourceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceUnavailableException) String 

func (s ResourceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 SentimentDetectionJobFilter 

type SentimentDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

func (SentimentDetectionJobFilter) GoString 

func (s SentimentDetectionJobFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SentimentDetectionJobFilter) SetJobName 

func (s *SentimentDetectionJobFilter) SetJobName(v string) *SentimentDetectionJobFilter

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobFilter) SetJobStatus 

func (s *SentimentDetectionJobFilter) SetJobStatus(v string) *SentimentDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeAfter 

func (s *SentimentDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *SentimentDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*SentimentDetectionJobFilter) SetSubmitTimeBefore 

func (s *SentimentDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *SentimentDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (SentimentDetectionJobFilter) String 

func (s SentimentDetectionJobFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SentimentDetectionJobFilter) Validate 

func (s *SentimentDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SentimentDetectionJobProperties 

type SentimentDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the sentiment detection job ended.
	EndTime *time.Time `type:"timestamp"`

	// The input data configuration that you supplied when you created the sentiment
	// detection job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier assigned to the sentiment detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned to the sentiment detection job
	JobName *string `min:"1" type:"string"`

	// The current status of the sentiment detection job. If the status is FAILED,
	// the Messages field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The language code of the input documents.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// A description of the status of a job.
	Message *string `type:"string"`

	// The output data configuration that you supplied when you created the sentiment
	// detection job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the sentiment detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your sentiment detection job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a sentiment detection job.

func (SentimentDetectionJobProperties) GoString 

func (s SentimentDetectionJobProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SentimentDetectionJobProperties) SetDataAccessRoleArn 

func (s *SentimentDetectionJobProperties) SetDataAccessRoleArn(v string) *SentimentDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*SentimentDetectionJobProperties) SetEndTime 

func (s *SentimentDetectionJobProperties) SetEndTime(v time.Time) *SentimentDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*SentimentDetectionJobProperties) SetInputDataConfig 

func (s *SentimentDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *SentimentDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetJobArn 

func (s *SentimentDetectionJobProperties) SetJobArn(v string) *SentimentDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*SentimentDetectionJobProperties) SetJobId 

func (s *SentimentDetectionJobProperties) SetJobId(v string) *SentimentDetectionJobProperties

SetJobId sets the JobId field's value.

func (*SentimentDetectionJobProperties) SetJobName 

func (s *SentimentDetectionJobProperties) SetJobName(v string) *SentimentDetectionJobProperties

SetJobName sets the JobName field's value.

func (*SentimentDetectionJobProperties) SetJobStatus 

func (s *SentimentDetectionJobProperties) SetJobStatus(v string) *SentimentDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*SentimentDetectionJobProperties) SetLanguageCode 

func (s *SentimentDetectionJobProperties) SetLanguageCode(v string) *SentimentDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*SentimentDetectionJobProperties) SetMessage 

func (s *SentimentDetectionJobProperties) SetMessage(v string) *SentimentDetectionJobProperties

SetMessage sets the Message field's value.

func (*SentimentDetectionJobProperties) SetOutputDataConfig 

func (s *SentimentDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *SentimentDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*SentimentDetectionJobProperties) SetSubmitTime 

func (s *SentimentDetectionJobProperties) SetSubmitTime(v time.Time) *SentimentDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*SentimentDetectionJobProperties) SetVolumeKmsKeyId 

func (s *SentimentDetectionJobProperties) SetVolumeKmsKeyId(v string) *SentimentDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*SentimentDetectionJobProperties) SetVpcConfig 

func (s *SentimentDetectionJobProperties) SetVpcConfig(v *VpcConfig) *SentimentDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (SentimentDetectionJobProperties) String 

func (s SentimentDetectionJobProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 SentimentScore 

type SentimentScore struct {

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the MIXED sentiment.
	Mixed *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEGATIVE sentiment.
	Negative *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEUTRAL sentiment.
	Neutral *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the POSITIVE sentiment.
	Positive *float64 `type:"float"`
	// contains filtered or unexported fields
}

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

func (SentimentScore) GoString 

func (s SentimentScore) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SentimentScore) SetMixed 

func (s *SentimentScore) SetMixed(v float64) *SentimentScore

SetMixed sets the Mixed field's value.

func (*SentimentScore) SetNegative 

func (s *SentimentScore) SetNegative(v float64) *SentimentScore

SetNegative sets the Negative field's value.

func (*SentimentScore) SetNeutral 

func (s *SentimentScore) SetNeutral(v float64) *SentimentScore

SetNeutral sets the Neutral field's value.

func (*SentimentScore) SetPositive 

func (s *SentimentScore) SetPositive(v float64) *SentimentScore

SetPositive sets the Positive field's value.

func (SentimentScore) String 

func (s SentimentScore) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 StartDocumentClassificationJobInput 

type StartDocumentClassificationJobInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the document classifier to use to process
	// the job.
	DocumentClassifierArn *string `type:"string"`

	// The Amazon Resource Number (ARN) of the flywheel associated with the model
	// to use.
	FlywheelArn *string `type:"string"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the document classification job. A tag is a key-value
	// pair that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your document classification job.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDocumentClassificationJobInput) GoString 

func (s StartDocumentClassificationJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentClassificationJobInput) SetClientRequestToken 

func (s *StartDocumentClassificationJobInput) SetClientRequestToken(v string) *StartDocumentClassificationJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDocumentClassificationJobInput) SetDataAccessRoleArn 

func (s *StartDocumentClassificationJobInput) SetDataAccessRoleArn(v string) *StartDocumentClassificationJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartDocumentClassificationJobInput) SetDocumentClassifierArn 

func (s *StartDocumentClassificationJobInput) SetDocumentClassifierArn(v string) *StartDocumentClassificationJobInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*StartDocumentClassificationJobInput) SetFlywheelArn added in v1.42.9 

func (s *StartDocumentClassificationJobInput) SetFlywheelArn(v string) *StartDocumentClassificationJobInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*StartDocumentClassificationJobInput) SetInputDataConfig 

func (s *StartDocumentClassificationJobInput) SetInputDataConfig(v *InputDataConfig) *StartDocumentClassificationJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartDocumentClassificationJobInput) SetJobName 

func (s *StartDocumentClassificationJobInput) SetJobName(v string) *StartDocumentClassificationJobInput

SetJobName sets the JobName field's value.

func (*StartDocumentClassificationJobInput) SetOutputDataConfig 

func (s *StartDocumentClassificationJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartDocumentClassificationJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartDocumentClassificationJobInput) SetTags 

func (s *StartDocumentClassificationJobInput) SetTags(v []*Tag) *StartDocumentClassificationJobInput

SetTags sets the Tags field's value.

func (*StartDocumentClassificationJobInput) SetVolumeKmsKeyId 

func (s *StartDocumentClassificationJobInput) SetVolumeKmsKeyId(v string) *StartDocumentClassificationJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartDocumentClassificationJobInput) SetVpcConfig 

func (s *StartDocumentClassificationJobInput) SetVpcConfig(v *VpcConfig) *StartDocumentClassificationJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartDocumentClassificationJobInput) String 

func (s StartDocumentClassificationJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentClassificationJobInput) Validate 

func (s *StartDocumentClassificationJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDocumentClassificationJobOutput 

type StartDocumentClassificationJobOutput struct {

	// The ARN of the custom classification model.
	DocumentClassifierArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the document classification job. It is
	// a unique, fully qualified identifier for the job. It includes the Amazon
	// Web Services account, Amazon Web Services 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 generated for the job. To get the status of the job, use this
	// identifier with the DescribeDocumentClassificationJob operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job:
	//
	//    * SUBMITTED - The job has been received and queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. For details, use the DescribeDocumentClassificationJob
	//    operation.
	//
	//    * STOP_REQUESTED - Amazon Comprehend has received a stop request for the
	//    job and is processing the request.
	//
	//    * STOPPED - The job was successfully stopped without completing.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartDocumentClassificationJobOutput) GoString 

func (s StartDocumentClassificationJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDocumentClassificationJobOutput) SetDocumentClassifierArn added in v1.42.9 

func (s *StartDocumentClassificationJobOutput) SetDocumentClassifierArn(v string) *StartDocumentClassificationJobOutput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*StartDocumentClassificationJobOutput) SetJobArn 

func (s *StartDocumentClassificationJobOutput) SetJobArn(v string) *StartDocumentClassificationJobOutput

SetJobArn sets the JobArn field's value.

func (*StartDocumentClassificationJobOutput) SetJobId 

func (s *StartDocumentClassificationJobOutput) SetJobId(v string) *StartDocumentClassificationJobOutput

SetJobId sets the JobId field's value.

func (*StartDocumentClassificationJobOutput) SetJobStatus 

func (s *StartDocumentClassificationJobOutput) SetJobStatus(v string) *StartDocumentClassificationJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartDocumentClassificationJobOutput) String 

func (s StartDocumentClassificationJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 StartDominantLanguageDetectionJobInput 

type StartDominantLanguageDetectionJobInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see Role-based permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// An identifier for the job.
	JobName *string `min:"1" type:"string"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the dominant language detection job. A tag is a key-value
	// pair that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your dominant language detection
	// job. For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDominantLanguageDetectionJobInput) GoString 

func (s StartDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDominantLanguageDetectionJobInput) SetClientRequestToken 

func (s *StartDominantLanguageDetectionJobInput) SetClientRequestToken(v string) *StartDominantLanguageDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartDominantLanguageDetectionJobInput) SetDataAccessRoleArn 

func (s *StartDominantLanguageDetectionJobInput) SetDataAccessRoleArn(v string) *StartDominantLanguageDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartDominantLanguageDetectionJobInput) SetInputDataConfig 

func (s *StartDominantLanguageDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartDominantLanguageDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartDominantLanguageDetectionJobInput) SetJobName 

func (s *StartDominantLanguageDetectionJobInput) SetJobName(v string) *StartDominantLanguageDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartDominantLanguageDetectionJobInput) SetOutputDataConfig 

func (s *StartDominantLanguageDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartDominantLanguageDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartDominantLanguageDetectionJobInput) SetTags 

func (s *StartDominantLanguageDetectionJobInput) SetTags(v []*Tag) *StartDominantLanguageDetectionJobInput

SetTags sets the Tags field's value.

func (*StartDominantLanguageDetectionJobInput) SetVolumeKmsKeyId 

func (s *StartDominantLanguageDetectionJobInput) SetVolumeKmsKeyId(v string) *StartDominantLanguageDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartDominantLanguageDetectionJobInput) SetVpcConfig 

func (s *StartDominantLanguageDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartDominantLanguageDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartDominantLanguageDetectionJobInput) String 

func (s StartDominantLanguageDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDominantLanguageDetectionJobInput) Validate 

func (s *StartDominantLanguageDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDominantLanguageDetectionJobOutput 

type StartDominantLanguageDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the dominant language detection job. It
	// is a unique, fully qualified identifier for the job. It includes the Amazon
	// Web Services account, Amazon Web Services 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 generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartDominantLanguageDetectionJobOutput) GoString 

func (s StartDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDominantLanguageDetectionJobOutput) SetJobArn 

func (s *StartDominantLanguageDetectionJobOutput) SetJobArn(v string) *StartDominantLanguageDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartDominantLanguageDetectionJobOutput) SetJobId 

func (s *StartDominantLanguageDetectionJobOutput) SetJobId(v string) *StartDominantLanguageDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartDominantLanguageDetectionJobOutput) SetJobStatus 

func (s *StartDominantLanguageDetectionJobOutput) SetJobStatus(v string) *StartDominantLanguageDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartDominantLanguageDetectionJobOutput) String 

func (s StartDominantLanguageDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 StartEntitiesDetectionJobInput 

type StartEntitiesDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see Role-based permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that identifies the specific entity recognizer
	// to be used by the StartEntitiesDetectionJob. This ARN is optional and is
	// only used for a custom entity recognition job.
	EntityRecognizerArn *string `type:"string"`

	// The Amazon Resource Number (ARN) of the flywheel associated with the model
	// to use.
	FlywheelArn *string `type:"string"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	// You can specify any of the languages supported by Amazon Comprehend. If custom
	// entities recognition is used, this parameter is ignored and the language
	// used for training the model is used instead.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the entities detection job. A tag is a key-value pair
	// that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your entity detection job. For
	// more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionJobInput) GoString 

func (s StartEntitiesDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEntitiesDetectionJobInput) SetClientRequestToken 

func (s *StartEntitiesDetectionJobInput) SetClientRequestToken(v string) *StartEntitiesDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEntitiesDetectionJobInput) SetDataAccessRoleArn 

func (s *StartEntitiesDetectionJobInput) SetDataAccessRoleArn(v string) *StartEntitiesDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEntitiesDetectionJobInput) SetEntityRecognizerArn 

func (s *StartEntitiesDetectionJobInput) SetEntityRecognizerArn(v string) *StartEntitiesDetectionJobInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*StartEntitiesDetectionJobInput) SetFlywheelArn added in v1.42.9 

func (s *StartEntitiesDetectionJobInput) SetFlywheelArn(v string) *StartEntitiesDetectionJobInput

SetFlywheelArn sets the FlywheelArn field's value.

func (*StartEntitiesDetectionJobInput) SetInputDataConfig 

func (s *StartEntitiesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartEntitiesDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEntitiesDetectionJobInput) SetJobName 

func (s *StartEntitiesDetectionJobInput) SetJobName(v string) *StartEntitiesDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartEntitiesDetectionJobInput) SetLanguageCode 

func (s *StartEntitiesDetectionJobInput) SetLanguageCode(v string) *StartEntitiesDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartEntitiesDetectionJobInput) SetOutputDataConfig 

func (s *StartEntitiesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartEntitiesDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartEntitiesDetectionJobInput) SetTags 

func (s *StartEntitiesDetectionJobInput) SetTags(v []*Tag) *StartEntitiesDetectionJobInput

SetTags sets the Tags field's value.

func (*StartEntitiesDetectionJobInput) SetVolumeKmsKeyId 

func (s *StartEntitiesDetectionJobInput) SetVolumeKmsKeyId(v string) *StartEntitiesDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartEntitiesDetectionJobInput) SetVpcConfig 

func (s *StartEntitiesDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartEntitiesDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartEntitiesDetectionJobInput) String 

func (s StartEntitiesDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEntitiesDetectionJobInput) Validate 

func (s *StartEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEntitiesDetectionJobOutput 

type StartEntitiesDetectionJobOutput struct {

	// The ARN of the custom entity recognition model.
	EntityRecognizerArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the entities detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services 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 generated for the job. To get the status of job, use this
	// identifier with the operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	//
	//    * STOP_REQUESTED - Amazon Comprehend has received a stop request for the
	//    job and is processing the request.
	//
	//    * STOPPED - The job was successfully stopped without completing.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionJobOutput) GoString 

func (s StartEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEntitiesDetectionJobOutput) SetEntityRecognizerArn added in v1.42.9 

func (s *StartEntitiesDetectionJobOutput) SetEntityRecognizerArn(v string) *StartEntitiesDetectionJobOutput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*StartEntitiesDetectionJobOutput) SetJobArn 

func (s *StartEntitiesDetectionJobOutput) SetJobArn(v string) *StartEntitiesDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartEntitiesDetectionJobOutput) SetJobId 

func (s *StartEntitiesDetectionJobOutput) SetJobId(v string) *StartEntitiesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartEntitiesDetectionJobOutput) SetJobStatus 

func (s *StartEntitiesDetectionJobOutput) SetJobStatus(v string) *StartEntitiesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartEntitiesDetectionJobOutput) String 

func (s StartEntitiesDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 StartEventsDetectionJobInput 

type StartEventsDetectionJobInput struct {

	// An unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the events detection job.
	JobName *string `min:"1" type:"string"`

	// The language code of the input documents.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the events detection job. A tag is a key-value pair
	// that adds 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 types of events to detect in the input documents.
	//
	// TargetEventTypes is a required field
	TargetEventTypes []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StartEventsDetectionJobInput) GoString 

func (s StartEventsDetectionJobInput) 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 (*StartEventsDetectionJobInput) SetClientRequestToken 

func (s *StartEventsDetectionJobInput) SetClientRequestToken(v string) *StartEventsDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEventsDetectionJobInput) SetDataAccessRoleArn 

func (s *StartEventsDetectionJobInput) SetDataAccessRoleArn(v string) *StartEventsDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEventsDetectionJobInput) SetInputDataConfig 

func (s *StartEventsDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartEventsDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEventsDetectionJobInput) SetJobName 

func (s *StartEventsDetectionJobInput) SetJobName(v string) *StartEventsDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartEventsDetectionJobInput) SetLanguageCode 

func (s *StartEventsDetectionJobInput) SetLanguageCode(v string) *StartEventsDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartEventsDetectionJobInput) SetOutputDataConfig 

func (s *StartEventsDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartEventsDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartEventsDetectionJobInput) SetTags 

func (s *StartEventsDetectionJobInput) SetTags(v []*Tag) *StartEventsDetectionJobInput

SetTags sets the Tags field's value.

func (*StartEventsDetectionJobInput) SetTargetEventTypes 

func (s *StartEventsDetectionJobInput) SetTargetEventTypes(v []*string) *StartEventsDetectionJobInput

SetTargetEventTypes sets the TargetEventTypes field's value.

func (StartEventsDetectionJobInput) String 

func (s StartEventsDetectionJobInput) 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 (*StartEventsDetectionJobInput) Validate 

func (s *StartEventsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartEventsDetectionJobOutput 

type StartEventsDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the events detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// An unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	JobId *string `min:"1" type:"string"`

	// The status of the events detection job.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartEventsDetectionJobOutput) GoString 

func (s StartEventsDetectionJobOutput) 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 (*StartEventsDetectionJobOutput) SetJobArn 

func (s *StartEventsDetectionJobOutput) SetJobArn(v string) *StartEventsDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartEventsDetectionJobOutput) SetJobId 

func (s *StartEventsDetectionJobOutput) SetJobId(v string) *StartEventsDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartEventsDetectionJobOutput) SetJobStatus 

func (s *StartEventsDetectionJobOutput) SetJobStatus(v string) *StartEventsDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartEventsDetectionJobOutput) String 

func (s StartEventsDetectionJobOutput) 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 StartFlywheelIterationInput added in v1.42.9 

type StartFlywheelIterationInput 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"`

	// The ARN of the flywheel.
	//
	// FlywheelArn is a required field
	FlywheelArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartFlywheelIterationInput) GoString added in v1.42.9 

func (s StartFlywheelIterationInput) 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 (*StartFlywheelIterationInput) SetClientRequestToken added in v1.42.9 

func (s *StartFlywheelIterationInput) SetClientRequestToken(v string) *StartFlywheelIterationInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartFlywheelIterationInput) SetFlywheelArn added in v1.42.9 

func (s *StartFlywheelIterationInput) SetFlywheelArn(v string) *StartFlywheelIterationInput

SetFlywheelArn sets the FlywheelArn field's value.

func (StartFlywheelIterationInput) String added in v1.42.9 

func (s StartFlywheelIterationInput) 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 (*StartFlywheelIterationInput) Validate added in v1.42.9 

func (s *StartFlywheelIterationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartFlywheelIterationOutput added in v1.42.9 

type StartFlywheelIterationOutput struct {
	FlywheelArn *string `type:"string"`

	FlywheelIterationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartFlywheelIterationOutput) GoString added in v1.42.9 

func (s StartFlywheelIterationOutput) 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 (*StartFlywheelIterationOutput) SetFlywheelArn added in v1.42.9 

func (s *StartFlywheelIterationOutput) SetFlywheelArn(v string) *StartFlywheelIterationOutput

SetFlywheelArn sets the FlywheelArn field's value.

func (*StartFlywheelIterationOutput) SetFlywheelIterationId added in v1.42.9 

func (s *StartFlywheelIterationOutput) SetFlywheelIterationId(v string) *StartFlywheelIterationOutput

SetFlywheelIterationId sets the FlywheelIterationId field's value.

func (StartFlywheelIterationOutput) String added in v1.42.9 

func (s StartFlywheelIterationOutput) 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 StartKeyPhrasesDetectionJobInput 

type StartKeyPhrasesDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see Role-based permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the key phrases detection job. A tag is a key-value
	// pair that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your key phrases detection job.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartKeyPhrasesDetectionJobInput) GoString 

func (s StartKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartKeyPhrasesDetectionJobInput) SetClientRequestToken 

func (s *StartKeyPhrasesDetectionJobInput) SetClientRequestToken(v string) *StartKeyPhrasesDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartKeyPhrasesDetectionJobInput) SetDataAccessRoleArn 

func (s *StartKeyPhrasesDetectionJobInput) SetDataAccessRoleArn(v string) *StartKeyPhrasesDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartKeyPhrasesDetectionJobInput) SetInputDataConfig 

func (s *StartKeyPhrasesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartKeyPhrasesDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartKeyPhrasesDetectionJobInput) SetJobName 

func (s *StartKeyPhrasesDetectionJobInput) SetJobName(v string) *StartKeyPhrasesDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartKeyPhrasesDetectionJobInput) SetLanguageCode 

func (s *StartKeyPhrasesDetectionJobInput) SetLanguageCode(v string) *StartKeyPhrasesDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartKeyPhrasesDetectionJobInput) SetOutputDataConfig 

func (s *StartKeyPhrasesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartKeyPhrasesDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartKeyPhrasesDetectionJobInput) SetTags 

func (s *StartKeyPhrasesDetectionJobInput) SetTags(v []*Tag) *StartKeyPhrasesDetectionJobInput

SetTags sets the Tags field's value.

func (*StartKeyPhrasesDetectionJobInput) SetVolumeKmsKeyId 

func (s *StartKeyPhrasesDetectionJobInput) SetVolumeKmsKeyId(v string) *StartKeyPhrasesDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartKeyPhrasesDetectionJobInput) SetVpcConfig 

func (s *StartKeyPhrasesDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartKeyPhrasesDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartKeyPhrasesDetectionJobInput) String 

func (s StartKeyPhrasesDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartKeyPhrasesDetectionJobInput) Validate 

func (s *StartKeyPhrasesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartKeyPhrasesDetectionJobOutput 

type StartKeyPhrasesDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartKeyPhrasesDetectionJobOutput) GoString 

func (s StartKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartKeyPhrasesDetectionJobOutput) SetJobArn 

func (s *StartKeyPhrasesDetectionJobOutput) SetJobArn(v string) *StartKeyPhrasesDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartKeyPhrasesDetectionJobOutput) SetJobId 

func (s *StartKeyPhrasesDetectionJobOutput) SetJobId(v string) *StartKeyPhrasesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartKeyPhrasesDetectionJobOutput) SetJobStatus 

func (s *StartKeyPhrasesDetectionJobOutput) SetJobStatus(v string) *StartKeyPhrasesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartKeyPhrasesDetectionJobOutput) String 

func (s StartKeyPhrasesDetectionJobOutput) String() 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 StartPiiEntitiesDetectionJobInput 

type StartPiiEntitiesDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The input properties for a PII entities detection job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. Currently, English is the only valid
	// language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies whether the output provides the locations (offsets) of PII entities
	// or a file in which PII entities are redacted.
	//
	// Mode is a required field
	Mode *string `type:"string" required:"true" enum:"PiiEntitiesDetectionMode"`

	// Provides configuration parameters for the output of PII entity detection
	// jobs.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Provides configuration parameters for PII entity redaction.
	//
	// This parameter is required if you set the Mode parameter to ONLY_REDACTION.
	// In that case, you must provide a RedactionConfig definition that includes
	// the PiiEntityTypes parameter.
	RedactionConfig *RedactionConfig `type:"structure"`

	// Tags to associate with the PII entities detection job. A tag is a key-value
	// pair that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (StartPiiEntitiesDetectionJobInput) GoString 

func (s StartPiiEntitiesDetectionJobInput) 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 (*StartPiiEntitiesDetectionJobInput) SetClientRequestToken 

func (s *StartPiiEntitiesDetectionJobInput) SetClientRequestToken(v string) *StartPiiEntitiesDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartPiiEntitiesDetectionJobInput) SetDataAccessRoleArn 

func (s *StartPiiEntitiesDetectionJobInput) SetDataAccessRoleArn(v string) *StartPiiEntitiesDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartPiiEntitiesDetectionJobInput) SetInputDataConfig 

func (s *StartPiiEntitiesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartPiiEntitiesDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartPiiEntitiesDetectionJobInput) SetJobName 

func (s *StartPiiEntitiesDetectionJobInput) SetJobName(v string) *StartPiiEntitiesDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartPiiEntitiesDetectionJobInput) SetLanguageCode 

func (s *StartPiiEntitiesDetectionJobInput) SetLanguageCode(v string) *StartPiiEntitiesDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartPiiEntitiesDetectionJobInput) SetMode 

func (s *StartPiiEntitiesDetectionJobInput) SetMode(v string) *StartPiiEntitiesDetectionJobInput

SetMode sets the Mode field's value.

func (*StartPiiEntitiesDetectionJobInput) SetOutputDataConfig 

func (s *StartPiiEntitiesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartPiiEntitiesDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartPiiEntitiesDetectionJobInput) SetRedactionConfig 

func (s *StartPiiEntitiesDetectionJobInput) SetRedactionConfig(v *RedactionConfig) *StartPiiEntitiesDetectionJobInput

SetRedactionConfig sets the RedactionConfig field's value.

func (*StartPiiEntitiesDetectionJobInput) SetTags 

func (s *StartPiiEntitiesDetectionJobInput) SetTags(v []*Tag) *StartPiiEntitiesDetectionJobInput

SetTags sets the Tags field's value.

func (StartPiiEntitiesDetectionJobInput) String 

func (s StartPiiEntitiesDetectionJobInput) 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 (*StartPiiEntitiesDetectionJobInput) Validate 

func (s *StartPiiEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartPiiEntitiesDetectionJobOutput 

type StartPiiEntitiesDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier generated for the job.
	JobId *string `min:"1" type:"string"`

	// The status of the job.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartPiiEntitiesDetectionJobOutput) GoString 

func (s StartPiiEntitiesDetectionJobOutput) 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 (*StartPiiEntitiesDetectionJobOutput) SetJobArn 

func (s *StartPiiEntitiesDetectionJobOutput) SetJobArn(v string) *StartPiiEntitiesDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartPiiEntitiesDetectionJobOutput) SetJobId 

func (s *StartPiiEntitiesDetectionJobOutput) SetJobId(v string) *StartPiiEntitiesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartPiiEntitiesDetectionJobOutput) SetJobStatus 

func (s *StartPiiEntitiesDetectionJobOutput) SetJobStatus(v string) *StartPiiEntitiesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartPiiEntitiesDetectionJobOutput) String 

func (s StartPiiEntitiesDetectionJobOutput) 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 StartSentimentDetectionJobInput 

type StartSentimentDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see Role-based permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. You can specify any of the primary languages
	// supported by Amazon Comprehend. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the sentiment detection job. A tag is a key-value
	// pair that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your sentiment detection job.
	// For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartSentimentDetectionJobInput) GoString 

func (s StartSentimentDetectionJobInput) 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 (*StartSentimentDetectionJobInput) SetClientRequestToken 

func (s *StartSentimentDetectionJobInput) SetClientRequestToken(v string) *StartSentimentDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartSentimentDetectionJobInput) SetDataAccessRoleArn 

func (s *StartSentimentDetectionJobInput) SetDataAccessRoleArn(v string) *StartSentimentDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartSentimentDetectionJobInput) SetInputDataConfig 

func (s *StartSentimentDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartSentimentDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartSentimentDetectionJobInput) SetJobName 

func (s *StartSentimentDetectionJobInput) SetJobName(v string) *StartSentimentDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartSentimentDetectionJobInput) SetLanguageCode 

func (s *StartSentimentDetectionJobInput) SetLanguageCode(v string) *StartSentimentDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartSentimentDetectionJobInput) SetOutputDataConfig 

func (s *StartSentimentDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartSentimentDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartSentimentDetectionJobInput) SetTags 

func (s *StartSentimentDetectionJobInput) SetTags(v []*Tag) *StartSentimentDetectionJobInput

SetTags sets the Tags field's value.

func (*StartSentimentDetectionJobInput) SetVolumeKmsKeyId 

func (s *StartSentimentDetectionJobInput) SetVolumeKmsKeyId(v string) *StartSentimentDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartSentimentDetectionJobInput) SetVpcConfig 

func (s *StartSentimentDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartSentimentDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartSentimentDetectionJobInput) String 

func (s StartSentimentDetectionJobInput) 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 (*StartSentimentDetectionJobInput) Validate 

func (s *StartSentimentDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSentimentDetectionJobOutput 

type StartSentimentDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartSentimentDetectionJobOutput) GoString 

func (s StartSentimentDetectionJobOutput) 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 (*StartSentimentDetectionJobOutput) SetJobArn 

func (s *StartSentimentDetectionJobOutput) SetJobArn(v string) *StartSentimentDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartSentimentDetectionJobOutput) SetJobId 

func (s *StartSentimentDetectionJobOutput) SetJobId(v string) *StartSentimentDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartSentimentDetectionJobOutput) SetJobStatus 

func (s *StartSentimentDetectionJobOutput) SetJobStatus(v string) *StartSentimentDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartSentimentDetectionJobOutput) String 

func (s StartSentimentDetectionJobOutput) 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 StartTargetedSentimentDetectionJobInput added in v1.42.9 

type StartTargetedSentimentDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see Role-based permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// The input properties for an inference job. The document reader config field
	// applies only to non-text inputs for custom analysis.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The language of the input documents. Currently, English is the only supported
	// language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the targeted sentiment detection job. A tag is a key-value
	// pair that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the 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 the job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartTargetedSentimentDetectionJobInput) GoString added in v1.42.9 

func (s StartTargetedSentimentDetectionJobInput) 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 (*StartTargetedSentimentDetectionJobInput) SetClientRequestToken added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetClientRequestToken(v string) *StartTargetedSentimentDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartTargetedSentimentDetectionJobInput) SetDataAccessRoleArn added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetDataAccessRoleArn(v string) *StartTargetedSentimentDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartTargetedSentimentDetectionJobInput) SetInputDataConfig added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartTargetedSentimentDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartTargetedSentimentDetectionJobInput) SetJobName added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetJobName(v string) *StartTargetedSentimentDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartTargetedSentimentDetectionJobInput) SetLanguageCode added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetLanguageCode(v string) *StartTargetedSentimentDetectionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartTargetedSentimentDetectionJobInput) SetOutputDataConfig added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartTargetedSentimentDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartTargetedSentimentDetectionJobInput) SetTags added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetTags(v []*Tag) *StartTargetedSentimentDetectionJobInput

SetTags sets the Tags field's value.

func (*StartTargetedSentimentDetectionJobInput) SetVolumeKmsKeyId added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetVolumeKmsKeyId(v string) *StartTargetedSentimentDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartTargetedSentimentDetectionJobInput) SetVpcConfig added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartTargetedSentimentDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartTargetedSentimentDetectionJobInput) String added in v1.42.9 

func (s StartTargetedSentimentDetectionJobInput) 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 (*StartTargetedSentimentDetectionJobInput) Validate added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartTargetedSentimentDetectionJobOutput added in v1.42.9 

type StartTargetedSentimentDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the targeted sentiment detection job. It
	// is a unique, fully qualified identifier for the job. It includes the Amazon
	// Web Services account, Amazon Web Services Region, and the job ID. The format
	// of the ARN is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the DescribeTargetedSentimentDetectionJob operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job.
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the DescribeTargetedSentimentDetectionJob
	//    operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartTargetedSentimentDetectionJobOutput) GoString added in v1.42.9 

func (s StartTargetedSentimentDetectionJobOutput) 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 (*StartTargetedSentimentDetectionJobOutput) SetJobArn added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobOutput) SetJobArn(v string) *StartTargetedSentimentDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartTargetedSentimentDetectionJobOutput) SetJobId added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobOutput) SetJobId(v string) *StartTargetedSentimentDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartTargetedSentimentDetectionJobOutput) SetJobStatus added in v1.42.9 

func (s *StartTargetedSentimentDetectionJobOutput) SetJobStatus(v string) *StartTargetedSentimentDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartTargetedSentimentDetectionJobOutput) String added in v1.42.9 

func (s StartTargetedSentimentDetectionJobOutput) 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 StartTopicsDetectionJobInput 

type StartTopicsDetectionJobInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data. For more information, see Role-based permissions
	// (https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions).
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The number of topics to detect.
	NumberOfTopics *int64 `min:"1" type:"integer"`

	// Specifies where to send the output files. The output is a compressed archive
	// with two files, topic-terms.csv that lists the terms associated with each
	// topic, and doc-topics.csv that lists the documents associated with each topic
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`

	// Tags to associate with the topics detection job. A tag is a key-value pair
	// that adds metadata to a resource used by Amazon Comprehend. For example,
	// a tag with "Sales" as the key might be added to a resource to indicate its
	// use by the sales department.
	Tags []*Tag `type:"list"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for your topic detection job. For
	// more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

func (StartTopicsDetectionJobInput) GoString 

func (s StartTopicsDetectionJobInput) 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 (*StartTopicsDetectionJobInput) SetClientRequestToken 

func (s *StartTopicsDetectionJobInput) SetClientRequestToken(v string) *StartTopicsDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartTopicsDetectionJobInput) SetDataAccessRoleArn 

func (s *StartTopicsDetectionJobInput) SetDataAccessRoleArn(v string) *StartTopicsDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartTopicsDetectionJobInput) SetInputDataConfig 

func (s *StartTopicsDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartTopicsDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartTopicsDetectionJobInput) SetJobName 

func (s *StartTopicsDetectionJobInput) SetJobName(v string) *StartTopicsDetectionJobInput

SetJobName sets the JobName field's value.

func (*StartTopicsDetectionJobInput) SetNumberOfTopics 

func (s *StartTopicsDetectionJobInput) SetNumberOfTopics(v int64) *StartTopicsDetectionJobInput

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*StartTopicsDetectionJobInput) SetOutputDataConfig 

func (s *StartTopicsDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartTopicsDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*StartTopicsDetectionJobInput) SetTags 

func (s *StartTopicsDetectionJobInput) SetTags(v []*Tag) *StartTopicsDetectionJobInput

SetTags sets the Tags field's value.

func (*StartTopicsDetectionJobInput) SetVolumeKmsKeyId 

func (s *StartTopicsDetectionJobInput) SetVolumeKmsKeyId(v string) *StartTopicsDetectionJobInput

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*StartTopicsDetectionJobInput) SetVpcConfig 

func (s *StartTopicsDetectionJobInput) SetVpcConfig(v *VpcConfig) *StartTopicsDetectionJobInput

SetVpcConfig sets the VpcConfig field's value.

func (StartTopicsDetectionJobInput) String 

func (s StartTopicsDetectionJobInput) 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 (*StartTopicsDetectionJobInput) Validate 

func (s *StartTopicsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartTopicsDetectionJobOutput 

type StartTopicsDetectionJobOutput struct {

	// The Amazon Resource Name (ARN) of the topics detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:topics-detection-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 generated for the job. To get the status of the job, use this
	// identifier with the DescribeTopicDetectionJob operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job:
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob
	//    operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StartTopicsDetectionJobOutput) GoString 

func (s StartTopicsDetectionJobOutput) 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 (*StartTopicsDetectionJobOutput) SetJobArn 

func (s *StartTopicsDetectionJobOutput) SetJobArn(v string) *StartTopicsDetectionJobOutput

SetJobArn sets the JobArn field's value.

func (*StartTopicsDetectionJobOutput) SetJobId 

func (s *StartTopicsDetectionJobOutput) SetJobId(v string) *StartTopicsDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StartTopicsDetectionJobOutput) SetJobStatus 

func (s *StartTopicsDetectionJobOutput) SetJobStatus(v string) *StartTopicsDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StartTopicsDetectionJobOutput) String 

func (s StartTopicsDetectionJobOutput) 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 StopDominantLanguageDetectionJobInput 

type StopDominantLanguageDetectionJobInput struct {

	// The identifier of the dominant language detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopDominantLanguageDetectionJobInput) GoString 

func (s StopDominantLanguageDetectionJobInput) 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 (*StopDominantLanguageDetectionJobInput) SetJobId 

func (s *StopDominantLanguageDetectionJobInput) SetJobId(v string) *StopDominantLanguageDetectionJobInput

SetJobId sets the JobId field's value.

func (StopDominantLanguageDetectionJobInput) String 

func (s StopDominantLanguageDetectionJobInput) 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 (*StopDominantLanguageDetectionJobInput) Validate 

func (s *StopDominantLanguageDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopDominantLanguageDetectionJobOutput 

type StopDominantLanguageDetectionJobOutput struct {

	// The identifier of the dominant language detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the
	// job was previously stopped with the StopDominantLanguageDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopDominantLanguageDetectionJobOutput) GoString 

func (s StopDominantLanguageDetectionJobOutput) 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 (*StopDominantLanguageDetectionJobOutput) SetJobId 

func (s *StopDominantLanguageDetectionJobOutput) SetJobId(v string) *StopDominantLanguageDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopDominantLanguageDetectionJobOutput) SetJobStatus 

func (s *StopDominantLanguageDetectionJobOutput) SetJobStatus(v string) *StopDominantLanguageDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopDominantLanguageDetectionJobOutput) String 

func (s StopDominantLanguageDetectionJobOutput) 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 StopEntitiesDetectionJobInput 

type StopEntitiesDetectionJobInput struct {

	// The identifier of the entities detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionJobInput) GoString 

func (s StopEntitiesDetectionJobInput) 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 (*StopEntitiesDetectionJobInput) SetJobId 

func (s *StopEntitiesDetectionJobInput) SetJobId(v string) *StopEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionJobInput) String 

func (s StopEntitiesDetectionJobInput) 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 (*StopEntitiesDetectionJobInput) Validate 

func (s *StopEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopEntitiesDetectionJobOutput 

type StopEntitiesDetectionJobOutput struct {

	// The identifier of the entities detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the
	// job was previously stopped with the StopEntitiesDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionJobOutput) GoString 

func (s StopEntitiesDetectionJobOutput) 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 (*StopEntitiesDetectionJobOutput) SetJobId 

func (s *StopEntitiesDetectionJobOutput) SetJobId(v string) *StopEntitiesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopEntitiesDetectionJobOutput) SetJobStatus 

func (s *StopEntitiesDetectionJobOutput) SetJobStatus(v string) *StopEntitiesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopEntitiesDetectionJobOutput) String 

func (s StopEntitiesDetectionJobOutput) 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 StopEventsDetectionJobInput 

type StopEventsDetectionJobInput struct {

	// The identifier of the events detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopEventsDetectionJobInput) GoString 

func (s StopEventsDetectionJobInput) 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 (*StopEventsDetectionJobInput) SetJobId 

func (s *StopEventsDetectionJobInput) SetJobId(v string) *StopEventsDetectionJobInput

SetJobId sets the JobId field's value.

func (StopEventsDetectionJobInput) String 

func (s StopEventsDetectionJobInput) 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 (*StopEventsDetectionJobInput) Validate 

func (s *StopEventsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopEventsDetectionJobOutput 

type StopEventsDetectionJobOutput struct {

	// The identifier of the events detection job to stop.
	JobId *string `min:"1" type:"string"`

	// The status of the events detection job.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopEventsDetectionJobOutput) GoString 

func (s StopEventsDetectionJobOutput) 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 (*StopEventsDetectionJobOutput) SetJobId 

func (s *StopEventsDetectionJobOutput) SetJobId(v string) *StopEventsDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopEventsDetectionJobOutput) SetJobStatus 

func (s *StopEventsDetectionJobOutput) SetJobStatus(v string) *StopEventsDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopEventsDetectionJobOutput) String 

func (s StopEventsDetectionJobOutput) 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 StopKeyPhrasesDetectionJobInput 

type StopKeyPhrasesDetectionJobInput struct {

	// The identifier of the key phrases detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopKeyPhrasesDetectionJobInput) GoString 

func (s StopKeyPhrasesDetectionJobInput) 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 (*StopKeyPhrasesDetectionJobInput) SetJobId 

func (s *StopKeyPhrasesDetectionJobInput) SetJobId(v string) *StopKeyPhrasesDetectionJobInput

SetJobId sets the JobId field's value.

func (StopKeyPhrasesDetectionJobInput) String 

func (s StopKeyPhrasesDetectionJobInput) 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 (*StopKeyPhrasesDetectionJobInput) Validate 

func (s *StopKeyPhrasesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopKeyPhrasesDetectionJobOutput 

type StopKeyPhrasesDetectionJobOutput struct {

	// The identifier of the key phrases detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the
	// job was previously stopped with the StopKeyPhrasesDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopKeyPhrasesDetectionJobOutput) GoString 

func (s StopKeyPhrasesDetectionJobOutput) 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 (*StopKeyPhrasesDetectionJobOutput) SetJobId 

func (s *StopKeyPhrasesDetectionJobOutput) SetJobId(v string) *StopKeyPhrasesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopKeyPhrasesDetectionJobOutput) SetJobStatus 

func (s *StopKeyPhrasesDetectionJobOutput) SetJobStatus(v string) *StopKeyPhrasesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopKeyPhrasesDetectionJobOutput) String 

func (s StopKeyPhrasesDetectionJobOutput) 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 StopPiiEntitiesDetectionJobInput 

type StopPiiEntitiesDetectionJobInput struct {

	// The identifier of the PII entities detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopPiiEntitiesDetectionJobInput) GoString 

func (s StopPiiEntitiesDetectionJobInput) 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 (*StopPiiEntitiesDetectionJobInput) SetJobId 

func (s *StopPiiEntitiesDetectionJobInput) SetJobId(v string) *StopPiiEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (StopPiiEntitiesDetectionJobInput) String 

func (s StopPiiEntitiesDetectionJobInput) 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 (*StopPiiEntitiesDetectionJobInput) Validate 

func (s *StopPiiEntitiesDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopPiiEntitiesDetectionJobOutput 

type StopPiiEntitiesDetectionJobOutput struct {

	// The identifier of the PII entities detection job to stop.
	JobId *string `min:"1" type:"string"`

	// The status of the PII entities detection job.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopPiiEntitiesDetectionJobOutput) GoString 

func (s StopPiiEntitiesDetectionJobOutput) 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 (*StopPiiEntitiesDetectionJobOutput) SetJobId 

func (s *StopPiiEntitiesDetectionJobOutput) SetJobId(v string) *StopPiiEntitiesDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopPiiEntitiesDetectionJobOutput) SetJobStatus 

func (s *StopPiiEntitiesDetectionJobOutput) SetJobStatus(v string) *StopPiiEntitiesDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopPiiEntitiesDetectionJobOutput) String 

func (s StopPiiEntitiesDetectionJobOutput) 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 StopSentimentDetectionJobInput 

type StopSentimentDetectionJobInput struct {

	// The identifier of the sentiment detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopSentimentDetectionJobInput) GoString 

func (s StopSentimentDetectionJobInput) 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 (*StopSentimentDetectionJobInput) SetJobId 

func (s *StopSentimentDetectionJobInput) SetJobId(v string) *StopSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (StopSentimentDetectionJobInput) String 

func (s StopSentimentDetectionJobInput) 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 (*StopSentimentDetectionJobInput) Validate 

func (s *StopSentimentDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopSentimentDetectionJobOutput 

type StopSentimentDetectionJobOutput struct {

	// The identifier of the sentiment detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the
	// job was previously stopped with the StopSentimentDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopSentimentDetectionJobOutput) GoString 

func (s StopSentimentDetectionJobOutput) 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 (*StopSentimentDetectionJobOutput) SetJobId 

func (s *StopSentimentDetectionJobOutput) SetJobId(v string) *StopSentimentDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopSentimentDetectionJobOutput) SetJobStatus 

func (s *StopSentimentDetectionJobOutput) SetJobStatus(v string) *StopSentimentDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopSentimentDetectionJobOutput) String 

func (s StopSentimentDetectionJobOutput) 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 StopTargetedSentimentDetectionJobInput added in v1.42.9 

type StopTargetedSentimentDetectionJobInput struct {

	// The identifier of the targeted sentiment detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopTargetedSentimentDetectionJobInput) GoString added in v1.42.9 

func (s StopTargetedSentimentDetectionJobInput) 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 (*StopTargetedSentimentDetectionJobInput) SetJobId added in v1.42.9 

func (s *StopTargetedSentimentDetectionJobInput) SetJobId(v string) *StopTargetedSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (StopTargetedSentimentDetectionJobInput) String added in v1.42.9 

func (s StopTargetedSentimentDetectionJobInput) 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 (*StopTargetedSentimentDetectionJobInput) Validate added in v1.42.9 

func (s *StopTargetedSentimentDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopTargetedSentimentDetectionJobOutput added in v1.42.9 

type StopTargetedSentimentDetectionJobOutput struct {

	// The identifier of the targeted sentiment detection job to stop.
	JobId *string `min:"1" type:"string"`

	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the
	// job was previously stopped with the StopSentimentDetectionJob operation.
	JobStatus *string `type:"string" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (StopTargetedSentimentDetectionJobOutput) GoString added in v1.42.9 

func (s StopTargetedSentimentDetectionJobOutput) 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 (*StopTargetedSentimentDetectionJobOutput) SetJobId added in v1.42.9 

func (s *StopTargetedSentimentDetectionJobOutput) SetJobId(v string) *StopTargetedSentimentDetectionJobOutput

SetJobId sets the JobId field's value.

func (*StopTargetedSentimentDetectionJobOutput) SetJobStatus added in v1.42.9 

func (s *StopTargetedSentimentDetectionJobOutput) SetJobStatus(v string) *StopTargetedSentimentDetectionJobOutput

SetJobStatus sets the JobStatus field's value.

func (StopTargetedSentimentDetectionJobOutput) String added in v1.42.9 

func (s StopTargetedSentimentDetectionJobOutput) 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 StopTrainingDocumentClassifierInput 

type StopTrainingDocumentClassifierInput struct {

	// The Amazon Resource Name (ARN) that identifies the document classifier currently
	// being trained.
	//
	// DocumentClassifierArn is a required field
	DocumentClassifierArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopTrainingDocumentClassifierInput) GoString 

func (s StopTrainingDocumentClassifierInput) 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 (*StopTrainingDocumentClassifierInput) SetDocumentClassifierArn 

func (s *StopTrainingDocumentClassifierInput) SetDocumentClassifierArn(v string) *StopTrainingDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (StopTrainingDocumentClassifierInput) String 

func (s StopTrainingDocumentClassifierInput) 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 (*StopTrainingDocumentClassifierInput) Validate 

func (s *StopTrainingDocumentClassifierInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopTrainingDocumentClassifierOutput 

type StopTrainingDocumentClassifierOutput struct {
	// contains filtered or unexported fields
}

func (StopTrainingDocumentClassifierOutput) GoString 

func (s StopTrainingDocumentClassifierOutput) 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 (StopTrainingDocumentClassifierOutput) String 

func (s StopTrainingDocumentClassifierOutput) 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 StopTrainingEntityRecognizerInput 

type StopTrainingEntityRecognizerInput struct {

	// The Amazon Resource Name (ARN) that identifies the entity recognizer currently
	// being trained.
	//
	// EntityRecognizerArn is a required field
	EntityRecognizerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopTrainingEntityRecognizerInput) GoString 

func (s StopTrainingEntityRecognizerInput) 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 (*StopTrainingEntityRecognizerInput) SetEntityRecognizerArn 

func (s *StopTrainingEntityRecognizerInput) SetEntityRecognizerArn(v string) *StopTrainingEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (StopTrainingEntityRecognizerInput) String 

func (s StopTrainingEntityRecognizerInput) 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 (*StopTrainingEntityRecognizerInput) Validate 

func (s *StopTrainingEntityRecognizerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopTrainingEntityRecognizerOutput 

type StopTrainingEntityRecognizerOutput struct {
	// contains filtered or unexported fields
}

func (StopTrainingEntityRecognizerOutput) GoString 

func (s StopTrainingEntityRecognizerOutput) 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 (StopTrainingEntityRecognizerOutput) String 

func (s StopTrainingEntityRecognizerOutput) 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 SyntaxToken 

type SyntaxToken struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the word.
	BeginOffset *int64 `type:"integer"`

	// The zero-based offset from the beginning of the source text to the last character
	// in the word.
	EndOffset *int64 `type:"integer"`

	// Provides the part of speech label and the confidence level that Amazon Comprehend
	// has that the part of speech was correctly identified. For more information,
	// see Syntax (https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html)
	// in the Comprehend Developer Guide.
	PartOfSpeech *PartOfSpeechTag `type:"structure"`

	// The word that was recognized in the source text.
	Text *string `min:"1" type:"string"`

	// A unique identifier for a token.
	TokenId *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

func (SyntaxToken) GoString 

func (s SyntaxToken) 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 (*SyntaxToken) SetBeginOffset 

func (s *SyntaxToken) SetBeginOffset(v int64) *SyntaxToken

SetBeginOffset sets the BeginOffset field's value.

func (*SyntaxToken) SetEndOffset 

func (s *SyntaxToken) SetEndOffset(v int64) *SyntaxToken

SetEndOffset sets the EndOffset field's value.

func (*SyntaxToken) SetPartOfSpeech 

func (s *SyntaxToken) SetPartOfSpeech(v *PartOfSpeechTag) *SyntaxToken

SetPartOfSpeech sets the PartOfSpeech field's value.

func (*SyntaxToken) SetText 

func (s *SyntaxToken) SetText(v string) *SyntaxToken

SetText sets the Text field's value.

func (*SyntaxToken) SetTokenId 

func (s *SyntaxToken) SetTokenId(v int64) *SyntaxToken

SetTokenId sets the TokenId field's value.

func (SyntaxToken) String 

func (s SyntaxToken) 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 Tag 

type Tag struct {

	// The initial part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the key portion of the pair,
	// with multiple possible values such as “sales,” “legal,” and “administration.”
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The second part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the initial (key) portion
	// of the pair, with a value of “sales” to indicate the sales department.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

func (Tag) GoString 

func (s Tag) 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 (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) 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 (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to
	// which you want to associate the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// Tags being associated with a specific Amazon Comprehend resource. There can
	// be a maximum of 50 tags (both existing and pending) associated with a specific
	// resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) 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 (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) 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 (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) 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 (TagResourceOutput) String 

func (s TagResourceOutput) 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 TargetedSentimentDetectionJobFilter added in v1.42.9 

type TargetedSentimentDetectionJobFilter 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 ListTargetedSentimentDetectionJobs operation.

func (TargetedSentimentDetectionJobFilter) GoString added in v1.42.9 

func (s TargetedSentimentDetectionJobFilter) 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 (*TargetedSentimentDetectionJobFilter) SetJobName added in v1.42.9 

func (s *TargetedSentimentDetectionJobFilter) SetJobName(v string) *TargetedSentimentDetectionJobFilter

SetJobName sets the JobName field's value.

func (*TargetedSentimentDetectionJobFilter) SetJobStatus added in v1.42.9 

func (s *TargetedSentimentDetectionJobFilter) SetJobStatus(v string) *TargetedSentimentDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*TargetedSentimentDetectionJobFilter) SetSubmitTimeAfter added in v1.42.9 

func (s *TargetedSentimentDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *TargetedSentimentDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*TargetedSentimentDetectionJobFilter) SetSubmitTimeBefore added in v1.42.9 

func (s *TargetedSentimentDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *TargetedSentimentDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (TargetedSentimentDetectionJobFilter) String added in v1.42.9 

func (s TargetedSentimentDetectionJobFilter) 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 (*TargetedSentimentDetectionJobFilter) Validate added in v1.42.9 

func (s *TargetedSentimentDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TargetedSentimentDetectionJobProperties added in v1.42.9 

type TargetedSentimentDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the targeted sentiment detection job ended.
	EndTime *time.Time `type:"timestamp"`

	// The input properties for an inference job. The document reader config field
	// applies only to non-text inputs for custom analysis.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the targeted sentiment detection job. It
	// is a unique, fully qualified identifier for the job. It includes the Amazon
	// Web Services account, Amazon Web Services Region, and the job ID. The format
	// of the ARN is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier assigned to the targeted sentiment detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned to the targeted sentiment detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the targeted sentiment detection job. If the status
	// is FAILED, the Messages field shows the reason for the failure.
	JobStatus *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"`

	// Provides configuration parameters for the output of inference jobs.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the targeted sentiment detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt the data on the
	// storage volume attached to the ML compute instance(s) that process the targeted
	// sentiment detection job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for the job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a targeted sentiment detection job.

func (TargetedSentimentDetectionJobProperties) GoString added in v1.42.9 

func (s TargetedSentimentDetectionJobProperties) 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 (*TargetedSentimentDetectionJobProperties) SetDataAccessRoleArn added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetDataAccessRoleArn(v string) *TargetedSentimentDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*TargetedSentimentDetectionJobProperties) SetEndTime added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetEndTime(v time.Time) *TargetedSentimentDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*TargetedSentimentDetectionJobProperties) SetInputDataConfig added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *TargetedSentimentDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*TargetedSentimentDetectionJobProperties) SetJobArn added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetJobArn(v string) *TargetedSentimentDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*TargetedSentimentDetectionJobProperties) SetJobId added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetJobId(v string) *TargetedSentimentDetectionJobProperties

SetJobId sets the JobId field's value.

func (*TargetedSentimentDetectionJobProperties) SetJobName added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetJobName(v string) *TargetedSentimentDetectionJobProperties

SetJobName sets the JobName field's value.

func (*TargetedSentimentDetectionJobProperties) SetJobStatus added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetJobStatus(v string) *TargetedSentimentDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*TargetedSentimentDetectionJobProperties) SetLanguageCode added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetLanguageCode(v string) *TargetedSentimentDetectionJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*TargetedSentimentDetectionJobProperties) SetMessage added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetMessage(v string) *TargetedSentimentDetectionJobProperties

SetMessage sets the Message field's value.

func (*TargetedSentimentDetectionJobProperties) SetOutputDataConfig added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *TargetedSentimentDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*TargetedSentimentDetectionJobProperties) SetSubmitTime added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetSubmitTime(v time.Time) *TargetedSentimentDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*TargetedSentimentDetectionJobProperties) SetVolumeKmsKeyId added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetVolumeKmsKeyId(v string) *TargetedSentimentDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*TargetedSentimentDetectionJobProperties) SetVpcConfig added in v1.42.9 

func (s *TargetedSentimentDetectionJobProperties) SetVpcConfig(v *VpcConfig) *TargetedSentimentDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (TargetedSentimentDetectionJobProperties) String added in v1.42.9 

func (s TargetedSentimentDetectionJobProperties) 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 TargetedSentimentEntity added in v1.42.9 

type TargetedSentimentEntity struct {

	// One or more index into the Mentions array that provides the best name for
	// the entity group.
	DescriptiveMentionIndex []*int64 `type:"list"`

	// An array of mentions of the entity in the document. The array represents
	// a co-reference group. See Co-reference group (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values)
	// for an example.
	Mentions []*TargetedSentimentMention `type:"list"`
	// contains filtered or unexported fields
}

Information about one of the entities found by targeted sentiment analysis.

For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).

func (TargetedSentimentEntity) GoString added in v1.42.9 

func (s TargetedSentimentEntity) 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 (*TargetedSentimentEntity) SetDescriptiveMentionIndex added in v1.42.9 

func (s *TargetedSentimentEntity) SetDescriptiveMentionIndex(v []*int64) *TargetedSentimentEntity

SetDescriptiveMentionIndex sets the DescriptiveMentionIndex field's value.

func (*TargetedSentimentEntity) SetMentions added in v1.42.9 

func (s *TargetedSentimentEntity) SetMentions(v []*TargetedSentimentMention) *TargetedSentimentEntity

SetMentions sets the Mentions field's value.

func (TargetedSentimentEntity) String added in v1.42.9 

func (s TargetedSentimentEntity) 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 TargetedSentimentMention added in v1.42.9 

type TargetedSentimentMention struct {

	// The offset into the document text where the mention begins.
	BeginOffset *int64 `type:"integer"`

	// The offset into the document text where the mention ends.
	EndOffset *int64 `type:"integer"`

	// The confidence that all the entities mentioned in the group relate to the
	// same entity.
	GroupScore *float64 `type:"float"`

	// Contains the sentiment and sentiment score for the mention.
	MentionSentiment *MentionSentiment `type:"structure"`

	// Model confidence that the entity is relevant. Value range is zero to one,
	// where one is highest confidence.
	Score *float64 `type:"float"`

	// The text in the document that identifies the entity.
	Text *string `min:"1" type:"string"`

	// The type of the entity. Amazon Comprehend supports a variety of entity types
	// (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities).
	Type *string `type:"string" enum:"TargetedSentimentEntityType"`
	// contains filtered or unexported fields
}

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

For more information about targeted sentiment, see Targeted sentiment (https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html).

func (TargetedSentimentMention) GoString added in v1.42.9 

func (s TargetedSentimentMention) 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 (*TargetedSentimentMention) SetBeginOffset added in v1.42.9 

func (s *TargetedSentimentMention) SetBeginOffset(v int64) *TargetedSentimentMention

SetBeginOffset sets the BeginOffset field's value.

func (*TargetedSentimentMention) SetEndOffset added in v1.42.9 

func (s *TargetedSentimentMention) SetEndOffset(v int64) *TargetedSentimentMention

SetEndOffset sets the EndOffset field's value.

func (*TargetedSentimentMention) SetGroupScore added in v1.42.9 

func (s *TargetedSentimentMention) SetGroupScore(v float64) *TargetedSentimentMention

SetGroupScore sets the GroupScore field's value.

func (*TargetedSentimentMention) SetMentionSentiment added in v1.42.9 

func (s *TargetedSentimentMention) SetMentionSentiment(v *MentionSentiment) *TargetedSentimentMention

SetMentionSentiment sets the MentionSentiment field's value.

func (*TargetedSentimentMention) SetScore added in v1.42.9 

func (s *TargetedSentimentMention) SetScore(v float64) *TargetedSentimentMention

SetScore sets the Score field's value.

func (*TargetedSentimentMention) SetText added in v1.42.9 

func (s *TargetedSentimentMention) SetText(v string) *TargetedSentimentMention

SetText sets the Text field's value.

func (*TargetedSentimentMention) SetType added in v1.42.9 

func (s *TargetedSentimentMention) SetType(v string) *TargetedSentimentMention

SetType sets the Type field's value.

func (TargetedSentimentMention) String added in v1.42.9 

func (s TargetedSentimentMention) 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 TaskConfig added in v1.42.9 

type TaskConfig struct {

	// Configuration required for a classification model.
	DocumentClassificationConfig *DocumentClassificationConfig `type:"structure"`

	// Configuration required for an entity recognition model.
	EntityRecognitionConfig *EntityRecognitionConfig `type:"structure"`

	// Language code for the language that the model supports.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`
	// contains filtered or unexported fields
}

Configuration about the custom classifier associated with the flywheel.

func (TaskConfig) GoString added in v1.42.9 

func (s TaskConfig) 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 (*TaskConfig) SetDocumentClassificationConfig added in v1.42.9 

func (s *TaskConfig) SetDocumentClassificationConfig(v *DocumentClassificationConfig) *TaskConfig

SetDocumentClassificationConfig sets the DocumentClassificationConfig field's value.

func (*TaskConfig) SetEntityRecognitionConfig added in v1.42.9 

func (s *TaskConfig) SetEntityRecognitionConfig(v *EntityRecognitionConfig) *TaskConfig

SetEntityRecognitionConfig sets the EntityRecognitionConfig field's value.

func (*TaskConfig) SetLanguageCode added in v1.42.9 

func (s *TaskConfig) SetLanguageCode(v string) *TaskConfig

SetLanguageCode sets the LanguageCode field's value.

func (TaskConfig) String added in v1.42.9 

func (s TaskConfig) 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 (*TaskConfig) Validate added in v1.42.9 

func (s *TaskConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TextSizeLimitExceededException 

type TextSizeLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The size of the input text exceeds the limit. Use a smaller document.

func (*TextSizeLimitExceededException) Code 

func (s *TextSizeLimitExceededException) Code() string

Code returns the exception type name.

func (*TextSizeLimitExceededException) Error 

func (s *TextSizeLimitExceededException) Error() string

func (TextSizeLimitExceededException) GoString 

func (s TextSizeLimitExceededException) 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 (*TextSizeLimitExceededException) Message 

func (s *TextSizeLimitExceededException) Message() string

Message returns the exception's message.

func (*TextSizeLimitExceededException) OrigErr 

func (s *TextSizeLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TextSizeLimitExceededException) RequestID 

func (s *TextSizeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TextSizeLimitExceededException) StatusCode 

func (s *TextSizeLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TextSizeLimitExceededException) String 

func (s TextSizeLimitExceededException) 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 TooManyRequestsException 

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The number of requests exceeds the limit. Resubmit your request later.

func (*TooManyRequestsException) Code 

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error 

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString 

func (s TooManyRequestsException) 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 (*TooManyRequestsException) Message 

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr 

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID 

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode 

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String 

func (s TooManyRequestsException) 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 TooManyTagKeysException 

type TooManyTagKeysException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

func (*TooManyTagKeysException) Code 

func (s *TooManyTagKeysException) Code() string

Code returns the exception type name.

func (*TooManyTagKeysException) Error 

func (s *TooManyTagKeysException) Error() string

func (TooManyTagKeysException) GoString 

func (s TooManyTagKeysException) 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 (*TooManyTagKeysException) Message 

func (s *TooManyTagKeysException) Message() string

Message returns the exception's message.

func (*TooManyTagKeysException) OrigErr 

func (s *TooManyTagKeysException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagKeysException) RequestID 

func (s *TooManyTagKeysException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagKeysException) StatusCode 

func (s *TooManyTagKeysException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagKeysException) String 

func (s TooManyTagKeysException) 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 TooManyTagsException 

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

func (*TooManyTagsException) Code 

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error 

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString 

func (s TooManyTagsException) 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 (*TooManyTagsException) Message 

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr 

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID 

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode 

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String 

func (s TooManyTagsException) 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 TopicsDetectionJobFilter 

type TopicsDetectionJobFilter struct {
	JobName *string `min:"1" type:"string"`

	// Filters the list of topic detection 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. Only returns jobs submitted after the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Only returns jobs submitted before the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering topic detection jobs. For more information, see .

func (TopicsDetectionJobFilter) GoString 

func (s TopicsDetectionJobFilter) 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 (*TopicsDetectionJobFilter) SetJobName 

func (s *TopicsDetectionJobFilter) SetJobName(v string) *TopicsDetectionJobFilter

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobFilter) SetJobStatus 

func (s *TopicsDetectionJobFilter) SetJobStatus(v string) *TopicsDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*TopicsDetectionJobFilter) SetSubmitTimeAfter 

func (s *TopicsDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *TopicsDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*TopicsDetectionJobFilter) SetSubmitTimeBefore 

func (s *TopicsDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *TopicsDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (TopicsDetectionJobFilter) String 

func (s TopicsDetectionJobFilter) 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 (*TopicsDetectionJobFilter) Validate 

func (s *TopicsDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TopicsDetectionJobProperties 

type TopicsDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// read access to your job data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the topic detection job was completed.
	EndTime *time.Time `type:"timestamp"`

	// The input data configuration supplied when you created the topic detection
	// job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The Amazon Resource Name (ARN) of the topics detection job. It is a unique,
	// fully qualified identifier for the job. It includes the Amazon Web Services
	// account, Amazon Web Services Region, and the job ID. The format of the ARN
	// is as follows:
	//
	// arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
	//
	// The following is an example job ARN:
	//
	// arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
	JobArn *string `type:"string"`

	// The identifier assigned to the topic detection job.
	JobId *string `min:"1" type:"string"`

	// The name of the topic detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the topic detection job. If the status is Failed, the
	// reason for the failure is shown in the Message field.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// A description for the status of a job.
	Message *string `type:"string"`

	// The number of topics to detect supplied when you created the topic detection
	// job. The default is 10.
	NumberOfTopics *int64 `type:"integer"`

	// The output data configuration supplied when you created the topic detection
	// job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the topic detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`

	// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
	// Comprehend uses to encrypt data on the storage volume attached to the ML
	// compute instance(s) that process the analysis job. The VolumeKmsKeyId can
	// be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your topic detection job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Provides information about a topic detection job.

func (TopicsDetectionJobProperties) GoString 

func (s TopicsDetectionJobProperties) 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 (*TopicsDetectionJobProperties) SetDataAccessRoleArn 

func (s *TopicsDetectionJobProperties) SetDataAccessRoleArn(v string) *TopicsDetectionJobProperties

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*TopicsDetectionJobProperties) SetEndTime 

func (s *TopicsDetectionJobProperties) SetEndTime(v time.Time) *TopicsDetectionJobProperties

SetEndTime sets the EndTime field's value.

func (*TopicsDetectionJobProperties) SetInputDataConfig 

func (s *TopicsDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *TopicsDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetJobArn 

func (s *TopicsDetectionJobProperties) SetJobArn(v string) *TopicsDetectionJobProperties

SetJobArn sets the JobArn field's value.

func (*TopicsDetectionJobProperties) SetJobId 

func (s *TopicsDetectionJobProperties) SetJobId(v string) *TopicsDetectionJobProperties

SetJobId sets the JobId field's value.

func (*TopicsDetectionJobProperties) SetJobName 

func (s *TopicsDetectionJobProperties) SetJobName(v string) *TopicsDetectionJobProperties

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobProperties) SetJobStatus 

func (s *TopicsDetectionJobProperties) SetJobStatus(v string) *TopicsDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*TopicsDetectionJobProperties) SetMessage 

func (s *TopicsDetectionJobProperties) SetMessage(v string) *TopicsDetectionJobProperties

SetMessage sets the Message field's value.

func (*TopicsDetectionJobProperties) SetNumberOfTopics 

func (s *TopicsDetectionJobProperties) SetNumberOfTopics(v int64) *TopicsDetectionJobProperties

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*TopicsDetectionJobProperties) SetOutputDataConfig 

func (s *TopicsDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *TopicsDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetSubmitTime 

func (s *TopicsDetectionJobProperties) SetSubmitTime(v time.Time) *TopicsDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*TopicsDetectionJobProperties) SetVolumeKmsKeyId 

func (s *TopicsDetectionJobProperties) SetVolumeKmsKeyId(v string) *TopicsDetectionJobProperties

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*TopicsDetectionJobProperties) SetVpcConfig 

func (s *TopicsDetectionJobProperties) SetVpcConfig(v *VpcConfig) *TopicsDetectionJobProperties

SetVpcConfig sets the VpcConfig field's value.

func (TopicsDetectionJobProperties) String 

func (s TopicsDetectionJobProperties) 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 UnsupportedLanguageException 

type UnsupportedLanguageException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, Supported languages (https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html) in the Comprehend Developer Guide.

func (*UnsupportedLanguageException) Code 

func (s *UnsupportedLanguageException) Code() string

Code returns the exception type name.

func (*UnsupportedLanguageException) Error 

func (s *UnsupportedLanguageException) Error() string

func (UnsupportedLanguageException) GoString 

func (s UnsupportedLanguageException) 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 (*UnsupportedLanguageException) Message 

func (s *UnsupportedLanguageException) Message() string

Message returns the exception's message.

func (*UnsupportedLanguageException) OrigErr 

func (s *UnsupportedLanguageException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedLanguageException) RequestID 

func (s *UnsupportedLanguageException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedLanguageException) StatusCode 

func (s *UnsupportedLanguageException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedLanguageException) String 

func (s UnsupportedLanguageException) 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 UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from
	// which you want to remove the tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The initial part of a key-value pair that forms a tag being removed from
	// a given resource. For example, a tag with "Sales" as the key might be added
	// to a resource to indicate its use by the sales department. Keys must be unique
	// and cannot be duplicated for a particular resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) 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 (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) 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 (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) 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 (UntagResourceOutput) String 

func (s UntagResourceOutput) 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 UpdateDataSecurityConfig added in v1.42.9 

type UpdateDataSecurityConfig struct {

	// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
	// models. The ModelKmsKeyId can be either of the following formats:
	//
	//    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	ModelKmsKeyId *string `type:"string"`

	// ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
	VolumeKmsKeyId *string `type:"string"`

	// Configuration parameters for an optional private Virtual Private Cloud (VPC)
	// containing the resources you are using for the job. For more information,
	// see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig `type:"structure"`
	// contains filtered or unexported fields
}

Data security configuration.

func (UpdateDataSecurityConfig) GoString added in v1.42.9 

func (s UpdateDataSecurityConfig) 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 (*UpdateDataSecurityConfig) SetModelKmsKeyId added in v1.42.9 

func (s *UpdateDataSecurityConfig) SetModelKmsKeyId(v string) *UpdateDataSecurityConfig

SetModelKmsKeyId sets the ModelKmsKeyId field's value.

func (*UpdateDataSecurityConfig) SetVolumeKmsKeyId added in v1.42.9 

func (s *UpdateDataSecurityConfig) SetVolumeKmsKeyId(v string) *UpdateDataSecurityConfig

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*UpdateDataSecurityConfig) SetVpcConfig added in v1.42.9 

func (s *UpdateDataSecurityConfig) SetVpcConfig(v *VpcConfig) *UpdateDataSecurityConfig

SetVpcConfig sets the VpcConfig field's value.

func (UpdateDataSecurityConfig) String added in v1.42.9 

func (s UpdateDataSecurityConfig) 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 (*UpdateDataSecurityConfig) Validate added in v1.42.9 

func (s *UpdateDataSecurityConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEndpointInput 

type UpdateEndpointInput struct {

	// Data access role ARN to use in case the new model is encrypted with a customer
	// CMK.
	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"`

	// The ARN of the new model to use when updating an existing endpoint.
	DesiredModelArn *string `type:"string"`

	// The Amazon Resource Number (ARN) of the endpoint being updated.
	//
	// EndpointArn is a required field
	EndpointArn *string `type:"string" required:"true"`

	// The Amazon Resource Number (ARN) of the flywheel
	FlywheelArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateEndpointInput) GoString 

func (s UpdateEndpointInput) 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 (*UpdateEndpointInput) SetDesiredDataAccessRoleArn 

func (s *UpdateEndpointInput) SetDesiredDataAccessRoleArn(v string) *UpdateEndpointInput

SetDesiredDataAccessRoleArn sets the DesiredDataAccessRoleArn field's value.

func (*UpdateEndpointInput) SetDesiredInferenceUnits 

func (s *UpdateEndpointInput) SetDesiredInferenceUnits(v int64) *UpdateEndpointInput

SetDesiredInferenceUnits sets the DesiredInferenceUnits field's value.

func (*UpdateEndpointInput) SetDesiredModelArn 

func (s *UpdateEndpointInput) SetDesiredModelArn(v string) *UpdateEndpointInput

SetDesiredModelArn sets the DesiredModelArn field's value.

func (*UpdateEndpointInput) SetEndpointArn 

func (s *UpdateEndpointInput) SetEndpointArn(v string) *UpdateEndpointInput

SetEndpointArn sets the EndpointArn field's value.

func (*UpdateEndpointInput) SetFlywheelArn added in v1.42.9 

func (s *UpdateEndpointInput) SetFlywheelArn(v string) *UpdateEndpointInput

SetFlywheelArn sets the FlywheelArn field's value.

func (UpdateEndpointInput) String 

func (s UpdateEndpointInput) 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 (*UpdateEndpointInput) Validate 

func (s *UpdateEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEndpointOutput 

type UpdateEndpointOutput struct {

	// The Amazon Resource Number (ARN) of the new model.
	DesiredModelArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateEndpointOutput) GoString 

func (s UpdateEndpointOutput) 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 (*UpdateEndpointOutput) SetDesiredModelArn added in v1.42.9 

func (s *UpdateEndpointOutput) SetDesiredModelArn(v string) *UpdateEndpointOutput

SetDesiredModelArn sets the DesiredModelArn field's value.

func (UpdateEndpointOutput) String 

func (s UpdateEndpointOutput) 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 UpdateFlywheelInput added in v1.42.9 

type UpdateFlywheelInput struct {

	// The Amazon Resource Number (ARN) of the active model version.
	ActiveModelArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
	// permission to access the flywheel data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// Flywheel data security configuration.
	DataSecurityConfig *UpdateDataSecurityConfig `type:"structure"`

	// The Amazon Resource Number (ARN) of the flywheel to update.
	//
	// FlywheelArn is a required field
	FlywheelArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFlywheelInput) GoString added in v1.42.9 

func (s UpdateFlywheelInput) 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 (*UpdateFlywheelInput) SetActiveModelArn added in v1.42.9 

func (s *UpdateFlywheelInput) SetActiveModelArn(v string) *UpdateFlywheelInput

SetActiveModelArn sets the ActiveModelArn field's value.

func (*UpdateFlywheelInput) SetDataAccessRoleArn added in v1.42.9 

func (s *UpdateFlywheelInput) SetDataAccessRoleArn(v string) *UpdateFlywheelInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*UpdateFlywheelInput) SetDataSecurityConfig added in v1.42.9 

func (s *UpdateFlywheelInput) SetDataSecurityConfig(v *UpdateDataSecurityConfig) *UpdateFlywheelInput

SetDataSecurityConfig sets the DataSecurityConfig field's value.

func (*UpdateFlywheelInput) SetFlywheelArn added in v1.42.9 

func (s *UpdateFlywheelInput) SetFlywheelArn(v string) *UpdateFlywheelInput

SetFlywheelArn sets the FlywheelArn field's value.

func (UpdateFlywheelInput) String added in v1.42.9 

func (s UpdateFlywheelInput) 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 (*UpdateFlywheelInput) Validate added in v1.42.9 

func (s *UpdateFlywheelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFlywheelOutput added in v1.42.9 

type UpdateFlywheelOutput struct {

	// The flywheel properties.
	FlywheelProperties *FlywheelProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateFlywheelOutput) GoString added in v1.42.9 

func (s UpdateFlywheelOutput) 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 (*UpdateFlywheelOutput) SetFlywheelProperties added in v1.42.9 

func (s *UpdateFlywheelOutput) SetFlywheelProperties(v *FlywheelProperties) *UpdateFlywheelOutput

SetFlywheelProperties sets the FlywheelProperties field's value.

func (UpdateFlywheelOutput) String added in v1.42.9 

func (s UpdateFlywheelOutput) 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 VpcConfig 

type VpcConfig struct {

	// The ID number for a security group on an instance of your private VPC. Security
	// groups on your VPC function serve as a virtual firewall to control inbound
	// and outbound traffic and provides security for the resources that you’ll
	// be accessing on the VPC. This ID number is preceded by "sg-", for instance:
	// "sg-03b388029b0a285ea". For more information, see Security Groups for your
	// VPC (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html).
	//
	// SecurityGroupIds is a required field
	SecurityGroupIds []*string `min:"1" type:"list" required:"true"`

	// The ID for each subnet being used in your private VPC. This subnet is a subset
	// of the a range of IPv4 addresses used by the VPC and is specific to a given
	// availability zone in the VPC’s Region. This ID number is preceded by "subnet-",
	// for instance: "subnet-04ccf456919e69055". For more information, see VPCs
	// and Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html).
	//
	// Subnets is a required field
	Subnets []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).

func (VpcConfig) GoString 

func (s VpcConfig) 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 (*VpcConfig) SetSecurityGroupIds 

func (s *VpcConfig) SetSecurityGroupIds(v []*string) *VpcConfig

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*VpcConfig) SetSubnets 

func (s *VpcConfig) SetSubnets(v []*string) *VpcConfig

SetSubnets sets the Subnets field's value.

func (VpcConfig) String 

func (s VpcConfig) 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 (*VpcConfig) Validate 

func (s *VpcConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WarningsListItem added in v1.42.9 

type WarningsListItem struct {

	// Page number in the input document.
	Page *int64 `type:"integer"`

	// The type of warning.
	WarnCode *string `type:"string" enum:"PageBasedWarningCode"`

	// Text message associated with the warning.
	WarnMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The system identified one of the following warnings while processing the input document:

  • The document to classify is plain text, but the classifier is a native model.

  • The document to classify is semi-structured, but the classifier is a plain-text model.

func (WarningsListItem) GoString added in v1.42.9 

func (s WarningsListItem) 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 (*WarningsListItem) SetPage added in v1.42.9 

func (s *WarningsListItem) SetPage(v int64) *WarningsListItem

SetPage sets the Page field's value.

func (*WarningsListItem) SetWarnCode added in v1.42.9 

func (s *WarningsListItem) SetWarnCode(v string) *WarningsListItem

SetWarnCode sets the WarnCode field's value.

func (*WarningsListItem) SetWarnMessage added in v1.42.9 

func (s *WarningsListItem) SetWarnMessage(v string) *WarningsListItem

SetWarnMessage sets the WarnMessage field's value.

func (WarningsListItem) String added in v1.42.9 

func (s WarningsListItem) 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".

Source Files

View all Source files

Directories

Path Synopsis
Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.
 Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.