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

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,23 +1,14 @@
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
7
7
 
8
- module Aws
9
- module Shield
10
- module Errors
8
+ module Aws::Shield
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
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
7
7
 
8
- module Aws
9
- module Shield
10
- class Resource
8
+ module Aws::Shield
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,448 +1,544 @@
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
7
7
 
8
- module Aws
9
- module Shield
10
- module Types
8
+ module Aws::Shield
9
+ module Types
11
10
 
12
- # The details of a DDoS attack.
13
- # @!attribute [rw] attack_id
14
- # The unique identifier (ID) of the attack.
15
- # @return [String]
16
- #
17
- # @!attribute [rw] resource_arn
18
- # The ARN (Amazon Resource Name) of the resource that was attacked.
19
- # @return [String]
20
- #
21
- # @!attribute [rw] sub_resources
22
- # If applicable, additional detail about the resource being attacked,
23
- # for example, IP address or URL.
24
- # @return [Array<Types::SubResourceSummary>]
25
- #
26
- # @!attribute [rw] start_time
27
- # The time the attack started, in the format 2016-12-16T13:50Z.
28
- # @return [Time]
29
- #
30
- # @!attribute [rw] end_time
31
- # The time the attack ended, in the format 2016-12-16T13:50Z.
32
- # @return [Time]
33
- #
34
- # @!attribute [rw] attack_counters
35
- # List of counters that describe the attack for the specified time
36
- # period.
37
- # @return [Array<Types::SummarizedCounter>]
38
- #
39
- # @!attribute [rw] mitigations
40
- # List of mitigation actions taken for the attack.
41
- # @return [Array<Types::Mitigation>]
42
- class AttackDetail < Struct.new(
43
- :attack_id,
44
- :resource_arn,
45
- :sub_resources,
46
- :start_time,
47
- :end_time,
48
- :attack_counters,
49
- :mitigations)
50
- include Aws::Structure
51
- end
52
-
53
- # Summarizes all DDoS attacks for a specified time period.
54
- # @!attribute [rw] attack_id
55
- # The unique identifier (ID) of the attack.
56
- # @return [String]
57
- #
58
- # @!attribute [rw] resource_arn
59
- # The ARN (Amazon Resource Name) of the resource that was attacked.
60
- # @return [String]
61
- #
62
- # @!attribute [rw] start_time
63
- # The start time of the attack, in the format 2016-12-16T13:50Z.
64
- # @return [Time]
65
- #
66
- # @!attribute [rw] end_time
67
- # The end time of the attack, in the format 2016-12-16T13:50Z.
68
- # @return [Time]
69
- #
70
- # @!attribute [rw] attack_vectors
71
- # The list of attacks for a specified time period.
72
- # @return [Array<Types::AttackVectorDescription>]
73
- class AttackSummary < Struct.new(
74
- :attack_id,
75
- :resource_arn,
76
- :start_time,
77
- :end_time,
78
- :attack_vectors)
79
- include Aws::Structure
80
- end
11
+ # The details of a DDoS attack.
12
+ #
13
+ # @!attribute [rw] attack_id
14
+ # The unique identifier (ID) of the attack.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] resource_arn
18
+ # The ARN (Amazon Resource Name) of the resource that was attacked.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] sub_resources
22
+ # If applicable, additional detail about the resource being attacked,
23
+ # for example, IP address or URL.
24
+ # @return [Array<Types::SubResourceSummary>]
25
+ #
26
+ # @!attribute [rw] start_time
27
+ # The time the attack started, in the format 2016-12-16T13:50Z.
28
+ # @return [Time]
29
+ #
30
+ # @!attribute [rw] end_time
31
+ # The time the attack ended, in the format 2016-12-16T13:50Z.
32
+ # @return [Time]
33
+ #
34
+ # @!attribute [rw] attack_counters
35
+ # List of counters that describe the attack for the specified time
36
+ # period.
37
+ # @return [Array<Types::SummarizedCounter>]
38
+ #
39
+ # @!attribute [rw] mitigations
40
+ # List of mitigation actions taken for the attack.
41
+ # @return [Array<Types::Mitigation>]
42
+ #
43
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AttackDetail AWS API Documentation
44
+ #
45
+ class AttackDetail < Struct.new(
46
+ :attack_id,
47
+ :resource_arn,
48
+ :sub_resources,
49
+ :start_time,
50
+ :end_time,
51
+ :attack_counters,
52
+ :mitigations)
53
+ include Aws::Structure
54
+ end
81
55
 
82
- # Describes the attack.
83
- # @!attribute [rw] vector_type
84
- # The attack type, for example, SNMP reflection or SYN flood.
85
- # @return [String]
86
- class AttackVectorDescription < Struct.new(
87
- :vector_type)
88
- include Aws::Structure
89
- end
56
+ # Summarizes all DDoS attacks for a specified time period.
57
+ #
58
+ # @!attribute [rw] attack_id
59
+ # The unique identifier (ID) of the attack.
60
+ # @return [String]
61
+ #
62
+ # @!attribute [rw] resource_arn
63
+ # The ARN (Amazon Resource Name) of the resource that was attacked.
64
+ # @return [String]
65
+ #
66
+ # @!attribute [rw] start_time
67
+ # The start time of the attack, in the format 2016-12-16T13:50Z.
68
+ # @return [Time]
69
+ #
70
+ # @!attribute [rw] end_time
71
+ # The end time of the attack, in the format 2016-12-16T13:50Z.
72
+ # @return [Time]
73
+ #
74
+ # @!attribute [rw] attack_vectors
75
+ # The list of attacks for a specified time period.
76
+ # @return [Array<Types::AttackVectorDescription>]
77
+ #
78
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AttackSummary AWS API Documentation
79
+ #
80
+ class AttackSummary < Struct.new(
81
+ :attack_id,
82
+ :resource_arn,
83
+ :start_time,
84
+ :end_time,
85
+ :attack_vectors)
86
+ include Aws::Structure
87
+ end
90
88
 
91
- # @note When making an API call, pass CreateProtectionRequest
92
- # data as a hash:
93
- #
94
- # {
95
- # name: "ProtectionName", # required
96
- # resource_arn: "ResourceArn", # required
97
- # }
98
- # @!attribute [rw] name
99
- # Friendly name for the `Protection` you are creating.
100
- # @return [String]
101
- #
102
- # @!attribute [rw] resource_arn
103
- # The ARN (Amazon Resource Name) of the resource to be protected.
104
- # @return [String]
105
- class CreateProtectionRequest < Struct.new(
106
- :name,
107
- :resource_arn)
108
- include Aws::Structure
109
- end
89
+ # Describes the attack.
90
+ #
91
+ # @!attribute [rw] vector_type
92
+ # The attack type, for example, SNMP reflection or SYN flood.
93
+ # @return [String]
94
+ #
95
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/AttackVectorDescription AWS API Documentation
96
+ #
97
+ class AttackVectorDescription < Struct.new(
98
+ :vector_type)
99
+ include Aws::Structure
100
+ end
110
101
 
111
- # @!attribute [rw] protection_id
112
- # The unique identifier (ID) for the Protection object that is
113
- # created.
114
- # @return [String]
115
- class CreateProtectionResponse < Struct.new(
116
- :protection_id)
117
- include Aws::Structure
118
- end
102
+ # @note When making an API call, you may pass CreateProtectionRequest
103
+ # data as a hash:
104
+ #
105
+ # {
106
+ # name: "ProtectionName", # required
107
+ # resource_arn: "ResourceArn", # required
108
+ # }
109
+ #
110
+ # @!attribute [rw] name
111
+ # Friendly name for the `Protection` you are creating.
112
+ # @return [String]
113
+ #
114
+ # @!attribute [rw] resource_arn
115
+ # The ARN (Amazon Resource Name) of the resource to be protected.
116
+ # @return [String]
117
+ #
118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtectionRequest AWS API Documentation
119
+ #
120
+ class CreateProtectionRequest < Struct.new(
121
+ :name,
122
+ :resource_arn)
123
+ include Aws::Structure
124
+ end
119
125
 
120
- # @api private
121
- class CreateSubscriptionRequest < Aws::EmptyStructure; end
126
+ # @!attribute [rw] protection_id
127
+ # The unique identifier (ID) for the Protection object that is
128
+ # created.
129
+ # @return [String]
130
+ #
131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateProtectionResponse AWS API Documentation
132
+ #
133
+ class CreateProtectionResponse < Struct.new(
134
+ :protection_id)
135
+ include Aws::Structure
136
+ end
122
137
 
123
- class CreateSubscriptionResponse < Aws::EmptyStructure; end
138
+ # @api private
139
+ #
140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateSubscriptionRequest AWS API Documentation
141
+ #
142
+ class CreateSubscriptionRequest < Aws::EmptyStructure; end
124
143
 
125
- # @note When making an API call, pass DeleteProtectionRequest
126
- # data as a hash:
127
- #
128
- # {
129
- # protection_id: "ProtectionId", # required
130
- # }
131
- # @!attribute [rw] protection_id
132
- # The unique identifier (ID) for the Protection object to be deleted.
133
- # @return [String]
134
- class DeleteProtectionRequest < Struct.new(
135
- :protection_id)
136
- include Aws::Structure
137
- end
144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CreateSubscriptionResponse AWS API Documentation
145
+ #
146
+ class CreateSubscriptionResponse < Aws::EmptyStructure; end
138
147
 
139
- class DeleteProtectionResponse < Aws::EmptyStructure; end
148
+ # @note When making an API call, you may pass DeleteProtectionRequest
149
+ # data as a hash:
150
+ #
151
+ # {
152
+ # protection_id: "ProtectionId", # required
153
+ # }
154
+ #
155
+ # @!attribute [rw] protection_id
156
+ # The unique identifier (ID) for the Protection object to be deleted.
157
+ # @return [String]
158
+ #
159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtectionRequest AWS API Documentation
160
+ #
161
+ class DeleteProtectionRequest < Struct.new(
162
+ :protection_id)
163
+ include Aws::Structure
164
+ end
140
165
 
141
- # @api private
142
- class DeleteSubscriptionRequest < Aws::EmptyStructure; end
166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteProtectionResponse AWS API Documentation
167
+ #
168
+ class DeleteProtectionResponse < Aws::EmptyStructure; end
143
169
 
144
- class DeleteSubscriptionResponse < Aws::EmptyStructure; end
170
+ # @api private
171
+ #
172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteSubscriptionRequest AWS API Documentation
173
+ #
174
+ class DeleteSubscriptionRequest < Aws::EmptyStructure; end
145
175
 
146
- # @note When making an API call, pass DescribeAttackRequest
147
- # data as a hash:
148
- #
149
- # {
150
- # attack_id: "AttackId", # required
151
- # }
152
- # @!attribute [rw] attack_id
153
- # The unique identifier (ID) for the attack that to be described.
154
- # @return [String]
155
- class DescribeAttackRequest < Struct.new(
156
- :attack_id)
157
- include Aws::Structure
158
- end
176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DeleteSubscriptionResponse AWS API Documentation
177
+ #
178
+ class DeleteSubscriptionResponse < Aws::EmptyStructure; end
159
179
 
160
- # @!attribute [rw] attack
161
- # The attack that is described.
162
- # @return [Types::AttackDetail]
163
- class DescribeAttackResponse < Struct.new(
164
- :attack)
165
- include Aws::Structure
166
- end
180
+ # @note When making an API call, you may pass DescribeAttackRequest
181
+ # data as a hash:
182
+ #
183
+ # {
184
+ # attack_id: "AttackId", # required
185
+ # }
186
+ #
187
+ # @!attribute [rw] attack_id
188
+ # The unique identifier (ID) for the attack that to be described.
189
+ # @return [String]
190
+ #
191
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttackRequest AWS API Documentation
192
+ #
193
+ class DescribeAttackRequest < Struct.new(
194
+ :attack_id)
195
+ include Aws::Structure
196
+ end
167
197
 
168
- # @note When making an API call, pass DescribeProtectionRequest
169
- # data as a hash:
170
- #
171
- # {
172
- # protection_id: "ProtectionId", # required
173
- # }
174
- # @!attribute [rw] protection_id
175
- # The unique identifier (ID) for the Protection object that is
176
- # described.
177
- # @return [String]
178
- class DescribeProtectionRequest < Struct.new(
179
- :protection_id)
180
- include Aws::Structure
181
- end
198
+ # @!attribute [rw] attack
199
+ # The attack that is described.
200
+ # @return [Types::AttackDetail]
201
+ #
202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttackResponse AWS API Documentation
203
+ #
204
+ class DescribeAttackResponse < Struct.new(
205
+ :attack)
206
+ include Aws::Structure
207
+ end
182
208
 
183
- # @!attribute [rw] protection
184
- # The Protection object that is described.
185
- # @return [Types::Protection]
186
- class DescribeProtectionResponse < Struct.new(
187
- :protection)
188
- include Aws::Structure
189
- end
209
+ # @note When making an API call, you may pass DescribeProtectionRequest
210
+ # data as a hash:
211
+ #
212
+ # {
213
+ # protection_id: "ProtectionId", # required
214
+ # }
215
+ #
216
+ # @!attribute [rw] protection_id
217
+ # The unique identifier (ID) for the Protection object that is
218
+ # described.
219
+ # @return [String]
220
+ #
221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtectionRequest AWS API Documentation
222
+ #
223
+ class DescribeProtectionRequest < Struct.new(
224
+ :protection_id)
225
+ include Aws::Structure
226
+ end
190
227
 
191
- # @api private
192
- class DescribeSubscriptionRequest < Aws::EmptyStructure; end
228
+ # @!attribute [rw] protection
229
+ # The Protection object that is described.
230
+ # @return [Types::Protection]
231
+ #
232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeProtectionResponse AWS API Documentation
233
+ #
234
+ class DescribeProtectionResponse < Struct.new(
235
+ :protection)
236
+ include Aws::Structure
237
+ end
193
238
 
194
- # @!attribute [rw] subscription
195
- # The AWS Shield Advanced subscription details for an account.
196
- # @return [Types::Subscription]
197
- class DescribeSubscriptionResponse < Struct.new(
198
- :subscription)
199
- include Aws::Structure
200
- end
239
+ # @api private
240
+ #
241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeSubscriptionRequest AWS API Documentation
242
+ #
243
+ class DescribeSubscriptionRequest < Aws::EmptyStructure; end
201
244
 
202
- # @note When making an API call, pass ListAttacksRequest
203
- # data as a hash:
204
- #
205
- # {
206
- # resource_arns: ["ResourceArn"],
207
- # start_time: {
208
- # from_inclusive: Time.now,
209
- # to_exclusive: Time.now,
210
- # },
211
- # end_time: {
212
- # from_inclusive: Time.now,
213
- # to_exclusive: Time.now,
214
- # },
215
- # next_token: "Token",
216
- # max_results: 1,
217
- # }
218
- # @!attribute [rw] resource_arns
219
- # The ARN (Amazon Resource Name) of the resource that was attacked. If
220
- # this is left blank, all applicable resources for this account will
221
- # be included.
222
- # @return [Array<String>]
223
- #
224
- # @!attribute [rw] start_time
225
- # The time period for the attacks.
226
- # @return [Types::TimeRange]
227
- #
228
- # @!attribute [rw] end_time
229
- # The end of the time period for the attacks.
230
- # @return [Types::TimeRange]
231
- #
232
- # @!attribute [rw] next_token
233
- # The `ListAttacksRequest.NextMarker` value from a previous call to
234
- # `ListAttacksRequest`. Pass null if this is the first call.
235
- # @return [String]
236
- #
237
- # @!attribute [rw] max_results
238
- # The maximum number of AttackSummary objects to be returned. If this
239
- # is left blank, the first 20 results will be returned.
240
- # @return [Integer]
241
- class ListAttacksRequest < Struct.new(
242
- :resource_arns,
243
- :start_time,
244
- :end_time,
245
- :next_token,
246
- :max_results)
247
- include Aws::Structure
248
- end
245
+ # @!attribute [rw] subscription
246
+ # The AWS Shield Advanced subscription details for an account.
247
+ # @return [Types::Subscription]
248
+ #
249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeSubscriptionResponse AWS API Documentation
250
+ #
251
+ class DescribeSubscriptionResponse < Struct.new(
252
+ :subscription)
253
+ include Aws::Structure
254
+ end
249
255
 
250
- # @!attribute [rw] attack_summaries
251
- # The attack information for the specified time range.
252
- # @return [Array<Types::AttackSummary>]
253
- #
254
- # @!attribute [rw] next_token
255
- # The token returned by a previous call to indicate that there is more
256
- # data available. If not null, more results are available. Pass this
257
- # value for the `NextMarker` parameter in a subsequent call to
258
- # `ListAttacks` to retrieve the next set of items.
259
- # @return [String]
260
- class ListAttacksResponse < Struct.new(
261
- :attack_summaries,
262
- :next_token)
263
- include Aws::Structure
264
- end
256
+ # @note When making an API call, you may pass ListAttacksRequest
257
+ # data as a hash:
258
+ #
259
+ # {
260
+ # resource_arns: ["ResourceArn"],
261
+ # start_time: {
262
+ # from_inclusive: Time.now,
263
+ # to_exclusive: Time.now,
264
+ # },
265
+ # end_time: {
266
+ # from_inclusive: Time.now,
267
+ # to_exclusive: Time.now,
268
+ # },
269
+ # next_token: "Token",
270
+ # max_results: 1,
271
+ # }
272
+ #
273
+ # @!attribute [rw] resource_arns
274
+ # The ARN (Amazon Resource Name) of the resource that was attacked. If
275
+ # this is left blank, all applicable resources for this account will
276
+ # be included.
277
+ # @return [Array<String>]
278
+ #
279
+ # @!attribute [rw] start_time
280
+ # The time period for the attacks.
281
+ # @return [Types::TimeRange]
282
+ #
283
+ # @!attribute [rw] end_time
284
+ # The end of the time period for the attacks.
285
+ # @return [Types::TimeRange]
286
+ #
287
+ # @!attribute [rw] next_token
288
+ # The `ListAttacksRequest.NextMarker` value from a previous call to
289
+ # `ListAttacksRequest`. Pass null if this is the first call.
290
+ # @return [String]
291
+ #
292
+ # @!attribute [rw] max_results
293
+ # The maximum number of AttackSummary objects to be returned. If this
294
+ # is left blank, the first 20 results will be returned.
295
+ # @return [Integer]
296
+ #
297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacksRequest AWS API Documentation
298
+ #
299
+ class ListAttacksRequest < Struct.new(
300
+ :resource_arns,
301
+ :start_time,
302
+ :end_time,
303
+ :next_token,
304
+ :max_results)
305
+ include Aws::Structure
306
+ end
265
307
 
266
- # @note When making an API call, pass ListProtectionsRequest
267
- # data as a hash:
268
- #
269
- # {
270
- # next_token: "Token",
271
- # max_results: 1,
272
- # }
273
- # @!attribute [rw] next_token
274
- # The `ListProtectionsRequest.NextToken` value from a previous call to
275
- # `ListProtections`. Pass null if this is the first call.
276
- # @return [String]
277
- #
278
- # @!attribute [rw] max_results
279
- # The maximum number of Protection objects to be returned. If this is
280
- # left blank the first 20 results will be returned.
281
- # @return [Integer]
282
- class ListProtectionsRequest < Struct.new(
283
- :next_token,
284
- :max_results)
285
- include Aws::Structure
286
- end
308
+ # @!attribute [rw] attack_summaries
309
+ # The attack information for the specified time range.
310
+ # @return [Array<Types::AttackSummary>]
311
+ #
312
+ # @!attribute [rw] next_token
313
+ # The token returned by a previous call to indicate that there is more
314
+ # data available. If not null, more results are available. Pass this
315
+ # value for the `NextMarker` parameter in a subsequent call to
316
+ # `ListAttacks` to retrieve the next set of items.
317
+ # @return [String]
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacksResponse AWS API Documentation
320
+ #
321
+ class ListAttacksResponse < Struct.new(
322
+ :attack_summaries,
323
+ :next_token)
324
+ include Aws::Structure
325
+ end
287
326
 
288
- # @!attribute [rw] protections
289
- # The array of enabled Protection objects.
290
- # @return [Array<Types::Protection>]
291
- #
292
- # @!attribute [rw] next_token
293
- # If you specify a value for `MaxResults` and you have more
294
- # Protections than the value of MaxResults, AWS Shield Advanced
295
- # returns a NextToken value in the response that allows you to list
296
- # another group of Protections. For the second and subsequent
297
- # ListProtections requests, specify the value of NextToken from the
298
- # previous response to get information about another batch of
299
- # Protections.
300
- # @return [String]
301
- class ListProtectionsResponse < Struct.new(
302
- :protections,
303
- :next_token)
304
- include Aws::Structure
305
- end
327
+ # @note When making an API call, you may pass ListProtectionsRequest
328
+ # data as a hash:
329
+ #
330
+ # {
331
+ # next_token: "Token",
332
+ # max_results: 1,
333
+ # }
334
+ #
335
+ # @!attribute [rw] next_token
336
+ # The `ListProtectionsRequest.NextToken` value from a previous call to
337
+ # `ListProtections`. Pass null if this is the first call.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] max_results
341
+ # The maximum number of Protection objects to be returned. If this is
342
+ # left blank the first 20 results will be returned.
343
+ # @return [Integer]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionsRequest AWS API Documentation
346
+ #
347
+ class ListProtectionsRequest < Struct.new(
348
+ :next_token,
349
+ :max_results)
350
+ include Aws::Structure
351
+ end
306
352
 
307
- # The mitigation applied to a DDoS attack.
308
- # @!attribute [rw] mitigation_name
309
- # The name of the mitigation taken for this attack.
310
- # @return [String]
311
- class Mitigation < Struct.new(
312
- :mitigation_name)
313
- include Aws::Structure
314
- end
353
+ # @!attribute [rw] protections
354
+ # The array of enabled Protection objects.
355
+ # @return [Array<Types::Protection>]
356
+ #
357
+ # @!attribute [rw] next_token
358
+ # If you specify a value for `MaxResults` and you have more
359
+ # Protections than the value of MaxResults, AWS Shield Advanced
360
+ # returns a NextToken value in the response that allows you to list
361
+ # another group of Protections. For the second and subsequent
362
+ # ListProtections requests, specify the value of NextToken from the
363
+ # previous response to get information about another batch of
364
+ # Protections.
365
+ # @return [String]
366
+ #
367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionsResponse AWS API Documentation
368
+ #
369
+ class ListProtectionsResponse < Struct.new(
370
+ :protections,
371
+ :next_token)
372
+ include Aws::Structure
373
+ end
315
374
 
316
- # An object that represents a resource that is under DDoS protection.
317
- # @!attribute [rw] id
318
- # The unique identifier (ID) of the protection.
319
- # @return [String]
320
- #
321
- # @!attribute [rw] name
322
- # The friendly name of the protection. For example, `My CloudFront
323
- # distributions`.
324
- # @return [String]
325
- #
326
- # @!attribute [rw] resource_arn
327
- # The ARN (Amazon Resource Name) of the AWS resource that is
328
- # protected.
329
- # @return [String]
330
- class Protection < Struct.new(
331
- :id,
332
- :name,
333
- :resource_arn)
334
- include Aws::Structure
335
- end
375
+ # The mitigation applied to a DDoS attack.
376
+ #
377
+ # @!attribute [rw] mitigation_name
378
+ # The name of the mitigation taken for this attack.
379
+ # @return [String]
380
+ #
381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Mitigation AWS API Documentation
382
+ #
383
+ class Mitigation < Struct.new(
384
+ :mitigation_name)
385
+ include Aws::Structure
386
+ end
336
387
 
337
- # The attack information for the specified SubResource.
338
- # @!attribute [rw] type
339
- # The `SubResource` type.
340
- # @return [String]
341
- #
342
- # @!attribute [rw] id
343
- # The unique identifier (ID) of the `SubResource`.
344
- # @return [String]
345
- #
346
- # @!attribute [rw] attack_vectors
347
- # The list of attack types and associated counters.
348
- # @return [Array<Types::SummarizedAttackVector>]
349
- #
350
- # @!attribute [rw] counters
351
- # The counters that describe the details of the attack.
352
- # @return [Array<Types::SummarizedCounter>]
353
- class SubResourceSummary < Struct.new(
354
- :type,
355
- :id,
356
- :attack_vectors,
357
- :counters)
358
- include Aws::Structure
359
- end
388
+ # An object that represents a resource that is under DDoS protection.
389
+ #
390
+ # @!attribute [rw] id
391
+ # The unique identifier (ID) of the protection.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] name
395
+ # The friendly name of the protection. For example, `My CloudFront
396
+ # distributions`.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] resource_arn
400
+ # The ARN (Amazon Resource Name) of the AWS resource that is
401
+ # protected.
402
+ # @return [String]
403
+ #
404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Protection AWS API Documentation
405
+ #
406
+ class Protection < Struct.new(
407
+ :id,
408
+ :name,
409
+ :resource_arn)
410
+ include Aws::Structure
411
+ end
360
412
 
361
- # Information about the AWS Shield Advanced subscription for an account.
362
- # @!attribute [rw] start_time
363
- # The start time of the subscription, in the format
364
- # "2016-12-16T13:50Z".
365
- # @return [Time]
366
- #
367
- # @!attribute [rw] time_commitment_in_seconds
368
- # The length, in seconds, of the AWS Shield Advanced subscription for
369
- # the account.
370
- # @return [Integer]
371
- class Subscription < Struct.new(
372
- :start_time,
373
- :time_commitment_in_seconds)
374
- include Aws::Structure
375
- end
413
+ # The attack information for the specified SubResource.
414
+ #
415
+ # @!attribute [rw] type
416
+ # The `SubResource` type.
417
+ # @return [String]
418
+ #
419
+ # @!attribute [rw] id
420
+ # The unique identifier (ID) of the `SubResource`.
421
+ # @return [String]
422
+ #
423
+ # @!attribute [rw] attack_vectors
424
+ # The list of attack types and associated counters.
425
+ # @return [Array<Types::SummarizedAttackVector>]
426
+ #
427
+ # @!attribute [rw] counters
428
+ # The counters that describe the details of the attack.
429
+ # @return [Array<Types::SummarizedCounter>]
430
+ #
431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/SubResourceSummary AWS API Documentation
432
+ #
433
+ class SubResourceSummary < Struct.new(
434
+ :type,
435
+ :id,
436
+ :attack_vectors,
437
+ :counters)
438
+ include Aws::Structure
439
+ end
376
440
 
377
- # A summary of information about the attack.
378
- # @!attribute [rw] vector_type
379
- # The attack type, for example, SNMP reflection or SYN flood.
380
- # @return [String]
381
- #
382
- # @!attribute [rw] vector_counters
383
- # The list of counters that describe the details of the attack.
384
- # @return [Array<Types::SummarizedCounter>]
385
- class SummarizedAttackVector < Struct.new(
386
- :vector_type,
387
- :vector_counters)
388
- include Aws::Structure
389
- end
441
+ # Information about the AWS Shield Advanced subscription for an account.
442
+ #
443
+ # @!attribute [rw] start_time
444
+ # The start time of the subscription, in the format
445
+ # "2016-12-16T13:50Z".
446
+ # @return [Time]
447
+ #
448
+ # @!attribute [rw] time_commitment_in_seconds
449
+ # The length, in seconds, of the AWS Shield Advanced subscription for
450
+ # the account.
451
+ # @return [Integer]
452
+ #
453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Subscription AWS API Documentation
454
+ #
455
+ class Subscription < Struct.new(
456
+ :start_time,
457
+ :time_commitment_in_seconds)
458
+ include Aws::Structure
459
+ end
390
460
 
391
- # The counter that describes a DDoS attack.
392
- # @!attribute [rw] name
393
- # The counter name.
394
- # @return [String]
395
- #
396
- # @!attribute [rw] max
397
- # The maximum value of the counter for a specified time period.
398
- # @return [Float]
399
- #
400
- # @!attribute [rw] average
401
- # The average value of the counter for a specified time period.
402
- # @return [Float]
403
- #
404
- # @!attribute [rw] sum
405
- # The total of counter values for a specified time period.
406
- # @return [Float]
407
- #
408
- # @!attribute [rw] n
409
- # The number of counters for a specified time period.
410
- # @return [Integer]
411
- #
412
- # @!attribute [rw] unit
413
- # The unit of the counters.
414
- # @return [String]
415
- class SummarizedCounter < Struct.new(
416
- :name,
417
- :max,
418
- :average,
419
- :sum,
420
- :n,
421
- :unit)
422
- include Aws::Structure
423
- end
461
+ # A summary of information about the attack.
462
+ #
463
+ # @!attribute [rw] vector_type
464
+ # The attack type, for example, SNMP reflection or SYN flood.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] vector_counters
468
+ # The list of counters that describe the details of the attack.
469
+ # @return [Array<Types::SummarizedCounter>]
470
+ #
471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/SummarizedAttackVector AWS API Documentation
472
+ #
473
+ class SummarizedAttackVector < Struct.new(
474
+ :vector_type,
475
+ :vector_counters)
476
+ include Aws::Structure
477
+ end
424
478
 
425
- # The time range.
426
- # @note When making an API call, pass TimeRange
427
- # data as a hash:
428
- #
429
- # {
430
- # from_inclusive: Time.now,
431
- # to_exclusive: Time.now,
432
- # }
433
- # @!attribute [rw] from_inclusive
434
- # The start time, in the format 2016-12-16T13:50Z.
435
- # @return [Time]
436
- #
437
- # @!attribute [rw] to_exclusive
438
- # The end time, in the format 2016-12-16T15:50Z.
439
- # @return [Time]
440
- class TimeRange < Struct.new(
441
- :from_inclusive,
442
- :to_exclusive)
443
- include Aws::Structure
444
- end
479
+ # The counter that describes a DDoS attack.
480
+ #
481
+ # @!attribute [rw] name
482
+ # The counter name.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] max
486
+ # The maximum value of the counter for a specified time period.
487
+ # @return [Float]
488
+ #
489
+ # @!attribute [rw] average
490
+ # The average value of the counter for a specified time period.
491
+ # @return [Float]
492
+ #
493
+ # @!attribute [rw] sum
494
+ # The total of counter values for a specified time period.
495
+ # @return [Float]
496
+ #
497
+ # @!attribute [rw] n
498
+ # The number of counters for a specified time period.
499
+ # @return [Integer]
500
+ #
501
+ # @!attribute [rw] unit
502
+ # The unit of the counters.
503
+ # @return [String]
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/SummarizedCounter AWS API Documentation
506
+ #
507
+ class SummarizedCounter < Struct.new(
508
+ :name,
509
+ :max,
510
+ :average,
511
+ :sum,
512
+ :n,
513
+ :unit)
514
+ include Aws::Structure
515
+ end
445
516
 
517
+ # The time range.
518
+ #
519
+ # @note When making an API call, you may pass TimeRange
520
+ # data as a hash:
521
+ #
522
+ # {
523
+ # from_inclusive: Time.now,
524
+ # to_exclusive: Time.now,
525
+ # }
526
+ #
527
+ # @!attribute [rw] from_inclusive
528
+ # The start time, in the format 2016-12-16T13:50Z.
529
+ # @return [Time]
530
+ #
531
+ # @!attribute [rw] to_exclusive
532
+ # The end time, in the format 2016-12-16T15:50Z.
533
+ # @return [Time]
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/TimeRange AWS API Documentation
536
+ #
537
+ class TimeRange < Struct.new(
538
+ :from_inclusive,
539
+ :to_exclusive)
540
+ include Aws::Structure
446
541
  end
542
+
447
543
  end
448
544
  end