aws-sdk-auditmanager 1.11.0 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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 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 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 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,7 +1149,7 @@ 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 identifier for the assessment.
1117
1153
  #
1118
1154
  # @option params [required, String] :evidence_folder_id
1119
1155
  # The identifier for the folder in which evidence is stored.
@@ -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 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
1374
  # The identifier for the assessment report.
1339
1375
  #
1340
1376
  # @option params [required, String] :assessment_id
1341
- # The identifier for the specified assessment.
1377
+ # The 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 identifier for the assessment.
1372
1408
  #
1373
1409
  # @option params [String] :control_set_id
1374
- # The identifier for the specified control set.
1410
+ # The identifier for the control set.
1375
1411
  #
1376
1412
  # @option params [String] :control_id
1377
- # The identifier for the specified control.
1413
+ # The 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,13 +1554,13 @@ 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 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 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 identifier for the folder that the evidence is stored in.
1528
1564
  #
1529
1565
  # @option params [required, String] :evidence_id
1530
1566
  # The identifier for the evidence.
@@ -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 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 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 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 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
  #
@@ -1868,7 +1904,7 @@ module Aws::AuditManager
1868
1904
  req.send_request(options)
1869
1905
  end
1870
1906
 
1871
- # Returns the settings for the specified account.
1907
+ # Returns the settings for the specified Amazon Web Services account.
1872
1908
  #
1873
1909
  # @option params [required, String] :attribute
1874
1910
  # The list of `SettingAttribute` enum values.
@@ -1903,18 +1939,77 @@ module Aws::AuditManager
1903
1939
  req.send_request(options)
1904
1940
  end
1905
1941
 
1906
- # Returns a list of the frameworks available in the Audit Manager
1907
- # framework library.
1942
+ # Returns a list of sent or received share requests for custom
1943
+ # frameworks in Audit Manager.
1944
+ #
1945
+ # @option params [required, String] :request_type
1946
+ # Specifies whether the share request is a sent request or a received
1947
+ # request.
1948
+ #
1949
+ # @option params [String] :next_token
1950
+ # The pagination token that's used to fetch the next set of results.
1951
+ #
1952
+ # @option params [Integer] :max_results
1953
+ # Represents the maximum number of results on a page or for an API
1954
+ # request call.
1955
+ #
1956
+ # @return [Types::ListAssessmentFrameworkShareRequestsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1957
+ #
1958
+ # * {Types::ListAssessmentFrameworkShareRequestsResponse#assessment_framework_share_requests #assessment_framework_share_requests} => Array&lt;Types::AssessmentFrameworkShareRequest&gt;
1959
+ # * {Types::ListAssessmentFrameworkShareRequestsResponse#next_token #next_token} => String
1960
+ #
1961
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1962
+ #
1963
+ # @example Request syntax with placeholder values
1964
+ #
1965
+ # resp = client.list_assessment_framework_share_requests({
1966
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
1967
+ # next_token: "Token",
1968
+ # max_results: 1,
1969
+ # })
1970
+ #
1971
+ # @example Response structure
1972
+ #
1973
+ # resp.assessment_framework_share_requests #=> Array
1974
+ # resp.assessment_framework_share_requests[0].id #=> String
1975
+ # resp.assessment_framework_share_requests[0].framework_id #=> String
1976
+ # resp.assessment_framework_share_requests[0].framework_name #=> String
1977
+ # resp.assessment_framework_share_requests[0].framework_description #=> String
1978
+ # resp.assessment_framework_share_requests[0].status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
1979
+ # resp.assessment_framework_share_requests[0].source_account #=> String
1980
+ # resp.assessment_framework_share_requests[0].destination_account #=> String
1981
+ # resp.assessment_framework_share_requests[0].destination_region #=> String
1982
+ # resp.assessment_framework_share_requests[0].expiration_time #=> Time
1983
+ # resp.assessment_framework_share_requests[0].creation_time #=> Time
1984
+ # resp.assessment_framework_share_requests[0].last_updated #=> Time
1985
+ # resp.assessment_framework_share_requests[0].comment #=> String
1986
+ # resp.assessment_framework_share_requests[0].standard_controls_count #=> Integer
1987
+ # resp.assessment_framework_share_requests[0].custom_controls_count #=> Integer
1988
+ # resp.assessment_framework_share_requests[0].compliance_type #=> String
1989
+ # resp.next_token #=> String
1990
+ #
1991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests AWS API Documentation
1992
+ #
1993
+ # @overload list_assessment_framework_share_requests(params = {})
1994
+ # @param [Hash] params ({})
1995
+ def list_assessment_framework_share_requests(params = {}, options = {})
1996
+ req = build_request(:list_assessment_framework_share_requests, params)
1997
+ req.send_request(options)
1998
+ end
1999
+
2000
+ # Returns a list of the frameworks that are available in the Audit
2001
+ # Manager framework library.
1908
2002
  #
