-
Notifications
You must be signed in to change notification settings - Fork 604
/
api_op_UpdatePipeline.go
378 lines (333 loc) · 14.9 KB
/
api_op_UpdatePipeline.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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package elastictranscoder
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
// The UpdatePipelineRequest structure.
type UpdatePipelineInput struct {
_ struct{} `type:"structure"`
// The AWS Key Management Service (AWS KMS) key that you want to use with this
// pipeline.
//
// If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need
// to provide a key with your job because a default key, known as an AWS-KMS
// key, is created for you automatically. You need to provide an AWS-KMS key
// only if you want to use a non-default AWS-KMS key, or if you are using an
// Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
AwsKmsKeyArn *string `type:"string"`
// The optional ContentConfig object specifies information about the Amazon
// S3 bucket in which you want Elastic Transcoder to save transcoded files and
// playlists: which bucket to use, which users you want to have access to the
// files, the type of access you want users to have, and the storage class that
// you want to assign to the files.
//
// If you specify values for ContentConfig, you must also specify values for
// ThumbnailConfig.
//
// If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket
// object.
//
// * Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to
// save transcoded files and playlists.
//
// * Permissions (Optional): The Permissions object specifies which users
// you want to have access to transcoded files and the type of access you
// want them to have. You can grant permissions to a maximum of 30 users
// and/or predefined Amazon S3 groups.
//
// * Grantee Type: Specify the type of value that appears in the Grantee
// object: Canonical: The value in the Grantee object is either the canonical
// user ID for an AWS account or an origin access identity for an Amazon
// CloudFront distribution. For more information about canonical user IDs,
// see Access Control List (ACL) Overview in the Amazon Simple Storage Service
// Developer Guide. For more information about using CloudFront origin access
// identities to require that users use CloudFront URLs instead of Amazon
// S3 URLs, see Using an Origin Access Identity to Restrict Access to Your
// Amazon S3 Content. A canonical user ID is not the same as an AWS account
// number. Email: The value in the Grantee object is the registered email
// address of an AWS account. Group: The value in the Grantee object is one
// of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers,
// or LogDelivery.
//
// * Grantee: The AWS user or group that you want to have access to transcoded
// files and playlists. To identify the user or group, you can specify the
// canonical user ID for an AWS account, an origin access identity for a
// CloudFront distribution, the registered email address of an AWS account,
// or a predefined Amazon S3 group
//
// * Access: The permission that you want to give to the AWS user that you
// specified in Grantee. Permissions are granted on the files that Elastic
// Transcoder adds to the bucket, including playlists and video files. Valid
// values include: READ: The grantee can read the objects and metadata for
// objects that Elastic Transcoder adds to the Amazon S3 bucket. READ_ACP:
// The grantee can read the object ACL for objects that Elastic Transcoder
// adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL
// for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
// FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions
// for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
//
// * StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy,
// that you want Elastic Transcoder to assign to the video files and playlists
// that it stores in your Amazon S3 bucket.
ContentConfig *PipelineOutputConfig `type:"structure"`
// The ID of the pipeline that you want to update.
//
// Id is a required field
Id *string `location:"uri" locationName:"Id" type:"string" required:"true"`
// The Amazon S3 bucket in which you saved the media files that you want to
// transcode and the graphics that you want to use as watermarks.
InputBucket *string `type:"string"`
// The name of the pipeline. We recommend that the name be unique within the
// AWS account, but uniqueness is not enforced.
//
// Constraints: Maximum 40 characters
Name *string `min:"1" type:"string"`
// The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic
// that you want to notify to report job status.
//
// To receive notifications, you must also subscribe to the new topic in the
// Amazon SNS console.
//
// * Progressing: The topic ARN for the Amazon Simple Notification Service
// (Amazon SNS) topic that you want to notify when Elastic Transcoder has
// started to process jobs that are added to this pipeline. This is the ARN
// that Amazon SNS returned when you created the topic.
//
// * Complete: The topic ARN for the Amazon SNS topic that you want to notify
// when Elastic Transcoder has finished processing a job. This is the ARN
// that Amazon SNS returned when you created the topic.
//
// * Warning: The topic ARN for the Amazon SNS topic that you want to notify
// when Elastic Transcoder encounters a warning condition. This is the ARN
// that Amazon SNS returned when you created the topic.
//
// * Error: The topic ARN for the Amazon SNS topic that you want to notify
// when Elastic Transcoder encounters an error condition. This is the ARN
// that Amazon SNS returned when you created the topic.
Notifications *Notifications `type:"structure"`
// The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder
// to use to transcode jobs for this pipeline.
Role *string `type:"string"`
// The ThumbnailConfig object specifies several values, including the Amazon
// S3 bucket in which you want Elastic Transcoder to save thumbnail files, which
// users you want to have access to the files, the type of access you want users
// to have, and the storage class that you want to assign to the files.
//
// If you specify values for ContentConfig, you must also specify values for
// ThumbnailConfig even if you don't want to create thumbnails.
//
// If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket
// object.
//
// * Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to
// save thumbnail files.
//
// * Permissions (Optional): The Permissions object specifies which users
// and/or predefined Amazon S3 groups you want to have access to thumbnail
// files, and the type of access you want them to have. You can grant permissions
// to a maximum of 30 users and/or predefined Amazon S3 groups.
//
// * GranteeType: Specify the type of value that appears in the Grantee object:
// Canonical: The value in the Grantee object is either the canonical user
// ID for an AWS account or an origin access identity for an Amazon CloudFront
// distribution. A canonical user ID is not the same as an AWS account number.
// Email: The value in the Grantee object is the registered email address
// of an AWS account. Group: The value in the Grantee object is one of the
// following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or
// LogDelivery.
//
// * Grantee: The AWS user or group that you want to have access to thumbnail
// files. To identify the user or group, you can specify the canonical user
// ID for an AWS account, an origin access identity for a CloudFront distribution,
// the registered email address of an AWS account, or a predefined Amazon
// S3 group.
//
// * Access: The permission that you want to give to the AWS user that you
// specified in Grantee. Permissions are granted on the thumbnail files that
// Elastic Transcoder adds to the bucket. Valid values include: READ: The
// grantee can read the thumbnails and metadata for objects that Elastic
// Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can read
// the object ACL for thumbnails that Elastic Transcoder adds to the Amazon
// S3 bucket. WRITE_ACP: The grantee can write the ACL for the thumbnails
// that Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The
// grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails
// that Elastic Transcoder adds to the Amazon S3 bucket.
//
// * StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy,
// that you want Elastic Transcoder to assign to the thumbnails that it stores
// in your Amazon S3 bucket.
ThumbnailConfig *PipelineOutputConfig `type:"structure"`
}
// String returns the string representation
func (s UpdatePipelineInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UpdatePipelineInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "UpdatePipelineInput"}
if s.Id == nil {
invalidParams.Add(aws.NewErrParamRequired("Id"))
}
if s.Name != nil && len(*s.Name) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("Name", 1))
}
if s.ContentConfig != nil {
if err := s.ContentConfig.Validate(); err != nil {
invalidParams.AddNested("ContentConfig", err.(aws.ErrInvalidParams))
}
}
if s.ThumbnailConfig != nil {
if err := s.ThumbnailConfig.Validate(); err != nil {
invalidParams.AddNested("ThumbnailConfig", err.(aws.ErrInvalidParams))
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s UpdatePipelineInput) MarshalFields(e protocol.FieldEncoder) error {
e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/json"), protocol.Metadata{})
if s.AwsKmsKeyArn != nil {
v := *s.AwsKmsKeyArn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "AwsKmsKeyArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.ContentConfig != nil {
v := s.ContentConfig
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "ContentConfig", v, metadata)
}
if s.InputBucket != nil {
v := *s.InputBucket
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "InputBucket", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.Name != nil {
v := *s.Name
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.Notifications != nil {
v := s.Notifications
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Notifications", v, metadata)
}
if s.Role != nil {
v := *s.Role
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "Role", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.ThumbnailConfig != nil {
v := s.ThumbnailConfig
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "ThumbnailConfig", v, metadata)
}
if s.Id != nil {
v := *s.Id
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "Id", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// When you update a pipeline, Elastic Transcoder returns the values that you
// specified in the request.
type UpdatePipelineOutput struct {
_ struct{} `type:"structure"`
// The pipeline updated by this UpdatePipelineResponse call.
Pipeline *Pipeline `type:"structure"`
// Elastic Transcoder returns a warning if the resources used by your pipeline
// are not in the same region as the pipeline.
//
// Using resources in the same region, such as your Amazon S3 buckets, Amazon
// SNS notification topics, and AWS KMS key, reduces processing time and prevents
// cross-regional charges.
Warnings []Warning `type:"list"`
}
// String returns the string representation
func (s UpdatePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s UpdatePipelineOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.Pipeline != nil {
v := s.Pipeline
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "Pipeline", v, metadata)
}
if s.Warnings != nil {
v := s.Warnings
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "Warnings", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddFields(v1)
}
ls0.End()
}
return nil
}
const opUpdatePipeline = "UpdatePipeline"
// UpdatePipelineRequest returns a request value for making API operation for
// Amazon Elastic Transcoder.
//
// Use the UpdatePipeline operation to update settings for a pipeline.
//
// When you change pipeline settings, your changes take effect immediately.
// Jobs that you have already submitted and that Elastic Transcoder has not
// started to process are affected in addition to jobs that you submit after
// you change settings.
//
// // Example sending a request using UpdatePipelineRequest.
// req := client.UpdatePipelineRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
func (c *Client) UpdatePipelineRequest(input *UpdatePipelineInput) UpdatePipelineRequest {
op := &aws.Operation{
Name: opUpdatePipeline,
HTTPMethod: "PUT",
HTTPPath: "/2012-09-25/pipelines/{Id}",
}
if input == nil {
input = &UpdatePipelineInput{}
}
req := c.newRequest(op, input, &UpdatePipelineOutput{})
return UpdatePipelineRequest{Request: req, Input: input, Copy: c.UpdatePipelineRequest}
}
// UpdatePipelineRequest is the request type for the
// UpdatePipeline API operation.
type UpdatePipelineRequest struct {
*aws.Request
Input *UpdatePipelineInput
Copy func(*UpdatePipelineInput) UpdatePipelineRequest
}
// Send marshals and sends the UpdatePipeline API request.
func (r UpdatePipelineRequest) Send(ctx context.Context) (*UpdatePipelineResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &UpdatePipelineResponse{
UpdatePipelineOutput: r.Request.Data.(*UpdatePipelineOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// UpdatePipelineResponse is the response type for the
// UpdatePipeline API operation.
type UpdatePipelineResponse struct {
*UpdatePipelineOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// UpdatePipeline request.
func (r *UpdatePipelineResponse) SDKResponseMetdata() *aws.Response {
return r.response
}