Skip to content

CreateJobRequest

Source code in docs_src/capo_braket/types/create_job_request.py
class CreateJobRequest(TypedDict, closed=True):
    client_token: "capo_braket.types.string64.String64"
    """<p>The client token associated with this request that guarantees that the request is idempotent.</p>"""
    algorithm_specification: (
        "capo_braket.types.algorithm_specification.AlgorithmSpecification"
    )
    """<p>Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.</p>"""
    input_data_config: NotRequired[
        "capo_braket.types.input_config_list.InputConfigList"
    ]
    """<p>A list of parameters that specify the name and type of input data and where it is located.</p>"""
    output_data_config: "capo_braket.types.job_output_data_config.JobOutputDataConfig"
    """<p>The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.</p>"""
    checkpoint_config: NotRequired[
        "capo_braket.types.job_checkpoint_config.JobCheckpointConfig"
    ]
    """<p>Information about the output locations for hybrid job checkpoint data.</p>"""
    job_name: "str"
    """<p>The name of the Amazon Braket hybrid job.</p>"""
    role_arn: "capo_braket.types.role_arn.RoleArn"
    """<p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the users' s3 buckets.</p>"""
    stopping_condition: NotRequired[
        "capo_braket.types.job_stopping_condition.JobStoppingCondition"
    ]
    """<p> The user-defined criteria that specifies when a hybrid job stops running.</p>"""
    instance_config: "capo_braket.types.instance_config.InstanceConfig"
    """<p>Configuration of the resource instances to use while running the hybrid job on Amazon Braket.</p>"""
    hyper_parameters: NotRequired["capo_braket.types.hyper_parameters.HyperParameters"]
    """<p>Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.</p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.</p> </important>"""
    device_config: "capo_braket.types.device_config.DeviceConfig"
    """<p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.</p>"""
    tags: NotRequired["capo_braket.types.tags_map.TagsMap"]
    """<p>Tags to be added to the hybrid job you're creating.</p>"""
    associations: NotRequired["capo_braket.types.associations.Associations"]
    """<p>The list of Amazon Braket resources associated with the hybrid job.</p>"""

algorithm_specification instance-attribute

algorithm_specification: AlgorithmSpecification

Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

associations instance-attribute

associations: NotRequired[Associations]

The list of Amazon Braket resources associated with the hybrid job.

checkpoint_config instance-attribute

checkpoint_config: NotRequired[JobCheckpointConfig]

Information about the output locations for hybrid job checkpoint data.

client_token instance-attribute

client_token: String64

The client token associated with this request that guarantees that the request is idempotent.

device_config instance-attribute

device_config: DeviceConfig

The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.

hyper_parameters instance-attribute

hyper_parameters: NotRequired[HyperParameters]

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.

Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

input_data_config instance-attribute

input_data_config: NotRequired[InputConfigList]

A list of parameters that specify the name and type of input data and where it is located.

instance_config instance-attribute

instance_config: InstanceConfig

Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

job_name instance-attribute

job_name: str

The name of the Amazon Braket hybrid job.

output_data_config instance-attribute

output_data_config: JobOutputDataConfig

The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.

role_arn instance-attribute

role_arn: RoleArn

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the users' s3 buckets.

stopping_condition instance-attribute

stopping_condition: NotRequired[JobStoppingCondition]

The user-defined criteria that specifies when a hybrid job stops running.

tags instance-attribute

tags: NotRequired[TagsMap]

Tags to be added to the hybrid job you're creating.