Skip to content

GetJobResponse

Source code in docs_src/capo_braket/types/get_job_response.py
class GetJobResponse(TypedDict, closed=True):
    status: "capo_braket.types.job_primary_status.JobPrimaryStatus"
    """<p>The status of the Amazon Braket hybrid job.</p>"""
    job_arn: "capo_braket.types.job_arn.JobArn"
    """<p>The ARN 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 other hybrid job details to the s3 buckets of a user.</p>"""
    failure_reason: NotRequired["capo_braket.types.string1024.String1024"]
    """<p>A description of the reason why an Amazon Braket hybrid job failed, if it failed.</p>"""
    job_name: "str"
    """<p>The name of the Amazon Braket hybrid job.</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 traiing 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 th hyperparameter.</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 hybrid job artifacts are stored and the encryption key used to store them there.</p>"""
    stopping_condition: NotRequired[
        "capo_braket.types.job_stopping_condition.JobStoppingCondition"
    ]
    """<p>The user-defined criteria that specifies when to stop a running hybrid job.</p>"""
    checkpoint_config: NotRequired[
        "capo_braket.types.job_checkpoint_config.JobCheckpointConfig"
    ]
    """<p>Information about the output locations for hybrid job checkpoint data.</p>"""
    algorithm_specification: (
        "capo_braket.types.algorithm_specification.AlgorithmSpecification"
    )
    """<p>Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.</p>"""
    instance_config: "capo_braket.types.instance_config.InstanceConfig"
    """<p>The resource instances to use while running the hybrid job on Amazon Braket.</p>"""
    created_at: "datetime.datetime"
    """<p>The time at which the Amazon Braket hybrid job was created.</p>"""
    started_at: NotRequired["datetime.datetime"]
    """<p>The time at which the Amazon Braket hybrid job was started.</p>"""
    ended_at: NotRequired["datetime.datetime"]
    """<p>The time at which the Amazon Braket hybrid job ended.</p>"""
    billable_duration: NotRequired["int"]
    """<p>The billable time for which the Amazon Braket hybrid job used to complete.</p>"""
    device_config: NotRequired["capo_braket.types.device_config.DeviceConfig"]
    """<p>The primary device used by the Amazon Braket hybrid job.</p>"""
    events: NotRequired["capo_braket.types.job_events.JobEvents"]
    """<p>Details about the time and type of events occurred related to the Amazon Braket hybrid job.</p>"""
    tags: NotRequired["capo_braket.types.tags_map.TagsMap"]
    """<p>The tags associated with this hybrid job.</p>"""
    queue_info: NotRequired[
        "capo_braket.types.hybrid_job_queue_info.HybridJobQueueInfo"
    ]
    """<p>Queue information for the requested hybrid job. Only returned if <code>QueueInfo</code> is specified in the <code>additionalAttributeNames"</code> field in the <code>GetJob</code> API request.</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 hybrid job created. Provides information about the container image used, and the Python scripts used for training.

associations instance-attribute

associations: NotRequired[Associations]

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

billable_duration instance-attribute

billable_duration: NotRequired[int]

The billable time for which the Amazon Braket hybrid job used to complete.

checkpoint_config instance-attribute

checkpoint_config: NotRequired[JobCheckpointConfig]

Information about the output locations for hybrid job checkpoint data.

created_at instance-attribute

created_at: datetime

The time at which the Amazon Braket hybrid job was created.

device_config instance-attribute

device_config: NotRequired[DeviceConfig]

The primary device used by the Amazon Braket hybrid job.

ended_at instance-attribute

ended_at: NotRequired[datetime]

The time at which the Amazon Braket hybrid job ended.

events instance-attribute

events: NotRequired[JobEvents]

Details about the time and type of events occurred related to the Amazon Braket hybrid job.

failure_reason instance-attribute

failure_reason: NotRequired[String1024]

A description of the reason why an Amazon Braket hybrid job failed, if it failed.

hyper_parameters instance-attribute

hyper_parameters: NotRequired[HyperParameters]

Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing 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 th hyperparameter.

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

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

job_arn instance-attribute

job_arn: JobArn

The ARN of the Amazon Braket hybrid job.

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 hybrid job artifacts are stored and the encryption key used to store them there.

queue_info instance-attribute

queue_info: NotRequired[HybridJobQueueInfo]

Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

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 other hybrid job details to the s3 buckets of a user.

started_at instance-attribute

started_at: NotRequired[datetime]

The time at which the Amazon Braket hybrid job was started.

status instance-attribute

The status of the Amazon Braket hybrid job.

stopping_condition instance-attribute

stopping_condition: NotRequired[JobStoppingCondition]

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

tags instance-attribute

tags: NotRequired[TagsMap]

The tags associated with this hybrid job.