Amazonka.Comprehend.StartEventsDetectionJob

Starts an asynchronous event detection job for a collection of documents.

Creating a Request

data StartEventsDetectionJob

See: newStartEventsDetectionJob smart constructor.

Constructors

StartEventsDetectionJob'

Fields

• clientRequestToken :: Maybe Text

  An 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 events detection job.

• tags :: Maybe [Tag]

  Tags to be associated with the events 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.

• inputDataConfig :: InputDataConfig

  Specifies the format and location of the input data for the job.

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

• languageCode :: LanguageCode

  The language code of the input documents.

• targetEventTypes :: NonEmpty Text

  The types of events to detect in the input documents.

Instances

ToJSON StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

toJSON :: StartEventsDetectionJob -> Value

toEncoding :: StartEventsDetectionJob -> Encoding

toJSONList :: [StartEventsDetectionJob] -> Value

toEncodingList :: [StartEventsDetectionJob] -> Encoding

ToHeaders StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

toHeaders :: StartEventsDetectionJob -> [Header]

ToPath StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

toPath :: StartEventsDetectionJob -> ByteString

ToQuery StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

toQuery :: StartEventsDetectionJob -> QueryString

AWSRequest StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Associated Types

type AWSResponse StartEventsDetectionJob

Methods

request :: (Service -> Service) -> StartEventsDetectionJob -> Request StartEventsDetectionJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartEventsDetectionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartEventsDetectionJob)))

Generic StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Associated Types

type Rep StartEventsDetectionJob :: Type -> Type

Methods

from :: StartEventsDetectionJob -> Rep StartEventsDetectionJob x

to :: Rep StartEventsDetectionJob x -> StartEventsDetectionJob

Read StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

readsPrec :: Int -> ReadS StartEventsDetectionJob

readList :: ReadS [StartEventsDetectionJob]

readPrec :: ReadPrec StartEventsDetectionJob

readListPrec :: ReadPrec [StartEventsDetectionJob]

Show StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

showsPrec :: Int -> StartEventsDetectionJob -> ShowS

show :: StartEventsDetectionJob -> String

showList :: [StartEventsDetectionJob] -> ShowS

NFData StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

rnf :: StartEventsDetectionJob -> ()

Eq StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

(==) :: StartEventsDetectionJob -> StartEventsDetectionJob -> Bool

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

Hashable StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

hashWithSalt :: Int -> StartEventsDetectionJob -> Int

hash :: StartEventsDetectionJob -> Int

type AWSResponse StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type AWSResponse StartEventsDetectionJob = StartEventsDetectionJobResponse

type Rep StartEventsDetectionJob

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJob = D1 ('MetaData "StartEventsDetectionJob" "Amazonka.Comprehend.StartEventsDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartEventsDetectionJob'" '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 "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) :*: S1 ('MetaSel ('Just "targetEventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))

newStartEventsDetectionJob

Arguments

:: InputDataConfig

StartEventsDetectionJob

-> OutputDataConfig

StartEventsDetectionJob

-> Text

StartEventsDetectionJob

-> LanguageCode

StartEventsDetectionJob

-> NonEmpty Text

StartEventsDetectionJob

-> StartEventsDetectionJob

Create a value of StartEventsDetectionJob 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:StartEventsDetectionJob', startEventsDetectionJob_clientRequestToken - An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

StartEventsDetectionJob, startEventsDetectionJob_jobName - The identifier of the events detection job.

$sel:tags:StartEventsDetectionJob', startEventsDetectionJob_tags - Tags to be associated with the events 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.

StartEventsDetectionJob, startEventsDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

StartEventsDetectionJob, startEventsDetectionJob_outputDataConfig - Specifies where to send the output files.

StartEventsDetectionJob, startEventsDetectionJob_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.

StartEventsDetectionJob, startEventsDetectionJob_languageCode - The language code of the input documents.

StartEventsDetectionJob, startEventsDetectionJob_targetEventTypes - The types of events to detect in the input documents.

Request Lenses

startEventsDetectionJob_clientRequestToken :: Lens' StartEventsDetectionJob (Maybe Text)

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

startEventsDetectionJob_jobName :: Lens' StartEventsDetectionJob (Maybe Text)

The identifier of the events detection job.

startEventsDetectionJob_tags :: Lens' StartEventsDetectionJob (Maybe [Tag])

Tags to be associated with the events 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.

startEventsDetectionJob_inputDataConfig :: Lens' StartEventsDetectionJob InputDataConfig

Specifies the format and location of the input data for the job.

startEventsDetectionJob_outputDataConfig :: Lens' StartEventsDetectionJob OutputDataConfig

Specifies where to send the output files.

startEventsDetectionJob_dataAccessRoleArn :: Lens' StartEventsDetectionJob 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.

startEventsDetectionJob_languageCode :: Lens' StartEventsDetectionJob LanguageCode

The language code of the input documents.

startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text)

The types of events to detect in the input documents.

Destructuring the Response

data StartEventsDetectionJobResponse

See: newStartEventsDetectionJobResponse smart constructor.

Constructors

StartEventsDetectionJobResponse'

Fields

• 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

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

• jobStatus :: Maybe JobStatus

  The status of the events detection job.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartEventsDetectionJobResponse

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Associated Types

type Rep StartEventsDetectionJobResponse :: Type -> Type

Methods

from :: StartEventsDetectionJobResponse -> Rep StartEventsDetectionJobResponse x

to :: Rep StartEventsDetectionJobResponse x -> StartEventsDetectionJobResponse

Read StartEventsDetectionJobResponse

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

readsPrec :: Int -> ReadS StartEventsDetectionJobResponse

readList :: ReadS [StartEventsDetectionJobResponse]

readPrec :: ReadPrec StartEventsDetectionJobResponse

readListPrec :: ReadPrec [StartEventsDetectionJobResponse]

Show StartEventsDetectionJobResponse

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

showsPrec :: Int -> StartEventsDetectionJobResponse -> ShowS

show :: StartEventsDetectionJobResponse -> String

showList :: [StartEventsDetectionJobResponse] -> ShowS

NFData StartEventsDetectionJobResponse

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

rnf :: StartEventsDetectionJobResponse -> ()

Eq StartEventsDetectionJobResponse

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

(==) :: StartEventsDetectionJobResponse -> StartEventsDetectionJobResponse -> Bool

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

type Rep StartEventsDetectionJobResponse

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJobResponse = D1 ('MetaData "StartEventsDetectionJobResponse" "Amazonka.Comprehend.StartEventsDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartEventsDetectionJobResponse'" '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))))

newStartEventsDetectionJobResponse

Arguments

:: Int

$sel:httpStatus:StartEventsDetectionJobResponse'

-> StartEventsDetectionJobResponse

Create a value of StartEventsDetectionJobResponse 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:

StartEventsDetectionJobResponse, startEventsDetectionJobResponse_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

StartEventsDetectionJobResponse, startEventsDetectionJobResponse_jobId - An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

StartEventsDetectionJobResponse, startEventsDetectionJobResponse_jobStatus - The status of the events detection job.

$sel:httpStatus:StartEventsDetectionJobResponse', startEventsDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

startEventsDetectionJobResponse_jobArn :: Lens' StartEventsDetectionJobResponse (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

startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text)

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

startEventsDetectionJobResponse_jobStatus :: Lens' StartEventsDetectionJobResponse (Maybe JobStatus)

The status of the events detection job.

startEventsDetectionJobResponse_httpStatus :: Lens' StartEventsDetectionJobResponse Int

The response's http status code.