Rebuild CostExplorer SDK

- Includes the new paginator definitions for the Cost Explorer API, so #next_page?, #next_page and other pagination methods are now properly working on the response
aws · Nov 29, 2024 · a63c98a · a63c98a
1 parent 413104a
commit a63c98a
Show file tree

Hide file tree

Showing 3 changed files with 158 additions and 0 deletions.
diff --git a/gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb b/gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/client.rb
@@ -1007,6 +1007,8 @@ def describe_cost_category_definition(params = {}, options = {})
     #   * {Types::GetAnomaliesResponse#anomalies #anomalies} => Array&lt;Types::Anomaly&gt;
     #   * {Types::GetAnomaliesResponse#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_anomalies({
@@ -1079,6 +1081,8 @@ def get_anomalies(params = {}, options = {})
     #   * {Types::GetAnomalyMonitorsResponse#anomaly_monitors #anomaly_monitors} => Array&lt;Types::AnomalyMonitor&gt;
     #   * {Types::GetAnomalyMonitorsResponse#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_anomaly_monitors({
@@ -1152,6 +1156,8 @@ def get_anomaly_monitors(params = {}, options = {})
     #   * {Types::GetAnomalySubscriptionsResponse#anomaly_subscriptions #anomaly_subscriptions} => Array&lt;Types::AnomalySubscription&gt;
     #   * {Types::GetAnomalySubscriptionsResponse#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_anomaly_subscriptions({
@@ -1434,6 +1440,8 @@ def get_commitment_purchase_analysis(params = {}, options = {})
     #   * {Types::GetCostAndUsageResponse#results_by_time #results_by_time} => Array&lt;Types::ResultByTime&gt;
     #   * {Types::GetCostAndUsageResponse#dimension_value_attributes #dimension_value_attributes} => Array&lt;Types::DimensionValuesWithAttributes&gt;
     #
+    # 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({
@@ -1617,6 +1625,8 @@ def get_cost_and_usage(params = {}, options = {})
     #   * {Types::GetCostAndUsageWithResourcesResponse#results_by_time #results_by_time} => Array&lt;Types::ResultByTime&gt;
     #   * {Types::GetCostAndUsageWithResourcesResponse#dimension_value_attributes #dimension_value_attributes} => Array&lt;Types::DimensionValuesWithAttributes&gt;
     #
+    # 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({
@@ -1740,6 +1750,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.
     #
@@ -1754,6 +1765,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.
@@ -1764,6 +1776,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
@@ -1779,6 +1792,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: ` {
@@ -1858,6 +1872,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({
@@ -2282,6 +2298,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.
     #
@@ -2296,6 +2313,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.
@@ -2306,6 +2324,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
@@ -2321,6 +2340,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: ` {
@@ -2397,6 +2417,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({
@@ -2639,6 +2661,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({
@@ -2788,6 +2812,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.
     #
@@ -2802,6 +2827,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.
@@ -2812,6 +2838,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
@@ -2827,6 +2854,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: ` {
@@ -2892,6 +2920,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({
@@ -3155,6 +3185,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({
@@ -3313,6 +3345,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.
     #
@@ -3327,6 +3360,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.
@@ -3337,6 +3371,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
@@ -3352,6 +3387,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: ` {
@@ -3409,6 +3445,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({
@@ -3842,6 +3880,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({
@@ -4287,6 +4327,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.
     #
@@ -4301,6 +4342,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.
@@ -4311,6 +4353,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
@@ -4326,6 +4369,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: ` {
@@ -4400,6 +4444,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({
@@ -4874,6 +4920,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({