aws-sdk-go: github.com/aws/aws-sdk-go/service/comprehend Index | Files | Directories

package comprehend

import "github.com/aws/aws-sdk-go/service/comprehend"

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

Amazon Comprehend is an AWS 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

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // EntityTypePerson is a EntityType enum value
    EntityTypePerson = "PERSON"

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

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

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

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

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

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

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

    // EntityTypeOther is a EntityType enum value
    EntityTypeOther = "OTHER"
)
const (
    // InputFormatOneDocPerFile is a InputFormat enum value
    InputFormatOneDocPerFile = "ONE_DOC_PER_FILE"

    // InputFormatOneDocPerLine is a InputFormat enum value
    InputFormatOneDocPerLine = "ONE_DOC_PER_LINE"
)
const (
    // JobStatusSubmitted is a JobStatus enum value
    JobStatusSubmitted = "SUBMITTED"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // ModelStatusTrained is a ModelStatus enum value
    ModelStatusTrained = "TRAINED"
)
const (
    // PartOfSpeechTagTypeAdj is a PartOfSpeechTagType enum value
    PartOfSpeechTagTypeAdj = "ADJ"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // PartOfSpeechTagTypeVerb is a PartOfSpeechTagType enum value
    PartOfSpeechTagTypeVerb = "VERB"
)
const (
    // SentimentTypePositive is a SentimentType enum value
    SentimentTypePositive = "POSITIVE"

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

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

    // SentimentTypeMixed is a SentimentType enum value
    SentimentTypeMixed = "MIXED"
)
const (
    // SyntaxLanguageCodeEn is a SyntaxLanguageCode enum value
    SyntaxLanguageCodeEn = "en"

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

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

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

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

    // SyntaxLanguageCodePt is a SyntaxLanguageCode enum value
    SyntaxLanguageCodePt = "pt"
)
const (

    // 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 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 recognizers per account has been exceeded. Review the
    // recognizers, perform cleanup, 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 to see if the resource is
    // in the TRAINED state 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 all custom
    // entity recognition APIs (such as CreateEntityRecognizer), only English is
    // accepted. For most other APIs, such as those for Custom Classification, Amazon
    // Comprehend accepts text in all supported languages. For a list of supported
    // languages, see supported-languages.
    ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException"
)
const (
    ServiceName = "comprehend" // Name of service.
    EndpointsID = ServiceName  // ID to lookup a service endpoint with.
    ServiceID   = "Comprehend" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type BatchDetectDominantLanguageInput Uses

type BatchDetectDominantLanguageInput struct {

    // A list containing the text of the input documents. The list can contain a
    // maximum of 25 documents. Each document should contain at least 20 characters
    // and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
    //
    // TextList is a required field
    TextList []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectDominantLanguageInput) GoString Uses

func (s BatchDetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageInput) SetTextList Uses

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

SetTextList sets the TextList field's value.

func (BatchDetectDominantLanguageInput) String Uses

func (s BatchDetectDominantLanguageInput) String() string

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate Uses

func (s *BatchDetectDominantLanguageInput) Validate() error

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

type BatchDetectDominantLanguageItemResult Uses

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 Uses

func (s BatchDetectDominantLanguageItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageItemResult) SetIndex Uses

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

SetIndex sets the Index field's value.

func (*BatchDetectDominantLanguageItemResult) SetLanguages Uses

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

SetLanguages sets the Languages field's value.

func (BatchDetectDominantLanguageItemResult) String Uses

func (s BatchDetectDominantLanguageItemResult) String() string

String returns the string representation

type BatchDetectDominantLanguageOutput Uses

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 Uses

func (s BatchDetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageOutput) SetErrorList Uses

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectDominantLanguageOutput) SetResultList Uses

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

SetResultList sets the ResultList field's value.

func (BatchDetectDominantLanguageOutput) String Uses

func (s BatchDetectDominantLanguageOutput) String() string

String returns the string representation

type BatchDetectEntitiesInput Uses

type BatchDetectEntitiesInput struct {

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

    // A list containing the text of the input documents. The list can contain a
    // maximum of 25 documents. Each document must contain fewer than 5,000 bytes
    // of UTF-8 encoded characters.
    //
    // TextList is a required field
    TextList []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectEntitiesInput) GoString Uses

func (s BatchDetectEntitiesInput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectEntitiesInput) SetTextList Uses

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

SetTextList sets the TextList field's value.

func (BatchDetectEntitiesInput) String Uses

func (s BatchDetectEntitiesInput) String() string

String returns the string representation

func (*BatchDetectEntitiesInput) Validate Uses

func (s *BatchDetectEntitiesInput) Validate() error

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

type BatchDetectEntitiesItemResult Uses

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 Uses

func (s BatchDetectEntitiesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesItemResult) SetEntities Uses

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

SetEntities sets the Entities field's value.

func (*BatchDetectEntitiesItemResult) SetIndex Uses

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

SetIndex sets the Index field's value.

func (BatchDetectEntitiesItemResult) String Uses

func (s BatchDetectEntitiesItemResult) String() string

String returns the string representation

type BatchDetectEntitiesOutput Uses

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 Uses

func (s BatchDetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesOutput) SetErrorList Uses

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectEntitiesOutput) SetResultList Uses

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

SetResultList sets the ResultList field's value.

func (BatchDetectEntitiesOutput) String Uses

func (s BatchDetectEntitiesOutput) String() string

String returns the string representation

type BatchDetectKeyPhrasesInput Uses

type BatchDetectKeyPhrasesInput struct {

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

    // A list containing the text of the input documents. The list can contain a
    // maximum of 25 documents. Each document must contain fewer that 5,000 bytes
    // of UTF-8 encoded characters.
    //
    // TextList is a required field
    TextList []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectKeyPhrasesInput) GoString Uses

func (s BatchDetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectKeyPhrasesInput) SetTextList Uses

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

SetTextList sets the TextList field's value.

func (BatchDetectKeyPhrasesInput) String Uses

func (s BatchDetectKeyPhrasesInput) String() string

String returns the string representation

func (*BatchDetectKeyPhrasesInput) Validate Uses

func (s *BatchDetectKeyPhrasesInput) Validate() error

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

type BatchDetectKeyPhrasesItemResult Uses

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 Uses

func (s BatchDetectKeyPhrasesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesItemResult) SetIndex Uses

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

SetIndex sets the Index field's value.

func (*BatchDetectKeyPhrasesItemResult) SetKeyPhrases Uses

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

SetKeyPhrases sets the KeyPhrases field's value.

func (BatchDetectKeyPhrasesItemResult) String Uses

func (s BatchDetectKeyPhrasesItemResult) String() string

String returns the string representation

type BatchDetectKeyPhrasesOutput Uses

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 Uses

func (s BatchDetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesOutput) SetErrorList Uses

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectKeyPhrasesOutput) SetResultList Uses

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

SetResultList sets the ResultList field's value.

func (BatchDetectKeyPhrasesOutput) String Uses

func (s BatchDetectKeyPhrasesOutput) String() string

String returns the string representation

type BatchDetectSentimentInput Uses

type BatchDetectSentimentInput struct {

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

    // A list containing the text of the input documents. The list can contain a
    // maximum of 25 documents. Each document must contain fewer that 5,000 bytes
    // of UTF-8 encoded characters.
    //
    // TextList is a required field
    TextList []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectSentimentInput) GoString Uses

func (s BatchDetectSentimentInput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSentimentInput) SetTextList Uses

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

SetTextList sets the TextList field's value.

func (BatchDetectSentimentInput) String Uses

func (s BatchDetectSentimentInput) String() string

String returns the string representation

func (*BatchDetectSentimentInput) Validate Uses

func (s *BatchDetectSentimentInput) Validate() error

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

type BatchDetectSentimentItemResult Uses

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 Uses

func (s BatchDetectSentimentItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentItemResult) SetIndex Uses

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

SetIndex sets the Index field's value.

func (*BatchDetectSentimentItemResult) SetSentiment Uses

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

SetSentiment sets the Sentiment field's value.

func (*BatchDetectSentimentItemResult) SetSentimentScore Uses

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

SetSentimentScore sets the SentimentScore field's value.

func (BatchDetectSentimentItemResult) String Uses

func (s BatchDetectSentimentItemResult) String() string

String returns the string representation

type BatchDetectSentimentOutput Uses

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 Uses

