« blib/lib/Paws/MarketplaceEntitlement/GetEntitlementFilters.pm
↑ Summary
blib/lib/Paws/MarketplaceEntitlement/GetEntitlementsResult.pm »
| 1 | |||
| 2 | package Paws::MarketplaceEntitlement::GetEntitlements; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'Paws::MarketplaceEntitlement::GetEntitlementFilters'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has ProductCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetEntitlements'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MarketplaceEntitlement::GetEntitlementsResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::MarketplaceEntitlement::GetEntitlements - Arguments for method GetEntitlements on L<Paws::MarketplaceEntitlement> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetEntitlements on the | ||
| 25 | L<AWS Marketplace Entitlement Service|Paws::MarketplaceEntitlement> service. Use the attributes of this class | ||
| 26 | as arguments to method GetEntitlements. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetEntitlements. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $entitlement.marketplace = Paws->service('MarketplaceEntitlement'); | ||
| 33 | my $GetEntitlementsResult = $entitlement . marketplace->GetEntitlements( | ||
| 34 | ProductCode => 'MyProductCode', | ||
| 35 | Filter => { | ||
| 36 | 'CUSTOMER_IDENTIFIER' => [ 'MyFilterValue', ... ] | ||
| 37 | , # key: values: CUSTOMER_IDENTIFIER, DIMENSION, value: min: 1 | ||
| 38 | }, # OPTIONAL | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | NextToken => 'MyNonEmptyString', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Entitlements = $GetEntitlementsResult->Entitlements; | ||
| 45 | my $NextToken = $GetEntitlementsResult->NextToken; | ||
| 46 | |||
| 47 | # Returns a L<Paws::MarketplaceEntitlement::GetEntitlementsResult> 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/entitlement.marketplace/GetEntitlements> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Filter => L<Paws::MarketplaceEntitlement::GetEntitlementFilters> | ||
| 56 | |||
| 57 | Filter is used to return entitlements for a specific customer or for a | ||
| 58 | specific dimension. Filters are described as keys mapped to a lists of | ||
| 59 | values. Filtered requests are I<unioned> for each value in the value | ||
| 60 | list, and then I<intersected> for each filter key. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxResults => Int | ||
| 65 | |||
| 66 | The maximum number of items to retrieve from the GetEntitlements | ||
| 67 | operation. For pagination, use the NextToken field in subsequent calls | ||
| 68 | to GetEntitlements. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 NextToken => Str | ||
| 73 | |||
| 74 | For paginated calls to GetEntitlements, pass the NextToken from the | ||
| 75 | previous GetEntitlementsResult. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> ProductCode => Str | ||
| 80 | |||
| 81 | Product code is used to uniquely identify a product in AWS Marketplace. | ||
| 82 | The product code will be provided by AWS Marketplace when the product | ||
| 83 | listing is created. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method GetEntitlements in L<Paws::MarketplaceEntitlement> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |