aws-sdk-securityir 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-securityir/client.rb +2093 -0
- data/lib/aws-sdk-securityir/client_api.rb +951 -0
- data/lib/aws-sdk-securityir/customizations.rb +0 -0
- data/lib/aws-sdk-securityir/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-securityir/endpoint_provider.rb +35 -0
- data/lib/aws-sdk-securityir/endpoints.rb +20 -0
- data/lib/aws-sdk-securityir/errors.rb +258 -0
- data/lib/aws-sdk-securityir/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-securityir/resource.rb +26 -0
- data/lib/aws-sdk-securityir/types.rb +1558 -0
- data/lib/aws-sdk-securityir/waiters.rb +15 -0
- data/lib/aws-sdk-securityir.rb +62 -0
- data/sig/client.rbs +456 -0
- data/sig/errors.rbs +55 -0
- data/sig/resource.rbs +82 -0
- data/sig/types.rbs +474 -0
- data/sig/waiters.rbs +13 -0
- metadata +100 -0
@@ -0,0 +1,15 @@
|
|
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 'aws-sdk-core/waiters'
|
11
|
+
|
12
|
+
module Aws::SecurityIR
|
13
|
+
module Waiters
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,62 @@
|
|
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
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:securityir)
|
15
|
+
|
16
|
+
# This module provides support for Security Incident Response. This module is available in the
|
17
|
+
# `aws-sdk-securityir` gem.
|
18
|
+
#
|
19
|
+
# # Client
|
20
|
+
#
|
21
|
+
# The {Client} class provides one method for each API operation. Operation
|
22
|
+
# methods each accept a hash of request parameters and return a response
|
23
|
+
# structure.
|
24
|
+
#
|
25
|
+
# security_ir = Aws::SecurityIR::Client.new
|
26
|
+
# resp = security_ir.batch_get_member_account_details(params)
|
27
|
+
#
|
28
|
+
# See {Client} for more information.
|
29
|
+
#
|
30
|
+
# # Errors
|
31
|
+
#
|
32
|
+
# Errors returned from Security Incident Response are defined in the
|
33
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
34
|
+
#
|
35
|
+
# begin
|
36
|
+
# # do stuff
|
37
|
+
# rescue Aws::SecurityIR::Errors::ServiceError
|
38
|
+
# # rescues all Security Incident Response API errors
|
39
|
+
# end
|
40
|
+
#
|
41
|
+
# See {Errors} for more information.
|
42
|
+
#
|
43
|
+
# @!group service
|
44
|
+
module Aws::SecurityIR
|
45
|
+
autoload :Types, 'aws-sdk-securityir/types'
|
46
|
+
autoload :ClientApi, 'aws-sdk-securityir/client_api'
|
47
|
+
module Plugins
|
48
|
+
autoload :Endpoints, 'aws-sdk-securityir/plugins/endpoints.rb'
|
49
|
+
end
|
50
|
+
autoload :Client, 'aws-sdk-securityir/client'
|
51
|
+
autoload :Errors, 'aws-sdk-securityir/errors'
|
52
|
+
autoload :Waiters, 'aws-sdk-securityir/waiters'
|
53
|
+
autoload :Resource, 'aws-sdk-securityir/resource'
|
54
|
+
autoload :EndpointParameters, 'aws-sdk-securityir/endpoint_parameters'
|
55
|
+
autoload :EndpointProvider, 'aws-sdk-securityir/endpoint_provider'
|
56
|
+
autoload :Endpoints, 'aws-sdk-securityir/endpoints'
|
57
|
+
|
58
|
+
GEM_VERSION = '1.0.0'
|
59
|
+
|
60
|
+
end
|
61
|
+
|
62
|
+
require_relative 'aws-sdk-securityir/customizations'
|
data/sig/client.rbs
ADDED
@@ -0,0 +1,456 @@
|
|
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/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module SecurityIR
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?account_id: String,
|
19
|
+
?active_endpoint_cache: bool,
|
20
|
+
?adaptive_retry_wait_to_fill: bool,
|
21
|
+
?client_side_monitoring: bool,
|
22
|
+
?client_side_monitoring_client_id: String,
|
23
|
+
?client_side_monitoring_host: String,
|
24
|
+
?client_side_monitoring_port: Integer,
|
25
|
+
?client_side_monitoring_publisher: untyped,
|
26
|
+
?convert_params: bool,
|
27
|
+
?correct_clock_skew: bool,
|
28
|
+
?defaults_mode: String,
|
29
|
+
?disable_host_prefix_injection: bool,
|
30
|
+
?disable_request_compression: bool,
|
31
|
+
?endpoint: String,
|
32
|
+
?endpoint_cache_max_entries: Integer,
|
33
|
+
?endpoint_cache_max_threads: Integer,
|
34
|
+
?endpoint_cache_poll_interval: Integer,
|
35
|
+
?endpoint_discovery: bool,
|
36
|
+
?ignore_configured_endpoint_urls: bool,
|
37
|
+
?log_formatter: untyped,
|
38
|
+
?log_level: Symbol,
|
39
|
+
?logger: untyped,
|
40
|
+
?max_attempts: Integer,
|
41
|
+
?profile: String,
|
42
|
+
?request_min_compression_size_bytes: Integer,
|
43
|
+
?retry_backoff: Proc,
|
44
|
+
?retry_base_delay: Float,
|
45
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
46
|
+
?retry_limit: Integer,
|
47
|
+
?retry_max_delay: Integer,
|
48
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
49
|
+
?sdk_ua_app_id: String,
|
50
|
+
?secret_access_key: String,
|
51
|
+
?session_token: String,
|
52
|
+
?sigv4a_signing_region_set: Array[String],
|
53
|
+
?stub_responses: untyped,
|
54
|
+
?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
|
55
|
+
?token_provider: untyped,
|
56
|
+
?use_dualstack_endpoint: bool,
|
57
|
+
?use_fips_endpoint: bool,
|
58
|
+
?validate_params: bool,
|
59
|
+
?endpoint_provider: untyped,
|
60
|
+
?http_proxy: String,
|
61
|
+
?http_open_timeout: (Float | Integer),
|
62
|
+
?http_read_timeout: (Float | Integer),
|
63
|
+
?http_idle_timeout: (Float | Integer),
|
64
|
+
?http_continue_timeout: (Float | Integer),
|
65
|
+
?ssl_timeout: (Float | Integer | nil),
|
66
|
+
?http_wire_trace: bool,
|
67
|
+
?ssl_verify_peer: bool,
|
68
|
+
?ssl_ca_bundle: String,
|
69
|
+
?ssl_ca_directory: String,
|
70
|
+
?ssl_ca_store: String,
|
71
|
+
?on_chunk_received: Proc,
|
72
|
+
?on_chunk_sent: Proc,
|
73
|
+
?raise_response_errors: bool
|
74
|
+
) -> instance
|
75
|
+
| (?Hash[Symbol, untyped]) -> instance
|
76
|
+
|
77
|
+
|
78
|
+
interface _BatchGetMemberAccountDetailsResponseSuccess
|
79
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::BatchGetMemberAccountDetailsResponse]
|
80
|
+
def items: () -> ::Array[Types::GetMembershipAccountDetailItem]
|
81
|
+
def errors: () -> ::Array[Types::GetMembershipAccountDetailError]
|
82
|
+
end
|
83
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#batch_get_member_account_details-instance_method
|
84
|
+
def batch_get_member_account_details: (
|
85
|
+
membership_id: ::String,
|
86
|
+
account_ids: Array[::String]
|
87
|
+
) -> _BatchGetMemberAccountDetailsResponseSuccess
|
88
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _BatchGetMemberAccountDetailsResponseSuccess
|
89
|
+
|
90
|
+
interface _CancelMembershipResponseSuccess
|
91
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CancelMembershipResponse]
|
92
|
+
def membership_id: () -> ::String
|
93
|
+
end
|
94
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#cancel_membership-instance_method
|
95
|
+
def cancel_membership: (
|
96
|
+
membership_id: ::String
|
97
|
+
) -> _CancelMembershipResponseSuccess
|
98
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelMembershipResponseSuccess
|
99
|
+
|
100
|
+
interface _CloseCaseResponseSuccess
|
101
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CloseCaseResponse]
|
102
|
+
def case_status: () -> ("Submitted" | "Acknowledged" | "Detection and Analysis" | "Containment, Eradication and Recovery" | "Post-incident Activities" | "Ready to Close" | "Closed")
|
103
|
+
def closed_date: () -> ::Time
|
104
|
+
end
|
105
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#close_case-instance_method
|
106
|
+
def close_case: (
|
107
|
+
case_id: ::String
|
108
|
+
) -> _CloseCaseResponseSuccess
|
109
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CloseCaseResponseSuccess
|
110
|
+
|
111
|
+
interface _CreateCaseResponseSuccess
|
112
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCaseResponse]
|
113
|
+
def case_id: () -> ::String
|
114
|
+
end
|
115
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#create_case-instance_method
|
116
|
+
def create_case: (
|
117
|
+
?client_token: ::String,
|
118
|
+
resolver_type: ("AWS" | "Self"),
|
119
|
+
title: ::String,
|
120
|
+
description: ::String,
|
121
|
+
engagement_type: ("Security Incident" | "Investigation"),
|
122
|
+
reported_incident_start_date: ::Time,
|
123
|
+
impacted_accounts: Array[::String],
|
124
|
+
watchers: Array[
|
125
|
+
{
|
126
|
+
email: ::String,
|
127
|
+
name: ::String?,
|
128
|
+
job_title: ::String?
|
129
|
+
},
|
130
|
+
],
|
131
|
+
?threat_actor_ip_addresses: Array[
|
132
|
+
{
|
133
|
+
ip_address: ::String,
|
134
|
+
user_agent: ::String?
|
135
|
+
},
|
136
|
+
],
|
137
|
+
?impacted_services: Array[::String],
|
138
|
+
?impacted_aws_regions: Array[
|
139
|
+
{
|
140
|
+
region: ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-south-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-southeast-5" | "ca-central-1" | "ca-west-1" | "cn-north-1" | "cn-northwest-1" | "eu-central-1" | "eu-central-2" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "il-central-1" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2")
|
141
|
+
},
|
142
|
+
],
|
143
|
+
?tags: Hash[::String, ::String]
|
144
|
+
) -> _CreateCaseResponseSuccess
|
145
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCaseResponseSuccess
|
146
|
+
|
147
|
+
interface _CreateCaseCommentResponseSuccess
|
148
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCaseCommentResponse]
|
149
|
+
def comment_id: () -> ::String
|
150
|
+
end
|
151
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#create_case_comment-instance_method
|
152
|
+
def create_case_comment: (
|
153
|
+
case_id: ::String,
|
154
|
+
?client_token: ::String,
|
155
|
+
body: ::String
|
156
|
+
) -> _CreateCaseCommentResponseSuccess
|
157
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCaseCommentResponseSuccess
|
158
|
+
|
159
|
+
interface _CreateMembershipResponseSuccess
|
160
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateMembershipResponse]
|
161
|
+
def membership_id: () -> ::String
|
162
|
+
end
|
163
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#create_membership-instance_method
|
164
|
+
def create_membership: (
|
165
|
+
?client_token: ::String,
|
166
|
+
membership_name: ::String,
|
167
|
+
incident_response_team: Array[
|
168
|
+
{
|
169
|
+
name: ::String,
|
170
|
+
job_title: ::String,
|
171
|
+
email: ::String
|
172
|
+
},
|
173
|
+
],
|
174
|
+
?opt_in_features: Array[
|
175
|
+
{
|
176
|
+
feature_name: ("Triage"),
|
177
|
+
is_enabled: bool
|
178
|
+
},
|
179
|
+
],
|
180
|
+
?tags: Hash[::String, ::String]
|
181
|
+
) -> _CreateMembershipResponseSuccess
|
182
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateMembershipResponseSuccess
|
183
|
+
|
184
|
+
interface _GetCaseResponseSuccess
|
185
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCaseResponse]
|
186
|
+
def title: () -> ::String
|
187
|
+
def case_arn: () -> ::String
|
188
|
+
def description: () -> ::String
|
189
|
+
def case_status: () -> ("Submitted" | "Acknowledged" | "Detection and Analysis" | "Containment, Eradication and Recovery" | "Post-incident Activities" | "Ready to Close" | "Closed")
|
190
|
+
def engagement_type: () -> ("Security Incident" | "Investigation")
|
191
|
+
def reported_incident_start_date: () -> ::Time
|
192
|
+
def actual_incident_start_date: () -> ::Time
|
193
|
+
def impacted_aws_regions: () -> ::Array[Types::ImpactedAwsRegion]
|
194
|
+
def threat_actor_ip_addresses: () -> ::Array[Types::ThreatActorIp]
|
195
|
+
def pending_action: () -> ("Customer" | "None")
|
196
|
+
def impacted_accounts: () -> ::Array[::String]
|
197
|
+
def watchers: () -> ::Array[Types::Watcher]
|
198
|
+
def created_date: () -> ::Time
|
199
|
+
def last_updated_date: () -> ::Time
|
200
|
+
def closure_code: () -> ("Investigation Completed" | "Not Resolved" | "False Positive" | "Duplicate")
|
201
|
+
def resolver_type: () -> ("AWS" | "Self")
|
202
|
+
def impacted_services: () -> ::Array[::String]
|
203
|
+
def case_attachments: () -> ::Array[Types::CaseAttachmentAttributes]
|
204
|
+
def closed_date: () -> ::Time
|
205
|
+
end
|
206
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#get_case-instance_method
|
207
|
+
def get_case: (
|
208
|
+
case_id: ::String
|
209
|
+
) -> _GetCaseResponseSuccess
|
210
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCaseResponseSuccess
|
211
|
+
|
212
|
+
interface _GetCaseAttachmentDownloadUrlResponseSuccess
|
213
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCaseAttachmentDownloadUrlResponse]
|
214
|
+
def attachment_presigned_url: () -> ::String
|
215
|
+
end
|
216
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#get_case_attachment_download_url-instance_method
|
217
|
+
def get_case_attachment_download_url: (
|
218
|
+
case_id: ::String,
|
219
|
+
attachment_id: ::String
|
220
|
+
) -> _GetCaseAttachmentDownloadUrlResponseSuccess
|
221
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCaseAttachmentDownloadUrlResponseSuccess
|
222
|
+
|
223
|
+
interface _GetCaseAttachmentUploadUrlResponseSuccess
|
224
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCaseAttachmentUploadUrlResponse]
|
225
|
+
def attachment_presigned_url: () -> ::String
|
226
|
+
end
|
227
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#get_case_attachment_upload_url-instance_method
|
228
|
+
def get_case_attachment_upload_url: (
|
229
|
+
case_id: ::String,
|
230
|
+
file_name: ::String,
|
231
|
+
content_length: ::Integer,
|
232
|
+
?client_token: ::String
|
233
|
+
) -> _GetCaseAttachmentUploadUrlResponseSuccess
|
234
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCaseAttachmentUploadUrlResponseSuccess
|
235
|
+
|
236
|
+
interface _GetMembershipResponseSuccess
|
237
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetMembershipResponse]
|
238
|
+
def membership_id: () -> ::String
|
239
|
+
def account_id: () -> ::String
|
240
|
+
def region: () -> ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-south-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-southeast-5" | "ca-central-1" | "ca-west-1" | "cn-north-1" | "cn-northwest-1" | "eu-central-1" | "eu-central-2" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "il-central-1" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2")
|
241
|
+
def membership_name: () -> ::String
|
242
|
+
def membership_arn: () -> ::String
|
243
|
+
def membership_status: () -> ("Active" | "Cancelled" | "Terminated")
|
244
|
+
def membership_activation_timestamp: () -> ::Time
|
245
|
+
def membership_deactivation_timestamp: () -> ::Time
|
246
|
+
def customer_type: () -> ("Standalone" | "Organization")
|
247
|
+
def number_of_accounts_covered: () -> ::Integer
|
248
|
+
def incident_response_team: () -> ::Array[Types::IncidentResponder]
|
249
|
+
def opt_in_features: () -> ::Array[Types::OptInFeature]
|
250
|
+
end
|
251
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#get_membership-instance_method
|
252
|
+
def get_membership: (
|
253
|
+
membership_id: ::String
|
254
|
+
) -> _GetMembershipResponseSuccess
|
255
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetMembershipResponseSuccess
|
256
|
+
|
257
|
+
interface _ListCaseEditsResponseSuccess
|
258
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCaseEditsResponse]
|
259
|
+
def next_token: () -> ::String
|
260
|
+
def items: () -> ::Array[Types::CaseEditItem]
|
261
|
+
def total: () -> ::Integer
|
262
|
+
end
|
263
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#list_case_edits-instance_method
|
264
|
+
def list_case_edits: (
|
265
|
+
?next_token: ::String,
|
266
|
+
?max_results: ::Integer,
|
267
|
+
case_id: ::String
|
268
|
+
) -> _ListCaseEditsResponseSuccess
|
269
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCaseEditsResponseSuccess
|
270
|
+
|
271
|
+
interface _ListCasesResponseSuccess
|
272
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCasesResponse]
|
273
|
+
def next_token: () -> ::String
|
274
|
+
def items: () -> ::Array[Types::ListCasesItem]
|
275
|
+
def total: () -> ::Integer
|
276
|
+
end
|
277
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#list_cases-instance_method
|
278
|
+
def list_cases: (
|
279
|
+
?next_token: ::String,
|
280
|
+
?max_results: ::Integer
|
281
|
+
) -> _ListCasesResponseSuccess
|
282
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCasesResponseSuccess
|
283
|
+
|
284
|
+
interface _ListCommentsResponseSuccess
|
285
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCommentsResponse]
|
286
|
+
def next_token: () -> ::String
|
287
|
+
def items: () -> ::Array[Types::ListCommentsItem]
|
288
|
+
def total: () -> ::Integer
|
289
|
+
end
|
290
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#list_comments-instance_method
|
291
|
+
def list_comments: (
|
292
|
+
?next_token: ::String,
|
293
|
+
?max_results: ::Integer,
|
294
|
+
case_id: ::String
|
295
|
+
) -> _ListCommentsResponseSuccess
|
296
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCommentsResponseSuccess
|
297
|
+
|
298
|
+
interface _ListMembershipsResponseSuccess
|
299
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListMembershipsResponse]
|
300
|
+
def next_token: () -> ::String
|
301
|
+
def items: () -> ::Array[Types::ListMembershipItem]
|
302
|
+
end
|
303
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#list_memberships-instance_method
|
304
|
+
def list_memberships: (
|
305
|
+
?next_token: ::String,
|
306
|
+
?max_results: ::Integer
|
307
|
+
) -> _ListMembershipsResponseSuccess
|
308
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMembershipsResponseSuccess
|
309
|
+
|
310
|
+
interface _ListTagsForResourceResponseSuccess
|
311
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceOutput]
|
312
|
+
def tags: () -> ::Hash[::String, ::String]
|
313
|
+
end
|
314
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#list_tags_for_resource-instance_method
|
315
|
+
def list_tags_for_resource: (
|
316
|
+
resource_arn: ::String
|
317
|
+
) -> _ListTagsForResourceResponseSuccess
|
318
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
319
|
+
|
320
|
+
interface _TagResourceResponseSuccess
|
321
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceOutput]
|
322
|
+
end
|
323
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#tag_resource-instance_method
|
324
|
+
def tag_resource: (
|
325
|
+
resource_arn: ::String,
|
326
|
+
tags: Hash[::String, ::String]
|
327
|
+
) -> _TagResourceResponseSuccess
|
328
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
329
|
+
|
330
|
+
interface _UntagResourceResponseSuccess
|
331
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceOutput]
|
332
|
+
end
|
333
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#untag_resource-instance_method
|
334
|
+
def untag_resource: (
|
335
|
+
resource_arn: ::String,
|
336
|
+
tag_keys: Array[::String]
|
337
|
+
) -> _UntagResourceResponseSuccess
|
338
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
339
|
+
|
340
|
+
interface _UpdateCaseResponseSuccess
|
341
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCaseResponse]
|
342
|
+
end
|
343
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#update_case-instance_method
|
344
|
+
def update_case: (
|
345
|
+
case_id: ::String,
|
346
|
+
?title: ::String,
|
347
|
+
?description: ::String,
|
348
|
+
?reported_incident_start_date: ::Time,
|
349
|
+
?actual_incident_start_date: ::Time,
|
350
|
+
?engagement_type: ("Security Incident" | "Investigation"),
|
351
|
+
?watchers_to_add: Array[
|
352
|
+
{
|
353
|
+
email: ::String,
|
354
|
+
name: ::String?,
|
355
|
+
job_title: ::String?
|
356
|
+
},
|
357
|
+
],
|
358
|
+
?watchers_to_delete: Array[
|
359
|
+
{
|
360
|
+
email: ::String,
|
361
|
+
name: ::String?,
|
362
|
+
job_title: ::String?
|
363
|
+
},
|
364
|
+
],
|
365
|
+
?threat_actor_ip_addresses_to_add: Array[
|
366
|
+
{
|
367
|
+
ip_address: ::String,
|
368
|
+
user_agent: ::String?
|
369
|
+
},
|
370
|
+
],
|
371
|
+
?threat_actor_ip_addresses_to_delete: Array[
|
372
|
+
{
|
373
|
+
ip_address: ::String,
|
374
|
+
user_agent: ::String?
|
375
|
+
},
|
376
|
+
],
|
377
|
+
?impacted_services_to_add: Array[::String],
|
378
|
+
?impacted_services_to_delete: Array[::String],
|
379
|
+
?impacted_aws_regions_to_add: Array[
|
380
|
+
{
|
381
|
+
region: ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-south-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-southeast-5" | "ca-central-1" | "ca-west-1" | "cn-north-1" | "cn-northwest-1" | "eu-central-1" | "eu-central-2" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "il-central-1" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2")
|
382
|
+
},
|
383
|
+
],
|
384
|
+
?impacted_aws_regions_to_delete: Array[
|
385
|
+
{
|
386
|
+
region: ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-south-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-southeast-5" | "ca-central-1" | "ca-west-1" | "cn-north-1" | "cn-northwest-1" | "eu-central-1" | "eu-central-2" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "il-central-1" | "me-central-1" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2")
|
387
|
+
},
|
388
|
+
],
|
389
|
+
?impacted_accounts_to_add: Array[::String],
|
390
|
+
?impacted_accounts_to_delete: Array[::String]
|
391
|
+
) -> _UpdateCaseResponseSuccess
|
392
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCaseResponseSuccess
|
393
|
+
|
394
|
+
interface _UpdateCaseCommentResponseSuccess
|
395
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCaseCommentResponse]
|
396
|
+
def comment_id: () -> ::String
|
397
|
+
def body: () -> ::String
|
398
|
+
end
|
399
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#update_case_comment-instance_method
|
400
|
+
def update_case_comment: (
|
401
|
+
case_id: ::String,
|
402
|
+
comment_id: ::String,
|
403
|
+
body: ::String
|
404
|
+
) -> _UpdateCaseCommentResponseSuccess
|
405
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCaseCommentResponseSuccess
|
406
|
+
|
407
|
+
interface _UpdateCaseStatusResponseSuccess
|
408
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateCaseStatusResponse]
|
409
|
+
def case_status: () -> ("Submitted" | "Detection and Analysis" | "Containment, Eradication and Recovery" | "Post-incident Activities")
|
410
|
+
end
|
411
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#update_case_status-instance_method
|
412
|
+
def update_case_status: (
|
413
|
+
case_id: ::String,
|
414
|
+
case_status: ("Submitted" | "Detection and Analysis" | "Containment, Eradication and Recovery" | "Post-incident Activities")
|
415
|
+
) -> _UpdateCaseStatusResponseSuccess
|
416
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCaseStatusResponseSuccess
|
417
|
+
|
418
|
+
interface _UpdateMembershipResponseSuccess
|
419
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateMembershipResponse]
|
420
|
+
end
|
421
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#update_membership-instance_method
|
422
|
+
def update_membership: (
|
423
|
+
membership_id: ::String,
|
424
|
+
?membership_name: ::String,
|
425
|
+
?incident_response_team: Array[
|
426
|
+
{
|
427
|
+
name: ::String,
|
428
|
+
job_title: ::String,
|
429
|
+
email: ::String
|
430
|
+
},
|
431
|
+
],
|
432
|
+
?opt_in_features: Array[
|
433
|
+
{
|
434
|
+
feature_name: ("Triage"),
|
435
|
+
is_enabled: bool
|
436
|
+
},
|
437
|
+
]
|
438
|
+
) -> _UpdateMembershipResponseSuccess
|
439
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateMembershipResponseSuccess
|
440
|
+
|
441
|
+
interface _UpdateResolverTypeResponseSuccess
|
442
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateResolverTypeResponse]
|
443
|
+
def case_id: () -> ::String
|
444
|
+
def case_status: () -> ("Submitted" | "Acknowledged" | "Detection and Analysis" | "Containment, Eradication and Recovery" | "Post-incident Activities" | "Ready to Close" | "Closed")
|
445
|
+
def resolver_type: () -> ("AWS" | "Self")
|
446
|
+
end
|
447
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#update_resolver_type-instance_method
|
448
|
+
def update_resolver_type: (
|
449
|
+
case_id: ::String,
|
450
|
+
resolver_type: ("AWS" | "Self")
|
451
|
+
) -> _UpdateResolverTypeResponseSuccess
|
452
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateResolverTypeResponseSuccess
|
453
|
+
end
|
454
|
+
end
|
455
|
+
end
|
456
|
+
|
data/sig/errors.rbs
ADDED
@@ -0,0 +1,55 @@
|
|
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/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module SecurityIR
|
10
|
+
module Errors
|
11
|
+
class ServiceError < ::Aws::Errors::ServiceError
|
12
|
+
end
|
13
|
+
|
14
|
+
class AccessDeniedException < ::Aws::Errors::ServiceError
|
15
|
+
def message: () -> ::String
|
16
|
+
end
|
17
|
+
class ConflictException < ::Aws::Errors::ServiceError
|
18
|
+
def message: () -> ::String
|
19
|
+
def resource_id: () -> ::String
|
20
|
+
def resource_type: () -> ::String
|
21
|
+
end
|
22
|
+
class InternalServerException < ::Aws::Errors::ServiceError
|
23
|
+
def message: () -> ::String
|
24
|
+
def retry_after_seconds: () -> ::String
|
25
|
+
end
|
26
|
+
class InvalidTokenException < ::Aws::Errors::ServiceError
|
27
|
+
def message: () -> ::String
|
28
|
+
end
|
29
|
+
class ResourceNotFoundException < ::Aws::Errors::ServiceError
|
30
|
+
def message: () -> ::String
|
31
|
+
end
|
32
|
+
class SecurityIncidentResponseNotActiveException < ::Aws::Errors::ServiceError
|
33
|
+
def message: () -> ::String
|
34
|
+
end
|
35
|
+
class ServiceQuotaExceededException < ::Aws::Errors::ServiceError
|
36
|
+
def message: () -> ::String
|
37
|
+
def resource_id: () -> ::String
|
38
|
+
def resource_type: () -> ::String
|
39
|
+
def service_code: () -> ::String
|
40
|
+
def quota_code: () -> ::String
|
41
|
+
end
|
42
|
+
class ThrottlingException < ::Aws::Errors::ServiceError
|
43
|
+
def message: () -> ::String
|
44
|
+
def service_code: () -> ::String
|
45
|
+
def quota_code: () -> ::String
|
46
|
+
def retry_after_seconds: () -> ::String
|
47
|
+
end
|
48
|
+
class ValidationException < ::Aws::Errors::ServiceError
|
49
|
+
def message: () -> ::String
|
50
|
+
def reason: () -> ::String
|
51
|
+
def field_list: () -> ::String
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|