NAME
Paws::CostExplorer::GetTags - Arguments for method GetTags on Paws::CostExplorer
DESCRIPTION
This class represents the parameters used for calling the method GetTags on the AWS Cost Explorer Service service. Use the attributes of this class as arguments to method GetTags.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetTags.
SYNOPSIS
my $ce = Paws->service('CostExplorer');
my $GetTagsResponse = $ce->GetTags(
TimePeriod => {
End => 'MyYearMonthDay', # max: 40
Start => 'MyYearMonthDay', # max: 40
},
Filter => {
And => [ <Expression>, ... ], # OPTIONAL
CostCategories => {
Key => 'MyCostCategoryName', # min: 1, max: 50; OPTIONAL
MatchOptions => [
'EQUALS',
... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
], # OPTIONAL
Values => [
'MyValue', ... # max: 1024
], # OPTIONAL
}, # OPTIONAL
Dimensions => {
Key => 'AZ'
, # 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
MatchOptions => [
'EQUALS',
... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
], # OPTIONAL
Values => [
'MyValue', ... # max: 1024
], # OPTIONAL
}, # OPTIONAL
Not => <Expression>,
Or => [ <Expression>, ... ], # OPTIONAL
Tags => {
Key => 'MyTagKey', # max: 1024; OPTIONAL
MatchOptions => [
'EQUALS',
... # values: EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
], # OPTIONAL
Values => [
'MyValue', ... # max: 1024
], # OPTIONAL
}, # OPTIONAL
}, # OPTIONAL
MaxResults => 1, # OPTIONAL
NextPageToken => 'MyNextPageToken', # OPTIONAL
SearchString => 'MySearchString', # OPTIONAL
SortBy => [
{
Key => 'MySortDefinitionKey', # max: 1024
SortOrder => 'ASCENDING', # values: ASCENDING, DESCENDING; OPTIONAL
},
...
], # OPTIONAL
TagKey => 'MyTagKey', # OPTIONAL
);
# Results:
my $NextPageToken = $GetTagsResponse->NextPageToken;
my $ReturnSize = $GetTagsResponse->ReturnSize;
my $Tags = $GetTagsResponse->Tags;
my $TotalSize = $GetTagsResponse->TotalSize;
# Returns a L<Paws::CostExplorer::GetTagsResponse> object.
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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ce/GetTags
ATTRIBUTES
Filter => Paws::CostExplorer::Expression
MaxResults => Int
This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
For GetTags
, MaxResults has an upper limit of 1000.
NextPageToken => Str
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
SearchString => Str
The value that you want to search for.
SortBy => ArrayRef[Paws::CostExplorer::SortDefinition]
The value by which you want to sort the data.
The key represents cost and usage metrics. The following values are supported:
BlendedCost
UnblendedCost
AmortizedCost
NetAmortizedCost
NetUnblendedCost
UsageQuantity
NormalizedUsageAmount
Supported values for SortOrder
are ASCENDING
or DESCENDING
.
When using SortBy
, NextPageToken
and SearchString
are not supported.
TagKey => Str
The key of the tag that you want to return values for.
REQUIRED TimePeriod => Paws::CostExplorer::DateInterval
The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start
is 2017-01-01
and end
is 2017-05-01
, then the cost and usage data is retrieved from 2017-01-01
up to and including 2017-04-30
but not including 2017-05-01
.
SEE ALSO
This class forms part of Paws, documenting arguments for method GetTags in Paws::CostExplorer
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues