« blib/lib/Paws/ElasticTranscoder/Permission.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/PipelineOutputConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::Pipeline; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has AwsKmsKeyArn => (is => 'ro', isa => 'Str'); | ||
| 6 | has ContentConfig => (is => 'ro', isa => 'Paws::ElasticTranscoder::PipelineOutputConfig'); | ||
| 7 | has Id => (is => 'ro', isa => 'Str'); | ||
| 8 | has InputBucket => (is => 'ro', isa => 'Str'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str'); | ||
| 10 | has Notifications => (is => 'ro', isa => 'Paws::ElasticTranscoder::Notifications'); | ||
| 11 | has OutputBucket => (is => 'ro', isa => 'Str'); | ||
| 12 | has Role => (is => 'ro', isa => 'Str'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str'); | ||
| 14 | has ThumbnailConfig => (is => 'ro', isa => 'Paws::ElasticTranscoder::PipelineOutputConfig'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ElasticTranscoder::Pipeline | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::Pipeline object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { Arn => $value, ..., ThumbnailConfig => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::Pipeline object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->Arn | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | The pipeline (queue) that is used to manage jobs. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Arn => Str | ||
| 52 | |||
| 53 | The Amazon Resource Name (ARN) for the pipeline. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AwsKmsKeyArn => Str | ||
| 57 | |||
| 58 | The AWS Key Management Service (AWS KMS) key that you want to use with | ||
| 59 | this pipeline. | ||
| 60 | |||
| 61 | If you use either C<s3> or C<s3-aws-kms> as your C<Encryption:Mode>, | ||
| 62 | you don't need to provide a key with your job because a default key, | ||
| 63 | known as an AWS-KMS key, is created for you automatically. You need to | ||
| 64 | provide an AWS-KMS key only if you want to use a non-default AWS-KMS | ||
| 65 | key, or if you are using an C<Encryption:Mode> of C<aes-cbc-pkcs7>, | ||
| 66 | C<aes-ctr>, or C<aes-gcm>. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ContentConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig> | ||
| 70 | |||
| 71 | Information about the Amazon S3 bucket in which you want Elastic | ||
| 72 | Transcoder to save transcoded files and playlists. Either you specify | ||
| 73 | both C<ContentConfig> and C<ThumbnailConfig>, or you specify | ||
| 74 | C<OutputBucket>. | ||
| 75 | |||
| 76 | =over | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | B<Bucket>: The Amazon S3 bucket in which you want Elastic Transcoder to | ||
| 81 | save transcoded files and playlists. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | B<Permissions>: A list of the users and/or predefined Amazon S3 groups | ||
| 86 | you want to have access to transcoded files and playlists, and the type | ||
| 87 | of access that you want them to have. | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | GranteeType: The type of value that appears in the C<Grantee> object: | ||
| 94 | |||
| 95 | =over | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<Canonical>: Either the canonical user ID for an AWS account or an | ||
| 100 | origin access identity for an Amazon CloudFront distribution. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | C<Email>: The registered email address of an AWS account. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | C<Group>: One of the following predefined Amazon S3 groups: | ||
| 109 | C<AllUsers>, C<AuthenticatedUsers>, or C<LogDelivery>. | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<Grantee>: The AWS user or group that you want to have access to | ||
| 116 | transcoded files and playlists. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<Access>: The permission that you want to give to the AWS user that is | ||
| 121 | listed in C<Grantee>. Valid values include: | ||
| 122 | |||
| 123 | =over | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<READ>: The grantee can read the objects and metadata for objects that | ||
| 128 | Elastic Transcoder adds to the Amazon S3 bucket. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<READ_ACP>: The grantee can read the object ACL for objects that | ||
| 133 | Elastic Transcoder adds to the Amazon S3 bucket. | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | C<WRITE_ACP>: The grantee can write the ACL for the objects that | ||
| 138 | Elastic Transcoder adds to the Amazon S3 bucket. | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | C<FULL_CONTROL>: The grantee has C<READ>, C<READ_ACP>, and C<WRITE_ACP> | ||
| 143 | permissions for the objects that Elastic Transcoder adds to the Amazon | ||
| 144 | S3 bucket. | ||
| 145 | |||
| 146 | =back | ||
| 147 | |||
| 148 | =back | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | B<StorageClass>: The Amazon S3 storage class, Standard or | ||
| 153 | ReducedRedundancy, that you want Elastic Transcoder to assign to the | ||
| 154 | video files and playlists that it stores in your Amazon S3 bucket. | ||
| 155 | |||
| 156 | =back | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 Id => Str | ||
| 161 | |||
| 162 | The identifier for the pipeline. You use this value to identify the | ||
| 163 | pipeline in which you want to perform a variety of operations, such as | ||
| 164 | creating a job or a preset. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 InputBucket => Str | ||
| 168 | |||
| 169 | The Amazon S3 bucket from which Elastic Transcoder gets media files for | ||
| 170 | transcoding and the graphics files, if any, that you want to use for | ||
| 171 | watermarks. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 Name => Str | ||
| 175 | |||
| 176 | The name of the pipeline. We recommend that the name be unique within | ||
| 177 | the AWS account, but uniqueness is not enforced. | ||
| 178 | |||
| 179 | Constraints: Maximum 40 characters | ||
| 180 | |||
| 181 | |||
| 182 | =head2 Notifications => L<Paws::ElasticTranscoder::Notifications> | ||
| 183 | |||
| 184 | The Amazon Simple Notification Service (Amazon SNS) topic that you want | ||
| 185 | to notify to report job status. | ||
| 186 | |||
| 187 | To receive notifications, you must also subscribe to the new topic in | ||
| 188 | the Amazon SNS console. | ||
| 189 | |||
| 190 | =over | ||
| 191 | |||
| 192 | =item * | ||
| 193 | |||
| 194 | B<Progressing> (optional): The Amazon Simple Notification Service | ||
| 195 | (Amazon SNS) topic that you want to notify when Elastic Transcoder has | ||
| 196 | started to process the job. | ||
| 197 | |||
| 198 | =item * | ||
| 199 | |||
| 200 | B<Complete> (optional): The Amazon SNS topic that you want to notify | ||
| 201 | when Elastic Transcoder has finished processing the job. | ||
| 202 | |||
| 203 | =item * | ||
| 204 | |||
| 205 | B<Warning> (optional): The Amazon SNS topic that you want to notify | ||
| 206 | when Elastic Transcoder encounters a warning condition. | ||
| 207 | |||
| 208 | =item * | ||
| 209 | |||
| 210 | B<Error> (optional): The Amazon SNS topic that you want to notify when | ||
| 211 | Elastic Transcoder encounters an error condition. | ||
| 212 | |||
| 213 | =back | ||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head2 OutputBucket => Str | ||
| 218 | |||
| 219 | The Amazon S3 bucket in which you want Elastic Transcoder to save | ||
| 220 | transcoded files, thumbnails, and playlists. Either you specify this | ||
| 221 | value, or you specify both C<ContentConfig> and C<ThumbnailConfig>. | ||
| 222 | |||
| 223 | |||
| 224 | =head2 Role => Str | ||
| 225 | |||
| 226 | The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder | ||
| 227 | uses to transcode jobs for this pipeline. | ||
| 228 | |||
| 229 | |||
| 230 | =head2 Status => Str | ||
| 231 | |||
| 232 | The current status of the pipeline: | ||
| 233 | |||
| 234 | =over | ||
| 235 | |||
| 236 | =item * | ||
| 237 | |||
| 238 | C<Active>: The pipeline is processing jobs. | ||
| 239 | |||
| 240 | =item * | ||
| 241 | |||
| 242 | C<Paused>: The pipeline is not currently processing jobs. | ||
| 243 | |||
| 244 | =back | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | =head2 ThumbnailConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig> | ||
| 249 | |||
| 250 | Information about the Amazon S3 bucket in which you want Elastic | ||
| 251 | Transcoder to save thumbnail files. Either you specify both | ||
| 252 | C<ContentConfig> and C<ThumbnailConfig>, or you specify | ||
| 253 | C<OutputBucket>. | ||
| 254 | |||
| 255 | =over | ||
| 256 | |||
| 257 | =item * | ||
| 258 | |||
| 259 | C<Bucket>: The Amazon S3 bucket in which you want Elastic Transcoder to | ||
| 260 | save thumbnail files. | ||
| 261 | |||
| 262 | =item * | ||
| 263 | |||
| 264 | C<Permissions>: A list of the users and/or predefined Amazon S3 groups | ||
| 265 | you want to have access to thumbnail files, and the type of access that | ||
| 266 | you want them to have. | ||
| 267 | |||
| 268 | =over | ||
| 269 | |||
| 270 | =item * | ||
| 271 | |||
| 272 | GranteeType: The type of value that appears in the Grantee object: | ||
| 273 | |||
| 274 | =over | ||
| 275 | |||
| 276 | =item * | ||
| 277 | |||
| 278 | C<Canonical>: Either the canonical user ID for an AWS account or an | ||
| 279 | origin access identity for an Amazon CloudFront distribution. | ||
| 280 | |||
| 281 | A canonical user ID is not the same as an AWS account number. | ||
| 282 | |||
| 283 | =item * | ||
| 284 | |||
| 285 | C<Email>: The registered email address of an AWS account. | ||
| 286 | |||
| 287 | =item * | ||
| 288 | |||
| 289 | C<Group>: One of the following predefined Amazon S3 groups: | ||
| 290 | C<AllUsers>, C<AuthenticatedUsers>, or C<LogDelivery>. | ||
| 291 | |||
| 292 | =back | ||
| 293 | |||
| 294 | =item * | ||
| 295 | |||
| 296 | C<Grantee>: The AWS user or group that you want to have access to | ||
| 297 | thumbnail files. | ||
| 298 | |||
| 299 | =item * | ||
| 300 | |||
| 301 | Access: The permission that you want to give to the AWS user that is | ||
| 302 | listed in Grantee. Valid values include: | ||
| 303 | |||
| 304 | =over | ||
| 305 | |||
| 306 | =item * | ||
| 307 | |||
| 308 | C<READ>: The grantee can read the thumbnails and metadata for | ||
| 309 | thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. | ||
| 310 | |||
| 311 | =item * | ||
| 312 | |||
| 313 | C<READ_ACP>: The grantee can read the object ACL for thumbnails that | ||
| 314 | Elastic Transcoder adds to the Amazon S3 bucket. | ||
| 315 | |||
| 316 | =item * | ||
| 317 | |||
| 318 | C<WRITE_ACP>: The grantee can write the ACL for the thumbnails that | ||
| 319 | Elastic Transcoder adds to the Amazon S3 bucket. | ||
| 320 | |||
| 321 | =item * | ||
| 322 | |||
| 323 | C<FULL_CONTROL>: The grantee has READ, READ_ACP, and WRITE_ACP | ||
| 324 | permissions for the thumbnails that Elastic Transcoder adds to the | ||
| 325 | Amazon S3 bucket. | ||
| 326 | |||
| 327 | =back | ||
| 328 | |||
| 329 | =back | ||
| 330 | |||
| 331 | =item * | ||
| 332 | |||
| 333 | C<StorageClass>: The Amazon S3 storage class, C<Standard> or | ||
| 334 | C<ReducedRedundancy>, that you want Elastic Transcoder to assign to the | ||
| 335 | thumbnails that it stores in your Amazon S3 bucket. | ||
| 336 | |||
| 337 | =back | ||
| 338 | |||
| 339 | |||
| 340 | |||
| 341 | |||
| 342 | =head1 SEE ALSO | ||
| 343 | |||
| 344 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 345 | |||
| 346 | =head1 BUGS and CONTRIBUTIONS | ||
| 347 | |||
| 348 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 349 | |||
| 350 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 351 | |||
| 352 | =cut | ||
| 353 |