« blib/lib/Paws/CostExplorer/GetSavingsPlansUtilizationResponse.pm
↑ Summary
blib/lib/Paws/CostExplorer/GetTagsResponse.pm »
| 1 | |||
| 2 | package Paws::CostExplorer::GetTags; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'Paws::CostExplorer::Expression'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextPageToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has SearchString => (is => 'ro', isa => 'Str'); | ||
| 8 | has SortBy => (is => 'ro', isa => 'ArrayRef[Paws::CostExplorer::SortDefinition]'); | ||
| 9 | has TagKey => (is => 'ro', isa => 'Str'); | ||
| 10 | has TimePeriod => (is => 'ro', isa => 'Paws::CostExplorer::DateInterval', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetTags'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CostExplorer::GetTagsResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CostExplorer::GetTags - Arguments for method GetTags on L<Paws::CostExplorer> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetTags on the | ||
| 28 | L<AWS Cost Explorer Service|Paws::CostExplorer> service. Use the attributes of this class | ||
| 29 | as arguments to method GetTags. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetTags. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ce = Paws->service('CostExplorer'); | ||
| 36 | my $GetTagsResponse = $ce->GetTags( | ||
| 37 | TimePeriod => { | ||
| 38 | End => 'MyYearMonthDay', # max: 40 | ||
| 39 | Start => 'MyYearMonthDay', # max: 40 | ||
| 40 | |||
| 41 | }, | ||
| 42 | Filter => { | ||
| 43 | And => [ <Expression>, ... ], # OPTIONAL | ||
| 44 | CostCategories => { | ||
| 45 | Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL | ||
| 46 | MatchOptions => [ | ||
| 47 | 'EQUALS', | ||
| 48 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 49 | ], # OPTIONAL | ||
| 50 | Values => [ | ||
| 51 | 'MyValue', ... # max: 1024 | ||
| 52 | ], # OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | Dimensions => { | ||
| 55 | Key => 'AZ' | ||
| 56 | , # values: AZ, INSTANCE_TYPE, LINKED_ACCOUNT, LINKED_ACCOUNT_NAME, OPERATION, PURCHASE_TYPE, REGION, SERVICE, SERVICE_CODE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE; OPTIONAL | ||
| 57 | MatchOptions => [ | ||
| 58 | 'EQUALS', | ||
| 59 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 60 | ], # OPTIONAL | ||
| 61 | Values => [ | ||
| 62 | 'MyValue', ... # max: 1024 | ||
| 63 | ], # OPTIONAL | ||
| 64 | }, # OPTIONAL | ||
| 65 | Not => <Expression>, | ||
| 66 | Or => [ <Expression>, ... ], # OPTIONAL | ||
| 67 | Tags => { | ||
| 68 | Key => 'MyTagKey', # max: 1024; OPTIONAL | ||
| 69 | MatchOptions => [ | ||
| 70 | 'EQUALS', | ||
| 71 | ... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE | ||
| 72 | ], # OPTIONAL | ||
| 73 | Values => [ | ||
| 74 | 'MyValue', ... # max: 1024 | ||
| 75 | ], # OPTIONAL | ||
| 76 | }, # OPTIONAL | ||
| 77 | }, # OPTIONAL | ||
| 78 | MaxResults => 1, # OPTIONAL | ||
| 79 | NextPageToken => 'MyNextPageToken', # OPTIONAL | ||
| 80 | SearchString => 'MySearchString', # OPTIONAL | ||
| 81 | SortBy => [ | ||
| 82 | { | ||
| 83 | Key => 'MySortDefinitionKey', # max: 1024 | ||
| 84 | SortOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL | ||
| 85 | }, | ||
| 86 | ... | ||
| 87 | ], # OPTIONAL | ||
| 88 | TagKey => 'MyTagKey', # OPTIONAL | ||
| 89 | ); | ||
| 90 | |||
| 91 | # Results: | ||
| 92 | my $NextPageToken = $GetTagsResponse->NextPageToken; | ||
| 93 | my $ReturnSize = $GetTagsResponse->ReturnSize; | ||
| 94 | my $Tags = $GetTagsResponse->Tags; | ||
| 95 | my $TotalSize = $GetTagsResponse->TotalSize; | ||
| 96 | |||
| 97 | # Returns a L<Paws::CostExplorer::GetTagsResponse> object. | ||
| 98 | |||
| 99 | 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. | ||
| 100 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ce/GetTags> | ||
| 101 | |||
| 102 | =head1 ATTRIBUTES | ||
| 103 | |||
| 104 | |||
| 105 | =head2 Filter => L<Paws::CostExplorer::Expression> | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 MaxResults => Int | ||
| 112 | |||
| 113 | This field is only used when SortBy is provided in the request. The | ||
| 114 | maximum number of objects that to be returned for this request. If | ||
| 115 | MaxResults is not specified with SortBy, the request will return 1000 | ||
| 116 | results as the default value for this parameter. | ||
| 117 | |||
| 118 | For C<GetTags>, MaxResults has an upper limit of 1000. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 NextPageToken => Str | ||
| 123 | |||
| 124 | The token to retrieve the next set of results. AWS provides the token | ||
| 125 | when the response from a previous call has more results than the | ||
| 126 | maximum page size. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 SearchString => Str | ||
| 131 | |||
| 132 | The value that you want to search for. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 SortBy => ArrayRef[L<Paws::CostExplorer::SortDefinition>] | ||
| 137 | |||
| 138 | The value by which you want to sort the data. | ||
| 139 | |||
| 140 | The key represents cost and usage metrics. The following values are | ||
| 141 | supported: | ||
| 142 | |||
| 143 | =over | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | C<BlendedCost> | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | C<UnblendedCost> | ||
| 152 | |||
| 153 | =item * | ||
| 154 | |||
| 155 | C<AmortizedCost> | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | C<NetAmortizedCost> | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | C<NetUnblendedCost> | ||
| 164 | |||
| 165 | =item * | ||
| 166 | |||
| 167 | C<UsageQuantity> | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | C<NormalizedUsageAmount> | ||
| 172 | |||
| 173 | =back | ||
| 174 | |||
| 175 | Supported values for C<SortOrder> are C<ASCENDING> or C<DESCENDING>. | ||
| 176 | |||
| 177 | When using C<SortBy>, C<NextPageToken> and C<SearchString> are not | ||
| 178 | supported. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 TagKey => Str | ||
| 183 | |||
| 184 | The key of the tag that you want to return values for. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head2 B<REQUIRED> TimePeriod => L<Paws::CostExplorer::DateInterval> | ||
| 189 | |||
| 190 | The start and end dates for retrieving the dimension values. The start | ||
| 191 | date is inclusive, but the end date is exclusive. For example, if | ||
| 192 | C<start> is C<2017-01-01> and C<end> is C<2017-05-01>, then the cost | ||
| 193 | and usage data is retrieved from C<2017-01-01> up to and including | ||
| 194 | C<2017-04-30> but not including C<2017-05-01>. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | |||
| 199 | =head1 SEE ALSO | ||
| 200 | |||
| 201 | This class forms part of L<Paws>, documenting arguments for method GetTags in L<Paws::CostExplorer> | ||
| 202 | |||
| 203 | =head1 BUGS and CONTRIBUTIONS | ||
| 204 | |||
| 205 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 206 | |||
| 207 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 208 | |||
| 209 | =cut | ||
| 210 |