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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package elastictranscoder
import (
"context"
"fmt"
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/elastictranscoder/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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.
func (c *Client) UpdatePipeline(ctx context.Context, params *UpdatePipelineInput, optFns ...func(*Options)) (*UpdatePipelineOutput, error) {
if params == nil {
params = &UpdatePipelineInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdatePipeline", params, optFns, c.addOperationUpdatePipelineMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdatePipelineOutput)
out.ResultMetadata = metadata
return out, nil
}
// The UpdatePipelineRequest structure.
type UpdatePipelineInput struct {
// The ID of the pipeline that you want to update.
//
// This member is required.
Id *string
// 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
// 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 *types.PipelineOutputConfig
// 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
// 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
// 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 *types.Notifications
// The IAM Amazon Resource Name (ARN) for the role that you want Elastic
// Transcoder to use to transcode jobs for this pipeline.
Role *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 *types.PipelineOutputConfig
noSmithyDocumentSerde
}
// When you update a pipeline, Elastic Transcoder returns the values that you
// specified in the request.
type UpdatePipelineOutput struct {
// The pipeline updated by this UpdatePipelineResponse call.
Pipeline *types.Pipeline
// 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 []types.Warning
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdatePipelineMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdatePipeline{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdatePipeline{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdatePipeline"); 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 = 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.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 = addOpUpdatePipelineValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdatePipeline(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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_opUpdatePipeline(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdatePipeline",
}
}
|