aws-sdk-shield 1.0.0.rc2 → 1.0.0.rc3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 69a73cbb3b900a10c58ef45ad40040dd276d2fb8
4
- data.tar.gz: 368ab934dc62f7d0cb88b9be6fdb436bc8b4220d
3
+ metadata.gz: 1f45eb1b18b884967139c79ed70bf7c298bf6643
4
+ data.tar.gz: 0352576ab47849cf3126d5afb2285ebf083a491b
5
5
  SHA512:
6
- metadata.gz: e701a903aa19a13f1067e6be85d0f5189e7a07252c524f256604a5909d65039047972bc61165cdf5463817e841811ee49fe9cd7070eb277f150cf286c26d5af3
7
- data.tar.gz: 0dfe6958f201ab84cadd63fc0eb44fa4bf474dc10c35623991456bb00e018a729b1042f27c971c1a962ef5168444b623d680153e89269b4a2ae86049295debdf
6
+ metadata.gz: 9b28f97f0f14e11f5102aed06924bbee2a81205c76b446c6e634c5e6436220eb2d086cba15c905e5ee53702d595a7e92151dbff33fedc2ec7ef1713f3abc3294
7
+ data.tar.gz: 95ba04ff41a9a1811cb3259cf3b4590e0902c5e29a773e48fbf09e42f4ba6024a6f38472474983470a5a5289958f36cc84a343fc07faa37135d18a96a589d341
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-shield/customizations'
42
42
  # @service
43
43
  module Aws::Shield
44
44
 
45
- GEM_VERSION = '1.0.0.rc2'
45
+ GEM_VERSION = '1.0.0.rc3'
46
46
 
47
47
  end
@@ -1,6 +1,6 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
@@ -18,405 +18,471 @@ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
18
  require 'aws-sdk-core/plugins/response_paging.rb'
19
19
  require 'aws-sdk-core/plugins/stub_responses.rb'
20
20
  require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
21
22
  require 'aws-sdk-core/plugins/signature_v4.rb'
22
23
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
23
24
 
24
25
  Aws::Plugins::GlobalConfiguration.add_identifier(:shield)
25
26
 
26
- module Aws
27
- module Shield
28
- class Client < Seahorse::Client::Base
27
+ module Aws::Shield
28
+ class Client < Seahorse::Client::Base
29
29
 
30
- include Aws::ClientStubs
30
+ include Aws::ClientStubs
31
31
 
32
- @identifier = :shield
32
+ @identifier = :shield
33
33
 
34
- set_api(ClientApi::API)
34
+ set_api(ClientApi::API)
35
35
 
36
- add_plugin(Seahorse::Client::Plugins::ContentLength)
37
- add_plugin(Aws::Plugins::CredentialsConfiguration)
38
- add_plugin(Aws::Plugins::Logging)
39
- add_plugin(Aws::Plugins::ParamConverter)
40
- add_plugin(Aws::Plugins::ParamValidator)
41
- add_plugin(Aws::Plugins::UserAgent)
42
- add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
- add_plugin(Aws::Plugins::RetryErrors)
44
- add_plugin(Aws::Plugins::GlobalConfiguration)
45
- add_plugin(Aws::Plugins::RegionalEndpoint)
46
- add_plugin(Aws::Plugins::ResponsePaging)
47
- add_plugin(Aws::Plugins::StubResponses)
48
- add_plugin(Aws::Plugins::IdempotencyToken)
49
- add_plugin(Aws::Plugins::SignatureV4)
50
- add_plugin(Aws::Plugins::Protocols::JsonRpc)
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
51
52
 
52
- # @option options [required, Aws::CredentialProvider] :credentials
53
- # Your AWS credentials. This can be an instance of any one of the
54
- # following classes:
55
- #
56
- # * `Aws::Credentials` - Used for configuring static, non-refreshing
57
- # credentials.
58
- #
59
- # * `Aws::InstanceProfileCredentials` - Used for loading credentials
60
- # from an EC2 IMDS on an EC2 instance.
61
- #
62
- # * `Aws::SharedCredentials` - Used for loading credentials from a
63
- # shared file, such as `~/.aws/config`.
64
- #
65
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
66
- #
67
- # When `:credentials` are not configured directly, the following
68
- # locations will be searched for credentials:
69
- #
70
- # * `Aws.config[:credentials]`
71
- # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
72
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
73
- # * `~/.aws/credentials`
74
- # * `~/.aws/config`
75
- # * EC2 IMDS instance profile - When used by default, the timeouts are
76
- # very aggressive. Construct and pass an instance of
77
- # `Aws::InstanceProfileCredentails` to enable retries and extended
78
- # timeouts.
79
- # @option options [required, String] :region
80
- # The AWS region to connect to. The configured `:region` is
81
- # used to determine the service `:endpoint`. When not passed,
82
- # a default `:region` is search for in the following locations:
83
- #
84
- # * `Aws.config[:region]`
85
- # * `ENV['AWS_REGION']`
86
- # * `ENV['AMAZON_REGION']`
87
- # * `ENV['AWS_DEFAULT_REGION']`
88
- # * `~/.aws/credentials`
89
- # * `~/.aws/config`
90
- # @option options [String] :access_key_id
91
- # @option options [Boolean] :convert_params (true)
92
- # When `true`, an attempt is made to coerce request parameters into
93
- # the required types.
94
- # @option options [String] :endpoint
95
- # The client endpoint is normally constructed from the `:region`
96
- # option. You should only configure an `:endpoint` when connecting
97
- # to test endpoints. This should be avalid HTTP(S) URI.
98
- # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
99
- # The log formatter.
100
- # @option options [Symbol] :log_level (:info)
101
- # The log level to send messages to the `:logger` at.
102
- # @option options [Logger] :logger
103
- # The Logger instance to send log messages to. If this option
104
- # is not set, logging will be disabled.
105
- # @option options [String] :profile ("default")
106
- # Used when loading credentials from the shared credentials file
107
- # at HOME/.aws/credentials. When not specified, 'default' is used.
108
- # @option options [Integer] :retry_limit (3)
109
- # The maximum number of times to retry failed requests. Only
110
- # ~ 500 level server errors and certain ~ 400 level client errors
111
- # are retried. Generally, these are throttling errors, data
112
- # checksum errors, networking errors, timeout errors and auth
113
- # errors from expired credentials.
114
- # @option options [String] :secret_access_key
115
- # @option options [String] :session_token
116
- # @option options [Boolean] :simple_json (false)
117
- # Disables request parameter conversion, validation, and formatting.
118
- # Also disable response data type conversions. This option is useful
119
- # when you want to ensure the highest level of performance by
120
- # avoiding overhead of walking request parameters and response data
121
- # structures.
122
- #
123
- # When `:simple_json` is enabled, the request parameters hash must
124
- # be formatted exactly as the DynamoDB API expects.
125
- # @option options [Boolean] :stub_responses (false)
126
- # Causes the client to return stubbed responses. By default
127
- # fake responses are generated and returned. You can specify
128
- # the response data to return or errors to raise by calling
129
- # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
130
- #
131
- # ** Please note ** When response stubbing is enabled, no HTTP
132
- # requests are made, and retries are disabled.
133
- # @option options [Boolean] :validate_params (true)
134
- # When `true`, request parameters are validated before
135
- # sending the request.
136
- def initialize(*args)
137
- super
138
- end
139
-
140
- # @!group API Operations
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :simple_json (false)
130
+ # Disables request parameter conversion, validation, and formatting.
131
+ # Also disable response data type conversions. This option is useful
132
+ # when you want to ensure the highest level of performance by
133
+ # avoiding overhead of walking request parameters and response data
134
+ # structures.
135
+ #
136
+ # When `:simple_json` is enabled, the request parameters hash must
137
+ # be formatted exactly as the DynamoDB API expects.
138
+ #
139
+ # @option options [Boolean] :stub_responses (false)
140
+ # Causes the client to return stubbed responses. By default
141
+ # fake responses are generated and returned. You can specify
142
+ # the response data to return or errors to raise by calling
143
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
144
+ #
145
+ # ** Please note ** When response stubbing is enabled, no HTTP
146
+ # requests are made, and retries are disabled.
147
+ #
148
+ # @option options [Boolean] :validate_params (true)
149
+ # When `true`, request parameters are validated before
150
+ # sending the request.
151
+ #
152
+ def initialize(*args)
153
+ super
154
+ end
141
155
 
142
- # Enables AWS Shield Advanced for a specific AWS resource. The resource
143
- # can be an Amazon CloudFront distribution, Elastic Load Balancing load
144
- # balancer, or an Amazon Route 53 hosted zone.
145
- # @option params [required, String] :name
146
- # Friendly name for the `Protection` you are creating.
147
- # @option params [required, String] :resource_arn
148
- # The ARN (Amazon Resource Name) of the resource to be protected.
149
- # @return [Types::CreateProtectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
150
- #
151
- # * {Types::CreateProtectionResponse#protection_id #ProtectionId} => String
152
- #
153
- # @example Request syntax with placeholder values
154
- # resp = client.create_protection({
155
- # name: "ProtectionName", # required
156
- # resource_arn: "ResourceArn", # required
157
- # })
158
- #
159
- # @example Response structure
160
- # resp.protection_id #=> String
161
- # @overload create_protection(params = {})
162
- # @param [Hash] params ({})
163
- def create_protection(params = {}, options = {})
164
- req = build_request(:create_protection, params)
165
- req.send_request(options)
166
- end
156
+ # @!group API Operations
167
157
 
168
- # Activates AWS Shield Advanced for an account.
169
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
170
- #
171
- # @example Request syntax with placeholder values
172
- # resp = client.create_subscription()
173
- # @overload create_subscription(params = {})
174
- # @param [Hash] params ({})
175
- def create_subscription(params = {}, options = {})
176
- req = build_request(:create_subscription, params)
177
- req.send_request(options)
178
- end
158
+ # Enables AWS Shield Advanced for a specific AWS resource. The resource
159
+ # can be an Amazon CloudFront distribution, Elastic Load Balancing load
160
+ # balancer, or an Amazon Route 53 hosted zone.
161
+ #
162
+ # @option params [required, String] :name
163
+ # Friendly name for the `Protection` you are creating.
164
+ #
165
+ # @option params [required, String] :resource_arn
166
+ # The ARN (Amazon Resource Name) of the resource to be protected.
167
+ #
168
+ # @return [Types::CreateProtectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
169
+ #
170
+ # * {Types::CreateProtectionResponse#protection_id #protection_id} => String
171
+ #
172
+ # @example Request syntax with placeholder values
173
+ #
174
+ # resp = client.create_protection({
175
+ # name: "ProtectionName", # required
176
+ # resource_arn: "ResourceArn", # required
177
+ # })
178
+ #
179
+ # @example Response structure
180
+ #
181
+ # resp.protection_id #=> String
182
+ #
183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtection AWS API Documentation
184
+ #
185
+ # @overload create_protection(params = {})
186
+ # @param [Hash] params ({})
187
+ def create_protection(params = {}, options = {})
188
+ req = build_request(:create_protection, params)
189
+ req.send_request(options)
190
+ end
179
191
 
180
- # Deletes an AWS Shield Advanced Protection.
181
- # @option params [required, String] :protection_id
182
- # The unique identifier (ID) for the Protection object to be deleted.
183
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
184
- #
185
- # @example Request syntax with placeholder values
186
- # resp = client.delete_protection({
187
- # protection_id: "ProtectionId", # required
188
- # })
189
- # @overload delete_protection(params = {})
190
- # @param [Hash] params ({})
191
- def delete_protection(params = {}, options = {})
192
- req = build_request(:delete_protection, params)
193
- req.send_request(options)
194
- end
192
+ # Activates AWS Shield Advanced for an account.
193
+ #
194
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
195
+ #
196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateSubscription AWS API Documentation
197
+ #
198
+ # @overload create_subscription(params = {})
199
+ # @param [Hash] params ({})
200
+ def create_subscription(params = {}, options = {})
201
+ req = build_request(:create_subscription, params)
202
+ req.send_request(options)
203
+ end
195
204
 
196
- # Removes AWS Shield Advanced from an account.
197
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
198
- #
199
- # @example Request syntax with placeholder values
200
- # resp = client.delete_subscription()
201
- # @overload delete_subscription(params = {})
202
- # @param [Hash] params ({})
203
- def delete_subscription(params = {}, options = {})
204
- req = build_request(:delete_subscription, params)
205
- req.send_request(options)
206
- end
205
+ # Deletes an AWS Shield Advanced Protection.
206
+ #
207
+ # @option params [required, String] :protection_id
208
+ # The unique identifier (ID) for the Protection object to be deleted.
209
+ #
210
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
211
+ #
212
+ # @example Request syntax with placeholder values
213
+ #
214
+ # resp = client.delete_protection({
215
+ # protection_id: "ProtectionId", # required
216
+ # })
217
+ #
218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtection AWS API Documentation
219
+ #
220
+ # @overload delete_protection(params = {})
221
+ # @param [Hash] params ({})
222
+ def delete_protection(params = {}, options = {})
223
+ req = build_request(:delete_protection, params)
224
+ req.send_request(options)
225
+ end
207
226
 
208
- # Describes the details of a DDoS attack.
209
- # @option params [required, String] :attack_id
210
- # The unique identifier (ID) for the attack that to be described.
211
- # @return [Types::DescribeAttackResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
212
- #
213
- # * {Types::DescribeAttackResponse#attack #Attack} => Types::AttackDetail
214
- #
215
- # @example Request syntax with placeholder values
216
- # resp = client.describe_attack({
217
- # attack_id: "AttackId", # required
218
- # })
219
- #
220
- # @example Response structure
221
- # resp.attack.attack_id #=> String
222
- # resp.attack.resource_arn #=> String
223
- # resp.attack.sub_resources #=> Array
224
- # resp.attack.sub_resources[0].type #=> String, one of "IP", "URL"
225
- # resp.attack.sub_resources[0].id #=> String
226
- # resp.attack.sub_resources[0].attack_vectors #=> Array
227
- # resp.attack.sub_resources[0].attack_vectors[0].vector_type #=> String
228
- # resp.attack.sub_resources[0].attack_vectors[0].vector_counters #=> Array
229
- # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].name #=> String
230
- # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].max #=> Float
231
- # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].average #=> Float
232
- # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].sum #=> Float
233
- # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].n #=> Integer
234
- # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].unit #=> String
235
- # resp.attack.sub_resources[0].counters #=> Array
236
- # resp.attack.sub_resources[0].counters[0].name #=> String
237
- # resp.attack.sub_resources[0].counters[0].max #=> Float
238
- # resp.attack.sub_resources[0].counters[0].average #=> Float
239
- # resp.attack.sub_resources[0].counters[0].sum #=> Float
240
- # resp.attack.sub_resources[0].counters[0].n #=> Integer
241
- # resp.attack.sub_resources[0].counters[0].unit #=> String
242
- # resp.attack.start_time #=> Time
243
- # resp.attack.end_time #=> Time
244
- # resp.attack.attack_counters #=> Array
245
- # resp.attack.attack_counters[0].name #=> String
246
- # resp.attack.attack_counters[0].max #=> Float
247
- # resp.attack.attack_counters[0].average #=> Float
248
- # resp.attack.attack_counters[0].sum #=> Float
249
- # resp.attack.attack_counters[0].n #=> Integer
250
- # resp.attack.attack_counters[0].unit #=> String
251
- # resp.attack.mitigations #=> Array
252
- # resp.attack.mitigations[0].mitigation_name #=> String
253
- # @overload describe_attack(params = {})
254
- # @param [Hash] params ({})
255
- def describe_attack(params = {}, options = {})
256
- req = build_request(:describe_attack, params)
257
- req.send_request(options)
258
- end
227
+ # Removes AWS Shield Advanced from an account.
228
+ #
229
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
230
+ #
231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteSubscription AWS API Documentation
232
+ #
233
+ # @overload delete_subscription(params = {})
234
+ # @param [Hash] params ({})
235
+ def delete_subscription(params = {}, options = {})
236
+ req = build_request(:delete_subscription, params)
237
+ req.send_request(options)
238
+ end
259
239
 
260
- # Lists the details of a Protection object.
261
- # @option params [required, String] :protection_id
262
- # The unique identifier (ID) for the Protection object that is
263
- # described.
264
- # @return [Types::DescribeProtectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
265
- #
266
- # * {Types::DescribeProtectionResponse#protection #Protection} => Types::Protection
267
- #
268
- # @example Request syntax with placeholder values
269
- # resp = client.describe_protection({
270
- # protection_id: "ProtectionId", # required
271
- # })
272
- #
273
- # @example Response structure
274
- # resp.protection.id #=> String
275
- # resp.protection.name #=> String
276
- # resp.protection.resource_arn #=> String
277
- # @overload describe_protection(params = {})
278
- # @param [Hash] params ({})
279
- def describe_protection(params = {}, options = {})
280
- req = build_request(:describe_protection, params)
281
- req.send_request(options)
282
- end
240
+ # Describes the details of a DDoS attack.
241
+ #
242
+ # @option params [required, String] :attack_id
243
+ # The unique identifier (ID) for the attack that to be described.
244
+ #
245
+ # @return [Types::DescribeAttackResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
246
+ #
247
+ # * {Types::DescribeAttackResponse#attack #attack} => Types::AttackDetail
248
+ #
249
+ # @example Request syntax with placeholder values
250
+ #
251
+ # resp = client.describe_attack({
252
+ # attack_id: "AttackId", # required
253
+ # })
254
+ #
255
+ # @example Response structure
256
+ #
257
+ # resp.attack.attack_id #=> String
258
+ # resp.attack.resource_arn #=> String
259
+ # resp.attack.sub_resources #=> Array
260
+ # resp.attack.sub_resources[0].type #=> String, one of "IP", "URL"
261
+ # resp.attack.sub_resources[0].id #=> String
262
+ # resp.attack.sub_resources[0].attack_vectors #=> Array
263
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_type #=> String
264
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_counters #=> Array
265
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].name #=> String
266
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].max #=> Float
267
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].average #=> Float
268
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].sum #=> Float
269
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].n #=> Integer
270
+ # resp.attack.sub_resources[0].attack_vectors[0].vector_counters[0].unit #=> String
271
+ # resp.attack.sub_resources[0].counters #=> Array
272
+ # resp.attack.sub_resources[0].counters[0].name #=> String
273
+ # resp.attack.sub_resources[0].counters[0].max #=> Float
274
+ # resp.attack.sub_resources[0].counters[0].average #=> Float
275
+ # resp.attack.sub_resources[0].counters[0].sum #=> Float
276
+ # resp.attack.sub_resources[0].counters[0].n #=> Integer
277
+ # resp.attack.sub_resources[0].counters[0].unit #=> String
278
+ # resp.attack.start_time #=> Time
279
+ # resp.attack.end_time #=> Time
280
+ # resp.attack.attack_counters #=> Array
281
+ # resp.attack.attack_counters[0].name #=> String
282
+ # resp.attack.attack_counters[0].max #=> Float
283
+ # resp.attack.attack_counters[0].average #=> Float
284
+ # resp.attack.attack_counters[0].sum #=> Float
285
+ # resp.attack.attack_counters[0].n #=> Integer
286
+ # resp.attack.attack_counters[0].unit #=> String
287
+ # resp.attack.mitigations #=> Array
288
+ # resp.attack.mitigations[0].mitigation_name #=> String
289
+ #
290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttack AWS API Documentation
291
+ #
292
+ # @overload describe_attack(params = {})
293
+ # @param [Hash] params ({})
294
+ def describe_attack(params = {}, options = {})
295
+ req = build_request(:describe_attack, params)
296
+ req.send_request(options)
297
+ end
283
298
 
284
- # Provides details about the AWS Shield Advanced subscription for an
285
- # account.
286
- # @return [Types::DescribeSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
287
- #
288
- # * {Types::DescribeSubscriptionResponse#subscription #Subscription} => Types::Subscription
289
- #
290
- # @example Request syntax with placeholder values
291
- # resp = client.describe_subscription()
292
- #
293
- # @example Response structure
294
- # resp.subscription.start_time #=> Time
295
- # resp.subscription.time_commitment_in_seconds #=> Integer
296
- # @overload describe_subscription(params = {})
297
- # @param [Hash] params ({})
298
- def describe_subscription(params = {}, options = {})
299
- req = build_request(:describe_subscription, params)
300
- req.send_request(options)
301
- end
299
+ # Lists the details of a Protection object.
300
+ #
301
+ # @option params [required, String] :protection_id
302
+ # The unique identifier (ID) for the Protection object that is
303
+ # described.
304
+ #
305
+ # @return [Types::DescribeProtectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
306
+ #
307
+ # * {Types::DescribeProtectionResponse#protection #protection} => Types::Protection
308
+ #
309
+ # @example Request syntax with placeholder values
310
+ #
311
+ # resp = client.describe_protection({
312
+ # protection_id: "ProtectionId", # required
313
+ # })
314
+ #
315
+ # @example Response structure
316
+ #
317
+ # resp.protection.id #=> String
318
+ # resp.protection.name #=> String
319
+ # resp.protection.resource_arn #=> String
320
+ #
321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtection AWS API Documentation
322
+ #
323
+ # @overload describe_protection(params = {})
324
+ # @param [Hash] params ({})
325
+ def describe_protection(params = {}, options = {})
326
+ req = build_request(:describe_protection, params)
327
+ req.send_request(options)
328
+ end
302
329
 
303
- # Returns all ongoing DDoS attacks or all DDoS attacks during a
304
- # specified time period.
305
- # @option params [Array<String>] :resource_arns
306
- # The ARN (Amazon Resource Name) of the resource that was attacked. If
307
- # this is left blank, all applicable resources for this account will be
308
- # included.
309
- # @option params [Types::TimeRange] :start_time
310
- # The time period for the attacks.
311
- # @option params [Types::TimeRange] :end_time
312
- # The end of the time period for the attacks.
313
- # @option params [String] :next_token
314
- # The `ListAttacksRequest.NextMarker` value from a previous call to
315
- # `ListAttacksRequest`. Pass null if this is the first call.
316
- # @option params [Integer] :max_results
317
- # The maximum number of AttackSummary objects to be returned. If this is
318
- # left blank, the first 20 results will be returned.
319
- # @return [Types::ListAttacksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
320
- #
321
- # * {Types::ListAttacksResponse#attack_summaries #AttackSummaries} => Array&lt;Types::AttackSummary&gt;
322
- # * {Types::ListAttacksResponse#next_token #NextToken} => String
323
- #
324
- # @example Request syntax with placeholder values
325
- # resp = client.list_attacks({
326
- # resource_arns: ["ResourceArn"],
327
- # start_time: {
328
- # from_inclusive: Time.now,
329
- # to_exclusive: Time.now,
330
- # },
331
- # end_time: {
332
- # from_inclusive: Time.now,
333
- # to_exclusive: Time.now,
334
- # },
335
- # next_token: "Token",
336
- # max_results: 1,
337
- # })
338
- #
339
- # @example Response structure
340
- # resp.attack_summaries #=> Array
341
- # resp.attack_summaries[0].attack_id #=> String
342
- # resp.attack_summaries[0].resource_arn #=> String
343
- # resp.attack_summaries[0].start_time #=> Time
344
- # resp.attack_summaries[0].end_time #=> Time
345
- # resp.attack_summaries[0].attack_vectors #=> Array
346
- # resp.attack_summaries[0].attack_vectors[0].vector_type #=> String
347
- # resp.next_token #=> String
348
- # @overload list_attacks(params = {})
349
- # @param [Hash] params ({})
350
- def list_attacks(params = {}, options = {})
351
- req = build_request(:list_attacks, params)
352
- req.send_request(options)
353
- end
330
+ # Provides details about the AWS Shield Advanced subscription for an
331
+ # account.
332
+ #
333
+ # @return [Types::DescribeSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
334
+ #
335
+ # * {Types::DescribeSubscriptionResponse#subscription #subscription} => Types::Subscription
336
+ #
337
+ # @example Response structure
338
+ #
339
+ # resp.subscription.start_time #=> Time
340
+ # resp.subscription.time_commitment_in_seconds #=> Integer
341
+ #
342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeSubscription AWS API Documentation
343
+ #
344
+ # @overload describe_subscription(params = {})
345
+ # @param [Hash] params ({})
346
+ def describe_subscription(params = {}, options = {})
347
+ req = build_request(:describe_subscription, params)
348
+ req.send_request(options)
349
+ end
354
350
 
355
- # Lists all Protection objects for the account.
356
- # @option params [String] :next_token
357
- # The `ListProtectionsRequest.NextToken` value from a previous call to
358
- # `ListProtections`. Pass null if this is the first call.
359
- # @option params [Integer] :max_results
360
- # The maximum number of Protection objects to be returned. If this is
361
- # left blank the first 20 results will be returned.
362
- # @return [Types::ListProtectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
363
- #
364
- # * {Types::ListProtectionsResponse#protections #Protections} => Array&lt;Types::Protection&gt;
365
- # * {Types::ListProtectionsResponse#next_token #NextToken} => String
366
- #
367
- # @example Request syntax with placeholder values
368
- # resp = client.list_protections({
369
- # next_token: "Token",
370
- # max_results: 1,
371
- # })
372
- #
373
- # @example Response structure
374
- # resp.protections #=> Array
375
- # resp.protections[0].id #=> String
376
- # resp.protections[0].name #=> String
377
- # resp.protections[0].resource_arn #=> String
378
- # resp.next_token #=> String
379
- # @overload list_protections(params = {})
380
- # @param [Hash] params ({})
381
- def list_protections(params = {}, options = {})
382
- req = build_request(:list_protections, params)
383
- req.send_request(options)
384
- end
351
+ # Returns all ongoing DDoS attacks or all DDoS attacks during a
352
+ # specified time period.
353
+ #
354
+ # @option params [Array<String>] :resource_arns
355
+ # The ARN (Amazon Resource Name) of the resource that was attacked. If
356
+ # this is left blank, all applicable resources for this account will be
357
+ # included.
358
+ #
359
+ # @option params [Types::TimeRange] :start_time
360
+ # The time period for the attacks.
361
+ #
362
+ # @option params [Types::TimeRange] :end_time
363
+ # The end of the time period for the attacks.
364
+ #
365
+ # @option params [String] :next_token
366
+ # The `ListAttacksRequest.NextMarker` value from a previous call to
367
+ # `ListAttacksRequest`. Pass null if this is the first call.
368
+ #
369
+ # @option params [Integer] :max_results
370
+ # The maximum number of AttackSummary objects to be returned. If this is
371
+ # left blank, the first 20 results will be returned.
372
+ #
373
+ # @return [Types::ListAttacksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
374
+ #
375
+ # * {Types::ListAttacksResponse#attack_summaries #attack_summaries} => Array&lt;Types::AttackSummary&gt;
376
+ # * {Types::ListAttacksResponse#next_token #next_token} => String
377
+ #
378
+ # @example Request syntax with placeholder values
379
+ #
380
+ # resp = client.list_attacks({
381
+ # resource_arns: ["ResourceArn"],
382
+ # start_time: {
383
+ # from_inclusive: Time.now,
384
+ # to_exclusive: Time.now,
385
+ # },
386
+ # end_time: {
387
+ # from_inclusive: Time.now,
388
+ # to_exclusive: Time.now,
389
+ # },
390
+ # next_token: "Token",
391
+ # max_results: 1,
392
+ # })
393
+ #
394
+ # @example Response structure
395
+ #
396
+ # resp.attack_summaries #=> Array
397
+ # resp.attack_summaries[0].attack_id #=> String
398
+ # resp.attack_summaries[0].resource_arn #=> String
399
+ # resp.attack_summaries[0].start_time #=> Time
400
+ # resp.attack_summaries[0].end_time #=> Time
401
+ # resp.attack_summaries[0].attack_vectors #=> Array
402
+ # resp.attack_summaries[0].attack_vectors[0].vector_type #=> String
403
+ # resp.next_token #=> String
404
+ #
405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacks AWS API Documentation
406
+ #
407
+ # @overload list_attacks(params = {})
408
+ # @param [Hash] params ({})
409
+ def list_attacks(params = {}, options = {})
410
+ req = build_request(:list_attacks, params)
411
+ req.send_request(options)
412
+ end
385
413
 
