1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// An entity that defines the scope of audit evidence collected by Audit Manager.
// An Audit Manager assessment is an implementation of an Audit Manager framework.
type Assessment struct {
// The Amazon Resource Name (ARN) of the assessment.
Arn *string
// The Amazon Web Services account that's associated with the assessment.
AwsAccount *AWSAccount
// The framework that the assessment was created from.
Framework *AssessmentFramework
// The metadata for the assessment.
Metadata *AssessmentMetadata
// The tags that are associated with the assessment.
Tags map[string]string
noSmithyDocumentSerde
}
// The control entity that represents a standard control or a custom control in an
// Audit Manager assessment.
type AssessmentControl struct {
// The amount of evidence in the assessment report.
AssessmentReportEvidenceCount int32
// The list of comments that's attached to the control.
Comments []ControlComment
// The description of the control.
Description *string
// The amount of evidence that's generated for the control.
EvidenceCount int32
// The list of data sources for the evidence.
EvidenceSources []string
// The identifier for the control.
Id *string
// The name of the control.
Name *string
// The response of the control.
Response ControlResponse
// The status of the control.
Status ControlStatus
noSmithyDocumentSerde
}
// Represents a set of controls in an Audit Manager assessment.
type AssessmentControlSet struct {
// The list of controls that's contained with the control set.
Controls []AssessmentControl
// The delegations that are associated with the control set.
Delegations []Delegation
// The description for the control set.
Description *string
// The identifier of the control set in the assessment. This is the control set
// name in a plain string format.
Id *string
// The total number of evidence objects that are uploaded manually to the control
// set.
ManualEvidenceCount int32
// The roles that are associated with the control set.
Roles []Role
// Specifies the current status of the control set.
Status ControlSetStatus
// The total number of evidence objects that are retrieved automatically for the
// control set.
SystemEvidenceCount int32
noSmithyDocumentSerde
}
// The folder where Audit Manager stores evidence for an assessment.
type AssessmentEvidenceFolder struct {
// The identifier for the assessment.
AssessmentId *string
// The total count of evidence that's included in the assessment report.
AssessmentReportSelectionCount int32
// The name of the user who created the evidence folder.
Author *string
// The unique identifier for the control.
ControlId *string
// The name of the control.
ControlName *string
// The identifier for the control set.
ControlSetId *string
// The Amazon Web Service that the evidence was collected from.
DataSource *string
// The date when the first evidence was added to the evidence folder.
Date *time.Time
// The total number of Amazon Web Services resources that were assessed to generate
// the evidence.
EvidenceAwsServiceSourceCount int32
// The number of evidence that falls under the compliance check category. This
// evidence is collected from Config or Security Hub.
EvidenceByTypeComplianceCheckCount int32
// The total number of issues that were reported directly from Security Hub,
// Config, or both.
EvidenceByTypeComplianceCheckIssuesCount int32
// The number of evidence that falls under the configuration data category. This
// evidence is collected from configuration snapshots of other Amazon Web Services
// such as Amazon EC2, Amazon S3, or IAM.
EvidenceByTypeConfigurationDataCount int32
// The number of evidence that falls under the manual category. This evidence is
// imported manually.
EvidenceByTypeManualCount int32
// The number of evidence that falls under the user activity category. This
// evidence is collected from CloudTrail logs.
EvidenceByTypeUserActivityCount int32
// The amount of evidence that's included in the evidence folder.
EvidenceResourcesIncludedCount int32
// The identifier for the folder that the evidence is stored in.
Id *string
// The name of the evidence folder.
Name *string
// The total amount of evidence in the evidence folder.
TotalEvidence int32
noSmithyDocumentSerde
}
// The file used to structure and automate Audit Manager assessments for a given
// compliance standard.
type AssessmentFramework struct {
// The Amazon Resource Name (ARN) of the framework.
Arn *string
// The control sets that are associated with the framework.
ControlSets []AssessmentControlSet
// The unique identifier for the framework.
Id *string
// The metadata of a framework, such as the name, ID, or description.
Metadata *FrameworkMetadata
noSmithyDocumentSerde
}
// The metadata that's associated with a standard framework or a custom framework.
type AssessmentFrameworkMetadata struct {
// The Amazon Resource Name (ARN) of the framework.
Arn *string
// The compliance type that the new custom framework supports, such as CIS or
// HIPAA.
ComplianceType *string
// The number of control sets that are associated with the framework.
ControlSetsCount int32
// The number of controls that are associated with the framework.
ControlsCount int32
// Specifies when the framework was created.
CreatedAt *time.Time
// The description of the framework.
Description *string
// The unique identifier for the framework.
Id *string
// Specifies when the framework was most recently updated.
LastUpdatedAt *time.Time
// The logo that's associated with the framework.
Logo *string
// The name of the framework.
Name *string
// The framework type, such as a standard framework or a custom framework.
Type FrameworkType
noSmithyDocumentSerde
}
// Represents a share request for a custom framework in Audit Manager.
type AssessmentFrameworkShareRequest struct {
// An optional comment from the sender about the share request.
Comment *string
// The compliance type that the shared custom framework supports, such as CIS or
// HIPAA.
ComplianceType *string
// The time when the share request was created.
CreationTime *time.Time
// The number of custom controls that are part of the shared custom framework.
CustomControlsCount *int32
// The Amazon Web Services account of the recipient.
DestinationAccount *string
// The Amazon Web Services Region of the recipient.
DestinationRegion *string
// The time when the share request expires.
ExpirationTime *time.Time
// The description of the shared custom framework.
FrameworkDescription *string
// The unique identifier for the shared custom framework.
FrameworkId *string
// The name of the custom framework that the share request is for.
FrameworkName *string
// The unique identifier for the share request.
Id *string
// Specifies when the share request was last updated.
LastUpdated *time.Time
// The Amazon Web Services account of the sender.
SourceAccount *string
// The number of standard controls that are part of the shared custom framework.
StandardControlsCount *int32
// The status of the share request.
Status ShareRequestStatus
noSmithyDocumentSerde
}
// The metadata that's associated with the specified assessment.
type AssessmentMetadata struct {
// The destination that evidence reports are stored in for the assessment.
AssessmentReportsDestination *AssessmentReportsDestination
// The name of the compliance standard that's related to the assessment, such as
// PCI-DSS.
ComplianceType *string
// Specifies when the assessment was created.
CreationTime *time.Time
// The delegations that are associated with the assessment.
Delegations []Delegation
// The description of the assessment.
Description *string
// The unique identifier for the assessment.
Id *string
// The time of the most recent update.
LastUpdated *time.Time
// The name of the assessment.
Name *string
// The roles that are associated with the assessment.
Roles []Role
// The wrapper of Amazon Web Services accounts and services that are in scope for
// the assessment.
Scope *Scope
// The overall status of the assessment.
Status AssessmentStatus
noSmithyDocumentSerde
}
// A metadata object that's associated with an assessment in Audit Manager.
type AssessmentMetadataItem struct {
// The name of the compliance standard that's related to the assessment, such as
// PCI-DSS.
ComplianceType *string
// Specifies when the assessment was created.
CreationTime *time.Time
// The delegations that are associated with the assessment.
Delegations []Delegation
// The unique identifier for the assessment.
Id *string
// The time of the most recent update.
LastUpdated *time.Time
// The name of the assessment.
Name *string
// The roles that are associated with the assessment.
Roles []Role
// The current status of the assessment.
Status AssessmentStatus
noSmithyDocumentSerde
}
// A finalized document that's generated from an Audit Manager assessment. These
// reports summarize the relevant evidence that was collected for your audit, and
// link to the relevant evidence folders. These evidence folders are named and
// organized according to the controls that are specified in your assessment.
type AssessmentReport struct {
// The identifier for the specified assessment.
AssessmentId *string
// The name of the associated assessment.
AssessmentName *string
// The name of the user who created the assessment report.
Author *string
// The identifier for the specified Amazon Web Services account.
AwsAccountId *string
// Specifies when the assessment report was created.
CreationTime *time.Time
// The description of the specified assessment report.
Description *string
// The unique identifier for the assessment report.
Id *string
// The name that's given to the assessment report.
Name *string
// The current status of the specified assessment report.
Status AssessmentReportStatus
noSmithyDocumentSerde
}
// An error entity for the AssessmentReportEvidence API. This is used to provide
// more meaningful errors than a simple string message.
type AssessmentReportEvidenceError struct {
// The error code that the AssessmentReportEvidence API returned.
ErrorCode *string
// The error message that the AssessmentReportEvidence API returned.
ErrorMessage *string
// The identifier for the evidence.
EvidenceId *string
noSmithyDocumentSerde
}
// The metadata objects that are associated with the specified assessment report.
type AssessmentReportMetadata struct {
// The unique identifier for the associated assessment.
AssessmentId *string
// The name of the associated assessment.
AssessmentName *string
// The name of the user who created the assessment report.
Author *string
// Specifies when the assessment report was created.
CreationTime *time.Time
// The description of the assessment report.
Description *string
// The unique identifier for the assessment report.
Id *string
// The name of the assessment report.
Name *string
// The current status of the assessment report.
Status AssessmentReportStatus
noSmithyDocumentSerde
}
// The location where Audit Manager saves assessment reports for the given
// assessment.
type AssessmentReportsDestination struct {
// The destination of the assessment report.
Destination *string
// The destination type, such as Amazon S3.
DestinationType AssessmentReportDestinationType
noSmithyDocumentSerde
}
// The wrapper of Amazon Web Services account details, such as account ID or email
// address.
type AWSAccount struct {
// The email address that's associated with the Amazon Web Services account.
EmailAddress *string
// The identifier for the Amazon Web Services account.
Id *string
// The name of the Amazon Web Services account.
Name *string
noSmithyDocumentSerde
}
// An Amazon Web Service such as Amazon S3 or CloudTrail.
type AWSService struct {
// The name of the Amazon Web Service.
ServiceName *string
noSmithyDocumentSerde
}
// An error entity for the BatchCreateDelegationByAssessment API. This is used to
// provide more meaningful errors than a simple string message.
type BatchCreateDelegationByAssessmentError struct {
// The API request to batch create delegations in Audit Manager.
CreateDelegationRequest *CreateDelegationRequest
// The error code that the BatchCreateDelegationByAssessment API returned.
ErrorCode *string
// The error message that the BatchCreateDelegationByAssessment API returned.
ErrorMessage *string
noSmithyDocumentSerde
}
// An error entity for the BatchDeleteDelegationByAssessment API. This is used to
// provide more meaningful errors than a simple string message.
type BatchDeleteDelegationByAssessmentError struct {
// The identifier for the delegation.
DelegationId *string
// The error code that the BatchDeleteDelegationByAssessment API returned.
ErrorCode *string
// The error message that the BatchDeleteDelegationByAssessment API returned.
ErrorMessage *string
noSmithyDocumentSerde
}
// An error entity for the BatchImportEvidenceToAssessmentControl API. This is used
// to provide more meaningful errors than a simple string message.
type BatchImportEvidenceToAssessmentControlError struct {
// The error code that the BatchImportEvidenceToAssessmentControl API returned.
ErrorCode *string
// The error message that the BatchImportEvidenceToAssessmentControl API returned.
ErrorMessage *string
// Manual evidence that can't be collected automatically by Audit Manager.
ManualEvidence *ManualEvidence
noSmithyDocumentSerde
}
// The record of a change within Audit Manager. For example, this could be the
// status change of an assessment or the delegation of a control set.
type ChangeLog struct {
// The action that was performed.
Action ActionEnum
// The time when the action was performed and the changelog record was created.
CreatedAt *time.Time
// The IAM user or role that performed the action.
CreatedBy *string
// The name of the object that changed. This could be the name of an assessment,
// control, or control set.
ObjectName *string
// The object that was changed, such as an assessment, control, or control set.
ObjectType ObjectTypeEnum
noSmithyDocumentSerde
}
// A control in Audit Manager.
type Control struct {
// The recommended actions to carry out if the control isn't fulfilled.
ActionPlanInstructions *string
// The title of the action plan for remediating the control.
ActionPlanTitle *string
// The Amazon Resource Name (ARN) of the control.
Arn *string
// The data mapping sources for the control.
ControlMappingSources []ControlMappingSource
// The data source that determines where Audit Manager collects evidence from for
// the control.
ControlSources *string
// Specifies when the control was created.
CreatedAt *time.Time
// The IAM user or role that created the control.
CreatedBy *string
// The description of the control.
Description *string
// The unique identifier for the control.
Id *string
// Specifies when the control was most recently updated.
LastUpdatedAt *time.Time
// The IAM user or role that most recently updated the control.
LastUpdatedBy *string
// The name of the control.
Name *string
// The tags associated with the control.
Tags map[string]string
// The steps that you should follow to determine if the control has been satisfied.
TestingInformation *string
// The type of control, such as a custom control or a standard control.
Type ControlType
noSmithyDocumentSerde
}
// A comment that's posted by a user on a control. This includes the author's name,
// the comment text, and a timestamp.
type ControlComment struct {
// The name of the user who authored the comment.
AuthorName *string
// The body text of a control comment.
CommentBody *string
// The time when the comment was posted.
PostedDate *time.Time
noSmithyDocumentSerde
}
// A summary of the latest analytics data for a specific control domain. Control
// domain insights are grouped by control domain, and ranked by the highest total
// count of non-compliant evidence.
type ControlDomainInsights struct {
// The number of controls in the control domain that collected non-compliant
// evidence on the lastUpdated date.
ControlsCountByNoncompliantEvidence *int32
// A breakdown of the compliance check status for the evidence that’s associated
// with the control domain.
EvidenceInsights *EvidenceInsights
// The unique identifier for the control domain.
Id *string
// The time when the control domain insights were last updated.
LastUpdated *time.Time
// The name of the control domain.
Name *string
// The total number of controls in the control domain.
TotalControlsCount *int32
noSmithyDocumentSerde
}
// A summary of the latest analytics data for a specific control in a specific
// active assessment. Control insights are grouped by control domain, and ranked by
// the highest total count of non-compliant evidence.
type ControlInsightsMetadataByAssessmentItem struct {
// The name of the control set that the assessment control belongs to.
ControlSetName *string
// A breakdown of the compliance check status for the evidence that’s associated
// with the assessment control.
EvidenceInsights *EvidenceInsights
// The unique identifier for the assessment control.
Id *string
// The time when the assessment control insights were last updated.
LastUpdated *time.Time
// The name of the assessment control.
Name *string
noSmithyDocumentSerde
}
// A summary of the latest analytics data for a specific control. This data
// reflects the total counts for the specified control across all active
// assessments. Control insights are grouped by control domain, and ranked by the
// highest total count of non-compliant evidence.
type ControlInsightsMetadataItem struct {
// A breakdown of the compliance check status for the evidence that’s associated
// with the control.
EvidenceInsights *EvidenceInsights
// The unique identifier for the control.
Id *string
// The time when the control insights were last updated.
LastUpdated *time.Time
// The name of the control.
Name *string
noSmithyDocumentSerde
}
// The data source that determines where Audit Manager collects evidence from for
// the control.
type ControlMappingSource struct {
// The description of the source.
SourceDescription *string
// The frequency of evidence collection for the control mapping source.
SourceFrequency SourceFrequency
// The unique identifier for the source.
SourceId *string
// The keyword to search for in CloudTrail logs, Config rules, Security Hub checks,
// and Amazon Web Services API names. To learn more about the supported keywords
// that you can use when mapping a control data source, see the following pages in
// the Audit Manager User Guide:
//
// * Config rules supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html)
//
// *
// Security Hub controls supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html)
//
// *
// API calls supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html)
//
// *
// CloudTrail event names supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html)
SourceKeyword *SourceKeyword
// The name of the source.
SourceName *string
// The setup option for the data source. This option reflects if the evidence
// collection is automated or manual.
SourceSetUpOption SourceSetUpOption
// Specifies one of the five types of data sources for evidence collection.
SourceType SourceType
// The instructions for troubleshooting the control.
TroubleshootingText *string
noSmithyDocumentSerde
}
// The metadata that's associated with the standard control or custom control.
type ControlMetadata struct {
// The Amazon Resource Name (ARN) of the control.
Arn *string
// The data source that determines where Audit Manager collects evidence from for
// the control.
ControlSources *string
// Specifies when the control was created.
CreatedAt *time.Time
// The unique identifier for the control.
Id *string
// Specifies when the control was most recently updated.
LastUpdatedAt *time.Time
// The name of the control.
Name *string
noSmithyDocumentSerde
}
// A set of controls in Audit Manager.
type ControlSet struct {
// The list of controls within the control set.
Controls []Control
// The identifier of the control set in the assessment. This is the control set
// name in a plain string format.
Id *string
// The name of the control set.
Name *string
noSmithyDocumentSerde
}
// The control entity attributes that uniquely identify an existing control to be
// added to a framework in Audit Manager.
type CreateAssessmentFrameworkControl struct {
// The unique identifier of the control.
//
// This member is required.
Id *string
noSmithyDocumentSerde
}
// A controlSet entity that represents a collection of controls in Audit Manager.
// This doesn't contain the control set ID.
type CreateAssessmentFrameworkControlSet struct {
// The name of the control set.
//
// This member is required.
Name *string
// The list of controls within the control set. This doesn't contain the control
// set ID.
Controls []CreateAssessmentFrameworkControl
noSmithyDocumentSerde
}
// The control mapping fields that represent the source for evidence collection,
// along with related parameters and metadata. This doesn't contain mappingID.
type CreateControlMappingSource struct {
// The description of the data source that determines where Audit Manager collects
// evidence from for the control.
SourceDescription *string
// The frequency of evidence collection for the control mapping source.
SourceFrequency SourceFrequency
// The keyword to search for in CloudTrail logs, Config rules, Security Hub checks,
// and Amazon Web Services API names. To learn more about the supported keywords
// that you can use when mapping a control data source, see the following pages in
// the Audit Manager User Guide:
//
// * Config rules supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html)
//
// *
// Security Hub controls supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html)
//
// *
// API calls supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html)
//
// *
// CloudTrail event names supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html)
SourceKeyword *SourceKeyword
// The name of the control mapping data source.
SourceName *string
// The setup option for the data source, which reflects if the evidence collection
// is automated or manual.
SourceSetUpOption SourceSetUpOption
// Specifies one of the five types of data sources for evidence collection.
SourceType SourceType
// The instructions for troubleshooting the control.
TroubleshootingText *string
noSmithyDocumentSerde
}
// A collection of attributes that's used to create a delegation for an assessment
// in Audit Manager.
type CreateDelegationRequest struct {
// A comment that's related to the delegation request.
Comment *string
// The unique identifier for the control set.
ControlSetId *string
// The Amazon Resource Name (ARN) of the IAM role.
RoleArn *string
// The type of customer persona. In CreateAssessment, roleType can only be
// PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In
// BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
RoleType RoleType
noSmithyDocumentSerde
}
// The assignment of a control set to a delegate for review.
type Delegation struct {
// The identifier for the assessment that's associated with the delegation.
AssessmentId *string
// The name of the assessment that's associated with the delegation.
AssessmentName *string
// The comment that's related to the delegation.
Comment *string
// The identifier for the control set that's associated with the delegation.
ControlSetId *string
// The IAM user or role that created the delegation.
CreatedBy *string
// Specifies when the delegation was created.
CreationTime *time.Time
// The unique identifier for the delegation.
Id *string
// Specifies when the delegation was last updated.
LastUpdated *time.Time
// The Amazon Resource Name (ARN) of the IAM role.
RoleArn *string
// The type of customer persona. In CreateAssessment, roleType can only be
// PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In
// BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
RoleType RoleType
// The status of the delegation.
Status DelegationStatus
noSmithyDocumentSerde
}
// The metadata that's associated with the delegation.
type DelegationMetadata struct {
// The unique identifier for the assessment.
AssessmentId *string
// The name of the associated assessment.
AssessmentName *string
// Specifies the name of the control set that was delegated for review.
ControlSetName *string
// Specifies when the delegation was created.
CreationTime *time.Time
// The unique identifier for the delegation.
Id *string
// The Amazon Resource Name (ARN) of the IAM role.
RoleArn *string
// The current status of the delegation.
Status DelegationStatus
noSmithyDocumentSerde
}
// A record that contains the information needed to demonstrate compliance with the
// requirements specified by a control. Examples of evidence include change
// activity triggered by a user, or a system configuration snapshot.
type Evidence struct {
// Specifies whether the evidence is included in the assessment report.
AssessmentReportSelection *string
// The names and values that are used by the evidence event. This includes an
// attribute name (such as allowUsersToChangePassword) and value (such as true or
// false).
Attributes map[string]string
// The identifier for the Amazon Web Services account.
AwsAccountId *string
// The Amazon Web Services account that the evidence is collected from, and its
// organization path.
AwsOrganization *string
// The evaluation status for evidence that falls under the compliance check
// category. For evidence collected from Security Hub, a Pass or Fail result is
// shown. For evidence collected from Config, a Compliant or Noncompliant result is
// shown.
ComplianceCheck *string
// The data source where the evidence was collected from.
DataSource *string
// The name of the evidence event.
EventName *string
// The Amazon Web Service that the evidence is collected from.
EventSource *string
// The identifier for the Amazon Web Services account.
EvidenceAwsAccountId *string
// The type of automated evidence.
EvidenceByType *string
// The identifier for the folder that the evidence is stored in.
EvidenceFolderId *string
// The unique identifier for the IAM user or role that's associated with the
// evidence.
IamId *string
// The identifier for the evidence.
Id *string
// The list of resources that are assessed to generate the evidence.
ResourcesIncluded []Resource
// The timestamp that represents when the evidence was collected.
Time *time.Time
noSmithyDocumentSerde
}
// A breakdown of the latest compliance check status for the evidence in your Audit
// Manager assessments.
type EvidenceInsights struct {
// The number of compliance check evidence that Audit Manager classified as
// compliant. This includes evidence that was collected from Security Hub with a
// Pass ruling, or collected from Config with a Compliant ruling.
CompliantEvidenceCount *int32
// The number of evidence that a compliance check ruling isn't available for.
// Evidence is inconclusive when the associated control uses Security Hub or Config
// as a data source but you didn't enable those services. This is also the case
// when a control uses a data source that doesn’t support compliance checks (for
// example, manual evidence, API calls, or CloudTrail). If evidence has a
// compliance check status of not applicable in the console, it's classified as
// inconclusive in EvidenceInsights data.
InconclusiveEvidenceCount *int32
// The number of compliance check evidence that Audit Manager classified as
// non-compliant. This includes evidence that was collected from Security Hub with
// a Fail ruling, or collected from Config with a Non-compliant ruling.
NoncompliantEvidenceCount *int32
noSmithyDocumentSerde
}
// The file that's used to structure and automate Audit Manager assessments for a
// given compliance standard.
type Framework struct {
// The Amazon Resource Name (ARN) of the framework.
Arn *string
// The compliance type that the new custom framework supports, such as CIS or
// HIPAA.
ComplianceType *string
// The control sets that are associated with the framework.
ControlSets []ControlSet
// The sources that Audit Manager collects evidence from for the control.
ControlSources *string
// Specifies when the framework was created.
CreatedAt *time.Time
// The IAM user or role that created the framework.
CreatedBy *string
// The description of the framework.
Description *string
// The unique identifier for the framework.
Id *string
// Specifies when the framework was most recently updated.
LastUpdatedAt *time.Time
// The IAM user or role that most recently updated the framework.
LastUpdatedBy *string
// The logo that's associated with the framework.
Logo *string
// The name of the framework.
Name *string
// The tags that are associated with the framework.
Tags map[string]string
// The framework type, such as a custom framework or a standard framework.
Type FrameworkType
noSmithyDocumentSerde
}
// The metadata of a framework, such as the name, ID, or description.
type FrameworkMetadata struct {
// The compliance standard that's associated with the framework. For example, this
// could be PCI DSS or HIPAA.
ComplianceType *string
// The description of the framework.
Description *string
// The logo that's associated with the framework.
Logo *string
// The name of the framework.
Name *string
noSmithyDocumentSerde
}
// A summary of the latest analytics data for all your active assessments. This
// summary is a snapshot of the data that your active assessments collected on the
// lastUpdated date. It’s important to understand that the following totals are
// daily counts based on this date — they aren’t a total sum to date. The Insights
// data is eventually consistent. This means that, when you read data from
// Insights, the response might not instantly reflect the results of a recently
// completed write or update operation. If you repeat your read request after a few
// hours, the response should return the latest data. If you delete an assessment
// or change its status to inactive, InsightsByAssessment includes data for that
// assessment as follows.
//
// * Inactive assessments - If Audit Manager collected
// evidence for your assessment before you changed it inactive, that evidence is
// included in the InsightsByAssessment counts for that day.
//
// * Deleted assessments
// - If Audit Manager collected evidence for your assessment before you deleted it,
// that evidence isn't included in the InsightsByAssessment counts for that day.
type Insights struct {
// The number of active assessments in Audit Manager.
ActiveAssessmentsCount *int32
// The number of assessment controls that collected non-compliant evidence on the
// lastUpdated date.
AssessmentControlsCountByNoncompliantEvidence *int32
// The number of compliance check evidence that Audit Manager classified as
// compliant on the lastUpdated date. This includes evidence that was collected
// from Security Hub with a Pass ruling, or collected from Config with a Compliant
// ruling.
CompliantEvidenceCount *int32
// The number of evidence without a compliance check ruling. Evidence is
// inconclusive when the associated control uses Security Hub or Config as a data
// source but you didn't enable those services. This is also the case when a
// control uses a data source that doesn’t support compliance checks (for example:
// manual evidence, API calls, or CloudTrail). If evidence has a compliance check
// status of not applicable, it's classed as inconclusive in Insights data.
InconclusiveEvidenceCount *int32
// The time when the cross-assessment insights were last updated.
LastUpdated *time.Time
// The number of compliance check evidence that Audit Manager classified as
// non-compliant on the lastUpdated date. This includes evidence that was collected
// from Security Hub with a Fail ruling, or collected from Config with a
// Non-compliant ruling.
NoncompliantEvidenceCount *int32
// The total number of controls across all active assessments.
TotalAssessmentControlsCount *int32
noSmithyDocumentSerde
}
// A summary of the latest analytics data for a specific active assessment. This
// summary is a snapshot of the data that was collected on the lastUpdated date.
// It’s important to understand that the totals in InsightsByAssessment are daily
// counts based on this date — they aren’t a total sum to date. The
// InsightsByAssessment data is eventually consistent. This means that when you
// read data from InsightsByAssessment, the response might not instantly reflect
// the results of a recently completed write or update operation. If you repeat
// your read request after a few hours, the response returns the latest data. If
// you delete an assessment or change its status to inactive, InsightsByAssessment
// includes data for that assessment as follows.
//
// * Inactive assessments - If Audit
// Manager collected evidence for your assessment before you changed it inactive,
// that evidence is included in the InsightsByAssessment counts for that day.
//
// *
// Deleted assessments - If Audit Manager collected evidence for your assessment
// before you deleted it, that evidence isn't included in the InsightsByAssessment
// counts for that day.
type InsightsByAssessment struct {
// The number of assessment controls that collected non-compliant evidence on the
// lastUpdated date.
AssessmentControlsCountByNoncompliantEvidence *int32
// The number of compliance check evidence that Audit Manager classified as
// compliant. This includes evidence that was collected from Security Hub with a
// Pass ruling, or collected from Config with a Compliant ruling.
CompliantEvidenceCount *int32
// The amount of evidence without a compliance check ruling. Evidence is
// inconclusive if the associated control uses Security Hub or Config as a data
// source and you didn't enable those services. This is also the case if a control
// uses a data source that doesn’t support compliance checks (for example, manual
// evidence, API calls, or CloudTrail). If evidence has a compliance check status
// of not applicable, it's classified as inconclusive in InsightsByAssessment data.
InconclusiveEvidenceCount *int32
// The time when the assessment insights were last updated.
LastUpdated *time.Time
// The number of compliance check evidence that Audit Manager classified as
// non-compliant. This includes evidence that was collected from Security Hub with
// a Fail ruling, or collected from Config with a Non-compliant ruling.
NoncompliantEvidenceCount *int32
// The total number of controls in the assessment.
TotalAssessmentControlsCount *int32
noSmithyDocumentSerde
}
// Evidence that's uploaded to Audit Manager manually.
type ManualEvidence struct {
// The Amazon S3 URL that points to a manual evidence object.
S3ResourcePath *string
noSmithyDocumentSerde
}
// The notification that informs a user of an update in Audit Manager. For example,
// this includes the notification that's sent when a control set is delegated for
// review.
type Notification struct {
// The identifier for the assessment.
AssessmentId *string
// The name of the related assessment.
AssessmentName *string
// The identifier for the control set.
ControlSetId *string
// Specifies the name of the control set that the notification is about.
ControlSetName *string
// The description of the notification.
Description *string
// The time when the notification was sent.
EventTime *time.Time
// The unique identifier for the notification.
Id *string
// The sender of the notification.
Source *string
noSmithyDocumentSerde
}
// A system asset that's evaluated in an Audit Manager assessment.
type Resource struct {
// The Amazon Resource Name (ARN) for the resource.
Arn *string
// The value of the resource.
Value *string
noSmithyDocumentSerde
}
// The wrapper that contains the Audit Manager role information of the current
// user. This includes the role type and IAM Amazon Resource Name (ARN).
type Role struct {
// The Amazon Resource Name (ARN) of the IAM role.
//
// This member is required.
RoleArn *string
// The type of customer persona. In CreateAssessment, roleType can only be
// PROCESS_OWNER. In UpdateSettings, roleType can only be PROCESS_OWNER. In
// BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
//
// This member is required.
RoleType RoleType
noSmithyDocumentSerde
}
// The wrapper that contains the Amazon Web Services accounts and services that are
// in scope for the assessment.
type Scope struct {
// The Amazon Web Services accounts that are included in the scope of the
// assessment.
AwsAccounts []AWSAccount
// The Amazon Web Services services that are included in the scope of the
// assessment.
AwsServices []AWSService
noSmithyDocumentSerde
}
// The metadata that's associated with the Amazon Web Service.
type ServiceMetadata struct {
// The category that the Amazon Web Service belongs to, such as compute, storage,
// or database.
Category *string
// The description of the Amazon Web Service.
Description *string
// The display name of the Amazon Web Service.
DisplayName *string
// The name of the Amazon Web Service.
Name *string
noSmithyDocumentSerde
}
// The settings object that holds all supported Audit Manager settings.
type Settings struct {
// The default storage destination for assessment reports.
DefaultAssessmentReportsDestination *AssessmentReportsDestination
// The designated default audit owners.
DefaultProcessOwners []Role
// Specifies whether Organizations is enabled.
IsAwsOrgEnabled *bool
// The KMS key details.
KmsKey *string
// The designated Amazon Simple Notification Service (Amazon SNS) topic.
SnsTopic *string
noSmithyDocumentSerde
}
// The keyword to search for in CloudTrail logs, Config rules, Security Hub checks,
// and Amazon Web Services API names. To learn more about the supported keywords
// that you can use when mapping a control data source, see the following pages in
// the Audit Manager User Guide:
//
// * Config rules supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html)
//
// *
// Security Hub controls supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html)
//
// *
// API calls supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html)
//
// *
// CloudTrail event names supported by Audit Manager
// (https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html)
type SourceKeyword struct {
// The input method for the keyword.
KeywordInputType KeywordInputType
// The value of the keyword that's used when mapping a control data source. For
// example, this can be a CloudTrail event name, a rule name for Config, a Security
// Hub control, or the name of an Amazon Web Services API call. If you’re mapping a
// data source to a rule in Config, the keywordValue that you specify depends on
// the type of rule:
//
// * For managed rules
// (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html),
// you can use the rule identifier as the keywordValue. You can find the rule
// identifier from the list of Config managed rules
// (https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html).
//
// *
// Managed rule name: s3-bucket-acl-prohibited
// (https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html)keywordValue:
// S3_BUCKET_ACL_PROHIBITED
//
// * For custom rules
// (https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html),
// you form the keywordValue by adding the Custom_ prefix to the rule name. This
// prefix distinguishes the rule from a managed rule.
//
// * Custom rule name:
// my-custom-config-rule keywordValue: Custom_my-custom-config-rule
//
// * For
// service-linked rules
// (https://docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html),
// you form the keywordValue by adding the Custom_ prefix to the rule name. In
// addition, you remove the suffix ID that appears at the end of the rule name.
//
// *
// Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
// keywordValue: Custom_CustomRuleForAccount-conformance-pack
//
// * Service-linked
// rule name: securityhub-api-gw-cache-encrypted-101104e1 keywordValue:
// Custom_securityhub-api-gw-cache-encrypted
//
// * Service-linked rule name:
// OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba keywordValue:
// Custom_OrgConfigRule-s3-bucket-versioning-enabled
KeywordValue *string
noSmithyDocumentSerde
}
// A controlSet entity that represents a collection of controls in Audit Manager.
// This doesn't contain the control set ID.
type UpdateAssessmentFrameworkControlSet struct {
// The list of controls that are contained within the control set.
//
// This member is required.
Controls []CreateAssessmentFrameworkControl
// The name of the control set.
//
// This member is required.
Name *string
// The unique identifier for the control set.
Id *string
noSmithyDocumentSerde
}
// Short for uniform resource locator. A URL is used as a unique identifier to
// locate a resource on the internet.
type URL struct {
// The name or word that's used as a hyperlink to the URL.
HyperlinkName *string
// The unique identifier for the internet resource.
Link *string
noSmithyDocumentSerde
}
// Indicates that the request has invalid or missing parameters for the field.
type ValidationExceptionField struct {
// The body of the error message.
//
// This member is required.
Message *string
// The name of the validation error.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|