aws-sdk-bcmrecommendedactions 1.0.0

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

@@ -0,0 +1,145 @@
+# 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
+  # @api private
+  module ClientApi
+
+    include Seahorse::Model
+
+    AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
+    AccountId = Shapes::StringShape.new(name: 'AccountId')
+    ActionFilter = Shapes::StructureShape.new(name: 'ActionFilter')
+    ActionFilterList = Shapes::ListShape.new(name: 'ActionFilterList')
+    ActionType = Shapes::StringShape.new(name: 'ActionType')
+    Context = Shapes::MapShape.new(name: 'Context')
+    Feature = Shapes::StringShape.new(name: 'Feature')
+    FilterName = Shapes::StringShape.new(name: 'FilterName')
+    FilterValue = Shapes::StringShape.new(name: 'FilterValue')
+    FilterValues = Shapes::ListShape.new(name: 'FilterValues')
+    InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
+    ListRecommendedActionsRequest = Shapes::StructureShape.new(name: 'ListRecommendedActionsRequest')
+    ListRecommendedActionsResponse = Shapes::StructureShape.new(name: 'ListRecommendedActionsResponse')
+    MatchOption = Shapes::StringShape.new(name: 'MatchOption')
+    MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
+    NextStep = Shapes::StringShape.new(name: 'NextStep')
+    NextSteps = Shapes::ListShape.new(name: 'NextSteps')
+    NextToken = Shapes::StringShape.new(name: 'NextToken')
+    RecommendedAction = Shapes::StructureShape.new(name: 'RecommendedAction')
+    RecommendedActions = Shapes::ListShape.new(name: 'RecommendedActions')
+    RequestFilter = Shapes::StructureShape.new(name: 'RequestFilter')
+    Severity = Shapes::StringShape.new(name: 'Severity')
+    String = Shapes::StringShape.new(name: 'String')
+    ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
+    ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
+    ValidationExceptionField = Shapes::StructureShape.new(name: 'ValidationExceptionField')
+    ValidationExceptionFieldList = Shapes::ListShape.new(name: 'ValidationExceptionFieldList')
+    ValidationExceptionReason = Shapes::StringShape.new(name: 'ValidationExceptionReason')
+
+    AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
+    AccessDeniedException.struct_class = Types::AccessDeniedException
+
+    ActionFilter.add_member(:key, Shapes::ShapeRef.new(shape: FilterName, required: true, location_name: "key"))
+    ActionFilter.add_member(:match_option, Shapes::ShapeRef.new(shape: MatchOption, required: true, location_name: "matchOption"))
+    ActionFilter.add_member(:values, Shapes::ShapeRef.new(shape: FilterValues, required: true, location_name: "values"))
+    ActionFilter.struct_class = Types::ActionFilter
+
+    ActionFilterList.member = Shapes::ShapeRef.new(shape: ActionFilter)
+
+    Context.key = Shapes::ShapeRef.new(shape: String)
+    Context.value = Shapes::ShapeRef.new(shape: String)
+
+    FilterValues.member = Shapes::ShapeRef.new(shape: FilterValue)
+
+    InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
+    InternalServerException.struct_class = Types::InternalServerException
+
+    ListRecommendedActionsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: RequestFilter, location_name: "filter"))
+    ListRecommendedActionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
+    ListRecommendedActionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListRecommendedActionsRequest.struct_class = Types::ListRecommendedActionsRequest
+
+    ListRecommendedActionsResponse.add_member(:recommended_actions, Shapes::ShapeRef.new(shape: RecommendedActions, required: true, location_name: "recommendedActions"))
+    ListRecommendedActionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListRecommendedActionsResponse.struct_class = Types::ListRecommendedActionsResponse
+
+    NextSteps.member = Shapes::ShapeRef.new(shape: NextStep)
+
+    RecommendedAction.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
+    RecommendedAction.add_member(:type, Shapes::ShapeRef.new(shape: ActionType, location_name: "type"))
+    RecommendedAction.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "accountId"))
+    RecommendedAction.add_member(:severity, Shapes::ShapeRef.new(shape: Severity, location_name: "severity"))
+    RecommendedAction.add_member(:feature, Shapes::ShapeRef.new(shape: Feature, location_name: "feature"))
+    RecommendedAction.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
+    RecommendedAction.add_member(:next_steps, Shapes::ShapeRef.new(shape: NextSteps, location_name: "nextSteps"))
+    RecommendedAction.add_member(:last_updated_time_stamp, Shapes::ShapeRef.new(shape: String, location_name: "lastUpdatedTimeStamp"))
+    RecommendedAction.struct_class = Types::RecommendedAction
+
+    RecommendedActions.member = Shapes::ShapeRef.new(shape: RecommendedAction)
+
+    RequestFilter.add_member(:actions, Shapes::ShapeRef.new(shape: ActionFilterList, location_name: "actions"))
+    RequestFilter.struct_class = Types::RequestFilter
+
+    ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
+    ThrottlingException.struct_class = Types::ThrottlingException
+
+    ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
+    ValidationException.add_member(:reason, Shapes::ShapeRef.new(shape: ValidationExceptionReason, required: true, location_name: "reason"))
+    ValidationException.add_member(:field_list, Shapes::ShapeRef.new(shape: ValidationExceptionFieldList, location_name: "fieldList"))
+    ValidationException.struct_class = Types::ValidationException
+
+    ValidationExceptionField.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "name"))
+    ValidationExceptionField.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
+    ValidationExceptionField.struct_class = Types::ValidationExceptionField
+
+    ValidationExceptionFieldList.member = Shapes::ShapeRef.new(shape: ValidationExceptionField)
+
+
+    # @api private
+    API = Seahorse::Model::Api.new.tap do |api|
+
+      api.version = "2024-11-14"
+
+      api.metadata = {
+        "apiVersion" => "2024-11-14",
+        "auth" => ["aws.auth#sigv4"],
+        "endpointPrefix" => "bcm-recommended-actions",
+        "jsonVersion" => "1.0",
+        "protocol" => "json",
+        "protocols" => ["json"],
+        "serviceFullName" => "AWS Billing and Cost Management Recommended Actions",
+        "serviceId" => "BCM Recommended Actions",
+        "signatureVersion" => "v4",
+        "signingName" => "bcm-recommended-actions",
+        "targetPrefix" => "AWSBillingAndCostManagementRecommendedActions",
+        "uid" => "bcm-recommended-actions-2024-11-14",
+      }
+
+      api.add_operation(:list_recommended_actions, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListRecommendedActions"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListRecommendedActionsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListRecommendedActionsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+    end
+
+  end
+end

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

@@ -0,0 +1,59 @@
+# 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
+  # Endpoint parameters used to influence endpoints per request.
+  #
+  # @!attribute use_fips
+  #   When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
+  #
+  #   @return [Boolean]
+  #
+  # @!attribute endpoint
+  #   Override the endpoint used to send this request
+  #
+  #   @return [String]
+  #
+  # @!attribute region
+  #   The AWS region used to dispatch the request.
+  #
+  #   @return [String]
+  #
+  EndpointParameters = Struct.new(
+    :use_fips,
+    :endpoint,
+    :region,
+  ) do
+    include Aws::Structure
+
+    # @api private
+    class << self
+      PARAM_MAP = {
+        'UseFIPS' => :use_fips,
+        'Endpoint' => :endpoint,
+        'Region' => :region,
+      }.freeze
+    end
+
+    def initialize(options = {})
+      self[:use_fips] = options[:use_fips]
+      self[:use_fips] = false if self[:use_fips].nil?
+      self[:endpoint] = options[:endpoint]
+      self[:region] = options[:region]
+    end
+
+    def self.create(config, options={})
+      new({
+        use_fips: config.use_fips_endpoint,
+        endpoint: (config.endpoint.to_s unless config.regional_endpoint),
+        region: config.region,
+      }.merge(options))
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# 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
+  class EndpointProvider
+    def resolve_endpoint(parameters)
+      if Aws::Endpoints::Matchers.set?(parameters.endpoint)
+        if Aws::Endpoints::Matchers.boolean_equals?(parameters.use_fips, true)
+          raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
+        end
+        return Aws::Endpoints::Endpoint.new(url: parameters.endpoint, headers: {}, properties: {})
+      end
+      if Aws::Endpoints::Matchers.set?(parameters.region)
+        if (partition_result = Aws::Endpoints::Matchers.aws_partition(parameters.region))
+          if Aws::Endpoints::Matchers.boolean_equals?(parameters.use_fips, true)
+            return Aws::Endpoints::Endpoint.new(url: "https://bcm-recommended-actions-fips.#{partition_result['implicitGlobalRegion']}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {"authSchemes" => [{"name" => "sigv4", "signingRegion" => "#{partition_result['implicitGlobalRegion']}"}]})
+          end
+          return Aws::Endpoints::Endpoint.new(url: "https://bcm-recommended-actions.#{partition_result['implicitGlobalRegion']}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {"authSchemes" => [{"name" => "sigv4", "signingRegion" => "#{partition_result['implicitGlobalRegion']}"}]})
+        end
+      end
+      raise ArgumentError, "Invalid Configuration: Missing Region"
+      raise ArgumentError, 'No endpoint could be resolved'
+
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# 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
+  # @api private
+  module Endpoints
+
+
+    def self.parameters_for_operation(context)
+      Aws::BCMRecommendedActions::EndpointParameters.create(context.config)
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# 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
+
+  # When BCMRecommendedActions returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::BCMRecommendedActions::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all BCMRecommendedActions errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::BCMRecommendedActions::Errors::ServiceError
+  #       # rescues all BCMRecommendedActions API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {AccessDeniedException}
+  # * {InternalServerException}
+  # * {ThrottlingException}
+  # * {ValidationException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
+  module Errors
+
+    extend Aws::Errors::DynamicErrors
+
+    class AccessDeniedException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::BCMRecommendedActions::Types::AccessDeniedException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class InternalServerException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::BCMRecommendedActions::Types::InternalServerException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class ThrottlingException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::BCMRecommendedActions::Types::ThrottlingException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class ValidationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::BCMRecommendedActions::Types::ValidationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+
+      # @return [String]
+      def reason
+        @data[:reason]
+      end
+
+      # @return [String]
+      def field_list
+        @data[:field_list]
+      end
+    end
+
+  end
+end

data/lib/aws-sdk-bcmrecommendedactions/plugins/endpoints.rb

@@ -0,0 +1,77 @@
+# 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 Plugins
+    class Endpoints < Seahorse::Client::Plugin
+      option(
+        :endpoint_provider,
+        doc_type: 'Aws::BCMRecommendedActions::EndpointProvider',
+        rbs_type: 'untyped',
+        docstring: <<~DOCS) do |_cfg|
+The endpoint provider used to resolve endpoints. Any object that responds to
+`#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
+`Aws::BCMRecommendedActions::EndpointParameters`.
+        DOCS
+        Aws::BCMRecommendedActions::EndpointProvider.new
+      end
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          unless context[:discovered_endpoint]
+            params = Aws::BCMRecommendedActions::Endpoints.parameters_for_operation(context)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
+          end
+
+          context[:auth_scheme] =
+            Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+          with_metrics(context) { @handler.call(context) }
+        end
+
+        private
+
+        def with_metrics(context, &block)
+          metrics = []
+          metrics << 'ENDPOINT_OVERRIDE' unless context.config.regional_endpoint
+          if context[:auth_scheme] && context[:auth_scheme]['name'] == 'sigv4a'
+            metrics << 'SIGV4A_SIGNING'
+          end
+          if context.config.credentials&.credentials&.account_id
+            metrics << 'RESOLVED_ACCOUNT_ID'
+          end
+          Aws::Plugins::UserAgent.metric(*metrics, &block)
+        end
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, values|
+            value = values
+              .compact
+              .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+              .join(',')
+
+            context.http_request.headers[key] = value
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :build, priority: 75)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# 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
+
+  class Resource
+
+    # @param options ({})
+    # @option options [Client] :client
+    def initialize(options = {})
+      @client = options[:client] || Client.new(options)
+    end
+
+    # @return [Client]
+    def client
+      @client
+    end
+
+  end
+end