Struct aws_sdk_braket::operation::get_job::GetJobOutput

#[non_exhaustive]
pub struct GetJobOutput {

    pub status: JobPrimaryStatus,
    pub job_arn: String,
    pub role_arn: String,
    pub failure_reason: Option<String>,
    pub job_name: String,
    pub hyper_parameters: Option<HashMap<String, String>>,
    pub input_data_config: Option<Vec<InputFileConfig>>,
    pub output_data_config: Option<JobOutputDataConfig>,
    pub stopping_condition: Option<JobStoppingCondition>,
    pub checkpoint_config: Option<JobCheckpointConfig>,
    pub algorithm_specification: Option<AlgorithmSpecification>,
    pub instance_config: Option<InstanceConfig>,
    pub created_at: DateTime,
    pub started_at: Option<DateTime>,
    pub ended_at: Option<DateTime>,
    pub billable_duration: Option<i32>,
    pub device_config: Option<DeviceConfig>,
    pub events: Option<Vec<JobEventDetails>>,
    pub tags: Option<HashMap<String, String>>,
    pub queue_info: Option<HybridJobQueueInfo>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: JobPrimaryStatus

The status of the Amazon Braket job.

job_arn: String

The ARN of the Amazon Braket job.

role_arn: String

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 resources to the s3 buckets of a user.

failure_reason: Option<String>

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

job_name: String

The name of the Amazon Braket job.

hyper_parameters: Option<HashMap<String, String>>

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string 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: Option<Vec<InputFileConfig>>

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

output_data_config: Option<JobOutputDataConfig>

The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

stopping_condition: Option<JobStoppingCondition>

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

checkpoint_config: Option<JobCheckpointConfig>

Information about the output locations for job checkpoint data.

algorithm_specification: Option<AlgorithmSpecification>

Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.

instance_config: Option<InstanceConfig>

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

created_at: DateTime

The date and time that the Amazon Braket job was created.

started_at: Option<DateTime>

The date and time that the Amazon Braket job was started.

ended_at: Option<DateTime>

The date and time that the Amazon Braket job ended.

billable_duration: Option<i32>

The billable time the Amazon Braket job used to complete.

device_config: Option<DeviceConfig>

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

events: Option<Vec<JobEventDetails>>

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

tags: Option<HashMap<String, String>>

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

queue_info: Option<HybridJobQueueInfo>

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

Implementations

impl GetJobOutput

pub fn status(&self) -> &JobPrimaryStatus

The status of the Amazon Braket job.

pub fn job_arn(&self) -> &str

The ARN of the Amazon Braket job.

pub fn role_arn(&self) -> &str

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 resources to the s3 buckets of a user.

pub fn failure_reason(&self) -> Option<&str>

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

pub fn job_name(&self) -> &str

The name of the Amazon Braket job.

pub fn hyper_parameters(&self) -> Option<&HashMap<String, String>>

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

pub fn input_data_config(&self) -> &[InputFileConfig]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .input_data_config.is_none().

pub fn output_data_config(&self) -> Option<&JobOutputDataConfig>

The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

pub fn stopping_condition(&self) -> Option<&JobStoppingCondition>

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

pub fn checkpoint_config(&self) -> Option<&JobCheckpointConfig>

Information about the output locations for job checkpoint data.

pub fn algorithm_specification(&self) -> Option<&AlgorithmSpecification>

Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.

pub fn instance_config(&self) -> Option<&InstanceConfig>

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

pub fn created_at(&self) -> &DateTime

The date and time that the Amazon Braket job was created.

pub fn started_at(&self) -> Option<&DateTime>

The date and time that the Amazon Braket job was started.

pub fn ended_at(&self) -> Option<&DateTime>

The date and time that the Amazon Braket job ended.

pub fn billable_duration(&self) -> Option<i32>

The billable time the Amazon Braket job used to complete.

pub fn device_config(&self) -> Option<&DeviceConfig>

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

pub fn events(&self) -> &[JobEventDetails]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .events.is_none().

pub fn tags(&self) -> Option<&HashMap<String, String>>

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

pub fn queue_info(&self) -> Option<&HybridJobQueueInfo>

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

impl GetJobOutput

pub fn builder() -> GetJobOutputBuilder

Creates a new builder-style object to manufacture GetJobOutput.

Trait Implementations

impl Clone for GetJobOutput

fn clone(&self) -> GetJobOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetJobOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetJobOutput

fn eq(&self, other: &GetJobOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetJobOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetJobOutput