Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.Types.EventsDetectionJobProperties

Description

Synopsis

Documentation

data EventsDetectionJobProperties Source #

Provides information about an events detection job.

See: newEventsDetectionJobProperties smart constructor.

Constructors

EventsDetectionJobProperties'

Fields

languageCode :: Maybe LanguageCode
The language code of the input documents.
jobId :: Maybe Text
The identifier assigned to the events detection job.
jobArn :: Maybe Text
The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>
```
The following is an example job ARN:
```
arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
```
jobName :: Maybe Text
The name you assigned the events detection job.
targetEventTypes :: Maybe (NonEmpty Text)
The types of events that are detected by the job.
inputDataConfig :: Maybe InputDataConfig
The input data configuration that you supplied when you created the events detection job.
endTime :: Maybe POSIX
The time that the events detection job completed.
outputDataConfig :: Maybe OutputDataConfig
The output data configuration that you supplied when you created the events detection job.
dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
jobStatus :: Maybe JobStatus
The current status of the events detection job.
message :: Maybe Text
A description of the status of the events detection job.
submitTime :: Maybe POSIX
The time that the events detection job was submitted for processing.

Instances

Instances details

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

newEventsDetectionJobProperties :: EventsDetectionJobProperties Source #

Create a value of EventsDetectionJobProperties 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:languageCode:EventsDetectionJobProperties', eventsDetectionJobProperties_languageCode - The language code of the input documents.

$sel:jobId:EventsDetectionJobProperties', eventsDetectionJobProperties_jobId - The identifier assigned to the events detection job.

$sel:jobArn:EventsDetectionJobProperties', eventsDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>

The following is an example job ARN:

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

$sel:jobName:EventsDetectionJobProperties', eventsDetectionJobProperties_jobName - The name you assigned the events detection job.

$sel:targetEventTypes:EventsDetectionJobProperties', eventsDetectionJobProperties_targetEventTypes - The types of events that are detected by the job.

$sel:inputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created the events detection job.

$sel:endTime:EventsDetectionJobProperties', eventsDetectionJobProperties_endTime - The time that the events detection job completed.

$sel:outputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the events detection job.

$sel:dataAccessRoleArn:EventsDetectionJobProperties', eventsDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:jobStatus:EventsDetectionJobProperties', eventsDetectionJobProperties_jobStatus - The current status of the events detection job.

$sel:message:EventsDetectionJobProperties', eventsDetectionJobProperties_message - A description of the status of the events detection job.

$sel:submitTime:EventsDetectionJobProperties', eventsDetectionJobProperties_submitTime - The time that the events detection job was submitted for processing.

eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode) Source #

The language code of the input documents.

eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text) Source #

The identifier assigned to the events detection job.

eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) of the events 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>:events-detection-job/<job-id>

The following is an example job ARN:

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

eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text) Source #

The name you assigned the events detection job.

eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text)) Source #

The types of events that are detected by the job.

eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig) Source #

The input data configuration that you supplied when you created the events detection job.

eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) Source #

The time that the events detection job completed.

eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig) Source #

The output data configuration that you supplied when you created the events detection job.

eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus) Source #

The current status of the events detection job.

eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text) Source #

A description of the status of the events detection job.

eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) Source #

The time that the events detection job was submitted for processing.