Skip to content

CreateModelInvocationJobRequest

Source code in docs_src/capo_bedrock/types/create_model_invocation_job_request.py
class CreateModelInvocationJobRequest(TypedDict, closed=True):
    job_name: "capo_bedrock.types.model_invocation_job_name.ModelInvocationJobName"
    """<p>A name to give the batch inference job.</p>"""
    role_arn: "capo_bedrock.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html">Create a service role for batch inference</a>.</p>"""
    client_request_token: NotRequired[
        "capo_bedrock.types.model_invocation_idempotency_token.ModelInvocationIdempotencyToken"
    ]
    """<p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>"""
    model_id: "capo_bedrock.types.model_id.ModelId"
    """<p>The unique identifier of the foundation model to use for the batch inference job.</p>"""
    input_data_config: "capo_bedrock.types.model_invocation_job_input_data_config.ModelInvocationJobInputDataConfig"
    """<p>Details about the location of the input to the batch inference job.</p>"""
    output_data_config: "capo_bedrock.types.model_invocation_job_output_data_config.ModelInvocationJobOutputDataConfig"
    """<p>Details about the location of the output of the batch inference job.</p>"""
    vpc_config: NotRequired["capo_bedrock.types.vpc_config.VpcConfig"]
    """<p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>"""
    timeout_duration_in_hours: NotRequired[
        "capo_bedrock.types.model_invocation_job_timeout_duration_in_hours.ModelInvocationJobTimeoutDurationInHours"
    ]
    """<p>The number of hours after which to force the batch inference job to time out.</p>"""
    tags: NotRequired["capo_bedrock.types.tag_list.TagList"]
    """<p>Any tags to associate with the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging Amazon Bedrock resources</a>.</p>"""
    model_invocation_type: (
        "capo_bedrock.types.model_invocation_type.ModelInvocationType"
    )
    """<p>The invocation endpoint for ModelInvocationJob</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ModelInvocationIdempotencyToken]

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

input_data_config instance-attribute

Details about the location of the input to the batch inference job.

job_name instance-attribute

A name to give the batch inference job.

model_id instance-attribute

model_id: ModelId

The unique identifier of the foundation model to use for the batch inference job.

model_invocation_type instance-attribute

model_invocation_type: ModelInvocationType

The invocation endpoint for ModelInvocationJob

output_data_config instance-attribute

Details about the location of the output of the batch inference job.

role_arn instance-attribute

role_arn: RoleArn

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

tags instance-attribute

tags: NotRequired[TagList]

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

timeout_duration_in_hours instance-attribute

timeout_duration_in_hours: NotRequired[ModelInvocationJobTimeoutDurationInHours]

The number of hours after which to force the batch inference job to time out.

vpc_config instance-attribute

vpc_config: NotRequired[VpcConfig]

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.