aws-sdk-shield 1.0.0.rc2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69a73cbb3b900a10c58ef45ad40040dd276d2fb8
+  data.tar.gz: 368ab934dc62f7d0cb88b9be6fdb436bc8b4220d
+SHA512:
+  metadata.gz: e701a903aa19a13f1067e6be85d0f5189e7a07252c524f256604a5909d65039047972bc61165cdf5463817e841811ee49fe9cd7070eb277f150cf286c26d5af3
+  data.tar.gz: 0dfe6958f201ab84cadd63fc0eb44fa4bf474dc10c35623991456bb00e018a729b1042f27c971c1a962ef5168444b623d680153e89269b4a2ae86049295debdf

data/lib/aws-sdk-shield.rb

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

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

@@ -0,0 +1,422 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# 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/response_paging.rb'
+require 'aws-sdk-core/plugins/stub_responses.rb'
+require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:shield)
+
+module Aws
+  module Shield
+    class Client < Seahorse::Client::Base
+
+      include Aws::ClientStubs
+
+      @identifier = :shield
+
+      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::ResponsePaging)
+      add_plugin(Aws::Plugins::StubResponses)
+      add_plugin(Aws::Plugins::IdempotencyToken)
+      add_plugin(Aws::Plugins::SignatureV4)
+      add_plugin(Aws::Plugins::Protocols::JsonRpc)
+
+      # @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] :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 [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 [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 [String] :secret_access_key
+      # @option options [String] :session_token
+      # @option options [Boolean] :simple_json (false)
+      #   Disables request parameter conversion, validation, and formatting.
+      #   Also disable response data type conversions. This option is useful
+      #   when you want to ensure the highest level of performance by
+      #   avoiding overhead of walking request parameters and response data
+      #   structures.
+      #
+      #   When `:simple_json` is enabled, the request parameters hash must
+      #   be formatted exactly as the DynamoDB API expects.
+      # @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] :validate_params (true)
+      #   When `true`, request parameters are validated before
+      #   sending the request.
+      def initialize(*args)
+        super
+      end
+
+      # @!group API Operations
+
+      # Enables AWS Shield Advanced for a specific AWS resource. The resource
+      # can be an Amazon CloudFront distribution, Elastic Load Balancing load
+      # balancer, or an Amazon Route 53 hosted zone.
+      # @option params [required, String] :name
+      #   Friendly name for the `Protection` you are creating.
+      # @option params [required, String] :resource_arn
+      #   The ARN (Amazon Resource Name) of the resource to be protected.
+      # @return [Types::CreateProtectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+      #
+      #   * {Types::CreateProtectionResponse#protection_id #ProtectionId} => String
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.create_protection({
+      #     name: "ProtectionName", # required
+      #     resource_arn: "ResourceArn", # required
+      #   })
+      #
+      # @example Response structure
+      #   resp.protection_id #=> String
+      # @overload create_protection(params = {})
+      # @param [Hash] params ({})
+      def create_protection(params = {}, options = {})
+        req = build_request(:create_protection, params)
+        req.send_request(options)
+      end
+
+      # Activates AWS Shield Advanced for an account.
+      # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.create_subscription()
+      # @overload create_subscription(params = {})
+      # @param [Hash] params ({})
+      def create_subscription(params = {}, options = {})
+        req = build_request(:create_subscription, params)
+        req.send_request(options)
+      end
+
+      # Deletes an AWS Shield Advanced Protection.
+      # @option params [required, String] :protection_id
+      #   The unique identifier (ID) for the Protection object to be deleted.
+      # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.delete_protection({
+      #     protection_id: "ProtectionId", # required
+      #   })
+      # @overload delete_protection(params = {})
+      # @param [Hash] params ({})
+      def delete_protection(params = {}, options = {})
+        req = build_request(:delete_protection, params)
+        req.send_request(options)
+      end
+
+      # Removes AWS Shield Advanced from an account.
+      # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.delete_subscription()
+      # @overload delete_subscription(params = {})
+      # @param [Hash] params ({})
+      def delete_subscription(params = {}, options = {})
+        req = build_request(:delete_subscription, params)
+        req.send_request(options)
+      end
+
+      # Describes the details of a DDoS attack.
+      # @option params [required, String] :attack_id
+      #   The unique identifier (ID) for the attack that to be described.
+      # @return [Types::DescribeAttackResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+      #
+      #   * {Types::DescribeAttackResponse#attack #Attack} => Types::AttackDetail
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.describe_attack({
+      #     attack_id: "AttackId", # required
+      #   })
+      #
+      # @example Response structure
+      #   resp.attack.attack_id #=> String
+      #   resp.attack.resource_arn #=> String
+      #   resp.attack.sub_resources #=> Array
+      #   resp.attack.sub_resources[0].type #=> String, one of "IP", "URL"
+      #   resp.attack.sub_resources[0].id #=> String
+      #   resp.attack.sub_resources[0].attack_vectors #=> Array
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_type #=> String
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_counters #=> Array
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].name #=> String
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].max #=> Float
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].average #=> Float
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].sum #=> Float
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].n #=> Integer
+      #   resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].unit #=> String
+      #   resp.attack.sub_resources[0].counters #=> Array
+      #   resp.attack.sub_resources[0].counters[0].name #=> String
+      #   resp.attack.sub_resources[0].counters[0].max #=> Float
+      #   resp.attack.sub_resources[0].counters[0].average #=> Float
+      #   resp.attack.sub_resources[0].counters[0].sum #=> Float
+      #   resp.attack.sub_resources[0].counters[0].n #=> Integer
+      #   resp.attack.sub_resources[0].counters[0].unit #=> String
+      #   resp.attack.start_time #=> Time
+      #   resp.attack.end_time #=> Time
+      #   resp.attack.attack_counters #=> Array
+      #   resp.attack.attack_counters[0].name #=> String
+      #   resp.attack.attack_counters[0].max #=> Float
+      #   resp.attack.attack_counters[0].average #=> Float
+      #   resp.attack.attack_counters[0].sum #=> Float
+      #   resp.attack.attack_counters[0].n #=> Integer
+      #   resp.attack.attack_counters[0].unit #=> String
+      #   resp.attack.mitigations #=> Array
+      #   resp.attack.mitigations[0].mitigation_name #=> String
+      # @overload describe_attack(params = {})
+      # @param [Hash] params ({})
+      def describe_attack(params = {}, options = {})
+        req = build_request(:describe_attack, params)
+        req.send_request(options)
+      end
+
+      # Lists the details of a Protection object.
+      # @option params [required, String] :protection_id
+      #   The unique identifier (ID) for the Protection object that is
+      #   described.
+      # @return [Types::DescribeProtectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+      #
+      #   * {Types::DescribeProtectionResponse#protection #Protection} => Types::Protection
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.describe_protection({
+      #     protection_id: "ProtectionId", # required
+      #   })
+      #
+      # @example Response structure
+      #   resp.protection.id #=> String
+      #   resp.protection.name #=> String
+      #   resp.protection.resource_arn #=> String
+      # @overload describe_protection(params = {})
+      # @param [Hash] params ({})
+      def describe_protection(params = {}, options = {})
+        req = build_request(:describe_protection, params)
+        req.send_request(options)
+      end
+
+      # Provides details about the AWS Shield Advanced subscription for an
+      # account.
+      # @return [Types::DescribeSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+      #
+      #   * {Types::DescribeSubscriptionResponse#subscription #Subscription} => Types::Subscription
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.describe_subscription()
+      #
+      # @example Response structure
+      #   resp.subscription.start_time #=> Time
+      #   resp.subscription.time_commitment_in_seconds #=> Integer
+      # @overload describe_subscription(params = {})
+      # @param [Hash] params ({})
+      def describe_subscription(params = {}, options = {})
+        req = build_request(:describe_subscription, params)
+        req.send_request(options)
+      end
+
+      # Returns all ongoing DDoS attacks or all DDoS attacks during a
+      # specified time period.
+      # @option params [Array<String>] :resource_arns
+      #   The ARN (Amazon Resource Name) of the resource that was attacked. If
+      #   this is left blank, all applicable resources for this account will be
+      #   included.
+      # @option params [Types::TimeRange] :start_time
+      #   The time period for the attacks.
+      # @option params [Types::TimeRange] :end_time
+      #   The end of the time period for the attacks.
+      # @option params [String] :next_token
+      #   The `ListAttacksRequest.NextMarker` value from a previous call to
+      #   `ListAttacksRequest`. Pass null if this is the first call.
+      # @option params [Integer] :max_results
+      #   The maximum number of AttackSummary objects to be returned. If this is
+      #   left blank, the first 20 results will be returned.
+      # @return [Types::ListAttacksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+      #
+      #   * {Types::ListAttacksResponse#attack_summaries #AttackSummaries} => Array&lt;Types::AttackSummary&gt;
+      #   * {Types::ListAttacksResponse#next_token #NextToken} => String
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.list_attacks({
+      #     resource_arns: ["ResourceArn"],
+      #     start_time: {
+      #       from_inclusive: Time.now,
+      #       to_exclusive: Time.now,
+      #     },
+      #     end_time: {
+      #       from_inclusive: Time.now,
+      #       to_exclusive: Time.now,
+      #     },
+      #     next_token: "Token",
+      #     max_results: 1,
+      #   })
+      #
+      # @example Response structure
+      #   resp.attack_summaries #=> Array
+      #   resp.attack_summaries[0].attack_id #=> String
+      #   resp.attack_summaries[0].resource_arn #=> String
+      #   resp.attack_summaries[0].start_time #=> Time
+      #   resp.attack_summaries[0].end_time #=> Time
+      #   resp.attack_summaries[0].attack_vectors #=> Array
+      #   resp.attack_summaries[0].attack_vectors[0].vector_type #=> String
+      #   resp.next_token #=> String
+      # @overload list_attacks(params = {})
+      # @param [Hash] params ({})
+      def list_attacks(params = {}, options = {})
+        req = build_request(:list_attacks, params)
+        req.send_request(options)
+      end
+
+      # Lists all Protection objects for the account.
+      # @option params [String] :next_token
+      #   The `ListProtectionsRequest.NextToken` value from a previous call to
+      #   `ListProtections`. Pass null if this is the first call.
+      # @option params [Integer] :max_results
+      #   The maximum number of Protection objects to be returned. If this is
+      #   left blank the first 20 results will be returned.
+      # @return [Types::ListProtectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+      #
+      #   * {Types::ListProtectionsResponse#protections #Protections} => Array&lt;Types::Protection&gt;
+      #   * {Types::ListProtectionsResponse#next_token #NextToken} => String
+      #
+      # @example Request syntax with placeholder values
+      #   resp = client.list_protections({
+      #     next_token: "Token",
+      #     max_results: 1,
+      #   })
+      #
+      # @example Response structure
+      #   resp.protections #=> Array
+      #   resp.protections[0].id #=> String
+      #   resp.protections[0].name #=> String
+      #   resp.protections[0].resource_arn #=> String
+      #   resp.next_token #=> String
+      # @overload list_protections(params = {})
+      # @param [Hash] params ({})
+      def list_protections(params = {}, options = {})
+        req = build_request(:list_protections, 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-shield'
+        context[:gem_version] = '1.0.0.rc2'
+        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
+end