1909
2003
  # @option params [required, String] :framework_type
1910
- # The type of framework, such as standard or custom.
2004
+ # The type of framework, such as a standard framework or a custom
2005
+ # framework.
1911
2006
  #
1912
2007
  # @option params [String] :next_token
1913
- # The pagination token used to fetch the next set of results.
2008
+ # The pagination token that's used to fetch the next set of results.
1914
2009
  #
1915
2010
  # @option params [Integer] :max_results
1916
- # Represents the maximum number of results per page, or per API request
1917
- # call.
2011
+ # Represents the maximum number of results on a page or for an API
2012
+ # request call.
1918
2013
  #
1919
2014
  # @return [Types::ListAssessmentFrameworksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1920
2015
  #
@@ -1959,11 +2054,11 @@ module Aws::AuditManager
1959
2054
  # Returns a list of assessment reports created in Audit Manager.
1960
2055
  #
1961
2056
  # @option params [String] :next_token
1962
- # The pagination token used to fetch the next set of results.
2057
+ # The pagination token that's used to fetch the next set of results.
1963
2058
  #
1964
2059
  # @option params [Integer] :max_results
1965
- # Represents the maximum number of results per page, or per API request
1966
- # call.
2060
+ # Represents the maximum number of results on a page or for an API
2061
+ # request call.
1967
2062
  #
1968
2063
  # @return [Types::ListAssessmentReportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1969
2064
  #
@@ -2004,11 +2099,11 @@ module Aws::AuditManager
2004
2099
  # Returns a list of current and past assessments from Audit Manager.
2005
2100
  #
2006
2101
  # @option params [String] :next_token
2007
- # The pagination token used to fetch the next set of results.
2102
+ # The pagination token that's used to fetch the next set of results.
2008
2103
  #
2009
2104
  # @option params [Integer] :max_results
2010
- # Represents the maximum number of results per page, or per API request
2011
- # call.
2105
+ # Represents the maximum number of results on a page or for an API
2106
+ # request call.
2012
2107
  #
2013
2108
  # @return [Types::ListAssessmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2014
2109
  #
@@ -2062,14 +2157,14 @@ module Aws::AuditManager
2062
2157
  # Returns a list of controls from Audit Manager.
2063
2158
  #
2064
2159
  # @option params [required, String] :control_type
2065
- # The type of control, such as standard or custom.
2160
+ # The type of control, such as a standard control or a custom control.
2066
2161
  #
2067
2162
  # @option params [String] :next_token
2068
- # The pagination token used to fetch the next set of results.
2163
+ # The pagination token that's used to fetch the next set of results.
2069
2164
  #
2070
2165
  # @option params [Integer] :max_results
2071
- # Represents the maximum number of results per page, or per API request
2072
- # call.
2166
+ # Represents the maximum number of results on a page or for an API
2167
+ # request call.
2073
2168
  #
2074
2169
  # @return [Types::ListControlsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2075
2170
  #
@@ -2106,18 +2201,18 @@ module Aws::AuditManager
2106
2201
  req.send_request(options)
2107
2202
  end
2108
2203
 
2109
- # Returns a list of keywords that pre-mapped to the specified control
2110
- # data source.
2204
+ # Returns a list of keywords that are pre-mapped to the specified
2205
+ # control data source.
2111
2206
  #
2112
2207
  # @option params [required, String] :source
2113
- # The control mapping data source to which the keywords apply.
2208
+ # The control mapping data source that the keywords apply to.
2114
2209
  #
2115
2210
  # @option params [String] :next_token
2116
- # The pagination token used to fetch the next set of results.
2211
+ # The pagination token that's used to fetch the next set of results.
2117
2212
  #
2118
2213
  # @option params [Integer] :max_results
2119
- # Represents the maximum number of results per page, or per API request
2120
- # call.
2214
+ # Represents the maximum number of results on a page or for an API
2215
+ # request call.
2121
2216
  #
2122
2217
  # @return [Types::ListKeywordsForDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2123
2218
  #
@@ -2152,11 +2247,11 @@ module Aws::AuditManager
2152
2247
  # Returns a list of all Audit Manager notifications.
2153
2248
  #
2154
2249
  # @option params [String] :next_token
2155
- # The pagination token used to fetch the next set of results.
2250
+ # The pagination token that's used to fetch the next set of results.
2156
2251
  #
2157
2252
  # @option params [Integer] :max_results
2158
- # Represents the maximum number of results per page, or per API request
2159
- # call.
2253
+ # Represents the maximum number of results on a page or for an API
2254
+ # request call.
2160
2255
  #
2161
2256
  # @return [Types::ListNotificationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2162
2257
  #
@@ -2197,7 +2292,7 @@ module Aws::AuditManager
2197
2292
  # Returns a list of tags for the specified resource in Audit Manager.
2198
2293
  #
2199
2294
  # @option params [required, String] :resource_arn
2200
- # The Amazon Resource Name (ARN) of the specified resource.
2295
+ # The Amazon Resource Name (ARN) of the resource.
2201
2296
  #
2202
2297
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2203
2298
  #
@@ -2223,7 +2318,7 @@ module Aws::AuditManager
2223
2318
  req.send_request(options)
2224
2319
  end
2225
2320
 
2226
- # Enables Audit Manager for the specified account.
2321
+ # Enables Audit Manager for the specified Amazon Web Services account.
2227
2322
  #
2228
2323
  # @option params [String] :kms_key
2229
2324
  # The KMS key details.
@@ -2255,11 +2350,11 @@ module Aws::AuditManager
2255
2350
  req.send_request(options)
2256
2351
  end
2257
2352
 
2258
- # Enables an account within the organization as the delegated
2259
- # administrator for Audit Manager.
2353
+ # Enables an Amazon Web Services account within the organization as the
2354
+ # delegated administrator for Audit Manager.
2260
2355
  #
2261
2356
  # @option params [required, String] :admin_account_id
2262
- # The identifier for the specified delegated administrator account.
2357
+ # The identifier for the delegated administrator account.
2263
2358
  #
2264
2359
  # @return [Types::RegisterOrganizationAdminAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2265
2360
  #
@@ -2286,13 +2381,84 @@ module Aws::AuditManager
2286
2381
  req.send_request(options)
2287
2382
  end
2288
2383
 
