« blib/lib/Paws/MediaConnect/UpdateFlow.pm
↑ Summary
blib/lib/Paws/MediaConnect/UpdateFlowEntitlementResponse.pm »
| 1 | |||
| 2 | package Paws::MediaConnect::UpdateFlowEntitlement; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 5 | has Encryption => (is => 'ro', isa => 'Paws::MediaConnect::UpdateEncryption', traits => ['NameInRequest'], request_name => 'encryption'); | ||
| 6 | has EntitlementArn => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'entitlementArn', required => 1); | ||
| 7 | has EntitlementStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'entitlementStatus'); | ||
| 8 | has FlowArn => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'flowArn', required => 1); | ||
| 9 | has Subscribers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'subscribers'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateFlowEntitlement'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/flows/{flowArn}/entitlements/{entitlementArn}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaConnect::UpdateFlowEntitlementResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::MediaConnect::UpdateFlowEntitlement - Arguments for method UpdateFlowEntitlement on L<Paws::MediaConnect> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method UpdateFlowEntitlement on the | ||
| 28 | L<AWS MediaConnect|Paws::MediaConnect> service. Use the attributes of this class | ||
| 29 | as arguments to method UpdateFlowEntitlement. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateFlowEntitlement. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $mediaconnect = Paws->service('MediaConnect'); | ||
| 36 | my $UpdateFlowEntitlementResponse = $mediaconnect->UpdateFlowEntitlement( | ||
| 37 | EntitlementArn => 'My__string', | ||
| 38 | FlowArn => 'My__string', | ||
| 39 | Description => 'My__string', # OPTIONAL | ||
| 40 | Encryption => { | ||
| 41 | Algorithm => 'aes128', # values: aes128, aes192, aes256; OPTIONAL | ||
| 42 | ConstantInitializationVector => 'My__string', | ||
| 43 | DeviceId => 'My__string', | ||
| 44 | KeyType => 'speke', # values: speke, static-key, srt-password; OPTIONAL | ||
| 45 | Region => 'My__string', | ||
| 46 | ResourceId => 'My__string', | ||
| 47 | RoleArn => 'My__string', | ||
| 48 | SecretArn => 'My__string', | ||
| 49 | Url => 'My__string', | ||
| 50 | }, # OPTIONAL | ||
| 51 | EntitlementStatus => 'ENABLED', # OPTIONAL | ||
| 52 | Subscribers => [ 'My__string', ... ], # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $Entitlement = $UpdateFlowEntitlementResponse->Entitlement; | ||
| 57 | my $FlowArn = $UpdateFlowEntitlementResponse->FlowArn; | ||
| 58 | |||
| 59 | # Returns a L<Paws::MediaConnect::UpdateFlowEntitlementResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mediaconnect/UpdateFlowEntitlement> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Description => Str | ||
| 68 | |||
| 69 | A description of the entitlement. This description appears only on the | ||
| 70 | AWS Elemental MediaConnect console and will not be seen by the | ||
| 71 | subscriber or end user. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Encryption => L<Paws::MediaConnect::UpdateEncryption> | ||
| 76 | |||
| 77 | The type of encryption that will be used on the output associated with | ||
| 78 | this entitlement. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> EntitlementArn => Str | ||
| 83 | |||
| 84 | The ARN of the entitlement that you want to update. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 EntitlementStatus => Str | ||
| 89 | |||
| 90 | An indication of whether you want to enable the entitlement to allow | ||
| 91 | access, or disable it to stop streaming content to the | ||
| 92 | subscriberE<rsquo>s flow temporarily. If you donE<rsquo>t specify the | ||
| 93 | entitlementStatus field in your request, MediaConnect leaves the value | ||
| 94 | unchanged. | ||
| 95 | |||
| 96 | Valid values are: C<"ENABLED">, C<"DISABLED"> | ||
| 97 | |||
| 98 | =head2 B<REQUIRED> FlowArn => Str | ||
| 99 | |||
| 100 | The flow that is associated with the entitlement that you want to | ||
| 101 | update. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Subscribers => ArrayRef[Str|Undef] | ||
| 106 | |||
| 107 | The AWS account IDs that you want to share your content with. The | ||
| 108 | receiving accounts (subscribers) will be allowed to create their own | ||
| 109 | flow using your content as the source. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method UpdateFlowEntitlement in L<Paws::MediaConnect> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |