« blib/lib/Paws/ElasticTranscoder/UpdatePipeline.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/UpdatePipelineNotificationsResponse.pm »
| 1 | |||
| 2 | package Paws::ElasticTranscoder::UpdatePipelineNotifications; | ||
| 3 | use Moose; | ||
| 4 | has Id => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Id', required => 1); | ||
| 5 | has Notifications => (is => 'ro', isa => 'Paws::ElasticTranscoder::Notifications', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdatePipelineNotifications'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2012-09-25/pipelines/{Id}/notifications'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticTranscoder::UpdatePipelineNotificationsResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ElasticTranscoder::UpdatePipelineNotifications - Arguments for method UpdatePipelineNotifications on L<Paws::ElasticTranscoder> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method UpdatePipelineNotifications on the | ||
| 24 | L<Amazon Elastic Transcoder|Paws::ElasticTranscoder> service. Use the attributes of this class | ||
| 25 | as arguments to method UpdatePipelineNotifications. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdatePipelineNotifications. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $elastictranscoder = Paws->service('ElasticTranscoder'); | ||
| 32 | my $UpdatePipelineNotificationsResponse = | ||
| 33 | $elastictranscoder->UpdatePipelineNotifications( | ||
| 34 | Id => 'MyId', | ||
| 35 | Notifications => { | ||
| 36 | Completed => 'MySnsTopic', # OPTIONAL | ||
| 37 | Error => 'MySnsTopic', # OPTIONAL | ||
| 38 | Progressing => 'MySnsTopic', # OPTIONAL | ||
| 39 | Warning => 'MySnsTopic', # OPTIONAL | ||
| 40 | }, | ||
| 41 | |||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $Pipeline = $UpdatePipelineNotificationsResponse->Pipeline; | ||
| 46 | |||
| 47 | # Returns a L<Paws::ElasticTranscoder::UpdatePipelineNotificationsResponse> object. | ||
| 48 | |||
| 49 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elastictranscoder/UpdatePipelineNotifications> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> Id => Str | ||
| 56 | |||
| 57 | The identifier of the pipeline for which you want to change | ||
| 58 | notification settings. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Notifications => L<Paws::ElasticTranscoder::Notifications> | ||
| 63 | |||
| 64 | The topic ARN for the Amazon Simple Notification Service (Amazon SNS) | ||
| 65 | topic that you want to notify to report job status. | ||
| 66 | |||
| 67 | To receive notifications, you must also subscribe to the new topic in | ||
| 68 | the Amazon SNS console. | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | B<Progressing>: The topic ARN for the Amazon Simple Notification | ||
| 75 | Service (Amazon SNS) topic that you want to notify when Elastic | ||
| 76 | Transcoder has started to process jobs that are added to this pipeline. | ||
| 77 | This is the ARN that Amazon SNS returned when you created the topic. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | B<Complete>: The topic ARN for the Amazon SNS topic that you want to | ||
| 82 | notify when Elastic Transcoder has finished processing a job. This is | ||
| 83 | the ARN that Amazon SNS returned when you created the topic. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | B<Warning>: The topic ARN for the Amazon SNS topic that you want to | ||
| 88 | notify when Elastic Transcoder encounters a warning condition. This is | ||
| 89 | the ARN that Amazon SNS returned when you created the topic. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | B<Error>: The topic ARN for the Amazon SNS topic that you want to | ||
| 94 | notify when Elastic Transcoder encounters an error condition. This is | ||
| 95 | the ARN that Amazon SNS returned when you created the topic. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method UpdatePipelineNotifications in L<Paws::ElasticTranscoder> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |