Amazonka.Comprehend.StartEntitiesDetectionJob

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

Creating a Request

data StartEntitiesDetectionJob

See: newStartEntitiesDetectionJob smart constructor.

Constructors

StartEntitiesDetectionJob'

Fields

• clientRequestToken :: Maybe Text

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

• entityRecognizerArn :: Maybe Text

  The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

• jobName :: Maybe Text

  The identifier of the job.

• tags :: Maybe [Tag]

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

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

  Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

• 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

• languageCode :: LanguageCode

  The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Instances

ToJSON StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

toJSON :: StartEntitiesDetectionJob -> Value

toEncoding :: StartEntitiesDetectionJob -> Encoding

toJSONList :: [StartEntitiesDetectionJob] -> Value

toEncodingList :: [StartEntitiesDetectionJob] -> Encoding

ToHeaders StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

toHeaders :: StartEntitiesDetectionJob -> [Header]

ToPath StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

toPath :: StartEntitiesDetectionJob -> ByteString

ToQuery StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

toQuery :: StartEntitiesDetectionJob -> QueryString

AWSRequest StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Associated Types

type AWSResponse StartEntitiesDetectionJob

Methods

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

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

Generic StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Associated Types

type Rep StartEntitiesDetectionJob :: Type -> Type

Methods

from :: StartEntitiesDetectionJob -> Rep StartEntitiesDetectionJob x

to :: Rep StartEntitiesDetectionJob x -> StartEntitiesDetectionJob

Read StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

readsPrec :: Int -> ReadS StartEntitiesDetectionJob

readList :: ReadS [StartEntitiesDetectionJob]

readPrec :: ReadPrec StartEntitiesDetectionJob

readListPrec :: ReadPrec [StartEntitiesDetectionJob]

Show StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

showsPrec :: Int -> StartEntitiesDetectionJob -> ShowS

show :: StartEntitiesDetectionJob -> String

showList :: [StartEntitiesDetectionJob] -> ShowS

NFData StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

rnf :: StartEntitiesDetectionJob -> ()

Eq StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

(==) :: StartEntitiesDetectionJob -> StartEntitiesDetectionJob -> Bool

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

Hashable StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

hashWithSalt :: Int -> StartEntitiesDetectionJob -> Int

hash :: StartEntitiesDetectionJob -> Int

type AWSResponse StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

type AWSResponse StartEntitiesDetectionJob = StartEntitiesDetectionJobResponse

type Rep StartEntitiesDetectionJob

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

