aws-sdk-s3control 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d00ae0c2db0f9204310e66f35add770d3c43567
+  data.tar.gz: 81ccf9923309be2636be6fd9d9ccd1092f1c32a0
+SHA512:
+  metadata.gz: a48ff74973ce199a422edcbb1075029302878b1a1df110cc8e9c2179ae1c35034ad5e6542c1f310f35db32dedb56b9c2d8772e8786edaf62b9f92c3a6a6125dd
+  data.tar.gz: fccd21b1eba52e7f076b2cf3f88be5cac9ad9f12240f902b9f2bee0731749a6e3576b2a7af73a807ca36bb766958ca324d2e13da2353244dd034d04d5c03fec3

data/lib/aws-sdk-s3control/client.rb

@@ -0,0 +1,338 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'seahorse/client/plugins/content_length.rb'
+require 'aws-sdk-core/plugins/credentials_configuration.rb'
+require 'aws-sdk-core/plugins/logging.rb'
+require 'aws-sdk-core/plugins/param_converter.rb'
+require 'aws-sdk-core/plugins/param_validator.rb'
+require 'aws-sdk-core/plugins/user_agent.rb'
+require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
+require 'aws-sdk-core/plugins/retry_errors.rb'
+require 'aws-sdk-core/plugins/global_configuration.rb'
+require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
+require 'aws-sdk-core/plugins/response_paging.rb'
+require 'aws-sdk-core/plugins/stub_responses.rb'
+require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
+require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
+require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
+require 'aws-sdk-core/plugins/protocols/rest_xml.rb'
+require 'aws-sdk-s3control/plugins/s3_control_dns.rb'
+require 'aws-sdk-s3control/plugins/s3_signer.rb'
+require 'aws-sdk-s3control/plugins/dualstack.rb'
+require 'aws-sdk-s3control/plugins/s3_host_id.rb'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:s3control)
+
+module Aws::S3Control
+  class Client < Seahorse::Client::Base
+
+    include Aws::ClientStubs
+
+    @identifier = :s3control
+
+    set_api(ClientApi::API)
+
+    add_plugin(Seahorse::Client::Plugins::ContentLength)
+    add_plugin(Aws::Plugins::CredentialsConfiguration)
+    add_plugin(Aws::Plugins::Logging)
+    add_plugin(Aws::Plugins::ParamConverter)
+    add_plugin(Aws::Plugins::ParamValidator)
+    add_plugin(Aws::Plugins::UserAgent)
+    add_plugin(Aws::Plugins::HelpfulSocketErrors)
+    add_plugin(Aws::Plugins::RetryErrors)
+    add_plugin(Aws::Plugins::GlobalConfiguration)
+    add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::EndpointDiscovery)
+    add_plugin(Aws::Plugins::ResponsePaging)
+    add_plugin(Aws::Plugins::StubResponses)
+    add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::JsonvalueConverter)
+    add_plugin(Aws::Plugins::ClientMetricsPlugin)
+    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
+    add_plugin(Aws::Plugins::Protocols::RestXml)
+    add_plugin(Aws::S3Control::Plugins::S3ControlDns)
+    add_plugin(Aws::S3Control::Plugins::S3Signer)
+    add_plugin(Aws::S3Control::Plugins::Dualstack)
+    add_plugin(Aws::S3Control::Plugins::S3HostId)
+
+    # @overload initialize(options)
+    #   @param [Hash] options
+    #   @option options [required, Aws::CredentialProvider] :credentials
+    #     Your AWS credentials. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::Credentials` - Used for configuring static, non-refreshing
+    #       credentials.
+    #
+    #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
+    #       from an EC2 IMDS on an EC2 instance.
+    #
+    #     * `Aws::SharedCredentials` - Used for loading credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     When `:credentials` are not configured directly, the following
+    #     locations will be searched for credentials:
+    #
+    #     * `Aws.config[:credentials]`
+    #     * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
+    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #     * EC2 IMDS instance profile - When used by default, the timeouts are
+    #       very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` to enable retries and extended
+    #       timeouts.
+    #
+    #   @option options [required, String] :region
+    #     The AWS region to connect to.  The configured `:region` is
+    #     used to determine the service `:endpoint`. When not passed,
+    #     a default `:region` is search for in the following locations:
+    #
+    #     * `Aws.config[:region]`
+    #     * `ENV['AWS_REGION']`
+    #     * `ENV['AMAZON_REGION']`
+    #     * `ENV['AWS_DEFAULT_REGION']`
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #
+    #   @option options [String] :access_key_id
+    #
+    #   @option options [Boolean] :active_endpoint_cache (false)
+    #     When set to `true`, a thread polling for endpoints will be running in
+    #     the background every 60 secs (default). Defaults to `false`.
+    #
+    #   @option options [Boolean] :client_side_monitoring (false)
+    #     When `true`, client-side metrics will be collected for all API requests from
+    #     this client.
+    #
+    #   @option options [String] :client_side_monitoring_client_id ("")
+    #     Allows you to provide an identifier for this client which will be attached to
+    #     all generated client side metrics. Defaults to an empty string.
+    #
+    #   @option options [Integer] :client_side_monitoring_port (31000)
+    #     Required for publishing client metrics. The port that the client side monitoring
+    #     agent is running on, where client metrics will be published via UDP.
+    #
+    #   @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
+    #     Allows you to provide a custom client-side monitoring publisher class. By default,
+    #     will use the Client Side Monitoring Agent Publisher.
+    #
+    #   @option options [Boolean] :convert_params (true)
+    #     When `true`, an attempt is made to coerce request parameters into
+    #     the required types.
+    #
+    #   @option options [String] :endpoint
+    #     The client endpoint is normally constructed from the `:region`
+    #     option. You should only configure an `:endpoint` when connecting
+    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #
+    #   @option options [Integer] :endpoint_cache_max_entries (1000)
+    #     Used for the maximum size limit of the LRU cache storing endpoints data
+    #     for endpoint discovery enabled operations. Defaults to 1000.
+    #
+    #   @option options [Integer] :endpoint_cache_max_threads (10)
+    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+    #
+    #   @option options [Integer] :endpoint_cache_poll_interval (60)
+    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
+    #     Use this option to config the time interval in seconds for making
+    #     requests fetching endpoints information. Defaults to 60 sec.
+    #
+    #   @option options [Boolean] :endpoint_discovery (false)
+    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #
+    #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
+    #     The log formatter.
+    #
+    #   @option options [Symbol] :log_level (:info)
+    #     The log level to send messages to the `:logger` at.
+    #
+    #   @option options [Logger] :logger
+    #     The Logger instance to send log messages to.  If this option
+    #     is not set, logging will be disabled.
+    #
+    #   @option options [String] :profile ("default")
+    #     Used when loading credentials from the shared credentials file
+    #     at HOME/.aws/credentials.  When not specified, 'default' is used.
+    #
+    #   @option options [Float] :retry_base_delay (0.3)
+    #     The base delay in seconds used by the default backoff function.
+    #
+    #   @option options [Symbol] :retry_jitter (:none)
+    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #
+    #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
+    #
+    #   @option options [Integer] :retry_limit (3)
+    #     The maximum number of times to retry failed requests.  Only
+    #     ~ 500 level server errors and certain ~ 400 level client errors
+    #     are retried.  Generally, these are throttling errors, data
+    #     checksum errors, networking errors, timeout errors and auth
+    #     errors from expired credentials.
+    #
+    #   @option options [Integer] :retry_max_delay (0)
+    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #
+    #   @option options [String] :secret_access_key
+    #
+    #   @option options [String] :session_token
+    #
+    #   @option options [Boolean] :stub_responses (false)
+    #     Causes the client to return stubbed responses. By default
+    #     fake responses are generated and returned. You can specify
+    #     the response data to return or errors to raise by calling
+    #     {ClientStubs#stub_responses}. See {ClientStubs} for more information.
+    #
+    #     ** Please note ** When response stubbing is enabled, no HTTP
+    #     requests are made, and retries are disabled.
+    #
+    #   @option options [Boolean] :use_dualstack_endpoint (false)
+    #     When set to `true`, IPv6-compatible bucket endpoints will be used
+    #     for all operations.
+    #
+    #   @option options [Boolean] :validate_params (true)
+    #     When `true`, request parameters are validated before
+    #     sending the request.
+    #
+    def initialize(*args)
+      super
+    end
+
+    # @!group API Operations
+
+    # Removes the Public Access Block configuration for an Amazon Web
+    # Services account.
+    #
+    # @option params [required, String] :account_id
+    #   The Account ID for the Amazon Web Services account whose Public Access
+    #   Block configuration you want to remove.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_public_access_block({
+    #     account_id: "AccountId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeletePublicAccessBlock AWS API Documentation
+    #
+    # @overload delete_public_access_block(params = {})
+    # @param [Hash] params ({})
+    def delete_public_access_block(params = {}, options = {})
+      req = build_request(:delete_public_access_block, params)
+      req.send_request(options)
+    end
+
+    # Retrieves the Public Access Block configuration for an Amazon Web
+    # Services account.
+    #
+    # @option params [required, String] :account_id
+    #   The Account ID for the Amazon Web Services account whose Public Access
+    #   Block configuration you want to retrieve.
+    #
+    # @return [Types::GetPublicAccessBlockOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetPublicAccessBlockOutput#public_access_block_configuration #public_access_block_configuration} => Types::PublicAccessBlockConfiguration
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_public_access_block({
+    #     account_id: "AccountId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.public_access_block_configuration.block_public_acls #=> Boolean
+    #   resp.public_access_block_configuration.ignore_public_acls #=> Boolean
+    #   resp.public_access_block_configuration.block_public_policy #=> Boolean
+    #   resp.public_access_block_configuration.restrict_public_buckets #=> Boolean
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlock AWS API Documentation
+    #
+    # @overload get_public_access_block(params = {})
+    # @param [Hash] params ({})
+    def get_public_access_block(params = {}, options = {})
+      req = build_request(:get_public_access_block, params)
+      req.send_request(options)
+    end
+
+    # Creates or modifies the Public Access Block configuration for an
+    # Amazon Web Services account.
+    #
+    # @option params [required, Types::PublicAccessBlockConfiguration] :public_access_block_configuration
+    #   The Public Access Block configuration that you want to apply to this
+    #   Amazon Web Services account.
+    #
+    # @option params [required, String] :account_id
+    #   The Account ID for the Amazon Web Services account whose Public Access
+    #   Block configuration you want to set.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_public_access_block({
+    #     public_access_block_configuration: { # required
+    #       block_public_acls: false,
+    #       ignore_public_acls: false,
+    #       block_public_policy: false,
+    #       restrict_public_buckets: false,
+    #     },
+    #     account_id: "AccountId", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlock AWS API Documentation
+    #
+    # @overload put_public_access_block(params = {})
+    # @param [Hash] params ({})
+    def put_public_access_block(params = {}, options = {})
+      req = build_request(:put_public_access_block, params)
+      req.send_request(options)
+    end
+
+    # @!endgroup
+
+    # @param params ({})
+    # @api private
+    def build_request(operation_name, params = {})
+      handlers = @handlers.for(operation_name)
+      context = Seahorse::Client::RequestContext.new(
+        operation_name: operation_name,
+        operation: config.api.operation(operation_name),
+        client: self,
+        params: params,
+        config: config)
+      context[:gem_name] = 'aws-sdk-s3control'
+      context[:gem_version] = '1.0.0'
+      Seahorse::Client::Request.new(handlers, context)
+    end
+
+    # @api private
+    # @deprecated
+    def waiter_names
+      []
+    end
+
+    class << self
+
+      # @api private
+      attr_reader :identifier
+
+      # @api private
+      def errors_module
+        Errors
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::S3Control
+  # @api private
+  module ClientApi
+
+    include Seahorse::Model
+
+    AccountId = Shapes::StringShape.new(name: 'AccountId')
+    DeletePublicAccessBlockRequest = Shapes::StructureShape.new(name: 'DeletePublicAccessBlockRequest')
+    GetPublicAccessBlockOutput = Shapes::StructureShape.new(name: 'GetPublicAccessBlockOutput')
+    GetPublicAccessBlockRequest = Shapes::StructureShape.new(name: 'GetPublicAccessBlockRequest')
+    NoSuchPublicAccessBlockConfiguration = Shapes::StructureShape.new(name: 'NoSuchPublicAccessBlockConfiguration')
+    NoSuchPublicAccessBlockConfigurationMessage = Shapes::StringShape.new(name: 'NoSuchPublicAccessBlockConfigurationMessage')
+    PublicAccessBlockConfiguration = Shapes::StructureShape.new(name: 'PublicAccessBlockConfiguration')
+    PutPublicAccessBlockRequest = Shapes::StructureShape.new(name: 'PutPublicAccessBlockRequest')
+    Setting = Shapes::BooleanShape.new(name: 'Setting')
+
+    DeletePublicAccessBlockRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location: "header", location_name: "x-amz-account-id"))
+    DeletePublicAccessBlockRequest.struct_class = Types::DeletePublicAccessBlockRequest
+
+    GetPublicAccessBlockOutput.add_member(:public_access_block_configuration, Shapes::ShapeRef.new(shape: PublicAccessBlockConfiguration, location_name: "PublicAccessBlockConfiguration"))
+    GetPublicAccessBlockOutput.struct_class = Types::GetPublicAccessBlockOutput
+    GetPublicAccessBlockOutput[:payload] = :public_access_block_configuration
+    GetPublicAccessBlockOutput[:payload_member] = GetPublicAccessBlockOutput.member(:public_access_block_configuration)
+
+    GetPublicAccessBlockRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location: "header", location_name: "x-amz-account-id"))
+    GetPublicAccessBlockRequest.struct_class = Types::GetPublicAccessBlockRequest
+
+    PublicAccessBlockConfiguration.add_member(:block_public_acls, Shapes::ShapeRef.new(shape: Setting, location_name: "BlockPublicAcls"))
+    PublicAccessBlockConfiguration.add_member(:ignore_public_acls, Shapes::ShapeRef.new(shape: Setting, location_name: "IgnorePublicAcls"))
+    PublicAccessBlockConfiguration.add_member(:block_public_policy, Shapes::ShapeRef.new(shape: Setting, location_name: "BlockPublicPolicy"))
+    PublicAccessBlockConfiguration.add_member(:restrict_public_buckets, Shapes::ShapeRef.new(shape: Setting, location_name: "RestrictPublicBuckets"))
+    PublicAccessBlockConfiguration.struct_class = Types::PublicAccessBlockConfiguration
+
+    PutPublicAccessBlockRequest.add_member(:public_access_block_configuration, Shapes::ShapeRef.new(shape: PublicAccessBlockConfiguration, required: true, location_name: "PublicAccessBlockConfiguration", metadata: {"xmlNamespace"=>{"uri"=>"http://awss3control.amazonaws.com/doc/2018-08-20/"}}))
+    PutPublicAccessBlockRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location: "header", location_name: "x-amz-account-id"))
+    PutPublicAccessBlockRequest.struct_class = Types::PutPublicAccessBlockRequest
+    PutPublicAccessBlockRequest[:payload] = :public_access_block_configuration
+    PutPublicAccessBlockRequest[:payload_member] = PutPublicAccessBlockRequest.member(:public_access_block_configuration)
+
+
+    # @api private
+    API = Seahorse::Model::Api.new.tap do |api|
+
+      api.version = "2018-08-20"
+
+      api.metadata = {
+        "apiVersion" => "2018-08-20",
+        "endpointPrefix" => "s3-control",
+        "protocol" => "rest-xml",
+        "serviceFullName" => "AWS S3 Control",
+        "serviceId" => "S3 Control",
+        "signatureVersion" => "s3v4",
+        "signingName" => "s3",
+        "uid" => "s3control-2018-08-20",
+      }
+
+      api.add_operation(:delete_public_access_block, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeletePublicAccessBlock"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/v20180820/configuration/publicAccessBlock"
+        o.input = Shapes::ShapeRef.new(shape: DeletePublicAccessBlockRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+      end)
+
+      api.add_operation(:get_public_access_block, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetPublicAccessBlock"
+        o.http_method = "GET"
+        o.http_request_uri = "/v20180820/configuration/publicAccessBlock"
+        o.input = Shapes::ShapeRef.new(shape: GetPublicAccessBlockRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetPublicAccessBlockOutput)
+        o.errors << Shapes::ShapeRef.new(shape: NoSuchPublicAccessBlockConfiguration)
+      end)
+
+      api.add_operation(:put_public_access_block, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "PutPublicAccessBlock"
+        o.http_method = "PUT"
+        o.http_request_uri = "/v20180820/configuration/publicAccessBlock"
+        o.input = Shapes::ShapeRef.new(shape: PutPublicAccessBlockRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+      end)
+    end
+
+  end
+end

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

@@ -0,0 +1,14 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::S3Control
+  module Errors
+
+    extend Aws::Errors::DynamicErrors
+
+  end
+end

data/lib/aws-sdk-s3control/plugins/dualstack.rb

@@ -0,0 +1,60 @@
+module Aws
+  module S3Control
+    module Plugins
+      # @api private
+      class Dualstack < Seahorse::Client::Plugin
+
+        option(:use_dualstack_endpoint,
+          default: false,
+          doc_type: 'Boolean',
+          docstring: <<-DOCS)
+When set to `true`, IPv6-compatible bucket endpoints will be used
+for all operations.
+          DOCS
+
+        def add_handlers(handlers, config)
+          handlers.add(OptionHandler, step: :initialize)
+          handlers.add(DualstackHandler, step: :build, priority: 2)
+        end
+
+        # @api private
+        class OptionHandler < Seahorse::Client::Handler
+          def call(context)
+            dualstack = context.params.delete(:use_dualstack_endpoint)
+            dualstack = context.config.use_dualstack_endpoint if dualstack.nil?
+            context[:use_dualstack_endpoint] = dualstack
+            @handler.call(context)
+          end
+        end
+
+        # @api private
+        class DualstackHandler < Seahorse::Client::Handler
+          def call(context)
+            apply_dualstack_endpoint(context) if use_dualstack_endpoint?(context)
+            @handler.call(context)
+          end
+
+          private
+          def apply_dualstack_endpoint(context)
+            bucket_name = context.params[:bucket]
+            region = context.config.region
+            dns_suffix = Aws::Partitions::EndpointProvider.dns_suffix_for(
+              region
+            )
+            host = "s3-control.dualstack.#{region}.#{dns_suffix}"
+            endpoint = URI.parse(context.http_request.endpoint.to_s)
+            endpoint.scheme = context.http_request.endpoint.scheme
+            endpoint.port = context.http_request.endpoint.port
+            endpoint.host = host
+            context.http_request.endpoint = endpoint.to_s
+          end
+
+          def use_dualstack_endpoint?(context)
+            context[:use_dualstack_endpoint]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3control/plugins/s3_control_dns.rb

@@ -0,0 +1,25 @@
+module Aws
+  module S3Control
+    module Plugins
+      class S3ControlDns < Seahorse::Client::Plugin
+        def add_handlers(handlers, config)
+          handlers.add(Handler, step: :build, priority: 1)
+        end
+
+        class Handler < Seahorse::Client::Handler
+          def call(context)
+            move_account_id_to_subdomain(context)
+            @handler.call(context)
+          end
+
+          private
+          def move_account_id_to_subdomain(context)
+            account_id = context.params[:account_id]
+            endpoint = context.http_request.endpoint
+            endpoint.host = "#{account_id}.#{endpoint.host}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3control/plugins/s3_host_id.rb

@@ -0,0 +1,28 @@
+module Aws
+  module S3Control
+    module Plugins
+
+      # Support S3 host id, more information, see:
+      # http://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html#sdk-request-ids
+      #
+      # This plugin adds :host_id for s3 responses when available
+      # @api private
+      class S3HostId < Seahorse::Client::Plugin
+
+        class Handler < Seahorse::Client::Handler
+
+          def call(context)
+            response = @handler.call(context)
+            h = context.http_response.headers
+            context[:s3_host_id] = h['x-amz-id-2']
+            response
+          end
+
+        end
+
+        handler(Handler, step: :sign)
+
+      end
+    end
+  end
+end

data/lib/aws-sdk-s3control/plugins/s3_signer.rb

@@ -0,0 +1,83 @@
+require 'aws-sigv4'
+
+module Aws
+  module S3Control
+    module Plugins
+      # This plugin is an implementation detail and may be modified.
+      # @api private
+      class S3Signer < Seahorse::Client::Plugin
+
+        option(:sigv4_signer) do |cfg|
+          S3Signer.build_v4_signer(
+            region: cfg.sigv4_region,
+            credentials: cfg.credentials
+          )
+        end
+
+        option(:sigv4_region) do |cfg|
+          Aws::Partitions::EndpointProvider.signing_region(cfg.region, 's3')
+        end
+
+        def add_handlers(handlers, cfg)
+          handlers.add(V4Handler, step: :sign)
+        end
+
+        class V4Handler < Seahorse::Client::Handler
+
+          def call(context)
+            Aws::Plugins::SignatureV4.apply_signature(
+              context: context,
+              signer: sigv4_signer(context)
+            )
+            @handler.call(context)
+          end
+
+          private
+
+          def sigv4_signer(context)
+            # If the client was configured with the wrong region,
+            # we have to build a new signer.
+            if
+              context[:cached_sigv4_region] &&
+                context[:cached_sigv4_region] != context.config.sigv4_signer.region
+              then
+              S3Signer.build_v4_signer(
+                region: context[:cached_sigv4_region],
+                credentials: context.config.credentials
+              )
+            else
+              context.config.sigv4_signer
+            end
+          end
+        end
+
+        class << self
+
+          # @option options [required, String] :region
+          # @option options [required, #credentials] :credentials
+          # @api private
+          def build_v4_signer(options = {})
+            Aws::Sigv4::Signer.new({
+              service: 's3',
+              region: options[:region],
+              credentials_provider: options[:credentials],
+              uri_escape_path: false,
+              unsigned_headers: ['content-length', 'x-amzn-trace-id'],
+            })
+          end
+
+          def new_hostname(context, region)
+            bucket = context.params[:bucket]
+            if region == 'us-east-1'
+              "#{bucket}.s3.amazonaws.com"
+            else
+              endpoint = Aws::Partitions::EndpointProvider.resolve(region, 's3')
+              bucket + '.' + URI.parse(endpoint).host
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::S3Control
+  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

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

@@ -0,0 +1,205 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::S3Control
+  module Types
+
+    # @note When making an API call, you may pass DeletePublicAccessBlockRequest
+    #   data as a hash:
+    #
+    #       {
+    #         account_id: "AccountId", # required
+    #       }
+    #
+    # @!attribute [rw] account_id
+    #   The Account ID for the Amazon Web Services account whose Public
+    #   Access Block configuration you want to remove.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/DeletePublicAccessBlockRequest AWS API Documentation
+    #
+    class DeletePublicAccessBlockRequest < Struct.new(
+      :account_id)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] public_access_block_configuration
+    #   The Public Access Block configuration currently in effect for this
+    #   Amazon Web Services account.
+    #   @return [Types::PublicAccessBlockConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlockOutput AWS API Documentation
+    #
+    class GetPublicAccessBlockOutput < Struct.new(
+      :public_access_block_configuration)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass GetPublicAccessBlockRequest
+    #   data as a hash:
+    #
+    #       {
+    #         account_id: "AccountId", # required
+    #       }
+    #
+    # @!attribute [rw] account_id
+    #   The Account ID for the Amazon Web Services account whose Public
+    #   Access Block configuration you want to retrieve.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/GetPublicAccessBlockRequest AWS API Documentation
+    #
+    class GetPublicAccessBlockRequest < Struct.new(
+      :account_id)
+      include Aws::Structure
+    end
+
+    # The container element for all Public Access Block configuration
+    # options. You can enable the configuration options in any combination.
+    #
+    # Amazon S3 considers a bucket policy public unless at least one of the
+    # following conditions is true:
+    #
+    # 1.  The policy limits access to a set of CIDRs using `aws:SourceIp`.
+    #     For more information on CIDR, see
+    #     [http://www.rfc-editor.org/rfc/rfc4632.txt][1]
+    #
+    # 2.  The policy grants permissions, not including any "bad actions,"
+    #     to one of the following:
+    #
+    #     * A fixed AWS principal, user, role, or service principal
+    #
+    #     * A fixed `aws:SourceArn`
+    #
+    #     * A fixed `aws:SourceVpc`
+    #
+    #     * A fixed `aws:SourceVpce`
+    #
+    #     * A fixed `aws:SourceOwner`
+    #
+    #     * A fixed `aws:SourceAccount`
+    #
+    #     * A fixed value of
+    #       `s3:x-amz-server-side-encryption-aws-kms-key-id`
+    #
+    #     * A fixed value of `aws:userid` outside the pattern
+    #       "`AROLEID:*`"
+    #
+    # "Bad actions" are those that could expose the data inside a bucket
+    # to reads or writes by the public. These actions are `s3:Get*`,
+    # `s3:List*`, `s3:AbortMultipartUpload`, `s3:Delete*`, `s3:Put*`, and
+    # `s3:RestoreObject`.
+    #
+    # The star notation for bad actions indicates that all matching
+    # operations are considered bad actions. For example, because `s3:Get*`
+    # is a bad action, `s3:GetObject`, `s3:GetObjectVersion`, and
+    # `s3:GetObjectAcl` are all bad actions.
+    #
+    #
+    #
+    # [1]: http://www.rfc-editor.org/rfc/rfc4632.txt
+    #
+    # @note When making an API call, you may pass PublicAccessBlockConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         block_public_acls: false,
+    #         ignore_public_acls: false,
+    #         block_public_policy: false,
+    #         restrict_public_buckets: false,
+    #       }
+    #
+    # @!attribute [rw] block_public_acls
+    #   Specifies whether Amazon S3 should block public ACLs for buckets in
+    #   this account. Setting this element to `TRUE` causes the following
+    #   behavior:
+    #
+    #   * PUT Bucket acl and PUT Object acl calls will fail if the specified
+    #     ACL allows public access.
+    #
+    #   * PUT Object calls will fail if the request includes an object ACL.
+    #
+    #   Note that enabling this setting doesn't affect existing policies or
+    #   ACLs.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] ignore_public_acls
+    #   Specifies whether Amazon S3 should ignore public ACLs for buckets in
+    #   this account. Setting this element to `TRUE` causes Amazon S3 to
+    #   ignore all public ACLs on buckets in this account and any objects
+    #   that they contain.
+    #
+    #   Note that enabling this setting doesn't affect the persistence of
+    #   any existing ACLs and doesn't prevent new public ACLs from being
+    #   set.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] block_public_policy
+    #   Specifies whether Amazon S3 should block public bucket policies for
+    #   buckets in this account. Setting this element to `TRUE` causes
+    #   Amazon S3 to reject calls to PUT Bucket policy if the specified
+    #   bucket policy allows public access.
+    #
+    #   Note that enabling this setting doesn't affect existing bucket
+    #   policies.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] restrict_public_buckets
+    #   Specifies whether Amazon S3 should restrict public bucket policies
+    #   for buckets in this account. If this element is set to `TRUE`, then
+    #   only the bucket owner and AWS Services can access buckets with
+    #   public policies.
+    #
+    #   Note that enabling this setting doesn't affect previously stored
+    #   bucket policies, except that public and cross-account access within
+    #   any public bucket policy, including non-public delegation to
+    #   specific accounts, is blocked.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PublicAccessBlockConfiguration AWS API Documentation
+    #
+    class PublicAccessBlockConfiguration < Struct.new(
+      :block_public_acls,
+      :ignore_public_acls,
+      :block_public_policy,
+      :restrict_public_buckets)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass PutPublicAccessBlockRequest
+    #   data as a hash:
+    #
+    #       {
+    #         public_access_block_configuration: { # required
+    #           block_public_acls: false,
+    #           ignore_public_acls: false,
+    #           block_public_policy: false,
+    #           restrict_public_buckets: false,
+    #         },
+    #         account_id: "AccountId", # required
+    #       }
+    #
+    # @!attribute [rw] public_access_block_configuration
+    #   The Public Access Block configuration that you want to apply to this
+    #   Amazon Web Services account.
+    #   @return [Types::PublicAccessBlockConfiguration]
+    #
+    # @!attribute [rw] account_id
+    #   The Account ID for the Amazon Web Services account whose Public
+    #   Access Block configuration you want to set.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/PutPublicAccessBlockRequest AWS API Documentation
+    #
+    class PutPublicAccessBlockRequest < Struct.new(
+      :public_access_block_configuration,
+      :account_id)
+      include Aws::Structure
+    end
+
+  end
+end

data/lib/aws-sdk-s3control.rb

@@ -0,0 +1,47 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sigv4'
+require 'aws-sdk-core'
+
+require_relative 'aws-sdk-s3control/types'
+require_relative 'aws-sdk-s3control/client_api'
+require_relative 'aws-sdk-s3control/client'
+require_relative 'aws-sdk-s3control/errors'
+require_relative 'aws-sdk-s3control/resource'
+require_relative 'aws-sdk-s3control/customizations'
+
+# This module provides support for AWS S3 Control. This module is available in the
+# `aws-sdk-s3control` 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.
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS S3 Control all
+# extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::S3Control::Errors::ServiceError
+#       # rescues all service API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @service
+module Aws::S3Control
+
+  GEM_VERSION = '1.0.0'
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: aws-sdk-s3control
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.26.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.26.0
+description: Official AWS Ruby gem for AWS S3 Control. This gem is part of the AWS
+  SDK for Ruby.
+email:
+- trevrowe@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/aws-sdk-s3control.rb
+- lib/aws-sdk-s3control/client.rb
+- lib/aws-sdk-s3control/client_api.rb
+- lib/aws-sdk-s3control/customizations.rb
+- lib/aws-sdk-s3control/errors.rb
+- lib/aws-sdk-s3control/plugins/dualstack.rb
+- lib/aws-sdk-s3control/plugins/s3_control_dns.rb
+- lib/aws-sdk-s3control/plugins/s3_host_id.rb
+- lib/aws-sdk-s3control/plugins/s3_signer.rb
+- lib/aws-sdk-s3control/resource.rb
+- lib/aws-sdk-s3control/types.rb
+homepage: http://github.com/aws/aws-sdk-ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-s3control
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-s3control/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: AWS SDK for Ruby - AWS S3 Control
+test_files: []