Amazonka.Comprehend.Types.EventsDetectionJobProperties

Documentation

data EventsDetectionJobProperties

Provides information about an events detection job.

See: newEventsDetectionJobProperties smart constructor.

Constructors

EventsDetectionJobProperties'

Fields

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

• endTime :: Maybe POSIX

  The time that the events detection job completed.

• inputDataConfig :: Maybe InputDataConfig

  The input data configuration that you supplied when you created 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

• jobId :: Maybe Text

  The identifier assigned to the events detection job.

• jobName :: Maybe Text

  The name you assigned the events detection job.

• jobStatus :: Maybe JobStatus

  The current status of the events detection job.

• languageCode :: Maybe LanguageCode

  The language code of the input documents.

• message :: Maybe Text

  A description of the status of the events detection job.

• outputDataConfig :: Maybe OutputDataConfig

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

• submitTime :: Maybe POSIX

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

• targetEventTypes :: Maybe (NonEmpty Text)

  The types of events that are detected by the job.

Instances

FromJSON EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Methods

parseJSON :: Value -> Parser EventsDetectionJobProperties

parseJSONList :: Value -> Parser [EventsDetectionJobProperties]

Generic EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Associated Types

type Rep EventsDetectionJobProperties :: Type -> Type

Methods

from :: EventsDetectionJobProperties -> Rep EventsDetectionJobProperties x

to :: Rep EventsDetectionJobProperties x -> EventsDetectionJobProperties

Read EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Methods

readsPrec :: Int -> ReadS EventsDetectionJobProperties

readList :: ReadS [EventsDetectionJobProperties]

readPrec :: ReadPrec EventsDetectionJobProperties

readListPrec :: ReadPrec [EventsDetectionJobProperties]

Show EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Methods

showsPrec :: Int -> EventsDetectionJobProperties -> ShowS

show :: EventsDetectionJobProperties -> String

showList :: [EventsDetectionJobProperties] -> ShowS

NFData EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Methods

rnf :: EventsDetectionJobProperties -> ()

Eq EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Methods

(==) :: EventsDetectionJobProperties -> EventsDetectionJobProperties -> Bool

(/=) :: EventsDetectionJobProperties -> EventsDetectionJobProperties -> Bool

Hashable EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

Methods

hashWithSalt :: Int -> EventsDetectionJobProperties -> Int

hash :: EventsDetectionJobProperties -> Int

type Rep EventsDetectionJobProperties

Defined in Amazonka.Comprehend.Types.EventsDetectionJobProperties

type Rep EventsDetectionJobProperties = D1 ('MetaData "EventsDetectionJobProperties" "Amazonka.Comprehend.Types.EventsDetectionJobProperties" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "EventsDetectionJobProperties'" '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 "targetEventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))))

newEventsDetectionJobProperties :: EventsDetectionJobProperties

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: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:endTime:EventsDetectionJobProperties', eventsDetectionJobProperties_endTime - The time that the events detection job completed.

$sel:inputDataConfig:EventsDetectionJobProperties', eventsDetectionJobProperties_inputDataConfig - The input data configuration that you supplied when you created 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:jobId:EventsDetectionJobProperties', eventsDetectionJobProperties_jobId - The identifier assigned to the events detection job.

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

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

$sel:languageCode:EventsDetectionJobProperties', eventsDetectionJobProperties_languageCode - The language code of the input documents.

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

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

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

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

eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (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.

eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime)

The time that the events detection job completed.

eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig)

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

eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (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

eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text)

The identifier assigned to the events detection job.

eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text)

The name you assigned the events detection job.

eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus)

The current status of the events detection job.

eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode)

The language code of the input documents.

eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text)

A description of the status of the events detection job.

eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig)

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

eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime)

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

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

The types of events that are detected by the job.