func (s BatchDetectSentimentOutput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentOutput) SetErrorList Uses

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSentimentOutput) SetResultList Uses

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

SetResultList sets the ResultList field's value.

func (BatchDetectSentimentOutput) String Uses

func (s BatchDetectSentimentOutput) String() string

String returns the string representation

type BatchDetectSyntaxInput Uses

type BatchDetectSyntaxInput struct {

    // The language of the input documents. You can specify any of the primary 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 text of the input documents. The list can contain a
    // maximum of 25 documents. Each document must contain fewer that 5,000 bytes
    // of UTF-8 encoded characters.
    //
    // TextList is a required field
    TextList []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (BatchDetectSyntaxInput) GoString Uses

func (s BatchDetectSyntaxInput) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSyntaxInput) SetTextList Uses

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

SetTextList sets the TextList field's value.

func (BatchDetectSyntaxInput) String Uses

func (s BatchDetectSyntaxInput) String() string

String returns the string representation

func (*BatchDetectSyntaxInput) Validate Uses

func (s *BatchDetectSyntaxInput) Validate() error

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

type BatchDetectSyntaxItemResult Uses

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 Uses

func (s BatchDetectSyntaxItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxItemResult) SetIndex Uses

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

SetIndex sets the Index field's value.

func (*BatchDetectSyntaxItemResult) SetSyntaxTokens Uses

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

SetSyntaxTokens sets the SyntaxTokens field's value.

func (BatchDetectSyntaxItemResult) String Uses

func (s BatchDetectSyntaxItemResult) String() string

String returns the string representation

type BatchDetectSyntaxOutput Uses

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 Uses

func (s BatchDetectSyntaxOutput) GoString() string

GoString returns the string representation

func (*BatchDetectSyntaxOutput) SetErrorList Uses

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSyntaxOutput) SetResultList Uses

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

SetResultList sets the ResultList field's value.

func (BatchDetectSyntaxOutput) String Uses

func (s BatchDetectSyntaxOutput) String() string

String returns the string representation

type BatchItemError Uses

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 Uses

func (s BatchItemError) GoString() string

GoString returns the string representation

func (*BatchItemError) SetErrorCode Uses

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchItemError) SetErrorMessage Uses

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchItemError) SetIndex Uses

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

SetIndex sets the Index field's value.

func (BatchItemError) String Uses

func (s BatchItemError) String() string

String returns the string representation

type ClassifierEvaluationMetrics Uses

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

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

func (s ClassifierEvaluationMetrics) GoString() string

GoString returns the string representation

func (*ClassifierEvaluationMetrics) SetAccuracy Uses

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

SetAccuracy sets the Accuracy field's value.

func (*ClassifierEvaluationMetrics) SetF1Score Uses

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

SetF1Score sets the F1Score field's value.

func (*ClassifierEvaluationMetrics) SetPrecision Uses

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

SetPrecision sets the Precision field's value.

func (*ClassifierEvaluationMetrics) SetRecall Uses

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

SetRecall sets the Recall field's value.

func (ClassifierEvaluationMetrics) String Uses

func (s ClassifierEvaluationMetrics) String() string

String returns the string representation

type ClassifierMetadata Uses

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

func (s ClassifierMetadata) GoString() string

GoString returns the string representation

func (*ClassifierMetadata) SetEvaluationMetrics Uses

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

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*ClassifierMetadata) SetNumberOfLabels Uses

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

SetNumberOfLabels sets the NumberOfLabels field's value.

func (*ClassifierMetadata) SetNumberOfTestDocuments Uses

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

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*ClassifierMetadata) SetNumberOfTrainedDocuments Uses

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

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (ClassifierMetadata) String Uses

func (s ClassifierMetadata) String() string

String returns the string representation

type Comprehend Uses

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 Uses

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:

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

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 how-entities

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 how-syntax.

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) CreateDocumentClassifier Uses

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

CreateDocumentClassifier API operation for Amazon Comprehend.

Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeResourceInUseException "ResourceInUseException"
The specified name is already in use. Use a different name and try your request
again.

* ErrCodeTooManyTagsException "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.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeResourceLimitExceededException "ResourceLimitExceededException"
The maximum number of recognizers per account has been exceeded. Review the
recognizers, perform cleanup, and then try your request again.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) CreateEntityRecognizer Uses

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

CreateEntityRecognizer API operation for Amazon Comprehend.

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

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

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

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeResourceInUseException "ResourceInUseException"
The specified name is already in use. Use a different name and try your request
again.

* ErrCodeTooManyTagsException "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.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeResourceLimitExceededException "ResourceLimitExceededException"
The maximum number of recognizers per account has been exceeded. Review the
recognizers, perform cleanup, and then try your request again.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DeleteDocumentClassifier Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeResourceUnavailableException "ResourceUnavailableException"
The specified resource is not available. Check to see if the resource is
in the TRAINED state and try your request again.

* ErrCodeResourceInUseException "ResourceInUseException"
The specified name is already in use. Use a different name and try your request
again.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DeleteEntityRecognizer Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeResourceUnavailableException "ResourceUnavailableException"
The specified resource is not available. Check to see if the resource is
in the TRAINED state and try your request again.

* ErrCodeResourceInUseException "ResourceInUseException"
The specified name is already in use. Use a different name and try your request
again.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DescribeDocumentClassificationJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DescribeEntitiesDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DescribeKeyPhrasesDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DescribeSentimentDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DescribeTopicsDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

func (c *Comprehend) DetectEntities(input *DetectEntitiesInput) (*DetectEntitiesOutput, error)

DetectEntities API operation for Amazon Comprehend.

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DetectSentiment Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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, how-syntax.

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTextSizeLimitExceededException "TextSizeLimitExceededException"
The size of the input text exceeds the limit. Use a smaller document.

* ErrCodeUnsupportedLanguageException "UnsupportedLanguageException"
Amazon Comprehend can't process the language of the input text. For all custom
entity recognition APIs (such as CreateEntityRecognizer), only English is
accepted. For most other APIs, such as those for Custom Classification, Amazon
Comprehend accepts text in all supported languages. For a list of supported
languages, see supported-languages.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) ListDocumentClassificationJobs Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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) ListDocumentClassifiers Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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) ListEntitiesDetectionJobs Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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) ListEntityRecognizers Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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) ListKeyPhrasesDetectionJobs Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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) ListSentimentDetectionJobs Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) ListTopicsDetectionJobs Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

* ErrCodeInvalidFilterException "InvalidFilterException"
The filter specified for the operation is invalid. Specify a different filter.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Uses

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) StartDocumentClassificationJob Uses

func (c *Comprehend) StartDocumentClassificationJob(input *StartDocumentClassificationJobInput) (*StartDocumentClassificationJobOutput, error)

StartDocumentClassificationJob API operation for Amazon Comprehend.

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

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

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

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeResourceUnavailableException "ResourceUnavailableException"
The specified resource is not available. Check to see if the resource is
in the TRAINED state and try your request again.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeResourceUnavailableException "ResourceUnavailableException"
The specified resource is not available. Check to see if the resource is
in the TRAINED state and try your request again.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StartKeyPhrasesDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StartSentimentDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StartTopicsDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StopKeyPhrasesDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StopSentimentDetectionJob Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeJobNotFoundException "JobNotFoundException"
The specified job was not found. Check the job ID and try again.

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StopTrainingDocumentClassifier Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeTooManyRequestsException "TooManyRequestsException"
The number of requests exceeds the limit. Resubmit your request later.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
Concurrent modification of the tags associated with an Amazon Comprehend
resource is not supported.

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

* ErrCodeTooManyTagsException "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.

* ErrCodeInternalServerException "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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
Concurrent modification of the tags associated with an Amazon Comprehend
resource is not supported.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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.

type CreateDocumentClassifierInput Uses