2384
+ # Creates a share request for a custom framework in Audit Manager.
2385
+ #
2386
+ # The share request specifies a recipient and notifies them that a
2387
+ # custom framework is available. Recipients have 120 days to accept or
2388
+ # decline the request. If no action is taken, the share request expires.
2389
+ #
2390
+ # When you invoke the `StartAssessmentFrameworkShare` API, you are about
2391
+ # to share a custom framework with another Amazon Web Services account.
2392
+ # You may not share a custom framework that is derived from a standard
2393
+ # framework if the standard framework is designated as not eligible for
2394
+ # sharing by Amazon Web Services, unless you have obtained permission to
2395
+ # do so from the owner of the standard framework. To learn more about
2396
+ # which standard frameworks are eligible for sharing, see [Framework
2397
+ # sharing eligibility][1] in the *Audit Manager User Guide*.
2398
+ #
2399
+ #
2400
+ #
2401
+ # [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility
2402
+ #
2403
+ # @option params [required, String] :framework_id
2404
+ # The unique identifier for the custom framework to be shared.
2405
+ #
2406
+ # @option params [required, String] :destination_account
2407
+ # The Amazon Web Services account of the recipient.
2408
+ #
2409
+ # @option params [required, String] :destination_region
2410
+ # The Amazon Web Services Region of the recipient.
2411
+ #
2412
+ # @option params [String] :comment
2413
+ # An optional comment from the sender about the share request.
2414
+ #
2415
+ # @return [Types::StartAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2416
+ #
2417
+ # * {Types::StartAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
2418
+ #
2419
+ # @example Request syntax with placeholder values
2420
+ #
2421
+ # resp = client.start_assessment_framework_share({
2422
+ # framework_id: "UUID", # required
2423
+ # destination_account: "AccountId", # required
2424
+ # destination_region: "Region", # required
2425
+ # comment: "ShareRequestComment",
2426
+ # })
2427
+ #
2428
+ # @example Response structure
2429
+ #
2430
+ # resp.assessment_framework_share_request.id #=> String
2431
+ # resp.assessment_framework_share_request.framework_id #=> String
2432
+ # resp.assessment_framework_share_request.framework_name #=> String
2433
+ # resp.assessment_framework_share_request.framework_description #=> String
2434
+ # resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
2435
+ # resp.assessment_framework_share_request.source_account #=> String
2436
+ # resp.assessment_framework_share_request.destination_account #=> String
2437
+ # resp.assessment_framework_share_request.destination_region #=> String
2438
+ # resp.assessment_framework_share_request.expiration_time #=> Time
2439
+ # resp.assessment_framework_share_request.creation_time #=> Time
2440
+ # resp.assessment_framework_share_request.last_updated #=> Time
2441
+ # resp.assessment_framework_share_request.comment #=> String
2442
+ # resp.assessment_framework_share_request.standard_controls_count #=> Integer
2443
+ # resp.assessment_framework_share_request.custom_controls_count #=> Integer
2444
+ # resp.assessment_framework_share_request.compliance_type #=> String
2445
+ #
2446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare AWS API Documentation
2447
+ #
2448
+ # @overload start_assessment_framework_share(params = {})
2449
+ # @param [Hash] params ({})
2450
+ def start_assessment_framework_share(params = {}, options = {})
2451
+ req = build_request(:start_assessment_framework_share, params)
2452
+ req.send_request(options)
2453
+ end
2454
+
2289
2455
  # Tags the specified resource in Audit Manager.
2290
2456
  #
2291
2457
  # @option params [required, String] :resource_arn
2292
- # The Amazon Resource Name (ARN) of the specified resource.
2458
+ # The Amazon Resource Name (ARN) of the resource.
2293
2459
  #
2294
2460
  # @option params [required, Hash<String,String>] :tags
2295
- # The tags to be associated with the resource.
2461
+ # The tags that are associated with the resource.
2296
2462
  #
2297
2463
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2298
2464
  #
@@ -2343,23 +2509,23 @@ module Aws::AuditManager
2343
2509
  # Edits an Audit Manager assessment.
2344
2510
  #
2345
2511
  # @option params [required, String] :assessment_id
2346
- # The identifier for the specified assessment.
2512
+ # The identifier for the assessment.
2347
2513
  #
2348
2514
  # @option params [String] :assessment_name
2349
- # The name of the specified assessment to be updated.
2515
+ # The name of the assessment to be updated.
2350
2516
  #
2351
2517
  # @option params [String] :assessment_description
2352
- # The description of the specified assessment.
2518
+ # The description of the assessment.
2353
2519
  #
2354
2520
  # @option params [required, Types::Scope] :scope
2355
- # The scope of the specified assessment.
2521
+ # The scope of the assessment.
2356
2522
  #
2357
2523
  # @option params [Types::AssessmentReportsDestination] :assessment_reports_destination
2358
- # The assessment report storage destination for the specified assessment
2359
- # that is being updated.
2524
+ # The assessment report storage destination for the assessment that's
2525
+ # being updated.
2360
2526
  #
2361
2527
  # @option params [Array<Types::Role>] :roles
2362
- # The list of roles for the specified assessment.
2528
+ # The list of roles for the assessment.
2363
2529
  #
2364
2530
  # @return [Types::UpdateAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2365
2531
  #
@@ -2489,19 +2655,19 @@ module Aws::AuditManager
2489
2655
  # Updates a control within an assessment in Audit Manager.
2490
2656
  #
2491
2657
  # @option params [required, String] :assessment_id
2492
- # The identifier for the specified assessment.
2658
+ # The identifier for the assessment.
2493
2659
  #
2494
2660
  # @option params [required, String] :control_set_id
2495
- # The identifier for the specified control set.
2661
+ # The identifier for the control set.
2496
2662
  #