386
- # @!endgroup
414
+ # Lists all Protection objects for the account.
415
+ #
416
+ # @option params [String] :next_token
417
+ # The `ListProtectionsRequest.NextToken` value from a previous call to
418
+ # `ListProtections`. Pass null if this is the first call.
419
+ #
420
+ # @option params [Integer] :max_results
421
+ # The maximum number of Protection objects to be returned. If this is
422
+ # left blank the first 20 results will be returned.
423
+ #
424
+ # @return [Types::ListProtectionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
425
+ #
426
+ # * {Types::ListProtectionsResponse#protections #protections} => Array&lt;Types::Protection&gt;
427
+ # * {Types::ListProtectionsResponse#next_token #next_token} => String
428
+ #
429
+ # @example Request syntax with placeholder values
430
+ #
431
+ # resp = client.list_protections({
432
+ # next_token: "Token",
433
+ # max_results: 1,
434
+ # })
435
+ #
436
+ # @example Response structure
437
+ #
438
+ # resp.protections #=> Array
439
+ # resp.protections[0].id #=> String
440
+ # resp.protections[0].name #=> String
441
+ # resp.protections[0].resource_arn #=> String
442
+ # resp.next_token #=> String
443
+ #
444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtections AWS API Documentation
445
+ #
446
+ # @overload list_protections(params = {})
447
+ # @param [Hash] params ({})
448
+ def list_protections(params = {}, options = {})
449
+ req = build_request(:list_protections, params)
450
+ req.send_request(options)
451
+ end
387
452
 
388
- # @param params ({})
389
- # @api private
390
- def build_request(operation_name, params = {})
391
- handlers = @handlers.for(operation_name)
392
- context = Seahorse::Client::RequestContext.new(
393
- operation_name: operation_name,
394
- operation: config.api.operation(operation_name),
395
- client: self,
396
- params: params,
397
- config: config)
398
- context[:gem_name] = 'aws-sdk-shield'
399
- context[:gem_version] = '1.0.0.rc2'
400
- Seahorse::Client::Request.new(handlers, context)
401
- end
453
+ # @!endgroup
402
454
 
403
- # @api private
404
- # @deprecated
405
- def waiter_names
406
- []
407
- end
455
+ # @param params ({})
456
+ # @api private
457
+ def build_request(operation_name, params = {})
458
+ handlers = @handlers.for(operation_name)
459
+ context = Seahorse::Client::RequestContext.new(
460
+ operation_name: operation_name,
461
+ operation: config.api.operation(operation_name),
462
+ client: self,
463
+ params: params,
464
+ config: config)
465
+ context[:gem_name] = 'aws-sdk-shield'
466
+ context[:gem_version] = '1.0.0.rc3'
467
+ Seahorse::Client::Request.new(handlers, context)
468
+ end
408
469
 
409
- class << self
470
+ # @api private
471
+ # @deprecated
472
+ def waiter_names
473
+ []
474
+ end
410
475
 
411
- # @api private
412
- attr_reader :identifier
476
+ class << self
413
477
 
414
- # @api private
415
- def errors_module
416
- Errors
417
- end
478
+ # @api private
479
+ attr_reader :identifier
418
480
 
481
+ # @api private
482
+ def errors_module
483
+ Errors
419
484
  end
485
+
420
486
  end
421
487
  end
422
488
  end