aws-sdk-securityir 1.28.0 → 1.29.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ab5f48e407999188b745303e23863cc8cbd191f5fc721256c0642585d8e115b
4
- data.tar.gz: c8dad78f4996e7c0a9ddf5643cd593c01e7b9d198684b341c9ff7c1e09b7a0b2
3
+ metadata.gz: 75fa61c5ac1ae27b711677de79f50ce6d8363899895de8dc6d14ac6afda9267a
4
+ data.tar.gz: fdcc5e9e6b4b5e677ea3e539372e0b2613c341d0e02b1c24b90624bbf29a2fcb
5
5
  SHA512:
6
- metadata.gz: 312dda872598ca73b944a6bbf80661f106e42fe72987a7f2d8887bf5c666d0c7f051efc15285c48d6907d798c85ffda5ef3e1da122fbd5b94111b8240a8c6a96
7
- data.tar.gz: f8f9a64f2b81820ddd1828f3d91ad71632a5825bb563f4d8670f022b529edd63b502e2420f16c6fcb9d8f4fcff2bd568a5b3425cbf7c090fcc67b93db222aa0b
6
+ metadata.gz: e1a2d2e6e87d6f29d3fa8eab647b57cab22505216b42da3e45c61429e6c337fc99418f4851eb76f3204ba3f29da6201c96c4c4d9e970f955696b70bbad85069f
7
+ data.tar.gz: e2b3449e6471c2195a4d0f1a6c302d2725aacc0b1a1525ef1713358564ec7d502b9805dbe1be2146785a35ced16435bf52d81c21c5fb79b80afbcbed4d0459e9
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.29.0 (2026-10-08)
5
+ ------------------
6
+
7
+ * Feature - Adds support for retrieving finding-lifecycle metrics for an AWS Security Incident Response membership.
8
+
4
9
  1.28.0 (2026-09-11)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.28.0
1
+ 1.29.0
@@ -1224,6 +1224,86 @@ module Aws::SecurityIR
1224
1224
  req.send_request(options)
1225
1225
  end
1226
1226
 
1227
+ # Returns finding-lifecycle metrics for a membership over a date range.
1228
+ #
1229
+ # @option params [required, String] :membership_id
1230
+ # The membership ID to retrieve metrics for.
1231
+ #
1232
+ # @option params [required, Time,DateTime,Date,Integer,String] :start_date
1233
+ # The start of the day-aligned UTC window, inclusive.
1234
+ #
1235
+ # @option params [required, Time,DateTime,Date,Integer,String] :end_date
1236
+ # The end of the day-aligned UTC window, inclusive.
1237
+ #
1238
+ # @return [Types::GetFindingMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1239
+ #
1240
+ # * {Types::GetFindingMetricsResponse#findings_ingested_security_hub #findings_ingested_security_hub} => Integer
1241
+ # * {Types::GetFindingMetricsResponse#findings_ingested_guard_duty #findings_ingested_guard_duty} => Integer
1242
+ # * {Types::GetFindingMetricsResponse#findings_triaged #findings_triaged} => Integer
1243
+ # * {Types::GetFindingMetricsResponse#findings_triaged_false_positive #findings_triaged_false_positive} => Integer
1244
+ # * {Types::GetFindingMetricsResponse#findings_investigated #findings_investigated} => Integer
1245
+ # * {Types::GetFindingMetricsResponse#findings_investigated_false_positive #findings_investigated_false_positive} => Integer
1246
+ # * {Types::GetFindingMetricsResponse#findings_escalated #findings_escalated} => Integer
1247
+ # * {Types::GetFindingMetricsResponse#findings_escalated_false_positive #findings_escalated_false_positive} => Integer
1248
+ # * {Types::GetFindingMetricsResponse#findings_true_positive #findings_true_positive} => Integer
1249
+ # * {Types::GetFindingMetricsResponse#findings_investigated_in_progress #findings_investigated_in_progress} => Integer
1250
+ # * {Types::GetFindingMetricsResponse#findings_escalated_in_progress #findings_escalated_in_progress} => Integer
1251
+ #
1252
+ #
1253
+ # @example Example: Retrieve finding-lifecycle metrics for a membership
1254
+ #
1255
+ # resp = client.get_finding_metrics({
1256
+ # end_date: Time.parse("2026-08-18T00:00:00Z"),
1257
+ # membership_id: "m-a1b2c3d4e5f",
1258
+ # start_date: Time.parse("2026-08-01T00:00:00Z"),
1259
+ # })
1260
+ #
1261
+ # resp.to_h outputs the following:
1262
+ # {
1263
+ # findings_escalated: 8,
1264
+ # findings_escalated_false_positive: 2,
1265
+ # findings_escalated_in_progress: 0,
1266
+ # findings_ingested_guard_duty: 45,
1267
+ # findings_ingested_security_hub: 120,
1268
+ # findings_investigated: 60,
1269
+ # findings_investigated_false_positive: 12,
1270
+ # findings_investigated_in_progress: 40,
1271
+ # findings_triaged: 165,
1272
+ # findings_triaged_false_positive: 30,
1273
+ # findings_true_positive: 6,
1274
+ # }
1275
+ #
1276
+ # @example Request syntax with placeholder values
1277
+ #
1278
+ # resp = client.get_finding_metrics({
1279
+ # membership_id: "MembershipId", # required
1280
+ # start_date: Time.now, # required
1281
+ # end_date: Time.now, # required
1282
+ # })
1283
+ #
1284
+ # @example Response structure
1285
+ #
1286
+ # resp.findings_ingested_security_hub #=> Integer
1287
+ # resp.findings_ingested_guard_duty #=> Integer
1288
+ # resp.findings_triaged #=> Integer
1289
+ # resp.findings_triaged_false_positive #=> Integer
1290
+ # resp.findings_investigated #=> Integer
1291
+ # resp.findings_investigated_false_positive #=> Integer
1292
+ # resp.findings_escalated #=> Integer
1293
+ # resp.findings_escalated_false_positive #=> Integer
1294
+ # resp.findings_true_positive #=> Integer
1295
+ # resp.findings_investigated_in_progress #=> Integer
1296
+ # resp.findings_escalated_in_progress #=> Integer
1297
+ #
1298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetFindingMetrics AWS API Documentation
1299
+ #
1300
+ # @overload get_finding_metrics(params = {})
1301
+ # @param [Hash] params ({})
1302
+ def get_finding_metrics(params = {}, options = {})
1303
+ req = build_request(:get_finding_metrics, params)
1304
+ req.send_request(options)
1305
+ end
1306
+
1227
1307
  # Returns the attributes of a membership.
