1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package braket
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/braket/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Retrieves the specified Amazon Braket job.
func (c *Client) GetJob(ctx context.Context, params *GetJobInput, optFns ...func(*Options)) (*GetJobOutput, error) {
if params == nil {
params = &GetJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetJob", params, optFns, c.addOperationGetJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetJobOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetJobInput struct {
// The ARN of the job to retrieve.
//
// This member is required.
JobArn *string
// A list of attributes to return information for.
AdditionalAttributeNames []types.HybridJobAdditionalAttributeName
noSmithyDocumentSerde
}
type GetJobOutput struct {
// 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.
//
// This member is required.
AlgorithmSpecification *types.AlgorithmSpecification
// The date and time that the Amazon Braket job was created.
//
// This member is required.
CreatedAt *time.Time
// The resource instances to use while running the hybrid job on Amazon Braket.
//
// This member is required.
InstanceConfig *types.InstanceConfig
// The ARN of the Amazon Braket job.
//
// This member is required.
JobArn *string
// The name of the Amazon Braket job.
//
// This member is required.
JobName *string
// The path to the S3 location where job artifacts are stored and the encryption
// key used to store them there.
//
// This member is required.
OutputDataConfig *types.JobOutputDataConfig
// 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.
//
// This member is required.
RoleArn *string
// The status of the Amazon Braket job.
//
// This member is required.
Status types.JobPrimaryStatus
// The list of Amazon Braket resources associated with the hybrid job.
Associations []types.Association
// The billable time the Amazon Braket job used to complete.
BillableDuration *int32
// Information about the output locations for job checkpoint data.
CheckpointConfig *types.JobCheckpointConfig
// The quantum processing unit (QPU) or simulator used to run the Amazon Braket
// job.
DeviceConfig *types.DeviceConfig
// The date and time that the Amazon Braket job ended.
EndedAt *time.Time
// Details about the type and time events occurred related to the Amazon Braket
// job.
Events []types.JobEventDetails
// A description of the reason why an Amazon Braket job failed, if it failed.
FailureReason *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.
HyperParameters map[string]string
// A list of parameters that specify the name and type of input data and where it
// is located.
InputDataConfig []types.InputFileConfig
// Queue information for the requested job. Only returned if QueueInfo is
// specified in the additionalAttributeNames" field in the GetJob API request.
QueueInfo *types.HybridJobQueueInfo
// The date and time that the Amazon Braket job was started.
StartedAt *time.Time
// The user-defined criteria that specifies when to stop a job running.
StoppingCondition *types.JobStoppingCondition
// A tag object that consists of a key and an optional value, used to manage
// metadata for Amazon Braket resources.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetJob{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetJob"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpGetJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetJob(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetJob",
}
}
|