type Rep StartEntitiesDetectionJob = D1 ('MetaData "StartEntitiesDetectionJob" "Amazonka.Comprehend.StartEntitiesDetectionJob" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "StartEntitiesDetectionJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityRecognizerArn") '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 "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: 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))))))

newStartEntitiesDetectionJob

Arguments

:: InputDataConfig

StartEntitiesDetectionJob

-> OutputDataConfig

StartEntitiesDetectionJob

-> Text

StartEntitiesDetectionJob

-> LanguageCode

StartEntitiesDetectionJob

-> StartEntitiesDetectionJob

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

StartEntitiesDetectionJob, startEntitiesDetectionJob_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

StartEntitiesDetectionJob, startEntitiesDetectionJob_jobName - The identifier of the job.

$sel:tags:StartEntitiesDetectionJob', startEntitiesDetectionJob_tags - Tags to be associated with the entities 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.

StartEntitiesDetectionJob, startEntitiesDetectionJob_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 analysis 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"

StartEntitiesDetectionJob, startEntitiesDetectionJob_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

StartEntitiesDetectionJob, startEntitiesDetectionJob_inputDataConfig - Specifies the format and location of the input data for the job.

StartEntitiesDetectionJob, startEntitiesDetectionJob_outputDataConfig - Specifies where to send the output files.

StartEntitiesDetectionJob, startEntitiesDetectionJob_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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

StartEntitiesDetectionJob, startEntitiesDetectionJob_languageCode - The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Request Lenses

startEntitiesDetectionJob_clientRequestToken :: Lens' StartEntitiesDetectionJob (Maybe Text)

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

startEntitiesDetectionJob_entityRecognizerArn :: Lens' StartEntitiesDetectionJob (Maybe Text)

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

startEntitiesDetectionJob_jobName :: Lens' StartEntitiesDetectionJob (Maybe Text)

The identifier of the job.

startEntitiesDetectionJob_tags :: Lens' StartEntitiesDetectionJob (Maybe [Tag])

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

startEntitiesDetectionJob_volumeKmsKeyId :: Lens' StartEntitiesDetectionJob (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 analysis 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"

startEntitiesDetectionJob_vpcConfig :: Lens' StartEntitiesDetectionJob (Maybe VpcConfig)

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

startEntitiesDetectionJob_inputDataConfig :: Lens' StartEntitiesDetectionJob InputDataConfig

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

startEntitiesDetectionJob_outputDataConfig :: Lens' StartEntitiesDetectionJob OutputDataConfig

Specifies where to send the output files.

startEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartEntitiesDetectionJob 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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

startEntitiesDetectionJob_languageCode :: Lens' StartEntitiesDetectionJob LanguageCode

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Destructuring the Response

data StartEntitiesDetectionJobResponse

See: newStartEntitiesDetectionJobResponse smart constructor.

Constructors

StartEntitiesDetectionJobResponse'

Fields

• jobArn :: Maybe Text

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

  The following is an example job ARN:

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

• jobId :: Maybe Text

  The identifier generated for the job. To get the status of job, use this identifier with the operation.

• jobStatus :: Maybe JobStatus

  The status of the job.

  • SUBMITTED - The job has been received and is queued for processing.
  • IN_PROGRESS - Amazon Comprehend is processing the job.
  • COMPLETED - The job was successfully completed and the output is available.
  • FAILED - The job did not complete. To get details, use the operation.
  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
  • STOPPED - The job was successfully stopped without completing.
• httpStatus :: Int

  The response's http status code.

Instances

Generic StartEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Associated Types

type Rep StartEntitiesDetectionJobResponse :: Type -> Type

Methods

from :: StartEntitiesDetectionJobResponse -> Rep StartEntitiesDetectionJobResponse x

to :: Rep StartEntitiesDetectionJobResponse x -> StartEntitiesDetectionJobResponse

Read StartEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

readsPrec :: Int -> ReadS StartEntitiesDetectionJobResponse

readList :: ReadS [StartEntitiesDetectionJobResponse]

readPrec :: ReadPrec StartEntitiesDetectionJobResponse

readListPrec :: ReadPrec [StartEntitiesDetectionJobResponse]

Show StartEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

showsPrec :: Int -> StartEntitiesDetectionJobResponse -> ShowS

show :: StartEntitiesDetectionJobResponse -> String

showList :: [StartEntitiesDetectionJobResponse] -> ShowS

NFData StartEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

rnf :: StartEntitiesDetectionJobResponse -> ()

Eq StartEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

Methods

(==) :: StartEntitiesDetectionJobResponse -> StartEntitiesDetectionJobResponse -> Bool

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

type Rep StartEntitiesDetectionJobResponse

Defined in Amazonka.Comprehend.StartEntitiesDetectionJob

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

newStartEntitiesDetectionJobResponse

Arguments

:: Int

$sel:httpStatus:StartEntitiesDetectionJobResponse'

-> StartEntitiesDetectionJobResponse

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

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

The following is an example job ARN:

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

StartEntitiesDetectionJobResponse, startEntitiesDetectionJobResponse_jobId - The identifier generated for the job. To get the status of job, use this identifier with the operation.

StartEntitiesDetectionJobResponse, startEntitiesDetectionJobResponse_jobStatus - The status of the job.

• SUBMITTED - The job has been received and is queued for processing.
• IN_PROGRESS - Amazon Comprehend is processing the job.
• COMPLETED - The job was successfully completed and the output is available.
• FAILED - The job did not complete. To get details, use the operation.
• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
• STOPPED - The job was successfully stopped without completing.

$sel:httpStatus:StartEntitiesDetectionJobResponse', startEntitiesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

startEntitiesDetectionJobResponse_jobArn :: Lens' StartEntitiesDetectionJobResponse (Maybe Text)

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

The following is an example job ARN:

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

startEntitiesDetectionJobResponse_jobId :: Lens' StartEntitiesDetectionJobResponse (Maybe Text)

The identifier generated for the job. To get the status of job, use this identifier with the operation.

startEntitiesDetectionJobResponse_jobStatus :: Lens' StartEntitiesDetectionJobResponse (Maybe JobStatus)

The status of the job.

• SUBMITTED - The job has been received and is queued for processing.
• IN_PROGRESS - Amazon Comprehend is processing the job.
• COMPLETED - The job was successfully completed and the output is available.
• FAILED - The job did not complete. To get details, use the operation.
• STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
• STOPPED - The job was successfully stopped without completing.

startEntitiesDetectionJobResponse_httpStatus :: Lens' StartEntitiesDetectionJobResponse Int

The response's http status code.