aws-sdk-auditmanager 1.12.0 → 1.16.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.
@@ -275,6 +275,15 @@ module Aws::AuditManager
275
275
  # ** Please note ** When response stubbing is enabled, no HTTP
276
276
  # requests are made, and retries are disabled.
277
277
  #
278
+ # @option options [Boolean] :use_dualstack_endpoint
279
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
280
+ # will be used if available.
281
+ #
282
+ # @option options [Boolean] :use_fips_endpoint
283
+ # When set to `true`, fips compatible endpoints will be used if available.
284
+ # When a `fips` region is used, the region is normalized and this config
285
+ # is set to `true`.
286
+ #
278
287
  # @option options [Boolean] :validate_params (true)
279
288
  # When `true`, request parameters are validated before
280
289
  # sending the request.
@@ -327,14 +336,14 @@ module Aws::AuditManager
327
336
 
328
337
  # @!group API Operations
329
338
 
330
- # Associates an evidence folder to the specified assessment report in
331
- # Audit Manager.
339
+ # Associates an evidence folder to an assessment report in a Audit
340
+ # Manager assessment.
332
341
  #
333
342
  # @option params [required, String] :assessment_id
334
- # The identifier for the specified assessment.
343
+ # The identifier for the assessment.
335
344
  #
336
345
  # @option params [required, String] :evidence_folder_id
337
- # The identifier for the folder in which evidence is stored.
346
+ # The identifier for the folder that the evidence is stored in.
338
347
  #
339
348
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
340
349
  #
@@ -358,10 +367,10 @@ module Aws::AuditManager
358
367
  # Manager assessment.
359
368
  #
360
369
  # @option params [required, String] :assessment_id
361
- # The unique identifier for the specified assessment.
370
+ # The identifier for the assessment.
362
371
  #
363
372
  # @option params [required, String] :evidence_folder_id
364
- # The identifier for the folder in which the evidence is stored.
373
+ # The identifier for the folder that the evidence is stored in.
365
374
  #
366
375
  # @option params [required, Array<String>] :evidence_ids
367
376
  # The list of evidence identifiers.
@@ -397,14 +406,13 @@ module Aws::AuditManager
397
406
  req.send_request(options)
398
407
  end
399
408
 
400
- # Create a batch of delegations for a specified assessment in Audit
401
- # Manager.
409
+ # Creates a batch of delegations for an assessment in Audit Manager.
402
410
  #
403
411
  # @option params [required, Array<Types::CreateDelegationRequest>] :create_delegation_requests
404
412
  # The API request to batch create delegations in Audit Manager.
405
413
  #
406
414
  # @option params [required, String] :assessment_id
407
- # The identifier for the specified assessment.
415
+ # The identifier for the assessment.
408
416
  #
409
417
  # @return [Types::BatchCreateDelegationByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
410
418
  #
@@ -456,13 +464,13 @@ module Aws::AuditManager
456
464
  req.send_request(options)
457
465
  end
458
466
 
459
- # Deletes the delegations in the specified Audit Manager assessment.
467
+ # Deletes a batch of delegations for an assessment in Audit Manager.
460
468
  #
461
469
  # @option params [required, Array<String>] :delegation_ids
462
- # The identifiers for the specified delegations.
470
+ # The identifiers for the delegations.
463
471
  #
464
472
  # @option params [required, String] :assessment_id
465
- # The identifier for the specified assessment.
473
+ # The identifier for the assessment.
466
474
  #
467
475
  # @return [Types::BatchDeleteDelegationByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
468
476
  #
@@ -491,14 +499,14 @@ module Aws::AuditManager
491
499
  req.send_request(options)
492
500
  end
493
501
 
494
- # Disassociates a list of evidence from the specified assessment report
495
- # in Audit Manager.
502
+ # Disassociates a list of evidence from an assessment report in Audit
503
+ # Manager.
496
504
  #
497
505
  # @option params [required, String] :assessment_id
498
- # The identifier for the specified assessment.
506
+ # The identifier for the assessment.
499
507
  #
500
508
  # @option params [required, String] :evidence_folder_id
501
- # The identifier for the folder in which evidence is stored.
509
+ # The identifier for the folder that the evidence is stored in.
502
510
  #
503
511
  # @option params [required, Array<String>] :evidence_ids
504
512
  # The list of evidence identifiers.
@@ -534,17 +542,17 @@ module Aws::AuditManager
534
542
  req.send_request(options)
535
543
  end
536
544
 
537
- # Uploads one or more pieces of evidence to the specified control in the
538
- # assessment in Audit Manager.
545
+ # Uploads one or more pieces of evidence to a control in an Audit
546
+ # Manager assessment.
539
547
  #
540
548
  # @option params [required, String] :assessment_id
541
- # The identifier for the specified assessment.
549
+ # The identifier for the assessment.
542
550
  #
543
551
  # @option params [required, String] :control_set_id
544
- # The identifier for the specified control set.
552
+ # The identifier for the control set.
545
553
  #
546
554
  # @option params [required, String] :control_id
547
- # The identifier for the specified control.
555
+ # The identifier for the control.
548
556
  #
549
557
  # @option params [required, Array<Types::ManualEvidence>] :manual_evidence
550
558
  # The list of manual evidence objects.
@@ -591,21 +599,22 @@ module Aws::AuditManager
591
599
  # The optional description of the assessment to be created.
592
600
  #
593
601
  # @option params [required, Types::AssessmentReportsDestination] :assessment_reports_destination
594
- # The assessment report storage destination for the specified assessment
595
- # that is being created.
602
+ # The assessment report storage destination for the assessment that's
603
+ # being created.
596
604
  #
597
605
  # @option params [required, Types::Scope] :scope
598
- # The wrapper that contains the accounts and services in scope for the
599
- # assessment.
606
+ # The wrapper that contains the Amazon Web Services accounts and
607
+ # services that are in scope for the assessment.
600
608
  #
601
609
  # @option params [required, Array<Types::Role>] :roles
602
- # The list of roles for the specified assessment.
610
+ # The list of roles for the assessment.
603
611
  #
604
612
  # @option params [required, String] :framework_id
605
- # The identifier for the specified framework.
613
+ # The identifier for the framework that the assessment will be created
614
+ # from.
606
615
  #
607
616
  # @option params [Hash<String,String>] :tags
608
- # The tags associated with the assessment.
617
+ # The tags that are associated with the assessment.
609
618
  #
610
619
  # @return [Types::CreateAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
611
620
  #
@@ -748,10 +757,10 @@ module Aws::AuditManager
748
757
  # CIS or HIPAA.
749
758
  #
750
759
  # @option params [required, Array<Types::CreateAssessmentFrameworkControlSet>] :control_sets
751
- # The control sets to be associated with the framework.
760
+ # The control sets that are associated with the framework.
752
761
  #
753
762
  # @option params [Hash<String,String>] :tags
754
- # The tags associated with the framework.
763
+ # The tags that are associated with the framework.
755
764
  #
756
765
  # @return [Types::CreateAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
757
766
  #
@@ -842,7 +851,7 @@ module Aws::AuditManager
842
851
  # The description of the assessment report.
843
852
  #
844
853
  # @option params [required, String] :assessment_id
845
- # The identifier for the specified assessment.
854
+ # The identifier for the assessment.
846
855
  #
847
856
  # @return [Types::CreateAssessmentReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
848
857
  #
@@ -886,19 +895,19 @@ module Aws::AuditManager
886
895
  # The description of the control.
887
896
  #
888
897
  # @option params [String] :testing_information
889
- # The steps to follow to determine if the control has been satisfied.
898
+ # The steps to follow to determine if the control is satisfied.
890
899
  #
891
900
  # @option params [String] :action_plan_title
892
901
  # The title of the action plan for remediating the control.
893
902
  #
894
903
  # @option params [String] :action_plan_instructions
895
- # The recommended actions to carry out if the control is not fulfilled.
904
+ # The recommended actions to carry out if the control isn't fulfilled.
896
905
  #
897
906
  # @option params [required, Array<Types::CreateControlMappingSource>] :control_mapping_sources
898
- # The data mapping sources for the specified control.
907
+ # The data mapping sources for the control.
899
908
  #
900
909
  # @option params [Hash<String,String>] :tags
901
- # The tags associated with the control.
910
+ # The tags that are associated with the control.
902
911
  #
903
912
  # @return [Types::CreateControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
904
913
  #
@@ -971,7 +980,7 @@ module Aws::AuditManager
971
980
  # Deletes an assessment in Audit Manager.
972
981
  #
973
982
  # @option params [required, String] :assessment_id
974
- # The identifier for the specified assessment.
983
+ # The identifier for the assessment.
975
984
  #
976
985
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
977
986
  #
@@ -993,7 +1002,7 @@ module Aws::AuditManager
993
1002
  # Deletes a custom framework in Audit Manager.
994
1003
  #
995
1004
  # @option params [required, String] :framework_id
996
- # The identifier for the specified framework.
1005
+ # The identifier for the custom framework.
997
1006
  #
998
1007
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
999
1008
  #
@@ -1012,10 +1021,37 @@ module Aws::AuditManager
1012
1021
  req.send_request(options)
1013
1022
  end
1014
1023
 
1024
+ # Deletes a share request for a custom framework in Audit Manager.
1025
+ #
1026
+ # @option params [required, String] :request_id
1027
+ # The unique identifier for the share request to be deleted.
1028
+ #
1029
+ # @option params [required, String] :request_type
1030
+ # Specifies whether the share request is a sent request or a received
1031
+ # request.
1032
+ #
1033
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1034
+ #
1035
+ # @example Request syntax with placeholder values
1036
+ #
1037
+ # resp = client.delete_assessment_framework_share({
1038
+ # request_id: "UUID", # required
1039
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
1040
+ # })
1041
+ #
1042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare AWS API Documentation
1043
+ #
1044
+ # @overload delete_assessment_framework_share(params = {})
1045
+ # @param [Hash] params ({})
1046
+ def delete_assessment_framework_share(params = {}, options = {})
1047
+ req = build_request(:delete_assessment_framework_share, params)
1048
+ req.send_request(options)
1049
+ end
1050
+
1015
1051
  # Deletes an assessment report from an assessment in Audit Manager.
1016
1052
  #
1017
1053
  # @option params [required, String] :assessment_id
1018
- # The identifier for the specified assessment.
1054
+ # The unique identifier for the assessment.
1019
1055
  #
1020
1056
  # @option params [required, String] :assessment_report_id
1021
1057
  # The unique identifier for the assessment report.
@@ -1041,7 +1077,7 @@ module Aws::AuditManager
1041
1077
  # Deletes a custom control in Audit Manager.
1042
1078
  #
1043
1079
  # @option params [required, String] :control_id
1044
- # The identifier for the specified control.
1080
+ # The unique identifier for the control.
1045
1081
  #
1046
1082
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1047
1083
  #
@@ -1079,18 +1115,18 @@ module Aws::AuditManager
1079
1115
  req.send_request(options)
1080
1116
  end
1081
1117
 
1082
- # Removes the specified member account as a delegated administrator for
1083
- # Audit Manager.
1118
+ # Removes the specified member Amazon Web Services account as a
1119
+ # delegated administrator for Audit Manager.
1084
1120
  #
1085
1121
  # When you remove a delegated administrator from your Audit Manager
1086
- # settings, or when you deregister a delegated administrator from
1087
- # Organizations, you continue to have access to the evidence that you
1088
- # previously collected under that account. However, Audit Manager will
1089
- # stop collecting and attaching evidence to that delegated administrator
1090
- # account moving forward.
1122
+ # settings, you continue to have access to the evidence that you
1123
+ # previously collected under that account. This is also the case when
1124
+ # you deregister a delegated administrator from Audit Manager. However,
1125
+ # Audit Manager will stop collecting and attaching evidence to that
1126
+ # delegated administrator account moving forward.
1091
1127
  #
1092
1128
  # @option params [String] :admin_account_id
1093
- # The identifier for the specified administrator account.
1129
+ # The identifier for the administrator account.
1094
1130
  #
1095
1131
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1096
1132
  #
@@ -1113,10 +1149,10 @@ module Aws::AuditManager
1113
1149
  # in Audit Manager.
1114
1150
  #
1115
1151
  # @option params [required, String] :assessment_id
1116
- # The identifier for the specified assessment.
1152
+ # The unique identifier for the assessment.
1117
1153
  #
1118
1154
  # @option params [required, String] :evidence_folder_id
1119
- # The identifier for the folder in which evidence is stored.
1155
+ # The unique identifier for the folder that the evidence is stored in.
1120
1156
  #
1121
1157
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1122
1158
  #
@@ -1158,7 +1194,7 @@ module Aws::AuditManager
1158
1194
  # Returns an assessment from Audit Manager.
1159
1195
  #
1160
1196
  # @option params [required, String] :assessment_id
1161
- # The identifier for the specified assessment.
1197
+ # The unique identifier for the assessment.
1162
1198
  #
1163
1199
  # @return [Types::GetAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1164
1200
  #
@@ -1265,7 +1301,7 @@ module Aws::AuditManager
1265
1301
  # Returns a framework from Audit Manager.
1266
1302
  #
1267
1303
  # @option params [required, String] :framework_id
1268
- # The identifier for the specified framework.
1304
+ # The identifier for the framework.
1269
1305
  #
1270
1306
  # @return [Types::GetAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1271
1307
  #
@@ -1332,13 +1368,13 @@ module Aws::AuditManager
1332
1368
  req.send_request(options)
1333
1369
  end
1334
1370
 
1335
- # Returns the URL of a specified assessment report in Audit Manager.
1371
+ # Returns the URL of an assessment report in Audit Manager.
1336
1372
  #
1337
1373
  # @option params [required, String] :assessment_report_id
1338
- # The identifier for the assessment report.
1374
+ # The unique identifier for the assessment report.
1339
1375
  #
1340
1376
  # @option params [required, String] :assessment_id
1341
- # The identifier for the specified assessment.
1377
+ # The unique identifier for the assessment.
1342
1378
  #
1343
1379
  # @return [Types::GetAssessmentReportUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1344
1380
  #
@@ -1368,20 +1404,20 @@ module Aws::AuditManager
1368
1404
  # Returns a list of changelogs from Audit Manager.
1369
1405
  #
1370
1406
  # @option params [required, String] :assessment_id
1371
- # The identifier for the specified assessment.
1407
+ # The unique identifier for the assessment.
1372
1408
  #
1373
1409
  # @option params [String] :control_set_id
1374
- # The identifier for the specified control set.
1410
+ # The unique identifier for the control set.
1375
1411
  #
1376
1412
  # @option params [String] :control_id
1377
- # The identifier for the specified control.
1413
+ # The unique identifier for the control.
1378
1414
  #
1379
1415
  # @option params [String] :next_token
1380
- # The pagination token used to fetch the next set of results.
1416
+ # The pagination token that's used to fetch the next set of results.
1381
1417
  #
1382
1418
  # @option params [Integer] :max_results
1383
- # Represents the maximum number of results per page, or per API request
1384
- # call.
1419
+ # Represents the maximum number of results on a page or for an API
1420
+ # request call.
1385
1421
  #
1386
1422
  # @return [Types::GetChangeLogsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1387
1423
  #
@@ -1422,7 +1458,7 @@ module Aws::AuditManager
1422
1458
  # Returns a control from Audit Manager.
1423
1459
  #
1424
1460
  # @option params [required, String] :control_id
1425
- # The identifier for the specified control.
1461
+ # The identifier for the control.
1426
1462
  #
1427
1463
  # @return [Types::GetControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1428
1464
  #
@@ -1474,11 +1510,11 @@ module Aws::AuditManager
1474
1510
  # Returns a list of delegations from an audit owner to a delegate.
1475
1511
  #
1476
1512
  # @option params [String] :next_token
1477
- # The pagination token used to fetch the next set of results.
1513
+ # The pagination token that's used to fetch the next set of results.
1478
1514
  #
1479
1515
  # @option params [Integer] :max_results
1480
- # Represents the maximum number of results per page, or per API request
1481
- # call.
1516
+ # Represents the maximum number of results on a page or for an API
1517
+ # request call.
1482
1518
  #
1483
1519
  # @return [Types::GetDelegationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1484
1520
  #
@@ -1518,16 +1554,16 @@ module Aws::AuditManager
1518
1554
  # Returns evidence from Audit Manager.
1519
1555
  #
1520
1556
  # @option params [required, String] :assessment_id
1521
- # The identifier for the specified assessment.
1557
+ # The unique identifier for the assessment.
1522
1558
  #
1523
1559
  # @option params [required, String] :control_set_id
1524
- # The identifier for the specified control set.
1560
+ # The unique identifier for the control set.
1525
1561
  #
1526
1562
  # @option params [required, String] :evidence_folder_id
1527
- # The identifier for the folder in which the evidence is stored.
1563
+ # The unique identifier for the folder that the evidence is stored in.
1528
1564
  #
1529
1565
  # @option params [required, String] :evidence_id
1530
- # The identifier for the evidence.
1566
+ # The unique identifier for the evidence.
1531
1567
  #
1532
1568
  # @return [Types::GetEvidenceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1533
1569
  #
@@ -1576,20 +1612,20 @@ module Aws::AuditManager
1576
1612
  # Manager.
1577
1613
  #
1578
1614
  # @option params [required, String] :assessment_id
1579
- # The identifier for the specified assessment.
1615
+ # The identifier for the assessment.
1580
1616
  #
1581
1617
  # @option params [required, String] :control_set_id
1582
1618
  # The identifier for the control set.
1583
1619
  #
1584
1620
  # @option params [required, String] :evidence_folder_id
1585
- # The unique identifier for the folder in which the evidence is stored.
1621
+ # The unique identifier for the folder that the evidence is stored in.
1586
1622
  #
1587
1623
  # @option params [String] :next_token
1588
- # The pagination token used to fetch the next set of results.
1624
+ # The pagination token that's used to fetch the next set of results.
1589
1625
  #
1590
1626
  # @option params [Integer] :max_results
1591
- # Represents the maximum number of results per page, or per API request
1592
- # call.
1627
+ # Represents the maximum number of results on a page or for an API
1628
+ # request call.
1593
1629
  #
1594
1630
  # @return [Types::GetEvidenceByEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1595
1631
  #
@@ -1644,13 +1680,13 @@ module Aws::AuditManager
1644
1680
  # Manager.
1645
1681
  #
1646
1682
  # @option params [required, String] :assessment_id
1647
- # The identifier for the specified assessment.
1683
+ # The unique identifier for the assessment.
1648
1684
  #
1649
1685
  # @option params [required, String] :control_set_id
1650
- # The identifier for the specified control set.
1686
+ # The unique identifier for the control set.
1651
1687
  #
1652
1688
  # @option params [required, String] :evidence_folder_id
1653
- # The identifier for the folder in which the evidence is stored.
1689
+ # The unique identifier for the folder that the evidence is stored in.
1654
1690
  #
1655
1691
  # @return [Types::GetEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1656
1692
  #
@@ -1698,14 +1734,14 @@ module Aws::AuditManager
1698
1734
  # Manager.
1699
1735
  #
1700
1736
  # @option params [required, String] :assessment_id
1701
- # The identifier for the specified assessment.
1737
+ # The unique identifier for the assessment.
1702
1738
  #
1703
1739
  # @option params [String] :next_token
1704
- # The pagination token used to fetch the next set of results.
1740
+ # The pagination token that's used to fetch the next set of results.
1705
1741
  #
1706
1742
  # @option params [Integer] :max_results
1707
- # Represents the maximum number of results per page, or per API request
1708
- # call.
1743
+ # Represents the maximum number of results on a page or for an API
1744
+ # request call.
1709
1745
  #
1710
1746
  # @return [Types::GetEvidenceFoldersByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1711
1747
  #
@@ -1754,24 +1790,24 @@ module Aws::AuditManager
1754
1790
  req.send_request(options)
1755
1791
  end
1756
1792
 
1757
- # Returns a list of evidence folders associated with a specified control
1758
- # of an assessment in Audit Manager.
1793
+ # Returns a list of evidence folders that are associated with a
1794
+ # specified control of an assessment in Audit Manager.
1759
1795
  #
1760
1796
  # @option params [required, String] :assessment_id
1761
- # The identifier for the specified assessment.
1797
+ # The identifier for the assessment.
1762
1798
  #
1763
1799
  # @option params [required, String] :control_set_id
1764
- # The identifier for the specified control set.
1800
+ # The identifier for the control set.
1765
1801
  #
1766
1802
  # @option params [required, String] :control_id
1767
- # The identifier for the specified control.
1803
+ # The identifier for the control.
1768
1804
  #
1769
1805
  # @option params [String] :next_token
1770
- # The pagination token used to fetch the next set of results.
1806
+ # The pagination token that's used to fetch the next set of results.
1771
1807
  #
1772
1808
  # @option params [Integer] :max_results
1773
- # Represents the maximum number of results per page, or per API request
1774
- # call.
1809
+ # Represents the maximum number of results on a page or for an API
1810
+ # request call.
1775
1811
  #
1776
1812
  # @return [Types::GetEvidenceFoldersByAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1777
1813
  #
@@ -1822,6 +1858,65 @@ module Aws::AuditManager
1822
1858
  req.send_request(options)
1823
1859
  end
1824
1860
 
1861
+ # Gets the latest analytics data for all your current active
1862
+ # assessments.
1863
+ #
1864
+ # @return [Types::GetInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1865
+ #
1866
+ # * {Types::GetInsightsResponse#insights #insights} => Types::Insights
1867
+ #
1868
+ # @example Response structure
1869
+ #
1870
+ # resp.insights.active_assessments_count #=> Integer
1871
+ # resp.insights.noncompliant_evidence_count #=> Integer
1872
+ # resp.insights.compliant_evidence_count #=> Integer
1873
+ # resp.insights.inconclusive_evidence_count #=> Integer
1874
+ # resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
1875
+ # resp.insights.total_assessment_controls_count #=> Integer
1876
+ # resp.insights.last_updated #=> Time
1877
+ #
1878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsights AWS API Documentation
1879
+ #
1880
+ # @overload get_insights(params = {})
1881
+ # @param [Hash] params ({})
1882
+ def get_insights(params = {}, options = {})
1883
+ req = build_request(:get_insights, params)
1884
+ req.send_request(options)
1885
+ end
1886
+
1887
+ # Gets the latest analytics data for a specific active assessment.
1888
+ #
1889
+ # @option params [required, String] :assessment_id
1890
+ # The unique identifier for the assessment.
1891
+ #
1892
+ # @return [Types::GetInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1893
+ #
1894
+ # * {Types::GetInsightsByAssessmentResponse#insights #insights} => Types::InsightsByAssessment
1895
+ #
1896
+ # @example Request syntax with placeholder values
1897
+ #
1898
+ # resp = client.get_insights_by_assessment({
1899
+ # assessment_id: "UUID", # required
1900
+ # })
1901
+ #
1902
+ # @example Response structure
1903
+ #
1904
+ # resp.insights.noncompliant_evidence_count #=> Integer
1905
+ # resp.insights.compliant_evidence_count #=> Integer
1906
+ # resp.insights.inconclusive_evidence_count #=> Integer
1907
+ # resp.insights.assessment_controls_count_by_noncompliant_evidence #=> Integer
1908
+ # resp.insights.total_assessment_controls_count #=> Integer
1909
+ # resp.insights.last_updated #=> Time
1910
+ #
1911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsightsByAssessment AWS API Documentation
1912
+ #
1913
+ # @overload get_insights_by_assessment(params = {})
1914
+ # @param [Hash] params ({})
1915
+ def get_insights_by_assessment(params = {}, options = {})
1916
+ req = build_request(:get_insights_by_assessment, params)
1917
+ req.send_request(options)
1918
+ end
1919
+
1825
1920
  # Returns the name of the delegated Amazon Web Services administrator
1826
1921
  # account for the organization.
1827
1922
  #
@@ -1868,7 +1963,7 @@ module Aws::AuditManager
1868
1963
  req.send_request(options)
1869
1964
  end
1870
1965
 
1871
- # Returns the settings for the specified account.
1966
+ # Returns the settings for the specified Amazon Web Services account.
1872
1967
  #
1873
1968
  # @option params [required, String] :attribute
1874
1969
  # The list of `SettingAttribute` enum values.
@@ -1903,18 +1998,138 @@ module Aws::AuditManager
1903
1998
  req.send_request(options)
1904
1999
  end
1905
2000
 
1906
- # Returns a list of the frameworks available in the Audit Manager
1907
- # framework library.
2001
+ # Lists the latest analytics data for controls within a specific control
2002
+ # domain and a specific active assessment.
2003
+ #
2004
+ # <note markdown="1"> Control insights are listed only if the control belongs to the control
2005
+ # domain and assessment that was specified. Moreover, the control must
2006
+ # have collected evidence on the `lastUpdated` date of
2007
+ # `controlInsightsByAssessment`. If neither of these conditions are met,
2008
+ # no data is listed for that control.
2009
+ #
2010
+ # </note>
2011
+ #
2012
+ # @option params [required, String] :control_domain_id
2013
+ # The unique identifier for the control domain.
2014
+ #
2015
+ # @option params [required, String] :assessment_id
2016
+ # The unique identifier for the active assessment.
2017
+ #
2018
+ # @option params [String] :next_token
2019
+ # The pagination token that's used to fetch the next set of results.
2020
+ #
2021
+ # @option params [Integer] :max_results
2022
+ # Represents the maximum number of results on a page or for an API
2023
+ # request call.
2024
+ #
2025
+ # @return [Types::ListAssessmentControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2026
+ #
2027
+ # * {Types::ListAssessmentControlInsightsByControlDomainResponse#control_insights_by_assessment #control_insights_by_assessment} => Array&lt;Types::ControlInsightsMetadataByAssessmentItem&gt;
2028
+ # * {Types::ListAssessmentControlInsightsByControlDomainResponse#next_token #next_token} => String
2029
+ #
2030
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2031
+ #
2032
+ # @example Request syntax with placeholder values
2033
+ #
2034
+ # resp = client.list_assessment_control_insights_by_control_domain({
2035
+ # control_domain_id: "UUID", # required
2036
+ # assessment_id: "UUID", # required
2037
+ # next_token: "Token",
2038
+ # max_results: 1,
2039
+ # })
2040
+ #
2041
+ # @example Response structure
2042
+ #
2043
+ # resp.control_insights_by_assessment #=> Array
2044
+ # resp.control_insights_by_assessment[0].name #=> String
2045
+ # resp.control_insights_by_assessment[0].id #=> String
2046
+ # resp.control_insights_by_assessment[0].evidence_insights.noncompliant_evidence_count #=> Integer
2047
+ # resp.control_insights_by_assessment[0].evidence_insights.compliant_evidence_count #=> Integer
2048
+ # resp.control_insights_by_assessment[0].evidence_insights.inconclusive_evidence_count #=> Integer
2049
+ # resp.control_insights_by_assessment[0].control_set_name #=> String
2050
+ # resp.control_insights_by_assessment[0].last_updated #=> Time
2051
+ # resp.next_token #=> String
2052
+ #
2053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain AWS API Documentation
2054
+ #
2055
+ # @overload list_assessment_control_insights_by_control_domain(params = {})
2056
+ # @param [Hash] params ({})
2057
+ def list_assessment_control_insights_by_control_domain(params = {}, options = {})
2058
+ req = build_request(:list_assessment_control_insights_by_control_domain, params)
2059
+ req.send_request(options)
2060
+ end
2061
+
2062
+ # Returns a list of sent or received share requests for custom
2063
+ # frameworks in Audit Manager.
2064
+ #
2065
+ # @option params [required, String] :request_type
2066
+ # Specifies whether the share request is a sent request or a received
2067
+ # request.
2068
+ #
2069
+ # @option params [String] :next_token
2070
+ # The pagination token that's used to fetch the next set of results.
2071
+ #
2072
+ # @option params [Integer] :max_results
2073
+ # Represents the maximum number of results on a page or for an API
2074
+ # request call.
2075
+ #
2076
+ # @return [Types::ListAssessmentFrameworkShareRequestsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2077
+ #
2078
+ # * {Types::ListAssessmentFrameworkShareRequestsResponse#assessment_framework_share_requests #assessment_framework_share_requests} => Array&lt;Types::AssessmentFrameworkShareRequest&gt;
2079
+ # * {Types::ListAssessmentFrameworkShareRequestsResponse#next_token #next_token} => String
2080
+ #
2081
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2082
+ #
2083
+ # @example Request syntax with placeholder values
2084
+ #
2085
+ # resp = client.list_assessment_framework_share_requests({
2086
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
2087
+ # next_token: "Token",
2088
+ # max_results: 1,
2089
+ # })
2090
+ #
2091
+ # @example Response structure
2092
+ #
2093
+ # resp.assessment_framework_share_requests #=> Array
2094
+ # resp.assessment_framework_share_requests[0].id #=> String
2095
+ # resp.assessment_framework_share_requests[0].framework_id #=> String
2096
+ # resp.assessment_framework_share_requests[0].framework_name #=> String
2097
+ # resp.assessment_framework_share_requests[0].framework_description #=> String
2098
+ # resp.assessment_framework_share_requests[0].status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
2099
+ # resp.assessment_framework_share_requests[0].source_account #=> String
2100
+ # resp.assessment_framework_share_requests[0].destination_account #=> String
2101
+ # resp.assessment_framework_share_requests[0].destination_region #=> String
2102
+ # resp.assessment_framework_share_requests[0].expiration_time #=> Time
2103
+ # resp.assessment_framework_share_requests[0].creation_time #=> Time
2104
+ # resp.assessment_framework_share_requests[0].last_updated #=> Time
2105
+ # resp.assessment_framework_share_requests[0].comment #=> String
2106
+ # resp.assessment_framework_share_requests[0].standard_controls_count #=> Integer
2107
+ # resp.assessment_framework_share_requests[0].custom_controls_count #=> Integer
2108
+ # resp.assessment_framework_share_requests[0].compliance_type #=> String
2109
+ # resp.next_token #=> String
2110
+ #
2111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests AWS API Documentation
2112
+ #
2113
+ # @overload list_assessment_framework_share_requests(params = {})
2114
+ # @param [Hash] params ({})
2115
+ def list_assessment_framework_share_requests(params = {}, options = {})
2116
+ req = build_request(:list_assessment_framework_share_requests, params)
2117
+ req.send_request(options)
2118
+ end
2119
+
2120
+ # Returns a list of the frameworks that are available in the Audit
2121
+ # Manager framework library.
1908
2122
  #
