Skip to content

StartJobRequest

Source code in docs_src/capo_location/types/start_job_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class StartJobRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_location.types.client_token.ClientToken"]
    """<p>A unique identifier for this request to ensure idempotency.</p>"""
    action: "capo_location.types.job_action.JobAction"
    """<p>The action to perform on the input data.</p>"""
    action_options: NotRequired[
        "capo_location.types.job_action_options.JobActionOptions"
    ]
    """<p>Additional parameters that can be requested for each result.</p>"""
    execution_role_arn: "capo_location.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p> <note> <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p> </note> <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>"""
    input_options: "capo_location.types.job_input_options.JobInputOptions"
    """<p>Configuration for input data location and format.</p> <note> <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p> </note>"""
    name: NotRequired["capo_location.types.resource_name.ResourceName"]
    """<p>An optional name for the job resource.</p>"""
    output_options: "capo_location.types.job_output_options.JobOutputOptions"
    """<p>Configuration for output data location and format.</p>"""
    tags: NotRequired["capo_location.types.tag_map.TagMap"]
    """<p>Tags and corresponding values to be associated with the job.</p>"""

action instance-attribute 

action: JobAction

The action to perform on the input data.

action_options instance-attribute 

action_options: NotRequired[JobActionOptions]

Additional parameters that can be requested for each result.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

A unique identifier for this request to ensure idempotency.

execution_role_arn instance-attribute 

execution_role_arn: IamRoleArn

The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.

The IAM role must be created in the same Amazon Web Services account where you plan to run your job.

For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.

input_options instance-attribute 

input_options: JobInputOptions

Configuration for input data location and format.

Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

name instance-attribute 

name: NotRequired[ResourceName]

An optional name for the job resource.

output_options instance-attribute 

output_options: JobOutputOptions

Configuration for output data location and format.

tags instance-attribute 

tags: NotRequired[TagMap]

Tags and corresponding values to be associated with the job.