Skip to content

Paginator definitions for CostExplorer API #3041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: version-3
Choose a base branch
from
Open

Paginator definitions for CostExplorer API #3041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69ec387
Add paginator definitions for Cost Explorer API endpoints
thomasklemm Jun 10, 2024
b198239
Rebuild CostExplorer SDK
thomasklemm Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions apis/ce/2017-10-25/paginators-1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,64 @@
"limit_key": "MaxResults",
"result_key": "AnomalySubscriptions"
},
"GetCostAndUsage": {
"input_token": "NextPageToken",
"output_token": "NextPageToken"
},
"GetCostAndUsageWithResources": {
"input_token": "NextPageToken",
"output_token": "NextPageToken"
},
"GetCostCategories": {
"input_token": "NextPageToken",
"output_token": "NextPageToken",
"limit_key": "MaxResults"
},
"GetDimensionValues": {
"input_token": "NextPageToken",
"output_token": "NextPageToken",
"limit_key": "MaxResults"
},
"GetReservationCoverage": {
"input_token": "NextPageToken",
"output_token": "NextPageToken",
"limit_key": "MaxResults"
},
"GetReservationPurchaseRecommendation": {
"input_token": "NextPageToken",
"output_token": "NextPageToken",
"limit_key": "PageSize"
},
"GetReservationUtilization": {
"input_token": "NextPageToken",
"output_token": "NextPageToken",
"limit_key": "MaxResults"
},
"GetRightsizingRecommendation": {
"input_token": "NextPageToken",
"output_token": "NextPageToken",
"limit_key": "PageSize"
},
"GetSavingsPlansCoverage": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetSavingsPlansPurchaseRecommendation": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "PageSize"
},
"GetSavingsPlansUtilizationDetails": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetTags": {
"input_token": "NextPageToken",
"output_token": "NextPageToken",
"limit_key": "MaxResults"
},
"ListCostAllocationTagBackfillHistory": {
"input_token": "NextToken",
"output_token": "NextToken",
Expand All @@ -42,6 +90,11 @@
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListSavingsPlansPurchaseRecommendationGeneration": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "PageSize"
}
}
}
42 changes: 42 additions & 0 deletions gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1471,6 +1471,8 @@ def get_commitment_purchase_analysis(params = {}, options = {})
# * {Types::GetCostAndUsageResponse#results_by_time #results_by_time} => Array<Types::ResultByTime>
# * {Types::GetCostAndUsageResponse#dimension_value_attributes #dimension_value_attributes} => Array<Types::DimensionValuesWithAttributes>
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_cost_and_usage({
Expand Down Expand Up @@ -1659,6 +1661,8 @@ def get_cost_and_usage(params = {}, options = {})
# * {Types::GetCostAndUsageWithResourcesResponse#results_by_time #results_by_time} => Array<Types::ResultByTime>
# * {Types::GetCostAndUsageWithResourcesResponse#dimension_value_attributes #dimension_value_attributes} => Array<Types::DimensionValuesWithAttributes>
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_cost_and_usage_with_resources({
Expand Down Expand Up @@ -1783,6 +1787,7 @@ def get_cost_and_usage_with_resources(params = {}, options = {})
#
# * Specify the `Dimensions` field to define a filter that acts on
# the [ `DimensionValues` ][1].
#
# * For each filter type, you can set the dimension name and values
# for the filters that you plan to use.
#
Expand All @@ -1797,6 +1802,7 @@ def get_cost_and_usage_with_resources(params = {}, options = {})
#
# * As shown in the previous example, lists of dimension values are
# combined with `OR` when applying the filter.
#
# * You can also set different match options to further control how
# the filter behaves. Not all APIs support match options. Refer to
# the documentation for each specific API to see what is supported.
Expand All @@ -1807,6 +1813,7 @@ def get_cost_and_usage_with_resources(params = {}, options = {})
# * The corresponding `Expression` for this example is as follows:
# `{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions":
# [ "STARTS_WITH" ], "Values": [ "a" ] } }`
#
# * Compound `Expression` types with logical operations.
#
# * You can use multiple `Expression` types and the logical operators
Expand All @@ -1822,6 +1829,7 @@ def get_cost_and_usage_with_resources(params = {}, options = {})
# "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
# "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key":
# "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } `
#
# <note markdown="1"> Because each `Expression` can have only one operator, the service
# returns an error if more than one is specified. The following
# example shows an `Expression` object that creates an error: ` {
Expand Down Expand Up @@ -1909,6 +1917,8 @@ def get_cost_and_usage_with_resources(params = {}, options = {})
# * {Types::GetCostCategoriesResponse#return_size #return_size} => Integer
# * {Types::GetCostCategoriesResponse#total_size #total_size} => Integer
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_cost_categories({
Expand Down Expand Up @@ -2341,6 +2351,7 @@ def get_cost_forecast(params = {}, options = {})
#
# * Specify the `Dimensions` field to define a filter that acts on
# the [ `DimensionValues` ][1].
#
# * For each filter type, you can set the dimension name and values
# for the filters that you plan to use.
#
Expand All @@ -2355,6 +2366,7 @@ def get_cost_forecast(params = {}, options = {})
#
# * As shown in the previous example, lists of dimension values are
# combined with `OR` when applying the filter.
#
# * You can also set different match options to further control how
# the filter behaves. Not all APIs support match options. Refer to
# the documentation for each specific API to see what is supported.
Expand All @@ -2365,6 +2377,7 @@ def get_cost_forecast(params = {}, options = {})
# * The corresponding `Expression` for this example is as follows:
# `{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions":
# [ "STARTS_WITH" ], "Values": [ "a" ] } }`
#
# * Compound `Expression` types with logical operations.
#
# * You can use multiple `Expression` types and the logical operators
Expand All @@ -2380,6 +2393,7 @@ def get_cost_forecast(params = {}, options = {})
# "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
# "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key":
# "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } `
#
# <note markdown="1"> Because each `Expression` can have only one operator, the service
# returns an error if more than one is specified. The following
# example shows an `Expression` object that creates an error: ` {
Expand Down Expand Up @@ -2464,6 +2478,8 @@ def get_cost_forecast(params = {}, options = {})
# * {Types::GetDimensionValuesResponse#total_size #total_size} => Integer
# * {Types::GetDimensionValuesResponse#next_page_token #next_page_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_dimension_values({
Expand Down Expand Up @@ -2707,6 +2723,8 @@ def get_dimension_values(params = {}, options = {})
# * {Types::GetReservationCoverageResponse#total #total} => Types::Coverage
# * {Types::GetReservationCoverageResponse#next_page_token #next_page_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_reservation_coverage({
Expand Down Expand Up @@ -2856,6 +2874,7 @@ def get_reservation_coverage(params = {}, options = {})
#
# * Specify the `Dimensions` field to define a filter that acts on
# the [ `DimensionValues` ][1].
#
# * For each filter type, you can set the dimension name and values
# for the filters that you plan to use.
#
Expand All @@ -2870,6 +2889,7 @@ def get_reservation_coverage(params = {}, options = {})
#
# * As shown in the previous example, lists of dimension values are
# combined with `OR` when applying the filter.
#
# * You can also set different match options to further control how
# the filter behaves. Not all APIs support match options. Refer to
# the documentation for each specific API to see what is supported.
Expand All @@ -2880,6 +2900,7 @@ def get_reservation_coverage(params = {}, options = {})
# * The corresponding `Expression` for this example is as follows:
# `{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions":
# [ "STARTS_WITH" ], "Values": [ "a" ] } }`
#
# * Compound `Expression` types with logical operations.
#
# * You can use multiple `Expression` types and the logical operators
Expand All @@ -2895,6 +2916,7 @@ def get_reservation_coverage(params = {}, options = {})
# "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
# "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key":
# "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } `
#
# <note markdown="1"> Because each `Expression` can have only one operator, the service
# returns an error if more than one is specified. The following
# example shows an `Expression` object that creates an error: ` {
Expand Down Expand Up @@ -2960,6 +2982,8 @@ def get_reservation_coverage(params = {}, options = {})
# * {Types::GetReservationPurchaseRecommendationResponse#recommendations #recommendations} => Array&lt;Types::ReservationPurchaseRecommendation&gt;
# * {Types::GetReservationPurchaseRecommendationResponse#next_page_token #next_page_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_reservation_purchase_recommendation({
Expand Down Expand Up @@ -3223,6 +3247,8 @@ def get_reservation_purchase_recommendation(params = {}, options = {})
# * {Types::GetReservationUtilizationResponse#total #total} => Types::ReservationAggregates
# * {Types::GetReservationUtilizationResponse#next_page_token #next_page_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_reservation_utilization({
Expand Down Expand Up @@ -3381,6 +3407,7 @@ def get_reservation_utilization(params = {}, options = {})
#
# * Specify the `Dimensions` field to define a filter that acts on
# the [ `DimensionValues` ][1].
#
# * For each filter type, you can set the dimension name and values
# for the filters that you plan to use.
#
Expand All @@ -3395,6 +3422,7 @@ def get_reservation_utilization(params = {}, options = {})
#
# * As shown in the previous example, lists of dimension values are
# combined with `OR` when applying the filter.
#
# * You can also set different match options to further control how
# the filter behaves. Not all APIs support match options. Refer to
# the documentation for each specific API to see what is supported.
Expand All @@ -3405,6 +3433,7 @@ def get_reservation_utilization(params = {}, options = {})
# * The corresponding `Expression` for this example is as follows:
# `{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions":
# [ "STARTS_WITH" ], "Values": [ "a" ] } }`
#
# * Compound `Expression` types with logical operations.
#
# * You can use multiple `Expression` types and the logical operators
Expand All @@ -3420,6 +3449,7 @@ def get_reservation_utilization(params = {}, options = {})
# "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
# "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key":
# "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } `
#
# <note markdown="1"> Because each `Expression` can have only one operator, the service
# returns an error if more than one is specified. The following
# example shows an `Expression` object that creates an error: ` {
Expand Down Expand Up @@ -3477,6 +3507,8 @@ def get_reservation_utilization(params = {}, options = {})
# * {Types::GetRightsizingRecommendationResponse#next_page_token #next_page_token} => String
# * {Types::GetRightsizingRecommendationResponse#configuration #configuration} => Types::RightsizingRecommendationConfiguration
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_rightsizing_recommendation({
Expand Down Expand Up @@ -3910,6 +3942,8 @@ def get_savings_plans_coverage(params = {}, options = {})
# * {Types::GetSavingsPlansPurchaseRecommendationResponse#savings_plans_purchase_recommendation #savings_plans_purchase_recommendation} => Types::SavingsPlansPurchaseRecommendation
# * {Types::GetSavingsPlansPurchaseRecommendationResponse#next_page_token #next_page_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_savings_plans_purchase_recommendation({
Expand Down Expand Up @@ -4355,6 +4389,7 @@ def get_savings_plans_utilization_details(params = {}, options = {})
#
# * Specify the `Dimensions` field to define a filter that acts on
# the [ `DimensionValues` ][1].
#
# * For each filter type, you can set the dimension name and values
# for the filters that you plan to use.
#
Expand All @@ -4369,6 +4404,7 @@ def get_savings_plans_utilization_details(params = {}, options = {})
#
# * As shown in the previous example, lists of dimension values are
# combined with `OR` when applying the filter.
#
# * You can also set different match options to further control how
# the filter behaves. Not all APIs support match options. Refer to
# the documentation for each specific API to see what is supported.
Expand All @@ -4379,6 +4415,7 @@ def get_savings_plans_utilization_details(params = {}, options = {})
# * The corresponding `Expression` for this example is as follows:
# `{ "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions":
# [ "STARTS_WITH" ], "Values": [ "a" ] } }`
#
# * Compound `Expression` types with logical operations.
#
# * You can use multiple `Expression` types and the logical operators
Expand All @@ -4394,6 +4431,7 @@ def get_savings_plans_utilization_details(params = {}, options = {})
# "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
# "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key":
# "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] } `
#
# <note markdown="1"> Because each `Expression` can have only one operator, the service
# returns an error if more than one is specified. The following
# example shows an `Expression` object that creates an error: ` {
Expand Down Expand Up @@ -4476,6 +4514,8 @@ def get_savings_plans_utilization_details(params = {}, options = {})
# * {Types::GetTagsResponse#return_size #return_size} => Integer
# * {Types::GetTagsResponse#total_size #total_size} => Integer
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.get_tags({
Expand Down Expand Up @@ -4960,6 +5000,8 @@ def list_cost_category_definitions(params = {}, options = {})
# * {Types::ListSavingsPlansPurchaseRecommendationGenerationResponse#generation_summary_list #generation_summary_list} => Array&lt;Types::GenerationSummary&gt;
# * {Types::ListSavingsPlansPurchaseRecommendationGenerationResponse#next_page_token #next_page_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_savings_plans_purchase_recommendation_generation({
Expand Down
Loading