aws-sdk-auditmanager 1.14.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-auditmanager/client.rb +339 -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: 1a569af173feae7639924a392295410b41335bea45288c67673aff6583e21eab
|
4
|
+
data.tar.gz: 15e4f24bc0ab6c0b0f73d17a16e91f2a5045cd7b42fd6b1b26d8111491da2d3a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0b8a96949e328d06a44c768cf58f966e27bfda267a64914ba19a4fba10fb78ca2b3e290b171820d06f975010e02938114c064289ea79cc6211db40e0f2c50ec2
|
7
|
+
data.tar.gz: 024bd0ef984633bb1f77dcf3a82718800120f9d54bcf45a9d62db0d969b3e414319ec9fcda04c6775ba0f479a95a8995fecaaee0ba7174c85a9d741fb89c290b
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.18.0 (2021-12-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.17.0 (2021-11-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.16.0 (2021-11-18)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* 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.
|
18
|
+
|
19
|
+
1.15.0 (2021-11-04)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.14.0 (2021-10-25)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.18.0
|
@@ -27,6 +27,7 @@ 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'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::AuditManager
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::AuditManager
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::AuditManager
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -275,6 +283,15 @@ module Aws::AuditManager
|
|
275
283
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
284
|
# requests are made, and retries are disabled.
|
277
285
|
#
|
286
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
287
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
288
|
+
# will be used if available.
|
289
|
+
#
|
290
|
+
# @option options [Boolean] :use_fips_endpoint
|
291
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
292
|
+
# When a `fips` region is used, the region is normalized and this config
|
293
|
+
# is set to `true`.
|
294
|
+
#
|
278
295
|
# @option options [Boolean] :validate_params (true)
|
279
296
|
# When `true`, request parameters are validated before
|
280
297
|
# sending the request.
|
@@ -286,7 +303,7 @@ module Aws::AuditManager
|
|
286
303
|
# seconds to wait when opening a HTTP session before raising a
|
287
304
|
# `Timeout::Error`.
|
288
305
|
#
|
289
|
-
# @option options [
|
306
|
+
# @option options [Float] :http_read_timeout (60) The default
|
290
307
|
# number of seconds to wait for response data. This value can
|
291
308
|
# safely be set per-request on the session.
|
292
309
|
#
|
@@ -302,6 +319,9 @@ module Aws::AuditManager
|
|
302
319
|
# disables this behaviour. This value can safely be set per
|
303
320
|
# request on the session.
|
304
321
|
#
|
322
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
323
|
+
# in seconds.
|
324
|
+
#
|
305
325
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
306
326
|
# HTTP debug output will be sent to the `:logger`.
|
307
327
|
#
|
@@ -993,7 +1013,7 @@ module Aws::AuditManager
|
|
993
1013
|
# Deletes a custom framework in Audit Manager.
|
994
1014
|
#
|
995
1015
|
# @option params [required, String] :framework_id
|
996
|
-
# The identifier for the framework.
|
1016
|
+
# The identifier for the custom framework.
|
997
1017
|
#
|
998
1018
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
999
1019
|
#
|
@@ -1042,7 +1062,7 @@ module Aws::AuditManager
|
|
1042
1062
|
# Deletes an assessment report from an assessment in Audit Manager.
|
1043
1063
|
#
|
1044
1064
|
# @option params [required, String] :assessment_id
|
1045
|
-
# The identifier for the assessment.
|
1065
|
+
# The unique identifier for the assessment.
|
1046
1066
|
#
|
1047
1067
|
# @option params [required, String] :assessment_report_id
|
1048
1068
|
# The unique identifier for the assessment report.
|
@@ -1068,7 +1088,7 @@ module Aws::AuditManager
|
|
1068
1088
|
# Deletes a custom control in Audit Manager.
|
1069
1089
|
#
|
1070
1090
|
# @option params [required, String] :control_id
|
1071
|
-
# The identifier for the control.
|
1091
|
+
# The unique identifier for the control.
|
1072
1092
|
#
|
1073
1093
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1074
1094
|
#
|
@@ -1140,10 +1160,10 @@ module Aws::AuditManager
|
|
1140
1160
|
# in Audit Manager.
|
1141
1161
|
#
|
1142
1162
|
# @option params [required, String] :assessment_id
|
1143
|
-
# The identifier for the assessment.
|
1163
|
+
# The unique identifier for the assessment.
|
1144
1164
|
#
|
1145
1165
|
# @option params [required, String] :evidence_folder_id
|
1146
|
-
# The identifier for the folder
|
1166
|
+
# The unique identifier for the folder that the evidence is stored in.
|
1147
1167
|
#
|
1148
1168
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1149
1169
|
#
|
@@ -1185,7 +1205,7 @@ module Aws::AuditManager
|
|
1185
1205
|
# Returns an assessment from Audit Manager.
|
1186
1206
|
#
|
1187
1207
|
# @option params [required, String] :assessment_id
|
1188
|
-
# The identifier for the assessment.
|
1208
|
+
# The unique identifier for the assessment.
|
1189
1209
|
#
|
1190
1210
|
# @return [Types::GetAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1191
1211
|
#
|
@@ -1362,10 +1382,10 @@ module Aws::AuditManager
|
|
1362
1382
|
# Returns the URL of an assessment report in Audit Manager.
|
1363
1383
|
#
|
1364
1384
|
# @option params [required, String] :assessment_report_id
|
1365
|
-
# The identifier for the assessment report.
|
1385
|
+
# The unique identifier for the assessment report.
|
1366
1386
|
#
|
1367
1387
|
# @option params [required, String] :assessment_id
|
1368
|
-
# The identifier for the assessment.
|
1388
|
+
# The unique identifier for the assessment.
|
1369
1389
|
#
|
1370
1390
|
# @return [Types::GetAssessmentReportUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1371
1391
|
#
|
@@ -1395,13 +1415,13 @@ module Aws::AuditManager
|
|
1395
1415
|
# Returns a list of changelogs from Audit Manager.
|
1396
1416
|
#
|
1397
1417
|
# @option params [required, String] :assessment_id
|
1398
|
-
# The identifier for the assessment.
|
1418
|
+
# The unique identifier for the assessment.
|
1399
1419
|
#
|
1400
1420
|
# @option params [String] :control_set_id
|
1401
|
-
# The identifier for the control set.
|
1421
|
+
# The unique identifier for the control set.
|
1402
1422
|
#
|
1403
1423
|
# @option params [String] :control_id
|
1404
|
-
# The identifier for the control.
|
1424
|
+
# The unique identifier for the control.
|
1405
1425
|
#
|
1406
1426
|
# @option params [String] :next_token
|
1407
1427
|
# The pagination token that's used to fetch the next set of results.
|
@@ -1545,16 +1565,16 @@ module Aws::AuditManager
|
|
1545
1565
|
# Returns evidence from Audit Manager.
|
1546
1566
|
#
|
1547
1567
|
# @option params [required, String] :assessment_id
|
1548
|
-
# The identifier for the assessment.
|
1568
|
+
# The unique identifier for the assessment.
|
1549
1569
|
#
|
1550
1570
|
# @option params [required, String] :control_set_id
|
1551
|
-
# The identifier for the control set.
|
1571
|
+
# The unique identifier for the control set.
|
1552
1572
|
#
|
1553
1573
|
# @option params [required, String] :evidence_folder_id
|
1554
|
-
# The identifier for the folder that the evidence is stored in.
|
1574
|
+
# The unique identifier for the folder that the evidence is stored in.
|
1555
1575
|
#
|
1556
1576
|
# @option params [required, String] :evidence_id
|
1557
|
-
# The identifier for the evidence.
|
1577
|
+
# The unique identifier for the evidence.
|
1558
1578
|
#
|
1559
1579
|
# @return [Types::GetEvidenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1560
1580
|
#
|
@@ -1671,13 +1691,13 @@ module Aws::AuditManager
|
|
1671
1691
|
# Manager.
|
1672
1692
|
#
|
1673
1693
|
# @option params [required, String] :assessment_id
|
1674
|
-
# The identifier for the assessment.
|
1694
|
+
# The unique identifier for the assessment.
|
1675
1695
|
#
|
1676
1696
|
# @option params [required, String] :control_set_id
|
1677
|
-
# The identifier for the control set.
|
1697
|
+
# The unique identifier for the control set.
|
1678
1698
|
#
|
1679
1699
|
# @option params [required, String] :evidence_folder_id
|
1680
|
-
# The identifier for the folder that the evidence is stored in.
|
1700
|
+
# The unique identifier for the folder that the evidence is stored in.
|
1681
1701
|
#
|
1682
1702
|
# @return [Types::GetEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1683
1703
|
#
|
@@ -1725,7 +1745,7 @@ module Aws::AuditManager
|
|
1725
1745
|
# Manager.
|
1726
1746
|
#
|
1727
1747
|
# @option params [required, String] :assessment_id
|
1728
|
-
# The identifier for the assessment.
|
1748
|
+
# The unique identifier for the assessment.
|
1729
1749
|
#
|
1730
1750
|
# @option params [String] :next_token
|
1731
1751
|
# The pagination token that's used to fetch the next set of results.
|
@@ -1849,6 +1869,65 @@ module Aws::AuditManager
|
|
1849
1869
|
req.send_request(options)
|
1850
1870
|
end
|
1851
1871
|
|
1872
|
+
# Gets the latest analytics data for all your current active
|
1873
|
+
# assessments.
|
1874
|
+
#
|
1875
|
+
# @return [Types::GetInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1876
|
+
#
|
1877
|
+
# * {Types::GetInsightsResponse#insights #insights} => Types::Insights
|
1878
|
+
#
|
1879
|
+
# @example Response structure
|
1880
|
+
#
|
1881
|
+
# resp.insights.active_assessments_count #=> Integer
|
1882
|
+
# resp.insights.noncompliant_evidence_count #=> Integer
|
1883
|
+
# resp.insights.compliant_evidence_count #=> Integer
|
1884
|
+
# resp.insights.inconclusive_evidence_count #=> Integer
|
1885
|
+
# resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
|
1886
|
+
# resp.insights.total_assessment_controls_count #=> Integer
|
1887
|
+
# resp.insights.last_updated #=> Time
|
1888
|
+
#
|
1889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsights AWS API Documentation
|
1890
|
+
#
|
1891
|
+
# @overload get_insights(params = {})
|
1892
|
+
# @param [Hash] params ({})
|
1893
|
+
def get_insights(params = {}, options = {})
|
1894
|
+
req = build_request(:get_insights, params)
|
1895
|
+
req.send_request(options)
|
1896
|
+
end
|
1897
|
+
|
1898
|
+
# Gets the latest analytics data for a specific active assessment.
|
1899
|
+
#
|
1900
|
+
# @option params [required, String] :assessment_id
|
1901
|
+
# The unique identifier for the assessment.
|
1902
|
+
#
|
1903
|
+
# @return [Types::GetInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1904
|
+
#
|
1905
|
+
# * {Types::GetInsightsByAssessmentResponse#insights #insights} => Types::InsightsByAssessment
|
1906
|
+
#
|
1907
|
+
# @example Request syntax with placeholder values
|
1908
|
+
#
|
1909
|
+
# resp = client.get_insights_by_assessment({
|
1910
|
+
# assessment_id: "UUID", # required
|
1911
|
+
# })
|
1912
|
+
#
|
1913
|
+
# @example Response structure
|
1914
|
+
#
|
1915
|
+
# resp.insights.noncompliant_evidence_count #=> Integer
|
1916
|
+
# resp.insights.compliant_evidence_count #=> Integer
|
1917
|
+
# resp.insights.inconclusive_evidence_count #=> Integer
|
1918
|
+
# resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
|
1919
|
+
# resp.insights.total_assessment_controls_count #=> Integer
|
1920
|
+
# resp.insights.last_updated #=> Time
|
1921
|
+
#
|
1922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsightsByAssessment AWS API Documentation
|
1923
|
+
#
|
1924
|
+
# @overload get_insights_by_assessment(params = {})
|
1925
|
+
# @param [Hash] params ({})
|
1926
|
+
def get_insights_by_assessment(params = {}, options = {})
|
1927
|
+
req = build_request(:get_insights_by_assessment, params)
|
1928
|
+
req.send_request(options)
|
1929
|
+
end
|
1930
|
+
|
1852
1931
|
# Returns the name of the delegated Amazon Web Services administrator
|
1853
1932
|
# account for the organization.
|
1854
1933
|
#
|
@@ -1930,6 +2009,67 @@ module Aws::AuditManager
|
|
1930
2009
|
req.send_request(options)
|
1931
2010
|
end
|
1932
2011
|
|
2012
|
+
# Lists the latest analytics data for controls within a specific control
|
2013
|
+
# domain and a specific active assessment.
|
2014
|
+
#
|
2015
|
+
# <note markdown="1"> Control insights are listed only if the control belongs to the control
|
2016
|
+
# domain and assessment that was specified. Moreover, the control must
|
2017
|
+
# have collected evidence on the `lastUpdated` date of
|
2018
|
+
# `controlInsightsByAssessment`. If neither of these conditions are met,
|
2019
|
+
# no data is listed for that control.
|
2020
|
+
#
|
2021
|
+
# </note>
|
2022
|
+
#
|
2023
|
+
# @option params [required, String] :control_domain_id
|
2024
|
+
# The unique identifier for the control domain.
|
2025
|
+
#
|
2026
|
+
# @option params [required, String] :assessment_id
|
2027
|
+
# The unique identifier for the active assessment.
|
2028
|
+
#
|
2029
|
+
# @option params [String] :next_token
|
2030
|
+
# The pagination token that's used to fetch the next set of results.
|
2031
|
+
#
|
2032
|
+
# @option params [Integer] :max_results
|
2033
|
+
# Represents the maximum number of results on a page or for an API
|
2034
|
+
# request call.
|
2035
|
+
#
|
2036
|
+
# @return [Types::ListAssessmentControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2037
|
+
#
|
2038
|
+
# * {Types::ListAssessmentControlInsightsByControlDomainResponse#control_insights_by_assessment #control_insights_by_assessment} => Array<Types::ControlInsightsMetadataByAssessmentItem>
|
2039
|
+
# * {Types::ListAssessmentControlInsightsByControlDomainResponse#next_token #next_token} => String
|
2040
|
+
#
|
2041
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2042
|
+
#
|
2043
|
+
# @example Request syntax with placeholder values
|
2044
|
+
#
|
2045
|
+
# resp = client.list_assessment_control_insights_by_control_domain({
|
2046
|
+
# control_domain_id: "UUID", # required
|
2047
|
+
# assessment_id: "UUID", # required
|
2048
|
+
# next_token: "Token",
|
2049
|
+
# max_results: 1,
|
2050
|
+
# })
|
2051
|
+
#
|
2052
|
+
# @example Response structure
|
2053
|
+
#
|
2054
|
+
# resp.control_insights_by_assessment #=> Array
|
2055
|
+
# resp.control_insights_by_assessment[0].name #=> String
|
2056
|
+
# resp.control_insights_by_assessment[0].id #=> String
|
2057
|
+
# resp.control_insights_by_assessment[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2058
|
+
# resp.control_insights_by_assessment[0].evidence_insights.compliant_evidence_count #=> Integer
|
2059
|
+
# resp.control_insights_by_assessment[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2060
|
+
# resp.control_insights_by_assessment[0].control_set_name #=> String
|
2061
|
+
# resp.control_insights_by_assessment[0].last_updated #=> Time
|
2062
|
+
# resp.next_token #=> String
|
2063
|
+
#
|
2064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain AWS API Documentation
|
2065
|
+
#
|
2066
|
+
# @overload list_assessment_control_insights_by_control_domain(params = {})
|
2067
|
+
# @param [Hash] params ({})
|
2068
|
+
def list_assessment_control_insights_by_control_domain(params = {}, options = {})
|
2069
|
+
req = build_request(:list_assessment_control_insights_by_control_domain, params)
|
2070
|
+
req.send_request(options)
|
2071
|
+
end
|
2072
|
+
|
1933
2073
|
# Returns a list of sent or received share requests for custom
|
1934
2074
|
# frameworks in Audit Manager.
|
1935
2075
|
#
|
@@ -2089,6 +2229,9 @@ module Aws::AuditManager
|
|
2089
2229
|
|
2090
2230
|
# Returns a list of current and past assessments from Audit Manager.
|
2091
2231
|
#
|
2232
|
+
# @option params [String] :status
|
2233
|
+
# The current status of the assessment.
|
2234
|
+
#
|
2092
2235
|
# @option params [String] :next_token
|
2093
2236
|
# The pagination token that's used to fetch the next set of results.
|
2094
2237
|
#
|
@@ -2106,6 +2249,7 @@ module Aws::AuditManager
|
|
2106
2249
|
# @example Request syntax with placeholder values
|
2107
2250
|
#
|
2108
2251
|
# resp = client.list_assessments({
|
2252
|
+
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
2109
2253
|
# next_token: "Token",
|
2110
2254
|
# max_results: 1,
|
2111
2255
|
# })
|
@@ -2145,6 +2289,171 @@ module Aws::AuditManager
|
|
2145
2289
|
req.send_request(options)
|
2146
2290
|
end
|
2147
2291
|
|
2292
|
+
# Lists the latest analytics data for control domains across all of your
|
2293
|
+
# active assessments.
|
2294
|
+
#
|
2295
|
+
# <note markdown="1"> A control domain is listed only if at least one of the controls within
|
2296
|
+
# that domain collected evidence on the `lastUpdated` date of
|
2297
|
+
# `controlDomainInsights`. If this condition isn’t met, no data is
|
2298
|
+
# listed for that control domain.
|
2299
|
+
#
|
2300
|
+
# </note>
|
2301
|
+
#
|
2302
|
+
# @option params [String] :next_token
|
2303
|
+
# The pagination token that's used to fetch the next set of results.
|
2304
|
+
#
|
2305
|
+
# @option params [Integer] :max_results
|
2306
|
+
# Represents the maximum number of results on a page or for an API
|
2307
|
+
# request call.
|
2308
|
+
#
|
2309
|
+
# @return [Types::ListControlDomainInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2310
|
+
#
|
2311
|
+
# * {Types::ListControlDomainInsightsResponse#control_domain_insights #control_domain_insights} => Array<Types::ControlDomainInsights>
|
2312
|
+
# * {Types::ListControlDomainInsightsResponse#next_token #next_token} => String
|
2313
|
+
#
|
2314
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2315
|
+
#
|
2316
|
+
# @example Request syntax with placeholder values
|
2317
|
+
#
|
2318
|
+
# resp = client.list_control_domain_insights({
|
2319
|
+
# next_token: "Token",
|
2320
|
+
# max_results: 1,
|
2321
|
+
# })
|
2322
|
+
#
|
2323
|
+
# @example Response structure
|
2324
|
+
#
|
2325
|
+
# resp.control_domain_insights #=> Array
|
2326
|
+
# resp.control_domain_insights[0].name #=> String
|
2327
|
+
# resp.control_domain_insights[0].id #=> String
|
2328
|
+
# resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
|
2329
|
+
# resp.control_domain_insights[0].total_controls_count #=> Integer
|
2330
|
+
# resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2331
|
+
# resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
|
2332
|
+
# resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2333
|
+
# resp.control_domain_insights[0].last_updated #=> Time
|
2334
|
+
# resp.next_token #=> String
|
2335
|
+
#
|
2336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsights AWS API Documentation
|
2337
|
+
#
|
2338
|
+
# @overload list_control_domain_insights(params = {})
|
2339
|
+
# @param [Hash] params ({})
|
2340
|
+
def list_control_domain_insights(params = {}, options = {})
|
2341
|
+
req = build_request(:list_control_domain_insights, params)
|
2342
|
+
req.send_request(options)
|
2343
|
+
end
|
2344
|
+
|
2345
|
+
# Lists analytics data for control domains within a specified active
|
2346
|
+
# assessment.
|
2347
|
+
#
|
2348
|
+
# <note markdown="1"> A control domain is listed only if at least one of the controls within
|
2349
|
+
# that domain collected evidence on the `lastUpdated` date of
|
2350
|
+
# `controlDomainInsights`. If this condition isn’t met, no data is
|
2351
|
+
# listed for that domain.
|
2352
|
+
#
|
2353
|
+
# </note>
|
2354
|
+
#
|
2355
|
+
# @option params [required, String] :assessment_id
|
2356
|
+
# The unique identifier for the active assessment.
|
2357
|
+
#
|
2358
|
+
# @option params [String] :next_token
|
2359
|
+
# The pagination token that's used to fetch the next set of results.
|
2360
|
+
#
|
2361
|
+
# @option params [Integer] :max_results
|
2362
|
+
# Represents the maximum number of results on a page or for an API
|
2363
|
+
# request call.
|
2364
|
+
#
|
2365
|
+
# @return [Types::ListControlDomainInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2366
|
+
#
|
2367
|
+
# * {Types::ListControlDomainInsightsByAssessmentResponse#control_domain_insights #control_domain_insights} => Array<Types::ControlDomainInsights>
|
2368
|
+
# * {Types::ListControlDomainInsightsByAssessmentResponse#next_token #next_token} => String
|
2369
|
+
#
|
2370
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2371
|
+
#
|
2372
|
+
# @example Request syntax with placeholder values
|
2373
|
+
#
|
2374
|
+
# resp = client.list_control_domain_insights_by_assessment({
|
2375
|
+
# assessment_id: "UUID", # required
|
2376
|
+
# next_token: "Token",
|
2377
|
+
# max_results: 1,
|
2378
|
+
# })
|
2379
|
+
#
|
2380
|
+
# @example Response structure
|
2381
|
+
#
|
2382
|
+
# resp.control_domain_insights #=> Array
|
2383
|
+
# resp.control_domain_insights[0].name #=> String
|
2384
|
+
# resp.control_domain_insights[0].id #=> String
|
2385
|
+
# resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
|
2386
|
+
# resp.control_domain_insights[0].total_controls_count #=> Integer
|
2387
|
+
# resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2388
|
+
# resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
|
2389
|
+
# resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2390
|
+
# resp.control_domain_insights[0].last_updated #=> Time
|
2391
|
+
# resp.next_token #=> String
|
2392
|
+
#
|
2393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment AWS API Documentation
|
2394
|
+
#
|
2395
|
+
# @overload list_control_domain_insights_by_assessment(params = {})
|
2396
|
+
# @param [Hash] params ({})
|
2397
|
+
def list_control_domain_insights_by_assessment(params = {}, options = {})
|
2398
|
+
req = build_request(:list_control_domain_insights_by_assessment, params)
|
2399
|
+
req.send_request(options)
|
2400
|
+
end
|
2401
|
+
|
2402
|
+
# Lists the latest analytics data for controls within a specific control
|
2403
|
+
# domain across all active assessments.
|
2404
|
+
#
|
2405
|
+
# <note markdown="1"> Control insights are listed only if the control belongs to the control
|
2406
|
+
# domain that was specified and the control collected evidence on the
|
2407
|
+
# `lastUpdated` date of `controlInsightsMetadata`. If neither of these
|
2408
|
+
# conditions are met, no data is listed for that control.
|
2409
|
+
#
|
2410
|
+
# </note>
|
2411
|
+
#
|
2412
|
+
# @option params [required, String] :control_domain_id
|
2413
|
+
# The unique identifier for the control domain.
|
2414
|
+
#
|
2415
|
+
# @option params [String] :next_token
|
2416
|
+
# The pagination token that's used to fetch the next set of results.
|
2417
|
+
#
|
2418
|
+
# @option params [Integer] :max_results
|
2419
|
+
# Represents the maximum number of results on a page or for an API
|
2420
|
+
# request call.
|
2421
|
+
#
|
2422
|
+
# @return [Types::ListControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2423
|
+
#
|
2424
|
+
# * {Types::ListControlInsightsByControlDomainResponse#control_insights_metadata #control_insights_metadata} => Array<Types::ControlInsightsMetadataItem>
|
2425
|
+
# * {Types::ListControlInsightsByControlDomainResponse#next_token #next_token} => String
|
2426
|
+
#
|
2427
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2428
|
+
#
|
2429
|
+
# @example Request syntax with placeholder values
|
2430
|
+
#
|
2431
|
+
# resp = client.list_control_insights_by_control_domain({
|
2432
|
+
# control_domain_id: "UUID", # required
|
2433
|
+
# next_token: "Token",
|
2434
|
+
# max_results: 1,
|
2435
|
+
# })
|
2436
|
+
#
|
2437
|
+
# @example Response structure
|
2438
|
+
#
|
2439
|
+
# resp.control_insights_metadata #=> Array
|
2440
|
+
# resp.control_insights_metadata[0].name #=> String
|
2441
|
+
# resp.control_insights_metadata[0].id #=> String
|
2442
|
+
# resp.control_insights_metadata[0].evidence_insights.noncompliant_evidence_count #=> Integer
|
2443
|
+
# resp.control_insights_metadata[0].evidence_insights.compliant_evidence_count #=> Integer
|
2444
|
+
# resp.control_insights_metadata[0].evidence_insights.inconclusive_evidence_count #=> Integer
|
2445
|
+
# resp.control_insights_metadata[0].last_updated #=> Time
|
2446
|
+
# resp.next_token #=> String
|
2447
|
+
#
|
2448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlInsightsByControlDomain AWS API Documentation
|
2449
|
+
#
|
2450
|
+
# @overload list_control_insights_by_control_domain(params = {})
|
2451
|
+
# @param [Hash] params ({})
|
2452
|
+
def list_control_insights_by_control_domain(params = {}, options = {})
|
2453
|
+
req = build_request(:list_control_insights_by_control_domain, params)
|
2454
|
+
req.send_request(options)
|
2455
|
+
end
|
2456
|
+
|
2148
2457
|
# Returns a list of controls from Audit Manager.
|
2149
2458
|
#
|
2150
2459
|
# @option params [required, String] :control_type
|
@@ -2500,7 +2809,7 @@ module Aws::AuditManager
|
|
2500
2809
|
# Edits an Audit Manager assessment.
|
2501
2810
|
#
|
2502
2811
|
# @option params [required, String] :assessment_id
|
2503
|
-
# The identifier for the assessment.
|
2812
|
+
# The unique identifier for the assessment.
|
2504
2813
|
#
|
2505
2814
|
# @option params [String] :assessment_name
|
2506
2815
|
# The name of the assessment to be updated.
|
@@ -2646,13 +2955,13 @@ module Aws::AuditManager
|
|
2646
2955
|
# Updates a control within an assessment in Audit Manager.
|
2647
2956
|
#
|
2648
2957
|
# @option params [required, String] :assessment_id
|
2649
|
-
# The identifier for the assessment.
|
2958
|
+
# The unique identifier for the assessment.
|
2650
2959
|
#
|
2651
2960
|
# @option params [required, String] :control_set_id
|
2652
|
-
# The identifier for the control set.
|
2961
|
+
# The unique identifier for the control set.
|
2653
2962
|
#
|
2654
2963
|
# @option params [required, String] :control_id
|
2655
|
-
# The identifier for the control.
|
2964
|
+
# The unique identifier for the control.
|
2656
2965
|
#
|
2657
2966
|
# @option params [String] :control_status
|
2658
2967
|
# The status of the control.
|
@@ -2702,10 +3011,10 @@ module Aws::AuditManager
|
|
2702
3011
|
# Updates the status of a control set in an Audit Manager assessment.
|
2703
3012
|
#
|
2704
3013
|
# @option params [required, String] :assessment_id
|
2705
|
-
# The identifier for the assessment.
|
3014
|
+
# The unique identifier for the assessment.
|
2706
3015
|
#
|
2707
3016
|
# @option params [required, String] :control_set_id
|
2708
|
-
# The identifier for the control set.
|
3017
|
+
# The unique identifier for the control set.
|
2709
3018
|
#
|
2710
3019
|
# @option params [required, String] :status
|
2711
3020
|
# The status of the control set that's being updated.
|
@@ -2775,7 +3084,7 @@ module Aws::AuditManager
|
|
2775
3084
|
# Updates a custom framework in Audit Manager.
|
2776
3085
|
#
|
2777
3086
|
# @option params [required, String] :framework_id
|
2778
|
-
# The identifier for the framework.
|
3087
|
+
# The unique identifier for the framework.
|
2779
3088
|
#
|
2780
3089
|
# @option params [required, String] :name
|
2781
3090
|
# The name of the framework to be updated.
|
@@ -2923,7 +3232,7 @@ module Aws::AuditManager
|
|
2923
3232
|
# Updates the status of an assessment in Audit Manager.
|
2924
3233
|
#
|
2925
3234
|
# @option params [required, String] :assessment_id
|
2926
|
-
# The identifier for the assessment.
|
3235
|
+
# The unique identifier for the assessment.
|
2927
3236
|
#
|
2928
3237
|
# @option params [required, String] :status
|
2929
3238
|
# The current status of the assessment.
|
@@ -3225,7 +3534,7 @@ module Aws::AuditManager
|
|
3225
3534
|
params: params,
|
3226
3535
|
config: config)
|
3227
3536
|
context[:gem_name] = 'aws-sdk-auditmanager'
|
3228
|
-
context[:gem_version] = '1.
|
3537
|
+
context[:gem_version] = '1.18.0'
|
3229
3538
|
Seahorse::Client::Request.new(handlers, context)
|
3230
3539
|
end
|
3231
3540
|
|