aws-sdk-auditmanager 1.13.0 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -327,14 +327,14 @@ module Aws::AuditManager
327
327
 
328
328
  # @!group API Operations
329
329
 
330
- # Associates an evidence folder to the specified assessment report in
331
- # Audit Manager.
330
+ # Associates an evidence folder to an assessment report in a Audit
331
+ # Manager assessment.
332
332
  #
333
333
  # @option params [required, String] :assessment_id
334
- # The identifier for the specified assessment.
334
+ # The identifier for the assessment.
335
335
  #
336
336
  # @option params [required, String] :evidence_folder_id
337
- # The identifier for the folder in which evidence is stored.
337
+ # The identifier for the folder that the evidence is stored in.
338
338
  #
339
339
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
340
340
  #
@@ -358,10 +358,10 @@ module Aws::AuditManager
358
358
  # Manager assessment.
359
359
  #
360
360
  # @option params [required, String] :assessment_id
361
- # The unique identifier for the specified assessment.
361
+ # The identifier for the assessment.
362
362
  #
363
363
  # @option params [required, String] :evidence_folder_id
364
- # The identifier for the folder in which the evidence is stored.
364
+ # The identifier for the folder that the evidence is stored in.
365
365
  #
366
366
  # @option params [required, Array<String>] :evidence_ids
367
367
  # The list of evidence identifiers.
@@ -397,14 +397,13 @@ module Aws::AuditManager
397
397
  req.send_request(options)
398
398
  end
399
399
 
400
- # Create a batch of delegations for a specified assessment in Audit
401
- # Manager.
400
+ # Creates a batch of delegations for an assessment in Audit Manager.
402
401
  #
403
402
  # @option params [required, Array<Types::CreateDelegationRequest>] :create_delegation_requests
404
403
  # The API request to batch create delegations in Audit Manager.
405
404
  #
406
405
  # @option params [required, String] :assessment_id
407
- # The identifier for the specified assessment.
406
+ # The identifier for the assessment.
408
407
  #
409
408
  # @return [Types::BatchCreateDelegationByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
410
409
  #
@@ -456,13 +455,13 @@ module Aws::AuditManager
456
455
  req.send_request(options)
457
456
  end
458
457
 
459
- # Deletes the delegations in the specified Audit Manager assessment.
458
+ # Deletes a batch of delegations for an assessment in Audit Manager.
460
459
  #
461
460
  # @option params [required, Array<String>] :delegation_ids
462
- # The identifiers for the specified delegations.
461
+ # The identifiers for the delegations.
463
462
  #
464
463
  # @option params [required, String] :assessment_id
465
- # The identifier for the specified assessment.
464
+ # The identifier for the assessment.
466
465
  #
467
466
  # @return [Types::BatchDeleteDelegationByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
468
467
  #
@@ -491,14 +490,14 @@ module Aws::AuditManager
491
490
  req.send_request(options)
492
491
  end
493
492
 
494
- # Disassociates a list of evidence from the specified assessment report
495
- # in Audit Manager.
493
+ # Disassociates a list of evidence from an assessment report in Audit
494
+ # Manager.
496
495
  #
497
496
  # @option params [required, String] :assessment_id
498
- # The identifier for the specified assessment.
497
+ # The identifier for the assessment.
499
498
  #
500
499
  # @option params [required, String] :evidence_folder_id
501
- # The identifier for the folder in which evidence is stored.
500
+ # The identifier for the folder that the evidence is stored in.
502
501
  #
503
502
  # @option params [required, Array<String>] :evidence_ids
504
503
  # The list of evidence identifiers.
@@ -534,17 +533,17 @@ module Aws::AuditManager
534
533
  req.send_request(options)
535
534
  end
536
535
 
537
- # Uploads one or more pieces of evidence to the specified control in the
538
- # assessment in Audit Manager.
536
+ # Uploads one or more pieces of evidence to a control in an Audit
537
+ # Manager assessment.
539
538
  #
540
539
  # @option params [required, String] :assessment_id
541
- # The identifier for the specified assessment.
540
+ # The identifier for the assessment.
542
541
  #
543
542
  # @option params [required, String] :control_set_id
544
- # The identifier for the specified control set.
543
+ # The identifier for the control set.
545
544
  #
546
545
  # @option params [required, String] :control_id
547
- # The identifier for the specified control.
546
+ # The identifier for the control.
548
547
  #
549
548
  # @option params [required, Array<Types::ManualEvidence>] :manual_evidence
550
549
  # The list of manual evidence objects.
@@ -591,21 +590,22 @@ module Aws::AuditManager
591
590
  # The optional description of the assessment to be created.
592
591
  #
593
592
  # @option params [required, Types::AssessmentReportsDestination] :assessment_reports_destination
594
- # The assessment report storage destination for the specified assessment
595
- # that is being created.
593
+ # The assessment report storage destination for the assessment that's
594
+ # being created.
596
595
  #
597
596
  # @option params [required, Types::Scope] :scope
598
597
  # The wrapper that contains the Amazon Web Services accounts and
599
- # services in scope for the assessment.
598
+ # services that are in scope for the assessment.
600
599
  #
601
600
  # @option params [required, Array<Types::Role>] :roles
602
- # The list of roles for the specified assessment.
601
+ # The list of roles for the assessment.
603
602
  #
604
603
  # @option params [required, String] :framework_id
605
- # The identifier for the specified framework.
604
+ # The identifier for the framework that the assessment will be created
605
+ # from.
606
606
  #
