-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_op_DescribeCompilationJob.go
201 lines (166 loc) · 6.94 KB
/
api_op_DescribeCompilationJob.go
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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package sagemaker
import (
"context"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeCompilationJobRequest
type DescribeCompilationJobInput struct {
_ struct{} `type:"structure"`
// The name of the model compilation job that you want information about.
//
// CompilationJobName is a required field
CompilationJobName *string `min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DescribeCompilationJobInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeCompilationJobInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DescribeCompilationJobInput"}
if s.CompilationJobName == nil {
invalidParams.Add(aws.NewErrParamRequired("CompilationJobName"))
}
if s.CompilationJobName != nil && len(*s.CompilationJobName) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("CompilationJobName", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeCompilationJobResponse
type DescribeCompilationJobOutput struct {
_ struct{} `type:"structure"`
// The time when the model compilation job on a compilation job instance ended.
// For a successful or stopped job, this is when the job's model artifacts have
// finished uploading. For a failed job, this is when Amazon SageMaker detected
// that the job failed.
CompilationEndTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes
// to perform the model compilation job.
//
// CompilationJobArn is a required field
CompilationJobArn *string `type:"string" required:"true"`
// The name of the model compilation job.
//
// CompilationJobName is a required field
CompilationJobName *string `min:"1" type:"string" required:"true"`
// The status of the model compilation job.
//
// CompilationJobStatus is a required field
CompilationJobStatus CompilationJobStatus `type:"string" required:"true" enum:"true"`
// The time when the model compilation job started the CompilationJob instances.
//
// You are billed for the time between this timestamp and the timestamp in the
// DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch
// Logs, the start time might be later than this time. That's because it takes
// time to download the compilation job, which depends on the size of the compilation
// job container.
CompilationStartTime *time.Time `type:"timestamp" timestampFormat:"unix"`
// The time that the model compilation job was created.
//
// CreationTime is a required field
CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
// If a model compilation job failed, the reason it failed.
//
// FailureReason is a required field
FailureReason *string `type:"string" required:"true"`
// Information about the location in Amazon S3 of the input model artifacts,
// the name and shape of the expected data inputs, and the framework in which
// the model was trained.
//
// InputConfig is a required field
InputConfig *InputConfig `type:"structure" required:"true"`
// The time that the status of the model compilation job was last modified.
//
// LastModifiedTime is a required field
LastModifiedTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
// Information about the location in Amazon S3 that has been configured for
// storing the model artifacts used in the compilation job.
//
// ModelArtifacts is a required field
ModelArtifacts *ModelArtifacts `type:"structure" required:"true"`
// Information about the output location for the compiled model and the target
// device that the model runs on.
//
// OutputConfig is a required field
OutputConfig *OutputConfig `type:"structure" required:"true"`
// The Amazon Resource Name (ARN) of the model compilation job.
//
// RoleArn is a required field
RoleArn *string `min:"20" type:"string" required:"true"`
// Specifies a limit to how long a model compilation job can run. When the job
// reaches the time limit, Amazon SageMaker ends the compilation job. Use this
// API to cap model training costs.
//
// StoppingCondition is a required field
StoppingCondition *StoppingCondition `type:"structure" required:"true"`
}
// String returns the string representation
func (s DescribeCompilationJobOutput) String() string {
return awsutil.Prettify(s)
}
const opDescribeCompilationJob = "DescribeCompilationJob"
// DescribeCompilationJobRequest returns a request value for making API operation for
// Amazon SageMaker Service.
//
// Returns information about a model compilation job.
//
// To create a model compilation job, use CreateCompilationJob. To get information
// about multiple model compilation jobs, use ListCompilationJobs.
//
// // Example sending a request using DescribeCompilationJobRequest.
// req := client.DescribeCompilationJobRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeCompilationJob
func (c *Client) DescribeCompilationJobRequest(input *DescribeCompilationJobInput) DescribeCompilationJobRequest {
op := &aws.Operation{
Name: opDescribeCompilationJob,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeCompilationJobInput{}
}
req := c.newRequest(op, input, &DescribeCompilationJobOutput{})
return DescribeCompilationJobRequest{Request: req, Input: input, Copy: c.DescribeCompilationJobRequest}
}
// DescribeCompilationJobRequest is the request type for the
// DescribeCompilationJob API operation.
type DescribeCompilationJobRequest struct {
*aws.Request
Input *DescribeCompilationJobInput
Copy func(*DescribeCompilationJobInput) DescribeCompilationJobRequest
}
// Send marshals and sends the DescribeCompilationJob API request.
func (r DescribeCompilationJobRequest) Send(ctx context.Context) (*DescribeCompilationJobResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &DescribeCompilationJobResponse{
DescribeCompilationJobOutput: r.Request.Data.(*DescribeCompilationJobOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// DescribeCompilationJobResponse is the response type for the
// DescribeCompilationJob API operation.
type DescribeCompilationJobResponse struct {
*DescribeCompilationJobOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// DescribeCompilationJob request.
func (r *DescribeCompilationJobResponse) SDKResponseMetdata() *aws.Response {
return r.response
}