...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/comprehend"
Overview
Constants

Overview ▾

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

The stub package, comprehendiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type BatchDetectDominantLanguageInput
func (s *BatchDetectDominantLanguageInput) SetTextList(v []*string) *BatchDetectDominantLanguageInput
type BatchDetectDominantLanguageItemResult
func (s *BatchDetectDominantLanguageItemResult) SetIndex(v int64) *BatchDetectDominantLanguageItemResult
func (s *BatchDetectDominantLanguageItemResult) SetLanguages(v []*DominantLanguage) *BatchDetectDominantLanguageItemResult
type BatchDetectDominantLanguageOutput
func (s *BatchDetectDominantLanguageOutput) SetErrorList(v []*BatchItemError) *BatchDetectDominantLanguageOutput
func (s *BatchDetectDominantLanguageOutput) SetResultList(v []*BatchDetectDominantLanguageItemResult) *BatchDetectDominantLanguageOutput
type BatchDetectEntitiesInput
func (s *BatchDetectEntitiesInput) SetLanguageCode(v string) *BatchDetectEntitiesInput
func (s *BatchDetectEntitiesInput) SetTextList(v []*string) *BatchDetectEntitiesInput
type BatchDetectEntitiesItemResult
func (s *BatchDetectEntitiesItemResult) SetEntities(v []*Entity) *BatchDetectEntitiesItemResult
func (s *BatchDetectEntitiesItemResult) SetIndex(v int64) *BatchDetectEntitiesItemResult
type BatchDetectEntitiesOutput
func (s *BatchDetectEntitiesOutput) SetErrorList(v []*BatchItemError) *BatchDetectEntitiesOutput
func (s *BatchDetectEntitiesOutput) SetResultList(v []*BatchDetectEntitiesItemResult) *BatchDetectEntitiesOutput
type BatchDetectKeyPhrasesInput
func (s *BatchDetectKeyPhrasesInput) SetLanguageCode(v string) *BatchDetectKeyPhrasesInput
func (s *BatchDetectKeyPhrasesInput) SetTextList(v []*string) *BatchDetectKeyPhrasesInput
type BatchDetectKeyPhrasesItemResult
func (s *BatchDetectKeyPhrasesItemResult) SetIndex(v int64) *BatchDetectKeyPhrasesItemResult
func (s *BatchDetectKeyPhrasesItemResult) SetKeyPhrases(v []*KeyPhrase) *BatchDetectKeyPhrasesItemResult
type BatchDetectKeyPhrasesOutput
func (s *BatchDetectKeyPhrasesOutput) SetErrorList(v []*BatchItemError) *BatchDetectKeyPhrasesOutput
func (s *BatchDetectKeyPhrasesOutput) SetResultList(v []*BatchDetectKeyPhrasesItemResult) *BatchDetectKeyPhrasesOutput
type BatchDetectSentimentInput
func (s *BatchDetectSentimentInput) SetLanguageCode(v string) *BatchDetectSentimentInput
func (s *BatchDetectSentimentInput) SetTextList(v []*string) *BatchDetectSentimentInput
type BatchDetectSentimentItemResult
func (s *BatchDetectSentimentItemResult) SetIndex(v int64) *BatchDetectSentimentItemResult
func (s *BatchDetectSentimentItemResult) SetSentiment(v string) *BatchDetectSentimentItemResult
func (s *BatchDetectSentimentItemResult) SetSentimentScore(v *SentimentScore) *BatchDetectSentimentItemResult
type BatchDetectSentimentOutput
func (s *BatchDetectSentimentOutput) SetErrorList(v []*BatchItemError) *BatchDetectSentimentOutput
func (s *BatchDetectSentimentOutput) SetResultList(v []*BatchDetectSentimentItemResult) *BatchDetectSentimentOutput
type BatchItemError
func (s *BatchItemError) SetErrorCode(v string) *BatchItemError
func (s *BatchItemError) SetErrorMessage(v string) *BatchItemError
func (s *BatchItemError) SetIndex(v int64) *BatchItemError
type Comprehend
type DescribeTopicsDetectionJobInput
func (s *DescribeTopicsDetectionJobInput) SetJobId(v string) *DescribeTopicsDetectionJobInput
type DescribeTopicsDetectionJobOutput
func (s *DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties(v *TopicsDetectionJobProperties) *DescribeTopicsDetectionJobOutput
type DetectDominantLanguageInput
func (s *DetectDominantLanguageInput) SetText(v string) *DetectDominantLanguageInput
type DetectDominantLanguageOutput
func (s *DetectDominantLanguageOutput) SetLanguages(v []*DominantLanguage) *DetectDominantLanguageOutput
type DetectEntitiesInput
func (s *DetectEntitiesInput) SetLanguageCode(v string) *DetectEntitiesInput
func (s *DetectEntitiesInput) SetText(v string) *DetectEntitiesInput
type DetectEntitiesOutput
func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput
type DetectKeyPhrasesInput
func (s *DetectKeyPhrasesInput) SetLanguageCode(v string) *DetectKeyPhrasesInput
func (s *DetectKeyPhrasesInput) SetText(v string) *DetectKeyPhrasesInput
type DetectKeyPhrasesOutput
func (s *DetectKeyPhrasesOutput) SetKeyPhrases(v []*KeyPhrase) *DetectKeyPhrasesOutput
type DetectSentimentInput
func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput
func (s *DetectSentimentInput) SetText(v string) *DetectSentimentInput
type DetectSentimentOutput
func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput
func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput
type DominantLanguage
func (s *DominantLanguage) SetLanguageCode(v string) *DominantLanguage
func (s *DominantLanguage) SetScore(v float64) *DominantLanguage
type Entity
func (s *Entity) SetBeginOffset(v int64) *Entity
func (s *Entity) SetEndOffset(v int64) *Entity
func (s *Entity) SetScore(v float64) *Entity
func (s *Entity) SetText(v string) *Entity
func (s *Entity) SetType(v string) *Entity
type InputDataConfig
func (s *InputDataConfig) SetInputFormat(v string) *InputDataConfig
func (s *InputDataConfig) SetS3Uri(v string) *InputDataConfig
type KeyPhrase
func (s *KeyPhrase) SetBeginOffset(v int64) *KeyPhrase
func (s *KeyPhrase) SetEndOffset(v int64) *KeyPhrase
func (s *KeyPhrase) SetScore(v float64) *KeyPhrase
func (s *KeyPhrase) SetText(v string) *KeyPhrase
type ListTopicsDetectionJobsInput
func (s *ListTopicsDetectionJobsInput) SetFilter(v *TopicsDetectionJobFilter) *ListTopicsDetectionJobsInput
func (s *ListTopicsDetectionJobsInput) SetMaxResults(v int64) *ListTopicsDetectionJobsInput
func (s *ListTopicsDetectionJobsInput) SetNextToken(v string) *ListTopicsDetectionJobsInput
type ListTopicsDetectionJobsOutput
func (s *ListTopicsDetectionJobsOutput) SetNextToken(v string) *ListTopicsDetectionJobsOutput
func (s *ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList(v []*TopicsDetectionJobProperties) *ListTopicsDetectionJobsOutput
type OutputDataConfig
func (s *OutputDataConfig) SetS3Uri(v string) *OutputDataConfig
type SentimentScore
func (s *SentimentScore) SetMixed(v float64) *SentimentScore
func (s *SentimentScore) SetNegative(v float64) *SentimentScore
func (s *SentimentScore) SetNeutral(v float64) *SentimentScore
func (s *SentimentScore) SetPositive(v float64) *SentimentScore
type StartTopicsDetectionJobInput
func (s *StartTopicsDetectionJobInput) SetClientRequestToken(v string) *StartTopicsDetectionJobInput
func (s *StartTopicsDetectionJobInput) SetDataAccessRoleArn(v string) *StartTopicsDetectionJobInput
func (s *StartTopicsDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartTopicsDetectionJobInput
func (s *StartTopicsDetectionJobInput) SetJobName(v string) *StartTopicsDetectionJobInput
func (s *StartTopicsDetectionJobInput) SetNumberOfTopics(v int64) *StartTopicsDetectionJobInput
func (s *StartTopicsDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartTopicsDetectionJobInput
type StartTopicsDetectionJobOutput
func (s *StartTopicsDetectionJobOutput) SetJobId(v string) *StartTopicsDetectionJobOutput
func (s *StartTopicsDetectionJobOutput) SetJobStatus(v string) *StartTopicsDetectionJobOutput
type TopicsDetectionJobFilter
func (s *TopicsDetectionJobFilter) SetJobName(v string) *TopicsDetectionJobFilter
func (s *TopicsDetectionJobFilter) SetJobStatus(v string) *TopicsDetectionJobFilter
func (s *TopicsDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *TopicsDetectionJobFilter
func (s *TopicsDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *TopicsDetectionJobFilter
type TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetEndTime(v time.Time) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetJobId(v string) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetJobName(v string) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetJobStatus(v string) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetMessage(v string) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetNumberOfTopics(v int64) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetOutputDataConfig(v *OutputDataConfig) *TopicsDetectionJobProperties
func (s *TopicsDetectionJobProperties) SetSubmitTime(v time.Time) *TopicsDetectionJobProperties

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"
)
const (
    // LanguageCodeEn is a LanguageCode enum value
    LanguageCodeEn = "en"

    // LanguageCodeEs is a LanguageCode enum value
    LanguageCodeEs = "es"
)
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 (

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

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

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

    // ErrCodeUnsupportedLanguageException for service response error code
    // "UnsupportedLanguageException".
    //
    // Amazon Comprehend can't process the language of the input text. For all APIs
    // except DetectDominantLanguage, Amazon Comprehend accepts only English or
    // Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
    // 100 languages. For a list of languages, see how-languages
    ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException"
)
const (
    ServiceName = "comprehend" // Service endpoint prefix API calls made to.
    EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

type BatchDetectDominantLanguageInput

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

func (s BatchDetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectDominantLanguageInput) String

func (s BatchDetectDominantLanguageInput) String() string

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate

func (s *BatchDetectDominantLanguageInput) Validate() error

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

type BatchDetectDominantLanguageItemResult

type BatchDetectDominantLanguageItemResult struct {

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

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

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

func (BatchDetectDominantLanguageItemResult) GoString

func (s BatchDetectDominantLanguageItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (*BatchDetectDominantLanguageItemResult) SetLanguages

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

SetLanguages sets the Languages field's value.

func (BatchDetectDominantLanguageItemResult) String

func (s BatchDetectDominantLanguageItemResult) String() string

String returns the string representation

type BatchDetectDominantLanguageOutput

type BatchDetectDominantLanguageOutput struct {

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

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

func (BatchDetectDominantLanguageOutput) GoString

func (s BatchDetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*BatchDetectDominantLanguageOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectDominantLanguageOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectDominantLanguageOutput) String

func (s BatchDetectDominantLanguageOutput) String() string

String returns the string representation

type BatchDetectEntitiesInput

type BatchDetectEntitiesInput struct {

    // The language of the input documents. All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `min:"1" type:"string" required:"true"`

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

func (s BatchDetectEntitiesInput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectEntitiesInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectEntitiesInput) String

func (s BatchDetectEntitiesInput) String() string

String returns the string representation

func (*BatchDetectEntitiesInput) Validate

func (s *BatchDetectEntitiesInput) Validate() error

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

type BatchDetectEntitiesItemResult

type BatchDetectEntitiesItemResult struct {

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

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

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

func (BatchDetectEntitiesItemResult) GoString

func (s BatchDetectEntitiesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesItemResult) SetEntities

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

SetEntities sets the Entities field's value.

func (*BatchDetectEntitiesItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (BatchDetectEntitiesItemResult) String

func (s BatchDetectEntitiesItemResult) String() string

String returns the string representation

type BatchDetectEntitiesOutput

type BatchDetectEntitiesOutput struct {

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

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

func (BatchDetectEntitiesOutput) GoString

func (s BatchDetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectEntitiesOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectEntitiesOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectEntitiesOutput) String

func (s BatchDetectEntitiesOutput) String() string

String returns the string representation

type BatchDetectKeyPhrasesInput

type BatchDetectKeyPhrasesInput struct {

    // The language of the input documents. All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `min:"1" type:"string" required:"true"`

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

func (s BatchDetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectKeyPhrasesInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectKeyPhrasesInput) String

func (s BatchDetectKeyPhrasesInput) String() string

String returns the string representation

func (*BatchDetectKeyPhrasesInput) Validate

func (s *BatchDetectKeyPhrasesInput) Validate() error

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

type BatchDetectKeyPhrasesItemResult

type BatchDetectKeyPhrasesItemResult struct {

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

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

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

func (BatchDetectKeyPhrasesItemResult) GoString

func (s BatchDetectKeyPhrasesItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (*BatchDetectKeyPhrasesItemResult) SetKeyPhrases

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

SetKeyPhrases sets the KeyPhrases field's value.

func (BatchDetectKeyPhrasesItemResult) String

func (s BatchDetectKeyPhrasesItemResult) String() string

String returns the string representation

type BatchDetectKeyPhrasesOutput

type BatchDetectKeyPhrasesOutput struct {

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

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

func (BatchDetectKeyPhrasesOutput) GoString

func (s BatchDetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*BatchDetectKeyPhrasesOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectKeyPhrasesOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectKeyPhrasesOutput) String

func (s BatchDetectKeyPhrasesOutput) String() string

String returns the string representation

type BatchDetectSentimentInput

type BatchDetectSentimentInput struct {

    // The language of the input documents. All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `min:"1" type:"string" required:"true"`

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

func (s BatchDetectSentimentInput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*BatchDetectSentimentInput) SetTextList

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

SetTextList sets the TextList field's value.

func (BatchDetectSentimentInput) String

func (s BatchDetectSentimentInput) String() string

String returns the string representation

func (*BatchDetectSentimentInput) Validate

func (s *BatchDetectSentimentInput) Validate() error

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

type BatchDetectSentimentItemResult

type BatchDetectSentimentItemResult struct {

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

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

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

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

func (BatchDetectSentimentItemResult) GoString

func (s BatchDetectSentimentItemResult) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentItemResult) SetIndex

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

SetIndex sets the Index field's value.

func (*BatchDetectSentimentItemResult) SetSentiment

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

SetSentiment sets the Sentiment field's value.

func (*BatchDetectSentimentItemResult) SetSentimentScore

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

SetSentimentScore sets the SentimentScore field's value.

func (BatchDetectSentimentItemResult) String

func (s BatchDetectSentimentItemResult) String() string

String returns the string representation

type BatchDetectSentimentOutput

type BatchDetectSentimentOutput struct {

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

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

func (BatchDetectSentimentOutput) GoString

func (s BatchDetectSentimentOutput) GoString() string

GoString returns the string representation

func (*BatchDetectSentimentOutput) SetErrorList

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

SetErrorList sets the ErrorList field's value.

func (*BatchDetectSentimentOutput) SetResultList

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

SetResultList sets the ResultList field's value.

func (BatchDetectSentimentOutput) String

func (s BatchDetectSentimentOutput) String() string

String returns the string representation

type BatchItemError

type BatchItemError struct {

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

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

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

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

func (BatchItemError) GoString

func (s BatchItemError) GoString() string

GoString returns the string representation

func (*BatchItemError) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchItemError) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchItemError) SetIndex

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

SetIndex sets the Index field's value.

func (BatchItemError) String

func (s BatchItemError) String() string

String returns the string representation

type Comprehend

type Comprehend struct {
    *client.Client
}

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

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

func New

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

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

Example:

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

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

func (*Comprehend) BatchDetectDominantLanguage

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

BatchDetectDominantLanguage API operation for Amazon Comprehend.

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (http://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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) BatchDetectDominantLanguageWithContext

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

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

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

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

func (*Comprehend) BatchDetectEntities

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

BatchDetectEntities API operation for Amazon Comprehend.

Inspects the text of a batch of documents and returns information about them. For more information about 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 APIs
except DetectDominantLanguage, Amazon Comprehend accepts only English or
Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
100 languages. For a list of languages, see how-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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) BatchDetectEntitiesWithContext

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

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

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

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

func (*Comprehend) BatchDetectKeyPhrases

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

BatchDetectKeyPhrases API operation for Amazon Comprehend.

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

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

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

Returned Error 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 APIs
except DetectDominantLanguage, Amazon Comprehend accepts only English or
Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
100 languages. For a list of languages, see how-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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) BatchDetectKeyPhrasesWithContext

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

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

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

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

func (*Comprehend) BatchDetectSentiment

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

BatchDetectSentiment API operation for Amazon Comprehend.

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

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

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

Returned Error 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 APIs
except DetectDominantLanguage, Amazon Comprehend accepts only English or
Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
100 languages. For a list of languages, see how-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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) BatchDetectSentimentWithContext

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

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

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

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

func (*Comprehend) DescribeTopicsDetectionJob

func (c *Comprehend) DescribeTopicsDetectionJob(input *DescribeTopicsDetectionJobInput) (*DescribeTopicsDetectionJobOutput, error)

DescribeTopicsDetectionJob API operation for Amazon Comprehend.

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

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

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

Returned Error 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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) DescribeTopicsDetectionJobWithContext

func (c *Comprehend) DescribeTopicsDetectionJobWithContext(ctx aws.Context, input *DescribeTopicsDetectionJobInput, opts ...request.Option) (*DescribeTopicsDetectionJobOutput, error)

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

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

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

func (*Comprehend) DetectDominantLanguage

func (c *Comprehend) DetectDominantLanguage(input *DetectDominantLanguageInput) (*DetectDominantLanguageOutput, error)

DetectDominantLanguage API operation for Amazon Comprehend.

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (http://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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) DetectDominantLanguageWithContext

func (c *Comprehend) DetectDominantLanguageWithContext(ctx aws.Context, input *DetectDominantLanguageInput, opts ...request.Option) (*DetectDominantLanguageOutput, error)

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

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

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

func (*Comprehend) DetectEntities

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

DetectEntities API operation for Amazon Comprehend.

Inspects text for entities, and returns information about them. For more information, about 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 APIs
except DetectDominantLanguage, Amazon Comprehend accepts only English or
Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
100 languages. For a list of languages, see how-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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) DetectEntitiesWithContext

func (c *Comprehend) DetectEntitiesWithContext(ctx aws.Context, input *DetectEntitiesInput, opts ...request.Option) (*DetectEntitiesOutput, error)

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

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

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

func (*Comprehend) DetectKeyPhrases

func (c *Comprehend) DetectKeyPhrases(input *DetectKeyPhrasesInput) (*DetectKeyPhrasesOutput, error)

DetectKeyPhrases API operation for Amazon Comprehend.

Detects the key noun phrases found in the text.

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

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

Returned Error 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 APIs
except DetectDominantLanguage, Amazon Comprehend accepts only English or
Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
100 languages. For a list of languages, see how-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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) DetectKeyPhrasesWithContext

func (c *Comprehend) DetectKeyPhrasesWithContext(ctx aws.Context, input *DetectKeyPhrasesInput, opts ...request.Option) (*DetectKeyPhrasesOutput, error)

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

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

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

func (*Comprehend) DetectSentiment

func (c *Comprehend) DetectSentiment(input *DetectSentimentInput) (*DetectSentimentOutput, error)

DetectSentiment API operation for Amazon Comprehend.

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

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

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

Returned Error 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 APIs
except DetectDominantLanguage, Amazon Comprehend accepts only English or
Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
100 languages. For a list of languages, see how-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

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 complets successfuly.

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

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

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

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

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

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

func (*Comprehend) DetectSentimentWithContext

func (c *Comprehend) DetectSentimentWithContext(ctx aws.Context, input *DetectSentimentInput, opts ...request.Option) (*DetectSentimentOutput, error)

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

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

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

func (*Comprehend) ListTopicsDetectionJobs

func (c *Comprehend) ListTopicsDetectionJobs(input *ListTopicsDetectionJobsInput) (*ListTopicsDetectionJobsOutput, error)

ListTopicsDetectionJobs API operation for Amazon Comprehend.

Gets a list of the topic detection jobs that you have submitted.

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

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

Returned Error 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 ListTopicDetectionJobs 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

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 *ListTopicsDetectionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Comprehend) ListTopicsDetectionJobsPagesWithContext

func (c *Comprehend) ListTopicsDetectionJobsPagesWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, fn func(*ListTopicsDetectionJobsOutput, bool) bool, opts ...request.Option) error

ListTopicsDetectionJobsPagesWithContext same as ListTopicsDetectionJobsPages except it takes a Context and allows setting request options on the pages.

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

func (*Comprehend) ListTopicsDetectionJobsRequest

func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) (req *request.Request, output *ListTopicsDetectionJobsOutput)

ListTopicsDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTopicsDetectionJobs operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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

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

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

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

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

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

func (*Comprehend) ListTopicsDetectionJobsWithContext

func (c *Comprehend) ListTopicsDetectionJobsWithContext(ctx aws.Context, input *ListTopicsDetectionJobsInput, opts ...request.Option) (*ListTopicsDetectionJobsOutput, error)

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

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

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

func (*Comprehend) StartTopicsDetectionJob

func (c *Comprehend) StartTopicsDetectionJob(input *StartTopicsDetectionJobInput) (*StartTopicsDetectionJobOutput, error)

StartTopicsDetectionJob API operation for Amazon Comprehend.

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

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

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

Returned Error Codes:

* ErrCodeInvalidRequestException "InvalidRequestException"
The request is invalid.

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

func (*Comprehend) StartTopicsDetectionJobRequest

func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput)

StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartTopicsDetectionJob operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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

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

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

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

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

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

func (*Comprehend) StartTopicsDetectionJobWithContext

func (c *Comprehend) StartTopicsDetectionJobWithContext(ctx aws.Context, input *StartTopicsDetectionJobInput, opts ...request.Option) (*StartTopicsDetectionJobOutput, error)

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

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

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

type DescribeTopicsDetectionJobInput

type DescribeTopicsDetectionJobInput struct {

    // The identifier assigned by the user to the detection job.
    //
    // JobId is a required field
    JobId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeTopicsDetectionJobInput) GoString

func (s DescribeTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobInput) SetJobId

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

SetJobId sets the JobId field's value.

func (DescribeTopicsDetectionJobInput) String

func (s DescribeTopicsDetectionJobInput) String() string

String returns the string representation

func (*DescribeTopicsDetectionJobInput) Validate

func (s *DescribeTopicsDetectionJobInput) Validate() error

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

type DescribeTopicsDetectionJobOutput

type DescribeTopicsDetectionJobOutput struct {

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

func (DescribeTopicsDetectionJobOutput) GoString

func (s DescribeTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribeTopicsDetectionJobOutput) SetTopicsDetectionJobProperties

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

SetTopicsDetectionJobProperties sets the TopicsDetectionJobProperties field's value.

func (DescribeTopicsDetectionJobOutput) String

func (s DescribeTopicsDetectionJobOutput) String() string

String returns the string representation

type DetectDominantLanguageInput

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

func (s DetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageInput) SetText

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

SetText sets the Text field's value.

func (DetectDominantLanguageInput) String

func (s DetectDominantLanguageInput) String() string

String returns the string representation

func (*DetectDominantLanguageInput) Validate

func (s *DetectDominantLanguageInput) Validate() error

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

type DetectDominantLanguageOutput

type DetectDominantLanguageOutput struct {

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

func (s DetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (*DetectDominantLanguageOutput) SetLanguages

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

SetLanguages sets the Languages field's value.

func (DetectDominantLanguageOutput) String

func (s DetectDominantLanguageOutput) String() string

String returns the string representation

type DetectEntitiesInput

type DetectEntitiesInput struct {

    // The RFC 5646 language code of the input text. If the request does not specify
    // the language code, the service detects the dominant language. If you specify
    // a language code that the service does not support, it returns UnsupportedLanguageException
    // exception. For more information about RFC 5646, see Tags for Identifying
    // Languages (https://tools.ietf.org/html/rfc5646) on the IETF Tools web site.
    //
    // 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

func (s DetectEntitiesInput) GoString() string

GoString returns the string representation

func (*DetectEntitiesInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectEntitiesInput) SetText

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

SetText sets the Text field's value.

func (DetectEntitiesInput) String

func (s DetectEntitiesInput) String() string

String returns the string representation

func (*DetectEntitiesInput) Validate

func (s *DetectEntitiesInput) Validate() error

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

type DetectEntitiesOutput

type DetectEntitiesOutput struct {

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

func (s DetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*DetectEntitiesOutput) SetEntities

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

SetEntities sets the Entities field's value.

func (DetectEntitiesOutput) String

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectKeyPhrasesInput

type DetectKeyPhrasesInput struct {

    // The RFC 5646 language code for the input text. If you don't specify a language
    // code, Amazon Comprehend detects the dominant language. If you specify the
    // code for a language that Amazon Comprehend does not support, it returns and
    // UnsupportedLanguageException. For more information about RFC 5646, see Tags
    // for Identifying Languages (https://tools.ietf.org/html/rfc5646) on the IETF
    // Tools web site.
    //
    // 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

func (s DetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectKeyPhrasesInput) SetText

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

SetText sets the Text field's value.

func (DetectKeyPhrasesInput) String

func (s DetectKeyPhrasesInput) String() string

String returns the string representation

func (*DetectKeyPhrasesInput) Validate

func (s *DetectKeyPhrasesInput) Validate() error

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

type DetectKeyPhrasesOutput

type DetectKeyPhrasesOutput struct {

    // A collection of key phrases that Amazon Comprehend identified in the input
    // text. For each key phrase, the response provides the text of the key phrase,
    // where the key phrase begins and ends, and the level of confidence that Amazon
    // Comprehend has in the accuracy of the detection.
    KeyPhrases []*KeyPhrase `type:"list"`
    // contains filtered or unexported fields
}

func (DetectKeyPhrasesOutput) GoString

func (s DetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (*DetectKeyPhrasesOutput) SetKeyPhrases

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

SetKeyPhrases sets the KeyPhrases field's value.

func (DetectKeyPhrasesOutput) String

func (s DetectKeyPhrasesOutput) String() string

String returns the string representation

type DetectSentimentInput

type DetectSentimentInput struct {

    // The RFC 5646 language code for the input text. If you don't specify a language
    // code, Amazon Comprehend detects the dominant language. If you specify the
    // code for a language that Amazon Comprehend does not support, it returns and
    // UnsupportedLanguageException. For more information about RFC 5646, see Tags
    // for Identifying Languages (https://tools.ietf.org/html/rfc5646) on the IETF
    // Tools web site.
    //
    // 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

func (s DetectSentimentInput) GoString() string

GoString returns the string representation

func (*DetectSentimentInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*DetectSentimentInput) SetText

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

SetText sets the Text field's value.

func (DetectSentimentInput) String

func (s DetectSentimentInput) String() string

String returns the string representation

func (*DetectSentimentInput) Validate

func (s *DetectSentimentInput) Validate() error

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

type DetectSentimentOutput

type DetectSentimentOutput struct {

    // The inferred sentiment that Amazon Comprehend has the highest level of confidence
    // in.
    Sentiment *string `type:"string" enum:"SentimentType"`

    // An object that lists the sentiments, and their corresponding confidence levels.
    SentimentScore *SentimentScore `type:"structure"`
    // contains filtered or unexported fields
}

func (DetectSentimentOutput) GoString

func (s DetectSentimentOutput) GoString() string

GoString returns the string representation

func (*DetectSentimentOutput) SetSentiment

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

SetSentiment sets the Sentiment field's value.

func (*DetectSentimentOutput) SetSentimentScore

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

SetSentimentScore sets the SentimentScore field's value.

func (DetectSentimentOutput) String

func (s DetectSentimentOutput) String() string

String returns the string representation

type DominantLanguage

type DominantLanguage struct {

    // The RFC 5646 language code for the dominant language.
    LanguageCode *string `min:"1" type:"string"`

    // The level of confidence that Amazon Comprehend has in the accuracy of the
    // detection.
    Score *float64 `type:"float"`
    // contains filtered or unexported fields
}

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

func (DominantLanguage) GoString

func (s DominantLanguage) GoString() string

GoString returns the string representation

func (*DominantLanguage) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*DominantLanguage) SetScore

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

SetScore sets the Score field's value.

func (DominantLanguage) String

func (s DominantLanguage) String() string

String returns the string representation

type Entity

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

func (s Entity) GoString() string

GoString returns the string representation

func (*Entity) SetBeginOffset

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

SetBeginOffset sets the BeginOffset field's value.

func (*Entity) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (*Entity) SetScore

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

SetScore sets the Score field's value.

func (*Entity) SetText

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

SetText sets the Text field's value.

func (*Entity) SetType

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

SetType sets the Type field's value.

func (Entity) String

func (s Entity) String() string

String returns the string representation

type InputDataConfig

type InputDataConfig struct {

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

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

The input properties for a topic detection job.

func (InputDataConfig) GoString

func (s InputDataConfig) GoString() string

GoString returns the string representation

func (*InputDataConfig) SetInputFormat

func (s *InputDataConfig) SetInputFormat(v string) *InputDataConfig

SetInputFormat sets the InputFormat field's value.

func (*InputDataConfig) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (InputDataConfig) String

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate

func (s *InputDataConfig) Validate() error

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

type KeyPhrase

type KeyPhrase struct {

    // A character offset in the input text that shows where the key phrase 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 where the key phrase 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 a key noun phrase.
    Text *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Describes a key noun phrase.

func (KeyPhrase) GoString

func (s KeyPhrase) GoString() string

GoString returns the string representation

func (*KeyPhrase) SetBeginOffset

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

SetBeginOffset sets the BeginOffset field's value.

func (*KeyPhrase) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (*KeyPhrase) SetScore

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

SetScore sets the Score field's value.

func (*KeyPhrase) SetText

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

SetText sets the Text field's value.

func (KeyPhrase) String

func (s KeyPhrase) String() string

String returns the string representation

type ListTopicsDetectionJobsInput

type ListTopicsDetectionJobsInput struct {

    // Filters the jobs that are returned. Jobs can be filtered on their name, status,
    // or the date and time that they were submitted. You can set only one filter
    // at a time.
    Filter *TopicsDetectionJobFilter `type:"structure"`

    // The maximum number of results to return in each page.
    MaxResults *int64 `min:"1" type:"integer"`

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListTopicsDetectionJobsInput) GoString

func (s ListTopicsDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListTopicsDetectionJobsInput) SetFilter

func (s *ListTopicsDetectionJobsInput) SetFilter(v *TopicsDetectionJobFilter) *ListTopicsDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListTopicsDetectionJobsInput) SetMaxResults

func (s *ListTopicsDetectionJobsInput) SetMaxResults(v int64) *ListTopicsDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTopicsDetectionJobsInput) SetNextToken

func (s *ListTopicsDetectionJobsInput) SetNextToken(v string) *ListTopicsDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListTopicsDetectionJobsInput) String

func (s ListTopicsDetectionJobsInput) String() string

String returns the string representation

func (*ListTopicsDetectionJobsInput) Validate

func (s *ListTopicsDetectionJobsInput) Validate() error

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

type ListTopicsDetectionJobsOutput

type ListTopicsDetectionJobsOutput struct {

    // Identifies the next page of results to return.
    NextToken *string `min:"1" type:"string"`

    // A list containing the properties of each job that is returned.
    TopicsDetectionJobPropertiesList []*TopicsDetectionJobProperties `type:"list"`
    // contains filtered or unexported fields
}

func (ListTopicsDetectionJobsOutput) GoString

func (s ListTopicsDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListTopicsDetectionJobsOutput) SetNextToken

func (s *ListTopicsDetectionJobsOutput) SetNextToken(v string) *ListTopicsDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList

func (s *ListTopicsDetectionJobsOutput) SetTopicsDetectionJobPropertiesList(v []*TopicsDetectionJobProperties) *ListTopicsDetectionJobsOutput

SetTopicsDetectionJobPropertiesList sets the TopicsDetectionJobPropertiesList field's value.

func (ListTopicsDetectionJobsOutput) String

func (s ListTopicsDetectionJobsOutput) String() string

String returns the string representation

type OutputDataConfig

type OutputDataConfig struct {

    // The Amazon S3 URI where you want to write the output data. The URI must be
    // in the same region as the API endpoint that you are calling.
    //
    // The service creates an output file called output.tar.gz. It is a compressed
    // archive that contains two files, topic-terms.csv that lists the terms associated
    // with each topic, and doc-topics.csv that lists the documents associated with
    // each topic. For more information, see topic-modeling.
    //
    // S3Uri is a required field
    S3Uri *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides configuration parameters for the output of topic detection jobs.

func (OutputDataConfig) GoString

func (s OutputDataConfig) GoString() string

GoString returns the string representation

func (*OutputDataConfig) SetS3Uri

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

SetS3Uri sets the S3Uri field's value.

func (OutputDataConfig) String

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate

func (s *OutputDataConfig) Validate() error

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

type SentimentScore

type SentimentScore struct {

    // The level of confidence that Amazon Comprehend has in the accuracy of its
    // detection of the MIXED sentiment.
    Mixed *float64 `type:"float"`

    // The level of confidence that Amazon Comprehend has in the accuracy of its
    // detection of the NEGATIVE sentiment.
    Negative *float64 `type:"float"`

    // The level of confidence that Amazon Comprehend has in the accuracy of its
    // detection of the NEUTRAL sentiment.
    Neutral *float64 `type:"float"`

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

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

func (SentimentScore) GoString

func (s SentimentScore) GoString() string

GoString returns the string representation

func (*SentimentScore) SetMixed

func (s *SentimentScore) SetMixed(v float64) *SentimentScore

SetMixed sets the Mixed field's value.

func (*SentimentScore) SetNegative

func (s *SentimentScore) SetNegative(v float64) *SentimentScore

SetNegative sets the Negative field's value.

func (*SentimentScore) SetNeutral

func (s *SentimentScore) SetNeutral(v float64) *SentimentScore

SetNeutral sets the Neutral field's value.

func (*SentimentScore) SetPositive

func (s *SentimentScore) SetPositive(v float64) *SentimentScore

SetPositive sets the Positive field's value.

func (SentimentScore) String

func (s SentimentScore) String() string

String returns the string representation

type StartTopicsDetectionJobInput

type StartTopicsDetectionJobInput struct {

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

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

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

    // The identifier of the job.
    JobName *string `min:"1" type:"string"`

    // The number of topics to detect.
    NumberOfTopics *int64 `min:"1" type:"integer"`

    // Specifies where to send the output files.
    //
    // OutputDataConfig is a required field
    OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (StartTopicsDetectionJobInput) GoString

func (s StartTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartTopicsDetectionJobInput) SetClientRequestToken

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartTopicsDetectionJobInput) SetDataAccessRoleArn

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartTopicsDetectionJobInput) SetInputDataConfig

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

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartTopicsDetectionJobInput) SetJobName

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

SetJobName sets the JobName field's value.

func (*StartTopicsDetectionJobInput) SetNumberOfTopics

func (s *StartTopicsDetectionJobInput) SetNumberOfTopics(v int64) *StartTopicsDetectionJobInput

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*StartTopicsDetectionJobInput) SetOutputDataConfig

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

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartTopicsDetectionJobInput) String

func (s StartTopicsDetectionJobInput) String() string

String returns the string representation

func (*StartTopicsDetectionJobInput) Validate

func (s *StartTopicsDetectionJobInput) Validate() error

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

type StartTopicsDetectionJobOutput

type StartTopicsDetectionJobOutput struct {

    // The identifier generated for the job. To get the status of the job, use this
    // identifier with the DescribeTopicDetectionJob operation.
    JobId *string `min:"1" type:"string"`

    // The status of the job:
    //
    //    * SUBMITTED - The job has been received and is queued for processing.
    //
    //    * IN_PROGRESS - Amazon Comprehend is processing the job.
    //
    //    * COMPLETED - The job was successfully completed and the output is available.
    //
    //    * FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob
    //    operation.
    JobStatus *string `type:"string" enum:"JobStatus"`
    // contains filtered or unexported fields
}

func (StartTopicsDetectionJobOutput) GoString

func (s StartTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartTopicsDetectionJobOutput) SetJobId

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

SetJobId sets the JobId field's value.

func (*StartTopicsDetectionJobOutput) SetJobStatus

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

SetJobStatus sets the JobStatus field's value.

func (StartTopicsDetectionJobOutput) String

func (s StartTopicsDetectionJobOutput) String() string

String returns the string representation

type TopicsDetectionJobFilter

type TopicsDetectionJobFilter struct {
    JobName *string `min:"1" type:"string"`

    // Filters the list of topic detection jobs based on job status. Returns only
    // jobs with the specified status.
    JobStatus *string `type:"string" enum:"JobStatus"`

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

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

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

func (TopicsDetectionJobFilter) GoString

func (s TopicsDetectionJobFilter) GoString() string

GoString returns the string representation

func (*TopicsDetectionJobFilter) SetJobName

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

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobFilter) SetJobStatus

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

SetJobStatus sets the JobStatus field's value.

func (*TopicsDetectionJobFilter) SetSubmitTimeAfter

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

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*TopicsDetectionJobFilter) SetSubmitTimeBefore

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

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (TopicsDetectionJobFilter) String

func (s TopicsDetectionJobFilter) String() string

String returns the string representation

func (*TopicsDetectionJobFilter) Validate

func (s *TopicsDetectionJobFilter) Validate() error

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

type TopicsDetectionJobProperties

type TopicsDetectionJobProperties struct {

    // The time that the topic detection job was completed.
    EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

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

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

    // The name of the topic detection job.
    JobName *string `min:"1" type:"string"`

    // The current status of the topic detection job. If the status is Failed, the
    // reason for the failure is shown in the Message field.
    JobStatus *string `type:"string" enum:"JobStatus"`

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

    // The number of topics to detect supplied when you created the topic detection
    // job. The default is 10.
    NumberOfTopics *int64 `type:"integer"`

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

    // The time that the topic detection job was submitted for processing.
    SubmitTime *time.Time `type:"timestamp" timestampFormat:"unix"`
    // contains filtered or unexported fields
}

Provides information about a topic detection job.

func (TopicsDetectionJobProperties) GoString

func (s TopicsDetectionJobProperties) GoString() string

GoString returns the string representation

func (*TopicsDetectionJobProperties) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*TopicsDetectionJobProperties) SetInputDataConfig

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

SetInputDataConfig sets the InputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetJobId

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

SetJobId sets the JobId field's value.

func (*TopicsDetectionJobProperties) SetJobName

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

SetJobName sets the JobName field's value.

func (*TopicsDetectionJobProperties) SetJobStatus

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

SetJobStatus sets the JobStatus field's value.

func (*TopicsDetectionJobProperties) SetMessage

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

SetMessage sets the Message field's value.

func (*TopicsDetectionJobProperties) SetNumberOfTopics

func (s *TopicsDetectionJobProperties) SetNumberOfTopics(v int64) *TopicsDetectionJobProperties

SetNumberOfTopics sets the NumberOfTopics field's value.

func (*TopicsDetectionJobProperties) SetOutputDataConfig

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

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*TopicsDetectionJobProperties) SetSubmitTime

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

SetSubmitTime sets the SubmitTime field's value.

func (TopicsDetectionJobProperties) String

func (s TopicsDetectionJobProperties) String() string

String returns the string representation