2497
2663
  # @option params [required, String] :control_id
2498
- # The identifier for the specified control.
2664
+ # The identifier for the control.
2499
2665
  #
2500
2666
  # @option params [String] :control_status
2501
- # The status of the specified control.
2667
+ # The status of the control.
2502
2668
  #
2503
2669
  # @option params [String] :comment_body
2504
- # The comment body text for the specified control.
2670
+ # The comment body text for the control.
2505
2671
  #
2506
2672
  # @return [Types::UpdateAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2507
2673
  #
@@ -2545,16 +2711,16 @@ module Aws::AuditManager
2545
2711
  # Updates the status of a control set in an Audit Manager assessment.
2546
2712
  #
2547
2713
  # @option params [required, String] :assessment_id
2548
- # The identifier for the specified assessment.
2714
+ # The identifier for the assessment.
2549
2715
  #
2550
2716
  # @option params [required, String] :control_set_id
2551
- # The identifier for the specified control set.
2717
+ # The identifier for the control set.
2552
2718
  #
2553
2719
  # @option params [required, String] :status
2554
- # The status of the control set that is being updated.
2720
+ # The status of the control set that's being updated.
2555
2721
  #
2556
2722
  # @option params [required, String] :comment
2557
- # The comment related to the status update.
2723
+ # The comment that's related to the status update.
2558
2724
  #
2559
2725
  # @return [Types::UpdateAssessmentControlSetStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2560
2726
  #
@@ -2618,20 +2784,20 @@ module Aws::AuditManager
2618
2784
  # Updates a custom framework in Audit Manager.
2619
2785
  #
2620
2786
  # @option params [required, String] :framework_id
2621
- # The identifier for the specified framework.
2787
+ # The identifier for the framework.
2622
2788
  #
2623
2789
  # @option params [required, String] :name
2624
2790
  # The name of the framework to be updated.
2625
2791
  #
2626
2792
  # @option params [String] :description
2627
- # The description of the framework that is to be updated.
2793
+ # The description of the updated framework.
2628
2794
  #
2629
2795
  # @option params [String] :compliance_type
2630
2796
  # The compliance type that the new custom framework supports, such as
2631
2797
  # CIS or HIPAA.
2632
2798
  #
2633
2799
  # @option params [required, Array<Types::UpdateAssessmentFrameworkControlSet>] :control_sets
2634
- # The control sets associated with the framework.
2800
+ # The control sets that are associated with the framework.
2635
2801
  #
2636
2802
  # @return [Types::UpdateAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2637
2803
  #
@@ -2712,13 +2878,64 @@ module Aws::AuditManager
2712
2878
  req.send_request(options)
2713
2879
  end
2714
2880
 
2881
+ # Updates a share request for a custom framework in Audit Manager.
2882
+ #
2883
+ # @option params [required, String] :request_id
2884
+ # The unique identifier for the share request.
2885
+ #
2886
+ # @option params [required, String] :request_type
2887
+ # Specifies whether the share request is a sent request or a received
2888
+ # request.
2889
+ #
2890
+ # @option params [required, String] :action
2891
+ # Specifies the update action for the share request.
2892
+ #
2893
+ # @return [Types::UpdateAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2894
+ #
2895
+ # * {Types::UpdateAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
2896
+ #
2897
+ # @example Request syntax with placeholder values
2898
+ #
2899
+ # resp = client.update_assessment_framework_share({
2900
+ # request_id: "UUID", # required
2901
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
2902
+ # action: "ACCEPT", # required, accepts ACCEPT, DECLINE, REVOKE
2903
+ # })
2904
+ #
2905
+ # @example Response structure
2906
+ #
2907
+ # resp.assessment_framework_share_request.id #=> String
2908
+ # resp.assessment_framework_share_request.framework_id #=> String
2909
+ # resp.assessment_framework_share_request.framework_name #=> String
2910
+ # resp.assessment_framework_share_request.framework_description #=> String
2911
+ # resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
2912
+ # resp.assessment_framework_share_request.source_account #=> String
2913
+ # resp.assessment_framework_share_request.destination_account #=> String
2914
+ # resp.assessment_framework_share_request.destination_region #=> String
2915
+ # resp.assessment_framework_share_request.expiration_time #=> Time
2916
+ # resp.assessment_framework_share_request.creation_time #=> Time
2917
+ # resp.assessment_framework_share_request.last_updated #=> Time
2918
+ # resp.assessment_framework_share_request.comment #=> String
2919
+ # resp.assessment_framework_share_request.standard_controls_count #=> Integer
2920
+ # resp.assessment_framework_share_request.custom_controls_count #=> Integer
2921
+ # resp.assessment_framework_share_request.compliance_type #=> String
2922
+ #
2923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare AWS API Documentation
2924
+ #
2925
+ # @overload update_assessment_framework_share(params = {})
2926
+ # @param [Hash] params ({})
2927
+ def update_assessment_framework_share(params = {}, options = {})
2928
+ req = build_request(:update_assessment_framework_share, params)
2929
+ req.send_request(options)
2930
+ end
2931
+
2715
2932
  # Updates the status of an assessment in Audit Manager.
