« blib/lib/Paws/MediaConvert/UpdatePresetResponse.pm
↑ Summary
blib/lib/Paws/MediaConvert/UpdateQueueResponse.pm »
| 1 | |||
| 2 | package Paws::MediaConvert::UpdateQueue; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 6 | has ReservationPlanSettings => (is => 'ro', isa => 'Paws::MediaConvert::ReservationPlanSettings', traits => ['NameInRequest'], request_name => 'reservationPlanSettings'); | ||
| 7 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateQueue'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2017-08-29/queues/{name}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaConvert::UpdateQueueResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::MediaConvert::UpdateQueue - Arguments for method UpdateQueue on L<Paws::MediaConvert> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateQueue on the | ||
| 26 | L<AWS Elemental MediaConvert|Paws::MediaConvert> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateQueue. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateQueue. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $mediaconvert = Paws->service('MediaConvert'); | ||
| 34 | my $UpdateQueueResponse = $mediaconvert->UpdateQueue( | ||
| 35 | Name => 'My__string', | ||
| 36 | Description => 'My__string', # OPTIONAL | ||
| 37 | ReservationPlanSettings => { | ||
| 38 | Commitment => 'ONE_YEAR', # values: ONE_YEAR | ||
| 39 | RenewalType => 'AUTO_RENEW', # values: AUTO_RENEW, EXPIRE | ||
| 40 | ReservedSlots => 1, | ||
| 41 | |||
| 42 | }, # OPTIONAL | ||
| 43 | Status => 'ACTIVE', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $Queue = $UpdateQueueResponse->Queue; | ||
| 48 | |||
| 49 | # Returns a L<Paws::MediaConvert::UpdateQueueResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mediaconvert/UpdateQueue> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Description => Str | ||
| 58 | |||
| 59 | The new description for the queue, if you are changing it. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Name => Str | ||
| 64 | |||
| 65 | The name of the queue that you are modifying. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 ReservationPlanSettings => L<Paws::MediaConvert::ReservationPlanSettings> | ||
| 70 | |||
| 71 | The new details of your pricing plan for your reserved queue. When you | ||
| 72 | set up a new pricing plan to replace an expired one, you enter into | ||
| 73 | another 12-month commitment. When you add capacity to your queue by | ||
| 74 | increasing the number of RTS, you extend the term of your commitment to | ||
| 75 | 12 months from when you add capacity. After you make these commitments, | ||
| 76 | you can't cancel them. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 Status => Str | ||
| 81 | |||
| 82 | Pause or activate a queue by changing its status between ACTIVE and | ||
| 83 | PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that | ||
| 84 | are running when you pause the queue continue to run until they finish | ||
| 85 | or result in an error. | ||
| 86 | |||
| 87 | Valid values are: C<"ACTIVE">, C<"PAUSED"> | ||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method UpdateQueue in L<Paws::MediaConvert> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |