Skip to content

StartEventsDetectionJobRequest

Source code in docs_src/capo_comprehend/types/start_events_detection_job_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class StartEventsDetectionJobRequest(TypedDict, closed=True):
    input_data_config: "capo_comprehend.types.input_data_config.InputDataConfig"
    """<p>Specifies the format and location of the input data for the job.</p>"""
    output_data_config: "capo_comprehend.types.output_data_config.OutputDataConfig"
    """<p>Specifies where to send the output files.</p>"""
    data_access_role_arn: "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>"""
    job_name: NotRequired["capo_comprehend.types.job_name.JobName"]
    """<p>The identifier of the events detection job.</p>"""
    language_code: "capo_comprehend.types.language_code.LanguageCode"
    """<p>The language code of the input documents.</p>"""
    client_request_token: NotRequired[
        "capo_comprehend.types.client_request_token_string.ClientRequestTokenString"
    ]
    """<p>An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>"""
    target_event_types: "capo_comprehend.types.target_event_types.TargetEventTypes"
    """<p>The types of events to detect in the input documents.</p>"""
    tags: NotRequired["capo_comprehend.types.tag_list.TagList"]
    """<p>Tags to associate 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.</p>"""

client_request_token instance-attribute 

client_request_token: NotRequired[ClientRequestTokenString]

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

data_access_role_arn instance-attribute 

data_access_role_arn: IamRoleArn

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

input_data_config instance-attribute 

input_data_config: InputDataConfig

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

job_name instance-attribute 

job_name: NotRequired[JobName]

The identifier of the events detection job.

language_code instance-attribute 

language_code: LanguageCode

The language code of the input documents.

output_data_config instance-attribute 

output_data_config: OutputDataConfig

Specifies where to send the output files.

tags instance-attribute 

tags: NotRequired[TagList]

Tags to associate 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.

target_event_types instance-attribute 

target_event_types: TargetEventTypes

The types of events to detect in the input documents.