2716
2933
  #
2717
2934
  # @option params [required, String] :assessment_id
2718
- # The identifier for the specified assessment.
2935
+ # The identifier for the assessment.
2719
2936
  #
2720
2937
  # @option params [required, String] :status
2721
- # The current status of the specified assessment.
2938
+ # The current status of the assessment.
2722
2939
  #
2723
2940
  # @return [Types::UpdateAssessmentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2724
2941
  #
@@ -2823,26 +3040,25 @@ module Aws::AuditManager
2823
3040
  # Updates a custom control in Audit Manager.
2824
3041
  #
2825
3042
  # @option params [required, String] :control_id
2826
- # The identifier for the specified control.
3043
+ # The identifier for the control.
2827
3044
  #
2828
3045
  # @option params [required, String] :name
2829
- # The name of the control to be updated.
3046
+ # The name of the updated control.
2830
3047
  #
2831
3048
  # @option params [String] :description
2832
3049
  # The optional description of the control.
2833
3050
  #
2834
3051
  # @option params [String] :testing_information
2835
- # The steps that to follow to determine if the control has been
2836
- # satisfied.
3052
+ # The steps that you should follow to determine if the control is met.
2837
3053
  #
2838
3054
  # @option params [String] :action_plan_title
2839
3055
  # The title of the action plan for remediating the control.
2840
3056
  #
2841
3057
  # @option params [String] :action_plan_instructions
2842
- # The recommended actions to carry out if the control is not fulfilled.
3058
+ # The recommended actions to carry out if the control isn't fulfilled.
2843
3059
  #
2844
3060
  # @option params [required, Array<Types::ControlMappingSource>] :control_mapping_sources
2845
- # The data mapping sources for the specified control.
3061
+ # The data mapping sources for the control.
2846
3062
  #
2847
3063
  # @return [Types::UpdateControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2848
3064
  #
@@ -2914,8 +3130,8 @@ module Aws::AuditManager
2914
3130
  # Updates Audit Manager settings for the current user account.
2915
3131
  #
2916
3132
  # @option params [String] :sns_topic
2917
- # The Amazon Simple Notification Service (Amazon SNS) topic to which
2918
- # Audit Manager sends notifications.
3133
+ # The Amazon Simple Notification Service (Amazon SNS) topic that Audit
3134
+ # Manager sends notifications to.
2919
3135
  #
2920
3136
  # @option params [Types::AssessmentReportsDestination] :default_assessment_reports_destination
2921
3137
  # The default storage destination for assessment reports.
@@ -2970,8 +3186,8 @@ module Aws::AuditManager
2970
3186
  # Validates the integrity of an assessment report in Audit Manager.
2971
3187
  #
2972
3188
  # @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.
3189
+ # The relative path of the Amazon S3 bucket that the assessment report
3190
+ # is stored in.
2975
3191
  #
2976
3192
  # @return [Types::ValidateAssessmentReportIntegrityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2977
3193
  #
@@ -3018,7 +3234,7 @@ module Aws::AuditManager
3018
3234
  params: params,
3019
3235
  config: config)
3020
3236
  context[:gem_name] = 'aws-sdk-auditmanager'
3021
- context[:gem_version] = '1.11.0'
3237
+ context[:gem_version] = '1.15.0'
3022
3238
  Seahorse::Client::Request.new(handlers, context)
3023
3239
  end
3024
3240