aws-sdk-macie2 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-macie2.rb +50 -0
- data/lib/aws-sdk-macie2/client.rb +2483 -0
- data/lib/aws-sdk-macie2/client_api.rb +2054 -0
- data/lib/aws-sdk-macie2/customizations.rb +0 -0
- data/lib/aws-sdk-macie2/errors.rb +148 -0
- data/lib/aws-sdk-macie2/resource.rb +24 -0
- data/lib/aws-sdk-macie2/types.rb +4881 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 166ae430232decba827e4747300ce325ef8183af88cb3c1d31c39547c985cf73
|
4
|
+
data.tar.gz: 3c5968f7372610abbe26174c38dd1b5955448ecfdc6d119f6e9410f6647d587f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8198e08cbaa0a1973b1649cba9fa9ba249d1f861e647baf17eddf54794d7ecc4e0493f318717caebbcec95b61573e8b3f3a46b59a28f9a006f75a3779e24bb0d
|
7
|
+
data.tar.gz: 69e3dfd18da6d80f3eb03aa4619cccc29d634dea4532805f7a2a4d82a2656c7ca6af2cde49cbbba827ee366942506fb1dfafe5bc6448ce672932b39c502107d2
|
@@ -0,0 +1,50 @@
|
|
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
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-macie2/types'
|
12
|
+
require_relative 'aws-sdk-macie2/client_api'
|
13
|
+
require_relative 'aws-sdk-macie2/client'
|
14
|
+
require_relative 'aws-sdk-macie2/errors'
|
15
|
+
require_relative 'aws-sdk-macie2/resource'
|
16
|
+
require_relative 'aws-sdk-macie2/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Macie 2. This module is available in the
|
19
|
+
# `aws-sdk-macie2` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# macie_2 = Aws::Macie2::Client.new
|
28
|
+
# resp = macie_2.accept_invitation(params)
|
29
|
+
#
|
30
|
+
# See {Client} for more information.
|
31
|
+
#
|
32
|
+
# # Errors
|
33
|
+
#
|
34
|
+
# Errors returned from Amazon Macie 2 are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
36
|
+
#
|
37
|
+
# begin
|
38
|
+
# # do stuff
|
39
|
+
# rescue Aws::Macie2::Errors::ServiceError
|
40
|
+
# # rescues all Amazon Macie 2 API errors
|
41
|
+
# end
|
42
|
+
#
|
43
|
+
# See {Errors} for more information.
|
44
|
+
#
|
45
|
+
# @service
|
46
|
+
module Aws::Macie2
|
47
|
+
|
48
|
+
GEM_VERSION = '1.0.0'
|
49
|
+
|
50
|
+
end
|
@@ -0,0 +1,2483 @@
|
|
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
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
|
+
|
30
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:macie2)
|
31
|
+
|
32
|
+
module Aws::Macie2
|
33
|
+
# An API client for Macie2. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Macie2::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
45
|
+
class Client < Seahorse::Client::Base
|
46
|
+
|
47
|
+
include Aws::ClientStubs
|
48
|
+
|
49
|
+
@identifier = :macie2
|
50
|
+
|
51
|
+
set_api(ClientApi::API)
|
52
|
+
|
53
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
54
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
55
|
+
add_plugin(Aws::Plugins::Logging)
|
56
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
57
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
58
|
+
add_plugin(Aws::Plugins::UserAgent)
|
59
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
60
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
61
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
62
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
63
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
64
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
65
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
66
|
+
add_plugin(Aws::Plugins::StubResponses)
|
67
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
68
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
69
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
72
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
73
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
74
|
+
|
75
|
+
# @overload initialize(options)
|
76
|
+
# @param [Hash] options
|
77
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
78
|
+
# Your AWS credentials. This can be an instance of any one of the
|
79
|
+
# following classes:
|
80
|
+
#
|
81
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
82
|
+
# credentials.
|
83
|
+
#
|
84
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
85
|
+
# from an EC2 IMDS on an EC2 instance.
|
86
|
+
#
|
87
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
88
|
+
# shared file, such as `~/.aws/config`.
|
89
|
+
#
|
90
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
91
|
+
#
|
92
|
+
# When `:credentials` are not configured directly, the following
|
93
|
+
# locations will be searched for credentials:
|
94
|
+
#
|
95
|
+
# * `Aws.config[:credentials]`
|
96
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
97
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
98
|
+
# * `~/.aws/credentials`
|
99
|
+
# * `~/.aws/config`
|
100
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
101
|
+
# very aggressive. Construct and pass an instance of
|
102
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
103
|
+
# timeouts.
|
104
|
+
#
|
105
|
+
# @option options [required, String] :region
|
106
|
+
# The AWS region to connect to. The configured `:region` is
|
107
|
+
# used to determine the service `:endpoint`. When not passed,
|
108
|
+
# a default `:region` is searched for in the following locations:
|
109
|
+
#
|
110
|
+
# * `Aws.config[:region]`
|
111
|
+
# * `ENV['AWS_REGION']`
|
112
|
+
# * `ENV['AMAZON_REGION']`
|
113
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
114
|
+
# * `~/.aws/credentials`
|
115
|
+
# * `~/.aws/config`
|
116
|
+
#
|
117
|
+
# @option options [String] :access_key_id
|
118
|
+
#
|
119
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
120
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
121
|
+
# the background every 60 secs (default). Defaults to `false`.
|
122
|
+
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
130
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
131
|
+
# this client.
|
132
|
+
#
|
133
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
134
|
+
# Allows you to provide an identifier for this client which will be attached to
|
135
|
+
# all generated client side metrics. Defaults to an empty string.
|
136
|
+
#
|
137
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
138
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
139
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
140
|
+
#
|
141
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
142
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
143
|
+
# agent is running on, where client metrics will be published via UDP.
|
144
|
+
#
|
145
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
146
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
147
|
+
# will use the Client Side Monitoring Agent Publisher.
|
148
|
+
#
|
149
|
+
# @option options [Boolean] :convert_params (true)
|
150
|
+
# When `true`, an attempt is made to coerce request parameters into
|
151
|
+
# the required types.
|
152
|
+
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
158
|
+
# Set to true to disable SDK automatically adding host prefix
|
159
|
+
# to default service endpoint when available.
|
160
|
+
#
|
161
|
+
# @option options [String] :endpoint
|
162
|
+
# The client endpoint is normally constructed from the `:region`
|
163
|
+
# option. You should only configure an `:endpoint` when connecting
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
165
|
+
#
|
166
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
168
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
169
|
+
#
|
170
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
171
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
172
|
+
#
|
173
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
174
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
175
|
+
# Use this option to config the time interval in seconds for making
|
176
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
177
|
+
#
|
178
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
180
|
+
#
|
181
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
|
+
# The log formatter.
|
183
|
+
#
|
184
|
+
# @option options [Symbol] :log_level (:info)
|
185
|
+
# The log level to send messages to the `:logger` at.
|
186
|
+
#
|
187
|
+
# @option options [Logger] :logger
|
188
|
+
# The Logger instance to send log messages to. If this option
|
189
|
+
# is not set, logging will be disabled.
|
190
|
+
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
197
|
+
# @option options [String] :profile ("default")
|
198
|
+
# Used when loading credentials from the shared credentials file
|
199
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
200
|
+
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
205
|
+
# @option options [Float] :retry_base_delay (0.3)
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
208
|
+
#
|
209
|
+
# @option options [Symbol] :retry_jitter (:none)
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
214
|
+
#
|
215
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
216
|
+
#
|
217
|
+
# @option options [Integer] :retry_limit (3)
|
218
|
+
# The maximum number of times to retry failed requests. Only
|
219
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
220
|
+
# are retried. Generally, these are throttling errors, data
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
224
|
+
#
|
225
|
+
# @option options [Integer] :retry_max_delay (0)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
245
|
+
#
|
246
|
+
# @option options [String] :secret_access_key
|
247
|
+
#
|
248
|
+
# @option options [String] :session_token
|
249
|
+
#
|
250
|
+
# @option options [Boolean] :stub_responses (false)
|
251
|
+
# Causes the client to return stubbed responses. By default
|
252
|
+
# fake responses are generated and returned. You can specify
|
253
|
+
# the response data to return or errors to raise by calling
|
254
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
255
|
+
#
|
256
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
257
|
+
# requests are made, and retries are disabled.
|
258
|
+
#
|
259
|
+
# @option options [Boolean] :validate_params (true)
|
260
|
+
# When `true`, request parameters are validated before
|
261
|
+
# sending the request.
|
262
|
+
#
|
263
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
264
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
265
|
+
#
|
266
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
268
|
+
# `Timeout::Error`.
|
269
|
+
#
|
270
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
271
|
+
# number of seconds to wait for response data. This value can
|
272
|
+
# safely be set per-request on the session.
|
273
|
+
#
|
274
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
276
|
+
# considered stale. Stale connections are closed and removed
|
277
|
+
# from the pool before making a request.
|
278
|
+
#
|
279
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
280
|
+
# seconds to wait for a 100-continue response before sending the
|
281
|
+
# request body. This option has no effect unless the request has
|
282
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
283
|
+
# disables this behaviour. This value can safely be set per
|
284
|
+
# request on the session.
|
285
|
+
#
|
286
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
287
|
+
# HTTP debug output will be sent to the `:logger`.
|
288
|
+
#
|
289
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
290
|
+
# SSL peer certificates are verified when establishing a
|
291
|
+
# connection.
|
292
|
+
#
|
293
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
294
|
+
# certificate authority bundle file that should be used when
|
295
|
+
# verifying peer certificates. If you do not pass
|
296
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
297
|
+
# will be used if available.
|
298
|
+
#
|
299
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
300
|
+
# directory that contains the unbundled SSL certificate
|
301
|
+
# authority files for verifying peer certificates. If you do
|
302
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
303
|
+
# system default will be used if available.
|
304
|
+
#
|
305
|
+
def initialize(*args)
|
306
|
+
super
|
307
|
+
end
|
308
|
+
|
309
|
+
# @!group API Operations
|
310
|
+
|
311
|
+
# Accepts an Amazon Macie membership invitation that was received from a
|
312
|
+
# specific account.
|
313
|
+
#
|
314
|
+
# @option params [required, String] :invitation_id
|
315
|
+
#
|
316
|
+
# @option params [required, String] :master_account
|
317
|
+
#
|
318
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
319
|
+
#
|
320
|
+
# @example Request syntax with placeholder values
|
321
|
+
#
|
322
|
+
# resp = client.accept_invitation({
|
323
|
+
# invitation_id: "__string", # required
|
324
|
+
# master_account: "__string", # required
|
325
|
+
# })
|
326
|
+
#
|
327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/AcceptInvitation AWS API Documentation
|
328
|
+
#
|
329
|
+
# @overload accept_invitation(params = {})
|
330
|
+
# @param [Hash] params ({})
|
331
|
+
def accept_invitation(params = {}, options = {})
|
332
|
+
req = build_request(:accept_invitation, params)
|
333
|
+
req.send_request(options)
|
334
|
+
end
|
335
|
+
|
336
|
+
# Archives one or more findings.
|
337
|
+
#
|
338
|
+
# @option params [required, Array<String>] :finding_ids
|
339
|
+
#
|
340
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
341
|
+
#
|
342
|
+
# @example Request syntax with placeholder values
|
343
|
+
#
|
344
|
+
# resp = client.archive_findings({
|
345
|
+
# finding_ids: ["__string"], # required
|
346
|
+
# })
|
347
|
+
#
|
348
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ArchiveFindings AWS API Documentation
|
349
|
+
#
|
350
|
+
# @overload archive_findings(params = {})
|
351
|
+
# @param [Hash] params ({})
|
352
|
+
def archive_findings(params = {}, options = {})
|
353
|
+
req = build_request(:archive_findings, params)
|
354
|
+
req.send_request(options)
|
355
|
+
end
|
356
|
+
|
357
|
+
# Retrieves information about one or more custom data identifiers.
|
358
|
+
#
|
359
|
+
# @option params [Array<String>] :ids
|
360
|
+
#
|
361
|
+
# @return [Types::BatchGetCustomDataIdentifiersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
362
|
+
#
|
363
|
+
# * {Types::BatchGetCustomDataIdentifiersResponse#custom_data_identifiers #custom_data_identifiers} => Array<Types::BatchGetCustomDataIdentifierSummary>
|
364
|
+
# * {Types::BatchGetCustomDataIdentifiersResponse#not_found_identifier_ids #not_found_identifier_ids} => Array<String>
|
365
|
+
#
|
366
|
+
# @example Request syntax with placeholder values
|
367
|
+
#
|
368
|
+
# resp = client.batch_get_custom_data_identifiers({
|
369
|
+
# ids: ["__string"],
|
370
|
+
# })
|
371
|
+
#
|
372
|
+
# @example Response structure
|
373
|
+
#
|
374
|
+
# resp.custom_data_identifiers #=> Array
|
375
|
+
# resp.custom_data_identifiers[0].arn #=> String
|
376
|
+
# resp.custom_data_identifiers[0].created_at #=> Time
|
377
|
+
# resp.custom_data_identifiers[0].deleted #=> Boolean
|
378
|
+
# resp.custom_data_identifiers[0].description #=> String
|
379
|
+
# resp.custom_data_identifiers[0].id #=> String
|
380
|
+
# resp.custom_data_identifiers[0].name #=> String
|
381
|
+
# resp.not_found_identifier_ids #=> Array
|
382
|
+
# resp.not_found_identifier_ids[0] #=> String
|
383
|
+
#
|
384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/BatchGetCustomDataIdentifiers AWS API Documentation
|
385
|
+
#
|
386
|
+
# @overload batch_get_custom_data_identifiers(params = {})
|
387
|
+
# @param [Hash] params ({})
|
388
|
+
def batch_get_custom_data_identifiers(params = {}, options = {})
|
389
|
+
req = build_request(:batch_get_custom_data_identifiers, params)
|
390
|
+
req.send_request(options)
|
391
|
+
end
|
392
|
+
|
393
|
+
# Creates and defines the settings for a classification job.
|
394
|
+
#
|
395
|
+
# @option params [required, String] :client_token
|
396
|
+
# **A suitable default value is auto-generated.** You should normally
|
397
|
+
# not need to pass this option.**
|
398
|
+
#
|
399
|
+
# @option params [Array<String>] :custom_data_identifier_ids
|
400
|
+
#
|
401
|
+
# @option params [String] :description
|
402
|
+
#
|
403
|
+
# @option params [Boolean] :initial_run
|
404
|
+
#
|
405
|
+
# @option params [required, String] :job_type
|
406
|
+
# The schedule for running a classification job. Valid values are:
|
407
|
+
#
|
408
|
+
# @option params [required, String] :name
|
409
|
+
#
|
410
|
+
# @option params [required, Types::S3JobDefinition] :s3_job_definition
|
411
|
+
# Specifies which S3 buckets contain the objects that a classification
|
412
|
+
# job analyzes, and the scope of that analysis.
|
413
|
+
#
|
414
|
+
# @option params [Integer] :sampling_percentage
|
415
|
+
#
|
416
|
+
# @option params [Types::JobScheduleFrequency] :schedule_frequency
|
417
|
+
# Specifies the recurrence pattern for running a classification job.
|
418
|
+
#
|
419
|
+
# @option params [Hash<String,String>] :tags
|
420
|
+
# A string-to-string map of key-value pairs that specifies the tags
|
421
|
+
# (keys and values) for a classification job, custom data identifier,
|
422
|
+
# findings filter, or member account.
|
423
|
+
#
|
424
|
+
# @return [Types::CreateClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
425
|
+
#
|
426
|
+
# * {Types::CreateClassificationJobResponse#job_arn #job_arn} => String
|
427
|
+
# * {Types::CreateClassificationJobResponse#job_id #job_id} => String
|
428
|
+
#
|
429
|
+
# @example Request syntax with placeholder values
|
430
|
+
#
|
431
|
+
# resp = client.create_classification_job({
|
432
|
+
# client_token: "__string", # required
|
433
|
+
# custom_data_identifier_ids: ["__string"],
|
434
|
+
# description: "__string",
|
435
|
+
# initial_run: false,
|
436
|
+
# job_type: "ONE_TIME", # required, accepts ONE_TIME, SCHEDULED
|
437
|
+
# name: "__string", # required
|
438
|
+
# s3_job_definition: { # required
|
439
|
+
# bucket_definitions: [
|
440
|
+
# {
|
441
|
+
# account_id: "__string",
|
442
|
+
# buckets: ["__string"],
|
443
|
+
# },
|
444
|
+
# ],
|
445
|
+
# scoping: {
|
446
|
+
# excludes: {
|
447
|
+
# and: [
|
448
|
+
# {
|
449
|
+
# simple_scope_term: {
|
450
|
+
# comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
|
451
|
+
# key: "BUCKET_CREATION_DATE", # accepts BUCKET_CREATION_DATE, OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, TAG
|
452
|
+
# values: ["__string"],
|
453
|
+
# },
|
454
|
+
# tag_scope_term: {
|
455
|
+
# comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
|
456
|
+
# key: "__string",
|
457
|
+
# tag_values: [
|
458
|
+
# {
|
459
|
+
# key: "__string",
|
460
|
+
# value: "__string",
|
461
|
+
# },
|
462
|
+
# ],
|
463
|
+
# target: "S3_OBJECT", # accepts S3_OBJECT
|
464
|
+
# },
|
465
|
+
# },
|
466
|
+
# ],
|
467
|
+
# },
|
468
|
+
# includes: {
|
469
|
+
# and: [
|
470
|
+
# {
|
471
|
+
# simple_scope_term: {
|
472
|
+
# comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
|
473
|
+
# key: "BUCKET_CREATION_DATE", # accepts BUCKET_CREATION_DATE, OBJECT_EXTENSION, OBJECT_LAST_MODIFIED_DATE, OBJECT_SIZE, TAG
|
474
|
+
# values: ["__string"],
|
475
|
+
# },
|
476
|
+
# tag_scope_term: {
|
477
|
+
# comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
|
478
|
+
# key: "__string",
|
479
|
+
# tag_values: [
|
480
|
+
# {
|
481
|
+
# key: "__string",
|
482
|
+
# value: "__string",
|
483
|
+
# },
|
484
|
+
# ],
|
485
|
+
# target: "S3_OBJECT", # accepts S3_OBJECT
|
486
|
+
# },
|
487
|
+
# },
|
488
|
+
# ],
|
489
|
+
# },
|
490
|
+
# },
|
491
|
+
# },
|
492
|
+
# sampling_percentage: 1,
|
493
|
+
# schedule_frequency: {
|
494
|
+
# daily_schedule: {
|
495
|
+
# },
|
496
|
+
# monthly_schedule: {
|
497
|
+
# day_of_month: 1,
|
498
|
+
# },
|
499
|
+
# weekly_schedule: {
|
500
|
+
# day_of_week: "SUNDAY", # accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
|
501
|
+
# },
|
502
|
+
# },
|
503
|
+
# tags: {
|
504
|
+
# "__string" => "__string",
|
505
|
+
# },
|
506
|
+
# })
|
507
|
+
#
|
508
|
+
# @example Response structure
|
509
|
+
#
|
510
|
+
# resp.job_arn #=> String
|
511
|
+
# resp.job_id #=> String
|
512
|
+
#
|
513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/CreateClassificationJob AWS API Documentation
|
514
|
+
#
|
515
|
+
# @overload create_classification_job(params = {})
|
516
|
+
# @param [Hash] params ({})
|
517
|
+
def create_classification_job(params = {}, options = {})
|
518
|
+
req = build_request(:create_classification_job, params)
|
519
|
+
req.send_request(options)
|
520
|
+
end
|
521
|
+
|
522
|
+
# Creates and defines the criteria and other settings for a custom data
|
523
|
+
# identifier.
|
524
|
+
#
|
525
|
+
# @option params [String] :client_token
|
526
|
+
# **A suitable default value is auto-generated.** You should normally
|
527
|
+
# not need to pass this option.**
|
528
|
+
#
|
529
|
+
# @option params [String] :description
|
530
|
+
#
|
531
|
+
# @option params [Array<String>] :ignore_words
|
532
|
+
#
|
533
|
+
# @option params [Array<String>] :keywords
|
534
|
+
#
|
535
|
+
# @option params [Integer] :maximum_match_distance
|
536
|
+
#
|
537
|
+
# @option params [String] :name
|
538
|
+
#
|
539
|
+
# @option params [String] :regex
|
540
|
+
#
|
541
|
+
# @option params [Hash<String,String>] :tags
|
542
|
+
# A string-to-string map of key-value pairs that specifies the tags
|
543
|
+
# (keys and values) for a classification job, custom data identifier,
|
544
|
+
# findings filter, or member account.
|
545
|
+
#
|
546
|
+
# @return [Types::CreateCustomDataIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
547
|
+
#
|
548
|
+
# * {Types::CreateCustomDataIdentifierResponse#custom_data_identifier_id #custom_data_identifier_id} => String
|
549
|
+
#
|
550
|
+
# @example Request syntax with placeholder values
|
551
|
+
#
|
552
|
+
# resp = client.create_custom_data_identifier({
|
553
|
+
# client_token: "__string",
|
554
|
+
# description: "__string",
|
555
|
+
# ignore_words: ["__string"],
|
556
|
+
# keywords: ["__string"],
|
557
|
+
# maximum_match_distance: 1,
|
558
|
+
# name: "__string",
|
559
|
+
# regex: "__string",
|
560
|
+
# tags: {
|
561
|
+
# "__string" => "__string",
|
562
|
+
# },
|
563
|
+
# })
|
564
|
+
#
|
565
|
+
# @example Response structure
|
566
|
+
#
|
567
|
+
# resp.custom_data_identifier_id #=> String
|
568
|
+
#
|
569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/CreateCustomDataIdentifier AWS API Documentation
|
570
|
+
#
|
571
|
+
# @overload create_custom_data_identifier(params = {})
|
572
|
+
# @param [Hash] params ({})
|
573
|
+
def create_custom_data_identifier(params = {}, options = {})
|
574
|
+
req = build_request(:create_custom_data_identifier, params)
|
575
|
+
req.send_request(options)
|
576
|
+
end
|
577
|
+
|
578
|
+
# Creates and defines the criteria and other settings for a findings
|
579
|
+
# filter.
|
580
|
+
#
|
581
|
+
# @option params [required, String] :action
|
582
|
+
# The action to perform on findings that meet the filter criteria. Valid
|
583
|
+
# values are:
|
584
|
+
#
|
585
|
+
# @option params [String] :client_token
|
586
|
+
# **A suitable default value is auto-generated.** You should normally
|
587
|
+
# not need to pass this option.**
|
588
|
+
#
|
589
|
+
# @option params [String] :description
|
590
|
+
#
|
591
|
+
# @option params [required, Types::FindingCriteria] :finding_criteria
|
592
|
+
# Specifies, as a map, one or more property-based conditions that filter
|
593
|
+
# the results of a query for findings.
|
594
|
+
#
|
595
|
+
# @option params [required, String] :name
|
596
|
+
#
|
597
|
+
# @option params [Integer] :position
|
598
|
+
#
|
599
|
+
# @option params [Hash<String,String>] :tags
|
600
|
+
# A string-to-string map of key-value pairs that specifies the tags
|
601
|
+
# (keys and values) for a classification job, custom data identifier,
|
602
|
+
# findings filter, or member account.
|
603
|
+
#
|
604
|
+
# @return [Types::CreateFindingsFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
605
|
+
#
|
606
|
+
# * {Types::CreateFindingsFilterResponse#arn #arn} => String
|
607
|
+
# * {Types::CreateFindingsFilterResponse#id #id} => String
|
608
|
+
#
|
609
|
+
# @example Request syntax with placeholder values
|
610
|
+
#
|
611
|
+
# resp = client.create_findings_filter({
|
612
|
+
# action: "ARCHIVE", # required, accepts ARCHIVE, NOOP
|
613
|
+
# client_token: "__string",
|
614
|
+
# description: "__string",
|
615
|
+
# finding_criteria: { # required
|
616
|
+
# criterion: {
|
617
|
+
# "__string" => {
|
618
|
+
# eq: ["__string"],
|
619
|
+
# gt: 1,
|
620
|
+
# gte: 1,
|
621
|
+
# lt: 1,
|
622
|
+
# lte: 1,
|
623
|
+
# neq: ["__string"],
|
624
|
+
# },
|
625
|
+
# },
|
626
|
+
# },
|
627
|
+
# name: "__string", # required
|
628
|
+
# position: 1,
|
629
|
+
# tags: {
|
630
|
+
# "__string" => "__string",
|
631
|
+
# },
|
632
|
+
# })
|
633
|
+
#
|
634
|
+
# @example Response structure
|
635
|
+
#
|
636
|
+
# resp.arn #=> String
|
637
|
+
# resp.id #=> String
|
638
|
+
#
|
639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/CreateFindingsFilter AWS API Documentation
|
640
|
+
#
|
641
|
+
# @overload create_findings_filter(params = {})
|
642
|
+
# @param [Hash] params ({})
|
643
|
+
def create_findings_filter(params = {}, options = {})
|
644
|
+
req = build_request(:create_findings_filter, params)
|
645
|
+
req.send_request(options)
|
646
|
+
end
|
647
|
+
|
648
|
+
# Sends an Amazon Macie membership invitation to one or more accounts.
|
649
|
+
#
|
650
|
+
# @option params [required, Array<String>] :account_ids
|
651
|
+
#
|
652
|
+
# @option params [Boolean] :disable_email_notification
|
653
|
+
#
|
654
|
+
# @option params [String] :message
|
655
|
+
#
|
656
|
+
# @return [Types::CreateInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
657
|
+
#
|
658
|
+
# * {Types::CreateInvitationsResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
|
659
|
+
#
|
660
|
+
# @example Request syntax with placeholder values
|
661
|
+
#
|
662
|
+
# resp = client.create_invitations({
|
663
|
+
# account_ids: ["__string"], # required
|
664
|
+
# disable_email_notification: false,
|
665
|
+
# message: "__string",
|
666
|
+
# })
|
667
|
+
#
|
668
|
+
# @example Response structure
|
669
|
+
#
|
670
|
+
# resp.unprocessed_accounts #=> Array
|
671
|
+
# resp.unprocessed_accounts[0].account_id #=> String
|
672
|
+
# resp.unprocessed_accounts[0].error_code #=> String, one of "ClientError", "InternalError"
|
673
|
+
# resp.unprocessed_accounts[0].error_message #=> String
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/CreateInvitations AWS API Documentation
|
676
|
+
#
|
677
|
+
# @overload create_invitations(params = {})
|
678
|
+
# @param [Hash] params ({})
|
679
|
+
def create_invitations(params = {}, options = {})
|
680
|
+
req = build_request(:create_invitations, params)
|
681
|
+
req.send_request(options)
|
682
|
+
end
|
683
|
+
|
684
|
+
# Associates an account with an Amazon Macie master account.
|
685
|
+
#
|
686
|
+
# @option params [required, Types::AccountDetail] :account
|
687
|
+
# Specifies details for an account to associate with an Amazon Macie
|
688
|
+
# master account.
|
689
|
+
#
|
690
|
+
# @option params [Hash<String,String>] :tags
|
691
|
+
# A string-to-string map of key-value pairs that specifies the tags
|
692
|
+
# (keys and values) for a classification job, custom data identifier,
|
693
|
+
# findings filter, or member account.
|
694
|
+
#
|
695
|
+
# @return [Types::CreateMemberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
696
|
+
#
|
697
|
+
# * {Types::CreateMemberResponse#arn #arn} => String
|
698
|
+
#
|
699
|
+
# @example Request syntax with placeholder values
|
700
|
+
#
|
701
|
+
# resp = client.create_member({
|
702
|
+
# account: { # required
|
703
|
+
# account_id: "__string", # required
|
704
|
+
# email: "__string", # required
|
705
|
+
# },
|
706
|
+
# tags: {
|
707
|
+
# "__string" => "__string",
|
708
|
+
# },
|
709
|
+
# })
|
710
|
+
#
|
711
|
+
# @example Response structure
|
712
|
+
#
|
713
|
+
# resp.arn #=> String
|
714
|
+
#
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/CreateMember AWS API Documentation
|
716
|
+
#
|
717
|
+
# @overload create_member(params = {})
|
718
|
+
# @param [Hash] params ({})
|
719
|
+
def create_member(params = {}, options = {})
|
720
|
+
req = build_request(:create_member, params)
|
721
|
+
req.send_request(options)
|
722
|
+
end
|
723
|
+
|
724
|
+
# Creates sample findings.
|
725
|
+
#
|
726
|
+
# @option params [Array<String>] :finding_types
|
727
|
+
#
|
728
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
729
|
+
#
|
730
|
+
# @example Request syntax with placeholder values
|
731
|
+
#
|
732
|
+
# resp = client.create_sample_findings({
|
733
|
+
# finding_types: ["SensitiveData:S3Object/Multiple"], # accepts SensitiveData:S3Object/Multiple, SensitiveData:S3Object/Financial, SensitiveData:S3Object/Personal, SensitiveData:S3Object/Credentials, SensitiveData:S3Object/CustomIdentifier, Policy:IAMUser/S3BucketPublic, Policy:IAMUser/S3BucketSharedExternally, Policy:IAMUser/S3BucketReplicatedExternally, Policy:IAMUser/S3BucketEncryptionDisabled, Policy:IAMUser/S3BlockPublicAccessDisabled
|
734
|
+
# })
|
735
|
+
#
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/CreateSampleFindings AWS API Documentation
|
737
|
+
#
|
738
|
+
# @overload create_sample_findings(params = {})
|
739
|
+
# @param [Hash] params ({})
|
740
|
+
def create_sample_findings(params = {}, options = {})
|
741
|
+
req = build_request(:create_sample_findings, params)
|
742
|
+
req.send_request(options)
|
743
|
+
end
|
744
|
+
|
745
|
+
# Declines Amazon Macie membership invitations that were received from
|
746
|
+
# specific accounts.
|
747
|
+
#
|
748
|
+
# @option params [required, Array<String>] :account_ids
|
749
|
+
#
|
750
|
+
# @return [Types::DeclineInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
751
|
+
#
|
752
|
+
# * {Types::DeclineInvitationsResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
|
753
|
+
#
|
754
|
+
# @example Request syntax with placeholder values
|
755
|
+
#
|
756
|
+
# resp = client.decline_invitations({
|
757
|
+
# account_ids: ["__string"], # required
|
758
|
+
# })
|
759
|
+
#
|
760
|
+
# @example Response structure
|
761
|
+
#
|
762
|
+
# resp.unprocessed_accounts #=> Array
|
763
|
+
# resp.unprocessed_accounts[0].account_id #=> String
|
764
|
+
# resp.unprocessed_accounts[0].error_code #=> String, one of "ClientError", "InternalError"
|
765
|
+
# resp.unprocessed_accounts[0].error_message #=> String
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DeclineInvitations AWS API Documentation
|
768
|
+
#
|
769
|
+
# @overload decline_invitations(params = {})
|
770
|
+
# @param [Hash] params ({})
|
771
|
+
def decline_invitations(params = {}, options = {})
|
772
|
+
req = build_request(:decline_invitations, params)
|
773
|
+
req.send_request(options)
|
774
|
+
end
|
775
|
+
|
776
|
+
# Deletes a custom data identifier.
|
777
|
+
#
|
778
|
+
# @option params [required, String] :id
|
779
|
+
#
|
780
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
781
|
+
#
|
782
|
+
# @example Request syntax with placeholder values
|
783
|
+
#
|
784
|
+
# resp = client.delete_custom_data_identifier({
|
785
|
+
# id: "__string", # required
|
786
|
+
# })
|
787
|
+
#
|
788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DeleteCustomDataIdentifier AWS API Documentation
|
789
|
+
#
|
790
|
+
# @overload delete_custom_data_identifier(params = {})
|
791
|
+
# @param [Hash] params ({})
|
792
|
+
def delete_custom_data_identifier(params = {}, options = {})
|
793
|
+
req = build_request(:delete_custom_data_identifier, params)
|
794
|
+
req.send_request(options)
|
795
|
+
end
|
796
|
+
|
797
|
+
# Deletes a findings filter.
|
798
|
+
#
|
799
|
+
# @option params [required, String] :id
|
800
|
+
#
|
801
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
802
|
+
#
|
803
|
+
# @example Request syntax with placeholder values
|
804
|
+
#
|
805
|
+
# resp = client.delete_findings_filter({
|
806
|
+
# id: "__string", # required
|
807
|
+
# })
|
808
|
+
#
|
809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DeleteFindingsFilter AWS API Documentation
|
810
|
+
#
|
811
|
+
# @overload delete_findings_filter(params = {})
|
812
|
+
# @param [Hash] params ({})
|
813
|
+
def delete_findings_filter(params = {}, options = {})
|
814
|
+
req = build_request(:delete_findings_filter, params)
|
815
|
+
req.send_request(options)
|
816
|
+
end
|
817
|
+
|
818
|
+
# Deletes Amazon Macie membership invitations that were received from
|
819
|
+
# specific accounts.
|
820
|
+
#
|
821
|
+
# @option params [required, Array<String>] :account_ids
|
822
|
+
#
|
823
|
+
# @return [Types::DeleteInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
824
|
+
#
|
825
|
+
# * {Types::DeleteInvitationsResponse#unprocessed_accounts #unprocessed_accounts} => Array<Types::UnprocessedAccount>
|
826
|
+
#
|
827
|
+
# @example Request syntax with placeholder values
|
828
|
+
#
|
829
|
+
# resp = client.delete_invitations({
|
830
|
+
# account_ids: ["__string"], # required
|
831
|
+
# })
|
832
|
+
#
|
833
|
+
# @example Response structure
|
834
|
+
#
|
835
|
+
# resp.unprocessed_accounts #=> Array
|
836
|
+
# resp.unprocessed_accounts[0].account_id #=> String
|
837
|
+
# resp.unprocessed_accounts[0].error_code #=> String, one of "ClientError", "InternalError"
|
838
|
+
# resp.unprocessed_accounts[0].error_message #=> String
|
839
|
+
#
|
840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DeleteInvitations AWS API Documentation
|
841
|
+
#
|
842
|
+
# @overload delete_invitations(params = {})
|
843
|
+
# @param [Hash] params ({})
|
844
|
+
def delete_invitations(params = {}, options = {})
|
845
|
+
req = build_request(:delete_invitations, params)
|
846
|
+
req.send_request(options)
|
847
|
+
end
|
848
|
+
|
849
|
+
# Deletes the association between an Amazon Macie master account and an
|
850
|
+
# account.
|
851
|
+
#
|
852
|
+
# @option params [required, String] :id
|
853
|
+
#
|
854
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
855
|
+
#
|
856
|
+
# @example Request syntax with placeholder values
|
857
|
+
#
|
858
|
+
# resp = client.delete_member({
|
859
|
+
# id: "__string", # required
|
860
|
+
# })
|
861
|
+
#
|
862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DeleteMember AWS API Documentation
|
863
|
+
#
|
864
|
+
# @overload delete_member(params = {})
|
865
|
+
# @param [Hash] params ({})
|
866
|
+
def delete_member(params = {}, options = {})
|
867
|
+
req = build_request(:delete_member, params)
|
868
|
+
req.send_request(options)
|
869
|
+
end
|
870
|
+
|
871
|
+
# Retrieves (queries) statistical data and other information about one
|
872
|
+
# or more S3 buckets that Amazon Macie monitors and analyzes.
|
873
|
+
#
|
874
|
+
# @option params [Hash<String,Types::BucketCriteriaAdditionalProperties>] :criteria
|
875
|
+
# Specifies, as a map, one or more attribute-based conditions that
|
876
|
+
# filter the results of a query for information about S3 buckets.
|
877
|
+
#
|
878
|
+
# @option params [Integer] :max_results
|
879
|
+
#
|
880
|
+
# @option params [String] :next_token
|
881
|
+
#
|
882
|
+
# @option params [Types::BucketSortCriteria] :sort_criteria
|
883
|
+
# Specifies criteria for sorting the results of a query for information
|
884
|
+
# about S3 buckets.
|
885
|
+
#
|
886
|
+
# @return [Types::DescribeBucketsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
887
|
+
#
|
888
|
+
# * {Types::DescribeBucketsResponse#buckets #buckets} => Array<Types::BucketMetadata>
|
889
|
+
# * {Types::DescribeBucketsResponse#next_token #next_token} => String
|
890
|
+
#
|
891
|
+
# @example Request syntax with placeholder values
|
892
|
+
#
|
893
|
+
# resp = client.describe_buckets({
|
894
|
+
# criteria: {
|
895
|
+
# "__string" => {
|
896
|
+
# eq: ["__string"],
|
897
|
+
# gt: 1,
|
898
|
+
# gte: 1,
|
899
|
+
# lt: 1,
|
900
|
+
# lte: 1,
|
901
|
+
# neq: ["__string"],
|
902
|
+
# prefix: "__string",
|
903
|
+
# },
|
904
|
+
# },
|
905
|
+
# max_results: 1,
|
906
|
+
# next_token: "__string",
|
907
|
+
# sort_criteria: {
|
908
|
+
# attribute_name: "__string",
|
909
|
+
# order_by: "ASC", # accepts ASC, DESC
|
910
|
+
# },
|
911
|
+
# })
|
912
|
+
#
|
913
|
+
# @example Response structure
|
914
|
+
#
|
915
|
+
# resp.buckets #=> Array
|
916
|
+
# resp.buckets[0].account_id #=> String
|
917
|
+
# resp.buckets[0].bucket_arn #=> String
|
918
|
+
# resp.buckets[0].bucket_created_at #=> Time
|
919
|
+
# resp.buckets[0].bucket_name #=> String
|
920
|
+
# resp.buckets[0].classifiable_object_count #=> Integer
|
921
|
+
# resp.buckets[0].last_updated #=> Time
|
922
|
+
# resp.buckets[0].object_count #=> Integer
|
923
|
+
# resp.buckets[0].object_count_by_encryption_type.customer_managed #=> Integer
|
924
|
+
# resp.buckets[0].object_count_by_encryption_type.kms_managed #=> Integer
|
925
|
+
# resp.buckets[0].object_count_by_encryption_type.s3_managed #=> Integer
|
926
|
+
# resp.buckets[0].object_count_by_encryption_type.unencrypted #=> Integer
|
927
|
+
# resp.buckets[0].public_access.effective_permission #=> String, one of "PUBLIC", "NOT_PUBLIC"
|
928
|
+
# resp.buckets[0].public_access.permission_configuration.account_level_permissions.block_public_access.block_public_acls #=> Boolean
|
929
|
+
# resp.buckets[0].public_access.permission_configuration.account_level_permissions.block_public_access.block_public_policy #=> Boolean
|
930
|
+
# resp.buckets[0].public_access.permission_configuration.account_level_permissions.block_public_access.ignore_public_acls #=> Boolean
|
931
|
+
# resp.buckets[0].public_access.permission_configuration.account_level_permissions.block_public_access.restrict_public_buckets #=> Boolean
|
932
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.access_control_list.allows_public_read_access #=> Boolean
|
933
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.access_control_list.allows_public_write_access #=> Boolean
|
934
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.block_public_access.block_public_acls #=> Boolean
|
935
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.block_public_access.block_public_policy #=> Boolean
|
936
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.block_public_access.ignore_public_acls #=> Boolean
|
937
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.block_public_access.restrict_public_buckets #=> Boolean
|
938
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.bucket_policy.allows_public_read_access #=> Boolean
|
939
|
+
# resp.buckets[0].public_access.permission_configuration.bucket_level_permissions.bucket_policy.allows_public_write_access #=> Boolean
|
940
|
+
# resp.buckets[0].region #=> String
|
941
|
+
# resp.buckets[0].replication_details.replicated #=> Boolean
|
942
|
+
# resp.buckets[0].replication_details.replicated_externally #=> Boolean
|
943
|
+
# resp.buckets[0].replication_details.replication_accounts #=> Array
|
944
|
+
# resp.buckets[0].replication_details.replication_accounts[0] #=> String
|
945
|
+
# resp.buckets[0].shared_access #=> String, one of "EXTERNAL", "INTERNAL", "NOT_SHARED"
|
946
|
+
# resp.buckets[0].size_in_bytes #=> Integer
|
947
|
+
# resp.buckets[0].size_in_bytes_compressed #=> Integer
|
948
|
+
# resp.buckets[0].tags #=> Array
|
949
|
+
# resp.buckets[0].tags[0].key #=> String
|
950
|
+
# resp.buckets[0].tags[0].value #=> String
|
951
|
+
# resp.buckets[0].versioning #=> Boolean
|
952
|
+
# resp.next_token #=> String
|
953
|
+
#
|
954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DescribeBuckets AWS API Documentation
|
955
|
+
#
|
956
|
+
# @overload describe_buckets(params = {})
|
957
|
+
# @param [Hash] params ({})
|
958
|
+
def describe_buckets(params = {}, options = {})
|
959
|
+
req = build_request(:describe_buckets, params)
|
960
|
+
req.send_request(options)
|
961
|
+
end
|
962
|
+
|
963
|
+
# Retrieves information about the status and settings for a
|
964
|
+
# classification job.
|
965
|
+
#
|
966
|
+
# @option params [required, String] :job_id
|
967
|
+
#
|
968
|
+
# @return [Types::DescribeClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
969
|
+
#
|
970
|
+
# * {Types::DescribeClassificationJobResponse#client_token #client_token} => String
|
971
|
+
# * {Types::DescribeClassificationJobResponse#created_at #created_at} => Time
|
972
|
+
# * {Types::DescribeClassificationJobResponse#custom_data_identifier_ids #custom_data_identifier_ids} => Array<String>
|
973
|
+
# * {Types::DescribeClassificationJobResponse#description #description} => String
|
974
|
+
# * {Types::DescribeClassificationJobResponse#initial_run #initial_run} => Boolean
|
975
|
+
# * {Types::DescribeClassificationJobResponse#job_arn #job_arn} => String
|
976
|
+
# * {Types::DescribeClassificationJobResponse#job_id #job_id} => String
|
977
|
+
# * {Types::DescribeClassificationJobResponse#job_status #job_status} => String
|
978
|
+
# * {Types::DescribeClassificationJobResponse#job_type #job_type} => String
|
979
|
+
# * {Types::DescribeClassificationJobResponse#last_run_time #last_run_time} => Time
|
980
|
+
# * {Types::DescribeClassificationJobResponse#name #name} => String
|
981
|
+
# * {Types::DescribeClassificationJobResponse#s3_job_definition #s3_job_definition} => Types::S3JobDefinition
|
982
|
+
# * {Types::DescribeClassificationJobResponse#sampling_percentage #sampling_percentage} => Integer
|
983
|
+
# * {Types::DescribeClassificationJobResponse#schedule_frequency #schedule_frequency} => Types::JobScheduleFrequency
|
984
|
+
# * {Types::DescribeClassificationJobResponse#statistics #statistics} => Types::Statistics
|
985
|
+
# * {Types::DescribeClassificationJobResponse#tags #tags} => Hash<String,String>
|
986
|
+
#
|
987
|
+
# @example Request syntax with placeholder values
|
988
|
+
#
|
989
|
+
# resp = client.describe_classification_job({
|
990
|
+
# job_id: "__string", # required
|
991
|
+
# })
|
992
|
+
#
|
993
|
+
# @example Response structure
|
994
|
+
#
|
995
|
+
# resp.client_token #=> String
|
996
|
+
# resp.created_at #=> Time
|
997
|
+
# resp.custom_data_identifier_ids #=> Array
|
998
|
+
# resp.custom_data_identifier_ids[0] #=> String
|
999
|
+
# resp.description #=> String
|
1000
|
+
# resp.initial_run #=> Boolean
|
1001
|
+
# resp.job_arn #=> String
|
1002
|
+
# resp.job_id #=> String
|
1003
|
+
# resp.job_status #=> String, one of "RUNNING", "PAUSED", "CANCELLED", "COMPLETE", "IDLE"
|
1004
|
+
# resp.job_type #=> String, one of "ONE_TIME", "SCHEDULED"
|
1005
|
+
# resp.last_run_time #=> Time
|
1006
|
+
# resp.name #=> String
|
1007
|
+
# resp.s3_job_definition.bucket_definitions #=> Array
|
1008
|
+
# resp.s3_job_definition.bucket_definitions[0].account_id #=> String
|
1009
|
+
# resp.s3_job_definition.bucket_definitions[0].buckets #=> Array
|
1010
|
+
# resp.s3_job_definition.bucket_definitions[0].buckets[0] #=> String
|
1011
|
+
# resp.s3_job_definition.scoping.excludes.and #=> Array
|
1012
|
+
# resp.s3_job_definition.scoping.excludes.and[0].simple_scope_term.comparator #=> String, one of "EQ", "GT", "GTE", "LT", "LTE", "NE", "CONTAINS"
|
1013
|
+
# resp.s3_job_definition.scoping.excludes.and[0].simple_scope_term.key #=> String, one of "BUCKET_CREATION_DATE", "OBJECT_EXTENSION", "OBJECT_LAST_MODIFIED_DATE", "OBJECT_SIZE", "TAG"
|
1014
|
+
# resp.s3_job_definition.scoping.excludes.and[0].simple_scope_term.values #=> Array
|
1015
|
+
# resp.s3_job_definition.scoping.excludes.and[0].simple_scope_term.values[0] #=> String
|
1016
|
+
# resp.s3_job_definition.scoping.excludes.and[0].tag_scope_term.comparator #=> String, one of "EQ", "GT", "GTE", "LT", "LTE", "NE", "CONTAINS"
|
1017
|
+
# resp.s3_job_definition.scoping.excludes.and[0].tag_scope_term.key #=> String
|
1018
|
+
# resp.s3_job_definition.scoping.excludes.and[0].tag_scope_term.tag_values #=> Array
|
1019
|
+
# resp.s3_job_definition.scoping.excludes.and[0].tag_scope_term.tag_values[0].key #=> String
|
1020
|
+
# resp.s3_job_definition.scoping.excludes.and[0].tag_scope_term.tag_values[0].value #=> String
|
1021
|
+
# resp.s3_job_definition.scoping.excludes.and[0].tag_scope_term.target #=> String, one of "S3_OBJECT"
|
1022
|
+
# resp.s3_job_definition.scoping.includes.and #=> Array
|
1023
|
+
# resp.s3_job_definition.scoping.includes.and[0].simple_scope_term.comparator #=> String, one of "EQ", "GT", "GTE", "LT", "LTE", "NE", "CONTAINS"
|
1024
|
+
# resp.s3_job_definition.scoping.includes.and[0].simple_scope_term.key #=> String, one of "BUCKET_CREATION_DATE", "OBJECT_EXTENSION", "OBJECT_LAST_MODIFIED_DATE", "OBJECT_SIZE", "TAG"
|
1025
|
+
# resp.s3_job_definition.scoping.includes.and[0].simple_scope_term.values #=> Array
|
1026
|
+
# resp.s3_job_definition.scoping.includes.and[0].simple_scope_term.values[0] #=> String
|
1027
|
+
# resp.s3_job_definition.scoping.includes.and[0].tag_scope_term.comparator #=> String, one of "EQ", "GT", "GTE", "LT", "LTE", "NE", "CONTAINS"
|
1028
|
+
# resp.s3_job_definition.scoping.includes.and[0].tag_scope_term.key #=> String
|
1029
|
+
# resp.s3_job_definition.scoping.includes.and[0].tag_scope_term.tag_values #=> Array
|
1030
|
+
# resp.s3_job_definition.scoping.includes.and[0].tag_scope_term.tag_values[0].key #=> String
|
1031
|
+
# resp.s3_job_definition.scoping.includes.and[0].tag_scope_term.tag_values[0].value #=> String
|
1032
|
+
# resp.s3_job_definition.scoping.includes.and[0].tag_scope_term.target #=> String, one of "S3_OBJECT"
|
1033
|
+
# resp.sampling_percentage #=> Integer
|
1034
|
+
# resp.schedule_frequency.monthly_schedule.day_of_month #=> Integer
|
1035
|
+
# resp.schedule_frequency.weekly_schedule.day_of_week #=> String, one of "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"
|
1036
|
+
# resp.statistics.approximate_number_of_objects_to_process #=> Float
|
1037
|
+
# resp.statistics.number_of_runs #=> Float
|
1038
|
+
# resp.tags #=> Hash
|
1039
|
+
# resp.tags["__string"] #=> String
|
1040
|
+
#
|
1041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DescribeClassificationJob AWS API Documentation
|
1042
|
+
#
|
1043
|
+
# @overload describe_classification_job(params = {})
|
1044
|
+
# @param [Hash] params ({})
|
1045
|
+
def describe_classification_job(params = {}, options = {})
|
1046
|
+
req = build_request(:describe_classification_job, params)
|
1047
|
+
req.send_request(options)
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# Retrieves information about the Amazon Macie configuration settings
|
1051
|
+
# for an AWS organization.
|
1052
|
+
#
|
1053
|
+
# @return [Types::DescribeOrganizationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1054
|
+
#
|
1055
|
+
# * {Types::DescribeOrganizationConfigurationResponse#auto_enable #auto_enable} => Boolean
|
1056
|
+
# * {Types::DescribeOrganizationConfigurationResponse#max_account_limit_reached #max_account_limit_reached} => Boolean
|
1057
|
+
#
|
1058
|
+
# @example Response structure
|
1059
|
+
#
|
1060
|
+
# resp.auto_enable #=> Boolean
|
1061
|
+
# resp.max_account_limit_reached #=> Boolean
|
1062
|
+
#
|
1063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DescribeOrganizationConfiguration AWS API Documentation
|
1064
|
+
#
|
1065
|
+
# @overload describe_organization_configuration(params = {})
|
1066
|
+
# @param [Hash] params ({})
|
1067
|
+
def describe_organization_configuration(params = {}, options = {})
|
1068
|
+
req = build_request(:describe_organization_configuration, params)
|
1069
|
+
req.send_request(options)
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Disables an Amazon Macie account and deletes Macie resources for the
|
1073
|
+
# account.
|
1074
|
+
#
|
1075
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1076
|
+
#
|
1077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DisableMacie AWS API Documentation
|
1078
|
+
#
|
1079
|
+
# @overload disable_macie(params = {})
|
1080
|
+
# @param [Hash] params ({})
|
1081
|
+
def disable_macie(params = {}, options = {})
|
1082
|
+
req = build_request(:disable_macie, params)
|
1083
|
+
req.send_request(options)
|
1084
|
+
end
|
1085
|
+
|
1086
|
+
# Disables an account as a delegated administrator of Amazon Macie for
|
1087
|
+
# an AWS organization.
|
1088
|
+
#
|
1089
|
+
# @option params [required, String] :admin_account_id
|
1090
|
+
#
|
1091
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1092
|
+
#
|
1093
|
+
# @example Request syntax with placeholder values
|
1094
|
+
#
|
1095
|
+
# resp = client.disable_organization_admin_account({
|
1096
|
+
# admin_account_id: "__string", # required
|
1097
|
+
# })
|
1098
|
+
#
|
1099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DisableOrganizationAdminAccount AWS API Documentation
|
1100
|
+
#
|
1101
|
+
# @overload disable_organization_admin_account(params = {})
|
1102
|
+
# @param [Hash] params ({})
|
1103
|
+
def disable_organization_admin_account(params = {}, options = {})
|
1104
|
+
req = build_request(:disable_organization_admin_account, params)
|
1105
|
+
req.send_request(options)
|
1106
|
+
end
|
1107
|
+
|
1108
|
+
# Disassociates a member account from its Amazon Macie master account.
|
1109
|
+
#
|
1110
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1111
|
+
#
|
1112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DisassociateFromMasterAccount AWS API Documentation
|
1113
|
+
#
|
1114
|
+
# @overload disassociate_from_master_account(params = {})
|
1115
|
+
# @param [Hash] params ({})
|
1116
|
+
def disassociate_from_master_account(params = {}, options = {})
|
1117
|
+
req = build_request(:disassociate_from_master_account, params)
|
1118
|
+
req.send_request(options)
|
1119
|
+
end
|
1120
|
+
|
1121
|
+
# Disassociates an Amazon Macie master account from a member account.
|
1122
|
+
#
|
1123
|
+
# @option params [required, String] :id
|
1124
|
+
#
|
1125
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1126
|
+
#
|
1127
|
+
# @example Request syntax with placeholder values
|
1128
|
+
#
|
1129
|
+
# resp = client.disassociate_member({
|
1130
|
+
# id: "__string", # required
|
1131
|
+
# })
|
1132
|
+
#
|
1133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/DisassociateMember AWS API Documentation
|
1134
|
+
#
|
1135
|
+
# @overload disassociate_member(params = {})
|
1136
|
+
# @param [Hash] params ({})
|
1137
|
+
def disassociate_member(params = {}, options = {})
|
1138
|
+
req = build_request(:disassociate_member, params)
|
1139
|
+
req.send_request(options)
|
1140
|
+
end
|
1141
|
+
|
1142
|
+
# Enables Amazon Macie and specifies the configuration settings for a
|
1143
|
+
# Macie account.
|
1144
|
+
#
|
1145
|
+
# @option params [String] :client_token
|
1146
|
+
# **A suitable default value is auto-generated.** You should normally
|
1147
|
+
# not need to pass this option.**
|
1148
|
+
#
|
1149
|
+
# @option params [String] :finding_publishing_frequency
|
1150
|
+
# The frequency with which Amazon Macie publishes findings for an
|
1151
|
+
# account. This includes adding findings to AWS Security Hub and
|
1152
|
+
# exporting finding events to Amazon CloudWatch. Valid values are:
|
1153
|
+
#
|
1154
|
+
# @option params [String] :status
|
1155
|
+
# The status of an Amazon Macie account. Valid values are:
|
1156
|
+
#
|
1157
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1158
|
+
#
|
1159
|
+
# @example Request syntax with placeholder values
|
1160
|
+
#
|
1161
|
+
# resp = client.enable_macie({
|
1162
|
+
# client_token: "__string",
|
1163
|
+
# finding_publishing_frequency: "FIFTEEN_MINUTES", # accepts FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS
|
1164
|
+
# status: "PAUSED", # accepts PAUSED, ENABLED
|
1165
|
+
# })
|
1166
|
+
#
|
1167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/EnableMacie AWS API Documentation
|
1168
|
+
#
|
1169
|
+
# @overload enable_macie(params = {})
|
1170
|
+
# @param [Hash] params ({})
|
1171
|
+
def enable_macie(params = {}, options = {})
|
1172
|
+
req = build_request(:enable_macie, params)
|
1173
|
+
req.send_request(options)
|
1174
|
+
end
|
1175
|
+
|
1176
|
+
# Enables an account as a delegated administrator of Amazon Macie for an
|
1177
|
+
# AWS organization.
|
1178
|
+
#
|
1179
|
+
# @option params [required, String] :admin_account_id
|
1180
|
+
#
|
1181
|
+
# @option params [String] :client_token
|
1182
|
+
# **A suitable default value is auto-generated.** You should normally
|
1183
|
+
# not need to pass this option.**
|
1184
|
+
#
|
1185
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1186
|
+
#
|
1187
|
+
# @example Request syntax with placeholder values
|
1188
|
+
#
|
1189
|
+
# resp = client.enable_organization_admin_account({
|
1190
|
+
# admin_account_id: "__string", # required
|
1191
|
+
# client_token: "__string",
|
1192
|
+
# })
|
1193
|
+
#
|
1194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/EnableOrganizationAdminAccount AWS API Documentation
|
1195
|
+
#
|
1196
|
+
# @overload enable_organization_admin_account(params = {})
|
1197
|
+
# @param [Hash] params ({})
|
1198
|
+
def enable_organization_admin_account(params = {}, options = {})
|
1199
|
+
req = build_request(:enable_organization_admin_account, params)
|
1200
|
+
req.send_request(options)
|
1201
|
+
end
|
1202
|
+
|
1203
|
+
# Retrieves (queries) aggregated statistical data for all the S3 buckets
|
1204
|
+
# that Amazon Macie monitors and analyzes.
|
1205
|
+
#
|
1206
|
+
# @option params [String] :account_id
|
1207
|
+
#
|
1208
|
+
# @return [Types::GetBucketStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1209
|
+
#
|
1210
|
+
# * {Types::GetBucketStatisticsResponse#bucket_count #bucket_count} => Integer
|
1211
|
+
# * {Types::GetBucketStatisticsResponse#bucket_count_by_effective_permission #bucket_count_by_effective_permission} => Types::BucketCountByEffectivePermission
|
1212
|
+
# * {Types::GetBucketStatisticsResponse#bucket_count_by_encryption_type #bucket_count_by_encryption_type} => Types::BucketCountByEncryptionType
|
1213
|
+
# * {Types::GetBucketStatisticsResponse#bucket_count_by_shared_access_type #bucket_count_by_shared_access_type} => Types::BucketCountBySharedAccessType
|
1214
|
+
# * {Types::GetBucketStatisticsResponse#classifiable_object_count #classifiable_object_count} => Integer
|
1215
|
+
# * {Types::GetBucketStatisticsResponse#last_updated #last_updated} => Time
|
1216
|
+
# * {Types::GetBucketStatisticsResponse#object_count #object_count} => Integer
|
1217
|
+
# * {Types::GetBucketStatisticsResponse#size_in_bytes #size_in_bytes} => Integer
|
1218
|
+
# * {Types::GetBucketStatisticsResponse#size_in_bytes_compressed #size_in_bytes_compressed} => Integer
|
1219
|
+
#
|
1220
|
+
# @example Request syntax with placeholder values
|
1221
|
+
#
|
1222
|
+
# resp = client.get_bucket_statistics({
|
1223
|
+
# account_id: "__string",
|
1224
|
+
# })
|
1225
|
+
#
|
1226
|
+
# @example Response structure
|
1227
|
+
#
|
1228
|
+
# resp.bucket_count #=> Integer
|
1229
|
+
# resp.bucket_count_by_effective_permission.publicly_accessible #=> Integer
|
1230
|
+
# resp.bucket_count_by_effective_permission.publicly_readable #=> Integer
|
1231
|
+
# resp.bucket_count_by_effective_permission.publicly_writable #=> Integer
|
1232
|
+
# resp.bucket_count_by_encryption_type.kms_managed #=> Integer
|
1233
|
+
# resp.bucket_count_by_encryption_type.s3_managed #=> Integer
|
1234
|
+
# resp.bucket_count_by_encryption_type.unencrypted #=> Integer
|
1235
|
+
# resp.bucket_count_by_shared_access_type.external #=> Integer
|
1236
|
+
# resp.bucket_count_by_shared_access_type.internal #=> Integer
|
1237
|
+
# resp.bucket_count_by_shared_access_type.not_shared #=> Integer
|
1238
|
+
# resp.classifiable_object_count #=> Integer
|
1239
|
+
# resp.last_updated #=> Time
|
1240
|
+
# resp.object_count #=> Integer
|
1241
|
+
# resp.size_in_bytes #=> Integer
|
1242
|
+
# resp.size_in_bytes_compressed #=> Integer
|
1243
|
+
#
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetBucketStatistics AWS API Documentation
|
1245
|
+
#
|
1246
|
+
# @overload get_bucket_statistics(params = {})
|
1247
|
+
# @param [Hash] params ({})
|
1248
|
+
def get_bucket_statistics(params = {}, options = {})
|
1249
|
+
req = build_request(:get_bucket_statistics, params)
|
1250
|
+
req.send_request(options)
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# Retrieves the configuration settings for exporting data classification
|
1254
|
+
# results.
|
1255
|
+
#
|
1256
|
+
# @return [Types::GetClassificationExportConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1257
|
+
#
|
1258
|
+
# * {Types::GetClassificationExportConfigurationResponse#configuration #configuration} => Types::ClassificationExportConfiguration
|
1259
|
+
#
|
1260
|
+
# @example Response structure
|
1261
|
+
#
|
1262
|
+
# resp.configuration.s3_destination.bucket_name #=> String
|
1263
|
+
# resp.configuration.s3_destination.key_prefix #=> String
|
1264
|
+
# resp.configuration.s3_destination.kms_key_arn #=> String
|
1265
|
+
#
|
1266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetClassificationExportConfiguration AWS API Documentation
|
1267
|
+
#
|
1268
|
+
# @overload get_classification_export_configuration(params = {})
|
1269
|
+
# @param [Hash] params ({})
|
1270
|
+
def get_classification_export_configuration(params = {}, options = {})
|
1271
|
+
req = build_request(:get_classification_export_configuration, params)
|
1272
|
+
req.send_request(options)
|
1273
|
+
end
|
1274
|
+
|
1275
|
+
# Retrieves information about the criteria and other settings for a
|
1276
|
+
# custom data identifier.
|
1277
|
+
#
|
1278
|
+
# @option params [required, String] :id
|
1279
|
+
#
|
1280
|
+
# @return [Types::GetCustomDataIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1281
|
+
#
|
1282
|
+
# * {Types::GetCustomDataIdentifierResponse#arn #arn} => String
|
1283
|
+
# * {Types::GetCustomDataIdentifierResponse#created_at #created_at} => Time
|
1284
|
+
# * {Types::GetCustomDataIdentifierResponse#deleted #deleted} => Boolean
|
1285
|
+
# * {Types::GetCustomDataIdentifierResponse#description #description} => String
|
1286
|
+
# * {Types::GetCustomDataIdentifierResponse#id #id} => String
|
1287
|
+
# * {Types::GetCustomDataIdentifierResponse#ignore_words #ignore_words} => Array<String>
|
1288
|
+
# * {Types::GetCustomDataIdentifierResponse#keywords #keywords} => Array<String>
|
1289
|
+
# * {Types::GetCustomDataIdentifierResponse#maximum_match_distance #maximum_match_distance} => Integer
|
1290
|
+
# * {Types::GetCustomDataIdentifierResponse#name #name} => String
|
1291
|
+
# * {Types::GetCustomDataIdentifierResponse#regex #regex} => String
|
1292
|
+
# * {Types::GetCustomDataIdentifierResponse#tags #tags} => Hash<String,String>
|
1293
|
+
#
|
1294
|
+
# @example Request syntax with placeholder values
|
1295
|
+
#
|
1296
|
+
# resp = client.get_custom_data_identifier({
|
1297
|
+
# id: "__string", # required
|
1298
|
+
# })
|
1299
|
+
#
|
1300
|
+
# @example Response structure
|
1301
|
+
#
|
1302
|
+
# resp.arn #=> String
|
1303
|
+
# resp.created_at #=> Time
|
1304
|
+
# resp.deleted #=> Boolean
|
1305
|
+
# resp.description #=> String
|
1306
|
+
# resp.id #=> String
|
1307
|
+
# resp.ignore_words #=> Array
|
1308
|
+
# resp.ignore_words[0] #=> String
|
1309
|
+
# resp.keywords #=> Array
|
1310
|
+
# resp.keywords[0] #=> String
|
1311
|
+
# resp.maximum_match_distance #=> Integer
|
1312
|
+
# resp.name #=> String
|
1313
|
+
# resp.regex #=> String
|
1314
|
+
# resp.tags #=> Hash
|
1315
|
+
# resp.tags["__string"] #=> String
|
1316
|
+
#
|
1317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetCustomDataIdentifier AWS API Documentation
|
1318
|
+
#
|
1319
|
+
# @overload get_custom_data_identifier(params = {})
|
1320
|
+
# @param [Hash] params ({})
|
1321
|
+
def get_custom_data_identifier(params = {}, options = {})
|
1322
|
+
req = build_request(:get_custom_data_identifier, params)
|
1323
|
+
req.send_request(options)
|
1324
|
+
end
|
1325
|
+
|
1326
|
+
# Retrieves (queries) aggregated statistical data about findings.
|
1327
|
+
#
|
1328
|
+
# @option params [Types::FindingCriteria] :finding_criteria
|
1329
|
+
# Specifies, as a map, one or more property-based conditions that filter
|
1330
|
+
# the results of a query for findings.
|
1331
|
+
#
|
1332
|
+
# @option params [required, String] :group_by
|
1333
|
+
#
|
1334
|
+
# @option params [Integer] :size
|
1335
|
+
#
|
1336
|
+
# @option params [Types::FindingStatisticsSortCriteria] :sort_criteria
|
1337
|
+
# Specifies criteria for sorting the results of a query for information
|
1338
|
+
# about findings.
|
1339
|
+
#
|
1340
|
+
# @return [Types::GetFindingStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1341
|
+
#
|
1342
|
+
# * {Types::GetFindingStatisticsResponse#counts_by_group #counts_by_group} => Array<Types::GroupCount>
|
1343
|
+
#
|
1344
|
+
# @example Request syntax with placeholder values
|
1345
|
+
#
|
1346
|
+
# resp = client.get_finding_statistics({
|
1347
|
+
# finding_criteria: {
|
1348
|
+
# criterion: {
|
1349
|
+
# "__string" => {
|
1350
|
+
# eq: ["__string"],
|
1351
|
+
# gt: 1,
|
1352
|
+
# gte: 1,
|
1353
|
+
# lt: 1,
|
1354
|
+
# lte: 1,
|
1355
|
+
# neq: ["__string"],
|
1356
|
+
# },
|
1357
|
+
# },
|
1358
|
+
# },
|
1359
|
+
# group_by: "resourcesAffected.s3Bucket.name", # required, accepts resourcesAffected.s3Bucket.name, type, classificationDetails.jobId, severity.description
|
1360
|
+
# size: 1,
|
1361
|
+
# sort_criteria: {
|
1362
|
+
# attribute_name: "groupKey", # accepts groupKey, count
|
1363
|
+
# order_by: "ASC", # accepts ASC, DESC
|
1364
|
+
# },
|
1365
|
+
# })
|
1366
|
+
#
|
1367
|
+
# @example Response structure
|
1368
|
+
#
|
1369
|
+
# resp.counts_by_group #=> Array
|
1370
|
+
# resp.counts_by_group[0].count #=> Integer
|
1371
|
+
# resp.counts_by_group[0].group_key #=> String
|
1372
|
+
#
|
1373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetFindingStatistics AWS API Documentation
|
1374
|
+
#
|
1375
|
+
# @overload get_finding_statistics(params = {})
|
1376
|
+
# @param [Hash] params ({})
|
1377
|
+
def get_finding_statistics(params = {}, options = {})
|
1378
|
+
req = build_request(:get_finding_statistics, params)
|
1379
|
+
req.send_request(options)
|
1380
|
+
end
|
1381
|
+
|
1382
|
+
# Retrieves information about one or more findings.
|
1383
|
+
#
|
1384
|
+
# @option params [required, Array<String>] :finding_ids
|
1385
|
+
#
|
1386
|
+
# @option params [Types::SortCriteria] :sort_criteria
|
1387
|
+
# Specifies criteria for sorting the results of a request for
|
1388
|
+
# information about findings.
|
1389
|
+
#
|
1390
|
+
# @return [Types::GetFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1391
|
+
#
|
1392
|
+
# * {Types::GetFindingsResponse#findings #findings} => Array<Types::Finding>
|
1393
|
+
#
|
1394
|
+
# @example Request syntax with placeholder values
|
1395
|
+
#
|
1396
|
+
# resp = client.get_findings({
|
1397
|
+
# finding_ids: ["__string"], # required
|
1398
|
+
# sort_criteria: {
|
1399
|
+
# attribute_name: "__string",
|
1400
|
+
# order_by: "ASC", # accepts ASC, DESC
|
1401
|
+
# },
|
1402
|
+
# })
|
1403
|
+
#
|
1404
|
+
# @example Response structure
|
1405
|
+
#
|
1406
|
+
# resp.findings #=> Array
|
1407
|
+
# resp.findings[0].account_id #=> String
|
1408
|
+
# resp.findings[0].archived #=> Boolean
|
1409
|
+
# resp.findings[0].category #=> String, one of "CLASSIFICATION", "POLICY"
|
1410
|
+
# resp.findings[0].classification_details.detailed_results_location #=> String
|
1411
|
+
# resp.findings[0].classification_details.job_arn #=> String
|
1412
|
+
# resp.findings[0].classification_details.job_id #=> String
|
1413
|
+
# resp.findings[0].classification_details.result.custom_data_identifiers.detections #=> Array
|
1414
|
+
# resp.findings[0].classification_details.result.custom_data_identifiers.detections[0].arn #=> String
|
1415
|
+
# resp.findings[0].classification_details.result.custom_data_identifiers.detections[0].count #=> Integer
|
1416
|
+
# resp.findings[0].classification_details.result.custom_data_identifiers.detections[0].name #=> String
|
1417
|
+
# resp.findings[0].classification_details.result.custom_data_identifiers.total_count #=> Integer
|
1418
|
+
# resp.findings[0].classification_details.result.mime_type #=> String
|
1419
|
+
# resp.findings[0].classification_details.result.sensitive_data #=> Array
|
1420
|
+
# resp.findings[0].classification_details.result.sensitive_data[0].category #=> String, one of "FINANCIAL_INFORMATION", "PERSONAL_INFORMATION", "CREDENTIALS", "CUSTOM_IDENTIFIER"
|
1421
|
+
# resp.findings[0].classification_details.result.sensitive_data[0].detections #=> Array
|
1422
|
+
# resp.findings[0].classification_details.result.sensitive_data[0].detections[0].count #=> Integer
|
1423
|
+
# resp.findings[0].classification_details.result.sensitive_data[0].detections[0].type #=> String
|
1424
|
+
# resp.findings[0].classification_details.result.sensitive_data[0].total_count #=> Integer
|
1425
|
+
# resp.findings[0].classification_details.result.size_classified #=> Integer
|
1426
|
+
# resp.findings[0].classification_details.result.status.code #=> String
|
1427
|
+
# resp.findings[0].classification_details.result.status.reason #=> String
|
1428
|
+
# resp.findings[0].count #=> Integer
|
1429
|
+
# resp.findings[0].created_at #=> Time
|
1430
|
+
# resp.findings[0].description #=> String
|
1431
|
+
# resp.findings[0].id #=> String
|
1432
|
+
# resp.findings[0].partition #=> String
|
1433
|
+
# resp.findings[0].policy_details.action.action_type #=> String, one of "AWS_API_CALL"
|
1434
|
+
# resp.findings[0].policy_details.action.api_call_details.api #=> String
|
1435
|
+
# resp.findings[0].policy_details.action.api_call_details.api_service_name #=> String
|
1436
|
+
# resp.findings[0].policy_details.action.api_call_details.first_seen #=> Time
|
1437
|
+
# resp.findings[0].policy_details.action.api_call_details.last_seen #=> Time
|
1438
|
+
# resp.findings[0].policy_details.actor.domain_details.domain_name #=> String
|
1439
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_address_v4 #=> String
|
1440
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_city.name #=> String
|
1441
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_country.code #=> String
|
1442
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_country.name #=> String
|
1443
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_geo_location.lat #=> Float
|
1444
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_geo_location.lon #=> Float
|
1445
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_owner.asn #=> String
|
1446
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_owner.asn_org #=> String
|
1447
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_owner.isp #=> String
|
1448
|
+
# resp.findings[0].policy_details.actor.ip_address_details.ip_owner.org #=> String
|
1449
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.access_key_id #=> String
|
1450
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.account_id #=> String
|
1451
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.arn #=> String
|
1452
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.principal_id #=> String
|
1453
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.session_context.attributes.creation_date #=> Time
|
1454
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.session_context.attributes.mfa_authenticated #=> Boolean
|
1455
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.session_context.session_issuer.account_id #=> String
|
1456
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.session_context.session_issuer.arn #=> String
|
1457
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.session_context.session_issuer.principal_id #=> String
|
1458
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.session_context.session_issuer.type #=> String
|
1459
|
+
# resp.findings[0].policy_details.actor.user_identity.assumed_role.session_context.session_issuer.user_name #=> String
|
1460
|
+
# resp.findings[0].policy_details.actor.user_identity.aws_account.account_id #=> String
|
1461
|
+
# resp.findings[0].policy_details.actor.user_identity.aws_account.principal_id #=> String
|
1462
|
+
# resp.findings[0].policy_details.actor.user_identity.aws_service.invoked_by #=> String
|
1463
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.access_key_id #=> String
|
1464
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.account_id #=> String
|
1465
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.arn #=> String
|
1466
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.principal_id #=> String
|
1467
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.session_context.attributes.creation_date #=> Time
|
1468
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.session_context.attributes.mfa_authenticated #=> Boolean
|
1469
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.session_context.session_issuer.account_id #=> String
|
1470
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.session_context.session_issuer.arn #=> String
|
1471
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.session_context.session_issuer.principal_id #=> String
|
1472
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.session_context.session_issuer.type #=> String
|
1473
|
+
# resp.findings[0].policy_details.actor.user_identity.federated_user.session_context.session_issuer.user_name #=> String
|
1474
|
+
# resp.findings[0].policy_details.actor.user_identity.iam_user.account_id #=> String
|
1475
|
+
# resp.findings[0].policy_details.actor.user_identity.iam_user.arn #=> String
|
1476
|
+
# resp.findings[0].policy_details.actor.user_identity.iam_user.principal_id #=> String
|
1477
|
+
# resp.findings[0].policy_details.actor.user_identity.iam_user.user_name #=> String
|
1478
|
+
# resp.findings[0].policy_details.actor.user_identity.root.account_id #=> String
|
1479
|
+
# resp.findings[0].policy_details.actor.user_identity.root.arn #=> String
|
1480
|
+
# resp.findings[0].policy_details.actor.user_identity.root.principal_id #=> String
|
1481
|
+
# resp.findings[0].policy_details.actor.user_identity.type #=> String, one of "AssumedRole", "IAMUser", "FederatedUser", "Root", "AWSAccount", "AWSService"
|
1482
|
+
# resp.findings[0].region #=> String
|
1483
|
+
# resp.findings[0].resources_affected.s3_bucket.arn #=> String
|
1484
|
+
# resp.findings[0].resources_affected.s3_bucket.created_at #=> Time
|
1485
|
+
# resp.findings[0].resources_affected.s3_bucket.default_server_side_encryption.encryption_type #=> String, one of "NONE", "AES256", "aws:kms"
|
1486
|
+
# resp.findings[0].resources_affected.s3_bucket.default_server_side_encryption.kms_master_key_id #=> String
|
1487
|
+
# resp.findings[0].resources_affected.s3_bucket.name #=> String
|
1488
|
+
# resp.findings[0].resources_affected.s3_bucket.owner.display_name #=> String
|
1489
|
+
# resp.findings[0].resources_affected.s3_bucket.owner.id #=> String
|
1490
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.effective_permission #=> String, one of "PUBLIC", "NOT_PUBLIC"
|
1491
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.account_level_permissions.block_public_access.block_public_acls #=> Boolean
|
1492
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.account_level_permissions.block_public_access.block_public_policy #=> Boolean
|
1493
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.account_level_permissions.block_public_access.ignore_public_acls #=> Boolean
|
1494
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.account_level_permissions.block_public_access.restrict_public_buckets #=> Boolean
|
1495
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.access_control_list.allows_public_read_access #=> Boolean
|
1496
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.access_control_list.allows_public_write_access #=> Boolean
|
1497
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.block_public_access.block_public_acls #=> Boolean
|
1498
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.block_public_access.block_public_policy #=> Boolean
|
1499
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.block_public_access.ignore_public_acls #=> Boolean
|
1500
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.block_public_access.restrict_public_buckets #=> Boolean
|
1501
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.bucket_policy.allows_public_read_access #=> Boolean
|
1502
|
+
# resp.findings[0].resources_affected.s3_bucket.public_access.permission_configuration.bucket_level_permissions.bucket_policy.allows_public_write_access #=> Boolean
|
1503
|
+
# resp.findings[0].resources_affected.s3_bucket.tags #=> Array
|
1504
|
+
# resp.findings[0].resources_affected.s3_bucket.tags[0].key #=> String
|
1505
|
+
# resp.findings[0].resources_affected.s3_bucket.tags[0].value #=> String
|
1506
|
+
# resp.findings[0].resources_affected.s3_object.bucket_arn #=> String
|
1507
|
+
# resp.findings[0].resources_affected.s3_object.e_tag #=> String
|
1508
|
+
# resp.findings[0].resources_affected.s3_object.extension #=> String
|
1509
|
+
# resp.findings[0].resources_affected.s3_object.key #=> String
|
1510
|
+
# resp.findings[0].resources_affected.s3_object.last_modified #=> Time
|
1511
|
+
# resp.findings[0].resources_affected.s3_object.path #=> String
|
1512
|
+
# resp.findings[0].resources_affected.s3_object.public_access #=> Boolean
|
1513
|
+
# resp.findings[0].resources_affected.s3_object.server_side_encryption.encryption_type #=> String, one of "NONE", "AES256", "aws:kms"
|
1514
|
+
# resp.findings[0].resources_affected.s3_object.server_side_encryption.kms_master_key_id #=> String
|
1515
|
+
# resp.findings[0].resources_affected.s3_object.size #=> Integer
|
1516
|
+
# resp.findings[0].resources_affected.s3_object.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "ONEZONE_IA", "GLACIER"
|
1517
|
+
# resp.findings[0].resources_affected.s3_object.tags #=> Array
|
1518
|
+
# resp.findings[0].resources_affected.s3_object.tags[0].key #=> String
|
1519
|
+
# resp.findings[0].resources_affected.s3_object.tags[0].value #=> String
|
1520
|
+
# resp.findings[0].resources_affected.s3_object.version_id #=> String
|
1521
|
+
# resp.findings[0].sample #=> Boolean
|
1522
|
+
# resp.findings[0].schema_version #=> String
|
1523
|
+
# resp.findings[0].severity.description #=> String, one of "Low", "Medium", "High"
|
1524
|
+
# resp.findings[0].severity.score #=> Integer
|
1525
|
+
# resp.findings[0].title #=> String
|
1526
|
+
# resp.findings[0].type #=> String, one of "SensitiveData:S3Object/Multiple", "SensitiveData:S3Object/Financial", "SensitiveData:S3Object/Personal", "SensitiveData:S3Object/Credentials", "SensitiveData:S3Object/CustomIdentifier", "Policy:IAMUser/S3BucketPublic", "Policy:IAMUser/S3BucketSharedExternally", "Policy:IAMUser/S3BucketReplicatedExternally", "Policy:IAMUser/S3BucketEncryptionDisabled", "Policy:IAMUser/S3BlockPublicAccessDisabled"
|
1527
|
+
# resp.findings[0].updated_at #=> Time
|
1528
|
+
#
|
1529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetFindings AWS API Documentation
|
1530
|
+
#
|
1531
|
+
# @overload get_findings(params = {})
|
1532
|
+
# @param [Hash] params ({})
|
1533
|
+
def get_findings(params = {}, options = {})
|
1534
|
+
req = build_request(:get_findings, params)
|
1535
|
+
req.send_request(options)
|
1536
|
+
end
|
1537
|
+
|
1538
|
+
# Retrieves information about the criteria and other settings for a
|
1539
|
+
# findings filter.
|
1540
|
+
#
|
1541
|
+
# @option params [required, String] :id
|
1542
|
+
#
|
1543
|
+
# @return [Types::GetFindingsFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1544
|
+
#
|
1545
|
+
# * {Types::GetFindingsFilterResponse#action #action} => String
|
1546
|
+
# * {Types::GetFindingsFilterResponse#arn #arn} => String
|
1547
|
+
# * {Types::GetFindingsFilterResponse#description #description} => String
|
1548
|
+
# * {Types::GetFindingsFilterResponse#finding_criteria #finding_criteria} => Types::FindingCriteria
|
1549
|
+
# * {Types::GetFindingsFilterResponse#id #id} => String
|
1550
|
+
# * {Types::GetFindingsFilterResponse#name #name} => String
|
1551
|
+
# * {Types::GetFindingsFilterResponse#position #position} => Integer
|
1552
|
+
# * {Types::GetFindingsFilterResponse#tags #tags} => Hash<String,String>
|
1553
|
+
#
|
1554
|
+
# @example Request syntax with placeholder values
|
1555
|
+
#
|
1556
|
+
# resp = client.get_findings_filter({
|
1557
|
+
# id: "__string", # required
|
1558
|
+
# })
|
1559
|
+
#
|
1560
|
+
# @example Response structure
|
1561
|
+
#
|
1562
|
+
# resp.action #=> String, one of "ARCHIVE", "NOOP"
|
1563
|
+
# resp.arn #=> String
|
1564
|
+
# resp.description #=> String
|
1565
|
+
# resp.finding_criteria.criterion #=> Hash
|
1566
|
+
# resp.finding_criteria.criterion["__string"].eq #=> Array
|
1567
|
+
# resp.finding_criteria.criterion["__string"].eq[0] #=> String
|
1568
|
+
# resp.finding_criteria.criterion["__string"].gt #=> Integer
|
1569
|
+
# resp.finding_criteria.criterion["__string"].gte #=> Integer
|
1570
|
+
# resp.finding_criteria.criterion["__string"].lt #=> Integer
|
1571
|
+
# resp.finding_criteria.criterion["__string"].lte #=> Integer
|
1572
|
+
# resp.finding_criteria.criterion["__string"].neq #=> Array
|
1573
|
+
# resp.finding_criteria.criterion["__string"].neq[0] #=> String
|
1574
|
+
# resp.id #=> String
|
1575
|
+
# resp.name #=> String
|
1576
|
+
# resp.position #=> Integer
|
1577
|
+
# resp.tags #=> Hash
|
1578
|
+
# resp.tags["__string"] #=> String
|
1579
|
+
#
|
1580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetFindingsFilter AWS API Documentation
|
1581
|
+
#
|
1582
|
+
# @overload get_findings_filter(params = {})
|
1583
|
+
# @param [Hash] params ({})
|
1584
|
+
def get_findings_filter(params = {}, options = {})
|
1585
|
+
req = build_request(:get_findings_filter, params)
|
1586
|
+
req.send_request(options)
|
1587
|
+
end
|
1588
|
+
|
1589
|
+
# Retrieves the count of Amazon Macie membership invitations that were
|
1590
|
+
# received by an account.
|
1591
|
+
#
|
1592
|
+
# @return [Types::GetInvitationsCountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1593
|
+
#
|
1594
|
+
# * {Types::GetInvitationsCountResponse#invitations_count #invitations_count} => Integer
|
1595
|
+
#
|
1596
|
+
# @example Response structure
|
1597
|
+
#
|
1598
|
+
# resp.invitations_count #=> Integer
|
1599
|
+
#
|
1600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetInvitationsCount AWS API Documentation
|
1601
|
+
#
|
1602
|
+
# @overload get_invitations_count(params = {})
|
1603
|
+
# @param [Hash] params ({})
|
1604
|
+
def get_invitations_count(params = {}, options = {})
|
1605
|
+
req = build_request(:get_invitations_count, params)
|
1606
|
+
req.send_request(options)
|
1607
|
+
end
|
1608
|
+
|
1609
|
+
# Retrieves information about the current status and configuration
|
1610
|
+
# settings for an Amazon Macie account.
|
1611
|
+
#
|
1612
|
+
# @return [Types::GetMacieSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1613
|
+
#
|
1614
|
+
# * {Types::GetMacieSessionResponse#created_at #created_at} => Time
|
1615
|
+
# * {Types::GetMacieSessionResponse#finding_publishing_frequency #finding_publishing_frequency} => String
|
1616
|
+
# * {Types::GetMacieSessionResponse#service_role #service_role} => String
|
1617
|
+
# * {Types::GetMacieSessionResponse#status #status} => String
|
1618
|
+
# * {Types::GetMacieSessionResponse#updated_at #updated_at} => Time
|
1619
|
+
#
|
1620
|
+
# @example Response structure
|
1621
|
+
#
|
1622
|
+
# resp.created_at #=> Time
|
1623
|
+
# resp.finding_publishing_frequency #=> String, one of "FIFTEEN_MINUTES", "ONE_HOUR", "SIX_HOURS"
|
1624
|
+
# resp.service_role #=> String
|
1625
|
+
# resp.status #=> String, one of "PAUSED", "ENABLED"
|
1626
|
+
# resp.updated_at #=> Time
|
1627
|
+
#
|
1628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetMacieSession AWS API Documentation
|
1629
|
+
#
|
1630
|
+
# @overload get_macie_session(params = {})
|
1631
|
+
# @param [Hash] params ({})
|
1632
|
+
def get_macie_session(params = {}, options = {})
|
1633
|
+
req = build_request(:get_macie_session, params)
|
1634
|
+
req.send_request(options)
|
1635
|
+
end
|
1636
|
+
|
1637
|
+
# Retrieves information about the Amazon Macie master account for an
|
1638
|
+
# account.
|
1639
|
+
#
|
1640
|
+
# @return [Types::GetMasterAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1641
|
+
#
|
1642
|
+
# * {Types::GetMasterAccountResponse#master #master} => Types::Invitation
|
1643
|
+
#
|
1644
|
+
# @example Response structure
|
1645
|
+
#
|
1646
|
+
# resp.master.account_id #=> String
|
1647
|
+
# resp.master.invitation_id #=> String
|
1648
|
+
# resp.master.invited_at #=> Time
|
1649
|
+
# resp.master.relationship_status #=> String, one of "Enabled", "Paused", "Invited", "Created", "Removed", "Resigned", "EmailVerificationInProgress", "EmailVerificationFailed"
|
1650
|
+
#
|
1651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetMasterAccount AWS API Documentation
|
1652
|
+
#
|
1653
|
+
# @overload get_master_account(params = {})
|
1654
|
+
# @param [Hash] params ({})
|
1655
|
+
def get_master_account(params = {}, options = {})
|
1656
|
+
req = build_request(:get_master_account, params)
|
1657
|
+
req.send_request(options)
|
1658
|
+
end
|
1659
|
+
|
1660
|
+
# Retrieves information about a member account that's associated with
|
1661
|
+
# an Amazon Macie master account.
|
1662
|
+
#
|
1663
|
+
# @option params [required, String] :id
|
1664
|
+
#
|
1665
|
+
# @return [Types::GetMemberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1666
|
+
#
|
1667
|
+
# * {Types::GetMemberResponse#account_id #account_id} => String
|
1668
|
+
# * {Types::GetMemberResponse#arn #arn} => String
|
1669
|
+
# * {Types::GetMemberResponse#email #email} => String
|
1670
|
+
# * {Types::GetMemberResponse#invited_at #invited_at} => Time
|
1671
|
+
# * {Types::GetMemberResponse#master_account_id #master_account_id} => String
|
1672
|
+
# * {Types::GetMemberResponse#relationship_status #relationship_status} => String
|
1673
|
+
# * {Types::GetMemberResponse#tags #tags} => Hash<String,String>
|
1674
|
+
# * {Types::GetMemberResponse#updated_at #updated_at} => Time
|
1675
|
+
#
|
1676
|
+
# @example Request syntax with placeholder values
|
1677
|
+
#
|
1678
|
+
# resp = client.get_member({
|
1679
|
+
# id: "__string", # required
|
1680
|
+
# })
|
1681
|
+
#
|
1682
|
+
# @example Response structure
|
1683
|
+
#
|
1684
|
+
# resp.account_id #=> String
|
1685
|
+
# resp.arn #=> String
|
1686
|
+
# resp.email #=> String
|
1687
|
+
# resp.invited_at #=> Time
|
1688
|
+
# resp.master_account_id #=> String
|
1689
|
+
# resp.relationship_status #=> String, one of "Enabled", "Paused", "Invited", "Created", "Removed", "Resigned", "EmailVerificationInProgress", "EmailVerificationFailed"
|
1690
|
+
# resp.tags #=> Hash
|
1691
|
+
# resp.tags["__string"] #=> String
|
1692
|
+
# resp.updated_at #=> Time
|
1693
|
+
#
|
1694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetMember AWS API Documentation
|
1695
|
+
#
|
1696
|
+
# @overload get_member(params = {})
|
1697
|
+
# @param [Hash] params ({})
|
1698
|
+
def get_member(params = {}, options = {})
|
1699
|
+
req = build_request(:get_member, params)
|
1700
|
+
req.send_request(options)
|
1701
|
+
end
|
1702
|
+
|
1703
|
+
# Retrieves (queries) quotas and aggregated usage data for one or more
|
1704
|
+
# accounts.
|
1705
|
+
#
|
1706
|
+
# @option params [Array<Types::UsageStatisticsFilter>] :filter_by
|
1707
|
+
#
|
1708
|
+
# @option params [Integer] :max_results
|
1709
|
+
#
|
1710
|
+
# @option params [String] :next_token
|
1711
|
+
#
|
1712
|
+
# @option params [Types::UsageStatisticsSortBy] :sort_by
|
1713
|
+
# Specifies criteria for sorting the results of a query for account
|
1714
|
+
# quotas and usage data.
|
1715
|
+
#
|
1716
|
+
# @return [Types::GetUsageStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1717
|
+
#
|
1718
|
+
# * {Types::GetUsageStatisticsResponse#next_token #next_token} => String
|
1719
|
+
# * {Types::GetUsageStatisticsResponse#records #records} => Array<Types::UsageRecord>
|
1720
|
+
#
|
1721
|
+
# @example Request syntax with placeholder values
|
1722
|
+
#
|
1723
|
+
# resp = client.get_usage_statistics({
|
1724
|
+
# filter_by: [
|
1725
|
+
# {
|
1726
|
+
# key: "accountId", # accepts accountId
|
1727
|
+
# values: ["__string"],
|
1728
|
+
# },
|
1729
|
+
# ],
|
1730
|
+
# max_results: 1,
|
1731
|
+
# next_token: "__string",
|
1732
|
+
# sort_by: {
|
1733
|
+
# key: "accountId", # accepts accountId, total
|
1734
|
+
# order_by: "ASC", # accepts ASC, DESC
|
1735
|
+
# },
|
1736
|
+
# })
|
1737
|
+
#
|
1738
|
+
# @example Response structure
|
1739
|
+
#
|
1740
|
+
# resp.next_token #=> String
|
1741
|
+
# resp.records #=> Array
|
1742
|
+
# resp.records[0].account_id #=> String
|
1743
|
+
# resp.records[0].free_trial_start_date #=> Time
|
1744
|
+
# resp.records[0].usage #=> Array
|
1745
|
+
# resp.records[0].usage[0].currency #=> String, one of "USD"
|
1746
|
+
# resp.records[0].usage[0].estimated_cost #=> String
|
1747
|
+
# resp.records[0].usage[0].service_limit.is_service_limited #=> Boolean
|
1748
|
+
# resp.records[0].usage[0].service_limit.unit #=> String, one of "TERABYTES"
|
1749
|
+
# resp.records[0].usage[0].service_limit.value #=> Integer
|
1750
|
+
# resp.records[0].usage[0].type #=> String, one of "DATA_INVENTORY_EVALUATION", "SENSITIVE_DATA_DISCOVERY"
|
1751
|
+
#
|
1752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetUsageStatistics AWS API Documentation
|
1753
|
+
#
|
1754
|
+
# @overload get_usage_statistics(params = {})
|
1755
|
+
# @param [Hash] params ({})
|
1756
|
+
def get_usage_statistics(params = {}, options = {})
|
1757
|
+
req = build_request(:get_usage_statistics, params)
|
1758
|
+
req.send_request(options)
|
1759
|
+
end
|
1760
|
+
|
1761
|
+
# Retrieves (queries) aggregated usage data for an account.
|
1762
|
+
#
|
1763
|
+
# @return [Types::GetUsageTotalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1764
|
+
#
|
1765
|
+
# * {Types::GetUsageTotalsResponse#usage_totals #usage_totals} => Array<Types::UsageTotal>
|
1766
|
+
#
|
1767
|
+
# @example Response structure
|
1768
|
+
#
|
1769
|
+
# resp.usage_totals #=> Array
|
1770
|
+
# resp.usage_totals[0].currency #=> String, one of "USD"
|
1771
|
+
# resp.usage_totals[0].estimated_cost #=> String
|
1772
|
+
# resp.usage_totals[0].type #=> String, one of "DATA_INVENTORY_EVALUATION", "SENSITIVE_DATA_DISCOVERY"
|
1773
|
+
#
|
1774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/GetUsageTotals AWS API Documentation
|
1775
|
+
#
|
1776
|
+
# @overload get_usage_totals(params = {})
|
1777
|
+
# @param [Hash] params ({})
|
1778
|
+
def get_usage_totals(params = {}, options = {})
|
1779
|
+
req = build_request(:get_usage_totals, params)
|
1780
|
+
req.send_request(options)
|
1781
|
+
end
|
1782
|
+
|
1783
|
+
# Retrieves information about the status and settings for one or more
|
1784
|
+
# classification jobs.
|
1785
|
+
#
|
1786
|
+
# @option params [Types::ListJobsFilterCriteria] :filter_criteria
|
1787
|
+
# Specifies criteria for filtering the results of a request for
|
1788
|
+
# information about classification jobs.
|
1789
|
+
#
|
1790
|
+
# @option params [Integer] :max_results
|
1791
|
+
#
|
1792
|
+
# @option params [String] :next_token
|
1793
|
+
#
|
1794
|
+
# @option params [Types::ListJobsSortCriteria] :sort_criteria
|
1795
|
+
# Specifies criteria for sorting the results of a request for
|
1796
|
+
# information about classification jobs.
|
1797
|
+
#
|
1798
|
+
# @return [Types::ListClassificationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1799
|
+
#
|
1800
|
+
# * {Types::ListClassificationJobsResponse#items #items} => Array<Types::JobSummary>
|
1801
|
+
# * {Types::ListClassificationJobsResponse#next_token #next_token} => String
|
1802
|
+
#
|
1803
|
+
# @example Request syntax with placeholder values
|
1804
|
+
#
|
1805
|
+
# resp = client.list_classification_jobs({
|
1806
|
+
# filter_criteria: {
|
1807
|
+
# excludes: [
|
1808
|
+
# {
|
1809
|
+
# comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
|
1810
|
+
# key: "jobType", # accepts jobType, jobStatus, createdAt, name
|
1811
|
+
# values: ["__string"],
|
1812
|
+
# },
|
1813
|
+
# ],
|
1814
|
+
# includes: [
|
1815
|
+
# {
|
1816
|
+
# comparator: "EQ", # accepts EQ, GT, GTE, LT, LTE, NE, CONTAINS
|
1817
|
+
# key: "jobType", # accepts jobType, jobStatus, createdAt, name
|
1818
|
+
# values: ["__string"],
|
1819
|
+
# },
|
1820
|
+
# ],
|
1821
|
+
# },
|
1822
|
+
# max_results: 1,
|
1823
|
+
# next_token: "__string",
|
1824
|
+
# sort_criteria: {
|
1825
|
+
# attribute_name: "createdAt", # accepts createdAt, jobStatus, name, jobType
|
1826
|
+
# order_by: "ASC", # accepts ASC, DESC
|
1827
|
+
# },
|
1828
|
+
# })
|
1829
|
+
#
|
1830
|
+
# @example Response structure
|
1831
|
+
#
|
1832
|
+
# resp.items #=> Array
|
1833
|
+
# resp.items[0].bucket_definitions #=> Array
|
1834
|
+
# resp.items[0].bucket_definitions[0].account_id #=> String
|
1835
|
+
# resp.items[0].bucket_definitions[0].buckets #=> Array
|
1836
|
+
# resp.items[0].bucket_definitions[0].buckets[0] #=> String
|
1837
|
+
# resp.items[0].created_at #=> Time
|
1838
|
+
# resp.items[0].job_id #=> String
|
1839
|
+
# resp.items[0].job_status #=> String, one of "RUNNING", "PAUSED", "CANCELLED", "COMPLETE", "IDLE"
|
1840
|
+
# resp.items[0].job_type #=> String, one of "ONE_TIME", "SCHEDULED"
|
1841
|
+
# resp.items[0].name #=> String
|
1842
|
+
# resp.next_token #=> String
|
1843
|
+
#
|
1844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListClassificationJobs AWS API Documentation
|
1845
|
+
#
|
1846
|
+
# @overload list_classification_jobs(params = {})
|
1847
|
+
# @param [Hash] params ({})
|
1848
|
+
def list_classification_jobs(params = {}, options = {})
|
1849
|
+
req = build_request(:list_classification_jobs, params)
|
1850
|
+
req.send_request(options)
|
1851
|
+
end
|
1852
|
+
|
1853
|
+
# Retrieves a subset of information about all the custom data
|
1854
|
+
# identifiers for an account.
|
1855
|
+
#
|
1856
|
+
# @option params [Integer] :max_results
|
1857
|
+
#
|
1858
|
+
# @option params [String] :next_token
|
1859
|
+
#
|
1860
|
+
# @return [Types::ListCustomDataIdentifiersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1861
|
+
#
|
1862
|
+
# * {Types::ListCustomDataIdentifiersResponse#items #items} => Array<Types::CustomDataIdentifierSummary>
|
1863
|
+
# * {Types::ListCustomDataIdentifiersResponse#next_token #next_token} => String
|
1864
|
+
#
|
1865
|
+
# @example Request syntax with placeholder values
|
1866
|
+
#
|
1867
|
+
# resp = client.list_custom_data_identifiers({
|
1868
|
+
# max_results: 1,
|
1869
|
+
# next_token: "__string",
|
1870
|
+
# })
|
1871
|
+
#
|
1872
|
+
# @example Response structure
|
1873
|
+
#
|
1874
|
+
# resp.items #=> Array
|
1875
|
+
# resp.items[0].arn #=> String
|
1876
|
+
# resp.items[0].created_at #=> Time
|
1877
|
+
# resp.items[0].description #=> String
|
1878
|
+
# resp.items[0].id #=> String
|
1879
|
+
# resp.items[0].name #=> String
|
1880
|
+
# resp.next_token #=> String
|
1881
|
+
#
|
1882
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListCustomDataIdentifiers AWS API Documentation
|
1883
|
+
#
|
1884
|
+
# @overload list_custom_data_identifiers(params = {})
|
1885
|
+
# @param [Hash] params ({})
|
1886
|
+
def list_custom_data_identifiers(params = {}, options = {})
|
1887
|
+
req = build_request(:list_custom_data_identifiers, params)
|
1888
|
+
req.send_request(options)
|
1889
|
+
end
|
1890
|
+
|
1891
|
+
# Retrieves a subset of information about one or more findings.
|
1892
|
+
#
|
1893
|
+
# @option params [Types::FindingCriteria] :finding_criteria
|
1894
|
+
# Specifies, as a map, one or more property-based conditions that filter
|
1895
|
+
# the results of a query for findings.
|
1896
|
+
#
|
1897
|
+
# @option params [Integer] :max_results
|
1898
|
+
#
|
1899
|
+
# @option params [String] :next_token
|
1900
|
+
#
|
1901
|
+
# @option params [Types::SortCriteria] :sort_criteria
|
1902
|
+
# Specifies criteria for sorting the results of a request for
|
1903
|
+
# information about findings.
|
1904
|
+
#
|
1905
|
+
# @return [Types::ListFindingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1906
|
+
#
|
1907
|
+
# * {Types::ListFindingsResponse#finding_ids #finding_ids} => Array<String>
|
1908
|
+
# * {Types::ListFindingsResponse#next_token #next_token} => String
|
1909
|
+
#
|
1910
|
+
# @example Request syntax with placeholder values
|
1911
|
+
#
|
1912
|
+
# resp = client.list_findings({
|
1913
|
+
# finding_criteria: {
|
1914
|
+
# criterion: {
|
1915
|
+
# "__string" => {
|
1916
|
+
# eq: ["__string"],
|
1917
|
+
# gt: 1,
|
1918
|
+
# gte: 1,
|
1919
|
+
# lt: 1,
|
1920
|
+
# lte: 1,
|
1921
|
+
# neq: ["__string"],
|
1922
|
+
# },
|
1923
|
+
# },
|
1924
|
+
# },
|
1925
|
+
# max_results: 1,
|
1926
|
+
# next_token: "__string",
|
1927
|
+
# sort_criteria: {
|
1928
|
+
# attribute_name: "__string",
|
1929
|
+
# order_by: "ASC", # accepts ASC, DESC
|
1930
|
+
# },
|
1931
|
+
# })
|
1932
|
+
#
|
1933
|
+
# @example Response structure
|
1934
|
+
#
|
1935
|
+
# resp.finding_ids #=> Array
|
1936
|
+
# resp.finding_ids[0] #=> String
|
1937
|
+
# resp.next_token #=> String
|
1938
|
+
#
|
1939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListFindings AWS API Documentation
|
1940
|
+
#
|
1941
|
+
# @overload list_findings(params = {})
|
1942
|
+
# @param [Hash] params ({})
|
1943
|
+
def list_findings(params = {}, options = {})
|
1944
|
+
req = build_request(:list_findings, params)
|
1945
|
+
req.send_request(options)
|
1946
|
+
end
|
1947
|
+
|
1948
|
+
# Retrieves a subset of information about all the findings filters for
|
1949
|
+
# an account.
|
1950
|
+
#
|
1951
|
+
# @option params [Integer] :max_results
|
1952
|
+
#
|
1953
|
+
# @option params [String] :next_token
|
1954
|
+
#
|
1955
|
+
# @return [Types::ListFindingsFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1956
|
+
#
|
1957
|
+
# * {Types::ListFindingsFiltersResponse#findings_filter_list_items #findings_filter_list_items} => Array<Types::FindingsFilterListItem>
|
1958
|
+
# * {Types::ListFindingsFiltersResponse#next_token #next_token} => String
|
1959
|
+
#
|
1960
|
+
# @example Request syntax with placeholder values
|
1961
|
+
#
|
1962
|
+
# resp = client.list_findings_filters({
|
1963
|
+
# max_results: 1,
|
1964
|
+
# next_token: "__string",
|
1965
|
+
# })
|
1966
|
+
#
|
1967
|
+
# @example Response structure
|
1968
|
+
#
|
1969
|
+
# resp.findings_filter_list_items #=> Array
|
1970
|
+
# resp.findings_filter_list_items[0].arn #=> String
|
1971
|
+
# resp.findings_filter_list_items[0].id #=> String
|
1972
|
+
# resp.findings_filter_list_items[0].name #=> String
|
1973
|
+
# resp.findings_filter_list_items[0].tags #=> Hash
|
1974
|
+
# resp.findings_filter_list_items[0].tags["__string"] #=> String
|
1975
|
+
# resp.next_token #=> String
|
1976
|
+
#
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListFindingsFilters AWS API Documentation
|
1978
|
+
#
|
1979
|
+
# @overload list_findings_filters(params = {})
|
1980
|
+
# @param [Hash] params ({})
|
1981
|
+
def list_findings_filters(params = {}, options = {})
|
1982
|
+
req = build_request(:list_findings_filters, params)
|
1983
|
+
req.send_request(options)
|
1984
|
+
end
|
1985
|
+
|
1986
|
+
# Retrieves information about all the Amazon Macie membership
|
1987
|
+
# invitations that were received by an account.
|
1988
|
+
#
|
1989
|
+
# @option params [Integer] :max_results
|
1990
|
+
#
|
1991
|
+
# @option params [String] :next_token
|
1992
|
+
#
|
1993
|
+
# @return [Types::ListInvitationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1994
|
+
#
|
1995
|
+
# * {Types::ListInvitationsResponse#invitations #invitations} => Array<Types::Invitation>
|
1996
|
+
# * {Types::ListInvitationsResponse#next_token #next_token} => String
|
1997
|
+
#
|
1998
|
+
# @example Request syntax with placeholder values
|
1999
|
+
#
|
2000
|
+
# resp = client.list_invitations({
|
2001
|
+
# max_results: 1,
|
2002
|
+
# next_token: "__string",
|
2003
|
+
# })
|
2004
|
+
#
|
2005
|
+
# @example Response structure
|
2006
|
+
#
|
2007
|
+
# resp.invitations #=> Array
|
2008
|
+
# resp.invitations[0].account_id #=> String
|
2009
|
+
# resp.invitations[0].invitation_id #=> String
|
2010
|
+
# resp.invitations[0].invited_at #=> Time
|
2011
|
+
# resp.invitations[0].relationship_status #=> String, one of "Enabled", "Paused", "Invited", "Created", "Removed", "Resigned", "EmailVerificationInProgress", "EmailVerificationFailed"
|
2012
|
+
# resp.next_token #=> String
|
2013
|
+
#
|
2014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListInvitations AWS API Documentation
|
2015
|
+
#
|
2016
|
+
# @overload list_invitations(params = {})
|
2017
|
+
# @param [Hash] params ({})
|
2018
|
+
def list_invitations(params = {}, options = {})
|
2019
|
+
req = build_request(:list_invitations, params)
|
2020
|
+
req.send_request(options)
|
2021
|
+
end
|
2022
|
+
|
2023
|
+
# Retrieves information about the accounts that are associated with an
|
2024
|
+
# Amazon Macie master account.
|
2025
|
+
#
|
2026
|
+
# @option params [Integer] :max_results
|
2027
|
+
#
|
2028
|
+
# @option params [String] :next_token
|
2029
|
+
#
|
2030
|
+
# @option params [String] :only_associated
|
2031
|
+
#
|
2032
|
+
# @return [Types::ListMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2033
|
+
#
|
2034
|
+
# * {Types::ListMembersResponse#members #members} => Array<Types::Member>
|
2035
|
+
# * {Types::ListMembersResponse#next_token #next_token} => String
|
2036
|
+
#
|
2037
|
+
# @example Request syntax with placeholder values
|
2038
|
+
#
|
2039
|
+
# resp = client.list_members({
|
2040
|
+
# max_results: 1,
|
2041
|
+
# next_token: "__string",
|
2042
|
+
# only_associated: "__string",
|
2043
|
+
# })
|
2044
|
+
#
|
2045
|
+
# @example Response structure
|
2046
|
+
#
|
2047
|
+
# resp.members #=> Array
|
2048
|
+
# resp.members[0].account_id #=> String
|
2049
|
+
# resp.members[0].arn #=> String
|
2050
|
+
# resp.members[0].email #=> String
|
2051
|
+
# resp.members[0].invited_at #=> Time
|
2052
|
+
# resp.members[0].master_account_id #=> String
|
2053
|
+
# resp.members[0].relationship_status #=> String, one of "Enabled", "Paused", "Invited", "Created", "Removed", "Resigned", "EmailVerificationInProgress", "EmailVerificationFailed"
|
2054
|
+
# resp.members[0].tags #=> Hash
|
2055
|
+
# resp.members[0].tags["__string"] #=> String
|
2056
|
+
# resp.members[0].updated_at #=> Time
|
2057
|
+
# resp.next_token #=> String
|
2058
|
+
#
|
2059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListMembers AWS API Documentation
|
2060
|
+
#
|
2061
|
+
# @overload list_members(params = {})
|
2062
|
+
# @param [Hash] params ({})
|
2063
|
+
def list_members(params = {}, options = {})
|
2064
|
+
req = build_request(:list_members, params)
|
2065
|
+
req.send_request(options)
|
2066
|
+
end
|
2067
|
+
|
2068
|
+
# Retrieves information about the account that's designated as the
|
2069
|
+
# delegated administrator of Amazon Macie for an AWS organization.
|
2070
|
+
#
|
2071
|
+
# @option params [Integer] :max_results
|
2072
|
+
#
|
2073
|
+
# @option params [String] :next_token
|
2074
|
+
#
|
2075
|
+
# @return [Types::ListOrganizationAdminAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2076
|
+
#
|
2077
|
+
# * {Types::ListOrganizationAdminAccountsResponse#admin_accounts #admin_accounts} => Array<Types::AdminAccount>
|
2078
|
+
# * {Types::ListOrganizationAdminAccountsResponse#next_token #next_token} => String
|
2079
|
+
#
|
2080
|
+
# @example Request syntax with placeholder values
|
2081
|
+
#
|
2082
|
+
# resp = client.list_organization_admin_accounts({
|
2083
|
+
# max_results: 1,
|
2084
|
+
# next_token: "__string",
|
2085
|
+
# })
|
2086
|
+
#
|
2087
|
+
# @example Response structure
|
2088
|
+
#
|
2089
|
+
# resp.admin_accounts #=> Array
|
2090
|
+
# resp.admin_accounts[0].account_id #=> String
|
2091
|
+
# resp.admin_accounts[0].status #=> String, one of "ENABLED", "DISABLING_IN_PROGRESS"
|
2092
|
+
# resp.next_token #=> String
|
2093
|
+
#
|
2094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListOrganizationAdminAccounts AWS API Documentation
|
2095
|
+
#
|
2096
|
+
# @overload list_organization_admin_accounts(params = {})
|
2097
|
+
# @param [Hash] params ({})
|
2098
|
+
def list_organization_admin_accounts(params = {}, options = {})
|
2099
|
+
req = build_request(:list_organization_admin_accounts, params)
|
2100
|
+
req.send_request(options)
|
2101
|
+
end
|
2102
|
+
|
2103
|
+
# Retrieves the tags (keys and values) that are associated with a
|
2104
|
+
# classification job, custom data identifier, findings filter, or member
|
2105
|
+
# account.
|
2106
|
+
#
|
2107
|
+
# @option params [required, String] :resource_arn
|
2108
|
+
#
|
2109
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2110
|
+
#
|
2111
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
2112
|
+
#
|
2113
|
+
# @example Request syntax with placeholder values
|
2114
|
+
#
|
2115
|
+
# resp = client.list_tags_for_resource({
|
2116
|
+
# resource_arn: "__string", # required
|
2117
|
+
# })
|
2118
|
+
#
|
2119
|
+
# @example Response structure
|
2120
|
+
#
|
2121
|
+
# resp.tags #=> Hash
|
2122
|
+
# resp.tags["__string"] #=> String
|
2123
|
+
#
|
2124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/ListTagsForResource AWS API Documentation
|
2125
|
+
#
|
2126
|
+
# @overload list_tags_for_resource(params = {})
|
2127
|
+
# @param [Hash] params ({})
|
2128
|
+
def list_tags_for_resource(params = {}, options = {})
|
2129
|
+
req = build_request(:list_tags_for_resource, params)
|
2130
|
+
req.send_request(options)
|
2131
|
+
end
|
2132
|
+
|
2133
|
+
# Creates or updates the configuration settings for exporting data
|
2134
|
+
# classification results.
|
2135
|
+
#
|
2136
|
+
# @option params [required, Types::ClassificationExportConfiguration] :configuration
|
2137
|
+
# Specifies where to export data classification results to, and the
|
2138
|
+
# encryption settings to use when storing results in that location.
|
2139
|
+
# Currently, you can export classification results only to an S3 bucket.
|
2140
|
+
#
|
2141
|
+
# @return [Types::PutClassificationExportConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2142
|
+
#
|
2143
|
+
# * {Types::PutClassificationExportConfigurationResponse#configuration #configuration} => Types::ClassificationExportConfiguration
|
2144
|
+
#
|
2145
|
+
# @example Request syntax with placeholder values
|
2146
|
+
#
|
2147
|
+
# resp = client.put_classification_export_configuration({
|
2148
|
+
# configuration: { # required
|
2149
|
+
# s3_destination: {
|
2150
|
+
# bucket_name: "__string", # required
|
2151
|
+
# key_prefix: "__string",
|
2152
|
+
# kms_key_arn: "__string", # required
|
2153
|
+
# },
|
2154
|
+
# },
|
2155
|
+
# })
|
2156
|
+
#
|
2157
|
+
# @example Response structure
|
2158
|
+
#
|
2159
|
+
# resp.configuration.s3_destination.bucket_name #=> String
|
2160
|
+
# resp.configuration.s3_destination.key_prefix #=> String
|
2161
|
+
# resp.configuration.s3_destination.kms_key_arn #=> String
|
2162
|
+
#
|
2163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/PutClassificationExportConfiguration AWS API Documentation
|
2164
|
+
#
|
2165
|
+
# @overload put_classification_export_configuration(params = {})
|
2166
|
+
# @param [Hash] params ({})
|
2167
|
+
def put_classification_export_configuration(params = {}, options = {})
|
2168
|
+
req = build_request(:put_classification_export_configuration, params)
|
2169
|
+
req.send_request(options)
|
2170
|
+
end
|
2171
|
+
|
2172
|
+
# Adds or updates one or more tags (keys and values) that are associated
|
2173
|
+
# with a classification job, custom data identifier, findings filter, or
|
2174
|
+
# member account.
|
2175
|
+
#
|
2176
|
+
# @option params [required, String] :resource_arn
|
2177
|
+
#
|
2178
|
+
# @option params [required, Hash<String,String>] :tags
|
2179
|
+
# A string-to-string map of key-value pairs that specifies the tags
|
2180
|
+
# (keys and values) for a classification job, custom data identifier,
|
2181
|
+
# findings filter, or member account.
|
2182
|
+
#
|
2183
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2184
|
+
#
|
2185
|
+
# @example Request syntax with placeholder values
|
2186
|
+
#
|
2187
|
+
# resp = client.tag_resource({
|
2188
|
+
# resource_arn: "__string", # required
|
2189
|
+
# tags: { # required
|
2190
|
+
# "__string" => "__string",
|
2191
|
+
# },
|
2192
|
+
# })
|
2193
|
+
#
|
2194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/TagResource AWS API Documentation
|
2195
|
+
#
|
2196
|
+
# @overload tag_resource(params = {})
|
2197
|
+
# @param [Hash] params ({})
|
2198
|
+
def tag_resource(params = {}, options = {})
|
2199
|
+
req = build_request(:tag_resource, params)
|
2200
|
+
req.send_request(options)
|
2201
|
+
end
|
2202
|
+
|
2203
|
+
# Tests a custom data identifier.
|
2204
|
+
#
|
2205
|
+
# @option params [Array<String>] :ignore_words
|
2206
|
+
#
|
2207
|
+
# @option params [Array<String>] :keywords
|
2208
|
+
#
|
2209
|
+
# @option params [Integer] :maximum_match_distance
|
2210
|
+
#
|
2211
|
+
# @option params [required, String] :regex
|
2212
|
+
#
|
2213
|
+
# @option params [required, String] :sample_text
|
2214
|
+
#
|
2215
|
+
# @return [Types::TestCustomDataIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2216
|
+
#
|
2217
|
+
# * {Types::TestCustomDataIdentifierResponse#match_count #match_count} => Integer
|
2218
|
+
#
|
2219
|
+
# @example Request syntax with placeholder values
|
2220
|
+
#
|
2221
|
+
# resp = client.test_custom_data_identifier({
|
2222
|
+
# ignore_words: ["__string"],
|
2223
|
+
# keywords: ["__string"],
|
2224
|
+
# maximum_match_distance: 1,
|
2225
|
+
# regex: "__string", # required
|
2226
|
+
# sample_text: "__string", # required
|
2227
|
+
# })
|
2228
|
+
#
|
2229
|
+
# @example Response structure
|
2230
|
+
#
|
2231
|
+
# resp.match_count #=> Integer
|
2232
|
+
#
|
2233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/TestCustomDataIdentifier AWS API Documentation
|
2234
|
+
#
|
2235
|
+
# @overload test_custom_data_identifier(params = {})
|
2236
|
+
# @param [Hash] params ({})
|
2237
|
+
def test_custom_data_identifier(params = {}, options = {})
|
2238
|
+
req = build_request(:test_custom_data_identifier, params)
|
2239
|
+
req.send_request(options)
|
2240
|
+
end
|
2241
|
+
|
2242
|
+
# Reactivates (unarchives) one or more findings.
|
2243
|
+
#
|
2244
|
+
# @option params [required, Array<String>] :finding_ids
|
2245
|
+
#
|
2246
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2247
|
+
#
|
2248
|
+
# @example Request syntax with placeholder values
|
2249
|
+
#
|
2250
|
+
# resp = client.unarchive_findings({
|
2251
|
+
# finding_ids: ["__string"], # required
|
2252
|
+
# })
|
2253
|
+
#
|
2254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/UnarchiveFindings AWS API Documentation
|
2255
|
+
#
|
2256
|
+
# @overload unarchive_findings(params = {})
|
2257
|
+
# @param [Hash] params ({})
|
2258
|
+
def unarchive_findings(params = {}, options = {})
|
2259
|
+
req = build_request(:unarchive_findings, params)
|
2260
|
+
req.send_request(options)
|
2261
|
+
end
|
2262
|
+
|
2263
|
+
# Removes one or more tags (keys and values) from a classification job,
|
2264
|
+
# custom data identifier, findings filter, or member account.
|
2265
|
+
#
|
2266
|
+
# @option params [required, String] :resource_arn
|
2267
|
+
#
|
2268
|
+
# @option params [required, Array<String>] :tag_keys
|
2269
|
+
#
|
2270
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2271
|
+
#
|
2272
|
+
# @example Request syntax with placeholder values
|
2273
|
+
#
|
2274
|
+
# resp = client.untag_resource({
|
2275
|
+
# resource_arn: "__string", # required
|
2276
|
+
# tag_keys: ["__string"], # required
|
2277
|
+
# })
|
2278
|
+
#
|
2279
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/UntagResource AWS API Documentation
|
2280
|
+
#
|
2281
|
+
# @overload untag_resource(params = {})
|
2282
|
+
# @param [Hash] params ({})
|
2283
|
+
def untag_resource(params = {}, options = {})
|
2284
|
+
req = build_request(:untag_resource, params)
|
2285
|
+
req.send_request(options)
|
2286
|
+
end
|
2287
|
+
|
2288
|
+
# Cancels a classification job.
|
2289
|
+
#
|
2290
|
+
# @option params [required, String] :job_id
|
2291
|
+
#
|
2292
|
+
# @option params [required, String] :job_status
|
2293
|
+
# The current status of a classification job. Valid values are:
|
2294
|
+
#
|
2295
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2296
|
+
#
|
2297
|
+
# @example Request syntax with placeholder values
|
2298
|
+
#
|
2299
|
+
# resp = client.update_classification_job({
|
2300
|
+
# job_id: "__string", # required
|
2301
|
+
# job_status: "RUNNING", # required, accepts RUNNING, PAUSED, CANCELLED, COMPLETE, IDLE
|
2302
|
+
# })
|
2303
|
+
#
|
2304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/UpdateClassificationJob AWS API Documentation
|
2305
|
+
#
|
2306
|
+
# @overload update_classification_job(params = {})
|
2307
|
+
# @param [Hash] params ({})
|
2308
|
+
def update_classification_job(params = {}, options = {})
|
2309
|
+
req = build_request(:update_classification_job, params)
|
2310
|
+
req.send_request(options)
|
2311
|
+
end
|
2312
|
+
|
2313
|
+
# Updates the criteria and other settings for a findings filter.
|
2314
|
+
#
|
2315
|
+
# @option params [String] :action
|
2316
|
+
# The action to perform on findings that meet the filter criteria. Valid
|
2317
|
+
# values are:
|
2318
|
+
#
|
2319
|
+
# @option params [String] :description
|
2320
|
+
#
|
2321
|
+
# @option params [Types::FindingCriteria] :finding_criteria
|
2322
|
+
# Specifies, as a map, one or more property-based conditions that filter
|
2323
|
+
# the results of a query for findings.
|
2324
|
+
#
|
2325
|
+
# @option params [required, String] :id
|
2326
|
+
#
|
2327
|
+
# @option params [String] :name
|
2328
|
+
#
|
2329
|
+
# @option params [Integer] :position
|
2330
|
+
#
|
2331
|
+
# @return [Types::UpdateFindingsFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2332
|
+
#
|
2333
|
+
# * {Types::UpdateFindingsFilterResponse#arn #arn} => String
|
2334
|
+
# * {Types::UpdateFindingsFilterResponse#id #id} => String
|
2335
|
+
#
|
2336
|
+
# @example Request syntax with placeholder values
|
2337
|
+
#
|
2338
|
+
# resp = client.update_findings_filter({
|
2339
|
+
# action: "ARCHIVE", # accepts ARCHIVE, NOOP
|
2340
|
+
# description: "__string",
|
2341
|
+
# finding_criteria: {
|
2342
|
+
# criterion: {
|
2343
|
+
# "__string" => {
|
2344
|
+
# eq: ["__string"],
|
2345
|
+
# gt: 1,
|
2346
|
+
# gte: 1,
|
2347
|
+
# lt: 1,
|
2348
|
+
# lte: 1,
|
2349
|
+
# neq: ["__string"],
|
2350
|
+
# },
|
2351
|
+
# },
|
2352
|
+
# },
|
2353
|
+
# id: "__string", # required
|
2354
|
+
# name: "__string",
|
2355
|
+
# position: 1,
|
2356
|
+
# })
|
2357
|
+
#
|
2358
|
+
# @example Response structure
|
2359
|
+
#
|
2360
|
+
# resp.arn #=> String
|
2361
|
+
# resp.id #=> String
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/UpdateFindingsFilter AWS API Documentation
|
2364
|
+
#
|
2365
|
+
# @overload update_findings_filter(params = {})
|
2366
|
+
# @param [Hash] params ({})
|
2367
|
+
def update_findings_filter(params = {}, options = {})
|
2368
|
+
req = build_request(:update_findings_filter, params)
|
2369
|
+
req.send_request(options)
|
2370
|
+
end
|
2371
|
+
|
2372
|
+
# Suspends or re-enables an Amazon Macie account, or updates the
|
2373
|
+
# configuration settings for a Macie account.
|
2374
|
+
#
|
2375
|
+
# @option params [String] :finding_publishing_frequency
|
2376
|
+
# The frequency with which Amazon Macie publishes findings for an
|
2377
|
+
# account. This includes adding findings to AWS Security Hub and
|
2378
|
+
# exporting finding events to Amazon CloudWatch. Valid values are:
|
2379
|
+
#
|
2380
|
+
# @option params [String] :status
|
2381
|
+
# The status of an Amazon Macie account. Valid values are:
|
2382
|
+
#
|
2383
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2384
|
+
#
|
2385
|
+
# @example Request syntax with placeholder values
|
2386
|
+
#
|
2387
|
+
# resp = client.update_macie_session({
|
2388
|
+
# finding_publishing_frequency: "FIFTEEN_MINUTES", # accepts FIFTEEN_MINUTES, ONE_HOUR, SIX_HOURS
|
2389
|
+
# status: "PAUSED", # accepts PAUSED, ENABLED
|
2390
|
+
# })
|
2391
|
+
#
|
2392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/UpdateMacieSession AWS API Documentation
|
2393
|
+
#
|
2394
|
+
# @overload update_macie_session(params = {})
|
2395
|
+
# @param [Hash] params ({})
|
2396
|
+
def update_macie_session(params = {}, options = {})
|
2397
|
+
req = build_request(:update_macie_session, params)
|
2398
|
+
req.send_request(options)
|
2399
|
+
end
|
2400
|
+
|
2401
|
+
# Enables an Amazon Macie master account to suspend or re-enable a
|
2402
|
+
# member account.
|
2403
|
+
#
|
2404
|
+
# @option params [required, String] :id
|
2405
|
+
#
|
2406
|
+
# @option params [required, String] :status
|
2407
|
+
# The status of an Amazon Macie account. Valid values are:
|
2408
|
+
#
|
2409
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2410
|
+
#
|
2411
|
+
# @example Request syntax with placeholder values
|
2412
|
+
#
|
2413
|
+
# resp = client.update_member_session({
|
2414
|
+
# id: "__string", # required
|
2415
|
+
# status: "PAUSED", # required, accepts PAUSED, ENABLED
|
2416
|
+
# })
|
2417
|
+
#
|
2418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/UpdateMemberSession AWS API Documentation
|
2419
|
+
#
|
2420
|
+
# @overload update_member_session(params = {})
|
2421
|
+
# @param [Hash] params ({})
|
2422
|
+
def update_member_session(params = {}, options = {})
|
2423
|
+
req = build_request(:update_member_session, params)
|
2424
|
+
req.send_request(options)
|
2425
|
+
end
|
2426
|
+
|
2427
|
+
# Updates Amazon Macie configuration settings for an AWS organization.
|
2428
|
+
#
|
2429
|
+
# @option params [required, Boolean] :auto_enable
|
2430
|
+
#
|
2431
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2432
|
+
#
|
2433
|
+
# @example Request syntax with placeholder values
|
2434
|
+
#
|
2435
|
+
# resp = client.update_organization_configuration({
|
2436
|
+
# auto_enable: false, # required
|
2437
|
+
# })
|
2438
|
+
#
|
2439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01T00:00:00Z/UpdateOrganizationConfiguration AWS API Documentation
|
2440
|
+
#
|
2441
|
+
# @overload update_organization_configuration(params = {})
|
2442
|
+
# @param [Hash] params ({})
|
2443
|
+
def update_organization_configuration(params = {}, options = {})
|
2444
|
+
req = build_request(:update_organization_configuration, params)
|
2445
|
+
req.send_request(options)
|
2446
|
+
end
|
2447
|
+
|
2448
|
+
# @!endgroup
|
2449
|
+
|
2450
|
+
# @param params ({})
|
2451
|
+
# @api private
|
2452
|
+
def build_request(operation_name, params = {})
|
2453
|
+
handlers = @handlers.for(operation_name)
|
2454
|
+
context = Seahorse::Client::RequestContext.new(
|
2455
|
+
operation_name: operation_name,
|
2456
|
+
operation: config.api.operation(operation_name),
|
2457
|
+
client: self,
|
2458
|
+
params: params,
|
2459
|
+
config: config)
|
2460
|
+
context[:gem_name] = 'aws-sdk-macie2'
|
2461
|
+
context[:gem_version] = '1.0.0'
|
2462
|
+
Seahorse::Client::Request.new(handlers, context)
|
2463
|
+
end
|
2464
|
+
|
2465
|
+
# @api private
|
2466
|
+
# @deprecated
|
2467
|
+
def waiter_names
|
2468
|
+
[]
|
2469
|
+
end
|
2470
|
+
|
2471
|
+
class << self
|
2472
|
+
|
2473
|
+
# @api private
|
2474
|
+
attr_reader :identifier
|
2475
|
+
|
2476
|
+
# @api private
|
2477
|
+
def errors_module
|
2478
|
+
Errors
|
2479
|
+
end
|
2480
|
+
|
2481
|
+
end
|
2482
|
+
end
|
2483
|
+
end
|