607
607
  # @option params [Hash<String,String>] :tags
608
- # The tags associated with the assessment.
608
+ # The tags that are associated with the assessment.
609
609
  #
610
610
  # @return [Types::CreateAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
611
611
  #
@@ -748,10 +748,10 @@ module Aws::AuditManager
748
748
  # CIS or HIPAA.
749
749
  #
750
750
  # @option params [required, Array<Types::CreateAssessmentFrameworkControlSet>] :control_sets
751
- # The control sets to be associated with the framework.
751
+ # The control sets that are associated with the framework.
752
752
  #
753
753
  # @option params [Hash<String,String>] :tags
754
- # The tags associated with the framework.
754
+ # The tags that are associated with the framework.
755
755
  #
756
756
  # @return [Types::CreateAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
757
757
  #
@@ -842,7 +842,7 @@ module Aws::AuditManager
842
842
  # The description of the assessment report.
843
843
  #
844
844
  # @option params [required, String] :assessment_id
845
- # The identifier for the specified assessment.
845
+ # The identifier for the assessment.
846
846
  #
847
847
  # @return [Types::CreateAssessmentReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
848
848
  #
@@ -886,19 +886,19 @@ module Aws::AuditManager
886
886
  # The description of the control.
887
887
  #
888
888
  # @option params [String] :testing_information
889
- # The steps to follow to determine if the control has been satisfied.
889
+ # The steps to follow to determine if the control is satisfied.
890
890
  #
891
891
  # @option params [String] :action_plan_title
892
892
  # The title of the action plan for remediating the control.
893
893
  #
894
894
  # @option params [String] :action_plan_instructions
895
- # The recommended actions to carry out if the control is not fulfilled.
895
+ # The recommended actions to carry out if the control isn't fulfilled.
896
896
  #
897
897
  # @option params [required, Array<Types::CreateControlMappingSource>] :control_mapping_sources
898
- # The data mapping sources for the specified control.
898
+ # The data mapping sources for the control.
899
899
  #
900
900
  # @option params [Hash<String,String>] :tags
901
- # The tags associated with the control.
901
+ # The tags that are associated with the control.
902
902
  #
903
903
  # @return [Types::CreateControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
904
904
  #
@@ -971,7 +971,7 @@ module Aws::AuditManager
971
971
  # Deletes an assessment in Audit Manager.
972
972
  #
973
973
  # @option params [required, String] :assessment_id
974
- # The identifier for the specified assessment.
974
+ # The identifier for the assessment.
975
975
  #
976
976
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
977
977
  #
@@ -993,7 +993,7 @@ module Aws::AuditManager
993
993
  # Deletes a custom framework in Audit Manager.
994
994
  #
995
995
  # @option params [required, String] :framework_id
996
- # The identifier for the specified framework.
996
+ # The identifier for the framework.
997
997
  #
998
998
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
999
999
  #
@@ -1012,10 +1012,37 @@ module Aws::AuditManager
1012
1012
  req.send_request(options)
1013
1013
  end
1014
1014
 
1015
+ # Deletes a share request for a custom framework in Audit Manager.
1016
+ #
1017
+ # @option params [required, String] :request_id
1018
+ # The unique identifier for the share request to be deleted.
1019
+ #
1020
+ # @option params [required, String] :request_type
1021
+ # Specifies whether the share request is a sent request or a received
1022
+ # request.
1023
+ #
1024
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1025
+ #
1026
+ # @example Request syntax with placeholder values
1027
+ #
1028
+ # resp = client.delete_assessment_framework_share({
1029
+ # request_id: "UUID", # required
1030
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
1031
+ # })
1032
+ #
1033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentFrameworkShare AWS API Documentation
1034
+ #
1035
+ # @overload delete_assessment_framework_share(params = {})
1036
+ # @param [Hash] params ({})
1037
+ def delete_assessment_framework_share(params = {}, options = {})
1038
+ req = build_request(:delete_assessment_framework_share, params)
1039
+ req.send_request(options)
1040
+ end
1041
+
1015
1042
  # Deletes an assessment report from an assessment in Audit Manager.
1016
1043
  #
1017
1044
  # @option params [required, String] :assessment_id
1018
- # The identifier for the specified assessment.
1045
+ # The identifier for the assessment.
1019
1046
  #
1020
1047
  # @option params [required, String] :assessment_report_id
1021
1048
  # The unique identifier for the assessment report.
@@ -1041,7 +1068,7 @@ module Aws::AuditManager
1041
1068
  # Deletes a custom control in Audit Manager.
1042
1069
  #
1043
1070
  # @option params [required, String] :control_id
1044
- # The identifier for the specified control.
1071
+ # The identifier for the control.
1045
1072
  #
1046
1073
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1047
1074
  #
@@ -1083,14 +1110,14 @@ module Aws::AuditManager
1083
1110
  # delegated administrator for Audit Manager.
1084
1111
  #
1085
1112
  # 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.
1113
+ # settings, you continue to have access to the evidence that you
1114
+ # previously collected under that account. This is also the case when
1115
+ # you deregister a delegated administrator from Audit Manager. However,
1116
+ # Audit Manager will stop collecting and attaching evidence to that
1117
+ # delegated administrator account moving forward.
1091
1118
  #
1092
1119
  # @option params [String] :admin_account_id
1093
- # The identifier for the specified administrator account.
1120
+ # The identifier for the administrator account.
1094
1121
  #
1095
1122
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1096
1123
  #
@@ -1113,7 +1140,7 @@ module Aws::AuditManager
1113
1140
  # in Audit Manager.
1114
1141
  #
1115
1142
  # @option params [required, String] :assessment_id
1116
- # The identifier for the specified assessment.
1143
+ # The identifier for the assessment.
1117
1144
  #
1118
1145
  # @option params [required, String] :evidence_folder_id
1119
1146
  # The identifier for the folder in which evidence is stored.
@@ -1158,7 +1185,7 @@ module Aws::AuditManager
1158
1185
  # Returns an assessment from Audit Manager.
1159
1186
  #
1160
1187
  # @option params [required, String] :assessment_id
1161
- # The identifier for the specified assessment.
1188
+ # The identifier for the assessment.
1162
1189
  #
1163
1190
  # @return [Types::GetAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1164
1191
  #
@@ -1265,7 +1292,7 @@ module Aws::AuditManager
1265
1292
  # Returns a framework from Audit Manager.
1266
1293
  #
1267
1294
  # @option params [required, String] :framework_id
1268
- # The identifier for the specified framework.
1295
+ # The identifier for the framework.
1269
1296
  #
1270
1297
  # @return [Types::GetAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1271
1298
  #
@@ -1332,13 +1359,13 @@ module Aws::AuditManager
1332
1359
  req.send_request(options)
1333
1360
  end
1334
1361
 
1335
- # Returns the URL of a specified assessment report in Audit Manager.
1362
+ # Returns the URL of an assessment report in Audit Manager.
1336
1363
  #
1337
1364
  # @option params [required, String] :assessment_report_id
1338
1365
  # The identifier for the assessment report.
1339
1366
  #
1340
1367
  # @option params [required, String] :assessment_id
1341
- # The identifier for the specified assessment.
1368
+ # The identifier for the assessment.
1342
1369
  #
1343
1370
  # @return [Types::GetAssessmentReportUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1344
1371
  #
@@ -1368,20 +1395,20 @@ module Aws::AuditManager
1368
1395
  # Returns a list of changelogs from Audit Manager.
1369
1396
  #
1370
1397
  # @option params [required, String] :assessment_id
1371
- # The identifier for the specified assessment.
1398
+ # The identifier for the assessment.
1372
1399
  #
1373
1400
  # @option params [String] :control_set_id
1374
- # The identifier for the specified control set.
1401
+ # The identifier for the control set.
1375
1402
  #
1376
1403
  # @option params [String] :control_id
1377
- # The identifier for the specified control.
1404
+ # The identifier for the control.
1378
1405
  #
1379
1406
  # @option params [String] :next_token
1380
- # The pagination token used to fetch the next set of results.
1407
+ # The pagination token that's used to fetch the next set of results.
1381
1408
  #
1382
1409
  # @option params [Integer] :max_results
1383
- # Represents the maximum number of results per page, or per API request
1384
- # call.
1410
+ # Represents the maximum number of results on a page or for an API
1411
+ # request call.
1385
1412
  #
1386
1413
  # @return [Types::GetChangeLogsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1387
1414
  #
@@ -1422,7 +1449,7 @@ module Aws::AuditManager
1422
1449
  # Returns a control from Audit Manager.
1423
1450
  #
1424
1451
  # @option params [required, String] :control_id
1425
- # The identifier for the specified control.
1452
+ # The identifier for the control.
1426
1453
  #
1427
1454
  # @return [Types::GetControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1428
1455
  #
@@ -1474,11 +1501,11 @@ module Aws::AuditManager
1474
1501
  # Returns a list of delegations from an audit owner to a delegate.
1475
1502
  #
1476
1503
  # @option params [String] :next_token
1477
- # The pagination token used to fetch the next set of results.
1504
+ # The pagination token that's used to fetch the next set of results.
1478
1505
  #
1479
1506
  # @option params [Integer] :max_results
1480
- # Represents the maximum number of results per page, or per API request
1481
- # call.
1507
+ # Represents the maximum number of results on a page or for an API
1508
+ # request call.
1482
1509
  #
1483
1510
  # @return [Types::GetDelegationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1484
1511
  #
@@ -1518,13 +1545,13 @@ module Aws::AuditManager
1518
1545
  # Returns evidence from Audit Manager.
1519
1546
  #
1520
1547
  # @option params [required, String] :assessment_id
1521
- # The identifier for the specified assessment.
1548
+ # The identifier for the assessment.
1522
1549
  #
1523
1550
  # @option params [required, String] :control_set_id
1524
- # The identifier for the specified control set.
1551
+ # The identifier for the control set.
1525
1552
  #
1526
1553
  # @option params [required, String] :evidence_folder_id
1527
- # The identifier for the folder in which the evidence is stored.
1554
+ # The identifier for the folder that the evidence is stored in.
1528
1555
  #
1529
1556
  # @option params [required, String] :evidence_id
1530
1557
  # The identifier for the evidence.
@@ -1576,20 +1603,20 @@ module Aws::AuditManager
1576
1603
  # Manager.
1577
1604
  #
1578
1605
  # @option params [required, String] :assessment_id
1579
- # The identifier for the specified assessment.
1606
+ # The identifier for the assessment.
1580
1607
  #
1581
1608
  # @option params [required, String] :control_set_id
1582
1609
  # The identifier for the control set.
1583
1610
  #
1584
1611
  # @option params [required, String] :evidence_folder_id
1585
- # The unique identifier for the folder in which the evidence is stored.
1612
+ # The unique identifier for the folder that the evidence is stored in.
1586
1613
  #
1587
1614
  # @option params [String] :next_token
1588
- # The pagination token used to fetch the next set of results.
1615
+ # The pagination token that's used to fetch the next set of results.
1589
1616
  #
1590
1617
  # @option params [Integer] :max_results
1591
- # Represents the maximum number of results per page, or per API request
1592
- # call.
1618
+ # Represents the maximum number of results on a page or for an API
1619
+ # request call.
1593
1620
  #
1594
1621
  # @return [Types::GetEvidenceByEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1595
1622
  #
@@ -1644,13 +1671,13 @@ module Aws::AuditManager
1644
1671
  # Manager.
1645
1672
  #
1646
1673
  # @option params [required, String] :assessment_id
1647
- # The identifier for the specified assessment.
1674
+ # The identifier for the assessment.
1648
1675
  #
1649
1676
  # @option params [required, String] :control_set_id
1650
- # The identifier for the specified control set.
1677
+ # The identifier for the control set.
1651
1678
  #
1652
1679
  # @option params [required, String] :evidence_folder_id
1653
- # The identifier for the folder in which the evidence is stored.
1680
+ # The identifier for the folder that the evidence is stored in.
1654
1681
  #
1655
1682
  # @return [Types::GetEvidenceFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1656
1683
  #
@@ -1698,14 +1725,14 @@ module Aws::AuditManager
1698
1725
  # Manager.
1699
1726
  #
1700
1727
  # @option params [required, String] :assessment_id
1701
- # The identifier for the specified assessment.
1728
+ # The identifier for the assessment.
1702
1729
  #
1703
1730
  # @option params [String] :next_token
1704
- # The pagination token used to fetch the next set of results.
1731
+ # The pagination token that's used to fetch the next set of results.
1705
1732
  #
1706
1733
  # @option params [Integer] :max_results
1707
- # Represents the maximum number of results per page, or per API request
1708
- # call.
1734
+ # Represents the maximum number of results on a page or for an API
1735
+ # request call.
1709
1736
  #
1710
1737
  # @return [Types::GetEvidenceFoldersByAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1711
1738
  #
@@ -1754,24 +1781,24 @@ module Aws::AuditManager
1754
1781
  req.send_request(options)
1755
1782
  end
1756
1783
 
1757
- # Returns a list of evidence folders associated with a specified control
1758
- # of an assessment in Audit Manager.
1784
+ # Returns a list of evidence folders that are associated with a
1785
+ # specified control of an assessment in Audit Manager.
1759
1786
  #
1760
1787
  # @option params [required, String] :assessment_id
1761
- # The identifier for the specified assessment.
1788
+ # The identifier for the assessment.
1762
1789
  #
1763
1790
  # @option params [required, String] :control_set_id
1764
- # The identifier for the specified control set.
1791
+ # The identifier for the control set.
1765
1792
  #
1766
1793
  # @option params [required, String] :control_id
1767
- # The identifier for the specified control.
1794
+ # The identifier for the control.
1768
1795
  #
1769
1796
  # @option params [String] :next_token
1770
- # The pagination token used to fetch the next set of results.
1797
+ # The pagination token that's used to fetch the next set of results.
1771
1798
  #
1772
1799
  # @option params [Integer] :max_results
1773
- # Represents the maximum number of results per page, or per API request
1774
- # call.
1800
+ # Represents the maximum number of results on a page or for an API
1801
+ # request call.
1775
1802
  #
1776
1803
  # @return [Types::GetEvidenceFoldersByAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1777
1804
  #
@@ -1903,18 +1930,77 @@ module Aws::AuditManager
1903
1930
  req.send_request(options)
1904
1931
  end
1905
1932
 
1906
- # Returns a list of the frameworks available in the Audit Manager
1907
- # framework library.
1933
+ # Returns a list of sent or received share requests for custom
1934
+ # frameworks in Audit Manager.
1935
+ #
1936
+ # @option params [required, String] :request_type
1937
+ # Specifies whether the share request is a sent request or a received
1938
+ # request.
1939
+ #
1940
+ # @option params [String] :next_token
1941
+ # The pagination token that's used to fetch the next set of results.
1942
+ #
1943
+ # @option params [Integer] :max_results
1944
+ # Represents the maximum number of results on a page or for an API
1945
+ # request call.
1946
+ #
1947
+ # @return [Types::ListAssessmentFrameworkShareRequestsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1948
+ #
1949
+ # * {Types::ListAssessmentFrameworkShareRequestsResponse#assessment_framework_share_requests #assessment_framework_share_requests} => Array&lt;Types::AssessmentFrameworkShareRequest&gt;
1950
+ # * {Types::ListAssessmentFrameworkShareRequestsResponse#next_token #next_token} => String
1951
+ #
1952
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1953
+ #
1954
+ # @example Request syntax with placeholder values
1955
+ #
1956
+ # resp = client.list_assessment_framework_share_requests({
1957
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
1958
+ # next_token: "Token",
1959
+ # max_results: 1,
1960
+ # })
1961
+ #
1962
+ # @example Response structure
1963
+ #
1964
+ # resp.assessment_framework_share_requests #=> Array
1965
+ # resp.assessment_framework_share_requests[0].id #=> String
1966
+ # resp.assessment_framework_share_requests[0].framework_id #=> String
1967
+ # resp.assessment_framework_share_requests[0].framework_name #=> String
1968
+ # resp.assessment_framework_share_requests[0].framework_description #=> String
1969
+ # resp.assessment_framework_share_requests[0].status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
1970
+ # resp.assessment_framework_share_requests[0].source_account #=> String
1971
+ # resp.assessment_framework_share_requests[0].destination_account #=> String
1972
+ # resp.assessment_framework_share_requests[0].destination_region #=> String
1973
+ # resp.assessment_framework_share_requests[0].expiration_time #=> Time
1974
+ # resp.assessment_framework_share_requests[0].creation_time #=> Time
1975
+ # resp.assessment_framework_share_requests[0].last_updated #=> Time
1976
+ # resp.assessment_framework_share_requests[0].comment #=> String
1977
+ # resp.assessment_framework_share_requests[0].standard_controls_count #=> Integer
1978
+ # resp.assessment_framework_share_requests[0].custom_controls_count #=> Integer
1979
+ # resp.assessment_framework_share_requests[0].compliance_type #=> String
1980
+ # resp.next_token #=> String
1981
+ #
1982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentFrameworkShareRequests AWS API Documentation
1983
+ #
1984
+ # @overload list_assessment_framework_share_requests(params = {})
1985
+ # @param [Hash] params ({})
1986
+ def list_assessment_framework_share_requests(params = {}, options = {})
1987
+ req = build_request(:list_assessment_framework_share_requests, params)
1988
+ req.send_request(options)
1989
+ end
1990
+
1991
+ # Returns a list of the frameworks that are available in the Audit
1992
+ # Manager framework library.
1908
1993
  #
