aws-sdk-abusesignal 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,866 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length'
11
+ require 'aws-sdk-core/plugins/credentials_configuration'
12
+ require 'aws-sdk-core/plugins/logging'
13
+ require 'aws-sdk-core/plugins/param_converter'
14
+ require 'aws-sdk-core/plugins/param_validator'
15
+ require 'aws-sdk-core/plugins/user_agent'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors'
17
+ require 'aws-sdk-core/plugins/retry_errors'
18
+ require 'aws-sdk-core/plugins/global_configuration'
19
+ require 'aws-sdk-core/plugins/regional_endpoint'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern'
22
+ require 'aws-sdk-core/plugins/response_paging'
23
+ require 'aws-sdk-core/plugins/stub_responses'
24
+ require 'aws-sdk-core/plugins/idempotency_token'
25
+ require 'aws-sdk-core/plugins/invocation_id'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin'
29
+ require 'aws-sdk-core/plugins/transfer_encoding'
30
+ require 'aws-sdk-core/plugins/http_checksum'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm'
32
+ require 'aws-sdk-core/plugins/request_compression'
33
+ require 'aws-sdk-core/plugins/defaults_mode'
34
+ require 'aws-sdk-core/plugins/recursion_detection'
35
+ require 'aws-sdk-core/plugins/telemetry'
36
+ require 'aws-sdk-core/plugins/sign'
37
+ require 'aws-sdk-core/plugins/protocols/rest_json'
38
+
39
+ module Aws::AbuseSignal
40
+ # An API client for AbuseSignal. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::AbuseSignal::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :abusesignal
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::InvocationId)
76
+ add_plugin(Aws::Plugins::JsonvalueConverter)
77
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
79
+ add_plugin(Aws::Plugins::TransferEncoding)
80
+ add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::AbuseSignal::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials used for authentication. This can be any class that includes and implements
99
+ # `Aws::CredentialProvider`, or instance of any one of the following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following locations will be searched for credentials:
128
+ #
129
+ # * `Aws.config[:credentials]`
130
+ #
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ #
134
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
135
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
136
+ #
137
+ # * `~/.aws/credentials`
138
+ #
139
+ # * `~/.aws/config`
140
+ #
141
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
142
+ # Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
143
+ # enable retries and extended timeouts. Instance profile credential fetching can be disabled by
144
+ # setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
145
+ #
146
+ # @option options [required, String] :region
147
+ # The AWS region to connect to. The configured `:region` is
148
+ # used to determine the service `:endpoint`. When not passed,
149
+ # a default `:region` is searched for in the following locations:
150
+ #
151
+ # * `Aws.config[:region]`
152
+ # * `ENV['AWS_REGION']`
153
+ # * `ENV['AMAZON_REGION']`
154
+ # * `ENV['AWS_DEFAULT_REGION']`
155
+ # * `~/.aws/credentials`
156
+ # * `~/.aws/config`
157
+ #
158
+ # @option options [String] :access_key_id
159
+ #
160
+ # @option options [String] :account_id
161
+ #
162
+ # @option options [Boolean] :active_endpoint_cache (false)
163
+ # When set to `true`, a thread polling for endpoints will be running in
164
+ # the background every 60 secs (default). Defaults to `false`.
165
+ #
166
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
167
+ # Used only in `adaptive` retry mode. When true, the request will sleep
168
+ # until there is sufficent client side capacity to retry the request.
169
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
170
+ # not retry instead of sleeping.
171
+ #
172
+ # @option options [Array<String>] :auth_scheme_preference
173
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
174
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
175
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
176
+ #
177
+ # @option options [Boolean] :client_side_monitoring (false)
178
+ # When `true`, client-side metrics will be collected for all API requests from
179
+ # this client.
180
+ #
181
+ # @option options [String] :client_side_monitoring_client_id ("")
182
+ # Allows you to provide an identifier for this client which will be attached to
183
+ # all generated client side metrics. Defaults to an empty string.
184
+ #
185
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
186
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
187
+ # side monitoring agent is running on, where client metrics will be published via UDP.
188
+ #
189
+ # @option options [Integer] :client_side_monitoring_port (31000)
190
+ # Required for publishing client metrics. The port that the client side monitoring
191
+ # agent is running on, where client metrics will be published via UDP.
192
+ #
193
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
194
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
195
+ # will use the Client Side Monitoring Agent Publisher.
196
+ #
197
+ # @option options [Boolean] :convert_params (true)
198
+ # When `true`, an attempt is made to coerce request parameters into
199
+ # the required types.
200
+ #
201
+ # @option options [Boolean] :correct_clock_skew (true)
202
+ # Used only in `standard` and `adaptive` retry modes. Specifies whether
203
+ # to apply a clock skew correction and retry requests with skewed client
204
+ # clocks. Takes effect only when `disable_clock_skew_correction` is not set.
205
+ #
206
+ # @option options [String] :defaults_mode ("legacy")
207
+ # See {Aws::DefaultsModeConfiguration} for a list of the
208
+ # accepted modes and the configuration defaults that are included.
209
+ #
210
+ # @option options [Boolean] :disable_clock_skew_correction
211
+ # Used only in `standard` and `adaptive` retry modes. When `true`, the
212
+ # SDK does not apply a clock skew correction, does not update its stored
213
+ # skew from responses, and does not retry clock skew errors. Clock skew
214
+ # correction is enabled by default.
215
+ #
216
+ # @option options [Boolean] :disable_host_prefix_injection (false)
217
+ # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
218
+ #
219
+ # @option options [Boolean] :disable_request_compression (false)
220
+ # When set to 'true' the request body will not be compressed
221
+ # for supported operations.
222
+ #
223
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
224
+ # Normally you should not configure the `:endpoint` option
225
+ # directly. This is normally constructed from the `:region`
226
+ # option. Configuring `:endpoint` is normally reserved for
227
+ # connecting to test or custom endpoints. The endpoint should
228
+ # be a URI formatted like:
229
+ #
230
+ # 'http://example.com'
231
+ # 'https://example.com'
232
+ # 'http://example.com:123'
233
+ #
234
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
235
+ # Used for the maximum size limit of the LRU cache storing endpoints data
236
+ # for endpoint discovery enabled operations. Defaults to 1000.
237
+ #
238
+ # @option options [Integer] :endpoint_cache_max_threads (10)
239
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
240
+ #
241
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
242
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
243
+ # Use this option to config the time interval in seconds for making
244
+ # requests fetching endpoints information. Defaults to 60 sec.
245
+ #
246
+ # @option options [Boolean] :endpoint_discovery (false)
247
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
248
+ #
249
+ # @option options [Boolean] :ignore_configured_endpoint_urls
250
+ # Setting to true disables use of endpoint URLs provided via environment
251
+ # variables and the shared configuration file.
252
+ #
253
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
254
+ # The log formatter.
255
+ #
256
+ # @option options [Symbol] :log_level (:info)
257
+ # The log level to send messages to the `:logger` at.
258
+ #
259
+ # @option options [Logger] :logger
260
+ # The Logger instance to send log messages to. If this option
261
+ # is not set, logging will be disabled.
262
+ #
263
+ # @option options [Integer] :max_attempts (3)
264
+ # An integer representing the maximum number attempts that will be made for
265
+ # a single request, including the initial attempt. For example,
266
+ # setting this value to 5 will result in a request being retried up to
267
+ # 4 times. Used in `standard` and `adaptive` retry modes. Defaults to 3,
268
+ # except for DynamoDB and DynamoDB Streams, which default to 4.
269
+ #
270
+ # @option options [String] :profile ("default")
271
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
272
+ # When not specified, 'default' is used.
273
+ #
274
+ # @option options [String] :request_checksum_calculation ("when_supported")
275
+ # Determines when a checksum will be calculated for request payloads. Values are:
276
+ #
277
+ # * `when_supported` - (default) When set, a checksum will be
278
+ # calculated for all request payloads of operations modeled with the
279
+ # `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
280
+ # `requestAlgorithmMember` is modeled.
281
+ # * `when_required` - When set, a checksum will only be calculated for
282
+ # request payloads of operations modeled with the `httpChecksum` trait where
283
+ # `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
284
+ # is modeled and supplied.
285
+ #
286
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
287
+ # The minimum size in bytes that triggers compression for request
288
+ # bodies. The value must be non-negative integer value between 0
289
+ # and 10485780 bytes inclusive.
290
+ #
291
+ # @option options [String] :response_checksum_validation ("when_supported")
292
+ # Determines when checksum validation will be performed on response payloads. Values are:
293
+ #
294
+ # * `when_supported` - (default) When set, checksum validation is performed on all
295
+ # response payloads of operations modeled with the `httpChecksum` trait where
296
+ # `responseAlgorithms` is modeled, except when no modeled checksum algorithms
297
+ # are supported.
298
+ # * `when_required` - When set, checksum validation is not performed on
299
+ # response payloads of operations unless the checksum algorithm is supported and
300
+ # the `requestValidationModeMember` member is set to `ENABLED`.
301
+ #
302
+ # @option options [Proc] :retry_backoff
303
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
304
+ # This option is only used in the `legacy` retry mode.
305
+ #
306
+ # @option options [Float] :retry_base_delay (0.3)
307
+ # The base delay in seconds used by the default backoff function. This option
308
+ # is only used in the `legacy` retry mode.
309
+ #
310
+ # @option options [Symbol] :retry_jitter (:none)
311
+ # A delay randomiser function used by the default backoff function.
312
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
313
+ # otherwise a Proc that takes and returns a number. This option is only used
314
+ # in the `legacy` retry mode.
315
+ #
316
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
317
+ #
318
+ # @option options [Integer] :retry_limit (3)
319
+ # The maximum number of times to retry failed requests. Only
320
+ # ~ 500 level server errors and certain ~ 400 level client errors
321
+ # are retried. Generally, these are throttling errors, data
322
+ # checksum errors, networking errors, timeout errors, auth errors,
323
+ # endpoint discovery, and errors from expired credentials.
324
+ # This option is only used in the `legacy` retry mode.
325
+ #
326
+ # @option options [Integer] :retry_max_delay (0)
327
+ # The maximum number of seconds to delay between retries (0 for no limit)
328
+ # used by the default backoff function. This option is only used in the
329
+ # `legacy` retry mode.
330
+ #
331
+ # @option options [String] :retry_mode ("standard")
332
+ # Specifies which retry algorithm to use. Values are:
333
+ #
334
+ # * `legacy` - The pre-existing retry behavior.
335
+ #
336
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
337
+ # This includes support for retry quotas, which limit the number of
338
+ # unsuccessful retries a client can make. This is the default value
339
+ # if no retry mode is provided.
340
+ #
341
+ # * `adaptive` - A retry mode that includes all the functionality of
342
+ # `standard` mode along with automatic client side throttling.
343
+ #
344
+ # @option options [String] :sdk_ua_app_id
345
+ # A unique and opaque application ID that is appended to the
346
+ # User-Agent header as app/sdk_ua_app_id. It should have a
347
+ # maximum length of 50. This variable is sourced from environment
348
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
349
+ #
350
+ # @option options [String] :secret_access_key
351
+ #
352
+ # @option options [String] :session_token
353
+ #
354
+ # @option options [Array] :sigv4a_signing_region_set
355
+ # A list of regions that should be signed with SigV4a signing. When
356
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
357
+ # in the following locations:
358
+ #
359
+ # * `Aws.config[:sigv4a_signing_region_set]`
360
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
361
+ # * `~/.aws/config`
362
+ #
363
+ # @option options [Boolean] :stub_responses (false)
364
+ # Causes the client to return stubbed responses. By default
365
+ # fake responses are generated and returned. You can specify
366
+ # the response data to return or errors to raise by calling
367
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
368
+ #
369
+ # ** Please note ** When response stubbing is enabled, no HTTP
370
+ # requests are made, and retries are disabled.
371
+ #
372
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
373
+ # Allows you to provide a telemetry provider, which is used to
374
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
375
+ # will not record or emit any telemetry data. The SDK supports the
376
+ # following telemetry providers:
377
+ #
378
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
379
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
380
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
381
+ #
382
+ # @option options [Aws::TokenProvider] :token_provider
383
+ # Your Bearer token used for authentication. This can be any class that includes and implements
384
+ # `Aws::TokenProvider`, or instance of any one of the following classes:
385
+ #
386
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
387
+ # tokens.
388
+ #
389
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
390
+ # access token generated from `aws login`.
391
+ #
392
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
393
+ # will be used to search for tokens configured for your profile in shared configuration files.
394
+ #
395
+ # @option options [Boolean] :use_dualstack_endpoint
396
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
397
+ # will be used if available.
398
+ #
399
+ # @option options [Boolean] :use_fips_endpoint
400
+ # When set to `true`, fips compatible endpoints will be used if available.
401
+ # When a `fips` region is used, the region is normalized and this config
402
+ # is set to `true`.
403
+ #
404
+ # @option options [Boolean] :validate_params (true)
405
+ # When `true`, request parameters are validated before
406
+ # sending the request.
407
+ #
408
+ # @option options [Aws::AbuseSignal::EndpointProvider] :endpoint_provider
409
+ # The endpoint provider used to resolve endpoints. Any object that responds to
410
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
411
+ # `Aws::AbuseSignal::EndpointParameters`.
412
+ #
413
+ # @option options [Float] :http_continue_timeout (1)
414
+ # The number of seconds to wait for a 100-continue response before sending the
415
+ # request body. This option has no effect unless the request has "Expect"
416
+ # header set to "100-continue". Defaults to `nil` which disables this
417
+ # behaviour. This value can safely be set per request on the session.
418
+ #
419
+ # @option options [Float] :http_idle_timeout (5)
420
+ # The number of seconds a connection is allowed to sit idle before it
421
+ # is considered stale. Stale connections are closed and removed from the
422
+ # pool before making a request.
423
+ #
424
+ # @option options [Float] :http_open_timeout (15)
425
+ # The default number of seconds to wait for response data.
426
+ # This value can safely be set per-request on the session.
427
+ #
428
+ # @option options [URI::HTTP,String] :http_proxy
429
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
430
+ #
431
+ # @option options [Float] :http_read_timeout (60)
432
+ # The default number of seconds to wait for response data.
433
+ # This value can safely be set per-request on the session.
434
+ #
435
+ # @option options [Boolean] :http_wire_trace (false)
436
+ # When `true`, HTTP debug output will be sent to the `:logger`.
437
+ #
438
+ # @option options [Proc] :on_chunk_received
439
+ # When a Proc object is provided, it will be used as callback when each chunk
440
+ # of the response body is received. It provides three arguments: the chunk,
441
+ # the number of bytes received, and the total number of
442
+ # bytes in the response (or nil if the server did not send a `content-length`).
443
+ #
444
+ # @option options [Proc] :on_chunk_sent
445
+ # When a Proc object is provided, it will be used as callback when each chunk
446
+ # of the request body is sent. It provides three arguments: the chunk,
447
+ # the number of bytes read from the body, and the total number of
448
+ # bytes in the body.
449
+ #
450
+ # @option options [Boolean] :raise_response_errors (true)
451
+ # When `true`, response errors are raised.
452
+ #
453
+ # @option options [String] :ssl_ca_bundle
454
+ # Full path to the SSL certificate authority bundle file that should be used when
455
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
456
+ # `:ssl_ca_directory` the the system default will be used if available.
457
+ #
458
+ # @option options [String] :ssl_ca_directory
459
+ # Full path of the directory that contains the unbundled SSL certificate
460
+ # authority files for verifying peer certificates. If you do
461
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
462
+ # default will be used if available.
463
+ #
464
+ # @option options [String] :ssl_ca_store
465
+ # Sets the X509::Store to verify peer certificate.
466
+ #
467
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
468
+ # Sets a client certificate when creating http connections.
469
+ #
470
+ # @option options [OpenSSL::PKey] :ssl_key
471
+ # Sets a client key when creating http connections.
472
+ #
473
+ # @option options [Float] :ssl_timeout
474
+ # Sets the SSL timeout in seconds
475
+ #
476
+ # @option options [Boolean] :ssl_verify_peer (true)
477
+ # When `true`, SSL peer certificates are verified when establishing a connection.
478
+ #
479
+ def initialize(*args)
480
+ super
481
+ end
482
+
483
+ # @!group API Operations
484
+
485
+ # Submits a structured report. Amazon Web Services validates it and
486
+ # returns a report ID. A successful response confirms that Amazon Web
487
+ # Services received your report. It doesn't mean that Amazon Web
488
+ # Services has reached an outcome. Use GetAbuseReportStatus with the
489
+ # report ID to check the report's status and outcome.
490
+ #
491
+ # This operation is idempotent within a time window. If you provide a
492
+ # `clientToken`, duplicate requests within 24 hours return the existing
493
+ # report ID. If you omit it, the service generates a token scoped to 5
494
+ # minutes.
495
+ #
496
+ # **Cross-Region data residency:** By submitting a report, you instruct
497
+ # Amazon Web Services to store it in all supported Regions (`us-east-1`,
498
+ # `us-west-2`, and `eu-west-2`), including across the United States and
499
+ # Europe. If data must remain in a single Region, do not include it in
500
+ # the report.
501
+ #
502
+ # @option params [required, Types::ReportData] :report
503
+ # The abuse report data in XARF format. Provide the report under the
504
+ # `xarf` key.
505
+ #
506
+ # @option params [String] :correlation_id
507
+ # An optional correlation ID for tracking the report in the reporter's
508
+ # system. The service echoes this value back in responses, and you can
509
+ # use it to filter reports with ListAbuseReportStatuses.
510
+ #
511
+ # @option params [String] :client_token
512
+ # An optional, client-provided idempotency token that ensures the
513
+ # operation completes no more than once. If the token matches a previous
514
+ # request within 24 hours, the service returns the existing report ID
515
+ # instead of creating a new report. When you omit this token, the
516
+ # service automatically generates one that is scoped to a 5-minute
517
+ # window.
518
+ #
519
+ # @return [Types::CreateAbuseReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
520
+ #
521
+ # * {Types::CreateAbuseReportResponse#report_id #report_id} => String
522
+ # * {Types::CreateAbuseReportResponse#correlation_id #correlation_id} => String
523
+ #
524
+ #
525
+ # @example Example: Submit an abuse report in X-ARF format
526
+ #
527
+ # resp = client.create_abuse_report({
528
+ # report: {
529
+ # xarf: {
530
+ # },
531
+ # },
532
+ # })
533
+ #
534
+ # resp.to_h outputs the following:
535
+ # {
536
+ # correlation_id: "my-tracking-id-123",
537
+ # report_id: "rpt5a8b3c2d1e4f6g7h8i9j0",
538
+ # }
539
+ #
540
+ # @example Request syntax with placeholder values
541
+ #
542
+ # resp = client.create_abuse_report({
543
+ # report: { # required
544
+ # xarf: {
545
+ # },
546
+ # },
547
+ # correlation_id: "CorrelationId",
548
+ # client_token: "ClientToken",
549
+ # })
550
+ #
551
+ # @example Response structure
552
+ #
553
+ # resp.report_id #=> String
554
+ # resp.correlation_id #=> String
555
+ #
556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/abuse-signal-2026-01-12/CreateAbuseReport AWS API Documentation
557
+ #
558
+ # @overload create_abuse_report(params = {})
559
+ # @param [Hash] params ({})
560
+ def create_abuse_report(params = {}, options = {})
561
+ req = build_request(:create_abuse_report, params)
562
+ req.send_request(options)
563
+ end
564
+
565
+ # Retrieves the current processing status of a previously submitted
566
+ # abuse report, including the status, submission timestamp, and
567
+ # last-update time.
568
+ #
569
+ # You can poll this operation to track the report's status.
570
+ # `PROCESSING` confirms that Amazon Web Services received your report
571
+ # and is processing it. `COMPLETED` means Amazon Web Services finished
572
+ # resolving the report, and the response includes a `reasonCode`. The
573
+ # time to reach `COMPLETED` may vary and can take up to several days
574
+ # depending on the scope and complexity of the suspected abuse.
575
+ #
576
+ # <note markdown="1"> `COMPLETED` is the only terminal status. To wait for a report, use the
577
+ # `ReportProcessing` waiter, which succeeds when the report reaches
578
+ # `PROCESSING` or `COMPLETED`. If you poll this operation yourself, wait
579
+ # 1–5 seconds between calls.
580
+ #
581
+ # </note>
582
+ #
583
+ # @option params [required, String] :report_id
584
+ # The unique identifier of the abuse report to retrieve status for. This
585
+ # is the `reportId` that is returned by CreateAbuseReport.
586
+ #
587
+ # @return [Types::GetAbuseReportStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
588
+ #
589
+ # * {Types::GetAbuseReportStatusResponse#report_id #report_id} => String
590
+ # * {Types::GetAbuseReportStatusResponse#correlation_id #correlation_id} => String
591
+ # * {Types::GetAbuseReportStatusResponse#status #status} => String
592
+ # * {Types::GetAbuseReportStatusResponse#description #description} => String
593
+ # * {Types::GetAbuseReportStatusResponse#reason_code #reason_code} => String
594
+ # * {Types::GetAbuseReportStatusResponse#submitted_at #submitted_at} => Time
595
+ # * {Types::GetAbuseReportStatusResponse#last_updated_at #last_updated_at} => Time
596
+ #
597
+ #
598
+ # @example Example: Get the status of a submitted report
599
+ #
600
+ # resp = client.get_abuse_report_status({
601
+ # report_id: "rpt5a8b3c2d1e4f6g7h8i9j0",
602
+ # })
603
+ #
604
+ # resp.to_h outputs the following:
605
+ # {
606
+ # description: "Report has been successfully submitted to Trust & Safety",
607
+ # report_id: "rpt5a8b3c2d1e4f6g7h8i9j0",
608
+ # status: "PROCESSING",
609
+ # submitted_at: Time.parse("2024-01-01T00:00:00Z"),
610
+ # }
611
+ #
612
+ # @example Request syntax with placeholder values
613
+ #
614
+ # resp = client.get_abuse_report_status({
615
+ # report_id: "ReportId", # required
616
+ # })
617
+ #
618
+ # @example Response structure
619
+ #
620
+ # resp.report_id #=> String
621
+ # resp.correlation_id #=> String
622
+ # resp.status #=> String, one of "QUEUED", "PROCESSING", "COMPLETED"
623
+ # resp.description #=> String
624
+ # resp.reason_code #=> String, one of "ACTIONED", "NOT_RESOLVABLE_TO_AWS", "REVIEWED_NO_AWS_ACTION", "CONTENT_DOWN_OR_INACCESSIBLE", "NEED_MORE_INFORMATION"
625
+ # resp.submitted_at #=> Time
626
+ # resp.last_updated_at #=> Time
627
+ #
628
+ #
629
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
630
+ #
631
+ # * report_processing
632
+ #
633
+ # @see http://docs.aws.amazon.com/goto/WebAPI/abuse-signal-2026-01-12/GetAbuseReportStatus AWS API Documentation
634
+ #
635
+ # @overload get_abuse_report_status(params = {})
636
+ # @param [Hash] params ({})
637
+ def get_abuse_report_status(params = {}, options = {})
638
+ req = build_request(:get_abuse_report_status, params)
639
+ req.send_request(options)
640
+ end
641
+
642
+ # Lists abuse report statuses for the calling account, ordered by
643
+ # submission time, with optional filtering and pagination.
644
+ #
645
+ # Use the `correlationId` parameter to filter results by the
646
+ # reporter-provided correlation ID that was specified during report
647
+ # submission.
648
+ #
649
+ # Results are paginated. Use `nextToken` to retrieve additional results.
650
+ #
651
+ # @option params [String] :correlation_id
652
+ # Filters results by the reporter-provided correlation ID.
653
+ #
654
+ # @option params [String] :next_token
655
+ # The pagination token for retrieving the next page of results. Omit
656
+ # this parameter to return the first page of results.
657
+ #
658
+ # @option params [Integer] :max_results
659
+ # The maximum number of results to return in a single page. Valid range:
660
+ # 1–50. The default is 50.
661
+ #
662
+ # @return [Types::ListAbuseReportStatusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
663
+ #
664
+ # * {Types::ListAbuseReportStatusesResponse#reports #reports} => Array&lt;Types::ReportStatusListItem&gt;
665
+ # * {Types::ListAbuseReportStatusesResponse#next_token #next_token} => String
666
+ #
667
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
668
+ #
669
+ #
670
+ # @example Example: List abuse report statuses
671
+ #
672
+ # resp = client.list_abuse_report_statuses({
673
+ # })
674
+ #
675
+ # resp.to_h outputs the following:
676
+ # {
677
+ # reports: [
678
+ # {
679
+ # description: "Submitted",
680
+ # report_id: "rpt5a8b3c2d1e4f6g7h8i9j0",
681
+ # status: "PROCESSING",
682
+ # },
683
+ # ],
684
+ # }
685
+ #
686
+ # @example Request syntax with placeholder values
687
+ #
688
+ # resp = client.list_abuse_report_statuses({
689
+ # correlation_id: "CorrelationId",
690
+ # next_token: "NextToken",
691
+ # max_results: 1,
692
+ # })
693
+ #
694
+ # @example Response structure
695
+ #
696
+ # resp.reports #=> Array
697
+ # resp.reports[0].report_id #=> String
698
+ # resp.reports[0].correlation_id #=> String
699
+ # resp.reports[0].status #=> String, one of "QUEUED", "PROCESSING", "COMPLETED"
700
+ # resp.reports[0].description #=> String
701
+ # resp.reports[0].reason_code #=> String, one of "ACTIONED", "NOT_RESOLVABLE_TO_AWS", "REVIEWED_NO_AWS_ACTION", "CONTENT_DOWN_OR_INACCESSIBLE", "NEED_MORE_INFORMATION"
702
+ # resp.next_token #=> String
703
+ #
704
+ # @see http://docs.aws.amazon.com/goto/WebAPI/abuse-signal-2026-01-12/ListAbuseReportStatuses AWS API Documentation
705
+ #
706
+ # @overload list_abuse_report_statuses(params = {})
707
+ # @param [Hash] params ({})
708
+ def list_abuse_report_statuses(params = {}, options = {})
709
+ req = build_request(:list_abuse_report_statuses, params)
710
+ req.send_request(options)
711
+ end
712
+
713
+ # @!endgroup
714
+
715
+ # @param params ({})
716
+ # @api private
717
+ def build_request(operation_name, params = {})
718
+ handlers = @handlers.for(operation_name)
719
+ tracer = config.telemetry_provider.tracer_provider.tracer(
720
+ Aws::Telemetry.module_to_tracer_name('Aws::AbuseSignal')
721
+ )
722
+ context = Seahorse::Client::RequestContext.new(
723
+ operation_name: operation_name,
724
+ operation: config.api.operation(operation_name),
725
+ client: self,
726
+ params: params,
727
+ config: config,
728
+ tracer: tracer
729
+ )
730
+ context[:gem_name] = 'aws-sdk-abusesignal'
731
+ context[:gem_version] = '1.0.0'
732
+ Seahorse::Client::Request.new(handlers, context)
733
+ end
734
+
735
+ # Polls an API operation until a resource enters a desired state.
736
+ #
737
+ # ## Basic Usage
738
+ #
739
+ # A waiter will call an API operation until:
740
+ #
741
+ # * It is successful
742
+ # * It enters a terminal state
743
+ # * It makes the maximum number of attempts
744
+ #
745
+ # In between attempts, the waiter will sleep.
746
+ #
747
+ # # polls in a loop, sleeping between attempts
748
+ # client.wait_until(waiter_name, params)
749
+ #
750
+ # ## Configuration
751
+ #
752
+ # You can configure the maximum number of polling attempts, and the
753
+ # delay (in seconds) between each polling attempt. You can pass
754
+ # configuration as the final arguments hash.
755
+ #
756
+ # # poll for ~25 seconds
757
+ # client.wait_until(waiter_name, params, {
758
+ # max_attempts: 5,
759
+ # delay: 5,
760
+ # })
761
+ #
762
+ # ## Callbacks
763
+ #
764
+ # You can be notified before each polling attempt and before each
765
+ # delay. If you throw `:success` or `:failure` from these callbacks,
766
+ # it will terminate the waiter.
767
+ #
768
+ # started_at = Time.now
769
+ # client.wait_until(waiter_name, params, {
770
+ #
771
+ # # disable max attempts
772
+ # max_attempts: nil,
773
+ #
774
+ # # poll for 1 hour, instead of a number of attempts
775
+ # before_wait: -> (attempts, response) do
776
+ # throw :failure if Time.now - started_at > 3600
777
+ # end
778
+ # })
779
+ #
780
+ # ## Handling Errors
781
+ #
782
+ # When a waiter is unsuccessful, it will raise an error.
783
+ # All of the failure errors extend from
784
+ # {Aws::Waiters::Errors::WaiterFailed}.
785
+ #
786
+ # begin
787
+ # client.wait_until(...)
788
+ # rescue Aws::Waiters::Errors::WaiterFailed
789
+ # # resource did not enter the desired state in time
790
+ # end
791
+ #
792
+ # ## Valid Waiters
793
+ #
794
+ # The following table lists the valid waiter names, the operations they call,
795
+ # and the default `:delay` and `:max_attempts` values.
796
+ #
797
+ # | waiter_name | params | :delay | :max_attempts |
798
+ # | ----------------- | -------------------------------- | -------- | ------------- |
799
+ # | report_processing | {Client#get_abuse_report_status} | 1 | 5 |
800
+ #
801
+ # @raise [Errors::FailureStateError] Raised when the waiter terminates
802
+ # because the waiter has entered a state that it will not transition
803
+ # out of, preventing success.
804
+ #
805
+ # @raise [Errors::TooManyAttemptsError] Raised when the configured
806
+ # maximum number of attempts have been made, and the waiter is not
807
+ # yet successful.
808
+ #
809
+ # @raise [Errors::UnexpectedError] Raised when an error is encounted
810
+ # while polling for a resource that is not expected.
811
+ #
812
+ # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
813
+ # for an unknown state.
814
+ #
815
+ # @return [Boolean] Returns `true` if the waiter was successful.
816
+ # @param [Symbol] waiter_name
817
+ # @param [Hash] params ({})
818
+ # @param [Hash] options ({})
819
+ # @option options [Integer] :max_attempts
820
+ # @option options [Integer] :delay
821
+ # @option options [Proc] :before_attempt
822
+ # @option options [Proc] :before_wait
823
+ def wait_until(waiter_name, params = {}, options = {})
824
+ w = waiter(waiter_name, options)
825
+ yield(w.waiter) if block_given? # deprecated
826
+ w.wait(params)
827
+ end
828
+
829
+ # @api private
830
+ # @deprecated
831
+ def waiter_names
832
+ waiters.keys
833
+ end
834
+
835
+ private
836
+
837
+ # @param [Symbol] waiter_name
838
+ # @param [Hash] options ({})
839
+ def waiter(waiter_name, options = {})
840
+ waiter_class = waiters[waiter_name]
841
+ if waiter_class
842
+ waiter_class.new(options.merge(client: self))
843
+ else
844
+ raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
845
+ end
846
+ end
847
+
848
+ def waiters
849
+ {
850
+ report_processing: Waiters::ReportProcessing
851
+ }
852
+ end
853
+
854
+ class << self
855
+
856
+ # @api private
857
+ attr_reader :identifier
858
+
859
+ # @api private
860
+ def errors_module
861
+ Errors
862
+ end
863
+
864
+ end
865
+ end
866
+ end