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.Types.TargetedSentimentDetectionJobProperties

Description

Synopsis

Documentation

data TargetedSentimentDetectionJobProperties Source #

Provides information about a targeted sentiment detection job.

See: newTargetedSentimentDetectionJobProperties smart constructor.

Constructors

TargetedSentimentDetectionJobProperties'

Fields

dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
endTime :: Maybe POSIX
The time that the targeted sentiment detection job ended.
inputDataConfig :: Maybe InputDataConfig
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 assigned to the targeted sentiment detection job.
jobName :: Maybe Text
The name that you assigned to the targeted sentiment detection job.
jobStatus :: Maybe JobStatus
The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
languageCode :: Maybe LanguageCode
The language code of the input documents.
message :: Maybe Text
A description of the status of a job.
outputDataConfig :: Maybe OutputDataConfig
submitTime :: Maybe POSIX
The time that the targeted sentiment detection job was submitted for processing.
volumeKmsKeyId :: Maybe Text
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:
- KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
- Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
vpcConfig :: Maybe VpcConfig

Instances

Instances details

FromJSON TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties Methods parseJSON :: Value -> Parser TargetedSentimentDetectionJobProperties # parseJSONList :: Value -> Parser [TargetedSentimentDetectionJobProperties] #
Generic TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties Associated Types type Rep TargetedSentimentDetectionJobProperties :: Type -> Type # Methods from :: TargetedSentimentDetectionJobProperties -> Rep TargetedSentimentDetectionJobProperties x # to :: Rep TargetedSentimentDetectionJobProperties x -> TargetedSentimentDetectionJobProperties #
Read TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties Methods readsPrec :: Int -> ReadS TargetedSentimentDetectionJobProperties # readList :: ReadS [TargetedSentimentDetectionJobProperties] # readPrec :: ReadPrec TargetedSentimentDetectionJobProperties # readListPrec :: ReadPrec [TargetedSentimentDetectionJobProperties] #
Show TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties Methods showsPrec :: Int -> TargetedSentimentDetectionJobProperties -> ShowS # show :: TargetedSentimentDetectionJobProperties -> String # showList :: [TargetedSentimentDetectionJobProperties] -> ShowS #
NFData TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties Methods rnf :: TargetedSentimentDetectionJobProperties -> () #
Eq TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties Methods (==) :: TargetedSentimentDetectionJobProperties -> TargetedSentimentDetectionJobProperties -> Bool # (/=) :: TargetedSentimentDetectionJobProperties -> TargetedSentimentDetectionJobProperties -> Bool #
Hashable TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties Methods hashWithSalt :: Int -> TargetedSentimentDetectionJobProperties -> Int # hash :: TargetedSentimentDetectionJobProperties -> Int #
type Rep TargetedSentimentDetectionJobProperties Source #
Instance details Defined in Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties type Rep TargetedSentimentDetectionJobProperties = D1 ('MetaData "TargetedSentimentDetectionJobProperties" "Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "TargetedSentimentDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)))) :: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)) :: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)))))))

newTargetedSentimentDetectionJobProperties :: TargetedSentimentDetectionJobProperties Source #

Create a value of TargetedSentimentDetectionJobProperties 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:dataAccessRoleArn:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:endTime:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_endTime - The time that the targeted sentiment detection job ended.

$sel:inputDataConfig:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_inputDataConfig - Undocumented member.

$sel:jobArn:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_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

$sel:jobId:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_jobId - The identifier assigned to the targeted sentiment detection job.

$sel:jobName:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_jobName - The name that you assigned to the targeted sentiment detection job.

$sel:jobStatus:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_jobStatus - The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

$sel:languageCode:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_languageCode - The language code of the input documents.

$sel:message:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_message - A description of the status of a job.

$sel:outputDataConfig:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_outputDataConfig - Undocumented member.

$sel:submitTime:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_submitTime - The time that the targeted sentiment detection job was submitted for processing.

$sel:volumeKmsKeyId:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_volumeKmsKeyId - ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:

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

$sel:vpcConfig:TargetedSentimentDetectionJobProperties', targetedSentimentDetectionJobProperties_vpcConfig - Undocumented member.

targetedSentimentDetectionJobProperties_dataAccessRoleArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

targetedSentimentDetectionJobProperties_endTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) Source #

The time that the targeted sentiment detection job ended.

targetedSentimentDetectionJobProperties_inputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe InputDataConfig) Source #

Undocumented member.

targetedSentimentDetectionJobProperties_jobArn :: Lens' TargetedSentimentDetectionJobProperties (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

targetedSentimentDetectionJobProperties_jobId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #

The identifier assigned to the targeted sentiment detection job.

targetedSentimentDetectionJobProperties_jobName :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #

The name that you assigned to the targeted sentiment detection job.

targetedSentimentDetectionJobProperties_jobStatus :: Lens' TargetedSentimentDetectionJobProperties (Maybe JobStatus) Source #

The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

targetedSentimentDetectionJobProperties_languageCode :: Lens' TargetedSentimentDetectionJobProperties (Maybe LanguageCode) Source #

The language code of the input documents.

targetedSentimentDetectionJobProperties_message :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #

A description of the status of a job.

targetedSentimentDetectionJobProperties_outputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe OutputDataConfig) Source #

Undocumented member.

targetedSentimentDetectionJobProperties_submitTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) Source #

The time that the targeted sentiment detection job was submitted for processing.

targetedSentimentDetectionJobProperties_volumeKmsKeyId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) Source #

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

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

targetedSentimentDetectionJobProperties_vpcConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe VpcConfig) Source #

Undocumented member.