1909
1994
  # @option params [required, String] :framework_type
1910
- # The type of framework, such as standard or custom.
1995
+ # The type of framework, such as a standard framework or a custom
1996
+ # framework.
1911
1997
  #
1912
1998
  # @option params [String] :next_token
1913
- # The pagination token used to fetch the next set of results.
1999
+ # The pagination token that's used to fetch the next set of results.
1914
2000
  #
1915
2001
  # @option params [Integer] :max_results
1916
- # Represents the maximum number of results per page, or per API request
1917
- # call.
2002
+ # Represents the maximum number of results on a page or for an API
2003
+ # request call.
1918
2004
  #
1919
2005
  # @return [Types::ListAssessmentFrameworksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1920
2006
  #
@@ -1959,11 +2045,11 @@ module Aws::AuditManager
1959
2045
  # Returns a list of assessment reports created in Audit Manager.
1960
2046
  #
1961
2047
  # @option params [String] :next_token
1962
- # The pagination token used to fetch the next set of results.
2048
+ # The pagination token that's used to fetch the next set of results.
1963
2049
  #
1964
2050
  # @option params [Integer] :max_results
1965
- # Represents the maximum number of results per page, or per API request
1966
- # call.
2051
+ # Represents the maximum number of results on a page or for an API
2052
+ # request call.
1967
2053
  #
1968
2054
  # @return [Types::ListAssessmentReportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1969
2055
  #
@@ -2004,11 +2090,11 @@ module Aws::AuditManager
2004
2090
  # Returns a list of current and past assessments from Audit Manager.
2005
2091
  #
2006
2092
  # @option params [String] :next_token
2007
- # The pagination token used to fetch the next set of results.
2093
+ # The pagination token that's used to fetch the next set of results.
2008
2094
  #
2009
2095
  # @option params [Integer] :max_results
2010
- # Represents the maximum number of results per page, or per API request
2011
- # call.
2096
+ # Represents the maximum number of results on a page or for an API
2097
+ # request call.
2012
2098
  #
2013
2099
  # @return [Types::ListAssessmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2014
2100
  #
@@ -2062,14 +2148,14 @@ module Aws::AuditManager
2062
2148
  # Returns a list of controls from Audit Manager.
2063
2149
  #
2064
2150
  # @option params [required, String] :control_type
2065
- # The type of control, such as standard or custom.
2151
+ # The type of control, such as a standard control or a custom control.
2066
2152
  #
2067
2153
  # @option params [String] :next_token
2068
- # The pagination token used to fetch the next set of results.
2154
+ # The pagination token that's used to fetch the next set of results.
2069
2155
  #
2070
2156
  # @option params [Integer] :max_results
2071
- # Represents the maximum number of results per page, or per API request
2072
- # call.
2157
+ # Represents the maximum number of results on a page or for an API
2158
+ # request call.
2073
2159
  #
2074
2160
  # @return [Types::ListControlsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2075
2161
  #
@@ -2106,18 +2192,18 @@ module Aws::AuditManager
2106
2192
  req.send_request(options)
2107
2193
  end
2108
2194
 
2109
- # Returns a list of keywords that pre-mapped to the specified control
2110
- # data source.
2195
+ # Returns a list of keywords that are pre-mapped to the specified
2196
+ # control data source.
2111
2197
  #
2112
2198
  # @option params [required, String] :source
2113
- # The control mapping data source to which the keywords apply.
2199
+ # The control mapping data source that the keywords apply to.
2114
2200
  #
2115
2201
  # @option params [String] :next_token
2116
- # The pagination token used to fetch the next set of results.
2202
+ # The pagination token that's used to fetch the next set of results.
2117
2203
  #
2118
2204
  # @option params [Integer] :max_results
2119
- # Represents the maximum number of results per page, or per API request
2120
- # call.
2205
+ # Represents the maximum number of results on a page or for an API
2206
+ # request call.
2121
2207
  #