type CreateDocumentClassifierInput struct {

    // A unique identifier for the request. If you don't set the client request
    // token, Amazon Comprehend generates one.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
    // that grants Amazon Comprehend read access to your input data.
    //
    // DataAccessRoleArn is a required field
    DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

    // The name of the document classifier.
    //
    // DocumentClassifierName is a required field
    DocumentClassifierName *string `type:"string" required:"true"`

    // Specifies the format and location of the input data for the job.
    //
    // InputDataConfig is a required field
    InputDataConfig *DocumentClassifierInputDataConfig `type:"structure" required:"true"`

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

    // Enables the addition of output results configuration parameters for custom
    // classifier jobs.
    OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

    // Tags to be associated with the document classifier being created. A tag is
    // a key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
    // For example, a tag with "Sales" as the key might be added to a resource to
    // indicate its use by the sales department.
    Tags []*Tag `type:"list"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

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

func (CreateDocumentClassifierInput) GoString Uses

func (s CreateDocumentClassifierInput) GoString() string

GoString returns the string representation

func (*CreateDocumentClassifierInput) SetClientRequestToken Uses

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDocumentClassifierInput) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateDocumentClassifierInput) SetDocumentClassifierName Uses

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

SetDocumentClassifierName sets the DocumentClassifierName field's value.

func (*CreateDocumentClassifierInput) SetInputDataConfig Uses

func (s *CreateDocumentClassifierInput) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *CreateDocumentClassifierInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*CreateDocumentClassifierInput) SetOutputDataConfig Uses

func (s *CreateDocumentClassifierInput) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *CreateDocumentClassifierInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*CreateDocumentClassifierInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CreateDocumentClassifierInput) SetVolumeKmsKeyId Uses

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

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateDocumentClassifierInput) SetVpcConfig Uses

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

SetVpcConfig sets the VpcConfig field's value.

func (CreateDocumentClassifierInput) String Uses

func (s CreateDocumentClassifierInput) String() string

String returns the string representation

func (*CreateDocumentClassifierInput) Validate Uses

func (s *CreateDocumentClassifierInput) Validate() error

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

type CreateDocumentClassifierOutput Uses

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 Uses

func (s CreateDocumentClassifierOutput) GoString() string

GoString returns the string representation

func (*CreateDocumentClassifierOutput) SetDocumentClassifierArn Uses

func (s *CreateDocumentClassifierOutput) SetDocumentClassifierArn(v string) *CreateDocumentClassifierOutput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (CreateDocumentClassifierOutput) String Uses

func (s CreateDocumentClassifierOutput) String() string

String returns the string representation

type CreateEntityRecognizerInput Uses

type CreateEntityRecognizerInput struct {

    // A unique identifier for the request. If you don't set the client request
    // token, Amazon Comprehend generates one.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
    // that grants Amazon Comprehend read access to your input data.
    //
    // DataAccessRoleArn is a required field
    DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

    // Specifies the format and location of the input data. The S3 bucket containing
    // the input data must be located in the same region as the entity recognizer
    // being created.
    //
    // InputDataConfig is a required field
    InputDataConfig *EntityRecognizerInputDataConfig `type:"structure" required:"true"`

    // The language of the input documents. All documents must be in the same language.
    // Only English ("en") is currently supported.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // The name given to the newly created recognizer. Recognizer names can be a
    // maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
    // (_) are allowed. The name must be unique in the account/region.
    //
    // RecognizerName is a required field
    RecognizerName *string `type:"string" required:"true"`

    // Tags to be associated with the entity recognizer being created. A tag is
    // a key-value pair that adds as a metadata to a resource used by Amazon Comprehend.
    // For example, a tag with "Sales" as the key might be added to a resource to
    // indicate its use by the sales department.
    Tags []*Tag `type:"list"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

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

func (CreateEntityRecognizerInput) GoString Uses

func (s CreateEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*CreateEntityRecognizerInput) SetClientRequestToken Uses

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateEntityRecognizerInput) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*CreateEntityRecognizerInput) SetInputDataConfig Uses

func (s *CreateEntityRecognizerInput) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *CreateEntityRecognizerInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*CreateEntityRecognizerInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*CreateEntityRecognizerInput) SetRecognizerName Uses

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

SetRecognizerName sets the RecognizerName field's value.

func (*CreateEntityRecognizerInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CreateEntityRecognizerInput) SetVolumeKmsKeyId Uses

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

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*CreateEntityRecognizerInput) SetVpcConfig Uses

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

SetVpcConfig sets the VpcConfig field's value.

func (CreateEntityRecognizerInput) String Uses

func (s CreateEntityRecognizerInput) String() string

String returns the string representation

func (*CreateEntityRecognizerInput) Validate Uses

func (s *CreateEntityRecognizerInput) Validate() error

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

type CreateEntityRecognizerOutput Uses

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 Uses

func (s CreateEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (*CreateEntityRecognizerOutput) SetEntityRecognizerArn Uses

func (s *CreateEntityRecognizerOutput) SetEntityRecognizerArn(v string) *CreateEntityRecognizerOutput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (CreateEntityRecognizerOutput) String Uses

func (s CreateEntityRecognizerOutput) String() string

String returns the string representation

type DeleteDocumentClassifierInput Uses

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 Uses

func (s DeleteDocumentClassifierInput) GoString() string

GoString returns the string representation

func (*DeleteDocumentClassifierInput) SetDocumentClassifierArn Uses

func (s *DeleteDocumentClassifierInput) SetDocumentClassifierArn(v string) *DeleteDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DeleteDocumentClassifierInput) String Uses

func (s DeleteDocumentClassifierInput) String() string

String returns the string representation

func (*DeleteDocumentClassifierInput) Validate Uses

func (s *DeleteDocumentClassifierInput) Validate() error

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

type DeleteDocumentClassifierOutput Uses

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

func (DeleteDocumentClassifierOutput) GoString Uses

func (s DeleteDocumentClassifierOutput) GoString() string

GoString returns the string representation

func (DeleteDocumentClassifierOutput) String Uses

func (s DeleteDocumentClassifierOutput) String() string

String returns the string representation

type DeleteEntityRecognizerInput Uses

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 Uses

func (s DeleteEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*DeleteEntityRecognizerInput) SetEntityRecognizerArn Uses

func (s *DeleteEntityRecognizerInput) SetEntityRecognizerArn(v string) *DeleteEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DeleteEntityRecognizerInput) String Uses

func (s DeleteEntityRecognizerInput) String() string

String returns the string representation

func (*DeleteEntityRecognizerInput) Validate Uses

func (s *DeleteEntityRecognizerInput) Validate() error

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

type DeleteEntityRecognizerOutput Uses

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

func (DeleteEntityRecognizerOutput) GoString Uses

func (s DeleteEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (DeleteEntityRecognizerOutput) String Uses

func (s DeleteEntityRecognizerOutput) String() string

String returns the string representation

type DescribeDocumentClassificationJobInput Uses

type DescribeDocumentClassificationJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeDocumentClassificationJobInput) GoString Uses

func (s DescribeDocumentClassificationJobInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassificationJobInput) SetJobId Uses

func (s *DescribeDocumentClassificationJobInput) SetJobId(v string) *DescribeDocumentClassificationJobInput

SetJobId sets the JobId field's value.

func (DescribeDocumentClassificationJobInput) String Uses

func (s DescribeDocumentClassificationJobInput) String() string

String returns the string representation

func (*DescribeDocumentClassificationJobInput) Validate Uses

func (s *DescribeDocumentClassificationJobInput) Validate() error

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

type DescribeDocumentClassificationJobOutput Uses

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 Uses

func (s DescribeDocumentClassificationJobOutput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties Uses

func (s *DescribeDocumentClassificationJobOutput) SetDocumentClassificationJobProperties(v *DocumentClassificationJobProperties) *DescribeDocumentClassificationJobOutput

SetDocumentClassificationJobProperties sets the DocumentClassificationJobProperties field's value.

func (DescribeDocumentClassificationJobOutput) String Uses

func (s DescribeDocumentClassificationJobOutput) String() string

String returns the string representation

type DescribeDocumentClassifierInput Uses

type DescribeDocumentClassifierInput struct {

    // The Amazon Resource Name (ARN) that identifies the document classifier. The
    // operation returns this identifier in its response.
    //
    // DocumentClassifierArn is a required field
    DocumentClassifierArn *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeDocumentClassifierInput) GoString Uses

func (s DescribeDocumentClassifierInput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassifierInput) SetDocumentClassifierArn Uses

func (s *DescribeDocumentClassifierInput) SetDocumentClassifierArn(v string) *DescribeDocumentClassifierInput

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (DescribeDocumentClassifierInput) String Uses

func (s DescribeDocumentClassifierInput) String() string

String returns the string representation

func (*DescribeDocumentClassifierInput) Validate Uses

func (s *DescribeDocumentClassifierInput) Validate() error

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

type DescribeDocumentClassifierOutput Uses

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 Uses

func (s DescribeDocumentClassifierOutput) GoString() string

GoString returns the string representation

func (*DescribeDocumentClassifierOutput) SetDocumentClassifierProperties Uses

func (s *DescribeDocumentClassifierOutput) SetDocumentClassifierProperties(v *DocumentClassifierProperties) *DescribeDocumentClassifierOutput

SetDocumentClassifierProperties sets the DocumentClassifierProperties field's value.

func (DescribeDocumentClassifierOutput) String Uses

func (s DescribeDocumentClassifierOutput) String() string

String returns the string representation

type DescribeDominantLanguageDetectionJobInput Uses

type DescribeDominantLanguageDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeDominantLanguageDetectionJobInput) GoString Uses

