aws-sdk-accessanalyzer 1.0.0
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 +7 -0
- data/lib/aws-sdk-accessanalyzer.rb +47 -0
- data/lib/aws-sdk-accessanalyzer/client.rb +1038 -0
- data/lib/aws-sdk-accessanalyzer/client_api.rb +639 -0
- data/lib/aws-sdk-accessanalyzer/customizations.rb +0 -0
- data/lib/aws-sdk-accessanalyzer/errors.rb +176 -0
- data/lib/aws-sdk-accessanalyzer/resource.rb +23 -0
- data/lib/aws-sdk-accessanalyzer/types.rb +1356 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,176 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::AccessAnalyzer
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
class AccessDeniedException < ServiceError
|
14
|
+
|
15
|
+
# @param [Seahorse::Client::RequestContext] context
|
16
|
+
# @param [String] message
|
17
|
+
# @param [Aws::AccessAnalyzer::Types::AccessDeniedException] data
|
18
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
|
+
super(context, message, data)
|
20
|
+
end
|
21
|
+
|
22
|
+
# @return [String]
|
23
|
+
def message
|
24
|
+
@message || @data[:message]
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
|
29
|
+
class ConflictException < ServiceError
|
30
|
+
|
31
|
+
# @param [Seahorse::Client::RequestContext] context
|
32
|
+
# @param [String] message
|
33
|
+
# @param [Aws::AccessAnalyzer::Types::ConflictException] data
|
34
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
35
|
+
super(context, message, data)
|
36
|
+
end
|
37
|
+
|
38
|
+
# @return [String]
|
39
|
+
def message
|
40
|
+
@message || @data[:message]
|
41
|
+
end
|
42
|
+
|
43
|
+
# @return [String]
|
44
|
+
def resource_id
|
45
|
+
@data[:resource_id]
|
46
|
+
end
|
47
|
+
|
48
|
+
# @return [String]
|
49
|
+
def resource_type
|
50
|
+
@data[:resource_type]
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
|
55
|
+
class InternalServerException < ServiceError
|
56
|
+
|
57
|
+
# @param [Seahorse::Client::RequestContext] context
|
58
|
+
# @param [String] message
|
59
|
+
# @param [Aws::AccessAnalyzer::Types::InternalServerException] data
|
60
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
61
|
+
super(context, message, data)
|
62
|
+
end
|
63
|
+
|
64
|
+
# @return [String]
|
65
|
+
def message
|
66
|
+
@message || @data[:message]
|
67
|
+
end
|
68
|
+
|
69
|
+
# @return [String]
|
70
|
+
def retry_after_seconds
|
71
|
+
@data[:retry_after_seconds]
|
72
|
+
end
|
73
|
+
|
74
|
+
end
|
75
|
+
|
76
|
+
class ResourceNotFoundException < ServiceError
|
77
|
+
|
78
|
+
# @param [Seahorse::Client::RequestContext] context
|
79
|
+
# @param [String] message
|
80
|
+
# @param [Aws::AccessAnalyzer::Types::ResourceNotFoundException] data
|
81
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
82
|
+
super(context, message, data)
|
83
|
+
end
|
84
|
+
|
85
|
+
# @return [String]
|
86
|
+
def message
|
87
|
+
@message || @data[:message]
|
88
|
+
end
|
89
|
+
|
90
|
+
# @return [String]
|
91
|
+
def resource_id
|
92
|
+
@data[:resource_id]
|
93
|
+
end
|
94
|
+
|
95
|
+
# @return [String]
|
96
|
+
def resource_type
|
97
|
+
@data[:resource_type]
|
98
|
+
end
|
99
|
+
|
100
|
+
end
|
101
|
+
|
102
|
+
class ServiceQuotaExceededException < ServiceError
|
103
|
+
|
104
|
+
# @param [Seahorse::Client::RequestContext] context
|
105
|
+
# @param [String] message
|
106
|
+
# @param [Aws::AccessAnalyzer::Types::ServiceQuotaExceededException] data
|
107
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
108
|
+
super(context, message, data)
|
109
|
+
end
|
110
|
+
|
111
|
+
# @return [String]
|
112
|
+
def message
|
113
|
+
@message || @data[:message]
|
114
|
+
end
|
115
|
+
|
116
|
+
# @return [String]
|
117
|
+
def resource_id
|
118
|
+
@data[:resource_id]
|
119
|
+
end
|
120
|
+
|
121
|
+
# @return [String]
|
122
|
+
def resource_type
|
123
|
+
@data[:resource_type]
|
124
|
+
end
|
125
|
+
|
126
|
+
end
|
127
|
+
|
128
|
+
class ThrottlingException < ServiceError
|
129
|
+
|
130
|
+
# @param [Seahorse::Client::RequestContext] context
|
131
|
+
# @param [String] message
|
132
|
+
# @param [Aws::AccessAnalyzer::Types::ThrottlingException] data
|
133
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
134
|
+
super(context, message, data)
|
135
|
+
end
|
136
|
+
|
137
|
+
# @return [String]
|
138
|
+
def message
|
139
|
+
@message || @data[:message]
|
140
|
+
end
|
141
|
+
|
142
|
+
# @return [String]
|
143
|
+
def retry_after_seconds
|
144
|
+
@data[:retry_after_seconds]
|
145
|
+
end
|
146
|
+
|
147
|
+
end
|
148
|
+
|
149
|
+
class ValidationException < ServiceError
|
150
|
+
|
151
|
+
# @param [Seahorse::Client::RequestContext] context
|
152
|
+
# @param [String] message
|
153
|
+
# @param [Aws::AccessAnalyzer::Types::ValidationException] data
|
154
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
155
|
+
super(context, message, data)
|
156
|
+
end
|
157
|
+
|
158
|
+
# @return [String]
|
159
|
+
def field_list
|
160
|
+
@data[:field_list]
|
161
|
+
end
|
162
|
+
|
163
|
+
# @return [String]
|
164
|
+
def message
|
165
|
+
@message || @data[:message]
|
166
|
+
end
|
167
|
+
|
168
|
+
# @return [String]
|
169
|
+
def reason
|
170
|
+
@data[:reason]
|
171
|
+
end
|
172
|
+
|
173
|
+
end
|
174
|
+
|
175
|
+
end
|
176
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::AccessAnalyzer
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,1356 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::AccessAnalyzer
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# You do not have sufficient access to perform this action.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] message
|
14
|
+
# @return [String]
|
15
|
+
#
|
16
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/AccessDeniedException AWS API Documentation
|
17
|
+
#
|
18
|
+
class AccessDeniedException < Struct.new(
|
19
|
+
:message)
|
20
|
+
include Aws::Structure
|
21
|
+
end
|
22
|
+
|
23
|
+
# Contains details about the analyzed resource.
|
24
|
+
#
|
25
|
+
# @!attribute [rw] actions
|
26
|
+
# The actions that an external principal is granted permission to use
|
27
|
+
# by the policy that generated the finding.
|
28
|
+
# @return [Array<String>]
|
29
|
+
#
|
30
|
+
# @!attribute [rw] analyzed_at
|
31
|
+
# The time at which the resource was analyzed.
|
32
|
+
# @return [Time]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] created_at
|
35
|
+
# The time at which the finding was created.
|
36
|
+
# @return [Time]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] error
|
39
|
+
# An error message.
|
40
|
+
# @return [String]
|
41
|
+
#
|
42
|
+
# @!attribute [rw] is_public
|
43
|
+
# Indicates whether the policy that generated the finding grants
|
44
|
+
# public access to the resource.
|
45
|
+
# @return [Boolean]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] resource_arn
|
48
|
+
# The ARN of the resource that was analyzed.
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
# @!attribute [rw] resource_type
|
52
|
+
# The type of the resource that was analyzed.
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] shared_via
|
56
|
+
# Indicates how the access that generated the finding is granted.
|
57
|
+
# @return [Array<String>]
|
58
|
+
#
|
59
|
+
# @!attribute [rw] status
|
60
|
+
# The current status of the finding generated from the analyzed
|
61
|
+
# resource.
|
62
|
+
# @return [String]
|
63
|
+
#
|
64
|
+
# @!attribute [rw] updated_at
|
65
|
+
# The time at which the finding was updated.
|
66
|
+
# @return [Time]
|
67
|
+
#
|
68
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/AnalyzedResource AWS API Documentation
|
69
|
+
#
|
70
|
+
class AnalyzedResource < Struct.new(
|
71
|
+
:actions,
|
72
|
+
:analyzed_at,
|
73
|
+
:created_at,
|
74
|
+
:error,
|
75
|
+
:is_public,
|
76
|
+
:resource_arn,
|
77
|
+
:resource_type,
|
78
|
+
:shared_via,
|
79
|
+
:status,
|
80
|
+
:updated_at)
|
81
|
+
include Aws::Structure
|
82
|
+
end
|
83
|
+
|
84
|
+
# Contains the ARN of the analyzed resource.
|
85
|
+
#
|
86
|
+
# @!attribute [rw] resource_arn
|
87
|
+
# The ARN of the analyzed resource.
|
88
|
+
# @return [String]
|
89
|
+
#
|
90
|
+
# @!attribute [rw] resource_type
|
91
|
+
# The type of resource that was analyzed.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/AnalyzedResourceSummary AWS API Documentation
|
95
|
+
#
|
96
|
+
class AnalyzedResourceSummary < Struct.new(
|
97
|
+
:resource_arn,
|
98
|
+
:resource_type)
|
99
|
+
include Aws::Structure
|
100
|
+
end
|
101
|
+
|
102
|
+
# Contains information about the analyzer.
|
103
|
+
#
|
104
|
+
# @!attribute [rw] arn
|
105
|
+
# The ARN of the analyzer.
|
106
|
+
# @return [String]
|
107
|
+
#
|
108
|
+
# @!attribute [rw] created_at
|
109
|
+
# A timestamp for the time at which the analyzer was created.
|
110
|
+
# @return [Time]
|
111
|
+
#
|
112
|
+
# @!attribute [rw] last_resource_analyzed
|
113
|
+
# The resource that was most recently analyzed by the analyzer.
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] last_resource_analyzed_at
|
117
|
+
# The time at which the most recently analyzed resource was analyzed.
|
118
|
+
# @return [Time]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] name
|
121
|
+
# The name of the analyzer.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] tags
|
125
|
+
# The tags added to the analyzer.
|
126
|
+
# @return [Hash<String,String>]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] type
|
129
|
+
# The type of analyzer, which corresponds to the zone of trust chosen
|
130
|
+
# for the analyzer.
|
131
|
+
# @return [String]
|
132
|
+
#
|
133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/AnalyzerSummary AWS API Documentation
|
134
|
+
#
|
135
|
+
class AnalyzerSummary < Struct.new(
|
136
|
+
:arn,
|
137
|
+
:created_at,
|
138
|
+
:last_resource_analyzed,
|
139
|
+
:last_resource_analyzed_at,
|
140
|
+
:name,
|
141
|
+
:tags,
|
142
|
+
:type)
|
143
|
+
include Aws::Structure
|
144
|
+
end
|
145
|
+
|
146
|
+
# Contains information about an archive rule.
|
147
|
+
#
|
148
|
+
# @!attribute [rw] created_at
|
149
|
+
# The time at which the archive rule was created.
|
150
|
+
# @return [Time]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] filter
|
153
|
+
# A filter used to define the archive rule.
|
154
|
+
# @return [Hash<String,Types::Criterion>]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] rule_name
|
157
|
+
# The name of the archive rule.
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] updated_at
|
161
|
+
# The time at which the archive rule was last updated.
|
162
|
+
# @return [Time]
|
163
|
+
#
|
164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ArchiveRuleSummary AWS API Documentation
|
165
|
+
#
|
166
|
+
class ArchiveRuleSummary < Struct.new(
|
167
|
+
:created_at,
|
168
|
+
:filter,
|
169
|
+
:rule_name,
|
170
|
+
:updated_at)
|
171
|
+
include Aws::Structure
|
172
|
+
end
|
173
|
+
|
174
|
+
# A conflict exception error.
|
175
|
+
#
|
176
|
+
# @!attribute [rw] message
|
177
|
+
# @return [String]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] resource_id
|
180
|
+
# The ID of the resource.
|
181
|
+
# @return [String]
|
182
|
+
#
|
183
|
+
# @!attribute [rw] resource_type
|
184
|
+
# The resource type.
|
185
|
+
# @return [String]
|
186
|
+
#
|
187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ConflictException AWS API Documentation
|
188
|
+
#
|
189
|
+
class ConflictException < Struct.new(
|
190
|
+
:message,
|
191
|
+
:resource_id,
|
192
|
+
:resource_type)
|
193
|
+
include Aws::Structure
|
194
|
+
end
|
195
|
+
|
196
|
+
# Creates an analyzer.
|
197
|
+
#
|
198
|
+
# @note When making an API call, you may pass CreateAnalyzerRequest
|
199
|
+
# data as a hash:
|
200
|
+
#
|
201
|
+
# {
|
202
|
+
# analyzer_name: "Name", # required
|
203
|
+
# archive_rules: [
|
204
|
+
# {
|
205
|
+
# filter: { # required
|
206
|
+
# "String" => {
|
207
|
+
# contains: ["String"],
|
208
|
+
# eq: ["String"],
|
209
|
+
# exists: false,
|
210
|
+
# neq: ["String"],
|
211
|
+
# },
|
212
|
+
# },
|
213
|
+
# rule_name: "Name", # required
|
214
|
+
# },
|
215
|
+
# ],
|
216
|
+
# client_token: "String",
|
217
|
+
# tags: {
|
218
|
+
# "String" => "String",
|
219
|
+
# },
|
220
|
+
# type: "ACCOUNT", # required, accepts ACCOUNT
|
221
|
+
# }
|
222
|
+
#
|
223
|
+
# @!attribute [rw] analyzer_name
|
224
|
+
# The name of the analyzer to create.
|
225
|
+
# @return [String]
|
226
|
+
#
|
227
|
+
# @!attribute [rw] archive_rules
|
228
|
+
# Specifies the archive rules to add for the analyzer.
|
229
|
+
# @return [Array<Types::InlineArchiveRule>]
|
230
|
+
#
|
231
|
+
# @!attribute [rw] client_token
|
232
|
+
# A client token.
|
233
|
+
#
|
234
|
+
# **A suitable default value is auto-generated.** You should normally
|
235
|
+
# not need to pass this option.
|
236
|
+
# @return [String]
|
237
|
+
#
|
238
|
+
# @!attribute [rw] tags
|
239
|
+
# The tags to apply to the analyzer.
|
240
|
+
# @return [Hash<String,String>]
|
241
|
+
#
|
242
|
+
# @!attribute [rw] type
|
243
|
+
# The zone of trust for the analyzer. You can create only one analyzer
|
244
|
+
# per account per Region.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/CreateAnalyzerRequest AWS API Documentation
|
248
|
+
#
|
249
|
+
class CreateAnalyzerRequest < Struct.new(
|
250
|
+
:analyzer_name,
|
251
|
+
:archive_rules,
|
252
|
+
:client_token,
|
253
|
+
:tags,
|
254
|
+
:type)
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
258
|
+
# The response to the request to create an analyzer.
|
259
|
+
#
|
260
|
+
# @!attribute [rw] arn
|
261
|
+
# The ARN of the analyzer that was created by the request.
|
262
|
+
# @return [String]
|
263
|
+
#
|
264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/CreateAnalyzerResponse AWS API Documentation
|
265
|
+
#
|
266
|
+
class CreateAnalyzerResponse < Struct.new(
|
267
|
+
:arn)
|
268
|
+
include Aws::Structure
|
269
|
+
end
|
270
|
+
|
271
|
+
# Creates an archive rule.
|
272
|
+
#
|
273
|
+
# @note When making an API call, you may pass CreateArchiveRuleRequest
|
274
|
+
# data as a hash:
|
275
|
+
#
|
276
|
+
# {
|
277
|
+
# analyzer_name: "Name", # required
|
278
|
+
# client_token: "String",
|
279
|
+
# filter: { # required
|
280
|
+
# "String" => {
|
281
|
+
# contains: ["String"],
|
282
|
+
# eq: ["String"],
|
283
|
+
# exists: false,
|
284
|
+
# neq: ["String"],
|
285
|
+
# },
|
286
|
+
# },
|
287
|
+
# rule_name: "Name", # required
|
288
|
+
# }
|
289
|
+
#
|
290
|
+
# @!attribute [rw] analyzer_name
|
291
|
+
# The name of the created analyzer.
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] client_token
|
295
|
+
# A client token.
|
296
|
+
#
|
297
|
+
# **A suitable default value is auto-generated.** You should normally
|
298
|
+
# not need to pass this option.
|
299
|
+
# @return [String]
|
300
|
+
#
|
301
|
+
# @!attribute [rw] filter
|
302
|
+
# The criteria for the rule.
|
303
|
+
# @return [Hash<String,Types::Criterion>]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] rule_name
|
306
|
+
# The name of the rule to create.
|
307
|
+
# @return [String]
|
308
|
+
#
|
309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/CreateArchiveRuleRequest AWS API Documentation
|
310
|
+
#
|
311
|
+
class CreateArchiveRuleRequest < Struct.new(
|
312
|
+
:analyzer_name,
|
313
|
+
:client_token,
|
314
|
+
:filter,
|
315
|
+
:rule_name)
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
319
|
+
# The criteria to use in the filter that defines the rule.
|
320
|
+
#
|
321
|
+
# @note When making an API call, you may pass Criterion
|
322
|
+
# data as a hash:
|
323
|
+
#
|
324
|
+
# {
|
325
|
+
# contains: ["String"],
|
326
|
+
# eq: ["String"],
|
327
|
+
# exists: false,
|
328
|
+
# neq: ["String"],
|
329
|
+
# }
|
330
|
+
#
|
331
|
+
# @!attribute [rw] contains
|
332
|
+
# A "contains" operator to match for the filter used to create the
|
333
|
+
# rule.
|
334
|
+
# @return [Array<String>]
|
335
|
+
#
|
336
|
+
# @!attribute [rw] eq
|
337
|
+
# An "equals" operator to match for the filter used to create the
|
338
|
+
# rule.
|
339
|
+
# @return [Array<String>]
|
340
|
+
#
|
341
|
+
# @!attribute [rw] exists
|
342
|
+
# An "exists" operator to match for the filter used to create the
|
343
|
+
# rule.
|
344
|
+
# @return [Boolean]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] neq
|
347
|
+
# A "not equals" operator to match for the filter used to create the
|
348
|
+
# rule.
|
349
|
+
# @return [Array<String>]
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/Criterion AWS API Documentation
|
352
|
+
#
|
353
|
+
class Criterion < Struct.new(
|
354
|
+
:contains,
|
355
|
+
:eq,
|
356
|
+
:exists,
|
357
|
+
:neq)
|
358
|
+
include Aws::Structure
|
359
|
+
end
|
360
|
+
|
361
|
+
# Deletes an analyzer.
|
362
|
+
#
|
363
|
+
# @note When making an API call, you may pass DeleteAnalyzerRequest
|
364
|
+
# data as a hash:
|
365
|
+
#
|
366
|
+
# {
|
367
|
+
# analyzer_name: "Name", # required
|
368
|
+
# client_token: "String",
|
369
|
+
# }
|
370
|
+
#
|
371
|
+
# @!attribute [rw] analyzer_name
|
372
|
+
# The name of the analyzer to delete.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] client_token
|
376
|
+
# A client token.
|
377
|
+
#
|
378
|
+
# **A suitable default value is auto-generated.** You should normally
|
379
|
+
# not need to pass this option.
|
380
|
+
# @return [String]
|
381
|
+
#
|
382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/DeleteAnalyzerRequest AWS API Documentation
|
383
|
+
#
|
384
|
+
class DeleteAnalyzerRequest < Struct.new(
|
385
|
+
:analyzer_name,
|
386
|
+
:client_token)
|
387
|
+
include Aws::Structure
|
388
|
+
end
|
389
|
+
|
390
|
+
# Deletes an archive rule.
|
391
|
+
#
|
392
|
+
# @note When making an API call, you may pass DeleteArchiveRuleRequest
|
393
|
+
# data as a hash:
|
394
|
+
#
|
395
|
+
# {
|
396
|
+
# analyzer_name: "Name", # required
|
397
|
+
# client_token: "String",
|
398
|
+
# rule_name: "Name", # required
|
399
|
+
# }
|
400
|
+
#
|
401
|
+
# @!attribute [rw] analyzer_name
|
402
|
+
# The name of the analyzer that was deleted.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] client_token
|
406
|
+
# A client token.
|
407
|
+
#
|
408
|
+
# **A suitable default value is auto-generated.** You should normally
|
409
|
+
# not need to pass this option.
|
410
|
+
# @return [String]
|
411
|
+
#
|
412
|
+
# @!attribute [rw] rule_name
|
413
|
+
# The name of the rule to delete.
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/DeleteArchiveRuleRequest AWS API Documentation
|
417
|
+
#
|
418
|
+
class DeleteArchiveRuleRequest < Struct.new(
|
419
|
+
:analyzer_name,
|
420
|
+
:client_token,
|
421
|
+
:rule_name)
|
422
|
+
include Aws::Structure
|
423
|
+
end
|
424
|
+
|
425
|
+
# Contains information about a finding.
|
426
|
+
#
|
427
|
+
# @!attribute [rw] action
|
428
|
+
# The action in the analyzed policy statement that an external
|
429
|
+
# principal has permission to use.
|
430
|
+
# @return [Array<String>]
|
431
|
+
#
|
432
|
+
# @!attribute [rw] analyzed_at
|
433
|
+
# The time at which the resource was analyzed.
|
434
|
+
# @return [Time]
|
435
|
+
#
|
436
|
+
# @!attribute [rw] condition
|
437
|
+
# The condition in the analyzed policy statement that resulted in a
|
438
|
+
# finding.
|
439
|
+
# @return [Hash<String,String>]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] created_at
|
442
|
+
# The time at which the finding was generated.
|
443
|
+
# @return [Time]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] error
|
446
|
+
# An error.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] id
|
450
|
+
# The ID of the finding.
|
451
|
+
# @return [String]
|
452
|
+
#
|
453
|
+
# @!attribute [rw] is_public
|
454
|
+
# Indicates whether the policy that generated the finding allows
|
455
|
+
# public access to the resource.
|
456
|
+
# @return [Boolean]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] principal
|
459
|
+
# The external principal that access to a resource within the zone of
|
460
|
+
# trust.
|
461
|
+
# @return [Hash<String,String>]
|
462
|
+
#
|
463
|
+
# @!attribute [rw] resource
|
464
|
+
# The resource that an external principal has access to.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] resource_type
|
468
|
+
# The type of the resource reported in the finding.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] status
|
472
|
+
# The current status of the finding.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] updated_at
|
476
|
+
# The time at which the finding was updated.
|
477
|
+
# @return [Time]
|
478
|
+
#
|
479
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/Finding AWS API Documentation
|
480
|
+
#
|
481
|
+
class Finding < Struct.new(
|
482
|
+
:action,
|
483
|
+
:analyzed_at,
|
484
|
+
:condition,
|
485
|
+
:created_at,
|
486
|
+
:error,
|
487
|
+
:id,
|
488
|
+
:is_public,
|
489
|
+
:principal,
|
490
|
+
:resource,
|
491
|
+
:resource_type,
|
492
|
+
:status,
|
493
|
+
:updated_at)
|
494
|
+
include Aws::Structure
|
495
|
+
end
|
496
|
+
|
497
|
+
# Contains information about a finding.
|
498
|
+
#
|
499
|
+
# @!attribute [rw] action
|
500
|
+
# The action in the analyzed policy statement that an external
|
501
|
+
# principal has permission to use.
|
502
|
+
# @return [Array<String>]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] analyzed_at
|
505
|
+
# The time at which the resource-based policy that generated the
|
506
|
+
# finding was analyzed.
|
507
|
+
# @return [Time]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] condition
|
510
|
+
# The condition in the analyzed policy statement that resulted in a
|
511
|
+
# finding.
|
512
|
+
# @return [Hash<String,String>]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] created_at
|
515
|
+
# The time at which the finding was created.
|
516
|
+
# @return [Time]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] error
|
519
|
+
# The error that resulted in an Error finding.
|
520
|
+
# @return [String]
|
521
|
+
#
|
522
|
+
# @!attribute [rw] id
|
523
|
+
# The ID of the finding.
|
524
|
+
# @return [String]
|
525
|
+
#
|
526
|
+
# @!attribute [rw] is_public
|
527
|
+
# Indicates whether the finding reports a resource that has a policy
|
528
|
+
# that allows public access.
|
529
|
+
# @return [Boolean]
|
530
|
+
#
|
531
|
+
# @!attribute [rw] principal
|
532
|
+
# The external principal that has access to a resource within the zone
|
533
|
+
# of trust.
|
534
|
+
# @return [Hash<String,String>]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] resource
|
537
|
+
# The resource that the external principal has access to.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] resource_type
|
541
|
+
# The type of the resource that the external principal has access to.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] status
|
545
|
+
# The status of the finding.
|
546
|
+
# @return [String]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] updated_at
|
549
|
+
# The time at which the finding was most recently updated.
|
550
|
+
# @return [Time]
|
551
|
+
#
|
552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/FindingSummary AWS API Documentation
|
553
|
+
#
|
554
|
+
class FindingSummary < Struct.new(
|
555
|
+
:action,
|
556
|
+
:analyzed_at,
|
557
|
+
:condition,
|
558
|
+
:created_at,
|
559
|
+
:error,
|
560
|
+
:id,
|
561
|
+
:is_public,
|
562
|
+
:principal,
|
563
|
+
:resource,
|
564
|
+
:resource_type,
|
565
|
+
:status,
|
566
|
+
:updated_at)
|
567
|
+
include Aws::Structure
|
568
|
+
end
|
569
|
+
|
570
|
+
# Retrieves an analyzed resource.
|
571
|
+
#
|
572
|
+
# @note When making an API call, you may pass GetAnalyzedResourceRequest
|
573
|
+
# data as a hash:
|
574
|
+
#
|
575
|
+
# {
|
576
|
+
# analyzer_arn: "AnalyzerArn", # required
|
577
|
+
# resource_arn: "ResourceArn", # required
|
578
|
+
# }
|
579
|
+
#
|
580
|
+
# @!attribute [rw] analyzer_arn
|
581
|
+
# The ARN of the analyzer to retrieve information from.
|
582
|
+
# @return [String]
|
583
|
+
#
|
584
|
+
# @!attribute [rw] resource_arn
|
585
|
+
# The ARN of the resource to retrieve information about.
|
586
|
+
# @return [String]
|
587
|
+
#
|
588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetAnalyzedResourceRequest AWS API Documentation
|
589
|
+
#
|
590
|
+
class GetAnalyzedResourceRequest < Struct.new(
|
591
|
+
:analyzer_arn,
|
592
|
+
:resource_arn)
|
593
|
+
include Aws::Structure
|
594
|
+
end
|
595
|
+
|
596
|
+
# The response to the request.
|
597
|
+
#
|
598
|
+
# @!attribute [rw] resource
|
599
|
+
# An `AnalyedResource` object that contains information that Access
|
600
|
+
# Analyzer found when it analyzed the resource.
|
601
|
+
# @return [Types::AnalyzedResource]
|
602
|
+
#
|
603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetAnalyzedResourceResponse AWS API Documentation
|
604
|
+
#
|
605
|
+
class GetAnalyzedResourceResponse < Struct.new(
|
606
|
+
:resource)
|
607
|
+
include Aws::Structure
|
608
|
+
end
|
609
|
+
|
610
|
+
# Retrieves an analyzer.
|
611
|
+
#
|
612
|
+
# @note When making an API call, you may pass GetAnalyzerRequest
|
613
|
+
# data as a hash:
|
614
|
+
#
|
615
|
+
# {
|
616
|
+
# analyzer_name: "Name", # required
|
617
|
+
# }
|
618
|
+
#
|
619
|
+
# @!attribute [rw] analyzer_name
|
620
|
+
# The name of the analyzer retrieved.
|
621
|
+
# @return [String]
|
622
|
+
#
|
623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetAnalyzerRequest AWS API Documentation
|
624
|
+
#
|
625
|
+
class GetAnalyzerRequest < Struct.new(
|
626
|
+
:analyzer_name)
|
627
|
+
include Aws::Structure
|
628
|
+
end
|
629
|
+
|
630
|
+
# The response to the request.
|
631
|
+
#
|
632
|
+
# @!attribute [rw] analyzer
|
633
|
+
# An `AnalyzerSummary` object that contains information about the
|
634
|
+
# analyzer.
|
635
|
+
# @return [Types::AnalyzerSummary]
|
636
|
+
#
|
637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetAnalyzerResponse AWS API Documentation
|
638
|
+
#
|
639
|
+
class GetAnalyzerResponse < Struct.new(
|
640
|
+
:analyzer)
|
641
|
+
include Aws::Structure
|
642
|
+
end
|
643
|
+
|
644
|
+
# Retrieves an archive rule.
|
645
|
+
#
|
646
|
+
# @note When making an API call, you may pass GetArchiveRuleRequest
|
647
|
+
# data as a hash:
|
648
|
+
#
|
649
|
+
# {
|
650
|
+
# analyzer_name: "Name", # required
|
651
|
+
# rule_name: "Name", # required
|
652
|
+
# }
|
653
|
+
#
|
654
|
+
# @!attribute [rw] analyzer_name
|
655
|
+
# The name of the analyzer to retrieve rules from.
|
656
|
+
# @return [String]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] rule_name
|
659
|
+
# The name of the rule to retrieve.
|
660
|
+
# @return [String]
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetArchiveRuleRequest AWS API Documentation
|
663
|
+
#
|
664
|
+
class GetArchiveRuleRequest < Struct.new(
|
665
|
+
:analyzer_name,
|
666
|
+
:rule_name)
|
667
|
+
include Aws::Structure
|
668
|
+
end
|
669
|
+
|
670
|
+
# The response to the request.
|
671
|
+
#
|
672
|
+
# @!attribute [rw] archive_rule
|
673
|
+
# Contains information about an archive rule.
|
674
|
+
# @return [Types::ArchiveRuleSummary]
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetArchiveRuleResponse AWS API Documentation
|
677
|
+
#
|
678
|
+
class GetArchiveRuleResponse < Struct.new(
|
679
|
+
:archive_rule)
|
680
|
+
include Aws::Structure
|
681
|
+
end
|
682
|
+
|
683
|
+
# Retrieves a finding.
|
684
|
+
#
|
685
|
+
# @note When making an API call, you may pass GetFindingRequest
|
686
|
+
# data as a hash:
|
687
|
+
#
|
688
|
+
# {
|
689
|
+
# analyzer_arn: "AnalyzerArn", # required
|
690
|
+
# id: "FindingId", # required
|
691
|
+
# }
|
692
|
+
#
|
693
|
+
# @!attribute [rw] analyzer_arn
|
694
|
+
# The ARN of the analyzer that generated the finding.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @!attribute [rw] id
|
698
|
+
# The ID of the finding to retrieve.
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetFindingRequest AWS API Documentation
|
702
|
+
#
|
703
|
+
class GetFindingRequest < Struct.new(
|
704
|
+
:analyzer_arn,
|
705
|
+
:id)
|
706
|
+
include Aws::Structure
|
707
|
+
end
|
708
|
+
|
709
|
+
# The resposne to the request.
|
710
|
+
#
|
711
|
+
# @!attribute [rw] finding
|
712
|
+
# A `finding` object that contains finding details.
|
713
|
+
# @return [Types::Finding]
|
714
|
+
#
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/GetFindingResponse AWS API Documentation
|
716
|
+
#
|
717
|
+
class GetFindingResponse < Struct.new(
|
718
|
+
:finding)
|
719
|
+
include Aws::Structure
|
720
|
+
end
|
721
|
+
|
722
|
+
# An inline archive rule.
|
723
|
+
#
|
724
|
+
# @note When making an API call, you may pass InlineArchiveRule
|
725
|
+
# data as a hash:
|
726
|
+
#
|
727
|
+
# {
|
728
|
+
# filter: { # required
|
729
|
+
# "String" => {
|
730
|
+
# contains: ["String"],
|
731
|
+
# eq: ["String"],
|
732
|
+
# exists: false,
|
733
|
+
# neq: ["String"],
|
734
|
+
# },
|
735
|
+
# },
|
736
|
+
# rule_name: "Name", # required
|
737
|
+
# }
|
738
|
+
#
|
739
|
+
# @!attribute [rw] filter
|
740
|
+
# The criteria for the rule.
|
741
|
+
# @return [Hash<String,Types::Criterion>]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] rule_name
|
744
|
+
# The name of the rule.
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/InlineArchiveRule AWS API Documentation
|
748
|
+
#
|
749
|
+
class InlineArchiveRule < Struct.new(
|
750
|
+
:filter,
|
751
|
+
:rule_name)
|
752
|
+
include Aws::Structure
|
753
|
+
end
|
754
|
+
|
755
|
+
# Internal server error.
|
756
|
+
#
|
757
|
+
# @!attribute [rw] message
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] retry_after_seconds
|
761
|
+
# The seconds to wait to retry.
|
762
|
+
# @return [Integer]
|
763
|
+
#
|
764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/InternalServerException AWS API Documentation
|
765
|
+
#
|
766
|
+
class InternalServerException < Struct.new(
|
767
|
+
:message,
|
768
|
+
:retry_after_seconds)
|
769
|
+
include Aws::Structure
|
770
|
+
end
|
771
|
+
|
772
|
+
# Retrieves a list of resources that have been analyzed.
|
773
|
+
#
|
774
|
+
# @note When making an API call, you may pass ListAnalyzedResourcesRequest
|
775
|
+
# data as a hash:
|
776
|
+
#
|
777
|
+
# {
|
778
|
+
# analyzer_arn: "AnalyzerArn", # required
|
779
|
+
# max_results: 1,
|
780
|
+
# next_token: "Token",
|
781
|
+
# resource_type: "AWS::IAM::Role", # accepts AWS::IAM::Role, AWS::KMS::Key, AWS::Lambda::Function, AWS::Lambda::LayerVersion, AWS::S3::Bucket, AWS::SQS::Queue
|
782
|
+
# }
|
783
|
+
#
|
784
|
+
# @!attribute [rw] analyzer_arn
|
785
|
+
# The ARN of the analyzer to retrieve a list of analyzed resources
|
786
|
+
# from.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] max_results
|
790
|
+
# The maximum number of results to return in the response.
|
791
|
+
# @return [Integer]
|
792
|
+
#
|
793
|
+
# @!attribute [rw] next_token
|
794
|
+
# A token used for pagination of results returned.
|
795
|
+
# @return [String]
|
796
|
+
#
|
797
|
+
# @!attribute [rw] resource_type
|
798
|
+
# The type of resource.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListAnalyzedResourcesRequest AWS API Documentation
|
802
|
+
#
|
803
|
+
class ListAnalyzedResourcesRequest < Struct.new(
|
804
|
+
:analyzer_arn,
|
805
|
+
:max_results,
|
806
|
+
:next_token,
|
807
|
+
:resource_type)
|
808
|
+
include Aws::Structure
|
809
|
+
end
|
810
|
+
|
811
|
+
# The response to the request.
|
812
|
+
#
|
813
|
+
# @!attribute [rw] analyzed_resources
|
814
|
+
# A list of resources that were analyzed.
|
815
|
+
# @return [Array<Types::AnalyzedResourceSummary>]
|
816
|
+
#
|
817
|
+
# @!attribute [rw] next_token
|
818
|
+
# A token used for pagination of results returned.
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListAnalyzedResourcesResponse AWS API Documentation
|
822
|
+
#
|
823
|
+
class ListAnalyzedResourcesResponse < Struct.new(
|
824
|
+
:analyzed_resources,
|
825
|
+
:next_token)
|
826
|
+
include Aws::Structure
|
827
|
+
end
|
828
|
+
|
829
|
+
# Retrieves a list of analyzers.
|
830
|
+
#
|
831
|
+
# @note When making an API call, you may pass ListAnalyzersRequest
|
832
|
+
# data as a hash:
|
833
|
+
#
|
834
|
+
# {
|
835
|
+
# max_results: 1,
|
836
|
+
# next_token: "Token",
|
837
|
+
# type: "ACCOUNT", # accepts ACCOUNT
|
838
|
+
# }
|
839
|
+
#
|
840
|
+
# @!attribute [rw] max_results
|
841
|
+
# The maximum number of results to return in the response.
|
842
|
+
# @return [Integer]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] next_token
|
845
|
+
# A token used for pagination of results returned.
|
846
|
+
# @return [String]
|
847
|
+
#
|
848
|
+
# @!attribute [rw] type
|
849
|
+
# The type of analyzer, which corresponds to the zone of trust
|
850
|
+
# selected when the analyzer was created.
|
851
|
+
# @return [String]
|
852
|
+
#
|
853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListAnalyzersRequest AWS API Documentation
|
854
|
+
#
|
855
|
+
class ListAnalyzersRequest < Struct.new(
|
856
|
+
:max_results,
|
857
|
+
:next_token,
|
858
|
+
:type)
|
859
|
+
include Aws::Structure
|
860
|
+
end
|
861
|
+
|
862
|
+
# The response to the request.
|
863
|
+
#
|
864
|
+
# @!attribute [rw] analyzers
|
865
|
+
# The analyzers retrieved.
|
866
|
+
# @return [Array<Types::AnalyzerSummary>]
|
867
|
+
#
|
868
|
+
# @!attribute [rw] next_token
|
869
|
+
# A token used for pagination of results returned.
|
870
|
+
# @return [String]
|
871
|
+
#
|
872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListAnalyzersResponse AWS API Documentation
|
873
|
+
#
|
874
|
+
class ListAnalyzersResponse < Struct.new(
|
875
|
+
:analyzers,
|
876
|
+
:next_token)
|
877
|
+
include Aws::Structure
|
878
|
+
end
|
879
|
+
|
880
|
+
# Retrieves a list of archive rules created for the specified analyzer.
|
881
|
+
#
|
882
|
+
# @note When making an API call, you may pass ListArchiveRulesRequest
|
883
|
+
# data as a hash:
|
884
|
+
#
|
885
|
+
# {
|
886
|
+
# analyzer_name: "Name", # required
|
887
|
+
# max_results: 1,
|
888
|
+
# next_token: "Token",
|
889
|
+
# }
|
890
|
+
#
|
891
|
+
# @!attribute [rw] analyzer_name
|
892
|
+
# The name of the analyzer to retrieve rules from.
|
893
|
+
# @return [String]
|
894
|
+
#
|
895
|
+
# @!attribute [rw] max_results
|
896
|
+
# The maximum number of results to return in the request.
|
897
|
+
# @return [Integer]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] next_token
|
900
|
+
# A token used for pagination of results returned.
|
901
|
+
# @return [String]
|
902
|
+
#
|
903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListArchiveRulesRequest AWS API Documentation
|
904
|
+
#
|
905
|
+
class ListArchiveRulesRequest < Struct.new(
|
906
|
+
:analyzer_name,
|
907
|
+
:max_results,
|
908
|
+
:next_token)
|
909
|
+
include Aws::Structure
|
910
|
+
end
|
911
|
+
|
912
|
+
# The response to the request.
|
913
|
+
#
|
914
|
+
# @!attribute [rw] archive_rules
|
915
|
+
# A list of archive rules created for the specified analyzer.
|
916
|
+
# @return [Array<Types::ArchiveRuleSummary>]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] next_token
|
919
|
+
# A token used for pagination of results returned.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListArchiveRulesResponse AWS API Documentation
|
923
|
+
#
|
924
|
+
class ListArchiveRulesResponse < Struct.new(
|
925
|
+
:archive_rules,
|
926
|
+
:next_token)
|
927
|
+
include Aws::Structure
|
928
|
+
end
|
929
|
+
|
930
|
+
# Retrieves a list of findings generated by the specified analyzer.
|
931
|
+
#
|
932
|
+
# @note When making an API call, you may pass ListFindingsRequest
|
933
|
+
# data as a hash:
|
934
|
+
#
|
935
|
+
# {
|
936
|
+
# analyzer_arn: "AnalyzerArn", # required
|
937
|
+
# filter: {
|
938
|
+
# "String" => {
|
939
|
+
# contains: ["String"],
|
940
|
+
# eq: ["String"],
|
941
|
+
# exists: false,
|
942
|
+
# neq: ["String"],
|
943
|
+
# },
|
944
|
+
# },
|
945
|
+
# max_results: 1,
|
946
|
+
# next_token: "Token",
|
947
|
+
# sort: {
|
948
|
+
# attribute_name: "String",
|
949
|
+
# order_by: "ASC", # accepts ASC, DESC
|
950
|
+
# },
|
951
|
+
# }
|
952
|
+
#
|
953
|
+
# @!attribute [rw] analyzer_arn
|
954
|
+
# The ARN of the analyzer to retrieve findings from.
|
955
|
+
# @return [String]
|
956
|
+
#
|
957
|
+
# @!attribute [rw] filter
|
958
|
+
# A filter to match for the findings to return.
|
959
|
+
# @return [Hash<String,Types::Criterion>]
|
960
|
+
#
|
961
|
+
# @!attribute [rw] max_results
|
962
|
+
# The maximum number of results to return in the response.
|
963
|
+
# @return [Integer]
|
964
|
+
#
|
965
|
+
# @!attribute [rw] next_token
|
966
|
+
# A token used for pagination of results returned.
|
967
|
+
# @return [String]
|
968
|
+
#
|
969
|
+
# @!attribute [rw] sort
|
970
|
+
# The sort order for the findings returned.
|
971
|
+
# @return [Types::SortCriteria]
|
972
|
+
#
|
973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListFindingsRequest AWS API Documentation
|
974
|
+
#
|
975
|
+
class ListFindingsRequest < Struct.new(
|
976
|
+
:analyzer_arn,
|
977
|
+
:filter,
|
978
|
+
:max_results,
|
979
|
+
:next_token,
|
980
|
+
:sort)
|
981
|
+
include Aws::Structure
|
982
|
+
end
|
983
|
+
|
984
|
+
# The resposne to the request.
|
985
|
+
#
|
986
|
+
# @!attribute [rw] findings
|
987
|
+
# A list of findings retrieved from the analyzer that match the filter
|
988
|
+
# criteria specified, if any.
|
989
|
+
# @return [Array<Types::FindingSummary>]
|
990
|
+
#
|
991
|
+
# @!attribute [rw] next_token
|
992
|
+
# A token used for pagination of results returned.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListFindingsResponse AWS API Documentation
|
996
|
+
#
|
997
|
+
class ListFindingsResponse < Struct.new(
|
998
|
+
:findings,
|
999
|
+
:next_token)
|
1000
|
+
include Aws::Structure
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
# Retrieves a list of tags applied to the specified resource.
|
1004
|
+
#
|
1005
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1006
|
+
# data as a hash:
|
1007
|
+
#
|
1008
|
+
# {
|
1009
|
+
# resource_arn: "String", # required
|
1010
|
+
# }
|
1011
|
+
#
|
1012
|
+
# @!attribute [rw] resource_arn
|
1013
|
+
# The ARN of the resource to retrieve tags from.
|
1014
|
+
# @return [String]
|
1015
|
+
#
|
1016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListTagsForResourceRequest AWS API Documentation
|
1017
|
+
#
|
1018
|
+
class ListTagsForResourceRequest < Struct.new(
|
1019
|
+
:resource_arn)
|
1020
|
+
include Aws::Structure
|
1021
|
+
end
|
1022
|
+
|
1023
|
+
# The response to the request.
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] tags
|
1026
|
+
# The tags that are applied to the specified resource.
|
1027
|
+
# @return [Hash<String,String>]
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ListTagsForResourceResponse AWS API Documentation
|
1030
|
+
#
|
1031
|
+
class ListTagsForResourceResponse < Struct.new(
|
1032
|
+
:tags)
|
1033
|
+
include Aws::Structure
|
1034
|
+
end
|
1035
|
+
|
1036
|
+
# The specified resource could not be found.
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] message
|
1039
|
+
# @return [String]
|
1040
|
+
#
|
1041
|
+
# @!attribute [rw] resource_id
|
1042
|
+
# The ID of the resource.
|
1043
|
+
# @return [String]
|
1044
|
+
#
|
1045
|
+
# @!attribute [rw] resource_type
|
1046
|
+
# The type of the resource.
|
1047
|
+
# @return [String]
|
1048
|
+
#
|
1049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ResourceNotFoundException AWS API Documentation
|
1050
|
+
#
|
1051
|
+
class ResourceNotFoundException < Struct.new(
|
1052
|
+
:message,
|
1053
|
+
:resource_id,
|
1054
|
+
:resource_type)
|
1055
|
+
include Aws::Structure
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
# Service quote met error.
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] message
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] resource_id
|
1064
|
+
# The resource ID.
|
1065
|
+
# @return [String]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] resource_type
|
1068
|
+
# The resource type.
|
1069
|
+
# @return [String]
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ServiceQuotaExceededException AWS API Documentation
|
1072
|
+
#
|
1073
|
+
class ServiceQuotaExceededException < Struct.new(
|
1074
|
+
:message,
|
1075
|
+
:resource_id,
|
1076
|
+
:resource_type)
|
1077
|
+
include Aws::Structure
|
1078
|
+
end
|
1079
|
+
|
1080
|
+
# The sort criteria.
|
1081
|
+
#
|
1082
|
+
# @note When making an API call, you may pass SortCriteria
|
1083
|
+
# data as a hash:
|
1084
|
+
#
|
1085
|
+
# {
|
1086
|
+
# attribute_name: "String",
|
1087
|
+
# order_by: "ASC", # accepts ASC, DESC
|
1088
|
+
# }
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] attribute_name
|
1091
|
+
# The name of the attribute to sort on.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] order_by
|
1095
|
+
# The sort order, ascending or descending.
|
1096
|
+
# @return [String]
|
1097
|
+
#
|
1098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/SortCriteria AWS API Documentation
|
1099
|
+
#
|
1100
|
+
class SortCriteria < Struct.new(
|
1101
|
+
:attribute_name,
|
1102
|
+
:order_by)
|
1103
|
+
include Aws::Structure
|
1104
|
+
end
|
1105
|
+
|
1106
|
+
# Starts a scan of the policies applied to the specified resource.
|
1107
|
+
#
|
1108
|
+
# @note When making an API call, you may pass StartResourceScanRequest
|
1109
|
+
# data as a hash:
|
1110
|
+
#
|
1111
|
+
# {
|
1112
|
+
# analyzer_arn: "AnalyzerArn", # required
|
1113
|
+
# resource_arn: "ResourceArn", # required
|
1114
|
+
# }
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] analyzer_arn
|
1117
|
+
# The ARN of the analyzer to use to scan the policies applied to the
|
1118
|
+
# specified resource.
|
1119
|
+
# @return [String]
|
1120
|
+
#
|
1121
|
+
# @!attribute [rw] resource_arn
|
1122
|
+
# The ARN of the resource to scan.
|
1123
|
+
# @return [String]
|
1124
|
+
#
|
1125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/StartResourceScanRequest AWS API Documentation
|
1126
|
+
#
|
1127
|
+
class StartResourceScanRequest < Struct.new(
|
1128
|
+
:analyzer_arn,
|
1129
|
+
:resource_arn)
|
1130
|
+
include Aws::Structure
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
# Adds a tag to the specified resource.
|
1134
|
+
#
|
1135
|
+
# @note When making an API call, you may pass TagResourceRequest
|
1136
|
+
# data as a hash:
|
1137
|
+
#
|
1138
|
+
# {
|
1139
|
+
# resource_arn: "String", # required
|
1140
|
+
# tags: { # required
|
1141
|
+
# "String" => "String",
|
1142
|
+
# },
|
1143
|
+
# }
|
1144
|
+
#
|
1145
|
+
# @!attribute [rw] resource_arn
|
1146
|
+
# The ARN of the resource to add the tag to.
|
1147
|
+
# @return [String]
|
1148
|
+
#
|
1149
|
+
# @!attribute [rw] tags
|
1150
|
+
# The tags to add to the resource.
|
1151
|
+
# @return [Hash<String,String>]
|
1152
|
+
#
|
1153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/TagResourceRequest AWS API Documentation
|
1154
|
+
#
|
1155
|
+
class TagResourceRequest < Struct.new(
|
1156
|
+
:resource_arn,
|
1157
|
+
:tags)
|
1158
|
+
include Aws::Structure
|
1159
|
+
end
|
1160
|
+
|
1161
|
+
# The response to the request.
|
1162
|
+
#
|
1163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/TagResourceResponse AWS API Documentation
|
1164
|
+
#
|
1165
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1166
|
+
|
1167
|
+
# Throttling limit exceeded error.
|
1168
|
+
#
|
1169
|
+
# @!attribute [rw] message
|
1170
|
+
# @return [String]
|
1171
|
+
#
|
1172
|
+
# @!attribute [rw] retry_after_seconds
|
1173
|
+
# The seconds to wait to retry.
|
1174
|
+
# @return [Integer]
|
1175
|
+
#
|
1176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ThrottlingException AWS API Documentation
|
1177
|
+
#
|
1178
|
+
class ThrottlingException < Struct.new(
|
1179
|
+
:message,
|
1180
|
+
:retry_after_seconds)
|
1181
|
+
include Aws::Structure
|
1182
|
+
end
|
1183
|
+
|
1184
|
+
# Removes a tag from the specified resource.
|
1185
|
+
#
|
1186
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
1187
|
+
# data as a hash:
|
1188
|
+
#
|
1189
|
+
# {
|
1190
|
+
# resource_arn: "String", # required
|
1191
|
+
# tag_keys: ["String"], # required
|
1192
|
+
# }
|
1193
|
+
#
|
1194
|
+
# @!attribute [rw] resource_arn
|
1195
|
+
# The ARN of the resource to remove the tag from.
|
1196
|
+
# @return [String]
|
1197
|
+
#
|
1198
|
+
# @!attribute [rw] tag_keys
|
1199
|
+
# The key for the tag to add.
|
1200
|
+
# @return [Array<String>]
|
1201
|
+
#
|
1202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/UntagResourceRequest AWS API Documentation
|
1203
|
+
#
|
1204
|
+
class UntagResourceRequest < Struct.new(
|
1205
|
+
:resource_arn,
|
1206
|
+
:tag_keys)
|
1207
|
+
include Aws::Structure
|
1208
|
+
end
|
1209
|
+
|
1210
|
+
# The response tot he request.
|
1211
|
+
#
|
1212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/UntagResourceResponse AWS API Documentation
|
1213
|
+
#
|
1214
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1215
|
+
|
1216
|
+
# Updates the specified archive rule.
|
1217
|
+
#
|
1218
|
+
# @note When making an API call, you may pass UpdateArchiveRuleRequest
|
1219
|
+
# data as a hash:
|
1220
|
+
#
|
1221
|
+
# {
|
1222
|
+
# analyzer_name: "Name", # required
|
1223
|
+
# client_token: "String",
|
1224
|
+
# filter: { # required
|
1225
|
+
# "String" => {
|
1226
|
+
# contains: ["String"],
|
1227
|
+
# eq: ["String"],
|
1228
|
+
# exists: false,
|
1229
|
+
# neq: ["String"],
|
1230
|
+
# },
|
1231
|
+
# },
|
1232
|
+
# rule_name: "Name", # required
|
1233
|
+
# }
|
1234
|
+
#
|
1235
|
+
# @!attribute [rw] analyzer_name
|
1236
|
+
# The name of the analyzer to update the archive rules for.
|
1237
|
+
# @return [String]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] client_token
|
1240
|
+
# A client token.
|
1241
|
+
#
|
1242
|
+
# **A suitable default value is auto-generated.** You should normally
|
1243
|
+
# not need to pass this option.
|
1244
|
+
# @return [String]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] filter
|
1247
|
+
# A filter to match for the rules to update. Only rules that match the
|
1248
|
+
# filter are updated.
|
1249
|
+
# @return [Hash<String,Types::Criterion>]
|
1250
|
+
#
|
1251
|
+
# @!attribute [rw] rule_name
|
1252
|
+
# The name of the rule to update.
|
1253
|
+
# @return [String]
|
1254
|
+
#
|
1255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/UpdateArchiveRuleRequest AWS API Documentation
|
1256
|
+
#
|
1257
|
+
class UpdateArchiveRuleRequest < Struct.new(
|
1258
|
+
:analyzer_name,
|
1259
|
+
:client_token,
|
1260
|
+
:filter,
|
1261
|
+
:rule_name)
|
1262
|
+
include Aws::Structure
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# Updates findings with the new values provided in the request.
|
1266
|
+
#
|
1267
|
+
# @note When making an API call, you may pass UpdateFindingsRequest
|
1268
|
+
# data as a hash:
|
1269
|
+
#
|
1270
|
+
# {
|
1271
|
+
# analyzer_arn: "AnalyzerArn", # required
|
1272
|
+
# client_token: "String",
|
1273
|
+
# ids: ["FindingId"],
|
1274
|
+
# resource_arn: "ResourceArn",
|
1275
|
+
# status: "ACTIVE", # required, accepts ACTIVE, ARCHIVED
|
1276
|
+
# }
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] analyzer_arn
|
1279
|
+
# The ARN of the analyzer that generated the findings to update.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] client_token
|
1283
|
+
# A client token.
|
1284
|
+
#
|
1285
|
+
# **A suitable default value is auto-generated.** You should normally
|
1286
|
+
# not need to pass this option.
|
1287
|
+
# @return [String]
|
1288
|
+
#
|
1289
|
+
# @!attribute [rw] ids
|
1290
|
+
# The IDs of the findings to update.
|
1291
|
+
# @return [Array<String>]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] resource_arn
|
1294
|
+
# The ARN of the resource identified in the finding.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] status
|
1298
|
+
# The state represents the action to take to update the finding
|
1299
|
+
# Status. Use `ARCHIVE` to change an Active finding to an Archived
|
1300
|
+
# finding. Use `ACTIVE` to change an Archived finding to an Active
|
1301
|
+
# finding.
|
1302
|
+
# @return [String]
|
1303
|
+
#
|
1304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/UpdateFindingsRequest AWS API Documentation
|
1305
|
+
#
|
1306
|
+
class UpdateFindingsRequest < Struct.new(
|
1307
|
+
:analyzer_arn,
|
1308
|
+
:client_token,
|
1309
|
+
:ids,
|
1310
|
+
:resource_arn,
|
1311
|
+
:status)
|
1312
|
+
include Aws::Structure
|
1313
|
+
end
|
1314
|
+
|
1315
|
+
# Validation exception error.
|
1316
|
+
#
|
1317
|
+
# @!attribute [rw] field_list
|
1318
|
+
# A list of fields that didn't validate.
|
1319
|
+
# @return [Array<Types::ValidationExceptionField>]
|
1320
|
+
#
|
1321
|
+
# @!attribute [rw] message
|
1322
|
+
# @return [String]
|
1323
|
+
#
|
1324
|
+
# @!attribute [rw] reason
|
1325
|
+
# The reason for the exception.
|
1326
|
+
# @return [String]
|
1327
|
+
#
|
1328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ValidationException AWS API Documentation
|
1329
|
+
#
|
1330
|
+
class ValidationException < Struct.new(
|
1331
|
+
:field_list,
|
1332
|
+
:message,
|
1333
|
+
:reason)
|
1334
|
+
include Aws::Structure
|
1335
|
+
end
|
1336
|
+
|
1337
|
+
# Contains information about a validation exception.
|
1338
|
+
#
|
1339
|
+
# @!attribute [rw] message
|
1340
|
+
# A message about the validation exception.
|
1341
|
+
# @return [String]
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] name
|
1344
|
+
# The name of the validation exception.
|
1345
|
+
# @return [String]
|
1346
|
+
#
|
1347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/accessanalyzer-2019-11-01/ValidationExceptionField AWS API Documentation
|
1348
|
+
#
|
1349
|
+
class ValidationExceptionField < Struct.new(
|
1350
|
+
:message,
|
1351
|
+
:name)
|
1352
|
+
include Aws::Structure
|
1353
|
+
end
|
1354
|
+
|
1355
|
+
end
|
1356
|
+
end
|