2122
2208
  # @return [Types::ListKeywordsForDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2123
2209
  #
@@ -2152,11 +2238,11 @@ module Aws::AuditManager
2152
2238
  # Returns a list of all Audit Manager notifications.
2153
2239
  #
2154
2240
  # @option params [String] :next_token
2155
- # The pagination token used to fetch the next set of results.
2241
+ # The pagination token that's used to fetch the next set of results.
2156
2242
  #
2157
2243
  # @option params [Integer] :max_results
2158
- # Represents the maximum number of results per page, or per API request
2159
- # call.
2244
+ # Represents the maximum number of results on a page or for an API
2245
+ # request call.
2160
2246
  #
2161
2247
  # @return [Types::ListNotificationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2162
2248
  #
@@ -2197,7 +2283,7 @@ module Aws::AuditManager
2197
2283
  # Returns a list of tags for the specified resource in Audit Manager.
2198
2284
  #
2199
2285
  # @option params [required, String] :resource_arn
2200
- # The Amazon Resource Name (ARN) of the specified resource.
2286
+ # The Amazon Resource Name (ARN) of the resource.
2201
2287
  #
2202
2288
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2203
2289
  #
@@ -2259,7 +2345,7 @@ module Aws::AuditManager
2259
2345
  # delegated administrator for Audit Manager.
2260
2346
  #
2261
2347
  # @option params [required, String] :admin_account_id
2262
- # The identifier for the specified delegated administrator account.
2348
+ # The identifier for the delegated administrator account.
2263
2349
  #
2264
2350
  # @return [Types::RegisterOrganizationAdminAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2265
2351
  #
@@ -2286,13 +2372,84 @@ module Aws::AuditManager
2286
2372
  req.send_request(options)
2287
2373
  end
2288
2374
 
2375
+ # Creates a share request for a custom framework in Audit Manager.
2376
+ #
2377
+ # The share request specifies a recipient and notifies them that a
2378
+ # custom framework is available. Recipients have 120 days to accept or
2379
+ # decline the request. If no action is taken, the share request expires.
2380
+ #
2381
+ # When you invoke the `StartAssessmentFrameworkShare` API, you are about
2382
+ # to share a custom framework with another Amazon Web Services account.
2383
+ # You may not share a custom framework that is derived from a standard
2384
+ # framework if the standard framework is designated as not eligible for
2385
+ # sharing by Amazon Web Services, unless you have obtained permission to
2386
+ # do so from the owner of the standard framework. To learn more about
2387
+ # which standard frameworks are eligible for sharing, see [Framework
2388
+ # sharing eligibility][1] in the *Audit Manager User Guide*.
2389
+ #
2390
+ #
2391
+ #
2392
+ # [1]: https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility
2393
+ #
2394
+ # @option params [required, String] :framework_id
2395
+ # The unique identifier for the custom framework to be shared.
2396
+ #
2397
+ # @option params [required, String] :destination_account
2398
+ # The Amazon Web Services account of the recipient.
2399
+ #
2400
+ # @option params [required, String] :destination_region
2401
+ # The Amazon Web Services Region of the recipient.
2402
+ #
2403
+ # @option params [String] :comment
2404
+ # An optional comment from the sender about the share request.
2405
+ #
2406
+ # @return [Types::StartAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2407
+ #
2408
+ # * {Types::StartAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
2409
+ #
2410
+ # @example Request syntax with placeholder values
2411
+ #
2412
+ # resp = client.start_assessment_framework_share({
2413
+ # framework_id: "UUID", # required
2414
+ # destination_account: "AccountId", # required
2415
+ # destination_region: "Region", # required
2416
+ # comment: "ShareRequestComment",
2417
+ # })
2418
+ #
2419
+ # @example Response structure
2420
+ #
2421
+ # resp.assessment_framework_share_request.id #=> String
2422
+ # resp.assessment_framework_share_request.framework_id #=> String
2423
+ # resp.assessment_framework_share_request.framework_name #=> String
2424
+ # resp.assessment_framework_share_request.framework_description #=> String
2425
+ # resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
2426
+ # resp.assessment_framework_share_request.source_account #=> String
2427
+ # resp.assessment_framework_share_request.destination_account #=> String
2428
+ # resp.assessment_framework_share_request.destination_region #=> String
2429
+ # resp.assessment_framework_share_request.expiration_time #=> Time
2430
+ # resp.assessment_framework_share_request.creation_time #=> Time
2431
+ # resp.assessment_framework_share_request.last_updated #=> Time
2432
+ # resp.assessment_framework_share_request.comment #=> String
2433
+ # resp.assessment_framework_share_request.standard_controls_count #=> Integer
2434
+ # resp.assessment_framework_share_request.custom_controls_count #=> Integer
2435
+ # resp.assessment_framework_share_request.compliance_type #=> String
2436
+ #
2437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare AWS API Documentation
2438
+ #
2439
+ # @overload start_assessment_framework_share(params = {})
2440
+ # @param [Hash] params ({})
2441
+ def start_assessment_framework_share(params = {}, options = {})
2442
+ req = build_request(:start_assessment_framework_share, params)
2443
+ req.send_request(options)
2444
+ end
2445
+
2289
2446
  # Tags the specified resource in Audit Manager.
2290
2447
  #
2291
2448
  # @option params [required, String] :resource_arn
2292
- # The Amazon Resource Name (ARN) of the specified resource.
2449
+ # The Amazon Resource Name (ARN) of the resource.
2293
2450
  #