func (s DescribeDominantLanguageDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) SetJobId Uses

func (s *DescribeDominantLanguageDetectionJobInput) SetJobId(v string) *DescribeDominantLanguageDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeDominantLanguageDetectionJobInput) String Uses

func (s DescribeDominantLanguageDetectionJobInput) String() string

String returns the string representation

func (*DescribeDominantLanguageDetectionJobInput) Validate Uses

func (s *DescribeDominantLanguageDetectionJobInput) Validate() error

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

type DescribeDominantLanguageDetectionJobOutput Uses

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 Uses

func (s DescribeDominantLanguageDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties Uses

func (s *DescribeDominantLanguageDetectionJobOutput) SetDominantLanguageDetectionJobProperties(v *DominantLanguageDetectionJobProperties) *DescribeDominantLanguageDetectionJobOutput

SetDominantLanguageDetectionJobProperties sets the DominantLanguageDetectionJobProperties field's value.

func (DescribeDominantLanguageDetectionJobOutput) String Uses

func (s DescribeDominantLanguageDetectionJobOutput) String() string

String returns the string representation

type DescribeEntitiesDetectionJobInput Uses

type DescribeEntitiesDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeEntitiesDetectionJobInput) GoString Uses

func (s DescribeEntitiesDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionJobInput) SetJobId Uses

func (s *DescribeEntitiesDetectionJobInput) SetJobId(v string) *DescribeEntitiesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionJobInput) String Uses

func (s DescribeEntitiesDetectionJobInput) String() string

String returns the string representation

func (*DescribeEntitiesDetectionJobInput) Validate Uses

func (s *DescribeEntitiesDetectionJobInput) Validate() error

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

type DescribeEntitiesDetectionJobOutput Uses

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 Uses