1909
2123
  # @option params [required, String] :framework_type
1910
- # The type of framework, such as standard or custom.
2124
+ # The type of framework, such as a standard framework or a custom
2125
+ # framework.
1911
2126
  #
1912
2127
  # @option params [String] :next_token
1913
- # The pagination token used to fetch the next set of results.
2128
+ # The pagination token that's used to fetch the next set of results.
1914
2129
  #
1915
2130
  # @option params [Integer] :max_results
1916
- # Represents the maximum number of results per page, or per API request
1917
- # call.
2131
+ # Represents the maximum number of results on a page or for an API
2132
+ # request call.
1918
2133
  #
1919
2134
  # @return [Types::ListAssessmentFrameworksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1920
2135
  #
@@ -1959,11 +2174,11 @@ module Aws::AuditManager
1959
2174
  # Returns a list of assessment reports created in Audit Manager.
1960
2175
  #
1961
2176
  # @option params [String] :next_token
1962
- # The pagination token used to fetch the next set of results.
2177
+ # The pagination token that's used to fetch the next set of results.
1963
2178
  #
1964
2179
  # @option params [Integer] :max_results
1965
- # Represents the maximum number of results per page, or per API request
1966
- # call.
2180
+ # Represents the maximum number of results on a page or for an API
2181
+ # request call.
1967
2182
  #
1968
2183
  # @return [Types::ListAssessmentReportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1969
2184
  #
@@ -2003,12 +2218,15 @@ module Aws::AuditManager
2003
2218
 
2004
2219
  # Returns a list of current and past assessments from Audit Manager.
2005
2220
  #
2221
+ # @option params [String] :status
2222
+ # The current status of the assessment.
2223
+ #
2006
2224
  # @option params [String] :next_token
2007
- # The pagination token used to fetch the next set of results.
2225
+ # The pagination token that's used to fetch the next set of results.
2008
2226
  #
2009
2227
  # @option params [Integer] :max_results
2010
- # Represents the maximum number of results per page, or per API request
2011
- # call.
2228
+ # Represents the maximum number of results on a page or for an API
2229
+ # request call.
2012
2230
  #
2013
2231
  # @return [Types::ListAssessmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2014
2232
  #
@@ -2020,6 +2238,7 @@ module Aws::AuditManager
2020
2238
  # @example Request syntax with placeholder values
2021
2239
  #
2022
2240
  # resp = client.list_assessments({
2241
+ # status: "ACTIVE", # accepts ACTIVE, INACTIVE
2023
2242
  # next_token: "Token",
2024
2243
  # max_results: 1,
2025
2244
  # })
@@ -2059,17 +2278,182 @@ module Aws::AuditManager
2059
2278
  req.send_request(options)
2060
2279
  end
2061
2280
 