2294
2451
  # @option params [required, Hash<String,String>] :tags
2295
- # The tags to be associated with the resource.
2452
+ # The tags that are associated with the resource.
2296
2453
  #
2297
2454
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2298
2455
  #
@@ -2343,23 +2500,23 @@ module Aws::AuditManager
2343
2500
  # Edits an Audit Manager assessment.
2344
2501
  #
2345
2502
  # @option params [required, String] :assessment_id
2346
- # The identifier for the specified assessment.
2503
+ # The identifier for the assessment.
2347
2504
  #
2348
2505
  # @option params [String] :assessment_name
2349
- # The name of the specified assessment to be updated.
2506
+ # The name of the assessment to be updated.
2350
2507
  #
2351
2508
  # @option params [String] :assessment_description
2352
- # The description of the specified assessment.
2509
+ # The description of the assessment.
2353
2510
  #
2354
2511
  # @option params [required, Types::Scope] :scope
2355
- # The scope of the specified assessment.
2512
+ # The scope of the assessment.
2356
2513
  #
2357
2514
  # @option params [Types::AssessmentReportsDestination] :assessment_reports_destination
2358
- # The assessment report storage destination for the specified assessment
2359
- # that is being updated.
2515
+ # The assessment report storage destination for the assessment that's
2516
+ # being updated.
2360
2517
  #
2361
2518
  # @option params [Array<Types::Role>] :roles
2362
- # The list of roles for the specified assessment.
2519
+ # The list of roles for the assessment.
2363
2520
  #
2364
2521
  # @return [Types::UpdateAssessmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2365
2522
  #
@@ -2489,19 +2646,19 @@ module Aws::AuditManager
2489
2646
  # Updates a control within an assessment in Audit Manager.
2490
2647
  #
2491
2648
  # @option params [required, String] :assessment_id
2492
- # The identifier for the specified assessment.
2649
+ # The identifier for the assessment.
2493
2650
  #
2494
2651
  # @option params [required, String] :control_set_id
2495
- # The identifier for the specified control set.
2652
+ # The identifier for the control set.
2496
2653
  #
2497
2654
  # @option params [required, String] :control_id
2498
- # The identifier for the specified control.
2655
+ # The identifier for the control.
2499
2656
  #
2500
2657
  # @option params [String] :control_status
2501
- # The status of the specified control.
2658
+ # The status of the control.
2502
2659
  #
2503
2660
  # @option params [String] :comment_body
2504
- # The comment body text for the specified control.
2661
+ # The comment body text for the control.
2505
2662
  #
2506
2663
  # @return [Types::UpdateAssessmentControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2507
2664
  #
@@ -2545,16 +2702,16 @@ module Aws::AuditManager
2545
2702
  # Updates the status of a control set in an Audit Manager assessment.
2546
2703
  #
2547
2704
  # @option params [required, String] :assessment_id
2548
- # The identifier for the specified assessment.
2705
+ # The identifier for the assessment.
2549
2706
  #
2550
2707
  # @option params [required, String] :control_set_id
2551
- # The identifier for the specified control set.
2708
+ # The identifier for the control set.
2552
2709
  #
2553
2710
  # @option params [required, String] :status
2554
- # The status of the control set that is being updated.
2711
+ # The status of the control set that's being updated.
2555
2712
  #
2556
2713
  # @option params [required, String] :comment
2557
- # The comment related to the status update.
2714
+ # The comment that's related to the status update.
2558
2715
  #
2559
2716
  # @return [Types::UpdateAssessmentControlSetStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2560
2717
  #
@@ -2618,20 +2775,20 @@ module Aws::AuditManager
2618
2775
  # Updates a custom framework in Audit Manager.
2619
2776
  #
2620
2777
  # @option params [required, String] :framework_id
2621
- # The identifier for the specified framework.
2778
+ # The identifier for the framework.
2622
2779
  #
2623
2780
  # @option params [required, String] :name
2624
2781
  # The name of the framework to be updated.
2625
2782
  #
2626
2783
  # @option params [String] :description
2627
- # The description of the framework that is to be updated.
2784
+ # The description of the updated framework.
2628
2785
  #
2629
2786
  # @option params [String] :compliance_type
2630
2787
  # The compliance type that the new custom framework supports, such as
2631
2788
  # CIS or HIPAA.
2632
2789
  #
2633
2790
  # @option params [required, Array<Types::UpdateAssessmentFrameworkControlSet>] :control_sets
2634
- # The control sets associated with the framework.
2791
+ # The control sets that are associated with the framework.
2635
2792
  #
2636
2793
  # @return [Types::UpdateAssessmentFrameworkResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2637
2794
  #
@@ -2712,13 +2869,64 @@ module Aws::AuditManager
2712
2869
  req.send_request(options)
2713
2870
  end
2714
2871
 