func (s DescribeEntitiesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties Uses

func (s *DescribeEntitiesDetectionJobOutput) SetEntitiesDetectionJobProperties(v *EntitiesDetectionJobProperties) *DescribeEntitiesDetectionJobOutput

SetEntitiesDetectionJobProperties sets the EntitiesDetectionJobProperties field's value.

func (DescribeEntitiesDetectionJobOutput) String Uses

func (s DescribeEntitiesDetectionJobOutput) String() string

String returns the string representation

type DescribeEntityRecognizerInput Uses

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 Uses

func (s DescribeEntityRecognizerInput) GoString() string

GoString returns the string representation

func (*DescribeEntityRecognizerInput) SetEntityRecognizerArn Uses

func (s *DescribeEntityRecognizerInput) SetEntityRecognizerArn(v string) *DescribeEntityRecognizerInput

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (DescribeEntityRecognizerInput) String Uses

func (s DescribeEntityRecognizerInput) String() string

String returns the string representation

func (*DescribeEntityRecognizerInput) Validate Uses

func (s *DescribeEntityRecognizerInput) Validate() error

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

type DescribeEntityRecognizerOutput Uses

type DescribeEntityRecognizerOutput struct {

    // Describes information associated with an entity recognizer.
    EntityRecognizerProperties *EntityRecognizerProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeEntityRecognizerOutput) GoString Uses

func (s DescribeEntityRecognizerOutput) GoString() string

GoString returns the string representation

func (*DescribeEntityRecognizerOutput) SetEntityRecognizerProperties Uses

func (s *DescribeEntityRecognizerOutput) SetEntityRecognizerProperties(v *EntityRecognizerProperties) *DescribeEntityRecognizerOutput

SetEntityRecognizerProperties sets the EntityRecognizerProperties field's value.

func (DescribeEntityRecognizerOutput) String Uses

func (s DescribeEntityRecognizerOutput) String() string

String returns the string representation

type DescribeKeyPhrasesDetectionJobInput Uses

type DescribeKeyPhrasesDetectionJobInput struct {

    // The identifier that Amazon Comprehend generated for the job. The operation
    // returns this identifier in its response.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeKeyPhrasesDetectionJobInput) GoString Uses

func (s DescribeKeyPhrasesDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) SetJobId Uses

func (s *DescribeKeyPhrasesDetectionJobInput) SetJobId(v string) *DescribeKeyPhrasesDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeKeyPhrasesDetectionJobInput) String Uses

func (s DescribeKeyPhrasesDetectionJobInput) String() string

String returns the string representation

func (*DescribeKeyPhrasesDetectionJobInput) Validate Uses

func (s *DescribeKeyPhrasesDetectionJobInput) Validate() error

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

type DescribeKeyPhrasesDetectionJobOutput Uses

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 Uses

func (s DescribeKeyPhrasesDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties Uses

func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperties(v *KeyPhrasesDetectionJobProperties) *DescribeKeyPhrasesDetectionJobOutput

SetKeyPhrasesDetectionJobProperties sets the KeyPhrasesDetectionJobProperties field's value.

func (DescribeKeyPhrasesDetectionJobOutput) String Uses

func (s DescribeKeyPhrasesDetectionJobOutput) String() string

String returns the string representation

type DescribeSentimentDetectionJobInput Uses

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 Uses

func (s DescribeSentimentDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeSentimentDetectionJobInput) SetJobId Uses

func (s *DescribeSentimentDetectionJobInput) SetJobId(v string) *DescribeSentimentDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeSentimentDetectionJobInput) String Uses

func (s DescribeSentimentDetectionJobInput) String() string

String returns the string representation

func (*DescribeSentimentDetectionJobInput) Validate Uses

func (s *DescribeSentimentDetectionJobInput) Validate() error

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

type DescribeSentimentDetectionJobOutput Uses

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 Uses

func (s DescribeSentimentDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties Uses

func (s *DescribeSentimentDetectionJobOutput) SetSentimentDetectionJobProperties(v *SentimentDetectionJobProperties) *DescribeSentimentDetectionJobOutput

SetSentimentDetectionJobProperties sets the SentimentDetectionJobProperties field's value.

func (DescribeSentimentDetectionJobOutput) String Uses

func (s DescribeSentimentDetectionJobOutput) String() string

String returns the string representation

type DescribeTopicsDetectionJobInput Uses

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 Uses

func (s DescribeTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobInput) SetJobId Uses

func (s *DescribeTopicsDetectionJobInput) SetJobId(v string) *DescribeTopicsDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribeTopicsDetectionJobInput) String Uses

func (s DescribeTopicsDetectionJobInput) String() string

String returns the string representation

func (*DescribeTopicsDetectionJobInput) Validate Uses

func (s *DescribeTopicsDetectionJobInput) Validate() error

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

type DescribeTopicsDetectionJobOutput Uses

type DescribeTopicsDetectionJobOutput struct {

    // The list of properties for the requested job.
    TopicsDetectionJobProperties *TopicsDetectionJobProperties `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobOutput) GoString Uses

func (s DescribeTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties Uses

func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *TopicsDetectionJobProperties) *DescribeTopicsDetectionJobOutput

SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value.

func (DescribeTopicsDetectionJobOutput) String Uses

func (s DescribeTopicsDetectionJobOutput) String() string

String returns the string representation

type DetectDominantLanguageInput Uses

type DetectDominantLanguageInput struct {

    // A UTF-8 text string. Each string should contain at least 20 characters and
    // must contain fewer that 5,000 bytes of UTF-8 encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectDominantLanguageInput) GoString Uses

func (s DetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageInput) SetText Uses

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

SetText sets the Text field's value.

func (DetectDominantLanguageInput) String Uses

func (s DetectDominantLanguageInput) String() string

String returns the string representation

func (*DetectDominantLanguageInput) Validate Uses

func (s *DetectDominantLanguageInput) Validate() error

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

type DetectDominantLanguageOutput Uses

type DetectDominantLanguageOutput struct {

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

func (DetectDominantLanguageOutput) GoString Uses

func (s DetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageOutput) SetLanguages Uses

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

SetLanguages sets the Languages field's value.

func (DetectDominantLanguageOutput) String Uses

func (s DetectDominantLanguageOutput) String() string

String returns the string representation

type DetectEntitiesInput Uses

type DetectEntitiesInput struct {

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

    // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
    // encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectEntitiesInput) GoString Uses

func (s DetectEntitiesInput) GoString() string

GoString returns the string representation

func (*DetectEntitiesInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectEntitiesInput) SetText Uses

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

SetText sets the Text field's value.

func (DetectEntitiesInput) String Uses

func (s DetectEntitiesInput) String() string

String returns the string representation

func (*DetectEntitiesInput) Validate Uses

func (s *DetectEntitiesInput) Validate() error

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

type DetectEntitiesOutput Uses

type DetectEntitiesOutput struct {

    // A collection of entities identified in the input text. For each entity, the
    // response provides the entity text, entity type, where the entity text begins
    // and ends, and the level of confidence that Amazon Comprehend has in the detection.
    // For a list of entity types, see how-entities.
    Entities []*Entity `type:"list"`
    // contains filtered or unexported fields
}

func (DetectEntitiesOutput) GoString Uses

func (s DetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*DetectEntitiesOutput) SetEntities Uses

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

SetEntities sets the Entities field's value.

func (DetectEntitiesOutput) String Uses

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectKeyPhrasesInput Uses

type DetectKeyPhrasesInput struct {

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

    // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
    // encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectKeyPhrasesInput) GoString Uses

func (s DetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectKeyPhrasesInput) SetText Uses

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

SetText sets the Text field's value.

func (DetectKeyPhrasesInput) String Uses

func (s DetectKeyPhrasesInput) String() string

String returns the string representation

func (*DetectKeyPhrasesInput) Validate Uses

func (s *DetectKeyPhrasesInput) Validate() error

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

type DetectKeyPhrasesOutput Uses

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 Uses

func (s DetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesOutput) SetKeyPhrases Uses

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

SetKeyPhrases sets the KeyPhrases field's value.

func (DetectKeyPhrasesOutput) String Uses

func (s DetectKeyPhrasesOutput) String() string

String returns the string representation

type DetectSentimentInput Uses

type DetectSentimentInput struct {

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

    // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
    // encoded characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectSentimentInput) GoString Uses

func (s DetectSentimentInput) GoString() string

GoString returns the string representation

func (*DetectSentimentInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSentimentInput) SetText Uses

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

SetText sets the Text field's value.

func (DetectSentimentInput) String Uses

func (s DetectSentimentInput) String() string

String returns the string representation

func (*DetectSentimentInput) Validate Uses

func (s *DetectSentimentInput) Validate() error

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

type DetectSentimentOutput Uses

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 Uses

func (s DetectSentimentOutput) GoString() string

GoString returns the string representation

func (*DetectSentimentOutput) SetSentiment Uses

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

SetSentiment sets the Sentiment field's value.

func (*DetectSentimentOutput) SetSentimentScore Uses

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

SetSentimentScore sets the SentimentScore field's value.

func (DetectSentimentOutput) String Uses

func (s DetectSentimentOutput) String() string

String returns the string representation

type DetectSyntaxInput Uses

type DetectSyntaxInput struct {

    // The language code of the input documents. You can specify any of the primary
    // 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. Each string must contain fewer that 5,000 bytes of UTF encoded
    // characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectSyntaxInput) GoString Uses

func (s DetectSyntaxInput) GoString() string

GoString returns the string representation

func (*DetectSyntaxInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSyntaxInput) SetText Uses

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

SetText sets the Text field's value.

func (DetectSyntaxInput) String Uses

func (s DetectSyntaxInput) String() string

String returns the string representation

func (*DetectSyntaxInput) Validate Uses

func (s *DetectSyntaxInput) Validate() error

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

type DetectSyntaxOutput Uses

type DetectSyntaxOutput struct {

    // A collection of syntax tokens describing the text. For each token, the response
    // provides the text, the token type, where the text begins and ends, and the
    // level of confidence that Amazon Comprehend has that the token is correct.
    // For a list of token types, see how-syntax.
    SyntaxTokens []*SyntaxToken `type:"list"`
    // contains filtered or unexported fields
}

func (DetectSyntaxOutput) GoString Uses

func (s DetectSyntaxOutput) GoString() string

GoString returns the string representation

func (*DetectSyntaxOutput) SetSyntaxTokens Uses

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

SetSyntaxTokens sets the SyntaxTokens field's value.

func (DetectSyntaxOutput) String Uses

func (s DetectSyntaxOutput) String() string

String returns the string representation

type DocumentClassificationJobFilter Uses

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 before 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 after 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 Uses

func (s DocumentClassificationJobFilter) GoString() string

GoString returns the string representation

func (*DocumentClassificationJobFilter) SetJobName Uses

func (s *DocumentClassificationJobFilter) SetJobName(v string) *DocumentClassificationJobFilter

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobFilter) SetJobStatus Uses

func (s *DocumentClassificationJobFilter) SetJobStatus(v string) *DocumentClassificationJobFilter

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeAfter Uses

func (s *DocumentClassificationJobFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassificationJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassificationJobFilter) SetSubmitTimeBefore Uses

func (s *DocumentClassificationJobFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassificationJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassificationJobFilter) String Uses

func (s DocumentClassificationJobFilter) String() string

String returns the string representation

func (*DocumentClassificationJobFilter) Validate Uses

func (s *DocumentClassificationJobFilter) Validate() error

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

type DocumentClassificationJobProperties Uses

type DocumentClassificationJobProperties struct {

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

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

    // The time that the document classification job completed.
    EndTime *time.Time `type:"timestamp"`

    // The input data configuration that you supplied when you created the document
    // classification job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the document classification job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned to the document classification job.
    JobName *string `min:"1" type:"string"`

    // The current status of the document classification job. If the status is FAILED,
    // the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

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

    // The output data configuration that you supplied when you created the document
    // classification job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the document classification job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your document classification job. For more
    // information, see Amazon VPC (https://docs.aws.amazon.com/vpc/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 Uses

func (s DocumentClassificationJobProperties) GoString() string

GoString returns the string representation

func (*DocumentClassificationJobProperties) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassificationJobProperties) SetDocumentClassifierArn Uses

func (s *DocumentClassificationJobProperties) SetDocumentClassifierArn(v string) *DocumentClassificationJobProperties

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassificationJobProperties) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*DocumentClassificationJobProperties) SetInputDataConfig Uses

func (s *DocumentClassificationJobProperties) SetInputDataConfig(v *InputDataConfig) *DocumentClassificationJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetJobId Uses

func (s *DocumentClassificationJobProperties) SetJobId(v string) *DocumentClassificationJobProperties

SetJobId sets the JobId field's value.

func (*DocumentClassificationJobProperties) SetJobName Uses

func (s *DocumentClassificationJobProperties) SetJobName(v string) *DocumentClassificationJobProperties

SetJobName sets the JobName field's value.

func (*DocumentClassificationJobProperties) SetJobStatus Uses

func (s *DocumentClassificationJobProperties) SetJobStatus(v string) *DocumentClassificationJobProperties

SetJobStatus sets the JobStatus field's value.

func (*DocumentClassificationJobProperties) SetMessage Uses

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

SetMessage sets the Message field's value.

func (*DocumentClassificationJobProperties) SetOutputDataConfig Uses

func (s *DocumentClassificationJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DocumentClassificationJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassificationJobProperties) SetSubmitTime Uses

func (s *DocumentClassificationJobProperties) SetSubmitTime(v time.Time) *DocumentClassificationJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassificationJobProperties) SetVolumeKmsKeyId Uses

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

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassificationJobProperties) SetVpcConfig Uses

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

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassificationJobProperties) String Uses

func (s DocumentClassificationJobProperties) String() string

String returns the string representation

type DocumentClassifierFilter Uses

type DocumentClassifierFilter struct {

    // Filters the list of classifiers based on status.
    Status *string `type:"string" enum:"ModelStatus"`

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

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

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

func (DocumentClassifierFilter) GoString Uses

func (s DocumentClassifierFilter) GoString() string

GoString returns the string representation

func (*DocumentClassifierFilter) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*DocumentClassifierFilter) SetSubmitTimeAfter Uses

func (s *DocumentClassifierFilter) SetSubmitTimeAfter(v time.Time) *DocumentClassifierFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DocumentClassifierFilter) SetSubmitTimeBefore Uses

func (s *DocumentClassifierFilter) SetSubmitTimeBefore(v time.Time) *DocumentClassifierFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DocumentClassifierFilter) String Uses

func (s DocumentClassifierFilter) String() string

String returns the string representation

type DocumentClassifierInputDataConfig Uses

type DocumentClassifierInputDataConfig struct {

    // 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.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

The input properties for training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data.

func (DocumentClassifierInputDataConfig) GoString Uses

func (s DocumentClassifierInputDataConfig) GoString() string

GoString returns the string representation

func (*DocumentClassifierInputDataConfig) SetS3Uri Uses

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

SetS3Uri sets the S3Uri field's value.

func (DocumentClassifierInputDataConfig) String Uses

func (s DocumentClassifierInputDataConfig) String() string

String returns the string representation

func (*DocumentClassifierInputDataConfig) Validate Uses

func (s *DocumentClassifierInputDataConfig) Validate() error

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

type DocumentClassifierOutputDataConfig Uses

type DocumentClassifierOutputDataConfig struct {

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

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

Provides output results configuration parameters for custom classifier jobs.

func (DocumentClassifierOutputDataConfig) GoString Uses

func (s DocumentClassifierOutputDataConfig) GoString() string

GoString returns the string representation

func (*DocumentClassifierOutputDataConfig) SetKmsKeyId Uses

func (s *DocumentClassifierOutputDataConfig) SetKmsKeyId(v string) *DocumentClassifierOutputDataConfig

SetKmsKeyId sets the KmsKeyId field's value.

func (*DocumentClassifierOutputDataConfig) SetS3Uri Uses

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

SetS3Uri sets the S3Uri field's value.

func (DocumentClassifierOutputDataConfig) String Uses

func (s DocumentClassifierOutputDataConfig) String() string

String returns the string representation

type DocumentClassifierProperties Uses

type DocumentClassifierProperties struct {

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

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

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

    // The time that training the document classifier completed.
    EndTime *time.Time `type:"timestamp"`

    // The input data configuration that you supplied when you created the document
    // classifier for training.
    InputDataConfig *DocumentClassifierInputDataConfig `type:"structure"`

    // The language code for the language of the documents that the classifier was
    // trained on.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // Additional information about the status of the classifier.
    Message *string `type:"string"`

    // Provides output results configuration parameters for custom classifier jobs.
    OutputDataConfig *DocumentClassifierOutputDataConfig `type:"structure"`

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

    // The time that the document classifier was submitted for training.
    SubmitTime *time.Time `type:"timestamp"`

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

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

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your custom classifier. For more information,
    // see Amazon VPC (https://docs.aws.amazon.com/vpc/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 Uses

func (s DocumentClassifierProperties) GoString() string

GoString returns the string representation

func (*DocumentClassifierProperties) SetClassifierMetadata Uses

func (s *DocumentClassifierProperties) SetClassifierMetadata(v *ClassifierMetadata) *DocumentClassifierProperties

SetClassifierMetadata sets the ClassifierMetadata field's value.

func (*DocumentClassifierProperties) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DocumentClassifierProperties) SetDocumentClassifierArn Uses

func (s *DocumentClassifierProperties) SetDocumentClassifierArn(v string) *DocumentClassifierProperties

SetDocumentClassifierArn sets the DocumentClassifierArn field's value.

func (*DocumentClassifierProperties) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*DocumentClassifierProperties) SetInputDataConfig Uses

func (s *DocumentClassifierProperties) SetInputDataConfig(v *DocumentClassifierInputDataConfig) *DocumentClassifierProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DocumentClassifierProperties) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*DocumentClassifierProperties) SetMessage Uses

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

SetMessage sets the Message field's value.

func (*DocumentClassifierProperties) SetOutputDataConfig Uses

func (s *DocumentClassifierProperties) SetOutputDataConfig(v *DocumentClassifierOutputDataConfig) *DocumentClassifierProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DocumentClassifierProperties) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*DocumentClassifierProperties) SetSubmitTime Uses

func (s *DocumentClassifierProperties) SetSubmitTime(v time.Time) *DocumentClassifierProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DocumentClassifierProperties) SetTrainingEndTime Uses

func (s *DocumentClassifierProperties) SetTrainingEndTime(v time.Time) *DocumentClassifierProperties

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*DocumentClassifierProperties) SetTrainingStartTime Uses

func (s *DocumentClassifierProperties) SetTrainingStartTime(v time.Time) *DocumentClassifierProperties

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*DocumentClassifierProperties) SetVolumeKmsKeyId Uses

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

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DocumentClassifierProperties) SetVpcConfig Uses

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

SetVpcConfig sets the VpcConfig field's value.

func (DocumentClassifierProperties) String Uses

func (s DocumentClassifierProperties) String() string

String returns the string representation

type DominantLanguage Uses

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 Uses

func (s DominantLanguage) GoString() string

GoString returns the string representation

func (*DominantLanguage) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*DominantLanguage) SetScore Uses

func (s *DominantLanguage) SetScore(v float64) *DominantLanguage

SetScore sets the Score field's value.

func (DominantLanguage) String Uses

func (s DominantLanguage) String() string

String returns the string representation

type DominantLanguageDetectionJobFilter Uses

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 Uses

func (s DominantLanguageDetectionJobFilter) GoString() string

GoString returns the string representation

func (*DominantLanguageDetectionJobFilter) SetJobName Uses

func (s *DominantLanguageDetectionJobFilter) SetJobName(v string) *DominantLanguageDetectionJobFilter

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobFilter) SetJobStatus Uses

func (s *DominantLanguageDetectionJobFilter) SetJobStatus(v string) *DominantLanguageDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeAfter Uses

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*DominantLanguageDetectionJobFilter) SetSubmitTimeBefore Uses

func (s *DominantLanguageDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *DominantLanguageDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (DominantLanguageDetectionJobFilter) String Uses

func (s DominantLanguageDetectionJobFilter) String() string

String returns the string representation

func (*DominantLanguageDetectionJobFilter) Validate Uses

func (s *DominantLanguageDetectionJobFilter) Validate() error

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

type DominantLanguageDetectionJobProperties Uses

type DominantLanguageDetectionJobProperties struct {

    // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
    // your input data.
    DataAccessRoleArn *string `min:"20" type:"string"`

    // The time that the dominant language detection job completed.
    EndTime *time.Time `type:"timestamp"`

    // The input data configuration that you supplied when you created the dominant
    // language detection job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the dominant language detection job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned to the dominant language detection job.
    JobName *string `min:"1" type:"string"`

    // The current status of the dominant language detection job. If the status
    // is FAILED, the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // A description for the status of a job.
    Message *string `type:"string"`

    // The output data configuration that you supplied when you created the dominant
    // language detection job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the dominant language detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

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

Provides information about a dominant language detection job.

func (DominantLanguageDetectionJobProperties) GoString Uses

func (s DominantLanguageDetectionJobProperties) GoString() string

GoString returns the string representation

func (*DominantLanguageDetectionJobProperties) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*DominantLanguageDetectionJobProperties) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*DominantLanguageDetectionJobProperties) SetInputDataConfig Uses

func (s *DominantLanguageDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *DominantLanguageDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetJobId Uses

func (s *DominantLanguageDetectionJobProperties) SetJobId(v string) *DominantLanguageDetectionJobProperties

SetJobId sets the JobId field's value.

func (*DominantLanguageDetectionJobProperties) SetJobName Uses

func (s *DominantLanguageDetectionJobProperties) SetJobName(v string) *DominantLanguageDetectionJobProperties

SetJobName sets the JobName field's value.

func (*DominantLanguageDetectionJobProperties) SetJobStatus Uses

func (s *DominantLanguageDetectionJobProperties) SetJobStatus(v string) *DominantLanguageDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*DominantLanguageDetectionJobProperties) SetMessage Uses

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

SetMessage sets the Message field's value.

func (*DominantLanguageDetectionJobProperties) SetOutputDataConfig Uses

func (s *DominantLanguageDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *DominantLanguageDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*DominantLanguageDetectionJobProperties) SetSubmitTime Uses

func (s *DominantLanguageDetectionJobProperties) SetSubmitTime(v time.Time) *DominantLanguageDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*DominantLanguageDetectionJobProperties) SetVolumeKmsKeyId Uses

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

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*DominantLanguageDetectionJobProperties) SetVpcConfig Uses

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

SetVpcConfig sets the VpcConfig field's value.

func (DominantLanguageDetectionJobProperties) String Uses

func (s DominantLanguageDetectionJobProperties) String() string

String returns the string representation

type EntitiesDetectionJobFilter Uses

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 Uses

func (s EntitiesDetectionJobFilter) GoString() string

GoString returns the string representation

func (*EntitiesDetectionJobFilter) SetJobName Uses

func (s *EntitiesDetectionJobFilter) SetJobName(v string) *EntitiesDetectionJobFilter

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobFilter) SetJobStatus Uses

func (s *EntitiesDetectionJobFilter) SetJobStatus(v string) *EntitiesDetectionJobFilter

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeAfter Uses

func (s *EntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntitiesDetectionJobFilter) SetSubmitTimeBefore Uses

func (s *EntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *EntitiesDetectionJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntitiesDetectionJobFilter) String Uses

func (s EntitiesDetectionJobFilter) String() string

String returns the string representation

func (*EntitiesDetectionJobFilter) Validate Uses

func (s *EntitiesDetectionJobFilter) Validate() error

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

type EntitiesDetectionJobProperties Uses

type EntitiesDetectionJobProperties struct {

    // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to
    // your input data.
    DataAccessRoleArn *string `min:"20" type:"string"`

    // The time that the entities detection job completed
    EndTime *time.Time `type:"timestamp"`

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

    // The input data configuration that you supplied when you created the entities
    // detection job.
    InputDataConfig *InputDataConfig `type:"structure"`

    // The identifier assigned to the entities detection job.
    JobId *string `min:"1" type:"string"`

    // The name that you assigned the entities detection job.
    JobName *string `min:"1" type:"string"`

    // The current status of the entities detection job. If the status is FAILED,
    // the Message field shows the reason for the failure.
    JobStatus *string `type:"string" enum:"JobStatus"`

    // The language code of the input documents.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

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

    // The output data configuration that you supplied when you created the entities
    // detection job.
    OutputDataConfig *OutputDataConfig `type:"structure"`

    // The time that the entities detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp"`

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

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

Provides information about an entities detection job.

func (EntitiesDetectionJobProperties) GoString Uses

func (s EntitiesDetectionJobProperties) GoString() string

GoString returns the string representation

func (*EntitiesDetectionJobProperties) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntitiesDetectionJobProperties) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*EntitiesDetectionJobProperties) SetEntityRecognizerArn Uses

func (s *EntitiesDetectionJobProperties) SetEntityRecognizerArn(v string) *EntitiesDetectionJobProperties

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntitiesDetectionJobProperties) SetInputDataConfig Uses

func (s *EntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *EntitiesDetectionJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetJobId Uses

func (s *EntitiesDetectionJobProperties) SetJobId(v string) *EntitiesDetectionJobProperties

SetJobId sets the JobId field's value.

func (*EntitiesDetectionJobProperties) SetJobName Uses

func (s *EntitiesDetectionJobProperties) SetJobName(v string) *EntitiesDetectionJobProperties

SetJobName sets the JobName field's value.

func (*EntitiesDetectionJobProperties) SetJobStatus Uses

func (s *EntitiesDetectionJobProperties) SetJobStatus(v string) *EntitiesDetectionJobProperties

SetJobStatus sets the JobStatus field's value.

func (*EntitiesDetectionJobProperties) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*EntitiesDetectionJobProperties) SetMessage Uses

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

SetMessage sets the Message field's value.

func (*EntitiesDetectionJobProperties) SetOutputDataConfig Uses

func (s *EntitiesDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *EntitiesDetectionJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*EntitiesDetectionJobProperties) SetSubmitTime Uses

func (s *EntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *EntitiesDetectionJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (*EntitiesDetectionJobProperties) SetVolumeKmsKeyId Uses

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

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntitiesDetectionJobProperties) SetVpcConfig Uses

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

