amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.StartEventsDetectionJob

Description

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

Synopsis

Creating a Request

data StartEventsDetectionJob Source #

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

Instances details
ToJSON StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

ToHeaders StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

ToPath StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

ToQuery StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

AWSRequest StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Generic StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Associated Types

type Rep StartEventsDetectionJob :: Type -> Type #

Read StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Show StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

NFData StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Methods

rnf :: StartEventsDetectionJob -> () #

Eq StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Hashable StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type AWSResponse StartEventsDetectionJob Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJob Source # 
Instance details

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 Source #

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) Source #

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) Source #

The identifier of the events detection job.

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

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 Source #

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

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

startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text) Source #

The types of events to detect in the input documents.

Destructuring the Response

data StartEventsDetectionJobResponse Source #

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

Instances details
Generic StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Associated Types

type Rep StartEventsDetectionJobResponse :: Type -> Type #

Read StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Show StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

NFData StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

Eq StartEventsDetectionJobResponse Source # 
Instance details

Defined in Amazonka.Comprehend.StartEventsDetectionJob

type Rep StartEventsDetectionJobResponse Source # 
Instance details

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 Source #

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) 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

startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text) Source #

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