2872
+ # Updates a share request for a custom framework in Audit Manager.
2873
+ #
2874
+ # @option params [required, String] :request_id
2875
+ # The unique identifier for the share request.
2876
+ #
2877
+ # @option params [required, String] :request_type
2878
+ # Specifies whether the share request is a sent request or a received
2879
+ # request.
2880
+ #
2881
+ # @option params [required, String] :action
2882
+ # Specifies the update action for the share request.
2883
+ #
2884
+ # @return [Types::UpdateAssessmentFrameworkShareResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2885
+ #
2886
+ # * {Types::UpdateAssessmentFrameworkShareResponse#assessment_framework_share_request #assessment_framework_share_request} => Types::AssessmentFrameworkShareRequest
2887
+ #
2888
+ # @example Request syntax with placeholder values
2889
+ #
2890
+ # resp = client.update_assessment_framework_share({
2891
+ # request_id: "UUID", # required
2892
+ # request_type: "SENT", # required, accepts SENT, RECEIVED
2893
+ # action: "ACCEPT", # required, accepts ACCEPT, DECLINE, REVOKE
2894
+ # })
2895
+ #
2896
+ # @example Response structure
2897
+ #
2898
+ # resp.assessment_framework_share_request.id #=> String
2899
+ # resp.assessment_framework_share_request.framework_id #=> String
2900
+ # resp.assessment_framework_share_request.framework_name #=> String
2901
+ # resp.assessment_framework_share_request.framework_description #=> String
2902
+ # resp.assessment_framework_share_request.status #=> String, one of "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED"
2903
+ # resp.assessment_framework_share_request.source_account #=> String
2904
+ # resp.assessment_framework_share_request.destination_account #=> String
2905
+ # resp.assessment_framework_share_request.destination_region #=> String
2906
+ # resp.assessment_framework_share_request.expiration_time #=> Time
2907
+ # resp.assessment_framework_share_request.creation_time #=> Time
2908
+ # resp.assessment_framework_share_request.last_updated #=> Time
2909
+ # resp.assessment_framework_share_request.comment #=> String
2910
+ # resp.assessment_framework_share_request.standard_controls_count #=> Integer
2911
+ # resp.assessment_framework_share_request.custom_controls_count #=> Integer
2912
+ # resp.assessment_framework_share_request.compliance_type #=> String
2913
+ #
2914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare AWS API Documentation
2915
+ #
2916
+ # @overload update_assessment_framework_share(params = {})
2917
+ # @param [Hash] params ({})
2918
+ def update_assessment_framework_share(params = {}, options = {})
2919
+ req = build_request(:update_assessment_framework_share, params)
2920
+ req.send_request(options)
2921
+ end
2922
+
2715
2923
  # Updates the status of an assessment in Audit Manager.
2716
2924
  #
2717
2925
  # @option params [required, String] :assessment_id
2718
- # The identifier for the specified assessment.
2926
+ # The identifier for the assessment.
2719
2927
  #
2720
2928
  # @option params [required, String] :status
2721
- # The current status of the specified assessment.
2929
+ # The current status of the assessment.
2722
2930
  #
2723
2931
  # @return [Types::UpdateAssessmentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2724
2932
  #
@@ -2823,26 +3031,25 @@ module Aws::AuditManager
2823
3031
  # Updates a custom control in Audit Manager.
2824
3032
  #
2825
3033
  # @option params [required, String] :control_id
2826
- # The identifier for the specified control.
3034
+ # The identifier for the control.
2827
3035
  #
2828
3036
  # @option params [required, String] :name
2829
- # The name of the control to be updated.
3037
+ # The name of the updated control.
2830
3038
  #
2831
3039
  # @option params [String] :description
2832
3040
  # The optional description of the control.
2833
3041
  #
2834
3042
  # @option params [String] :testing_information
2835
- # The steps that to follow to determine if the control has been
2836
- # satisfied.
3043
+ # The steps that you should follow to determine if the control is met.
2837
3044
  #
2838
3045
  # @option params [String] :action_plan_title
2839
3046
  # The title of the action plan for remediating the control.
2840
3047
  #
2841
3048
  # @option params [String] :action_plan_instructions
2842
- # The recommended actions to carry out if the control is not fulfilled.
3049
+ # The recommended actions to carry out if the control isn't fulfilled.
2843
3050
  #
2844
3051
  # @option params [required, Array<Types::ControlMappingSource>] :control_mapping_sources
2845
- # The data mapping sources for the specified control.
3052
+ # The data mapping sources for the control.
2846
3053
  #
2847
3054
  # @return [Types::UpdateControlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2848
3055
  #
@@ -2914,8 +3121,8 @@ module Aws::AuditManager
2914
3121
  # Updates Audit Manager settings for the current user account.
2915
3122
  #
2916
3123
  # @option params [String] :sns_topic
2917
- # The Amazon Simple Notification Service (Amazon SNS) topic to which
2918
- # Audit Manager sends notifications.
3124
+ # The Amazon Simple Notification Service (Amazon SNS) topic that Audit
3125
+ # Manager sends notifications to.
2919
3126
  #
2920
3127
  # @option params [Types::AssessmentReportsDestination] :default_assessment_reports_destination
2921
3128
  # The default storage destination for assessment reports.
@@ -2970,8 +3177,8 @@ module Aws::AuditManager
2970
3177
  # Validates the integrity of an assessment report in Audit Manager.
2971
3178
  #
2972
3179
  # @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.
3180
+ # The relative path of the Amazon S3 bucket that the assessment report
3181
+ # is stored in.
2975
3182
  #
2976
3183
  # @return [Types::ValidateAssessmentReportIntegrityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2977
3184
  #
@@ -3018,7 +3225,7 @@ module Aws::AuditManager
3018
3225
  params: params,
3019
3226
  config: config)
3020
3227
  context[:gem_name] = 'aws-sdk-auditmanager'
3021
- context[:gem_version] = '1.13.0'
3228
+ context[:gem_version] = '1.14.0'
3022
3229
  Seahorse::Client::Request.new(handlers, context)
3023
3230
  end
3024
3231