2281
+ # Lists the latest analytics data for control domains across all of your
2282
+ # active assessments.
2283
+ #
2284
+ # <note markdown="1"> A control domain is listed only if at least one of the controls within
2285
+ # that domain collected evidence on the `lastUpdated` date of
2286
+ # `controlDomainInsights`. If this condition isn’t met, no data is
2287
+ # listed for that control domain.
2288
+ #
2289
+ # </note>
2290
+ #
2291
+ # @option params [String] :next_token
2292
+ # The pagination token that's used to fetch the next set of results.
2293
+ #
2294
+ # @option params [Integer] :max_results
2295
+ # Represents the maximum number of results on a page or for an API
2296
+ # request call.
2297
+ #
2298
+ # @return [Types::ListControlDomainInsightsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2299
+ #
2300
+ # * {Types::ListControlDomainInsightsResponse#control_domain_insights #control_domain_insights} => Array&lt;Types::ControlDomainInsights&gt;
2301
+ # * {Types::ListControlDomainInsightsResponse#next_token #next_token} => String
2302
+ #
2303
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2304
+ #
2305
+ # @example Request syntax with placeholder values
2306
+ #
2307
+ # resp = client.list_control_domain_insights({
2308
+ # next_token: "Token",
2309
+ # max_results: 1,
2310
+ # })
2311
+ #
2312
+ # @example Response structure
2313
+ #
2314
+ # resp.control_domain_insights #=> Array
2315
+ # resp.control_domain_insights[0].name #=> String
2316
+ # resp.control_domain_insights[0].id #=> String
2317
+ # resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
2318
+ # resp.control_domain_insights[0].total_controls_count #=> Integer
2319
+ # resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
2320
+ # resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
2321
+ # resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
2322
+ # resp.control_domain_insights[0].last_updated #=> Time
2323
+ # resp.next_token #=> String
2324
+ #
2325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsights AWS API Documentation
2326
+ #
2327
+ # @overload list_control_domain_insights(params = {})
2328
+ # @param [Hash] params ({})
2329
+ def list_control_domain_insights(params = {}, options = {})
2330
+ req = build_request(:list_control_domain_insights, params)
2331
+ req.send_request(options)
2332
+ end
2333
+
2334
+ # Lists analytics data for control domains within a specified active
2335
+ # assessment.
2336
+ #
2337
+ # <note markdown="1"> A control domain is listed only if at least one of the controls within
2338
+ # that domain collected evidence on the `lastUpdated` date of
2339
+ # `controlDomainInsights`. If this condition isn’t met, no data is
2340
+ # listed for that domain.
2341
+ #
2342
+ # </note>
2343
+ #
2344
+ # @option params [required, String] :assessment_id
2345
+ # The unique identifier for the active assessment.
2346
+ #
2347
+ # @option params [String] :next_token
2348
+ # The pagination token that's used to fetch the next set of results.
2349
+ #
2350
+ # @option params [Integer] :max_results
2351
+ # Represents the maximum number of results on a page or for an API
2352
+ # request call.
2353
+ #
2354
+ # @return [Types::ListControlDomainInsightsByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2355
+ #
2356
+ # * {Types::ListControlDomainInsightsByAssessmentResponse#control_domain_insights #control_domain_insights} => Array&lt;Types::ControlDomainInsights&gt;
2357
+ # * {Types::ListControlDomainInsightsByAssessmentResponse#next_token #next_token} => String
2358
+ #
2359
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2360
+ #
2361
+ # @example Request syntax with placeholder values
2362
+ #
2363
+ # resp = client.list_control_domain_insights_by_assessment({
2364
+ # assessment_id: "UUID", # required
2365
+ # next_token: "Token",
2366
+ # max_results: 1,
2367
+ # })
2368
+ #
2369
+ # @example Response structure
2370
+ #
2371
+ # resp.control_domain_insights #=> Array
2372
+ # resp.control_domain_insights[0].name #=> String
2373
+ # resp.control_domain_insights[0].id #=> String
2374
+ # resp.control_domain_insights[0].controls_count_by_noncompliant_evidence #=> Integer
2375
+ # resp.control_domain_insights[0].total_controls_count #=> Integer
2376
+ # resp.control_domain_insights[0].evidence_insights.noncompliant_evidence_count #=> Integer
2377
+ # resp.control_domain_insights[0].evidence_insights.compliant_evidence_count #=> Integer
2378
+ # resp.control_domain_insights[0].evidence_insights.inconclusive_evidence_count #=> Integer
2379
+ # resp.control_domain_insights[0].last_updated #=> Time
2380
+ # resp.next_token #=> String
2381
+ #
2382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment AWS API Documentation
2383
+ #
2384
+ # @overload list_control_domain_insights_by_assessment(params = {})
2385
+ # @param [Hash] params ({})
2386
+ def list_control_domain_insights_by_assessment(params = {}, options = {})
2387
+ req = build_request(:list_control_domain_insights_by_assessment, params)
2388
+ req.send_request(options)
2389
+ end
2390
+
2391
+ # Lists the latest analytics data for controls within a specific control
2392
+ # domain across all active assessments.
2393
+ #
2394
+ # <note markdown="1"> Control insights are listed only if the control belongs to the control
2395
+ # domain that was specified and the control collected evidence on the
2396
+ # `lastUpdated` date of `controlInsightsMetadata`. If neither of these
2397
+ # conditions are met, no data is listed for that control.
2398
+ #
2399
+ # </note>
2400
+ #
2401
+ # @option params [required, String] :control_domain_id
2402
+ # The unique identifier for the control domain.
2403
+ #
2404
+ # @option params [String] :next_token
2405
+ # The pagination token that's used to fetch the next set of results.
2406
+ #
2407
+ # @option params [Integer] :max_results
2408
+ # Represents the maximum number of results on a page or for an API
2409
+ # request call.
2410
+ #
2411
+ # @return [Types::ListControlInsightsByControlDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2412
+ #
2413
+ # * {Types::ListControlInsightsByControlDomainResponse#control_insights_metadata #control_insights_metadata} => Array&lt;Types::ControlInsightsMetadataItem&gt;
2414
+ # * {Types::ListControlInsightsByControlDomainResponse#next_token #next_token} => String
2415
+ #
2416
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2417
+ #
2418
+ # @example Request syntax with placeholder values
2419
+ #
2420
+ # resp = client.list_control_insights_by_control_domain({
2421
+ # control_domain_id: "UUID", # required
2422
+ # next_token: "Token",
2423
+ # max_results: 1,
2424
+ # })
2425
+ #
2426
+ # @example Response structure
2427
+ #
2428
+ # resp.control_insights_metadata #=> Array
2429
+ # resp.control_insights_metadata[0].name #=> String
2430
+ # resp.control_insights_metadata[0].id #=> String
2431
+ # resp.control_insights_metadata[0].evidence_insights.noncompliant_evidence_count #=> Integer
2432
+ # resp.control_insights_metadata[0].evidence_insights.compliant_evidence_count #=> Integer
2433
+ # resp.control_insights_metadata[0].evidence_insights.inconclusive_evidence_count #=> Integer
2434
+ # resp.control_insights_metadata[0].last_updated #=> Time
2435
+ # resp.next_token #=> String
2436
+ #
2437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlInsightsByControlDomain AWS API Documentation
2438
+ #
2439
+ # @overload list_control_insights_by_control_domain(params = {})
2440
+ # @param [Hash] params ({})
2441
+ def list_control_insights_by_control_domain(params = {}, options = {})
2442
+ req = build_request(:list_control_insights_by_control_domain, params)
2443
+ req.send_request(options)
2444
+ end
2445
+
2062
2446
  # Returns a list of controls from Audit Manager.
2063
2447
  #
2064
2448
  # @option params [required, String] :control_type
2065
- # The type of control, such as standard or custom.
2449
+ # The type of control, such as a standard control or a custom control.
2066
2450
  #
2067
2451
  # @option params [String] :next_token
2068
- # The pagination token used to fetch the next set of results.
2452
+ # The pagination token that's used to fetch the next set of results.
2069
2453
  #
2070
2454
  # @option params [Integer] :max_results
2071
- # Represents the maximum number of results per page, or per API request
2072
- # call.
2455
+ # Represents the maximum number of results on a page or for an API
2456
+ # request call.
2073
2457
  #
2074
2458
  # @return [Types::ListControlsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2075
2459
  #
@@ -2106,18 +2490,18 @@ module Aws::AuditManager
2106
2490
  req.send_request(options)
2107
2491
  end
2108
2492
 
2109
- # Returns a list of keywords that pre-mapped to the specified control
2110
- # data source.
2493
+ # Returns a list of keywords that are pre-mapped to the specified
2494
+ # control data source.
2111
2495
  #
2112
2496
  # @option params [required, String] :source
2113
- # The control mapping data source to which the keywords apply.
2497
+ # The control mapping data source that the keywords apply to.
2114
2498
  #
2115
2499
  # @option params [String] :next_token
2116
- # The pagination token used to fetch the next set of results.
2500
+ # The pagination token that's used to fetch the next set of results.
2117
2501
  #
2118
2502
  # @option params [Integer] :max_results
2119
- # Represents the maximum number of results per page, or per API request
2120
- # call.
2503
+ # Represents the maximum number of results on a page or for an API
2504
+ # request call.
2121
2505
  #
2122
2506
  # @return [Types::ListKeywordsForDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2123
2507
  #
@@ -2152,11 +2536,11 @@ module Aws::AuditManager
2152
2536
  # Returns a list of all Audit Manager notifications.
2153
2537
  #
2154
2538
  # @option params [String] :next_token
2155
- # The pagination token used to fetch the next set of results.
2539
+ # The pagination token that's used to fetch the next set of results.
2156
2540
  #
2157
2541
  # @option params [Integer] :max_results
2158
- # Represents the maximum number of results per page, or per API request
2159
- # call.
2542
+ # Represents the maximum number of results on a page or for an API
2543
+ # request call.
2160
2544
  #
2161
2545
  # @return [Types::ListNotificationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2162
2546
  #
@@ -2197,7 +2581,7 @@ module Aws::AuditManager
2197
2581
  # Returns a list of tags for the specified resource in Audit Manager.
2198
2582
  #
2199
2583
  # @option params [required, String] :resource_arn
2200
- # The Amazon Resource Name (ARN) of the specified resource.
2584
+ # The Amazon Resource Name (ARN) of the resource.
2201
2585
  #
2202
2586
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2203
2587
  #
@@ -2223,7 +2607,7 @@ module Aws::AuditManager
2223
2607
  req.send_request(options)
2224
2608
  end
2225
2609
 
2226
- # Enables Audit Manager for the specified account.
2610
+ # Enables Audit Manager for the specified Amazon Web Services account.
2227
2611
  #
2228
2612
  # @option params [String] :kms_key
2229
2613
  # The KMS key details.
@@ -2255,11 +2639,11 @@ module Aws::AuditManager
2255
2639
  req.send_request(options)
2256
2640
  end
2257
2641
 
2258
- # Enables an account within the organization as the delegated
2259
- # administrator for Audit Manager.
2642
+ # Enables an Amazon Web Services account within the organization as the
2643
+ # delegated administrator for Audit Manager.
2260
2644
  #
2261
2645
  # @option params [required, String] :admin_account_id
2262
- # The identifier for the specified delegated administrator account.
2646
+ # The identifier for the delegated administrator account.
2263
2647
  #
2264
2648
  # @return [Types::RegisterOrganizationAdminAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2265
2649
  #
@@ -2286,13 +2670,84 @@ module Aws::AuditManager
2286
2670
  req.send_request(options)
2287
2671
  end
2288
2672
 
2673
+ # Creates a share request for a custom framework in Audit Manager.
2674
+ #
2675
+ # The share request specifies a recipient and notifies them that a
2676
+ # custom framework is available. Recipients have 120 days to accept or
2677
+ # decline the request. If no action is taken, the share request expires.
2678
+ #
2679
+ # When you invoke the `StartAssessmentFrameworkShare` API, you are about
2680
+ # to share a custom framework with another Amazon Web Services account.
2681
+ # You may not share a custom framework that is derived from a standard
2682
+ # framework if the standard framework is designated as not eligible for
2683
+ # sharing by Amazon Web Services, unless you have obtained permission to
2684
+ # do so from the owner of the standard framework. To learn more about
2685
+ # which standard frameworks are eligible for sharing, see [Framework
2686
+ # sharing eligibility][1] in the *Audit Manager User Guide*.
2687
+ #
2688
+ #
2689
+ #
2690
+ # [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility
2691
+ #
2692
+ # @option params [required, String] :framework_id
2693
+ # The unique identifier for the custom framework to be shared.
2694
+ #
2695
+ # @option params [required, String] :destination_account
2696
+ # The Amazon Web Services account of the recipient.
2697
+ #
2698
+ # @option params [required, String] :destination_region
2699
+ # The Amazon Web Services Region of the recipient.
2700
+ #
2701
+ # @option params [String] :comment
2702
+ # An optional comment from the sender about the share request.
2703
+ #
2704
+ # @return [Types::StartAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2705
+ #
2706
+ # * {Types::StartAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
2707
+ #
2708
+ # @example Request syntax with placeholder values
2709
+ #
2710
+ # resp = client.start_assessment_framework_share({
2711
+ # framework_id: "UUID", # required
2712
+ # destination_account: "AccountId", # required
2713
+ # destination_region: "Region", # required
2714
+ # comment: "ShareRequestComment",
2715
+ # })
2716
+ #
2717
+ # @example Response structure
2718
+ #
2719
+ # resp.assessment_framework_share_request.id #=> String
2720
+ # resp.assessment_framework_share_request.framework_id #=> String
2721
+ # resp.assessment_framework_share_request.framework_name #=> String
2722
+ # resp.assessment_framework_share_request.framework_description #=> String
2723
+ # resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
2724
+ # resp.assessment_framework_share_request.source_account #=> String
2725
+ # resp.assessment_framework_share_request.destination_account #=> String
2726
+ # resp.assessment_framework_share_request.destination_region #=> String
2727
+ # resp.assessment_framework_share_request.expiration_time #=> Time
2728
+ # resp.assessment_framework_share_request.creation_time #=> Time
2729
+ # resp.assessment_framework_share_request.last_updated #=> Time
2730
+ # resp.assessment_framework_share_request.comment #=> String
2731
+ # resp.assessment_framework_share_request.standard_controls_count #=> Integer
2732
+ # resp.assessment_framework_share_request.custom_controls_count #=> Integer
2733
+ # resp.assessment_framework_share_request.compliance_type #=> String
2734
+ #
2735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare AWS API Documentation
2736
+ #
2737
+ # @overload start_assessment_framework_share(params = {})
2738
+ # @param [Hash] params ({})
2739
+ def start_assessment_framework_share(params = {}, options = {})
2740
+ req = build_request(:start_assessment_framework_share, params)
2741
+ req.send_request(options)
2742
+ end
2743
+
2289
2744
  # Tags the specified resource in Audit Manager.
2290
2745
  #
2291
2746
  # @option params [required, String] :resource_arn
2292
- # The Amazon Resource Name (ARN) of the specified resource.
2747
+ # The Amazon Resource Name (ARN) of the resource.
2293
2748
  #
2294
2749
  # @option params [required, Hash<String,String>] :tags
2295
- # The tags to be associated with the resource.
2750
+ # The tags that are associated with the resource.
2296
2751
  #
2297
2752
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2298
2753
  #
@@ -2343,23 +2798,23 @@ module Aws::AuditManager
2343
2798
  # Edits an Audit Manager assessment.
2344
2799
  #
2345
2800
  # @option params [required, String] :assessment_id
2346
- # The identifier for the specified assessment.
2801
+ # The unique identifier for the assessment.
2347
2802
  #
2348
2803
  # @option params [String] :assessment_name
2349
- # The name of the specified assessment to be updated.
2804
+ # The name of the assessment to be updated.
2350
2805
  #
2351
2806
  # @option params [String] :assessment_description
2352
- # The description of the specified assessment.
2807
+ # The description of the assessment.
2353
2808
  #
2354
2809
  # @option params [required, Types::Scope] :scope
2355
- # The scope of the specified assessment.
2810
+ # The scope of the assessment.
2356
2811
  #
2357
2812
  # @option params [Types::AssessmentReportsDestination] :assessment_reports_destination
2358
- # The assessment report storage destination for the specified assessment
2359
- # that is being updated.
2813
+ # The assessment report storage destination for the assessment that's
2814
+ # being updated.
2360
2815
  #
2361
2816
  # @option params [Array<Types::Role>] :roles
2362
- # The list of roles for the specified assessment.
2817
+ # The list of roles for the assessment.
2363
2818
  #
2364
2819
  # @return [Types::UpdateAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2365
2820
  #
@@ -2489,19 +2944,19 @@ module Aws::AuditManager
2489
2944
  # Updates a control within an assessment in Audit Manager.
2490
2945
  #
2491
2946
  # @option params [required, String] :assessment_id
2492
- # The identifier for the specified assessment.
2947
+ # The unique identifier for the assessment.
2493
2948
  #
2494
2949
  # @option params [required, String] :control_set_id
2495
- # The identifier for the specified control set.
2950
+ # The unique identifier for the control set.
2496
2951
  #
2497
2952
  # @option params [required, String] :control_id
2498
- # The identifier for the specified control.
2953
+ # The unique identifier for the control.
2499
2954
  #
2500
2955
  # @option params [String] :control_status
2501
- # The status of the specified control.
2956
+ # The status of the control.
2502
2957
  #
2503
2958
  # @option params [String] :comment_body
2504
- # The comment body text for the specified control.
2959
+ # The comment body text for the control.
2505
2960
  #
2506
2961
  # @return [Types::UpdateAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2507
2962
  #
@@ -2545,16 +3000,16 @@ module Aws::AuditManager
2545
3000
  # Updates the status of a control set in an Audit Manager assessment.
2546
3001
  #
2547
3002
  # @option params [required, String] :assessment_id
2548
- # The identifier for the specified assessment.
3003
+ # The unique identifier for the assessment.
2549
3004
  #
2550
3005
  # @option params [required, String] :control_set_id
2551
- # The identifier for the specified control set.
3006
+ # The unique identifier for the control set.
2552
3007
  #
2553
3008
  # @option params [required, String] :status
2554
- # The status of the control set that is being updated.
3009
+ # The status of the control set that's being updated.
2555
3010
  #
2556
3011
  # @option params [required, String] :comment
2557
- # The comment related to the status update.
3012
+ # The comment that's related to the status update.
2558
3013
  #
2559
3014
  # @return [Types::UpdateAssessmentControlSetStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2560
3015
  #
@@ -2618,20 +3073,20 @@ module Aws::AuditManager
2618
3073
  # Updates a custom framework in Audit Manager.
2619
3074
  #
2620
3075
  # @option params [required, String] :framework_id
2621
- # The identifier for the specified framework.
3076
+ # The unique identifier for the framework.
2622
3077
  #
2623
3078
  # @option params [required, String] :name
2624
3079
  # The name of the framework to be updated.
2625
3080
  #
2626
3081
  # @option params [String] :description
2627
- # The description of the framework that is to be updated.
3082
+ # The description of the updated framework.
2628
3083
  #
2629
3084
  # @option params [String] :compliance_type
2630
3085
  # The compliance type that the new custom framework supports, such as
2631
3086
  # CIS or HIPAA.
2632
3087
  #
2633
3088
  # @option params [required, Array<Types::UpdateAssessmentFrameworkControlSet>] :control_sets
2634
- # The control sets associated with the framework.
3089
+ # The control sets that are associated with the framework.
2635
3090
  #
2636
3091
  # @return [Types::UpdateAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2637
3092
  #
@@ -2712,13 +3167,64 @@ module Aws::AuditManager
2712
3167
  req.send_request(options)
2713
3168
  end
2714
3169
 
3170
+ # Updates a share request for a custom framework in Audit Manager.
3171
+ #
3172
+ # @option params [required, String] :request_id
3173
+ # The unique identifier for the share request.
3174
+ #
3175
+ # @option params [required, String] :request_type
3176
+ # Specifies whether the share request is a sent request or a received
3177
+ # request.
3178
+ #
3179
+ # @option params [required, String] :action
3180
+ # Specifies the update action for the share request.
3181
+ #
3182
+ # @return [Types::UpdateAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3183
+ #
3184
+ # * {Types::UpdateAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
3185
+ #
3186
+ # @example Request syntax with placeholder values
3187
+ #
3188
+ # resp = client.update_assessment_framework_share({
3189
+ # request_id: "UUID", # required
3190
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
3191
+ # action: "ACCEPT", # required, accepts ACCEPT, DECLINE, REVOKE
3192
+ # })
3193
+ #
3194
+ # @example Response structure
3195
+ #
3196
+ # resp.assessment_framework_share_request.id #=> String
3197
+ # resp.assessment_framework_share_request.framework_id #=> String
3198
+ # resp.assessment_framework_share_request.framework_name #=> String
3199
+ # resp.assessment_framework_share_request.framework_description #=> String
3200
+ # resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
3201
+ # resp.assessment_framework_share_request.source_account #=> String
3202
+ # resp.assessment_framework_share_request.destination_account #=> String
3203
+ # resp.assessment_framework_share_request.destination_region #=> String
3204
+ # resp.assessment_framework_share_request.expiration_time #=> Time
3205
+ # resp.assessment_framework_share_request.creation_time #=> Time
3206
+ # resp.assessment_framework_share_request.last_updated #=> Time
3207
+ # resp.assessment_framework_share_request.comment #=> String
3208
+ # resp.assessment_framework_share_request.standard_controls_count #=> Integer
3209
+ # resp.assessment_framework_share_request.custom_controls_count #=> Integer
3210
+ # resp.assessment_framework_share_request.compliance_type #=> String
3211
+ #
3212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare AWS API Documentation
3213
+ #
3214
+ # @overload update_assessment_framework_share(params = {})
3215
+ # @param [Hash] params ({})
3216
+ def update_assessment_framework_share(params = {}, options = {})
3217
+ req = build_request(:update_assessment_framework_share, params)
3218
+ req.send_request(options)
3219
+ end
3220
+
2715
3221
  # Updates the status of an assessment in Audit Manager.
2716
3222
  #
2717
3223
  # @option params [required, String] :assessment_id
2718
- # The identifier for the specified assessment.
3224
+ # The unique identifier for the assessment.
2719
3225
  #
2720
3226
  # @option params [required, String] :status
2721
- # The current status of the specified assessment.
3227
+ # The current status of the assessment.
2722
3228
  #
2723
3229
  # @return [Types::UpdateAssessmentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2724
3230
  #
@@ -2823,26 +3329,25 @@ module Aws::AuditManager
2823
3329
  # Updates a custom control in Audit Manager.
2824
3330
  #
2825
3331
  # @option params [required, String] :control_id
2826
- # The identifier for the specified control.
3332
+ # The identifier for the control.
2827
3333
  #
2828
3334
  # @option params [required, String] :name
2829
- # The name of the control to be updated.
3335
+ # The name of the updated control.
2830
3336
  #
2831
3337
  # @option params [String] :description
2832
3338
  # The optional description of the control.
2833
3339
  #
2834
3340
  # @option params [String] :testing_information
2835
- # The steps that to follow to determine if the control has been
2836
- # satisfied.
3341
+ # The steps that you should follow to determine if the control is met.
2837
3342
  #
2838
3343
  # @option params [String] :action_plan_title
2839
3344
  # The title of the action plan for remediating the control.
2840
3345
  #
2841
3346
  # @option params [String] :action_plan_instructions
2842
- # The recommended actions to carry out if the control is not fulfilled.
3347
+ # The recommended actions to carry out if the control isn't fulfilled.
2843
3348
  #
2844
3349
  # @option params [required, Array<Types::ControlMappingSource>] :control_mapping_sources
2845
- # The data mapping sources for the specified control.
3350
+ # The data mapping sources for the control.
2846
3351
  #
2847
3352
  # @return [Types::UpdateControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2848
3353
  #
@@ -2914,8 +3419,8 @@ module Aws::AuditManager
2914
3419
  # Updates Audit Manager settings for the current user account.
2915
3420
  #
2916
3421
  # @option params [String] :sns_topic
2917
- # The Amazon Simple Notification Service (Amazon SNS) topic to which
2918
- # Audit Manager sends notifications.
3422
+ # The Amazon Simple Notification Service (Amazon SNS) topic that Audit
3423
+ # Manager sends notifications to.
2919
3424
  #
2920
3425
  # @option params [Types::AssessmentReportsDestination] :default_assessment_reports_destination
2921
3426
  # The default storage destination for assessment reports.
@@ -2970,8 +3475,8 @@ module Aws::AuditManager
2970
3475
  # Validates the integrity of an assessment report in Audit Manager.
2971
3476
  #
2972
3477
  # @option params [required, String] :s3_relative_path
2973
- # The relative path of the specified Amazon S3 bucket in which the
2974
- # assessment report is stored.
3478
+ # The relative path of the Amazon S3 bucket that the assessment report
3479
+ # is stored in.
2975
3480
  #
2976
3481
  # @return [Types::ValidateAssessmentReportIntegrityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2977
3482
  #
@@ -3018,7 +3523,7 @@ module Aws::AuditManager
3018
3523
  params: params,
3019
3524
  config: config)
3020
3525
  context[:gem_name] = 'aws-sdk-auditmanager'
3021
- context[:gem_version] = '1.12.0'
3526
+ context[:gem_version] = '1.16.0'
3022
3527
  Seahorse::Client::Request.new(handlers, context)
3023
3528
  end
3024
3529