Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Comprehend.StartTargetedSentimentDetectionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the operation to track the status of a job.

Synopsis

Creating a Request

data StartTargetedSentimentDetectionJob Source #

See: newStartTargetedSentimentDetectionJob smart constructor.

Constructors

StartTargetedSentimentDetectionJob'

Fields

clientRequestToken :: Maybe Text
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
jobName :: Maybe Text
The identifier of the job.
tags :: Maybe [Tag]
Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
volumeKmsKeyId :: Maybe Text
ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
vpcConfig :: Maybe VpcConfig
inputDataConfig :: InputDataConfig
outputDataConfig :: OutputDataConfig
Specifies where to send the output files.
dataAccessRoleArn :: Text
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.
languageCode :: LanguageCode
The language of the input documents. Currently, English is the only supported language.

Instances

Instances details

ToJSON StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods toJSON :: StartTargetedSentimentDetectionJob -> Value # toEncoding :: StartTargetedSentimentDetectionJob -> Encoding # toJSONList :: [StartTargetedSentimentDetectionJob] -> Value # toEncodingList :: [StartTargetedSentimentDetectionJob] -> Encoding #
ToHeaders StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods toHeaders :: StartTargetedSentimentDetectionJob -> [Header] #
ToPath StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods toPath :: StartTargetedSentimentDetectionJob -> ByteString #
ToQuery StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods toQuery :: StartTargetedSentimentDetectionJob -> QueryString #
AWSRequest StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Associated Types type AWSResponse StartTargetedSentimentDetectionJob # Methods request :: (Service -> Service) -> StartTargetedSentimentDetectionJob -> Request StartTargetedSentimentDetectionJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartTargetedSentimentDetectionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartTargetedSentimentDetectionJob))) #
Generic StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Associated Types type Rep StartTargetedSentimentDetectionJob :: Type -> Type # Methods from :: StartTargetedSentimentDetectionJob -> Rep StartTargetedSentimentDetectionJob x # to :: Rep StartTargetedSentimentDetectionJob x -> StartTargetedSentimentDetectionJob #
Read StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods readsPrec :: Int -> ReadS StartTargetedSentimentDetectionJob # readList :: ReadS [StartTargetedSentimentDetectionJob] # readPrec :: ReadPrec StartTargetedSentimentDetectionJob # readListPrec :: ReadPrec [StartTargetedSentimentDetectionJob] #
Show StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods showsPrec :: Int -> StartTargetedSentimentDetectionJob -> ShowS # show :: StartTargetedSentimentDetectionJob -> String # showList :: [StartTargetedSentimentDetectionJob] -> ShowS #
NFData StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods rnf :: StartTargetedSentimentDetectionJob -> () #
Eq StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods (==) :: StartTargetedSentimentDetectionJob -> StartTargetedSentimentDetectionJob -> Bool # (/=) :: StartTargetedSentimentDetectionJob -> StartTargetedSentimentDetectionJob -> Bool #
Hashable StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods hashWithSalt :: Int -> StartTargetedSentimentDetectionJob -> Int # hash :: StartTargetedSentimentDetectionJob -> Int #
type AWSResponse StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob type AWSResponse StartTargetedSentimentDetectionJob = StartTargetedSentimentDetectionJobResponse
type Rep StartTargetedSentimentDetectionJob Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob type Rep StartTargetedSentimentDetectionJob = D1 ('MetaData "StartTargetedSentimentDetectionJob" "Amazonka.Comprehend.StartTargetedSentimentDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartTargetedSentimentDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig)) :: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))))

newStartTargetedSentimentDetectionJob Source #

Arguments

:: InputDataConfig	`StartTargetedSentimentDetectionJob`
-> OutputDataConfig	`StartTargetedSentimentDetectionJob`
-> Text	`StartTargetedSentimentDetectionJob`
-> LanguageCode	`StartTargetedSentimentDetectionJob`
-> StartTargetedSentimentDetectionJob

Create a value of StartTargetedSentimentDetectionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientRequestToken:StartTargetedSentimentDetectionJob', startTargetedSentimentDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

StartTargetedSentimentDetectionJob, startTargetedSentimentDetectionJob_jobName - The identifier of the job.

$sel:tags:StartTargetedSentimentDetectionJob', startTargetedSentimentDetectionJob_tags - Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

StartTargetedSentimentDetectionJob, startTargetedSentimentDetectionJob_volumeKmsKeyId - ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

StartTargetedSentimentDetectionJob, startTargetedSentimentDetectionJob_vpcConfig - Undocumented member.

StartTargetedSentimentDetectionJob, startTargetedSentimentDetectionJob_inputDataConfig - Undocumented member.

StartTargetedSentimentDetectionJob, startTargetedSentimentDetectionJob_outputDataConfig - Specifies where to send the output files.

StartTargetedSentimentDetectionJob, startTargetedSentimentDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

StartTargetedSentimentDetectionJob, startTargetedSentimentDetectionJob_languageCode - The language of the input documents. Currently, English is the only supported language.

Request Lenses

startTargetedSentimentDetectionJob_clientRequestToken :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) Source #

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

