aws-sdk-bcmrecommendedactions 1.0.0

data/lib/aws-sdk-bcmrecommendedactions/types.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::BCMRecommendedActions
+  module Types
+
+    # You do not have sufficient access to perform this action.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/AccessDeniedException AWS API Documentation
+    #
+    class AccessDeniedException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Describes a filter that returns a more specific list of recommended
+    # actions.
+    #
+    # @!attribute [rw] key
+    #   The category to filter on. Valid values are `FEATURE` for feature
+    #   type, `SEVERITY` for severity level, and `TYPE` for recommendation
+    #   type.
+    #   @return [String]
+    #
+    # @!attribute [rw] match_option
+    #   Specifies how to apply the filter. Use `EQUALS` to include matching
+    #   results or `NOT_EQUALS` to exclude matching results.
+    #   @return [String]
+    #
+    # @!attribute [rw] values
+    #   One or more values to match against the specified key.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/ActionFilter AWS API Documentation
+    #
+    class ActionFilter < Struct.new(
+      :key,
+      :match_option,
+      :values)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # An unexpected error occurred during the processing of your request.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/InternalServerException AWS API Documentation
+    #
+    class InternalServerException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] filter
+    #   The criteria that you want all returned recommended actions to
+    #   match.
+    #   @return [Types::RequestFilter]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return in the response.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token that indicates the next set of results that you
+    #   want to retrieve.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/ListRecommendedActionsRequest AWS API Documentation
+    #
+    class ListRecommendedActionsRequest < Struct.new(
+      :filter,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recommended_actions
+    #   The list of recommended actions that satisfy the filter criteria.
+    #   @return [Array<Types::RecommendedAction>]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token that indicates the next set of results that you
+    #   want to retrieve.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/ListRecommendedActionsResponse AWS API Documentation
+    #
+    class ListRecommendedActionsResponse < Struct.new(
+      :recommended_actions,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Describes a specific recommended action.
+    #
+    # @!attribute [rw] id
+    #   The ID for the recommended action.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The type of action you can take by adopting the recommended action.
+    #   @return [String]
+    #
+    # @!attribute [rw] account_id
+    #   The account that the recommended action is for.
+    #   @return [String]
+    #
+    # @!attribute [rw] severity
+    #   The severity associated with the recommended action.
+    #   @return [String]
+    #
+    # @!attribute [rw] feature
+    #   The feature associated with the recommended action.
+    #   @return [String]
+    #
+    # @!attribute [rw] context
+    #   Context that applies to the recommended action.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] next_steps
+    #   The possible next steps to execute the recommended action.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] last_updated_time_stamp
+    #   The time when the recommended action status was last updated.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/RecommendedAction AWS API Documentation
+    #
+    class RecommendedAction < Struct.new(
+      :id,
+      :type,
+      :account_id,
+      :severity,
+      :feature,
+      :context,
+      :next_steps,
+      :last_updated_time_stamp)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Enables filtering of results based on specified action criteria. You
+    # can define multiple action filters to refine results using
+    # combinations of feature type, severity level, and recommendation type.
+    #
+    # @!attribute [rw] actions
+    #   A list of action filters that define criteria for filtering results.
+    #   Each filter specifies a key, match option, and corresponding values
+    #   to filter on.
+    #   @return [Array<Types::ActionFilter>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/RequestFilter AWS API Documentation
+    #
+    class RequestFilter < Struct.new(
+      :actions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The request was denied due to request throttling.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/ThrottlingException AWS API Documentation
+    #
+    class ThrottlingException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The input fails to satisfy the constraints specified by an Amazon Web
+    # Services service.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @!attribute [rw] reason
+    #   Provides a single, overarching explanation for the validation
+    #   failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] field_list
+    #   Lists each problematic field and why it failed validation.
+    #   @return [Array<Types::ValidationExceptionField>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/ValidationException AWS API Documentation
+    #
+    class ValidationException < Struct.new(
+      :message,
+      :reason,
+      :field_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides specific details about why a particular field failed
+    # validation.
+    #
+    # @!attribute [rw] name
+    #   Provides the name of the field that failed validation.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   Provides a message explaining why the field failed validation.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bcm-recommended-actions-2024-11-14/ValidationExceptionField AWS API Documentation
+    #
+    class ValidationExceptionField < Struct.new(
+      :name,
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+  end
+end
+

data/lib/aws-sdk-bcmrecommendedactions/waiters.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::BCMRecommendedActions
+  module Waiters
+  end
+end

data/lib/aws-sdk-bcmrecommendedactions.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:bcmrecommendedactions)
+
+# This module provides support for AWS Billing and Cost Management Recommended Actions. This module is available in the
+# `aws-sdk-bcmrecommendedactions` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+#     bcm_recommended_actions = Aws::BCMRecommendedActions::Client.new
+#     resp = bcm_recommended_actions.list_recommended_actions(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS Billing and Cost Management Recommended Actions are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::BCMRecommendedActions::Errors::ServiceError
+#       # rescues all AWS Billing and Cost Management Recommended Actions API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::BCMRecommendedActions
+  autoload :Types, 'aws-sdk-bcmrecommendedactions/types'
+  autoload :ClientApi, 'aws-sdk-bcmrecommendedactions/client_api'
+  module Plugins
+    autoload :Endpoints, 'aws-sdk-bcmrecommendedactions/plugins/endpoints.rb'
+  end
+  autoload :Client, 'aws-sdk-bcmrecommendedactions/client'
+  autoload :Errors, 'aws-sdk-bcmrecommendedactions/errors'
+  autoload :Waiters, 'aws-sdk-bcmrecommendedactions/waiters'
+  autoload :Resource, 'aws-sdk-bcmrecommendedactions/resource'
+  autoload :EndpointParameters, 'aws-sdk-bcmrecommendedactions/endpoint_parameters'
+  autoload :EndpointProvider, 'aws-sdk-bcmrecommendedactions/endpoint_provider'
+  autoload :Endpoints, 'aws-sdk-bcmrecommendedactions/endpoints'
+
+  GEM_VERSION = '1.0.0'
+
+end
+
+require_relative 'aws-sdk-bcmrecommendedactions/customizations'

data/sig/client.rbs

@@ -0,0 +1,105 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module BCMRecommendedActions
+    class Client < ::Seahorse::Client::Base
+      include ::Aws::ClientStubs
+
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BCMRecommendedActions/Client.html#initialize-instance_method
+      def self.new: (
+                      ?credentials: untyped,
+                      ?region: String,
+                      ?access_key_id: String,
+                      ?account_id: String,
+                      ?active_endpoint_cache: bool,
+                      ?adaptive_retry_wait_to_fill: bool,
+                      ?auth_scheme_preference: Array[String],
+                      ?client_side_monitoring: bool,
+                      ?client_side_monitoring_client_id: String,
+                      ?client_side_monitoring_host: String,
+                      ?client_side_monitoring_port: Integer,
+                      ?client_side_monitoring_publisher: untyped,
+                      ?convert_params: bool,
+                      ?correct_clock_skew: bool,
+                      ?defaults_mode: String,
+                      ?disable_host_prefix_injection: bool,
+                      ?disable_request_compression: bool,
+                      ?endpoint: String,
+                      ?endpoint_cache_max_entries: Integer,
+                      ?endpoint_cache_max_threads: Integer,
+                      ?endpoint_cache_poll_interval: Integer,
+                      ?endpoint_discovery: bool,
+                      ?ignore_configured_endpoint_urls: bool,
+                      ?log_formatter: untyped,
+                      ?log_level: Symbol,
+                      ?logger: untyped,
+                      ?max_attempts: Integer,
+                      ?profile: String,
+                      ?request_checksum_calculation: String,
+                      ?request_min_compression_size_bytes: Integer,
+                      ?response_checksum_validation: String,
+                      ?retry_backoff: Proc,
+                      ?retry_base_delay: Float,
+                      ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
+                      ?retry_limit: Integer,
+                      ?retry_max_delay: Integer,
+                      ?retry_mode: ("legacy" | "standard" | "adaptive"),
+                      ?sdk_ua_app_id: String,
+                      ?secret_access_key: String,
+                      ?session_token: String,
+                      ?sigv4a_signing_region_set: Array[String],
+                      ?simple_json: bool,
+                      ?stub_responses: untyped,
+                      ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
+                      ?token_provider: untyped,
+                      ?use_dualstack_endpoint: bool,
+                      ?use_fips_endpoint: bool,
+                      ?validate_params: bool,
+                      ?endpoint_provider: untyped,
+                      ?http_proxy: String,
+                      ?http_open_timeout: (Float | Integer),
+                      ?http_read_timeout: (Float | Integer),
+                      ?http_idle_timeout: (Float | Integer),
+                      ?http_continue_timeout: (Float | Integer),
+                      ?ssl_timeout: (Float | Integer | nil),
+                      ?http_wire_trace: bool,
+                      ?ssl_verify_peer: bool,
+                      ?ssl_ca_bundle: String,
+                      ?ssl_ca_directory: String,
+                      ?ssl_ca_store: String,
+                      ?on_chunk_received: Proc,
+                      ?on_chunk_sent: Proc,
+                      ?raise_response_errors: bool
+                    ) -> instance
+                  | (?Hash[Symbol, untyped]) -> instance
+
+
+      interface _ListRecommendedActionsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListRecommendedActionsResponse]
+        def recommended_actions: () -> ::Array[Types::RecommendedAction]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BCMRecommendedActions/Client.html#list_recommended_actions-instance_method
+      def list_recommended_actions: (
+                                      ?filter: {
+                                        actions: Array[
+                                          {
+                                            key: ("FEATURE" | "SEVERITY" | "TYPE"),
+                                            match_option: ("EQUALS" | "NOT_EQUALS"),
+                                            values: Array[::String]
+                                          },
+                                        ]?
+                                      },
+                                      ?max_results: ::Integer,
+                                      ?next_token: ::String
+                                    ) -> _ListRecommendedActionsResponseSuccess
+                                  | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRecommendedActionsResponseSuccess
+    end
+  end
+end
+

data/sig/errors.rbs

@@ -0,0 +1,30 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module BCMRecommendedActions
+    module Errors
+      class ServiceError < ::Aws::Errors::ServiceError
+      end
+
+      class AccessDeniedException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class InternalServerException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class ThrottlingException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
+      class ValidationException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+        def reason: () -> ::String
+        def field_list: () -> ::String
+      end
+    end
+  end
+end

data/sig/resource.rbs

@@ -0,0 +1,86 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module BCMRecommendedActions
+    # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BCMRecommendedActions/Resource.html
+    class Resource
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BCMRecommendedActions/Resource.html#initialize-instance_method
+      def initialize: (
+                        ?client: Client,
+                        ?credentials: untyped,
+                        ?region: String,
+                        ?access_key_id: String,
+                        ?account_id: String,
+                        ?active_endpoint_cache: bool,
+                        ?adaptive_retry_wait_to_fill: bool,
+                        ?auth_scheme_preference: Array[String],
+                        ?client_side_monitoring: bool,
+                        ?client_side_monitoring_client_id: String,
+                        ?client_side_monitoring_host: String,
+                        ?client_side_monitoring_port: Integer,
+                        ?client_side_monitoring_publisher: untyped,
+                        ?convert_params: bool,
+                        ?correct_clock_skew: bool,
+                        ?defaults_mode: String,
+                        ?disable_host_prefix_injection: bool,
+                        ?disable_request_compression: bool,
+                        ?endpoint: String,
+                        ?endpoint_cache_max_entries: Integer,
+                        ?endpoint_cache_max_threads: Integer,
+                        ?endpoint_cache_poll_interval: Integer,
+                        ?endpoint_discovery: bool,
+                        ?ignore_configured_endpoint_urls: bool,
+                        ?log_formatter: untyped,
+                        ?log_level: Symbol,
+                        ?logger: untyped,
+                        ?max_attempts: Integer,
+                        ?profile: String,
+                        ?request_checksum_calculation: String,
+                        ?request_min_compression_size_bytes: Integer,
+                        ?response_checksum_validation: String,
+                        ?retry_backoff: Proc,
+                        ?retry_base_delay: Float,
+                        ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
+                        ?retry_limit: Integer,
+                        ?retry_max_delay: Integer,
+                        ?retry_mode: ("legacy" | "standard" | "adaptive"),
+                        ?sdk_ua_app_id: String,
+                        ?secret_access_key: String,
+                        ?session_token: String,
+                        ?sigv4a_signing_region_set: Array[String],
+                        ?simple_json: bool,
+                        ?stub_responses: untyped,
+                        ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
+                        ?token_provider: untyped,
+                        ?use_dualstack_endpoint: bool,
+                        ?use_fips_endpoint: bool,
+                        ?validate_params: bool,
+                        ?endpoint_provider: untyped,
+                        ?http_proxy: String,
+                        ?http_open_timeout: (Float | Integer),
+                        ?http_read_timeout: (Float | Integer),
+                        ?http_idle_timeout: (Float | Integer),
+                        ?http_continue_timeout: (Float | Integer),
+                        ?ssl_timeout: (Float | Integer | nil),
+                        ?http_wire_trace: bool,
+                        ?ssl_verify_peer: bool,
+                        ?ssl_ca_bundle: String,
+                        ?ssl_ca_directory: String,
+                        ?ssl_ca_store: String,
+                        ?on_chunk_received: Proc,
+                        ?on_chunk_sent: Proc,
+                        ?raise_response_errors: bool
+                      ) -> void
+                    | (?Hash[Symbol, untyped]) -> void
+
+      def client: () -> Client
+
+
+    end
+  end
+end

data/sig/types.rbs

@@ -0,0 +1,76 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::BCMRecommendedActions
+  module Types
+
+    class AccessDeniedException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class ActionFilter
+      attr_accessor key: ("FEATURE" | "SEVERITY" | "TYPE")
+      attr_accessor match_option: ("EQUALS" | "NOT_EQUALS")
+      attr_accessor values: ::Array[::String]
+      SENSITIVE: []
+    end
+
+    class InternalServerException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class ListRecommendedActionsRequest
+      attr_accessor filter: Types::RequestFilter
+      attr_accessor max_results: ::Integer
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class ListRecommendedActionsResponse
+      attr_accessor recommended_actions: ::Array[Types::RecommendedAction]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class RecommendedAction
+      attr_accessor id: ::String
+      attr_accessor type: ("ADD_ALTERNATE_BILLING_CONTACT" | "CREATE_ANOMALY_MONITOR" | "CREATE_BUDGET" | "ENABLE_COST_OPTIMIZATION_HUB" | "MIGRATE_TO_GRANULAR_PERMISSIONS" | "PAYMENTS_DUE" | "PAYMENTS_PAST_DUE" | "REVIEW_ANOMALIES" | "REVIEW_BUDGET_ALERTS" | "REVIEW_BUDGETS_EXCEEDED" | "REVIEW_EXPIRING_RI" | "REVIEW_EXPIRING_SP" | "REVIEW_FREETIER_USAGE_ALERTS" | "REVIEW_SAVINGS_OPPORTUNITY_RECOMMENDATIONS" | "UPDATE_EXPIRED_PAYMENT_METHOD" | "UPDATE_INVALID_PAYMENT_METHOD" | "UPDATE_TAX_EXEMPTION_CERTIFICATE" | "UPDATE_TAX_REGISTRATION_NUMBER")
+      attr_accessor account_id: ::String
+      attr_accessor severity: ("INFO" | "WARNING" | "CRITICAL")
+      attr_accessor feature: ("ACCOUNT" | "BUDGETS" | "COST_ANOMALY_DETECTION" | "COST_OPTIMIZATION_HUB" | "FREE_TIER" | "IAM" | "PAYMENTS" | "RESERVATIONS" | "SAVINGS_PLANS" | "TAX_SETTINGS")
+      attr_accessor context: ::Hash[::String, ::String]
+      attr_accessor next_steps: ::Array[::String]
+      attr_accessor last_updated_time_stamp: ::String
+      SENSITIVE: []
+    end
+
+    class RequestFilter
+      attr_accessor actions: ::Array[Types::ActionFilter]
+      SENSITIVE: []
+    end
+
+    class ThrottlingException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
+    class ValidationException
+      attr_accessor message: ::String
+      attr_accessor reason: ("unknownOperation" | "cannotParse" | "fieldValidationFailed" | "other")
+      attr_accessor field_list: ::Array[Types::ValidationExceptionField]
+      SENSITIVE: []
+    end
+
+    class ValidationExceptionField
+      attr_accessor name: ::String
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+  end
+end

data/sig/waiters.rbs

@@ -0,0 +1,13 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module BCMRecommendedActions
+    module Waiters
+    end
+  end
+end