aws-sdk-auditmanager 1.15.0 → 1.19.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 +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-auditmanager/client.rb +332 -30
- data/lib/aws-sdk-auditmanager/client_api.rb +212 -0
- data/lib/aws-sdk-auditmanager/types.rb +610 -27
- data/lib/aws-sdk-auditmanager.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '08c91fb1bace7166fe100d644892763707d1c664e4a21874d87cf6e5857656e4'
|
4
|
+
data.tar.gz: b2829eac7bdd395303df5e016c02a4610b863c63ac680d15d6140f0668f8348d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f52c4111b30b4061757371cbdc828459f868516985073c4adccc7de198f850f22dfd8eff1f44210fca031fccd7a91d58ab55e4baea0bf4b250a245f5b089b1c7
|
7
|
+
data.tar.gz: 5cb6d0aa5f40d694f0f35483bb660b6a2b6d3bcd695d3c25d3540b056c4bdf926c13a8ca0f30b55b1624d5d2ecb654d79deb86cdcb545577de59cb4d6dcf78c4
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.19.0 (2022-02-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.18.0 (2021-12-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.17.0 (2021-11-30)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.16.0 (2021-11-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - This release introduces a new feature for Audit Manager: Dashboard views. You can now view insights data for your active assessments, and quickly identify non-compliant evidence that needs to be remediated.
|
23
|
+
|
4
24
|
1.15.0 (2021-11-04)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.19.0
|
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::AuditManager
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::AuditManager
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::AuditManager
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -295,7 +305,7 @@ module Aws::AuditManager
|
|
295
305
|
# seconds to wait when opening a HTTP session before raising a
|
296
306
|
# `Timeout::Error`.
|
297
307
|
#
|
298
|
-
# @option options [
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
299
309
|
# number of seconds to wait for response data. This value can
|
300
310
|
# safely be set per-request on the session.
|
301
311
|
#
|
@@ -311,6 +321,9 @@ module Aws::AuditManager
|
|
311
321
|
# disables this behaviour. This value can safely be set per
|
312
322
|
# request on the session.
|
313
323
|
#
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
325
|
+
# in seconds.
|
326
|
+
#
|
314
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
315
328
|
# HTTP debug output will be sent to the `:logger`.
|
316
329
|
#
|
@@ -1002,7 +1015,7 @@ module Aws::AuditManager
|
|
1002
1015
|
# Deletes a custom framework in Audit Manager.
|
1003
1016
|
#
|
1004
1017
|
# @option params [required, String] :framework_id
|
1005
|
-
# The identifier for the framework.
|
1018
|
+
# The identifier for the custom framework.
|
1006
1019
|
#
|
1007
1020
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1008
1021
|
#
|
@@ -1051,7 +1064,7 @@ module Aws::AuditManager
|
|
1051
1064
|
# Deletes an assessment report from an assessment in Audit Manager.
|
1052
1065
|
#
|
1053
1066
|
# @option params [required, String] :assessment_id
|
1054
|
-
# The identifier for the assessment.
|
1067
|
+
# The unique identifier for the assessment.
|
1055
1068
|
#
|
1056
1069
|
# @option params [required, String] :assessment_report_id
|
1057
1070
|
# The unique identifier for the assessment report.
|
@@ -1077,7 +1090,7 @@ module Aws::AuditManager
|
|
1077
1090
|
# Deletes a custom control in Audit Manager.
|
1078
1091
|
#
|
1079
1092
|
# @option params [required, String] :control_id
|
1080
|
-
# The identifier for the control.
|
1093
|
+
# The unique identifier for the control.
|
1081
1094
|
#
|
1082
1095
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1083
1096
|
#
|
@@ -1149,10 +1162,10 @@ module Aws::AuditManager
|
|
1149
1162
|
# in Audit Manager.
|
1150
1163
|
#
|
1151
1164
|
# @option params [required, String] :assessment_id
|
1152
|
-
# The identifier for the assessment.
|
1165
|
+
# The unique identifier for the assessment.
|
1153
1166
|
#
|
1154
1167
|
# @option params [required, String] :evidence_folder_id
|
1155
|
-
# The identifier for the folder
|
1168
|
+
# The unique identifier for the folder that the evidence is stored in.
|
1156
1169
|
#
|
1157
1170
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1158
1171
|
#
|
@@ -1194,7 +1207,7 @@ module Aws::AuditManager
|
|
1194
1207
|
# Returns an assessment from Audit Manager.
|
1195
1208
|
#
|
1196
1209
|
# @option params [required, String] :assessment_id
|
1197
|
-
# The identifier for the assessment.
|
1210
|
+
# The unique identifier for the assessment.
|
1198
1211
|
#
|
1199
1212
|
# @return [Types::GetAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1200
1213
|
#
|
@@ -1371,10 +1384,10 @@ module Aws::AuditManager
|
|
1371
1384
|
# Returns the URL of an assessment report in Audit Manager.
|
1372
1385
|
#
|
1373
1386
|
# @option params [required, String] :assessment_report_id
|
1374
|
-
# The identifier for the assessment report.
|
1387
|
+
# The unique identifier for the assessment report.
|
1375
1388
|
#
|
1376
1389
|
# @option params [required, String] :assessment_id
|
1377
|
-
# The identifier for the assessment.
|
1390
|
+
# The unique identifier for the assessment.
|
1378
1391
|
#
|
1379
1392
|
# @return [Types::GetAssessmentReportUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1380
1393
|
#
|
@@ -1404,13 +1417,13 @@ module Aws::AuditManager
|
|
1404
1417
|
# Returns a list of changelogs from Audit Manager.
|
1405
1418
|
#
|
1406
1419
|
# @option params [required, String] :assessment_id
|
1407
|
-
# The identifier for the assessment.
|
1420
|
+
# The unique identifier for the assessment.
|
1408
1421
|
#
|
1409
1422
|
# @option params [String] :control_set_id
|
1410
|
-
# The identifier for the control set.
|
1423
|
+
# The unique identifier for the control set.
|
1411
1424
|
#
|
1412
1425
|
# @option params [String] :control_id
|
1413
|
-
# The identifier for the control.
|
1426
|
+
# The unique identifier for the control.
|
1414
1427
|
#
|
1415
1428
|
# @option params [String] :next_token
|
1416
1429
|
# The pagination token that's used to fetch the next set of results.
|
@@ -1554,16 +1567,16 @@ module Aws::AuditManager
|
|
1554
1567
|
# Returns evidence from Audit Manager.
|
1555
1568
|
#
|
1556
1569
|
# @option params [required, String] :assessment_id
|
1557
|
-
# The identifier for the assessment.
|
1570
|
+
# The unique identifier for the assessment.
|
1558
1571
|
#
|
1559
1572
|
# @option params [required, String] :control_set_id
|
1560
|
-
# The identifier for the control set.
|
1573
|
+
# The unique identifier for the control set.
|
1561
1574
|
#
|
1562
1575
|
# @option params [required, String] :evidence_folder_id
|
1563
|
-
# The identifier for the folder that the evidence is stored in.
|
1576
|
+
# The unique identifier for the folder that the evidence is stored in.
|
1564
1577
|
#
|
1565
1578
|
# @option params [required, String] :evidence_id
|
1566
|
-
# The identifier for the evidence.
|
1579
|
+
# The unique identifier for the evidence.
|
1567
1580
|
#
|
1568
1581
|
# @return [Types::GetEvidenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1569
1582
|
#
|
@@ -1680,13 +1693,13 @@ module Aws::AuditManager
|
|
1680
1693
|
# Manager.
|
1681
1694
|
#
|
1682
1695
|
# @option params [required, String] :assessment_id
|
1683
|
-
# The identifier for the assessment.
|
1696
|
+
# The unique identifier for the assessment.
|
1684
1697
|
#
|
1685
1698
|
# @option params [required, String] :control_set_id
|
1686
|
-
# The identifier for the control set.
|
1699
|
+
# The unique identifier for the control set.
|
1687
1700
|
#
|
1688
1701
|
# @option params [required, String] :evidence_folder_id
|
1689
|
-
# The identifier for the folder that the evidence is stored in.
|
1702
|
+
# The unique identifier for the folder that the evidence is stored in.
|
1690
1703
|
#
|
1691
1704
|
# @return [Types::GetEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1692
1705
|
#
|
@@ -1734,7 +1747,7 @@ module Aws::AuditManager
|
|
1734
1747
|
# Manager.
|
1735
1748
|
#
|
1736
1749
|
# @option params [required, String] :assessment_id
|
1737
|
-
# The identifier for the assessment.
|
1750
|
+
# The unique identifier for the assessment.
|
1738
1751
|
#
|
1739
1752
|
# @option params [String] :next_token
|
1740
1753
|
# The pagination token that's used to fetch the next set of results.
|
@@ -1858,6 +1871,65 @@ module Aws::AuditManager
|
|
1858
1871
|
req.send_request(options)
|
1859
1872
|
end
|
1860
1873
|
|
1874
|
+
# Gets the latest analytics data for all your current active
|
1875
|
+
# assessments.
|
1876
|
+
#
|
1877
|
+
# @return [Types::GetInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1878
|
+
#
|
1879
|
+
# * {Types::GetInsightsResponse#insights #insights} => Types::Insights
|
1880
|
+
#
|
1881
|
+
# @example Response structure
|
1882
|
+
#
|
1883
|
+
# resp.insights.active_assessments_count #=> Integer
|
1884
|
+
# resp.insights.noncompliant_evidence_count #=> Integer
|
1885
|
+
# resp.insights.compliant_evidence_count #=> Integer
|
1886
|
+
# resp.insights.inconclusive_evidence_count #=> Integer
|
1887
|
+
# resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
|
1888
|
+
# resp.insights.total_assessment_controls_count #=> Integer
|
1889
|
+
# resp.insights.last_updated #=> Time
|
1890
|
+
#
|
1891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsights AWS API Documentation
|
1892
|
+
#
|
1893
|
+
# @overload get_insights(params = {})
|
1894
|
+
# @param [Hash] params ({})
|
1895
|
+
def get_insights(params = {}, options = {})
|
1896
|
+
req = build_request(:get_insights, params)
|
1897
|
+
req.send_request(options)
|
1898
|
+
end
|
1899
|
+
|
1900
|
+
# Gets the latest analytics data for a specific active assessment.
|
1901
|
+
#
|
1902
|
+
# @option params [required, String] :assessment_id
|
1903
|
+
# The unique identifier for the assessment.
|
1904
|
+
#
|
1905
|
+
# @return [Types::GetInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1906
|
+
#
|
1907
|
+
# * {Types::GetInsightsByAssessmentResponse#insights #insights} => Types::InsightsByAssessment
|
1908
|
+
#
|
1909
|
+
# @example Request syntax with placeholder values
|
1910
|
+
#
|
1911
|
+
# resp = client.get_insights_by_assessment({
|
1912
|
+
# assessment_id: "UUID", # required
|
1913
|
+
# })
|
1914
|
+
#
|
1915
|
+
# @example Response structure
|
1916
|
+
#
|
1917
|
+
# resp.insights.noncompliant_evidence_count #=> Integer
|
1918
|
+
# resp.insights.compliant_evidence_count #=> Integer
|
1919
|
+
# resp.insights.inconclusive_evidence_count #=> Integer
|
1920
|
+
# resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
|
1921
|
+
# resp.insights.total_assessment_controls_count #=> Integer
|
1922
|
+
# resp.insights.last_updated #=> Time
|
1923
|
+
#
|
1924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsightsByAssessment AWS API Documentation
|
1925
|
+
#
|
1926
|
+
# @overload get_insights_by_assessment(params = {})
|
1927
|
+
# @param [Hash] params ({})
|
1928
|
+
def get_insights_by_assessment(params = {}, options = {})
|
1929
|
+
req = build_request(:get_insights_by_assessment, params)
|
1930
|
+
req.send_request(options)
|
1931
|
+
end
|
1932
|
+
|
1861
1933
|
# Returns the name of the delegated Amazon Web Services administrator
|
1862
1934
|
# account for the organization.
|
1863
1935
|
#
|
@@ -1939,6 +2011,67 @@ module Aws::AuditManager
|
|
1939
2011
|
req.send_request(options)
|
1940
2012
|
end
|
1941
2013
|
|
2014
|
+
# Lists the latest analytics data for controls within a specific control
|
2015
|
+
# domain and a specific active assessment.
|
2016
|
+
#
|
2017
|
+
# <note markdown="1"> Control insights are listed only if the control belongs to the control
|
2018
|
+
# domain and assessment that was specified. Moreover, the control must
|
2019
|
+
# have collected evidence on the `lastUpdated` date of
|
2020
|
+
# `controlInsightsByAssessment`. If neither of these conditions are met,
|
2021
|
+
# no data is listed for that control.
|
2022
|
+
#
|
2023
|
+
# </note>
|
2024
|
+
#
|
2025
|
+
# @option params [required, String] :control_domain_id
|
2026
|
+
# The unique identifier for the control domain.
|
2027
|
+
#
|
2028
|
+
# @option params [required, String] :assessment_id
|
2029
|
+
# The unique identifier for the active assessment.
|
2030
|
+
#
|
2031
|
+
# @option params [String] :next_token
|
2032
|
+
# The pagination token that's used to fetch the next set of results.
|
2033
|
+
#
|
2034
|
+
# @option params [Integer] :max_results
|
2035
|
+
# Represents the maximum number of results on a page or for an API
|
2036
|
+
# request call.
|
2037
|
+
#
|
2038
|
+
# @return [Types::ListAssessmentControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2039
|
+
#
|
2040
|
+
# * {Types::ListAssessmentControlInsightsByControlDomainResponse#control_insights_by_assessment #control_insights_by_assessment} => Array<Types::ControlInsightsMetadataByAssessmentItem>
|
2041
|
+
# * {Types::ListAssessmentControlInsightsByControlDomainResponse#next_token #next_token} => String
|
2042
|
+
#
|
2043
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2044
|
+
#
|
2045
|
+
# @example Request syntax with placeholder values
|
2046
|
+
#
|
2047
|
+
# resp = client.list_assessment_control_insights_by_control_domain({
|
2048
|
+
# control_domain_id: "UUID", # required
|
2049
|
+
# assessment_id: "UUID", # required
|
2050
|
+
# next_token: "Token",
|
2051
|
+
# max_results: 1,
|
2052
|
+
# })
|
2053
|
+
#
|
2054
|
+
# @example Response structure
|
2055
|
+
#
|
2056
|
+
# resp.control_insights_by_assessment #=> Array
|
2057
|
+
# resp.control_insights_by_assessment[0].name #=> String
|
2058
|
+
# resp.control_insights_by_assessment[0].id #=> String
|
2059
|
+
# resp.control_insights_by_assessment[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2060
|
+
# resp.control_insights_by_assessment[0].evidence_insights.compliant_evidence_count #=> Integer
|
2061
|
+
# resp.control_insights_by_assessment[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2062
|
+
# resp.control_insights_by_assessment[0].control_set_name #=> String
|
2063
|
+
# resp.control_insights_by_assessment[0].last_updated #=> Time
|
2064
|
+
# resp.next_token #=> String
|
2065
|
+
#
|
2066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain AWS API Documentation
|
2067
|
+
#
|
2068
|
+
# @overload list_assessment_control_insights_by_control_domain(params = {})
|
2069
|
+
# @param [Hash] params ({})
|
2070
|
+
def list_assessment_control_insights_by_control_domain(params = {}, options = {})
|
2071
|
+
req = build_request(:list_assessment_control_insights_by_control_domain, params)
|
2072
|
+
req.send_request(options)
|
2073
|
+
end
|
2074
|
+
|
1942
2075
|
# Returns a list of sent or received share requests for custom
|
1943
2076
|
# frameworks in Audit Manager.
|
1944
2077
|
#
|
@@ -2098,6 +2231,9 @@ module Aws::AuditManager
|
|
2098
2231
|
|
2099
2232
|
# Returns a list of current and past assessments from Audit Manager.
|
2100
2233
|
#
|
2234
|
+
# @option params [String] :status
|
2235
|
+
# The current status of the assessment.
|
2236
|
+
#
|
2101
2237
|
# @option params [String] :next_token
|
2102
2238
|
# The pagination token that's used to fetch the next set of results.
|
2103
2239
|
#
|
@@ -2115,6 +2251,7 @@ module Aws::AuditManager
|
|
2115
2251
|
# @example Request syntax with placeholder values
|
2116
2252
|
#
|
2117
2253
|
# resp = client.list_assessments({
|
2254
|
+
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
2118
2255
|
# next_token: "Token",
|
2119
2256
|
# max_results: 1,
|
2120
2257
|
# })
|
@@ -2154,6 +2291,171 @@ module Aws::AuditManager
|
|
2154
2291
|
req.send_request(options)
|
2155
2292
|
end
|
2156
2293
|
|
2294
|
+
# Lists the latest analytics data for control domains across all of your
|
2295
|
+
# active assessments.
|
2296
|
+
#
|
2297
|
+
# <note markdown="1"> A control domain is listed only if at least one of the controls within
|
2298
|
+
# that domain collected evidence on the `lastUpdated` date of
|
2299
|
+
# `controlDomainInsights`. If this condition isn’t met, no data is
|
2300
|
+
# listed for that control domain.
|
2301
|
+
#
|
2302
|
+
# </note>
|
2303
|
+
#
|
2304
|
+
# @option params [String] :next_token
|
2305
|
+
# The pagination token that's used to fetch the next set of results.
|
2306
|
+
#
|
2307
|
+
# @option params [Integer] :max_results
|
2308
|
+
# Represents the maximum number of results on a page or for an API
|
2309
|
+
# request call.
|
2310
|
+
#
|
2311
|
+
# @return [Types::ListControlDomainInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2312
|
+
#
|
2313
|
+
# * {Types::ListControlDomainInsightsResponse#control_domain_insights #control_domain_insights} => Array<Types::ControlDomainInsights>
|
2314
|
+
# * {Types::ListControlDomainInsightsResponse#next_token #next_token} => String
|
2315
|
+
#
|
2316
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2317
|
+
#
|
2318
|
+
# @example Request syntax with placeholder values
|
2319
|
+
#
|
2320
|
+
# resp = client.list_control_domain_insights({
|
2321
|
+
# next_token: "Token",
|
2322
|
+
# max_results: 1,
|
2323
|
+
# })
|
2324
|
+
#
|
2325
|
+
# @example Response structure
|
2326
|
+
#
|
2327
|
+
# resp.control_domain_insights #=> Array
|
2328
|
+
# resp.control_domain_insights[0].name #=> String
|
2329
|
+
# resp.control_domain_insights[0].id #=> String
|
2330
|
+
# resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
|
2331
|
+
# resp.control_domain_insights[0].total_controls_count #=> Integer
|
2332
|
+
# resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2333
|
+
# resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
|
2334
|
+
# resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2335
|
+
# resp.control_domain_insights[0].last_updated #=> Time
|
2336
|
+
# resp.next_token #=> String
|
2337
|
+
#
|
2338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsights AWS API Documentation
|
2339
|
+
#
|
2340
|
+
# @overload list_control_domain_insights(params = {})
|
2341
|
+
# @param [Hash] params ({})
|
2342
|
+
def list_control_domain_insights(params = {}, options = {})
|
2343
|
+
req = build_request(:list_control_domain_insights, params)
|
2344
|
+
req.send_request(options)
|
2345
|
+
end
|
2346
|
+
|
2347
|
+
# Lists analytics data for control domains within a specified active
|
2348
|
+
# assessment.
|
2349
|
+
#
|
2350
|
+
# <note markdown="1"> A control domain is listed only if at least one of the controls within
|
2351
|
+
# that domain collected evidence on the `lastUpdated` date of
|
2352
|
+
# `controlDomainInsights`. If this condition isn’t met, no data is
|
2353
|
+
# listed for that domain.
|
2354
|
+
#
|
2355
|
+
# </note>
|
2356
|
+
#
|
2357
|
+
# @option params [required, String] :assessment_id
|
2358
|
+
# The unique identifier for the active assessment.
|
2359
|
+
#
|
2360
|
+
# @option params [String] :next_token
|
2361
|
+
# The pagination token that's used to fetch the next set of results.
|
2362
|
+
#
|
2363
|
+
# @option params [Integer] :max_results
|
2364
|
+
# Represents the maximum number of results on a page or for an API
|
2365
|
+
# request call.
|
2366
|
+
#
|
2367
|
+
# @return [Types::ListControlDomainInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2368
|
+
#
|
2369
|
+
# * {Types::ListControlDomainInsightsByAssessmentResponse#control_domain_insights #control_domain_insights} => Array<Types::ControlDomainInsights>
|
2370
|
+
# * {Types::ListControlDomainInsightsByAssessmentResponse#next_token #next_token} => String
|
2371
|
+
#
|
2372
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2373
|
+
#
|
2374
|
+
# @example Request syntax with placeholder values
|
2375
|
+
#
|
2376
|
+
# resp = client.list_control_domain_insights_by_assessment({
|
2377
|
+
# assessment_id: "UUID", # required
|
2378
|
+
# next_token: "Token",
|
2379
|
+
# max_results: 1,
|
2380
|
+
# })
|
2381
|
+
#
|
2382
|
+
# @example Response structure
|
2383
|
+
#
|
2384
|
+
# resp.control_domain_insights #=> Array
|
2385
|
+
# resp.control_domain_insights[0].name #=> String
|
2386
|
+
# resp.control_domain_insights[0].id #=> String
|
2387
|
+
# resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
|
2388
|
+
# resp.control_domain_insights[0].total_controls_count #=> Integer
|
2389
|
+
# resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2390
|
+
# resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
|
2391
|
+
# resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2392
|
+
# resp.control_domain_insights[0].last_updated #=> Time
|
2393
|
+
# resp.next_token #=> String
|
2394
|
+
#
|
2395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment AWS API Documentation
|
2396
|
+
#
|
2397
|
+
# @overload list_control_domain_insights_by_assessment(params = {})
|
2398
|
+
# @param [Hash] params ({})
|
2399
|
+
def list_control_domain_insights_by_assessment(params = {}, options = {})
|
2400
|
+
req = build_request(:list_control_domain_insights_by_assessment, params)
|
2401
|
+
req.send_request(options)
|
2402
|
+
end
|
2403
|
+
|
2404
|
+
# Lists the latest analytics data for controls within a specific control
|
2405
|
+
# domain across all active assessments.
|
2406
|
+
#
|
2407
|
+
# <note markdown="1"> Control insights are listed only if the control belongs to the control
|
2408
|
+
# domain that was specified and the control collected evidence on the
|
2409
|
+
# `lastUpdated` date of `controlInsightsMetadata`. If neither of these
|
2410
|
+
# conditions are met, no data is listed for that control.
|
2411
|
+
#
|
2412
|
+
# </note>
|
2413
|
+
#
|
2414
|
+
# @option params [required, String] :control_domain_id
|
2415
|
+
# The unique identifier for the control domain.
|
2416
|
+
#
|
2417
|
+
# @option params [String] :next_token
|
2418
|
+
# The pagination token that's used to fetch the next set of results.
|
2419
|
+
#
|
2420
|
+
# @option params [Integer] :max_results
|
2421
|
+
# Represents the maximum number of results on a page or for an API
|
2422
|
+
# request call.
|
2423
|
+
#
|
2424
|
+
# @return [Types::ListControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2425
|
+
#
|
2426
|
+
# * {Types::ListControlInsightsByControlDomainResponse#control_insights_metadata #control_insights_metadata} => Array<Types::ControlInsightsMetadataItem>
|
2427
|
+
# * {Types::ListControlInsightsByControlDomainResponse#next_token #next_token} => String
|
2428
|
+
#
|
2429
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2430
|
+
#
|
2431
|
+
# @example Request syntax with placeholder values
|
2432
|
+
#
|
2433
|
+
# resp = client.list_control_insights_by_control_domain({
|
2434
|
+
# control_domain_id: "UUID", # required
|
2435
|
+
# next_token: "Token",
|
2436
|
+
# max_results: 1,
|
2437
|
+
# })
|
2438
|
+
#
|
2439
|
+
# @example Response structure
|
2440
|
+
#
|
2441
|
+
# resp.control_insights_metadata #=> Array
|
2442
|
+
# resp.control_insights_metadata[0].name #=> String
|
2443
|
+
# resp.control_insights_metadata[0].id #=> String
|
2444
|
+
# resp.control_insights_metadata[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2445
|
+
# resp.control_insights_metadata[0].evidence_insights.compliant_evidence_count #=> Integer
|
2446
|
+
# resp.control_insights_metadata[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2447
|
+
# resp.control_insights_metadata[0].last_updated #=> Time
|
2448
|
+
# resp.next_token #=> String
|
2449
|
+
#
|
2450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlInsightsByControlDomain AWS API Documentation
|
2451
|
+
#
|
2452
|
+
# @overload list_control_insights_by_control_domain(params = {})
|
2453
|
+
# @param [Hash] params ({})
|
2454
|
+
def list_control_insights_by_control_domain(params = {}, options = {})
|
2455
|
+
req = build_request(:list_control_insights_by_control_domain, params)
|
2456
|
+
req.send_request(options)
|
2457
|
+
end
|
2458
|
+
|
2157
2459
|
# Returns a list of controls from Audit Manager.
|
2158
2460
|
#
|
2159
2461
|
# @option params [required, String] :control_type
|
@@ -2509,7 +2811,7 @@ module Aws::AuditManager
|
|
2509
2811
|
# Edits an Audit Manager assessment.
|
2510
2812
|
#
|
2511
2813
|
# @option params [required, String] :assessment_id
|
2512
|
-
# The identifier for the assessment.
|
2814
|
+
# The unique identifier for the assessment.
|
2513
2815
|
#
|
2514
2816
|
# @option params [String] :assessment_name
|
2515
2817
|
# The name of the assessment to be updated.
|
@@ -2655,13 +2957,13 @@ module Aws::AuditManager
|
|
2655
2957
|
# Updates a control within an assessment in Audit Manager.
|
2656
2958
|
#
|
2657
2959
|
# @option params [required, String] :assessment_id
|
2658
|
-
# The identifier for the assessment.
|
2960
|
+
# The unique identifier for the assessment.
|
2659
2961
|
#
|
2660
2962
|
# @option params [required, String] :control_set_id
|
2661
|
-
# The identifier for the control set.
|
2963
|
+
# The unique identifier for the control set.
|
2662
2964
|
#
|
2663
2965
|
# @option params [required, String] :control_id
|
2664
|
-
# The identifier for the control.
|
2966
|
+
# The unique identifier for the control.
|
2665
2967
|
#
|
2666
2968
|
# @option params [String] :control_status
|
2667
2969
|
# The status of the control.
|
@@ -2711,10 +3013,10 @@ module Aws::AuditManager
|
|
2711
3013
|
# Updates the status of a control set in an Audit Manager assessment.
|
2712
3014
|
#
|
2713
3015
|
# @option params [required, String] :assessment_id
|
2714
|
-
# The identifier for the assessment.
|
3016
|
+
# The unique identifier for the assessment.
|
2715
3017
|
#
|
2716
3018
|
# @option params [required, String] :control_set_id
|
2717
|
-
# The identifier for the control set.
|
3019
|
+
# The unique identifier for the control set.
|
2718
3020
|
#
|
2719
3021
|
# @option params [required, String] :status
|
2720
3022
|
# The status of the control set that's being updated.
|
@@ -2784,7 +3086,7 @@ module Aws::AuditManager
|
|
2784
3086
|
# Updates a custom framework in Audit Manager.
|
2785
3087
|
#
|
2786
3088
|
# @option params [required, String] :framework_id
|
2787
|
-
# The identifier for the framework.
|
3089
|
+
# The unique identifier for the framework.
|
2788
3090
|
#
|
2789
3091
|
# @option params [required, String] :name
|
2790
3092
|
# The name of the framework to be updated.
|
@@ -2932,7 +3234,7 @@ module Aws::AuditManager
|
|
2932
3234
|
# Updates the status of an assessment in Audit Manager.
|
2933
3235
|
#
|
2934
3236
|
# @option params [required, String] :assessment_id
|
2935
|
-
# The identifier for the assessment.
|
3237
|
+
# The unique identifier for the assessment.
|
2936
3238
|
#
|
2937
3239
|
# @option params [required, String] :status
|
2938
3240
|
# The current status of the assessment.
|
@@ -3234,7 +3536,7 @@ module Aws::AuditManager
|
|
3234
3536
|
params: params,
|
3235
3537
|
config: config)
|
3236
3538
|
context[:gem_name] = 'aws-sdk-auditmanager'
|
3237
|
-
context[:gem_version] = '1.
|
3539
|
+
context[:gem_version] = '1.19.0'
|
3238
3540
|
Seahorse::Client::Request.new(handlers, context)
|
3239
3541
|
end
|
3240
3542
|
|