startTargetedSentimentDetectionJob_jobName :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) Source #

The identifier of the job.

startTargetedSentimentDetectionJob_tags :: Lens' StartTargetedSentimentDetectionJob (Maybe [Tag]) Source #

Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

startTargetedSentimentDetectionJob_volumeKmsKeyId :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) Source #

ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

startTargetedSentimentDetectionJob_vpcConfig :: Lens' StartTargetedSentimentDetectionJob (Maybe VpcConfig) Source #

Undocumented member.

startTargetedSentimentDetectionJob_inputDataConfig :: Lens' StartTargetedSentimentDetectionJob InputDataConfig Source #

Undocumented member.

startTargetedSentimentDetectionJob_outputDataConfig :: Lens' StartTargetedSentimentDetectionJob OutputDataConfig Source #

Specifies where to send the output files.

startTargetedSentimentDetectionJob_dataAccessRoleArn :: Lens' StartTargetedSentimentDetectionJob Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

startTargetedSentimentDetectionJob_languageCode :: Lens' StartTargetedSentimentDetectionJob LanguageCode Source #

The language of the input documents. Currently, English is the only supported language.

Destructuring the Response

data StartTargetedSentimentDetectionJobResponse Source #

See: newStartTargetedSentimentDetectionJobResponse smart constructor.

Constructors

StartTargetedSentimentDetectionJobResponse'

Fields

jobArn :: Maybe Text
The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
```
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
```
The following is an example job ARN:
```
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
```
jobId :: Maybe Text
The identifier generated for the job. To get the status of a job, use this identifier with the operation.
jobStatus :: Maybe JobStatus
The status of the job.
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Comprehend is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- FAILED - The job did not complete. To get details, use the operation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StartTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Associated Types type Rep StartTargetedSentimentDetectionJobResponse :: Type -> Type # Methods from :: StartTargetedSentimentDetectionJobResponse -> Rep StartTargetedSentimentDetectionJobResponse x # to :: Rep StartTargetedSentimentDetectionJobResponse x -> StartTargetedSentimentDetectionJobResponse #
Read StartTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods readsPrec :: Int -> ReadS StartTargetedSentimentDetectionJobResponse # readList :: ReadS [StartTargetedSentimentDetectionJobResponse] # readPrec :: ReadPrec StartTargetedSentimentDetectionJobResponse # readListPrec :: ReadPrec [StartTargetedSentimentDetectionJobResponse] #
Show StartTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods showsPrec :: Int -> StartTargetedSentimentDetectionJobResponse -> ShowS # show :: StartTargetedSentimentDetectionJobResponse -> String # showList :: [StartTargetedSentimentDetectionJobResponse] -> ShowS #
NFData StartTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods rnf :: StartTargetedSentimentDetectionJobResponse -> () #
Eq StartTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob Methods (==) :: StartTargetedSentimentDetectionJobResponse -> StartTargetedSentimentDetectionJobResponse -> Bool # (/=) :: StartTargetedSentimentDetectionJobResponse -> StartTargetedSentimentDetectionJobResponse -> Bool #
type Rep StartTargetedSentimentDetectionJobResponse Source #
Instance details Defined in Amazonka.Comprehend.StartTargetedSentimentDetectionJob type Rep StartTargetedSentimentDetectionJobResponse = D1 ('MetaData "StartTargetedSentimentDetectionJobResponse" "Amazonka.Comprehend.StartTargetedSentimentDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartTargetedSentimentDetectionJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartTargetedSentimentDetectionJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartTargetedSentimentDetectionJobResponse'`
-> StartTargetedSentimentDetectionJobResponse

Create a value of StartTargetedSentimentDetectionJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartTargetedSentimentDetectionJobResponse, startTargetedSentimentDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

StartTargetedSentimentDetectionJobResponse, startTargetedSentimentDetectionJobResponse_jobId - The identifier generated for the job. To get the status of a job, use this identifier with the operation.

StartTargetedSentimentDetectionJobResponse, startTargetedSentimentDetectionJobResponse_jobStatus - The status of the job.

SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.

$sel:httpStatus:StartTargetedSentimentDetectionJobResponse', startTargetedSentimentDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

startTargetedSentimentDetectionJobResponse_jobArn :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

startTargetedSentimentDetectionJobResponse_jobId :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) Source #

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

startTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe JobStatus) Source #

The status of the job.

SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Comprehend is processing the job.
COMPLETED - The job was successfully completed and the output is available.
FAILED - The job did not complete. To get details, use the operation.

startTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StartTargetedSentimentDetectionJobResponse Int Source #

The response's http status code.