-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_SubmitJob.go
232 lines (203 loc) · 8.93 KB
/
api_op_SubmitJob.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
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
// Code generated by smithy-go-codegen DO NOT EDIT.
package batch
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/batch/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Submits an Batch job from a job definition. Parameters that are specified during
// SubmitJob override parameters defined in the job definition. vCPU and memory
// requirements that are specified in the resourceRequirements objects in the job
// definition are the exception. They can't be overridden this way using the memory
// and vcpus parameters. Rather, you must specify updates to job definition
// parameters in a ResourceRequirements object that's included in the
// containerOverrides parameter. Job queues with a scheduling policy are limited to
// 500 active fair share identifiers at a time. Jobs that run on Fargate resources
// can't be guaranteed to run for more than 14 days. This is because, after 14
// days, Fargate resources might become unavailable and job might be terminated.
func (c *Client) SubmitJob(ctx context.Context, params *SubmitJobInput, optFns ...func(*Options)) (*SubmitJobOutput, error) {
if params == nil {
params = &SubmitJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SubmitJob", params, optFns, c.addOperationSubmitJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SubmitJobOutput)
out.ResultMetadata = metadata
return out, nil
}
// Contains the parameters for SubmitJob.
type SubmitJobInput struct {
// The job definition used by this job. This value can be one of name,
// name:revision, or the Amazon Resource Name (ARN) for the job definition. If name
// is specified without a revision then the latest active revision is used.
//
// This member is required.
JobDefinition *string
// The name of the job. It can be up to 128 letters long. The first character must
// be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens
// (-), and underscores (_).
//
// This member is required.
JobName *string
// The job queue where the job is submitted. You can specify either the name or the
// Amazon Resource Name (ARN) of the queue.
//
// This member is required.
JobQueue *string
// The array properties for the submitted job, such as the size of the array. The
// array size can be between 2 and 10,000. If you specify array properties for a
// job, it becomes an array job. For more information, see Array Jobs
// (https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) in the
// Batch User Guide.
ArrayProperties *types.ArrayProperties
// A list of container overrides in the JSON format that specify the name of a
// container in the specified job definition and the overrides it should receive.
// You can override the default command for a container, which is specified in the
// job definition or the Docker image, with a command override. You can also
// override existing environment variables on a container or add new environment
// variables to it with an environment override.
ContainerOverrides *types.ContainerOverrides
// A list of dependencies for the job. A job can depend upon a maximum of 20 jobs.
// You can specify a SEQUENTIAL type dependency without specifying a job ID for
// array jobs so that each child array job completes sequentially, starting at
// index 0. You can also specify an N_TO_N type dependency with a job ID for array
// jobs. In that case, each index child of this job must wait for the corresponding
// index child of each dependency to complete before it can begin.
DependsOn []types.JobDependency
// A list of node overrides in JSON format that specify the node range to target
// and the container overrides for that node range. This parameter isn't applicable
// to jobs that are running on Fargate resources; use containerOverrides instead.
NodeOverrides *types.NodeOverrides
// Additional parameters passed to the job that replace parameter substitution
// placeholders that are set in the job definition. Parameters are specified as a
// key and value pair mapping. Parameters in a SubmitJob request override any
// corresponding parameter defaults from the job definition.
Parameters map[string]string
// Specifies whether to propagate the tags from the job or job definition to the
// corresponding Amazon ECS task. If no value is specified, the tags aren't
// propagated. Tags can only be propagated to the tasks during task creation. For
// tags with the same name, job tags are given priority over job definitions tags.
// If the total number of combined tags from the job and job definition is over 50,
// the job is moved to the FAILED state. When specified, this overrides the tag
// propagation setting in the job definition.
PropagateTags bool
// The retry strategy to use for failed jobs from this SubmitJob operation. When a
// retry strategy is specified here, it overrides the retry strategy defined in the
// job definition.
RetryStrategy *types.RetryStrategy
// The scheduling priority for the job. This will only affect jobs in job queues
// with a fair share policy. Jobs with a higher scheduling priority will be
// scheduled before jobs with a lower scheduling priority. This will override any
// scheduling priority in the job definition. The minimum supported value is 0 and
// the maximum supported value is 9999.
SchedulingPriorityOverride int32
// The share identifier for the job.
ShareIdentifier *string
// The tags that you apply to the job request to help you categorize and organize
// your resources. Each tag consists of a key and an optional value. For more
// information, see Tagging Amazon Web Services Resources
// (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in Amazon Web
// Services General Reference.
Tags map[string]string
// The timeout configuration for this SubmitJob operation. You can specify a
// timeout duration after which Batch terminates your jobs if they haven't
// finished. If a job is terminated due to a timeout, it isn't retried. The minimum
// value for the timeout is 60 seconds. This configuration overrides any timeout
// configuration specified in the job definition. For array jobs, child jobs have
// the same timeout configuration as the parent job. For more information, see Job
// Timeouts
// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html)
// in the Amazon Elastic Container Service Developer Guide.
Timeout *types.JobTimeout
noSmithyDocumentSerde
}
type SubmitJobOutput struct {
// The unique identifier for the job.
//
// This member is required.
JobId *string
// The name of the job.
//
// This member is required.
JobName *string
// The Amazon Resource Name (ARN) for the job.
JobArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSubmitJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSubmitJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSubmitJob{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSubmitJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSubmitJob(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opSubmitJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "batch",
OperationName: "SubmitJob",
}
}