SetVpcConfig sets the VpcConfig field's value.

func (EntitiesDetectionJobProperties) String Uses

func (s EntitiesDetectionJobProperties) String() string

String returns the string representation

type Entity Uses

type Entity struct {

    // A character offset in the input text that shows where the entity begins (the
    // first character is at position 0). The offset returns the position of each
    // UTF-8 code point in the string. A code point is the abstract character from
    // a particular graphical representation. For example, a multi-byte UTF-8 character
    // maps to a single code point.
    BeginOffset *int64 `type:"integer"`

    // A character offset in the input text that shows where the entity ends. The
    // offset returns the position of each UTF-8 code point in the string. A code
    // point is the abstract character from a particular graphical representation.
    // For example, a multi-byte UTF-8 character maps to a single code point.
    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's type.
    Type *string `type:"string" enum:"EntityType"`
    // contains filtered or unexported fields
}

Provides information about an entity.

func (Entity) GoString Uses

func (s Entity) GoString() string

GoString returns the string representation

func (*Entity) SetBeginOffset Uses

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

SetBeginOffset sets the BeginOffset field's value.

func (*Entity) SetEndOffset Uses

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

SetEndOffset sets the EndOffset field's value.

func (*Entity) SetScore Uses

func (s *Entity) SetScore(v float64) *Entity

SetScore sets the Score field's value.

func (*Entity) SetText Uses

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

SetText sets the Text field's value.

func (*Entity) SetType Uses

func (s *Entity) SetType(v string) *Entity

SetType sets the Type field's value.

func (Entity) String Uses

func (s Entity) String() string

String returns the string representation

type EntityRecognizerAnnotations Uses

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

Describes the annotations associated with a entity recognizer.

func (EntityRecognizerAnnotations) GoString Uses

func (s EntityRecognizerAnnotations) GoString() string

GoString returns the string representation

func (*EntityRecognizerAnnotations) SetS3Uri Uses

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

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerAnnotations) String Uses

func (s EntityRecognizerAnnotations) String() string

String returns the string representation

func (*EntityRecognizerAnnotations) Validate Uses

func (s *EntityRecognizerAnnotations) Validate() error

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

type EntityRecognizerDocuments Uses

type EntityRecognizerDocuments struct {

    // Specifies the Amazon S3 location where the training documents for an entity
    // recognizer are located. The URI must be in the same region as the API endpoint
    // that you are calling.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Describes the training documents submitted with an entity recognizer.

func (EntityRecognizerDocuments) GoString Uses

func (s EntityRecognizerDocuments) GoString() string

GoString returns the string representation

func (*EntityRecognizerDocuments) SetS3Uri Uses

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

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerDocuments) String Uses

func (s EntityRecognizerDocuments) String() string

String returns the string representation

func (*EntityRecognizerDocuments) Validate Uses

func (s *EntityRecognizerDocuments) Validate() error

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

type EntityRecognizerEntityList Uses

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 recognizer submitted with an entity recognizer.

func (EntityRecognizerEntityList) GoString Uses

func (s EntityRecognizerEntityList) GoString() string

GoString returns the string representation

func (*EntityRecognizerEntityList) SetS3Uri Uses

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

SetS3Uri sets the S3Uri field's value.

func (EntityRecognizerEntityList) String Uses

func (s EntityRecognizerEntityList) String() string

String returns the string representation

func (*EntityRecognizerEntityList) Validate Uses

func (s *EntityRecognizerEntityList) Validate() error

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

type EntityRecognizerEvaluationMetrics Uses

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. The highest score is 1, and the worst score is
    // 0.
    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 Uses

func (s EntityRecognizerEvaluationMetrics) GoString() string

GoString returns the string representation

func (*EntityRecognizerEvaluationMetrics) SetF1Score Uses

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

SetF1Score sets the F1Score field's value.

func (*EntityRecognizerEvaluationMetrics) SetPrecision Uses

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

SetPrecision sets the Precision field's value.

func (*EntityRecognizerEvaluationMetrics) SetRecall Uses

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

SetRecall sets the Recall field's value.

func (EntityRecognizerEvaluationMetrics) String Uses

func (s EntityRecognizerEvaluationMetrics) String() string

String returns the string representation

type EntityRecognizerFilter Uses

