Skip to content

EventsDetectionJobProperties

Source code in docs_src/capo_comprehend/types/events_detection_job_properties.py
class EventsDetectionJobProperties(TypedDict, closed=True):
    job_id: NotRequired["capo_comprehend.types.job_id.JobId"]
    """<p>The identifier assigned to the events detection job.</p>"""
    job_arn: NotRequired["capo_comprehend.types.comprehend_arn.ComprehendArn"]
    """<p>The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:</p> <p> <code>arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id></code> </p> <p>The following is an example job ARN:</p> <p> <code>arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>"""
    job_name: NotRequired["capo_comprehend.types.job_name.JobName"]
    """<p>The name you assigned the events detection job.</p>"""
    job_status: NotRequired["capo_comprehend.types.job_status.JobStatus"]
    """<p>The current status of the events detection job.</p>"""
    message: NotRequired["capo_comprehend.types.any_length_string.AnyLengthString"]
    """<p>A description of the status of the events detection job.</p>"""
    submit_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>The time that the events detection job was submitted for processing.</p>"""
    end_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>The time that the events detection job completed.</p>"""
    input_data_config: NotRequired[
        "capo_comprehend.types.input_data_config.InputDataConfig"
    ]
    """<p>The input data configuration that you supplied when you created the events detection job.</p>"""
    output_data_config: NotRequired[
        "capo_comprehend.types.output_data_config.OutputDataConfig"
    ]
    """<p>The output data configuration that you supplied when you created the events detection job.</p>"""
    language_code: NotRequired["capo_comprehend.types.language_code.LanguageCode"]
    """<p>The language code of the input documents.</p>"""
    data_access_role_arn: NotRequired["capo_comprehend.types.iam_role_arn.IamRoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.</p>"""
    target_event_types: NotRequired[
        "capo_comprehend.types.target_event_types.TargetEventTypes"
    ]
    """<p>The types of events that are detected by the job.</p>"""

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[IamRoleArn]

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

end_time instance-attribute

end_time: NotRequired[Timestamp]

The time that the events detection job completed.

input_data_config instance-attribute

input_data_config: NotRequired[InputDataConfig]

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

job_arn instance-attribute

job_arn: NotRequired[ComprehendArn]

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn::comprehend:::events-detection-job/

The following is an example job ARN:

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

job_id instance-attribute

job_id: NotRequired[JobId]

The identifier assigned to the events detection job.

job_name instance-attribute

job_name: NotRequired[JobName]

The name you assigned the events detection job.

job_status instance-attribute

job_status: NotRequired[JobStatus]

The current status of the events detection job.

language_code instance-attribute

language_code: NotRequired[LanguageCode]

The language code of the input documents.

message instance-attribute

message: NotRequired[AnyLengthString]

A description of the status of the events detection job.

output_data_config instance-attribute

output_data_config: NotRequired[OutputDataConfig]

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

submit_time instance-attribute

submit_time: NotRequired[Timestamp]

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

target_event_types instance-attribute

target_event_types: NotRequired[TargetEventTypes]

The types of events that are detected by the job.