-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_op_StartTask.go
233 lines (198 loc) · 8.35 KB
/
api_op_StartTask.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
233
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package ecs
import (
"context"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
type StartTaskInput struct {
_ struct{} `type:"structure"`
// The short name or full Amazon Resource Name (ARN) of the cluster on which
// to start your task. If you do not specify a cluster, the default cluster
// is assumed.
Cluster *string `locationName:"cluster" type:"string"`
// The container instance IDs or full ARN entries for the container instances
// on which you would like to place your task. You can specify up to 10 container
// instances.
//
// ContainerInstances is a required field
ContainerInstances []string `locationName:"containerInstances" type:"list" required:"true"`
// Specifies whether to enable Amazon ECS managed tags for the task. For more
// information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
// in the Amazon Elastic Container Service Developer Guide.
EnableECSManagedTags *bool `locationName:"enableECSManagedTags" type:"boolean"`
// The name of the task group to associate with the task. The default value
// is the family name of the task definition (for example, family:my-family-name).
Group *string `locationName:"group" type:"string"`
// The VPC subnet and security group configuration for tasks that receive their
// own elastic network interface by using the awsvpc networking mode.
NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"`
// A list of container overrides in JSON format that specify the name of a container
// in the specified task definition and the overrides it should receive. You
// can override the default command for a container (that is specified in the
// task definition or Docker image) with a command override. You can also override
// existing environment variables (that are specified in the task definition
// or Docker image) on a container or add new environment variables to it with
// an environment override.
//
// A total of 8192 characters are allowed for overrides. This limit includes
// the JSON formatting characters of the override structure.
Overrides *TaskOverride `locationName:"overrides" type:"structure"`
// Specifies whether to propagate the tags from the task definition or the service
// to the task. If no value is specified, the tags are not propagated.
PropagateTags PropagateTags `locationName:"propagateTags" type:"string" enum:"true"`
// The reference ID to use for the task.
ReferenceId *string `locationName:"referenceId" type:"string"`
// An optional tag specified when a task is started. For example, if you automatically
// trigger a task to run a batch process job, you could apply a unique identifier
// for that job to your task with the startedBy parameter. You can then identify
// which tasks belong to that job by filtering the results of a ListTasks call
// with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers,
// hyphens, and underscores are allowed.
//
// If a task is started by an Amazon ECS service, then the startedBy parameter
// contains the deployment ID of the service that starts it.
StartedBy *string `locationName:"startedBy" type:"string"`
// The metadata that you apply to the task to help you categorize and organize
// them. Each tag consists of a key and an optional value, both of which you
// define.
//
// The following basic restrictions apply to tags:
//
// * Maximum number of tags per resource - 50
//
// * For each resource, each tag key must be unique, and each tag key can
// have only one value.
//
// * Maximum key length - 128 Unicode characters in UTF-8
//
// * Maximum value length - 256 Unicode characters in UTF-8
//
// * If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable
// in UTF-8, and the following characters: + - = . _ : / @.
//
// * Tag keys and values are case-sensitive.
//
// * Do not use aws:, AWS:, or any upper or lowercase combination of such
// as a prefix for either keys or values as it is reserved for AWS use. You
// cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag `locationName:"tags" type:"list"`
// The family and revision (family:revision) or full ARN of the task definition
// to start. If a revision is not specified, the latest ACTIVE revision is used.
//
// TaskDefinition is a required field
TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"`
}
// String returns the string representation
func (s StartTaskInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StartTaskInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "StartTaskInput"}
if s.ContainerInstances == nil {
invalidParams.Add(aws.NewErrParamRequired("ContainerInstances"))
}
if s.TaskDefinition == nil {
invalidParams.Add(aws.NewErrParamRequired("TaskDefinition"))
}
if s.NetworkConfiguration != nil {
if err := s.NetworkConfiguration.Validate(); err != nil {
invalidParams.AddNested("NetworkConfiguration", err.(aws.ErrInvalidParams))
}
}
if s.Overrides != nil {
if err := s.Overrides.Validate(); err != nil {
invalidParams.AddNested("Overrides", err.(aws.ErrInvalidParams))
}
}
if s.Tags != nil {
for i, v := range s.Tags {
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(aws.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
type StartTaskOutput struct {
_ struct{} `type:"structure"`
// Any failures associated with the call.
Failures []Failure `locationName:"failures" type:"list"`
// A full description of the tasks that were started. Each task that was successfully
// placed on your container instances is described.
Tasks []Task `locationName:"tasks" type:"list"`
}
// String returns the string representation
func (s StartTaskOutput) String() string {
return awsutil.Prettify(s)
}
const opStartTask = "StartTask"
// StartTaskRequest returns a request value for making API operation for
// Amazon EC2 Container Service.
//
// Starts a new task from the specified task definition on the specified container
// instance or instances.
//
// Alternatively, you can use RunTask to place tasks for you. For more information,
// see Scheduling Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html)
// in the Amazon Elastic Container Service Developer Guide.
//
// // Example sending a request using StartTaskRequest.
// req := client.StartTaskRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTask
func (c *Client) StartTaskRequest(input *StartTaskInput) StartTaskRequest {
op := &aws.Operation{
Name: opStartTask,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &StartTaskInput{}
}
req := c.newRequest(op, input, &StartTaskOutput{})
return StartTaskRequest{Request: req, Input: input, Copy: c.StartTaskRequest}
}
// StartTaskRequest is the request type for the
// StartTask API operation.
type StartTaskRequest struct {
*aws.Request
Input *StartTaskInput
Copy func(*StartTaskInput) StartTaskRequest
}
// Send marshals and sends the StartTask API request.
func (r StartTaskRequest) Send(ctx context.Context) (*StartTaskResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &StartTaskResponse{
StartTaskOutput: r.Request.Data.(*StartTaskOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// StartTaskResponse is the response type for the
// StartTask API operation.
type StartTaskResponse struct {
*StartTaskOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// StartTask request.
func (r *StartTaskResponse) SDKResponseMetdata() *aws.Response {
return r.response
}