type EntityRecognizerFilter struct {

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

func (EntityRecognizerFilter) GoString Uses

func (s EntityRecognizerFilter) GoString() string

GoString returns the string representation

func (*EntityRecognizerFilter) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*EntityRecognizerFilter) SetSubmitTimeAfter Uses

func (s *EntityRecognizerFilter) SetSubmitTimeAfter(v time.Time) *EntityRecognizerFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*EntityRecognizerFilter) SetSubmitTimeBefore Uses

func (s *EntityRecognizerFilter) SetSubmitTimeBefore(v time.Time) *EntityRecognizerFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (EntityRecognizerFilter) String Uses

func (s EntityRecognizerFilter) String() string

String returns the string representation

type EntityRecognizerInputDataConfig Uses

type EntityRecognizerInputDataConfig struct {

    // S3 location of the annotations file for an entity recognizer.
    Annotations *EntityRecognizerAnnotations `type:"structure"`

    // S3 location of the documents folder for an entity recognizer
    //
    // Documents is a required field
    Documents *EntityRecognizerDocuments `type:"structure" required:"true"`

    // S3 location of the entity list for an entity recognizer.
    EntityList *EntityRecognizerEntityList `type:"structure"`

    // The entity types in the input data for an entity recognizer. A maximum of
    // 12 entity types can be used at one time to train an entity recognizer.
    //
    // 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 Uses

func (s EntityRecognizerInputDataConfig) GoString() string

GoString returns the string representation

func (*EntityRecognizerInputDataConfig) SetAnnotations Uses

func (s *EntityRecognizerInputDataConfig) SetAnnotations(v *EntityRecognizerAnnotations) *EntityRecognizerInputDataConfig

SetAnnotations sets the Annotations field's value.

func (*EntityRecognizerInputDataConfig) SetDocuments Uses

func (s *EntityRecognizerInputDataConfig) SetDocuments(v *EntityRecognizerDocuments) *EntityRecognizerInputDataConfig

SetDocuments sets the Documents field's value.

func (*EntityRecognizerInputDataConfig) SetEntityList Uses

func (s *EntityRecognizerInputDataConfig) SetEntityList(v *EntityRecognizerEntityList) *EntityRecognizerInputDataConfig

SetEntityList sets the EntityList field's value.

func (*EntityRecognizerInputDataConfig) SetEntityTypes Uses

func (s *EntityRecognizerInputDataConfig) SetEntityTypes(v []*EntityTypesListItem) *EntityRecognizerInputDataConfig

SetEntityTypes sets the EntityTypes field's value.

func (EntityRecognizerInputDataConfig) String Uses

func (s EntityRecognizerInputDataConfig) String() string

String returns the string representation

func (*EntityRecognizerInputDataConfig) Validate Uses

func (s *EntityRecognizerInputDataConfig) Validate() error

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

type EntityRecognizerMetadata Uses

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 Uses

func (s EntityRecognizerMetadata) GoString() string

GoString returns the string representation

func (*EntityRecognizerMetadata) SetEntityTypes Uses

func (s *EntityRecognizerMetadata) SetEntityTypes(v []*EntityRecognizerMetadataEntityTypesListItem) *EntityRecognizerMetadata

SetEntityTypes sets the EntityTypes field's value.

func (*EntityRecognizerMetadata) SetEvaluationMetrics Uses

func (s *EntityRecognizerMetadata) SetEvaluationMetrics(v *EntityRecognizerEvaluationMetrics) *EntityRecognizerMetadata

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadata) SetNumberOfTestDocuments Uses

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

SetNumberOfTestDocuments sets the NumberOfTestDocuments field's value.

func (*EntityRecognizerMetadata) SetNumberOfTrainedDocuments Uses

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

SetNumberOfTrainedDocuments sets the NumberOfTrainedDocuments field's value.

func (EntityRecognizerMetadata) String Uses

func (s EntityRecognizerMetadata) String() string

String returns the string representation

type EntityRecognizerMetadataEntityTypesListItem Uses

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 Uses

func (s EntityRecognizerMetadataEntityTypesListItem) GoString() string

GoString returns the string representation

func (*EntityRecognizerMetadataEntityTypesListItem) SetEvaluationMetrics Uses

func (s *EntityRecognizerMetadataEntityTypesListItem) SetEvaluationMetrics(v *EntityTypesEvaluationMetrics) *EntityRecognizerMetadataEntityTypesListItem

SetEvaluationMetrics sets the EvaluationMetrics field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetNumberOfTrainMentions Uses

func (s *EntityRecognizerMetadataEntityTypesListItem) SetNumberOfTrainMentions(v int64) *EntityRecognizerMetadataEntityTypesListItem

SetNumberOfTrainMentions sets the NumberOfTrainMentions field's value.

func (*EntityRecognizerMetadataEntityTypesListItem) SetType Uses

func (s *EntityRecognizerMetadataEntityTypesListItem) SetType(v string) *EntityRecognizerMetadataEntityTypesListItem

SetType sets the Type field's value.

func (EntityRecognizerMetadataEntityTypesListItem) String Uses

func (s EntityRecognizerMetadataEntityTypesListItem) String() string

String returns the string representation

type EntityRecognizerProperties Uses

type EntityRecognizerProperties struct {

    // The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
    // that grants Amazon Comprehend read access to your input data.
    DataAccessRoleArn *string `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 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"`

    // Provides information about an entity recognizer.
    RecognizerMetadata *EntityRecognizerMetadata `type:"structure"`

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

    // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses
    // to encrypt data on the storage volume attached to the ML compute instance(s)
    // that process the analysis job. The VolumeKmsKeyId can be either of the following
    // formats:
    //
    //    * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    //
    //    * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    VolumeKmsKeyId *string `type:"string"`

    // Configuration parameters for a private Virtual Private Cloud (VPC) containing
    // the resources you are using for your custom 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 Uses

func (s EntityRecognizerProperties) GoString() string

GoString returns the string representation

func (*EntityRecognizerProperties) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*EntityRecognizerProperties) SetEndTime Uses

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

SetEndTime sets the EndTime field's value.

func (*EntityRecognizerProperties) SetEntityRecognizerArn Uses

func (s *EntityRecognizerProperties) SetEntityRecognizerArn(v string) *EntityRecognizerProperties

SetEntityRecognizerArn sets the EntityRecognizerArn field's value.

func (*EntityRecognizerProperties) SetInputDataConfig Uses

func (s *EntityRecognizerProperties) SetInputDataConfig(v *EntityRecognizerInputDataConfig) *EntityRecognizerProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*EntityRecognizerProperties) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*EntityRecognizerProperties) SetMessage Uses

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

SetMessage sets the Message field's value.

func (*EntityRecognizerProperties) SetRecognizerMetadata Uses

func (s *EntityRecognizerProperties) SetRecognizerMetadata(v *EntityRecognizerMetadata) *EntityRecognizerProperties

SetRecognizerMetadata sets the RecognizerMetadata field's value.

func (*EntityRecognizerProperties) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*EntityRecognizerProperties) SetSubmitTime Uses

func (s *EntityRecognizerProperties) SetSubmitTime(v time.Time) *EntityRecognizerProperties

SetSubmitTime sets the SubmitTime field's value.

func (*EntityRecognizerProperties) SetTrainingEndTime Uses

func (s *EntityRecognizerProperties) SetTrainingEndTime(v time.Time) *EntityRecognizerProperties

SetTrainingEndTime sets the TrainingEndTime field's value.

func (*EntityRecognizerProperties) SetTrainingStartTime Uses

func (s *EntityRecognizerProperties) SetTrainingStartTime(v time.Time) *EntityRecognizerProperties

SetTrainingStartTime sets the TrainingStartTime field's value.

func (*EntityRecognizerProperties) SetVolumeKmsKeyId Uses

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

SetVolumeKmsKeyId sets the VolumeKmsKeyId field's value.

func (*EntityRecognizerProperties) SetVpcConfig Uses

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

SetVpcConfig sets the VpcConfig field's value.

func (EntityRecognizerProperties) String Uses

func (s EntityRecognizerProperties) String() string

String returns the string representation

type EntityTypesEvaluationMetrics Uses

type EntityTypesEvaluationMetrics struct {

    // A measure of how accurate the recognizer results are for 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 Uses

func (s EntityTypesEvaluationMetrics) GoString() string

GoString returns the string representation

func (*EntityTypesEvaluationMetrics) SetF1Score Uses

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

SetF1Score sets the F1Score field's value.