aws-sdk-auditmanager 1.13.0 → 1.17.0

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