1228
1308
  #
1229
1309
  # @option params [required, String] :membership_id
@@ -2385,7 +2465,7 @@ module Aws::SecurityIR
2385
2465
  tracer: tracer
2386
2466
  )
2387
2467
  context[:gem_name] = 'aws-sdk-securityir'
2388
- context[:gem_version] = '1.28.0'
2468
+ context[:gem_version] = '1.29.0'
2389
2469
  Seahorse::Client::Request.new(handlers, context)
2390
2470
  end
2391
2471
 
@@ -74,6 +74,8 @@ module Aws::SecurityIR
74
74
  GetCaseAttachmentUploadUrlResponse = Shapes::StructureShape.new(name: 'GetCaseAttachmentUploadUrlResponse')
75
75
  GetCaseRequest = Shapes::StructureShape.new(name: 'GetCaseRequest')
76
76
  GetCaseResponse = Shapes::StructureShape.new(name: 'GetCaseResponse')
77
+ GetFindingMetricsRequest = Shapes::StructureShape.new(name: 'GetFindingMetricsRequest')
78
+ GetFindingMetricsResponse = Shapes::StructureShape.new(name: 'GetFindingMetricsResponse')
77
79
  GetMembershipAccountDetailError = Shapes::StructureShape.new(name: 'GetMembershipAccountDetailError')
78
80
  GetMembershipAccountDetailErrors = Shapes::ListShape.new(name: 'GetMembershipAccountDetailErrors')
79
81
  GetMembershipAccountDetailItem = Shapes::StructureShape.new(name: 'GetMembershipAccountDetailItem')
@@ -319,6 +321,24 @@ module Aws::SecurityIR
319
321
  GetCaseResponse.add_member(:case_metadata, Shapes::ShapeRef.new(shape: CaseMetadata, location_name: "caseMetadata"))
320
322
  GetCaseResponse.struct_class = Types::GetCaseResponse
321
323
 
324
+ GetFindingMetricsRequest.add_member(:membership_id, Shapes::ShapeRef.new(shape: MembershipId, required: true, location: "uri", location_name: "membershipId"))
325
+ GetFindingMetricsRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "startDate"))
326
+ GetFindingMetricsRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "endDate"))
327
+ GetFindingMetricsRequest.struct_class = Types::GetFindingMetricsRequest
328
+
329
+ GetFindingMetricsResponse.add_member(:findings_ingested_security_hub, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsIngestedSecurityHub"))
330
+ GetFindingMetricsResponse.add_member(:findings_ingested_guard_duty, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsIngestedGuardDuty"))
331
+ GetFindingMetricsResponse.add_member(:findings_triaged, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsTriaged"))
332
+ GetFindingMetricsResponse.add_member(:findings_triaged_false_positive, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsTriagedFalsePositive"))
333
+ GetFindingMetricsResponse.add_member(:findings_investigated, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsInvestigated"))
334
+ GetFindingMetricsResponse.add_member(:findings_investigated_false_positive, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsInvestigatedFalsePositive"))
335
+ GetFindingMetricsResponse.add_member(:findings_escalated, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsEscalated"))
336
+ GetFindingMetricsResponse.add_member(:findings_escalated_false_positive, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsEscalatedFalsePositive"))
337
+ GetFindingMetricsResponse.add_member(:findings_true_positive, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsTruePositive"))
338
+ GetFindingMetricsResponse.add_member(:findings_investigated_in_progress, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsInvestigatedInProgress"))
339
+ GetFindingMetricsResponse.add_member(:findings_escalated_in_progress, Shapes::ShapeRef.new(shape: Long, required: true, location_name: "findingsEscalatedInProgress"))
340
+ GetFindingMetricsResponse.struct_class = Types::GetFindingMetricsResponse
341
+
322
342
  GetMembershipAccountDetailError.add_member(:account_id, Shapes::ShapeRef.new(shape: AWSAccountId, required: true, location_name: "accountId"))
323
343
  GetMembershipAccountDetailError.add_member(:error, Shapes::ShapeRef.new(shape: String, required: true, location_name: "error"))
324
344
  GetMembershipAccountDetailError.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
@@ -793,6 +813,23 @@ module Aws::SecurityIR
793
813
  o.errors << Shapes::ShapeRef.new(shape: InvalidTokenException)
794
814
  end)
795
815
 
816
+ api.add_operation(:get_finding_metrics, Seahorse::Model::Operation.new.tap do |o|
817
+ o.name = "GetFindingMetrics"
818
+ o.http_method = "GET"
819
+ o.http_request_uri = "/v1/membership/{membershipId}/finding-metrics"
820
+ o.input = Shapes::ShapeRef.new(shape: GetFindingMetricsRequest)
821
+ o.output = Shapes::ShapeRef.new(shape: GetFindingMetricsResponse)
822
+ o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
823
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
824
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
825
+ o.errors << Shapes::ShapeRef.new(shape: SecurityIncidentResponseNotActiveException)
826
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
827
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
828
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
829
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
830
+ o.errors << Shapes::ShapeRef.new(shape: InvalidTokenException)
831
+ end)
832
+
796
833
  api.add_operation(:get_membership, Seahorse::Model::Operation.new.tap do |o|
797
834
  o.name = "GetMembership"
798
835
  o.http_method = "GET"
@@ -678,6 +678,101 @@ module Aws::SecurityIR
678
678
  include Aws::Structure
679
679
  end
680
680
 
681
+ # @!attribute [rw] membership_id
682
+ # The membership ID to retrieve metrics for.
683
+ # @return [String]
684
+ #
685
+ # @!attribute [rw] start_date
686
+ # The start of the day-aligned UTC window, inclusive.
687
+ # @return [Time]
688
+ #
689
+ # @!attribute [rw] end_date
690
+ # The end of the day-aligned UTC window, inclusive.
691
+ # @return [Time]
692
+ #
693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetFindingMetricsRequest AWS API Documentation
694
+ #
695
+ class GetFindingMetricsRequest < Struct.new(
696
+ :membership_id,
697
+ :start_date,
698
+ :end_date)
699
+ SENSITIVE = []
700
+ include Aws::Structure
701
+ end
702
+
703
+ # Finding-lifecycle metrics for a membership over the requested date
704
+ # range.
705
+ #
706
+ # @!attribute [rw] findings_ingested_security_hub
707
+ # The number of findings ingested from AWS Security Hub during the
708
+ # requested date range.
709
+ # @return [Integer]
710
+ #
711
+ # @!attribute [rw] findings_ingested_guard_duty
712
+ # The number of findings ingested from Amazon GuardDuty during the
713
+ # requested date range.
714
+ # @return [Integer]
715
+ #
716
+ # @!attribute [rw] findings_triaged
717
+ # The number of findings triaged during the requested date range.
718
+ # @return [Integer]
719
+ #
720
+ # @!attribute [rw] findings_triaged_false_positive
721
+ # The number of triaged findings that were closed as false positives
722
+ # during the requested date range.
723
+ # @return [Integer]
724
+ #
725
+ # @!attribute [rw] findings_investigated
726
+ # The number of findings investigated during the requested date range.
727
+ # @return [Integer]
728
+ #
729
+ # @!attribute [rw] findings_investigated_false_positive
730
+ # The number of investigated findings that were closed as false
731
+ # positives during the requested date range.
732
+ # @return [Integer]
733
+ #
734
+ # @!attribute [rw] findings_escalated
735
+ # The number of findings escalated during the requested date range.
736
+ # @return [Integer]
737
+ #
738
+ # @!attribute [rw] findings_escalated_false_positive
739
+ # The number of escalated findings that were closed as false positives
740
+ # during the requested date range.
741
+ # @return [Integer]
742
+ #
743
+ # @!attribute [rw] findings_true_positive
744
+ # The number of findings confirmed as true positives during the
745
+ # requested date range.
746
+ # @return [Integer]
747
+ #
748
+ # @!attribute [rw] findings_investigated_in_progress
749
+ # The number of findings whose investigation was in progress during
750
+ # the requested date range.
751
+ # @return [Integer]
752
+ #
753
+ # @!attribute [rw] findings_escalated_in_progress
754
+ # The number of findings whose escalation was in progress during the
755
+ # requested date range.
756
+ # @return [Integer]
757
+ #
758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/GetFindingMetricsResponse AWS API Documentation
759
+ #
760
+ class GetFindingMetricsResponse < Struct.new(
761
+ :findings_ingested_security_hub,
762
+ :findings_ingested_guard_duty,
763
+ :findings_triaged,
764
+ :findings_triaged_false_positive,
765
+ :findings_investigated,
766
+ :findings_investigated_false_positive,
767
+ :findings_escalated,
768
+ :findings_escalated_false_positive,
769
+ :findings_true_positive,
770
+ :findings_investigated_in_progress,
771
+ :findings_escalated_in_progress)
772
+ SENSITIVE = []
773
+ include Aws::Structure
774
+ end
775
+
681
776
  # @!attribute [rw] account_id
682
777
  # @return [String]
683
778
  #
@@ -55,7 +55,7 @@ module Aws::SecurityIR
55
55
  autoload :EndpointProvider, 'aws-sdk-securityir/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-securityir/endpoints'
57
57
 
58
- GEM_VERSION = '1.28.0'
58
+ GEM_VERSION = '1.29.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -239,6 +239,28 @@ module Aws
239
239
  ) -> _GetCaseAttachmentUploadUrlResponseSuccess
240
240
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCaseAttachmentUploadUrlResponseSuccess
241
241
 
242
+ interface _GetFindingMetricsResponseSuccess
243
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetFindingMetricsResponse]
244
+ def findings_ingested_security_hub: () -> ::Integer
245
+ def findings_ingested_guard_duty: () -> ::Integer
246
+ def findings_triaged: () -> ::Integer
247
+ def findings_triaged_false_positive: () -> ::Integer
248
+ def findings_investigated: () -> ::Integer
249
+ def findings_investigated_false_positive: () -> ::Integer
250
+ def findings_escalated: () -> ::Integer
251
+ def findings_escalated_false_positive: () -> ::Integer
252
+ def findings_true_positive: () -> ::Integer
253
+ def findings_investigated_in_progress: () -> ::Integer
254
+ def findings_escalated_in_progress: () -> ::Integer
255
+ end
256
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SecurityIR/Client.html#get_finding_metrics-instance_method
257
+ def get_finding_metrics: (
258
+ membership_id: ::String,
259
+ start_date: ::Time,
260
+ end_date: ::Time
261
+ ) -> _GetFindingMetricsResponseSuccess
262
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFindingMetricsResponseSuccess
263
+
242
264
  interface _GetMembershipResponseSuccess
243
265
  include ::Seahorse::Client::_ResponseSuccess[Types::GetMembershipResponse]
244
266
  def membership_id: () -> ::String
data/sig/types.rbs CHANGED
@@ -177,6 +177,28 @@ module Aws::SecurityIR
177
177
  SENSITIVE: [:title, :description]
178
178
  end
179
179
 
180
+ class GetFindingMetricsRequest
181
+ attr_accessor membership_id: ::String
182
+ attr_accessor start_date: ::Time
183
+ attr_accessor end_date: ::Time
184
+ SENSITIVE: []
185
+ end
186
+
187
+ class GetFindingMetricsResponse
188
+ attr_accessor findings_ingested_security_hub: ::Integer
189
+ attr_accessor findings_ingested_guard_duty: ::Integer
190
+ attr_accessor findings_triaged: ::Integer
191
+ attr_accessor findings_triaged_false_positive: ::Integer
192
+ attr_accessor findings_investigated: ::Integer
193
+ attr_accessor findings_investigated_false_positive: ::Integer
194
+ attr_accessor findings_escalated: ::Integer
195
+ attr_accessor findings_escalated_false_positive: ::Integer
196
+ attr_accessor findings_true_positive: ::Integer
197
+ attr_accessor findings_investigated_in_progress: ::Integer
198
+ attr_accessor findings_escalated_in_progress: ::Integer
199
+ SENSITIVE: []
200
+ end
201
+
180
202
  class GetMembershipAccountDetailError
181
203
  attr_accessor account_id: ::String
182
204
  attr_accessor error: ::String
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-securityir
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.28.0
4
+ version: 1.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services