Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified	Actions
📁 ..	-	2025-05-25 12:27
📄 api-2.json { "version":"2.0", "metadata":{ "apiVersion":"2017-07-25", "endpointPrefix":"auditmanager", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AWS Audit Manager", "serviceId":"AuditManager", "signatureVersion":"v4", "signingName":"auditmanager", "uid":"auditmanager-2017-07-25" }, "operations":{ "AssociateAssessmentReportEvidenceFolder":{ "name":"AssociateAssessmentReportEvidenceFolder", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/associateToAssessmentReport" }, "input":{"shape":"AssociateAssessmentReportEvidenceFolderRequest"}, "output":{"shape":"AssociateAssessmentReportEvidenceFolderResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "BatchAssociateAssessmentReportEvidence":{ "name":"BatchAssociateAssessmentReportEvidence", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/batchAssociateToAssessmentReport" }, "input":{"shape":"BatchAssociateAssessmentReportEvidenceRequest"}, "output":{"shape":"BatchAssociateAssessmentReportEvidenceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "BatchCreateDelegationByAssessment":{ "name":"BatchCreateDelegationByAssessment", "http":{ "method":"POST", "requestUri":"/assessments/{assessmentId}/delegations" }, "input":{"shape":"BatchCreateDelegationByAssessmentRequest"}, "output":{"shape":"BatchCreateDelegationByAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "BatchDeleteDelegationByAssessment":{ "name":"BatchDeleteDelegationByAssessment", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/delegations" }, "input":{"shape":"BatchDeleteDelegationByAssessmentRequest"}, "output":{"shape":"BatchDeleteDelegationByAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "BatchDisassociateAssessmentReportEvidence":{ "name":"BatchDisassociateAssessmentReportEvidence", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/batchDisassociateFromAssessmentReport" }, "input":{"shape":"BatchDisassociateAssessmentReportEvidenceRequest"}, "output":{"shape":"BatchDisassociateAssessmentReportEvidenceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "BatchImportEvidenceToAssessmentControl":{ "name":"BatchImportEvidenceToAssessmentControl", "http":{ "method":"POST", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence" }, "input":{"shape":"BatchImportEvidenceToAssessmentControlRequest"}, "output":{"shape":"BatchImportEvidenceToAssessmentControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ] }, "CreateAssessment":{ "name":"CreateAssessment", "http":{ "method":"POST", "requestUri":"/assessments" }, "input":{"shape":"CreateAssessmentRequest"}, "output":{"shape":"CreateAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ] }, "CreateAssessmentFramework":{ "name":"CreateAssessmentFramework", "http":{ "method":"POST", "requestUri":"/assessmentFrameworks" }, "input":{"shape":"CreateAssessmentFrameworkRequest"}, "output":{"shape":"CreateAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ] }, "CreateAssessmentReport":{ "name":"CreateAssessmentReport", "http":{ "method":"POST", "requestUri":"/assessments/{assessmentId}/reports" }, "input":{"shape":"CreateAssessmentReportRequest"}, "output":{"shape":"CreateAssessmentReportResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "CreateControl":{ "name":"CreateControl", "http":{ "method":"POST", "requestUri":"/controls" }, "input":{"shape":"CreateControlRequest"}, "output":{"shape":"CreateControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ] }, "DeleteAssessment":{ "name":"DeleteAssessment", "http":{ "method":"DELETE", "requestUri":"/assessments/{assessmentId}" }, "input":{"shape":"DeleteAssessmentRequest"}, "output":{"shape":"DeleteAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "DeleteAssessmentFramework":{ "name":"DeleteAssessmentFramework", "http":{ "method":"DELETE", "requestUri":"/assessmentFrameworks/{frameworkId}" }, "input":{"shape":"DeleteAssessmentFrameworkRequest"}, "output":{"shape":"DeleteAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "DeleteAssessmentFrameworkShare":{ "name":"DeleteAssessmentFrameworkShare", "http":{ "method":"DELETE", "requestUri":"/assessmentFrameworkShareRequests/{requestId}" }, "input":{"shape":"DeleteAssessmentFrameworkShareRequest"}, "output":{"shape":"DeleteAssessmentFrameworkShareResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "DeleteAssessmentReport":{ "name":"DeleteAssessmentReport", "http":{ "method":"DELETE", "requestUri":"/assessments/{assessmentId}/reports/{assessmentReportId}" }, "input":{"shape":"DeleteAssessmentReportRequest"}, "output":{"shape":"DeleteAssessmentReportResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "DeleteControl":{ "name":"DeleteControl", "http":{ "method":"DELETE", "requestUri":"/controls/{controlId}" }, "input":{"shape":"DeleteControlRequest"}, "output":{"shape":"DeleteControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "DeregisterAccount":{ "name":"DeregisterAccount", "http":{ "method":"POST", "requestUri":"/account/deregisterAccount" }, "input":{"shape":"DeregisterAccountRequest"}, "output":{"shape":"DeregisterAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "DeregisterOrganizationAdminAccount":{ "name":"DeregisterOrganizationAdminAccount", "http":{ "method":"POST", "requestUri":"/account/deregisterOrganizationAdminAccount" }, "input":{"shape":"DeregisterOrganizationAdminAccountRequest"}, "output":{"shape":"DeregisterOrganizationAdminAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "DisassociateAssessmentReportEvidenceFolder":{ "name":"DisassociateAssessmentReportEvidenceFolder", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/disassociateFromAssessmentReport" }, "input":{"shape":"DisassociateAssessmentReportEvidenceFolderRequest"}, "output":{"shape":"DisassociateAssessmentReportEvidenceFolderResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "GetAccountStatus":{ "name":"GetAccountStatus", "http":{ "method":"GET", "requestUri":"/account/status" }, "input":{"shape":"GetAccountStatusRequest"}, "output":{"shape":"GetAccountStatusResponse"}, "errors":[ {"shape":"InternalServerException"} ] }, "GetAssessment":{ "name":"GetAssessment", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}" }, "input":{"shape":"GetAssessmentRequest"}, "output":{"shape":"GetAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetAssessmentFramework":{ "name":"GetAssessmentFramework", "http":{ "method":"GET", "requestUri":"/assessmentFrameworks/{frameworkId}" }, "input":{"shape":"GetAssessmentFrameworkRequest"}, "output":{"shape":"GetAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetAssessmentReportUrl":{ "name":"GetAssessmentReportUrl", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/reports/{assessmentReportId}/url" }, "input":{"shape":"GetAssessmentReportUrlRequest"}, "output":{"shape":"GetAssessmentReportUrlResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "GetChangeLogs":{ "name":"GetChangeLogs", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/changelogs" }, "input":{"shape":"GetChangeLogsRequest"}, "output":{"shape":"GetChangeLogsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "GetControl":{ "name":"GetControl", "http":{ "method":"GET", "requestUri":"/controls/{controlId}" }, "input":{"shape":"GetControlRequest"}, "output":{"shape":"GetControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetDelegations":{ "name":"GetDelegations", "http":{ "method":"GET", "requestUri":"/delegations" }, "input":{"shape":"GetDelegationsRequest"}, "output":{"shape":"GetDelegationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetEvidence":{ "name":"GetEvidence", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}" }, "input":{"shape":"GetEvidenceRequest"}, "output":{"shape":"GetEvidenceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetEvidenceByEvidenceFolder":{ "name":"GetEvidenceByEvidenceFolder", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence" }, "input":{"shape":"GetEvidenceByEvidenceFolderRequest"}, "output":{"shape":"GetEvidenceByEvidenceFolderResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetEvidenceFileUploadUrl":{ "name":"GetEvidenceFileUploadUrl", "http":{ "method":"GET", "requestUri":"/evidenceFileUploadUrl" }, "input":{"shape":"GetEvidenceFileUploadUrlRequest"}, "output":{"shape":"GetEvidenceFileUploadUrlResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ] }, "GetEvidenceFolder":{ "name":"GetEvidenceFolder", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}" }, "input":{"shape":"GetEvidenceFolderRequest"}, "output":{"shape":"GetEvidenceFolderResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetEvidenceFoldersByAssessment":{ "name":"GetEvidenceFoldersByAssessment", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/evidenceFolders" }, "input":{"shape":"GetEvidenceFoldersByAssessmentRequest"}, "output":{"shape":"GetEvidenceFoldersByAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "GetEvidenceFoldersByAssessmentControl":{ "name":"GetEvidenceFoldersByAssessmentControl", "http":{ "method":"GET", "requestUri":"/assessments/{assessmentId}/evidenceFolders-by-assessment-control/{controlSetId}/{controlId}" }, "input":{"shape":"GetEvidenceFoldersByAssessmentControlRequest"}, "output":{"shape":"GetEvidenceFoldersByAssessmentControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetInsights":{ "name":"GetInsights", "http":{ "method":"GET", "requestUri":"/insights" }, "input":{"shape":"GetInsightsRequest"}, "output":{"shape":"GetInsightsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetInsightsByAssessment":{ "name":"GetInsightsByAssessment", "http":{ "method":"GET", "requestUri":"/insights/assessments/{assessmentId}" }, "input":{"shape":"GetInsightsByAssessmentRequest"}, "output":{"shape":"GetInsightsByAssessmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "GetOrganizationAdminAccount":{ "name":"GetOrganizationAdminAccount", "http":{ "method":"GET", "requestUri":"/account/organizationAdminAccount" }, "input":{"shape":"GetOrganizationAdminAccountRequest"}, "output":{"shape":"GetOrganizationAdminAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "GetServicesInScope":{ "name":"GetServicesInScope", "http":{ "method":"GET", "requestUri":"/services" }, "input":{"shape":"GetServicesInScopeRequest"}, "output":{"shape":"GetServicesInScopeResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "GetSettings":{ "name":"GetSettings", "http":{ "method":"GET", "requestUri":"/settings/{attribute}" }, "input":{"shape":"GetSettingsRequest"}, "output":{"shape":"GetSettingsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "ListAssessmentControlInsightsByControlDomain":{ "name":"ListAssessmentControlInsightsByControlDomain", "http":{ "method":"GET", "requestUri":"/insights/controls-by-assessment" }, "input":{"shape":"ListAssessmentControlInsightsByControlDomainRequest"}, "output":{"shape":"ListAssessmentControlInsightsByControlDomainResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "ListAssessmentFrameworkShareRequests":{ "name":"ListAssessmentFrameworkShareRequests", "http":{ "method":"GET", "requestUri":"/assessmentFrameworkShareRequests" }, "input":{"shape":"ListAssessmentFrameworkShareRequestsRequest"}, "output":{"shape":"ListAssessmentFrameworkShareRequestsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "ListAssessmentFrameworks":{ "name":"ListAssessmentFrameworks", "http":{ "method":"GET", "requestUri":"/assessmentFrameworks" }, "input":{"shape":"ListAssessmentFrameworksRequest"}, "output":{"shape":"ListAssessmentFrameworksResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "ListAssessmentReports":{ "name":"ListAssessmentReports", "http":{ "method":"GET", "requestUri":"/assessmentReports" }, "input":{"shape":"ListAssessmentReportsRequest"}, "output":{"shape":"ListAssessmentReportsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "ListAssessments":{ "name":"ListAssessments", "http":{ "method":"GET", "requestUri":"/assessments" }, "input":{"shape":"ListAssessmentsRequest"}, "output":{"shape":"ListAssessmentsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "ListControlDomainInsights":{ "name":"ListControlDomainInsights", "http":{ "method":"GET", "requestUri":"/insights/control-domains" }, "input":{"shape":"ListControlDomainInsightsRequest"}, "output":{"shape":"ListControlDomainInsightsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ] }, "ListControlDomainInsightsByAssessment":{ "name":"ListControlDomainInsightsByAssessment", "http":{ "method":"GET", "requestUri":"/insights/control-domains-by-assessment" }, "input":{"shape":"ListControlDomainInsightsByAssessmentRequest"}, "output":{"shape":"ListControlDomainInsightsByAssessmentResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "ListControlInsightsByControlDomain":{ "name":"ListControlInsightsByControlDomain", "http":{ "method":"GET", "requestUri":"/insights/controls" }, "input":{"shape":"ListControlInsightsByControlDomainRequest"}, "output":{"shape":"ListControlInsightsByControlDomainResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"} ] }, "ListControls":{ "name":"ListControls", "http":{ "method":"GET", "requestUri":"/controls" }, "input":{"shape":"ListControlsRequest"}, "output":{"shape":"ListControlsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "ListKeywordsForDataSource":{ "name":"ListKeywordsForDataSource", "http":{ "method":"GET", "requestUri":"/dataSourceKeywords" }, "input":{"shape":"ListKeywordsForDataSourceRequest"}, "output":{"shape":"ListKeywordsForDataSourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "ListNotifications":{ "name":"ListNotifications", "http":{ "method":"GET", "requestUri":"/notifications" }, "input":{"shape":"ListNotificationsRequest"}, "output":{"shape":"ListNotificationsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ] }, "RegisterAccount":{ "name":"RegisterAccount", "http":{ "method":"POST", "requestUri":"/account/registerAccount" }, "input":{"shape":"RegisterAccountRequest"}, "output":{"shape":"RegisterAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ] }, "RegisterOrganizationAdminAccount":{ "name":"RegisterOrganizationAdminAccount", "http":{ "method":"POST", "requestUri":"/account/registerOrganizationAdminAccount" }, "input":{"shape":"RegisterOrganizationAdminAccountRequest"}, "output":{"shape":"RegisterOrganizationAdminAccountResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "StartAssessmentFrameworkShare":{ "name":"StartAssessmentFrameworkShare", "http":{ "method":"POST", "requestUri":"/assessmentFrameworks/{frameworkId}/shareRequests" }, "input":{"shape":"StartAssessmentFrameworkShareRequest"}, "output":{"shape":"StartAssessmentFrameworkShareResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ] }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ] }, "UpdateAssessment":{ "name":"UpdateAssessment", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}" }, "input":{"shape":"UpdateAssessmentRequest"}, "output":{"shape":"UpdateAssessmentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ] }, "UpdateAssessmentControl":{ "name":"UpdateAssessmentControl", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}" }, "input":{"shape":"UpdateAssessmentControlRequest"}, "output":{"shape":"UpdateAssessmentControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "UpdateAssessmentControlSetStatus":{ "name":"UpdateAssessmentControlSetStatus", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/controlSets/{controlSetId}/status" }, "input":{"shape":"UpdateAssessmentControlSetStatusRequest"}, "output":{"shape":"UpdateAssessmentControlSetStatusResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "UpdateAssessmentFramework":{ "name":"UpdateAssessmentFramework", "http":{ "method":"PUT", "requestUri":"/assessmentFrameworks/{frameworkId}" }, "input":{"shape":"UpdateAssessmentFrameworkRequest"}, "output":{"shape":"UpdateAssessmentFrameworkResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "UpdateAssessmentFrameworkShare":{ "name":"UpdateAssessmentFrameworkShare", "http":{ "method":"PUT", "requestUri":"/assessmentFrameworkShareRequests/{requestId}" }, "input":{"shape":"UpdateAssessmentFrameworkShareRequest"}, "output":{"shape":"UpdateAssessmentFrameworkShareResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ] }, "UpdateAssessmentStatus":{ "name":"UpdateAssessmentStatus", "http":{ "method":"PUT", "requestUri":"/assessments/{assessmentId}/status" }, "input":{"shape":"UpdateAssessmentStatusRequest"}, "output":{"shape":"UpdateAssessmentStatusResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ] }, "UpdateControl":{ "name":"UpdateControl", "http":{ "method":"PUT", "requestUri":"/controls/{controlId}" }, "input":{"shape":"UpdateControlRequest"}, "output":{"shape":"UpdateControlResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "UpdateSettings":{ "name":"UpdateSettings", "http":{ "method":"PUT", "requestUri":"/settings" }, "input":{"shape":"UpdateSettingsRequest"}, "output":{"shape":"UpdateSettingsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ] }, "ValidateAssessmentReportIntegrity":{ "name":"ValidateAssessmentReportIntegrity", "http":{ "method":"POST", "requestUri":"/assessmentReports/integrity" }, "input":{"shape":"ValidateAssessmentReportIntegrityRequest"}, "output":{"shape":"ValidateAssessmentReportIntegrityResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ] } }, "shapes":{ "AWSAccount":{ "type":"structure", "members":{ "id":{"shape":"AccountId"}, "emailAddress":{"shape":"EmailAddress"}, "name":{"shape":"AccountName"} } }, "AWSAccounts":{ "type":"list", "member":{"shape":"AWSAccount"}, "max":200, "min":1, "sensitive":true }, "AWSService":{ "type":"structure", "members":{ "serviceName":{"shape":"AWSServiceName"} } }, "AWSServiceName":{ "type":"string", "max":40, "min":1, "pattern":"^[a-zA-Z0-9-\\s().]+$" }, "AWSServices":{ "type":"list", "member":{"shape":"AWSService"} }, "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":403}, "exception":true }, "AccountId":{ "type":"string", "max":12, "min":12, "pattern":"^[0-9]{12}$" }, "AccountName":{ "type":"string", "max":50, "min":1, "pattern":"^[\\u0020-\\u007E]+$" }, "AccountStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "PENDING_ACTIVATION" ] }, "ActionEnum":{ "type":"string", "enum":[ "CREATE", "UPDATE_METADATA", "ACTIVE", "INACTIVE", "DELETE", "UNDER_REVIEW", "REVIEWED", "IMPORT_EVIDENCE" ] }, "ActionPlanInstructions":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "ActionPlanTitle":{ "type":"string", "max":300, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "Assessment":{ "type":"structure", "members":{ "arn":{"shape":"AuditManagerArn"}, "awsAccount":{"shape":"AWSAccount"}, "metadata":{"shape":"AssessmentMetadata"}, "framework":{"shape":"AssessmentFramework"}, "tags":{"shape":"TagMap"} } }, "AssessmentControl":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "name":{"shape":"ControlName"}, "description":{"shape":"ControlDescription"}, "status":{"shape":"ControlStatus"}, "response":{"shape":"ControlResponse"}, "comments":{"shape":"ControlComments"}, "evidenceSources":{"shape":"EvidenceSources"}, "evidenceCount":{"shape":"Integer"}, "assessmentReportEvidenceCount":{"shape":"Integer"} } }, "AssessmentControlSet":{ "type":"structure", "members":{ "id":{"shape":"ControlSetId"}, "description":{"shape":"NonEmptyString"}, "status":{"shape":"ControlSetStatus"}, "roles":{"shape":"Roles"}, "controls":{"shape":"AssessmentControls"}, "delegations":{"shape":"Delegations"}, "systemEvidenceCount":{"shape":"Integer"}, "manualEvidenceCount":{"shape":"Integer"} } }, "AssessmentControlSets":{ "type":"list", "member":{"shape":"AssessmentControlSet"} }, "AssessmentControls":{ "type":"list", "member":{"shape":"AssessmentControl"} }, "AssessmentDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "AssessmentEvidenceFolder":{ "type":"structure", "members":{ "name":{"shape":"AssessmentEvidenceFolderName"}, "date":{"shape":"Timestamp"}, "assessmentId":{"shape":"UUID"}, "controlSetId":{"shape":"ControlSetId"}, "controlId":{"shape":"UUID"}, "id":{"shape":"UUID"}, "dataSource":{"shape":"String"}, "author":{"shape":"String"}, "totalEvidence":{"shape":"Integer"}, "assessmentReportSelectionCount":{"shape":"Integer"}, "controlName":{"shape":"ControlName"}, "evidenceResourcesIncludedCount":{"shape":"Integer"}, "evidenceByTypeConfigurationDataCount":{"shape":"Integer"}, "evidenceByTypeManualCount":{"shape":"Integer"}, "evidenceByTypeComplianceCheckCount":{"shape":"Integer"}, "evidenceByTypeComplianceCheckIssuesCount":{"shape":"Integer"}, "evidenceByTypeUserActivityCount":{"shape":"Integer"}, "evidenceAwsServiceSourceCount":{"shape":"Integer"} } }, "AssessmentEvidenceFolderName":{ "type":"string", "max":300, "min":1, "pattern":"^[\\w\\W\\s\\S]$" }, "AssessmentEvidenceFolders":{ "type":"list", "member":{"shape":"AssessmentEvidenceFolder"} }, "AssessmentFramework":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "arn":{"shape":"AuditManagerArn"}, "metadata":{"shape":"FrameworkMetadata"}, "controlSets":{"shape":"AssessmentControlSets"} }, "sensitive":true }, "AssessmentFrameworkDescription":{ "type":"string", "max":200, "min":1, "pattern":"^[\\w\\W\\s\\S]$" }, "AssessmentFrameworkMetadata":{ "type":"structure", "members":{ "arn":{"shape":"AuditManagerArn"}, "id":{"shape":"UUID"}, "type":{"shape":"FrameworkType"}, "name":{"shape":"FrameworkName"}, "description":{"shape":"FrameworkDescription"}, "logo":{"shape":"Filename"}, "complianceType":{"shape":"ComplianceType"}, "controlsCount":{"shape":"ControlsCount"}, "controlSetsCount":{"shape":"ControlSetsCount"}, "createdAt":{"shape":"Timestamp"}, "lastUpdatedAt":{"shape":"Timestamp"} } }, "AssessmentFrameworkShareRequest":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "frameworkId":{"shape":"UUID"}, "frameworkName":{"shape":"FrameworkName"}, "frameworkDescription":{"shape":"FrameworkDescription"}, "status":{"shape":"ShareRequestStatus"}, "sourceAccount":{"shape":"AccountId"}, "destinationAccount":{"shape":"AccountId"}, "destinationRegion":{"shape":"Region"}, "expirationTime":{"shape":"Timestamp"}, "creationTime":{"shape":"Timestamp"}, "lastUpdated":{"shape":"Timestamp"}, "comment":{"shape":"ShareRequestComment"}, "standardControlsCount":{"shape":"NullableInteger"}, "customControlsCount":{"shape":"NullableInteger"}, "complianceType":{"shape":"ComplianceType"} } }, "AssessmentFrameworkShareRequestList":{ "type":"list", "member":{"shape":"AssessmentFrameworkShareRequest"} }, "AssessmentMetadata":{ "type":"structure", "members":{ "name":{"shape":"AssessmentName"}, "id":{"shape":"UUID"}, "description":{"shape":"AssessmentDescription"}, "complianceType":{"shape":"ComplianceType"}, "status":{"shape":"AssessmentStatus"}, "assessmentReportsDestination":{"shape":"AssessmentReportsDestination"}, "scope":{"shape":"Scope"}, "roles":{"shape":"Roles"}, "delegations":{"shape":"Delegations"}, "creationTime":{"shape":"Timestamp"}, "lastUpdated":{"shape":"Timestamp"} } }, "AssessmentMetadataItem":{ "type":"structure", "members":{ "name":{"shape":"AssessmentName"}, "id":{"shape":"UUID"}, "complianceType":{"shape":"ComplianceType"}, "status":{"shape":"AssessmentStatus"}, "roles":{"shape":"Roles"}, "delegations":{"shape":"Delegations"}, "creationTime":{"shape":"Timestamp"}, "lastUpdated":{"shape":"Timestamp"} } }, "AssessmentName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\]$", "sensitive":true }, "AssessmentReport":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "name":{"shape":"AssessmentReportName"}, "description":{"shape":"AssessmentReportDescription"}, "awsAccountId":{"shape":"AccountId"}, "assessmentId":{"shape":"UUID"}, "assessmentName":{"shape":"AssessmentName"}, "author":{"shape":"Username"}, "status":{"shape":"AssessmentReportStatus"}, "creationTime":{"shape":"Timestamp"} } }, "AssessmentReportDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "AssessmentReportDestinationType":{ "type":"string", "enum":["S3"] }, "AssessmentReportEvidenceError":{ "type":"structure", "members":{ "evidenceId":{"shape":"UUID"}, "errorCode":{"shape":"ErrorCode"}, "errorMessage":{"shape":"ErrorMessage"} } }, "AssessmentReportEvidenceErrors":{ "type":"list", "member":{"shape":"AssessmentReportEvidenceError"} }, "AssessmentReportMetadata":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "name":{"shape":"AssessmentReportName"}, "description":{"shape":"AssessmentReportDescription"}, "assessmentId":{"shape":"UUID"}, "assessmentName":{"shape":"AssessmentName"}, "author":{"shape":"Username"}, "status":{"shape":"AssessmentReportStatus"}, "creationTime":{"shape":"Timestamp"} } }, "AssessmentReportName":{ "type":"string", "max":300, "min":1, "pattern":"^[a-zA-Z0-9-_\\.]+$" }, "AssessmentReportStatus":{ "type":"string", "enum":[ "COMPLETE", "IN_PROGRESS", "FAILED" ] }, "AssessmentReportsDestination":{ "type":"structure", "members":{ "destinationType":{"shape":"AssessmentReportDestinationType"}, "destination":{"shape":"S3Url"} }, "sensitive":true }, "AssessmentReportsMetadata":{ "type":"list", "member":{"shape":"AssessmentReportMetadata"} }, "AssessmentStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "AssociateAssessmentReportEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{"shape":"UUID"} } }, "AssociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", "members":{ } }, "AuditManagerArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:.:auditmanager:." }, "BatchAssociateAssessmentReportEvidenceRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId", "evidenceIds" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{"shape":"UUID"}, "evidenceIds":{"shape":"EvidenceIds"} } }, "BatchAssociateAssessmentReportEvidenceResponse":{ "type":"structure", "members":{ "evidenceIds":{"shape":"EvidenceIds"}, "errors":{"shape":"AssessmentReportEvidenceErrors"} } }, "BatchCreateDelegationByAssessmentError":{ "type":"structure", "members":{ "createDelegationRequest":{"shape":"CreateDelegationRequest"}, "errorCode":{"shape":"ErrorCode"}, "errorMessage":{"shape":"ErrorMessage"} } }, "BatchCreateDelegationByAssessmentErrors":{ "type":"list", "member":{"shape":"BatchCreateDelegationByAssessmentError"}, "sensitive":true }, "BatchCreateDelegationByAssessmentRequest":{ "type":"structure", "required":[ "createDelegationRequests", "assessmentId" ], "members":{ "createDelegationRequests":{"shape":"CreateDelegationRequests"}, "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" } } }, "BatchCreateDelegationByAssessmentResponse":{ "type":"structure", "members":{ "delegations":{"shape":"Delegations"}, "errors":{"shape":"BatchCreateDelegationByAssessmentErrors"} } }, "BatchDeleteDelegationByAssessmentError":{ "type":"structure", "members":{ "delegationId":{"shape":"UUID"}, "errorCode":{"shape":"ErrorCode"}, "errorMessage":{"shape":"ErrorMessage"} } }, "BatchDeleteDelegationByAssessmentErrors":{ "type":"list", "member":{"shape":"BatchDeleteDelegationByAssessmentError"}, "sensitive":true }, "BatchDeleteDelegationByAssessmentRequest":{ "type":"structure", "required":[ "delegationIds", "assessmentId" ], "members":{ "delegationIds":{"shape":"DelegationIds"}, "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" } } }, "BatchDeleteDelegationByAssessmentResponse":{ "type":"structure", "members":{ "errors":{"shape":"BatchDeleteDelegationByAssessmentErrors"} } }, "BatchDisassociateAssessmentReportEvidenceRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId", "evidenceIds" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{"shape":"UUID"}, "evidenceIds":{"shape":"EvidenceIds"} } }, "BatchDisassociateAssessmentReportEvidenceResponse":{ "type":"structure", "members":{ "evidenceIds":{"shape":"EvidenceIds"}, "errors":{"shape":"AssessmentReportEvidenceErrors"} } }, "BatchImportEvidenceToAssessmentControlError":{ "type":"structure", "members":{ "manualEvidence":{"shape":"ManualEvidence"}, "errorCode":{"shape":"ErrorCode"}, "errorMessage":{"shape":"ErrorMessage"} } }, "BatchImportEvidenceToAssessmentControlErrors":{ "type":"list", "member":{"shape":"BatchImportEvidenceToAssessmentControlError"} }, "BatchImportEvidenceToAssessmentControlRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "controlId", "manualEvidence" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "location":"uri", "locationName":"controlId" }, "manualEvidence":{"shape":"ManualEvidenceList"} } }, "BatchImportEvidenceToAssessmentControlResponse":{ "type":"structure", "members":{ "errors":{"shape":"BatchImportEvidenceToAssessmentControlErrors"} } }, "Boolean":{"type":"boolean"}, "ChangeLog":{ "type":"structure", "members":{ "objectType":{"shape":"ObjectTypeEnum"}, "objectName":{"shape":"NonEmptyString"}, "action":{"shape":"ActionEnum"}, "createdAt":{"shape":"Timestamp"}, "createdBy":{"shape":"IamArn"} } }, "ChangeLogs":{ "type":"list", "member":{"shape":"ChangeLog"} }, "CloudTrailArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:.:cloudtrail:." }, "ComplianceType":{ "type":"string", "max":100, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "Control":{ "type":"structure", "members":{ "arn":{"shape":"AuditManagerArn"}, "id":{"shape":"UUID"}, "type":{"shape":"ControlType"}, "name":{"shape":"ControlName"}, "description":{"shape":"ControlDescription"}, "testingInformation":{"shape":"TestingInformation"}, "actionPlanTitle":{"shape":"ActionPlanTitle"}, "actionPlanInstructions":{"shape":"ActionPlanInstructions"}, "controlSources":{"shape":"ControlSources"}, "controlMappingSources":{"shape":"ControlMappingSources"}, "createdAt":{"shape":"Timestamp"}, "lastUpdatedAt":{"shape":"Timestamp"}, "createdBy":{"shape":"CreatedBy"}, "lastUpdatedBy":{"shape":"LastUpdatedBy"}, "tags":{"shape":"TagMap"}, "state":{"shape":"ControlState"} } }, "ControlCatalogId":{ "type":"string", "max":2048, "min":13, "pattern":"^arn:.:controlcatalog:.\|UNCATEGORIZED" }, "ControlComment":{ "type":"structure", "members":{ "authorName":{"shape":"Username"}, "commentBody":{"shape":"ControlCommentBody"}, "postedDate":{"shape":"Timestamp"} } }, "ControlCommentBody":{ "type":"string", "max":500, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "ControlComments":{ "type":"list", "member":{"shape":"ControlComment"} }, "ControlDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "ControlDomainId":{ "type":"string", "max":2048, "min":13, "pattern":"^arn:.:controlcatalog:.:.:domain/.\|UNCATEGORIZED\|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "ControlDomainInsights":{ "type":"structure", "members":{ "name":{"shape":"String"}, "id":{"shape":"ControlDomainId"}, "controlsCountByNoncompliantEvidence":{"shape":"NullableInteger"}, "totalControlsCount":{"shape":"NullableInteger"}, "evidenceInsights":{"shape":"EvidenceInsights"}, "lastUpdated":{"shape":"Timestamp"} } }, "ControlDomainInsightsList":{ "type":"list", "member":{"shape":"ControlDomainInsights"} }, "ControlInsightsMetadata":{ "type":"list", "member":{"shape":"ControlInsightsMetadataItem"} }, "ControlInsightsMetadataByAssessment":{ "type":"list", "member":{"shape":"ControlInsightsMetadataByAssessmentItem"} }, "ControlInsightsMetadataByAssessmentItem":{ "type":"structure", "members":{ "name":{"shape":"String"}, "id":{"shape":"ControlDomainId"}, "evidenceInsights":{"shape":"EvidenceInsights"}, "controlSetName":{"shape":"NonEmptyString"}, "lastUpdated":{"shape":"Timestamp"} } }, "ControlInsightsMetadataItem":{ "type":"structure", "members":{ "name":{"shape":"String"}, "id":{"shape":"ControlDomainId"}, "evidenceInsights":{"shape":"EvidenceInsights"}, "lastUpdated":{"shape":"Timestamp"} } }, "ControlMappingSource":{ "type":"structure", "members":{ "sourceId":{"shape":"UUID"}, "sourceName":{"shape":"SourceName"}, "sourceDescription":{"shape":"SourceDescription"}, "sourceSetUpOption":{"shape":"SourceSetUpOption"}, "sourceType":{"shape":"SourceType"}, "sourceKeyword":{"shape":"SourceKeyword"}, "sourceFrequency":{"shape":"SourceFrequency"}, "troubleshootingText":{"shape":"TroubleshootingText"} } }, "ControlMappingSources":{ "type":"list", "member":{"shape":"ControlMappingSource"}, "min":1 }, "ControlMetadata":{ "type":"structure", "members":{ "arn":{"shape":"AuditManagerArn"}, "id":{"shape":"UUID"}, "name":{"shape":"ControlName"}, "controlSources":{"shape":"ControlSources"}, "createdAt":{"shape":"Timestamp"}, "lastUpdatedAt":{"shape":"Timestamp"} } }, "ControlMetadataList":{ "type":"list", "member":{"shape":"ControlMetadata"} }, "ControlName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\]$" }, "ControlResponse":{ "type":"string", "enum":[ "MANUAL", "AUTOMATE", "DEFER", "IGNORE" ] }, "ControlSet":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "name":{"shape":"ControlSetName"}, "controls":{"shape":"Controls"} } }, "ControlSetId":{ "type":"string", "max":300, "min":1, "pattern":"^[\\w\\W\\s\\S]$" }, "ControlSetName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\\\_]$" }, "ControlSetStatus":{ "type":"string", "enum":[ "ACTIVE", "UNDER_REVIEW", "REVIEWED" ] }, "ControlSets":{ "type":"list", "member":{"shape":"ControlSet"}, "min":1, "sensitive":true }, "ControlSetsCount":{"type":"integer"}, "ControlSources":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z_0-9-\\s.,]+$" }, "ControlState":{ "type":"string", "enum":[ "ACTIVE", "END_OF_SUPPORT" ] }, "ControlStatus":{ "type":"string", "enum":[ "UNDER_REVIEW", "REVIEWED", "INACTIVE" ] }, "ControlType":{ "type":"string", "enum":[ "Standard", "Custom", "Core" ] }, "Controls":{ "type":"list", "member":{"shape":"Control"}, "min":1 }, "ControlsCount":{"type":"integer"}, "CreateAssessmentFrameworkControl":{ "type":"structure", "required":["id"], "members":{ "id":{"shape":"UUID"} } }, "CreateAssessmentFrameworkControlSet":{ "type":"structure", "required":["name"], "members":{ "name":{"shape":"ControlSetName"}, "controls":{"shape":"CreateAssessmentFrameworkControls"} } }, "CreateAssessmentFrameworkControlSets":{ "type":"list", "member":{"shape":"CreateAssessmentFrameworkControlSet"}, "min":1 }, "CreateAssessmentFrameworkControls":{ "type":"list", "member":{"shape":"CreateAssessmentFrameworkControl"}, "min":1 }, "CreateAssessmentFrameworkRequest":{ "type":"structure", "required":[ "name", "controlSets" ], "members":{ "name":{"shape":"FrameworkName"}, "description":{"shape":"FrameworkDescription"}, "complianceType":{"shape":"ComplianceType"}, "controlSets":{"shape":"CreateAssessmentFrameworkControlSets"}, "tags":{"shape":"TagMap"} } }, "CreateAssessmentFrameworkResponse":{ "type":"structure", "members":{ "framework":{"shape":"Framework"} } }, "CreateAssessmentReportRequest":{ "type":"structure", "required":[ "name", "assessmentId" ], "members":{ "name":{"shape":"AssessmentReportName"}, "description":{"shape":"AssessmentReportDescription"}, "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "queryStatement":{"shape":"QueryStatement"} } }, "CreateAssessmentReportResponse":{ "type":"structure", "members":{ "assessmentReport":{"shape":"AssessmentReport"} } }, "CreateAssessmentRequest":{ "type":"structure", "required":[ "name", "assessmentReportsDestination", "scope", "roles", "frameworkId" ], "members":{ "name":{"shape":"AssessmentName"}, "description":{"shape":"AssessmentDescription"}, "assessmentReportsDestination":{"shape":"AssessmentReportsDestination"}, "scope":{"shape":"Scope"}, "roles":{"shape":"Roles"}, "frameworkId":{"shape":"UUID"}, "tags":{"shape":"TagMap"} } }, "CreateAssessmentResponse":{ "type":"structure", "members":{ "assessment":{"shape":"Assessment"} } }, "CreateControlMappingSource":{ "type":"structure", "members":{ "sourceName":{"shape":"SourceName"}, "sourceDescription":{"shape":"SourceDescription"}, "sourceSetUpOption":{"shape":"SourceSetUpOption"}, "sourceType":{"shape":"SourceType"}, "sourceKeyword":{"shape":"SourceKeyword"}, "sourceFrequency":{"shape":"SourceFrequency"}, "troubleshootingText":{"shape":"TroubleshootingText"} } }, "CreateControlMappingSources":{ "type":"list", "member":{"shape":"CreateControlMappingSource"}, "min":1 }, "CreateControlRequest":{ "type":"structure", "required":[ "name", "controlMappingSources" ], "members":{ "name":{"shape":"ControlName"}, "description":{"shape":"ControlDescription"}, "testingInformation":{"shape":"TestingInformation"}, "actionPlanTitle":{"shape":"ActionPlanTitle"}, "actionPlanInstructions":{"shape":"ActionPlanInstructions"}, "controlMappingSources":{"shape":"CreateControlMappingSources"}, "tags":{"shape":"TagMap"} } }, "CreateControlResponse":{ "type":"structure", "members":{ "control":{"shape":"Control"} } }, "CreateDelegationRequest":{ "type":"structure", "members":{ "comment":{"shape":"DelegationComment"}, "controlSetId":{"shape":"ControlSetId"}, "roleArn":{"shape":"IamArn"}, "roleType":{"shape":"RoleType"} } }, "CreateDelegationRequests":{ "type":"list", "member":{"shape":"CreateDelegationRequest"}, "max":50, "min":1, "sensitive":true }, "CreatedBy":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9\\s-_()\\[\\]]+$", "sensitive":true }, "DataSourceType":{ "type":"string", "enum":[ "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL" ] }, "DefaultExportDestination":{ "type":"structure", "members":{ "destinationType":{"shape":"ExportDestinationType"}, "destination":{"shape":"S3Url"} } }, "Delegation":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "assessmentName":{"shape":"AssessmentName"}, "assessmentId":{"shape":"UUID"}, "status":{"shape":"DelegationStatus"}, "roleArn":{"shape":"IamArn"}, "roleType":{"shape":"RoleType"}, "creationTime":{"shape":"Timestamp"}, "lastUpdated":{"shape":"Timestamp"}, "controlSetId":{"shape":"ControlSetId"}, "comment":{"shape":"DelegationComment"}, "createdBy":{"shape":"CreatedBy"} }, "sensitive":true }, "DelegationComment":{ "type":"string", "max":350, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "DelegationIds":{ "type":"list", "member":{"shape":"UUID"}, "max":50, "min":1 }, "DelegationMetadata":{ "type":"structure", "members":{ "id":{"shape":"UUID"}, "assessmentName":{"shape":"AssessmentName"}, "assessmentId":{"shape":"UUID"}, "status":{"shape":"DelegationStatus"}, "roleArn":{"shape":"IamArn"}, "creationTime":{"shape":"Timestamp"}, "controlSetName":{"shape":"NonEmptyString"} } }, "DelegationMetadataList":{ "type":"list", "member":{"shape":"DelegationMetadata"} }, "DelegationStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "UNDER_REVIEW", "COMPLETE" ] }, "Delegations":{ "type":"list", "member":{"shape":"Delegation"} }, "DeleteAssessmentFrameworkRequest":{ "type":"structure", "required":["frameworkId"], "members":{ "frameworkId":{ "shape":"UUID", "location":"uri", "locationName":"frameworkId" } } }, "DeleteAssessmentFrameworkResponse":{ "type":"structure", "members":{ } }, "DeleteAssessmentFrameworkShareRequest":{ "type":"structure", "required":[ "requestId", "requestType" ], "members":{ "requestId":{ "shape":"UUID", "location":"uri", "locationName":"requestId" }, "requestType":{ "shape":"ShareRequestType", "location":"querystring", "locationName":"requestType" } } }, "DeleteAssessmentFrameworkShareResponse":{ "type":"structure", "members":{ } }, "DeleteAssessmentReportRequest":{ "type":"structure", "required":[ "assessmentId", "assessmentReportId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "assessmentReportId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentReportId" } } }, "DeleteAssessmentReportResponse":{ "type":"structure", "members":{ } }, "DeleteAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" } } }, "DeleteAssessmentResponse":{ "type":"structure", "members":{ } }, "DeleteControlRequest":{ "type":"structure", "required":["controlId"], "members":{ "controlId":{ "shape":"UUID", "location":"uri", "locationName":"controlId" } } }, "DeleteControlResponse":{ "type":"structure", "members":{ } }, "DeleteResources":{ "type":"string", "enum":[ "ALL", "DEFAULT" ] }, "DeregisterAccountRequest":{ "type":"structure", "members":{ } }, "DeregisterAccountResponse":{ "type":"structure", "members":{ "status":{"shape":"AccountStatus"} } }, "DeregisterOrganizationAdminAccountRequest":{ "type":"structure", "members":{ "adminAccountId":{"shape":"AccountId"} } }, "DeregisterOrganizationAdminAccountResponse":{ "type":"structure", "members":{ } }, "DeregistrationPolicy":{ "type":"structure", "members":{ "deleteResources":{"shape":"DeleteResources"} } }, "DisassociateAssessmentReportEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "evidenceFolderId":{"shape":"UUID"} } }, "DisassociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", "members":{ } }, "EmailAddress":{ "type":"string", "max":320, "min":1, "pattern":"^.@.$", "sensitive":true }, "ErrorCode":{ "type":"string", "max":3, "min":3, "pattern":"[0-9]{3}" }, "ErrorMessage":{ "type":"string", "max":300, "pattern":"^[\\w\\W\\s\\S]$" }, "EventName":{ "type":"string", "max":100, "pattern":"^[\\w\\W\\s\\S]$" }, "Evidence":{ "type":"structure", "members":{ "dataSource":{"shape":"String"}, "evidenceAwsAccountId":{"shape":"AccountId"}, "time":{"shape":"Timestamp"}, "eventSource":{"shape":"AWSServiceName"}, "eventName":{"shape":"EventName"}, "evidenceByType":{"shape":"String"}, "resourcesIncluded":{"shape":"Resources"}, "attributes":{"shape":"EvidenceAttributes"}, "iamId":{"shape":"IamArn"}, "complianceCheck":{"shape":"String"}, "awsOrganization":{"shape":"String"}, "awsAccountId":{"shape":"AccountId"}, "evidenceFolderId":{"shape":"UUID"}, "id":{"shape":"UUID"}, "assessmentReportSelection":{"shape":"String"} } }, "EvidenceAttributeKey":{ "type":"string", "max":100, "pattern":"^[\\w\\W\\s\\S]$" }, "EvidenceAttributeValue":{ "type":"string", "max":200, "pattern":"^[\\w\\W\\s\\S]$" }, "EvidenceAttributes":{ "type":"map", "key":{"shape":"EvidenceAttributeKey"}, "value":{"shape":"EvidenceAttributeValue"} }, "EvidenceFinderBackfillStatus":{ "type":"string", "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "EvidenceFinderEnablement":{ "type":"structure", "members":{ "eventDataStoreArn":{"shape":"CloudTrailArn"}, "enablementStatus":{"shape":"EvidenceFinderEnablementStatus"}, "backfillStatus":{"shape":"EvidenceFinderBackfillStatus"}, "error":{"shape":"ErrorMessage"} } }, "EvidenceFinderEnablementStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS" ] }, "EvidenceIds":{ "type":"list", "member":{"shape":"UUID"}, "max":50, "min":0 }, "EvidenceInsights":{ "type":"structure", "members":{ "noncompliantEvidenceCount":{"shape":"NullableInteger"}, "compliantEvidenceCount":{"shape":"NullableInteger"}, "inconclusiveEvidenceCount":{"shape":"NullableInteger"} } }, "EvidenceList":{ "type":"list", "member":{"shape":"Evidence"} }, "EvidenceSources":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "ExportDestinationType":{ "type":"string", "enum":["S3"] }, "Filename":{ "type":"string", "max":255, "min":1, "pattern":"^[\\w,\\s-]+\\.[A-Za-z]+$" }, "Framework":{ "type":"structure", "members":{ "arn":{"shape":"AuditManagerArn"}, "id":{"shape":"UUID"}, "name":{"shape":"FrameworkName"}, "type":{"shape":"FrameworkType"}, "complianceType":{"shape":"ComplianceType"}, "description":{"shape":"FrameworkDescription"}, "logo":{"shape":"Filename"}, "controlSources":{"shape":"ControlSources"}, "controlSets":{"shape":"ControlSets"}, "createdAt":{"shape":"Timestamp"}, "lastUpdatedAt":{"shape":"Timestamp"}, "createdBy":{"shape":"CreatedBy"}, "lastUpdatedBy":{"shape":"LastUpdatedBy"}, "tags":{"shape":"TagMap"} } }, "FrameworkDescription":{ "type":"string", "max":1000, "min":1, "pattern":"^[\\w\\W\\s\\S]$" }, "FrameworkMetadata":{ "type":"structure", "members":{ "name":{"shape":"AssessmentName"}, "description":{"shape":"AssessmentFrameworkDescription"}, "logo":{"shape":"Filename"}, "complianceType":{"shape":"ComplianceType"} } }, "FrameworkMetadataList":{ "type":"list", "member":{"shape":"AssessmentFrameworkMetadata"} }, "FrameworkName":{ "type":"string", "max":300, "min":1, "pattern":"^[^\\\\]$" }, "FrameworkType":{ "type":"string", "enum":[ "Standard", "Custom" ] }, "GenericArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:." }, "GetAccountStatusRequest":{ "type":"structure", "members":{ } }, "GetAccountStatusResponse":{ "type":"structure", "members":{ "status":{"shape":"AccountStatus"} } }, "GetAssessmentFrameworkRequest":{ "type":"structure", "required":["frameworkId"], "members":{ "frameworkId":{ "shape":"UUID", "location":"uri", "locationName":"frameworkId" } } }, "GetAssessmentFrameworkResponse":{ "type":"structure", "members":{ "framework":{"shape":"Framework"} } }, "GetAssessmentReportUrlRequest":{ "type":"structure", "required":[ "assessmentReportId", "assessmentId" ], "members":{ "assessmentReportId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentReportId" }, "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" } } }, "GetAssessmentReportUrlResponse":{ "type":"structure", "members":{ "preSignedUrl":{"shape":"URL"} } }, "GetAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" } } }, "GetAssessmentResponse":{ "type":"structure", "members":{ "assessment":{"shape":"Assessment"}, "userRole":{"shape":"Role"} } }, "GetChangeLogsRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "location":"querystring", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "location":"querystring", "locationName":"controlId" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "GetChangeLogsResponse":{ "type":"structure", "members":{ "changeLogs":{"shape":"ChangeLogs"}, "nextToken":{"shape":"Token"} } }, "GetControlRequest":{ "type":"structure", "required":["controlId"], "members":{ "controlId":{ "shape":"UUID", "location":"uri", "locationName":"controlId" } } }, "GetControlResponse":{ "type":"structure", "members":{ "control":{"shape":"Control"} } }, "GetDelegationsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "GetDelegationsResponse":{ "type":"structure", "members":{ "delegations":{"shape":"DelegationMetadataList"}, "nextToken":{"shape":"Token"} } }, "GetEvidenceByEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", "location":"uri", "locationName":"evidenceFolderId" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "GetEvidenceByEvidenceFolderResponse":{ "type":"structure", "members":{ "evidence":{"shape":"EvidenceList"}, "nextToken":{"shape":"Token"} } }, "GetEvidenceFileUploadUrlRequest":{ "type":"structure", "required":["fileName"], "members":{ "fileName":{ "shape":"ManualEvidenceLocalFileName", "location":"querystring", "locationName":"fileName" } } }, "GetEvidenceFileUploadUrlResponse":{ "type":"structure", "members":{ "evidenceFileName":{"shape":"NonEmptyString"}, "uploadUrl":{"shape":"NonEmptyString"} }, "sensitive":true }, "GetEvidenceFolderRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "evidenceFolderId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", "location":"uri", "locationName":"evidenceFolderId" } } }, "GetEvidenceFolderResponse":{ "type":"structure", "members":{ "evidenceFolder":{"shape":"AssessmentEvidenceFolder"} } }, "GetEvidenceFoldersByAssessmentControlRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "controlId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "location":"uri", "locationName":"controlId" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "GetEvidenceFoldersByAssessmentControlResponse":{ "type":"structure", "members":{ "evidenceFolders":{"shape":"AssessmentEvidenceFolders"}, "nextToken":{"shape":"Token"} } }, "GetEvidenceFoldersByAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "GetEvidenceFoldersByAssessmentResponse":{ "type":"structure", "members":{ "evidenceFolders":{"shape":"AssessmentEvidenceFolders"}, "nextToken":{"shape":"Token"} } }, "GetEvidenceRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "evidenceFolderId", "evidenceId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "location":"uri", "locationName":"controlSetId" }, "evidenceFolderId":{ "shape":"UUID", "location":"uri", "locationName":"evidenceFolderId" }, "evidenceId":{ "shape":"UUID", "location":"uri", "locationName":"evidenceId" } } }, "GetEvidenceResponse":{ "type":"structure", "members":{ "evidence":{"shape":"Evidence"} } }, "GetInsightsByAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" } } }, "GetInsightsByAssessmentResponse":{ "type":"structure", "members":{ "insights":{"shape":"InsightsByAssessment"} } }, "GetInsightsRequest":{ "type":"structure", "members":{ } }, "GetInsightsResponse":{ "type":"structure", "members":{ "insights":{"shape":"Insights"} } }, "GetOrganizationAdminAccountRequest":{ "type":"structure", "members":{ } }, "GetOrganizationAdminAccountResponse":{ "type":"structure", "members":{ "adminAccountId":{"shape":"AccountId"}, "organizationId":{"shape":"organizationId"} } }, "GetServicesInScopeRequest":{ "type":"structure", "members":{ } }, "GetServicesInScopeResponse":{ "type":"structure", "members":{ "serviceMetadata":{"shape":"ServiceMetadataList"} } }, "GetSettingsRequest":{ "type":"structure", "required":["attribute"], "members":{ "attribute":{ "shape":"SettingAttribute", "location":"uri", "locationName":"attribute" } } }, "GetSettingsResponse":{ "type":"structure", "members":{ "settings":{"shape":"Settings"} } }, "HyperlinkName":{ "type":"string", "max":200, "min":1, "pattern":"^[\\w\\W\\s\\S]$" }, "IamArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:.:iam:." }, "Insights":{ "type":"structure", "members":{ "activeAssessmentsCount":{"shape":"NullableInteger"}, "noncompliantEvidenceCount":{"shape":"NullableInteger"}, "compliantEvidenceCount":{"shape":"NullableInteger"}, "inconclusiveEvidenceCount":{"shape":"NullableInteger"}, "assessmentControlsCountByNoncompliantEvidence":{"shape":"NullableInteger"}, "totalAssessmentControlsCount":{"shape":"NullableInteger"}, "lastUpdated":{"shape":"Timestamp"} } }, "InsightsByAssessment":{ "type":"structure", "members":{ "noncompliantEvidenceCount":{"shape":"NullableInteger"}, "compliantEvidenceCount":{"shape":"NullableInteger"}, "inconclusiveEvidenceCount":{"shape":"NullableInteger"}, "assessmentControlsCountByNoncompliantEvidence":{"shape":"NullableInteger"}, "totalAssessmentControlsCount":{"shape":"NullableInteger"}, "lastUpdated":{"shape":"Timestamp"} } }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "KeywordInputType":{ "type":"string", "enum":[ "SELECT_FROM_LIST", "UPLOAD_FILE", "INPUT_TEXT" ] }, "KeywordValue":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z_0-9-\\s().:\\/]+$" }, "Keywords":{ "type":"list", "member":{"shape":"KeywordValue"} }, "KmsKey":{ "type":"string", "max":2048, "min":7, "pattern":"^arn:.:kms:.\|DEFAULT" }, "LastUpdatedBy":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9\\s-_()\\[\\]]+$", "sensitive":true }, "ListAssessmentControlInsightsByControlDomainRequest":{ "type":"structure", "required":[ "controlDomainId", "assessmentId" ], "members":{ "controlDomainId":{ "shape":"ControlDomainId", "location":"querystring", "locationName":"controlDomainId" }, "assessmentId":{ "shape":"UUID", "location":"querystring", "locationName":"assessmentId" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentControlInsightsByControlDomainResponse":{ "type":"structure", "members":{ "controlInsightsByAssessment":{"shape":"ControlInsightsMetadataByAssessment"}, "nextToken":{"shape":"Token"} } }, "ListAssessmentFrameworkShareRequestsRequest":{ "type":"structure", "required":["requestType"], "members":{ "requestType":{ "shape":"ShareRequestType", "location":"querystring", "locationName":"requestType" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentFrameworkShareRequestsResponse":{ "type":"structure", "members":{ "assessmentFrameworkShareRequests":{"shape":"AssessmentFrameworkShareRequestList"}, "nextToken":{"shape":"Token"} } }, "ListAssessmentFrameworksRequest":{ "type":"structure", "required":["frameworkType"], "members":{ "frameworkType":{ "shape":"FrameworkType", "location":"querystring", "locationName":"frameworkType" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentFrameworksResponse":{ "type":"structure", "members":{ "frameworkMetadataList":{"shape":"FrameworkMetadataList"}, "nextToken":{"shape":"Token"} } }, "ListAssessmentMetadata":{ "type":"list", "member":{"shape":"AssessmentMetadataItem"} }, "ListAssessmentReportsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentReportsResponse":{ "type":"structure", "members":{ "assessmentReports":{"shape":"AssessmentReportsMetadata"}, "nextToken":{"shape":"Token"} } }, "ListAssessmentsRequest":{ "type":"structure", "members":{ "status":{ "shape":"AssessmentStatus", "location":"querystring", "locationName":"status" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListAssessmentsResponse":{ "type":"structure", "members":{ "assessmentMetadata":{"shape":"ListAssessmentMetadata"}, "nextToken":{"shape":"Token"} } }, "ListControlDomainInsightsByAssessmentRequest":{ "type":"structure", "required":["assessmentId"], "members":{ "assessmentId":{ "shape":"UUID", "location":"querystring", "locationName":"assessmentId" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListControlDomainInsightsByAssessmentResponse":{ "type":"structure", "members":{ "controlDomainInsights":{"shape":"ControlDomainInsightsList"}, "nextToken":{"shape":"Token"} } }, "ListControlDomainInsightsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListControlDomainInsightsResponse":{ "type":"structure", "members":{ "controlDomainInsights":{"shape":"ControlDomainInsightsList"}, "nextToken":{"shape":"Token"} } }, "ListControlInsightsByControlDomainRequest":{ "type":"structure", "required":["controlDomainId"], "members":{ "controlDomainId":{ "shape":"ControlDomainId", "location":"querystring", "locationName":"controlDomainId" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListControlInsightsByControlDomainResponse":{ "type":"structure", "members":{ "controlInsightsMetadata":{"shape":"ControlInsightsMetadata"}, "nextToken":{"shape":"Token"} } }, "ListControlsRequest":{ "type":"structure", "required":["controlType"], "members":{ "controlType":{ "shape":"ControlType", "location":"querystring", "locationName":"controlType" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" }, "controlCatalogId":{ "shape":"ControlCatalogId", "location":"querystring", "locationName":"controlCatalogId" } } }, "ListControlsResponse":{ "type":"structure", "members":{ "controlMetadataList":{"shape":"ControlMetadataList"}, "nextToken":{"shape":"Token"} } }, "ListKeywordsForDataSourceRequest":{ "type":"structure", "required":["source"], "members":{ "source":{ "shape":"DataSourceType", "location":"querystring", "locationName":"source" }, "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListKeywordsForDataSourceResponse":{ "type":"structure", "members":{ "keywords":{"shape":"Keywords"}, "nextToken":{"shape":"Token"} } }, "ListNotificationsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"Token", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults" } } }, "ListNotificationsResponse":{ "type":"structure", "members":{ "notifications":{"shape":"Notifications"}, "nextToken":{"shape":"Token"} } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"AuditManagerArn", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{"shape":"TagMap"} } }, "ManualEvidence":{ "type":"structure", "members":{ "s3ResourcePath":{"shape":"S3Url"}, "textResponse":{"shape":"ManualEvidenceTextResponse"}, "evidenceFileName":{"shape":"ManualEvidenceLocalFileName"} } }, "ManualEvidenceList":{ "type":"list", "member":{"shape":"ManualEvidence"}, "max":50, "min":1 }, "ManualEvidenceLocalFileName":{ "type":"string", "max":300, "min":1, "pattern":"[^\\/]", "sensitive":true }, "ManualEvidenceTextResponse":{ "type":"string", "max":1000, "min":1, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "MaxResults":{ "type":"integer", "max":1000, "min":1 }, "NonEmptyString":{ "type":"string", "max":2048, "min":1, "pattern":".\\S." }, "Notification":{ "type":"structure", "members":{ "id":{"shape":"TimestampUUID"}, "assessmentId":{"shape":"UUID"}, "assessmentName":{"shape":"AssessmentName"}, "controlSetId":{"shape":"ControlSetId"}, "controlSetName":{"shape":"NonEmptyString"}, "description":{"shape":"NonEmptyString"}, "eventTime":{"shape":"Timestamp"}, "source":{"shape":"NonEmptyString"} } }, "Notifications":{ "type":"list", "member":{"shape":"Notification"} }, "NullableInteger":{"type":"integer"}, "ObjectTypeEnum":{ "type":"string", "enum":[ "ASSESSMENT", "CONTROL_SET", "CONTROL", "DELEGATION", "ASSESSMENT_REPORT" ] }, "QueryStatement":{ "type":"string", "max":10000, "min":1, "pattern":"(?s)." }, "Region":{ "type":"string", "pattern":"^[a-z]{2}-[a-z]+-[0-9]{1}$" }, "RegisterAccountRequest":{ "type":"structure", "members":{ "kmsKey":{"shape":"KmsKey"}, "delegatedAdminAccount":{"shape":"AccountId"} } }, "RegisterAccountResponse":{ "type":"structure", "members":{ "status":{"shape":"AccountStatus"} } }, "RegisterOrganizationAdminAccountRequest":{ "type":"structure", "required":["adminAccountId"], "members":{ "adminAccountId":{"shape":"AccountId"} } }, "RegisterOrganizationAdminAccountResponse":{ "type":"structure", "members":{ "adminAccountId":{"shape":"AccountId"}, "organizationId":{"shape":"organizationId"} } }, "Resource":{ "type":"structure", "members":{ "arn":{"shape":"GenericArn"}, "value":{"shape":"String"}, "complianceCheck":{"shape":"String"} } }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{"shape":"String"}, "resourceType":{"shape":"String"} }, "error":{"httpStatusCode":404}, "exception":true }, "Resources":{ "type":"list", "member":{"shape":"Resource"} }, "Role":{ "type":"structure", "required":[ "roleType", "roleArn" ], "members":{ "roleType":{"shape":"RoleType"}, "roleArn":{"shape":"IamArn"} } }, "RoleType":{ "type":"string", "enum":[ "PROCESS_OWNER", "RESOURCE_OWNER" ] }, "Roles":{ "type":"list", "member":{"shape":"Role"}, "sensitive":true }, "S3Url":{ "type":"string", "max":1024, "min":1, "pattern":"^(S\|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\\\_\\!\\/]+$" }, "SNSTopic":{ "type":"string", "max":255, "min":1, "pattern":"^[a-zA-Z0-9-_\\(\\)\\[\\]]+$", "sensitive":true }, "Scope":{ "type":"structure", "members":{ "awsAccounts":{"shape":"AWSAccounts"}, "awsServices":{ "shape":"AWSServices", "deprecated":true, "deprecatedMessage":"You can't specify services in scope when creating/updating an assessment. If you use the parameter to specify one or more AWS services, Audit Manager ignores the input. Instead the value of the parameter will show as empty indicating that the services are defined and managed by Audit Manager." } }, "sensitive":true }, "ServiceMetadata":{ "type":"structure", "members":{ "name":{"shape":"AWSServiceName"}, "displayName":{"shape":"NonEmptyString"}, "description":{"shape":"NonEmptyString"}, "category":{"shape":"NonEmptyString"} } }, "ServiceMetadataList":{ "type":"list", "member":{"shape":"ServiceMetadata"} }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":402}, "exception":true }, "SettingAttribute":{ "type":"string", "enum":[ "ALL", "IS_AWS_ORG_ENABLED", "SNS_TOPIC", "DEFAULT_ASSESSMENT_REPORTS_DESTINATION", "DEFAULT_PROCESS_OWNERS", "EVIDENCE_FINDER_ENABLEMENT", "DEREGISTRATION_POLICY", "DEFAULT_EXPORT_DESTINATION" ] }, "Settings":{ "type":"structure", "members":{ "isAwsOrgEnabled":{"shape":"Boolean"}, "snsTopic":{"shape":"SNSTopic"}, "defaultAssessmentReportsDestination":{"shape":"AssessmentReportsDestination"}, "defaultProcessOwners":{"shape":"Roles"}, "kmsKey":{"shape":"KmsKey"}, "evidenceFinderEnablement":{"shape":"EvidenceFinderEnablement"}, "deregistrationPolicy":{"shape":"DeregistrationPolicy"}, "defaultExportDestination":{"shape":"DefaultExportDestination"} } }, "ShareRequestAction":{ "type":"string", "enum":[ "ACCEPT", "DECLINE", "REVOKE" ] }, "ShareRequestComment":{ "type":"string", "max":500, "pattern":"^[\\w\\W\\s\\S]$" }, "ShareRequestStatus":{ "type":"string", "enum":[ "ACTIVE", "REPLICATING", "SHARED", "EXPIRING", "FAILED", "EXPIRED", "DECLINED", "REVOKED" ] }, "ShareRequestType":{ "type":"string", "enum":[ "SENT", "RECEIVED" ] }, "SnsArn":{ "type":"string", "max":2048, "min":4, "pattern":"^arn:.:sns:.\|NONE" }, "SourceDescription":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]$" }, "SourceFrequency":{ "type":"string", "enum":[ "DAILY", "WEEKLY", "MONTHLY" ] }, "SourceKeyword":{ "type":"structure", "members":{ "keywordInputType":{"shape":"KeywordInputType"}, "keywordValue":{"shape":"KeywordValue"} } }, "SourceName":{ "type":"string", "max":300, "min":1 }, "SourceSetUpOption":{ "type":"string", "enum":[ "System_Controls_Mapping", "Procedural_Controls_Mapping" ] }, "SourceType":{ "type":"string", "enum":[ "AWS_Cloudtrail", "AWS_Config", "AWS_Security_Hub", "AWS_API_Call", "MANUAL", "Common_Control", "Core_Control" ] }, "StartAssessmentFrameworkShareRequest":{ "type":"structure", "required":[ "frameworkId", "destinationAccount", "destinationRegion" ], "members":{ "frameworkId":{ "shape":"UUID", "location":"uri", "locationName":"frameworkId" }, "destinationAccount":{"shape":"AccountId"}, "destinationRegion":{"shape":"Region"}, "comment":{"shape":"ShareRequestComment"} } }, "StartAssessmentFrameworkShareResponse":{ "type":"structure", "members":{ "assessmentFrameworkShareRequest":{"shape":"AssessmentFrameworkShareRequest"} } }, "String":{ "type":"string", "max":2048, "min":0, "pattern":"." }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"AuditManagerArn", "location":"uri", "locationName":"resourceArn" }, "tags":{"shape":"TagMap"} } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":".{0,255}" }, "TestingInformation":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":429}, "exception":true }, "Timestamp":{"type":"timestamp"}, "TimestampUUID":{ "type":"string", "max":50, "min":47, "pattern":"^[0-9]{10,13}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "Token":{ "type":"string", "max":1000, "min":1, "pattern":"^[A-Za-z0-9+\\/=]$" }, "TroubleshootingText":{ "type":"string", "max":1000, "pattern":"^[\\w\\W\\s\\S]$", "sensitive":true }, "URL":{ "type":"structure", "members":{ "hyperlinkName":{"shape":"HyperlinkName"}, "link":{"shape":"UrlLink"} } }, "UUID":{ "type":"string", "max":36, "min":36, "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"AuditManagerArn", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateAssessmentControlRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "controlId" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"ControlSetId", "location":"uri", "locationName":"controlSetId" }, "controlId":{ "shape":"UUID", "location":"uri", "locationName":"controlId" }, "controlStatus":{"shape":"ControlStatus"}, "commentBody":{"shape":"ControlCommentBody"} } }, "UpdateAssessmentControlResponse":{ "type":"structure", "members":{ "control":{"shape":"AssessmentControl"} } }, "UpdateAssessmentControlSetStatusRequest":{ "type":"structure", "required":[ "assessmentId", "controlSetId", "status", "comment" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "controlSetId":{ "shape":"String", "location":"uri", "locationName":"controlSetId" }, "status":{"shape":"ControlSetStatus"}, "comment":{"shape":"DelegationComment"} } }, "UpdateAssessmentControlSetStatusResponse":{ "type":"structure", "members":{ "controlSet":{"shape":"AssessmentControlSet"} } }, "UpdateAssessmentFrameworkControlSet":{ "type":"structure", "required":[ "name", "controls" ], "members":{ "id":{"shape":"ControlSetName"}, "name":{"shape":"ControlSetName"}, "controls":{"shape":"CreateAssessmentFrameworkControls"} } }, "UpdateAssessmentFrameworkControlSets":{ "type":"list", "member":{"shape":"UpdateAssessmentFrameworkControlSet"}, "min":1 }, "UpdateAssessmentFrameworkRequest":{ "type":"structure", "required":[ "frameworkId", "name", "controlSets" ], "members":{ "frameworkId":{ "shape":"UUID", "location":"uri", "locationName":"frameworkId" }, "name":{"shape":"FrameworkName"}, "description":{"shape":"FrameworkDescription"}, "complianceType":{"shape":"ComplianceType"}, "controlSets":{"shape":"UpdateAssessmentFrameworkControlSets"} } }, "UpdateAssessmentFrameworkResponse":{ "type":"structure", "members":{ "framework":{"shape":"Framework"} } }, "UpdateAssessmentFrameworkShareRequest":{ "type":"structure", "required":[ "requestId", "requestType", "action" ], "members":{ "requestId":{ "shape":"UUID", "location":"uri", "locationName":"requestId" }, "requestType":{"shape":"ShareRequestType"}, "action":{"shape":"ShareRequestAction"} } }, "UpdateAssessmentFrameworkShareResponse":{ "type":"structure", "members":{ "assessmentFrameworkShareRequest":{"shape":"AssessmentFrameworkShareRequest"} } }, "UpdateAssessmentRequest":{ "type":"structure", "required":[ "assessmentId", "scope" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "assessmentName":{"shape":"AssessmentName"}, "assessmentDescription":{"shape":"AssessmentDescription"}, "scope":{"shape":"Scope"}, "assessmentReportsDestination":{"shape":"AssessmentReportsDestination"}, "roles":{"shape":"Roles"} } }, "UpdateAssessmentResponse":{ "type":"structure", "members":{ "assessment":{"shape":"Assessment"} } }, "UpdateAssessmentStatusRequest":{ "type":"structure", "required":[ "assessmentId", "status" ], "members":{ "assessmentId":{ "shape":"UUID", "location":"uri", "locationName":"assessmentId" }, "status":{"shape":"AssessmentStatus"} } }, "UpdateAssessmentStatusResponse":{ "type":"structure", "members":{ "assessment":{"shape":"Assessment"} } }, "UpdateControlRequest":{ "type":"structure", "required":[ "controlId", "name", "controlMappingSources" ], "members":{ "controlId":{ "shape":"UUID", "location":"uri", "locationName":"controlId" }, "name":{"shape":"ControlName"}, "description":{"shape":"ControlDescription"}, "testingInformation":{"shape":"TestingInformation"}, "actionPlanTitle":{"shape":"ActionPlanTitle"}, "actionPlanInstructions":{"shape":"ActionPlanInstructions"}, "controlMappingSources":{"shape":"ControlMappingSources"} } }, "UpdateControlResponse":{ "type":"structure", "members":{ "control":{"shape":"Control"} } }, "UpdateSettingsRequest":{ "type":"structure", "members":{ "snsTopic":{"shape":"SnsArn"}, "defaultAssessmentReportsDestination":{"shape":"AssessmentReportsDestination"}, "defaultProcessOwners":{"shape":"Roles"}, "kmsKey":{"shape":"KmsKey"}, "evidenceFinderEnabled":{"shape":"Boolean"}, "deregistrationPolicy":{"shape":"DeregistrationPolicy"}, "defaultExportDestination":{"shape":"DefaultExportDestination"} } }, "UpdateSettingsResponse":{ "type":"structure", "members":{ "settings":{"shape":"Settings"} } }, "UrlLink":{ "type":"string", "max":8192, "min":1, "pattern":"^(https?:\\/\\/)?(www\\.)?[a-zA-Z0-9-_]+([\\.]+[a-zA-Z]+)+[\\/\\w]*$" }, "Username":{ "type":"string", "max":128, "min":1, "pattern":"^[a-zA-Z0-9-_()\\s\\+=,.@]+$", "sensitive":true }, "ValidateAssessmentReportIntegrityRequest":{ "type":"structure", "required":["s3RelativePath"], "members":{ "s3RelativePath":{"shape":"S3Url"} } }, "ValidateAssessmentReportIntegrityResponse":{ "type":"structure", "members":{ "signatureValid":{"shape":"Boolean"}, "signatureAlgorithm":{"shape":"String"}, "signatureDateTime":{"shape":"String"}, "signatureKeyId":{"shape":"String"}, "validationErrors":{"shape":"ValidationErrors"} } }, "ValidationErrors":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "reason":{"shape":"ValidationExceptionReason"}, "fields":{"shape":"ValidationExceptionFieldList"} }, "error":{"httpStatusCode":400}, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{"shape":"String"}, "message":{"shape":"String"} } }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "other" ] }, "organizationId":{ "type":"string", "max":34, "min":12, "pattern":"o-[a-z0-9]{10,32}" } } }	104.76 KB	2025-05-25 12:27
📄 docs-2.json { "version": "2.0", "service": "<p>Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors. </p> <p>Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance.</p> <p>Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with specific requirements. </p> <p>Use the following links to get started with the Audit Manager API:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Operations.html\">Actions</a>: An alphabetical list of all Audit Manager API operations.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Types.html\">Data types</a>: An alphabetical list of all Audit Manager data types.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonParameters.html\">Common parameters</a>: Parameters that all operations can use.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonErrors.html\">Common errors</a>: Client and server errors that all operations can return.</p> </li> </ul> <p>If you're new to Audit Manager, we recommend that you review the <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html\"> Audit Manager User Guide</a>.</p>", "operations": { "AssociateAssessmentReportEvidenceFolder": "<p> Associates an evidence folder to an assessment report in an Audit Manager assessment. </p>", "BatchAssociateAssessmentReportEvidence": "<p> Associates a list of evidence to an assessment report in an Audit Manager assessment. </p>", "BatchCreateDelegationByAssessment": "<p> Creates a batch of delegations for an assessment in Audit Manager. </p>", "BatchDeleteDelegationByAssessment": "<p> Deletes a batch of delegations for an assessment in Audit Manager. </p>", "BatchDisassociateAssessmentReportEvidence": "<p> Disassociates a list of evidence from an assessment report in Audit Manager. </p>", "BatchImportEvidenceToAssessmentControl": "<p>Adds one or more pieces of evidence to a control in an Audit Manager assessment. </p> <p>You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question. </p> <p>The following restrictions apply to this action:</p> <ul> <li> <p> <code>manualEvidence</code> can be only one of the following: <code>evidenceFileName</code>, <code>s3ResourcePath</code>, or <code>textResponse</code> </p> </li> <li> <p>Maximum size of an individual evidence file: 100 MB</p> </li> <li> <p>Number of daily manual evidence uploads per control: 100</p> </li> <li> <p>Supported file formats: See <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files\">Supported file types for manual evidence</a> in the <i>Audit Manager User Guide</i> </p> </li> </ul> <p>For more information about Audit Manager service restrictions, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html\">Quotas and restrictions for Audit Manager</a>.</p>", "CreateAssessment": "<p> Creates an assessment in Audit Manager. </p>", "CreateAssessmentFramework": "<p> Creates a custom framework in Audit Manager. </p>", "CreateAssessmentReport": "<p> Creates an assessment report for the specified assessment. </p>", "CreateControl": "<p> Creates a new custom control in Audit Manager. </p>", "DeleteAssessment": "<p> Deletes an assessment in Audit Manager. </p>", "DeleteAssessmentFramework": "<p> Deletes a custom framework in Audit Manager. </p>", "DeleteAssessmentFrameworkShare": "<p> Deletes a share request for a custom framework in Audit Manager. </p>", "DeleteAssessmentReport": "<p>Deletes an assessment report in Audit Manager. </p> <p>When you run the <code>DeleteAssessmentReport</code> operation, Audit Manager attempts to delete the following data:</p> <ol> <li> <p>The specified assessment report that’s stored in your S3 bucket</p> </li> <li> <p>The associated metadata that’s stored in Audit Manager</p> </li> </ol> <p>If Audit Manager can’t access the assessment report in your S3 bucket, the report isn’t deleted. In this event, the <code>DeleteAssessmentReport</code> operation doesn’t fail. Instead, it proceeds to delete the associated metadata only. You must then delete the assessment report from the S3 bucket yourself. </p> <p>This scenario happens when Audit Manager receives a <code>403 (Forbidden)</code> or <code>404 (Not Found)</code> error from Amazon S3. To avoid this, make sure that your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that you can use, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination\">Assessment report destination permissions</a> in the <i>Audit Manager User Guide</i>. For information about the issues that could cause a <code>403 (Forbidden)</code> or <code>404 (Not Found</code>) error from Amazon S3, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList\">List of Error Codes</a> in the <i>Amazon Simple Storage Service API Reference</i>. </p>", "DeleteControl": "<p> Deletes a custom control in Audit Manager. </p> <important> <p>When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control.</p> </important>", "DeregisterAccount": "<p> Deregisters an account in Audit Manager. </p> <note> <p>Before you deregister, you can use the <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_UpdateSettings.html\">UpdateSettings</a> API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the <code>DeregistrationPolicy</code> attribute to request the deletion of your data. </p> <p>For more information about data retention, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html\">Data Protection</a> in the <i>Audit Manager User Guide</i>. </p> </note>", "DeregisterOrganizationAdminAccount": "<p>Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager. </p> <p>When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Organizations. However, Audit Manager stops collecting and attaching evidence to that delegated administrator account moving forward.</p> <important> <p>Keep in mind the following cleanup task if you use evidence finder:</p> <p>Before you use your management account to remove a delegated administrator, make sure that the current delegated administrator account signs in to Audit Manager and disables evidence finder first. Disabling evidence finder automatically deletes the event data store that was created in their account when they enabled evidence finder. If this task isn’t completed, the event data store remains in their account. In this case, we recommend that the original delegated administrator goes to CloudTrail Lake and manually <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-eds-disable-termination.html\">deletes the event data store</a>.</p> <p>This cleanup task is necessary to ensure that you don't end up with multiple event data stores. Audit Manager ignores an unused event data store after you remove or change a delegated administrator account. However, the unused event data store continues to incur storage costs from CloudTrail Lake if you don't delete it.</p> </important> <p>When you deregister a delegated administrator account for Audit Manager, the data for that account isn’t deleted. If you want to delete resource data for a delegated administrator account, you must perform that task separately before you deregister the account. Either, you can do this in the Audit Manager console. Or, you can use one of the delete API operations that are provided by Audit Manager. </p> <p>To delete your Audit Manager resource data, see the following instructions: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html\">DeleteAssessment</a> (see also: <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html\">Deleting an assessment</a> in the <i>Audit Manager User Guide</i>)</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html\">DeleteAssessmentFramework</a> (see also: <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html\">Deleting a custom framework</a> in the <i>Audit Manager User Guide</i>)</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html\">DeleteAssessmentFrameworkShare</a> (see also: <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html\">Deleting a share request</a> in the <i>Audit Manager User Guide</i>)</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html\">DeleteAssessmentReport</a> (see also: <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps\">Deleting an assessment report</a> in the <i>Audit Manager User Guide</i>)</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html\">DeleteControl</a> (see also: <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html\">Deleting a custom control</a> in the <i>Audit Manager User Guide</i>)</p> </li> </ul> <p>At this time, Audit Manager doesn't provide an option to delete evidence for a specific delegated administrator. Instead, when your management account deregisters Audit Manager, we perform a cleanup for the current delegated administrator account at the time of deregistration.</p>", "DisassociateAssessmentReportEvidenceFolder": "<p> Disassociates an evidence folder from the specified assessment report in Audit Manager. </p>", "GetAccountStatus": "<p> Gets the registration status of an account in Audit Manager. </p>", "GetAssessment": "<p>Gets information about a specified assessment. </p>", "GetAssessmentFramework": "<p>Gets information about a specified framework.</p>", "GetAssessmentReportUrl": "<p> Gets the URL of an assessment report in Audit Manager. </p>", "GetChangeLogs": "<p> Gets a list of changelogs from Audit Manager. </p>", "GetControl": "<p> Gets information about a specified control.</p>", "GetDelegations": "<p> Gets a list of delegations from an audit owner to a delegate. </p>", "GetEvidence": "<p> Gets information about a specified evidence item.</p>", "GetEvidenceByEvidenceFolder": "<p> Gets all evidence from a specified evidence folder in Audit Manager. </p>", "GetEvidenceFileUploadUrl": "<p>Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#how-to-upload-manual-evidence-files\">Upload a file from your browser </a> in the <i>Audit Manager User Guide</i>.</p> <p>The following restrictions apply to this operation:</p> <ul> <li> <p>Maximum size of an individual evidence file: 100 MB</p> </li> <li> <p>Number of daily manual evidence uploads per control: 100</p> </li> <li> <p>Supported file formats: See <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files\">Supported file types for manual evidence</a> in the <i>Audit Manager User Guide</i> </p> </li> </ul> <p>For more information about Audit Manager service restrictions, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html\">Quotas and restrictions for Audit Manager</a>.</p>", "GetEvidenceFolder": "<p> Gets an evidence folder from a specified assessment in Audit Manager. </p>", "GetEvidenceFoldersByAssessment": "<p> Gets the evidence folders from a specified assessment in Audit Manager. </p>", "GetEvidenceFoldersByAssessmentControl": "<p> Gets a list of evidence folders that are associated with a specified control in an Audit Manager assessment. </p>", "GetInsights": "<p>Gets the latest analytics data for all your current active assessments. </p>", "GetInsightsByAssessment": "<p>Gets the latest analytics data for a specific active assessment. </p>", "GetOrganizationAdminAccount": "<p> Gets the name of the delegated Amazon Web Services administrator account for a specified organization. </p>", "GetServicesInScope": "<p>Gets a list of the Amazon Web Services from which Audit Manager can collect evidence. </p> <p>Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list.</p> <note> <p>For information about why it's no longer possible to specify services in scope manually, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-collection-issues.html#unable-to-edit-services\">I can't edit the services in scope for my assessment</a> in the <i>Troubleshooting</i> section of the Audit Manager user guide.</p> </note>", "GetSettings": "<p> Gets the settings for a specified Amazon Web Services account. </p>", "ListAssessmentControlInsightsByControlDomain": "<p>Lists the latest analytics data for controls within a specific control domain and a specific active assessment.</p> <note> <p>Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the <code>lastUpdated</code> date of <code>controlInsightsByAssessment</code>. If neither of these conditions are met, no data is listed for that control. </p> </note>", "ListAssessmentFrameworkShareRequests": "<p> Returns a list of sent or received share requests for custom frameworks in Audit Manager. </p>", "ListAssessmentFrameworks": "<p> Returns a list of the frameworks that are available in the Audit Manager framework library. </p>", "ListAssessmentReports": "<p> Returns a list of assessment reports created in Audit Manager. </p>", "ListAssessments": "<p> Returns a list of current and past assessments from Audit Manager. </p>", "ListControlDomainInsights": "<p>Lists the latest analytics data for control domains across all of your active assessments. </p> <p>Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html\"> <code>ListDomains</code> </a> in the Amazon Web Services Control Catalog API Reference.</p> <note> <p>A control domain is listed only if at least one of the controls within that domain collected evidence on the <code>lastUpdated</code> date of <code>controlDomainInsights</code>. If this condition isn’t met, no data is listed for that control domain.</p> </note>", "ListControlDomainInsightsByAssessment": "<p>Lists analytics data for control domains within a specified active assessment.</p> <p>Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html\"> <code>ListDomains</code> </a> in the Amazon Web Services Control Catalog API Reference.</p> <note> <p>A control domain is listed only if at least one of the controls within that domain collected evidence on the <code>lastUpdated</code> date of <code>controlDomainInsights</code>. If this condition isn’t met, no data is listed for that domain.</p> </note>", "ListControlInsightsByControlDomain": "<p>Lists the latest analytics data for controls within a specific control domain across all active assessments.</p> <note> <p>Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the <code>lastUpdated</code> date of <code>controlInsightsMetadata</code>. If neither of these conditions are met, no data is listed for that control. </p> </note>", "ListControls": "<p> Returns a list of controls from Audit Manager. </p>", "ListKeywordsForDataSource": "<p>Returns a list of keywords that are pre-mapped to the specified control data source.</p>", "ListNotifications": "<p> Returns a list of all Audit Manager notifications. </p>", "ListTagsForResource": "<p> Returns a list of tags for the specified resource in Audit Manager. </p>", "RegisterAccount": "<p> Enables Audit Manager for the specified Amazon Web Services account. </p>", "RegisterOrganizationAdminAccount": "<p> Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. </p>", "StartAssessmentFrameworkShare": "<p> Creates a share request for a custom framework in Audit Manager. </p> <p>The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.</p> <p>When you create a share request, Audit Manager stores a snapshot of your custom framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.</p> <p>Audit Manager deletes the snapshot and the backup snapshot when one of the following events occurs:</p> <ul> <li> <p>The sender revokes the share request.</p> </li> <li> <p>The recipient declines the share request.</p> </li> <li> <p>The recipient encounters an error and doesn't successfully accept the share request.</p> </li> <li> <p>The share request expires before the recipient responds to the request.</p> </li> </ul> <p>When a sender <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend\">resends a share request</a>, the snapshot is replaced with an updated version that corresponds with the latest version of the custom framework. </p> <p>When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. </p> <important> <p>When you invoke the <code>StartAssessmentFrameworkShare</code> API, you are about to share a custom framework with another Amazon Web Services account. You may not share a custom framework that is derived from a standard framework if the standard framework is designated as not eligible for sharing by Amazon Web Services, unless you have obtained permission to do so from the owner of the standard framework. To learn more about which standard frameworks are eligible for sharing, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility\">Framework sharing eligibility</a> in the <i>Audit Manager User Guide</i>.</p> </important>", "TagResource": "<p> Tags the specified resource in Audit Manager. </p>", "UntagResource": "<p> Removes a tag from a resource in Audit Manager. </p>", "UpdateAssessment": "<p> Edits an Audit Manager assessment. </p>", "UpdateAssessmentControl": "<p> Updates a control within an assessment in Audit Manager. </p>", "UpdateAssessmentControlSetStatus": "<p> Updates the status of a control set in an Audit Manager assessment. </p>", "UpdateAssessmentFramework": "<p> Updates a custom framework in Audit Manager. </p>", "UpdateAssessmentFrameworkShare": "<p> Updates a share request for a custom framework in Audit Manager. </p>", "UpdateAssessmentStatus": "<p> Updates the status of an assessment in Audit Manager. </p>", "UpdateControl": "<p> Updates a custom control in Audit Manager. </p>", "UpdateSettings": "<p> Updates Audit Manager settings for the current account. </p>", "ValidateAssessmentReportIntegrity": "<p> Validates the integrity of an assessment report in Audit Manager. </p>" }, "shapes": { "AWSAccount": { "base": "<p> The wrapper of Amazon Web Services account details, such as account ID or email address. </p>", "refs": { "AWSAccounts$member": null, "Assessment$awsAccount": "<p> The Amazon Web Services account that's associated with the assessment. </p>" } }, "AWSAccounts": { "base": null, "refs": { "Scope$awsAccounts": "<p> The Amazon Web Services accounts that are included in the scope of the assessment. </p>" } }, "AWSService": { "base": "<p> An Amazon Web Service such as Amazon S3 or CloudTrail. </p> <p>For an example of how to find an Amazon Web Service name and how to define it in your assessment scope, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_2\">Finding an Amazon Web Service name to use in your assessment scope</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetServicesInScope.html#API_GetServicesInScope_Example_3\">Defining an Amazon Web Service name in your assessment scope</a> </p> </li> </ul>", "refs": { "AWSServices$member": null } }, "AWSServiceName": { "base": null, "refs": { "AWSService$serviceName": "<p> The name of the Amazon Web Service. </p>", "Evidence$eventSource": "<p> The Amazon Web Service that the evidence is collected from. </p>", "ServiceMetadata$name": "<p> The name of the Amazon Web Service. </p>" } }, "AWSServices": { "base": null, "refs": { "Scope$awsServices": "<p> The Amazon Web Services services that are included in the scope of the assessment. </p> <important> <p>This API parameter is no longer supported. If you use this parameter to specify one or more Amazon Web Services, Audit Manager ignores this input. Instead, the value for <code>awsServices</code> will show as empty.</p> </important>" } }, "AccessDeniedException": { "base": "<p> Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. </p>", "refs": { } }, "AccountId": { "base": null, "refs": { "AWSAccount$id": "<p> The identifier for the Amazon Web Services account. </p>", "AssessmentFrameworkShareRequest$sourceAccount": "<p> The Amazon Web Services account of the sender. </p>", "AssessmentFrameworkShareRequest$destinationAccount": "<p> The Amazon Web Services account of the recipient. </p>", "AssessmentReport$awsAccountId": "<p> The identifier for the specified Amazon Web Services account. </p>", "DeregisterOrganizationAdminAccountRequest$adminAccountId": "<p> The identifier for the administrator account. </p>", "Evidence$evidenceAwsAccountId": "<p> The identifier for the Amazon Web Services account. </p>", "Evidence$awsAccountId": "<p> The identifier for the Amazon Web Services account. </p>", "GetOrganizationAdminAccountResponse$adminAccountId": "<p> The identifier for the administrator account. </p>", "RegisterAccountRequest$delegatedAdminAccount": "<p> The delegated administrator account for Audit Manager. </p>", "RegisterOrganizationAdminAccountRequest$adminAccountId": "<p> The identifier for the delegated administrator account. </p>", "RegisterOrganizationAdminAccountResponse$adminAccountId": "<p> The identifier for the delegated administrator account. </p>", "StartAssessmentFrameworkShareRequest$destinationAccount": "<p> The Amazon Web Services account of the recipient. </p>" } }, "AccountName": { "base": null, "refs": { "AWSAccount$name": "<p> The name of the Amazon Web Services account. </p>" } }, "AccountStatus": { "base": null, "refs": { "DeregisterAccountResponse$status": "<p> The registration status of the account. </p>", "GetAccountStatusResponse$status": "<p> The status of the Amazon Web Services account. </p>", "RegisterAccountResponse$status": "<p> The status of the account registration request. </p>" } }, "ActionEnum": { "base": null, "refs": { "ChangeLog$action": "<p> The action that was performed. </p>" } }, "ActionPlanInstructions": { "base": null, "refs": { "Control$actionPlanInstructions": "<p> The recommended actions to carry out if the control isn't fulfilled. </p>", "CreateControlRequest$actionPlanInstructions": "<p> The recommended actions to carry out if the control isn't fulfilled. </p>", "UpdateControlRequest$actionPlanInstructions": "<p> The recommended actions to carry out if the control isn't fulfilled. </p>" } }, "ActionPlanTitle": { "base": null, "refs": { "Control$actionPlanTitle": "<p> The title of the action plan for remediating the control. </p>", "CreateControlRequest$actionPlanTitle": "<p> The title of the action plan for remediating the control. </p>", "UpdateControlRequest$actionPlanTitle": "<p> The title of the action plan for remediating the control. </p>" } }, "Assessment": { "base": "<p> 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. </p>", "refs": { "CreateAssessmentResponse$assessment": null, "GetAssessmentResponse$assessment": null, "UpdateAssessmentResponse$assessment": "<p> The response object for the <code>UpdateAssessment</code> API. This is the name of the updated assessment.</p>", "UpdateAssessmentStatusResponse$assessment": "<p> The name of the updated assessment that the <code>UpdateAssessmentStatus</code> API returned. </p>" } }, "AssessmentControl": { "base": "<p> The control entity that represents a standard control or a custom control in an Audit Manager assessment. </p>", "refs": { "AssessmentControls$member": null, "UpdateAssessmentControlResponse$control": "<p> The name of the updated control set that the <code>UpdateAssessmentControl</code> API returned. </p>" } }, "AssessmentControlSet": { "base": "<p> Represents a set of controls in an Audit Manager assessment. </p>", "refs": { "AssessmentControlSets$member": null, "UpdateAssessmentControlSetStatusResponse$controlSet": "<p> The name of the updated control set that the <code>UpdateAssessmentControlSetStatus</code> API returned. </p>" } }, "AssessmentControlSets": { "base": null, "refs": { "AssessmentFramework$controlSets": "<p> The control sets that are associated with the framework. </p>" } }, "AssessmentControls": { "base": null, "refs": { "AssessmentControlSet$controls": "<p> The list of controls that's contained with the control set. </p>" } }, "AssessmentDescription": { "base": null, "refs": { "AssessmentMetadata$description": "<p> The description of the assessment. </p>", "CreateAssessmentRequest$description": "<p> The optional description of the assessment to be created. </p>", "UpdateAssessmentRequest$assessmentDescription": "<p> The description of the assessment. </p>" } }, "AssessmentEvidenceFolder": { "base": "<p> The folder where Audit Manager stores evidence for an assessment. </p>", "refs": { "AssessmentEvidenceFolders$member": null, "GetEvidenceFolderResponse$evidenceFolder": "<p> The folder that the evidence is stored in. </p>" } }, "AssessmentEvidenceFolderName": { "base": null, "refs": { "AssessmentEvidenceFolder$name": "<p> The name of the evidence folder. </p>" } }, "AssessmentEvidenceFolders": { "base": null, "refs": { "GetEvidenceFoldersByAssessmentControlResponse$evidenceFolders": "<p> The list of evidence folders that the <code>GetEvidenceFoldersByAssessmentControl</code> API returned. </p>", "GetEvidenceFoldersByAssessmentResponse$evidenceFolders": "<p> The list of evidence folders that the <code>GetEvidenceFoldersByAssessment</code> API returned. </p>" } }, "AssessmentFramework": { "base": "<p> The file used to structure and automate Audit Manager assessments for a given compliance standard. </p>", "refs": { "Assessment$framework": "<p> The framework that the assessment was created from. </p>" } }, "AssessmentFrameworkDescription": { "base": null, "refs": { "FrameworkMetadata$description": "<p> The description of the framework. </p>" } }, "AssessmentFrameworkMetadata": { "base": "<p> The metadata that's associated with a standard framework or a custom framework. </p>", "refs": { "FrameworkMetadataList$member": null } }, "AssessmentFrameworkShareRequest": { "base": "<p> Represents a share request for a custom framework in Audit Manager. </p>", "refs": { "AssessmentFrameworkShareRequestList$member": null, "StartAssessmentFrameworkShareResponse$assessmentFrameworkShareRequest": "<p> The share request that's created by the <code>StartAssessmentFrameworkShare</code> API. </p>", "UpdateAssessmentFrameworkShareResponse$assessmentFrameworkShareRequest": "<p> The updated share request that's returned by the <code>UpdateAssessmentFrameworkShare</code> operation. </p>" } }, "AssessmentFrameworkShareRequestList": { "base": null, "refs": { "ListAssessmentFrameworkShareRequestsResponse$assessmentFrameworkShareRequests": "<p> The list of share requests that the <code>ListAssessmentFrameworkShareRequests</code> API returned. </p>" } }, "AssessmentMetadata": { "base": "<p> The metadata that's associated with the specified assessment. </p>", "refs": { "Assessment$metadata": "<p> The metadata for the assessment. </p>" } }, "AssessmentMetadataItem": { "base": "<p> A metadata object that's associated with an assessment in Audit Manager. </p>", "refs": { "ListAssessmentMetadata$member": null } }, "AssessmentName": { "base": null, "refs": { "AssessmentMetadata$name": "<p> The name of the assessment. </p>", "AssessmentMetadataItem$name": "<p> The name of the assessment. </p>", "AssessmentReport$assessmentName": "<p> The name of the associated assessment. </p>", "AssessmentReportMetadata$assessmentName": "<p>The name of the associated assessment. </p>", "CreateAssessmentRequest$name": "<p> The name of the assessment to be created. </p>", "Delegation$assessmentName": "<p> The name of the assessment that's associated with the delegation. </p>", "DelegationMetadata$assessmentName": "<p> The name of the associated assessment. </p>", "FrameworkMetadata$name": "<p> The name of the framework. </p>", "Notification$assessmentName": "<p> The name of the related assessment. </p>", "UpdateAssessmentRequest$assessmentName": "<p> The name of the assessment to be updated. </p>" } }, "AssessmentReport": { "base": "<p> 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. </p>", "refs": { "CreateAssessmentReportResponse$assessmentReport": "<p> The new assessment report that the <code>CreateAssessmentReport</code> API returned. </p>" } }, "AssessmentReportDescription": { "base": null, "refs": { "AssessmentReport$description": "<p> The description of the specified assessment report. </p>", "AssessmentReportMetadata$description": "<p> The description of the assessment report. </p>", "CreateAssessmentReportRequest$description": "<p> The description of the assessment report. </p>" } }, "AssessmentReportDestinationType": { "base": null, "refs": { "AssessmentReportsDestination$destinationType": "<p> The destination type, such as Amazon S3. </p>" } }, "AssessmentReportEvidenceError": { "base": "<p> An error entity for assessment report evidence errors. This is used to provide more meaningful errors than a simple string message. </p>", "refs": { "AssessmentReportEvidenceErrors$member": null } }, "AssessmentReportEvidenceErrors": { "base": null, "refs": { "BatchAssociateAssessmentReportEvidenceResponse$errors": "<p> A list of errors that the <code>BatchAssociateAssessmentReportEvidence</code> API returned. </p>", "BatchDisassociateAssessmentReportEvidenceResponse$errors": "<p> A list of errors that the <code>BatchDisassociateAssessmentReportEvidence</code> API returned. </p>" } }, "AssessmentReportMetadata": { "base": "<p> The metadata objects that are associated with the specified assessment report. </p>", "refs": { "AssessmentReportsMetadata$member": null } }, "AssessmentReportName": { "base": null, "refs": { "AssessmentReport$name": "<p> The name that's given to the assessment report. </p>", "AssessmentReportMetadata$name": "<p> The name of the assessment report. </p>", "CreateAssessmentReportRequest$name": "<p> The name of the new assessment report. </p>" } }, "AssessmentReportStatus": { "base": null, "refs": { "AssessmentReport$status": "<p> The current status of the specified assessment report. </p>", "AssessmentReportMetadata$status": "<p> The current status of the assessment report. </p>" } }, "AssessmentReportsDestination": { "base": "<p> The location where Audit Manager saves assessment reports for the given assessment. </p>", "refs": { "AssessmentMetadata$assessmentReportsDestination": "<p> The destination that evidence reports are stored in for the assessment. </p>", "CreateAssessmentRequest$assessmentReportsDestination": "<p> The assessment report storage destination for the assessment that's being created. </p>", "Settings$defaultAssessmentReportsDestination": "<p>The default S3 destination bucket for storing assessment reports.</p>", "UpdateAssessmentRequest$assessmentReportsDestination": "<p> The assessment report storage destination for the assessment that's being updated. </p>", "UpdateSettingsRequest$defaultAssessmentReportsDestination": "<p> The default S3 destination bucket for storing assessment reports. </p>" } }, "AssessmentReportsMetadata": { "base": null, "refs": { "ListAssessmentReportsResponse$assessmentReports": "<p> The list of assessment reports that the <code>ListAssessmentReports</code> API returned. </p>" } }, "AssessmentStatus": { "base": null, "refs": { "AssessmentMetadata$status": "<p> The overall status of the assessment. </p>", "AssessmentMetadataItem$status": "<p> The current status of the assessment. </p>", "ListAssessmentsRequest$status": "<p> The current status of the assessment.</p>", "UpdateAssessmentStatusRequest$status": "<p> The current status of the assessment. </p>" } }, "AssociateAssessmentReportEvidenceFolderRequest": { "base": null, "refs": { } }, "AssociateAssessmentReportEvidenceFolderResponse": { "base": null, "refs": { } }, "AuditManagerArn": { "base": null, "refs": { "Assessment$arn": "<p> The Amazon Resource Name (ARN) of the assessment. </p>", "AssessmentFramework$arn": "<p> The Amazon Resource Name (ARN) of the framework. </p>", "AssessmentFrameworkMetadata$arn": "<p> The Amazon Resource Name (ARN) of the framework. </p>", "Control$arn": "<p> The Amazon Resource Name (ARN) of the control. </p>", "ControlMetadata$arn": "<p> The Amazon Resource Name (ARN) of the control. </p>", "Framework$arn": "<p> The Amazon Resource Name (ARN) of the framework. </p>", "ListTagsForResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) of the resource. </p>", "TagResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) of the resource. </p>", "UntagResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) of the specified resource. </p>" } }, "BatchAssociateAssessmentReportEvidenceRequest": { "base": null, "refs": { } }, "BatchAssociateAssessmentReportEvidenceResponse": { "base": null, "refs": { } }, "BatchCreateDelegationByAssessmentError": { "base": "<p> An error entity for the <code>BatchCreateDelegationByAssessment</code> API. This is used to provide more meaningful errors than a simple string message. </p>", "refs": { "BatchCreateDelegationByAssessmentErrors$member": null } }, "BatchCreateDelegationByAssessmentErrors": { "base": null, "refs": { "BatchCreateDelegationByAssessmentResponse$errors": "<p> A list of errors that the <code>BatchCreateDelegationByAssessment</code> API returned. </p>" } }, "BatchCreateDelegationByAssessmentRequest": { "base": null, "refs": { } }, "BatchCreateDelegationByAssessmentResponse": { "base": null, "refs": { } }, "BatchDeleteDelegationByAssessmentError": { "base": "<p> An error entity for the <code>BatchDeleteDelegationByAssessment</code> API. This is used to provide more meaningful errors than a simple string message. </p>", "refs": { "BatchDeleteDelegationByAssessmentErrors$member": null } }, "BatchDeleteDelegationByAssessmentErrors": { "base": null, "refs": { "BatchDeleteDelegationByAssessmentResponse$errors": "<p> A list of errors that the <code>BatchDeleteDelegationByAssessment</code> API returned. </p>" } }, "BatchDeleteDelegationByAssessmentRequest": { "base": null, "refs": { } }, "BatchDeleteDelegationByAssessmentResponse": { "base": null, "refs": { } }, "BatchDisassociateAssessmentReportEvidenceRequest": { "base": null, "refs": { } }, "BatchDisassociateAssessmentReportEvidenceResponse": { "base": null, "refs": { } }, "BatchImportEvidenceToAssessmentControlError": { "base": "<p> An error entity for the <code>BatchImportEvidenceToAssessmentControl</code> API. This is used to provide more meaningful errors than a simple string message. </p>", "refs": { "BatchImportEvidenceToAssessmentControlErrors$member": null } }, "BatchImportEvidenceToAssessmentControlErrors": { "base": null, "refs": { "BatchImportEvidenceToAssessmentControlResponse$errors": "<p> A list of errors that the <code>BatchImportEvidenceToAssessmentControl</code> API returned. </p>" } }, "BatchImportEvidenceToAssessmentControlRequest": { "base": null, "refs": { } }, "BatchImportEvidenceToAssessmentControlResponse": { "base": null, "refs": { } }, "Boolean": { "base": null, "refs": { "Settings$isAwsOrgEnabled": "<p> Specifies whether Organizations is enabled. </p>", "UpdateSettingsRequest$evidenceFinderEnabled": "<p>Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder.</p> <important> <p>When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html\">deregister</a> and then <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html\">re-register</a> Audit Manager. </p> </important>", "ValidateAssessmentReportIntegrityResponse$signatureValid": "<p> Specifies whether the signature key is valid. </p>" } }, "ChangeLog": { "base": "<p> 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. </p>", "refs": { "ChangeLogs$member": null } }, "ChangeLogs": { "base": null, "refs": { "GetChangeLogsResponse$changeLogs": "<p>The list of user activity for the control. </p>" } }, "CloudTrailArn": { "base": null, "refs": { "EvidenceFinderEnablement$eventDataStoreArn": "<p>The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder. The event data store is the lake of evidence data that evidence finder runs queries against.</p>" } }, "ComplianceType": { "base": null, "refs": { "AssessmentFrameworkMetadata$complianceType": "<p> The compliance type that the new custom framework supports, such as CIS or HIPAA. </p>", "AssessmentFrameworkShareRequest$complianceType": "<p>The compliance type that the shared custom framework supports, such as CIS or HIPAA.</p>", "AssessmentMetadata$complianceType": "<p> The name of the compliance standard that's related to the assessment, such as PCI-DSS. </p>", "AssessmentMetadataItem$complianceType": "<p> The name of the compliance standard that's related to the assessment, such as PCI-DSS. </p>", "CreateAssessmentFrameworkRequest$complianceType": "<p> The compliance type that the new custom framework supports, such as CIS or HIPAA. </p>", "Framework$complianceType": "<p> The compliance type that the framework supports, such as CIS or HIPAA. </p>", "FrameworkMetadata$complianceType": "<p> The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA. </p>", "UpdateAssessmentFrameworkRequest$complianceType": "<p> The compliance type that the new custom framework supports, such as CIS or HIPAA. </p>" } }, "Control": { "base": "<p> A control in Audit Manager. </p>", "refs": { "Controls$member": null, "CreateControlResponse$control": "<p> The new control that the <code>CreateControl</code> API returned. </p>", "GetControlResponse$control": "<p> The details of the control that the <code>GetControl</code> API returned. </p>", "UpdateControlResponse$control": "<p> The name of the updated control set that the <code>UpdateControl</code> API returned. </p>" } }, "ControlCatalogId": { "base": null, "refs": { "ListControlsRequest$controlCatalogId": "<p>A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog. </p> <p>To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html\"> <code>ListDomains</code> </a>, <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListObjectives.html\"> <code>ListObjectives</code> </a>, and <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListCommonControls.html\"> <code>ListCommonControls</code> </a>.</p> <note> <p>You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the <code>ListControls</code> operation separately for each ARN. </p> </note> <p>Alternatively, specify <code>UNCATEGORIZED</code> to list controls that aren't mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don't belong to any control domain or control objective.</p>" } }, "ControlComment": { "base": "<p> A comment that's posted by a user on a control. This includes the author's name, the comment text, and a timestamp. </p>", "refs": { "ControlComments$member": null } }, "ControlCommentBody": { "base": null, "refs": { "ControlComment$commentBody": "<p> The body text of a control comment. </p>", "UpdateAssessmentControlRequest$commentBody": "<p> The comment body text for the control. </p>" } }, "ControlComments": { "base": null, "refs": { "AssessmentControl$comments": "<p> The list of comments that's attached to the control. </p>" } }, "ControlDescription": { "base": null, "refs": { "AssessmentControl$description": "<p> The description of the control. </p>", "Control$description": "<p> The description of the control. </p>", "CreateControlRequest$description": "<p> The description of the control. </p>", "UpdateControlRequest$description": "<p> The optional description of the control. </p>" } }, "ControlDomainId": { "base": null, "refs": { "ControlDomainInsights$id": "<p>The unique identifier for the control domain. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html\"> <code>ListDomains</code> </a> in the Amazon Web Services Control Catalog API Reference.</p>", "ControlInsightsMetadataByAssessmentItem$id": "<p>The unique identifier for the assessment control. </p>", "ControlInsightsMetadataItem$id": "<p>The unique identifier for the control. </p>", "ListAssessmentControlInsightsByControlDomainRequest$controlDomainId": "<p>The unique identifier for the control domain. </p> <p>Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html\"> <code>ListDomains</code> </a> in the Amazon Web Services Control Catalog API Reference.</p>", "ListControlInsightsByControlDomainRequest$controlDomainId": "<p>The unique identifier for the control domain. </p> <p>Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see <a href=\"https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html\"> <code>ListDomains</code> </a> in the Amazon Web Services Control Catalog API Reference.</p>" } }, "ControlDomainInsights": { "base": "<p>A summary of the latest analytics data for a specific control domain.</p> <p>Control domain insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.</p>", "refs": { "ControlDomainInsightsList$member": null } }, "ControlDomainInsightsList": { "base": null, "refs": { "ListControlDomainInsightsByAssessmentResponse$controlDomainInsights": "<p>The control domain analytics data that the <code>ListControlDomainInsightsByAssessment</code> API returned. </p>", "ListControlDomainInsightsResponse$controlDomainInsights": "<p>The control domain analytics data that the <code>ListControlDomainInsights</code> API returned. </p>" } }, "ControlInsightsMetadata": { "base": null, "refs": { "ListControlInsightsByControlDomainResponse$controlInsightsMetadata": "<p>The control analytics data that the <code>ListControlInsightsByControlDomain</code> API returned. </p>" } }, "ControlInsightsMetadataByAssessment": { "base": null, "refs": { "ListAssessmentControlInsightsByControlDomainResponse$controlInsightsByAssessment": "<p>The assessment control analytics data that the <code>ListAssessmentControlInsightsByControlDomain</code> API returned. </p>" } }, "ControlInsightsMetadataByAssessmentItem": { "base": "<p>A summary of the latest analytics data for a specific control in a specific active assessment.</p> <p>Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence. </p>", "refs": { "ControlInsightsMetadataByAssessment$member": null } }, "ControlInsightsMetadataItem": { "base": "<p>A summary of the latest analytics data for a specific control. </p> <p>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.</p>", "refs": { "ControlInsightsMetadata$member": null } }, "ControlMappingSource": { "base": "<p> The data source that determines where Audit Manager collects evidence from for the control. </p>", "refs": { "ControlMappingSources$member": null } }, "ControlMappingSources": { "base": null, "refs": { "Control$controlMappingSources": "<p> The data mapping sources for the control. </p>", "UpdateControlRequest$controlMappingSources": "<p> The data mapping sources for the control. </p>" } }, "ControlMetadata": { "base": "<p> The metadata that's associated with the standard control or custom control. </p>", "refs": { "ControlMetadataList$member": null } }, "ControlMetadataList": { "base": null, "refs": { "ListControlsResponse$controlMetadataList": "<p> A list of metadata that the <code>ListControls</code> API returns for each control.</p>" } }, "ControlName": { "base": null, "refs": { "AssessmentControl$name": "<p> The name of the control. </p>", "AssessmentEvidenceFolder$controlName": "<p> The name of the control. </p>", "Control$name": "<p> The name of the control. </p>", "ControlMetadata$name": "<p> The name of the control. </p>", "CreateControlRequest$name": "<p> The name of the control. </p>", "UpdateControlRequest$name": "<p> The name of the updated control. </p>" } }, "ControlResponse": { "base": null, "refs": { "AssessmentControl$response": "<p> The response of the control. </p>" } }, "ControlSet": { "base": "<p> A set of controls in Audit Manager. </p>", "refs": { "ControlSets$member": null } }, "ControlSetId": { "base": null, "refs": { "AssessmentControlSet$id": "<p> The identifier of the control set in the assessment. This is the control set name in a plain string format. </p>", "AssessmentEvidenceFolder$controlSetId": "<p> The identifier for the control set. </p>", "BatchImportEvidenceToAssessmentControlRequest$controlSetId": "<p> The identifier for the control set. </p>", "CreateDelegationRequest$controlSetId": "<p> The unique identifier for the control set. </p>", "Delegation$controlSetId": "<p> The identifier for the control set that's associated with the delegation. </p>", "GetChangeLogsRequest$controlSetId": "<p> The unique identifier for the control set. </p>", "GetEvidenceByEvidenceFolderRequest$controlSetId": "<p> The identifier for the control set. </p>", "GetEvidenceFolderRequest$controlSetId": "<p> The unique identifier for the control set. </p>", "GetEvidenceFoldersByAssessmentControlRequest$controlSetId": "<p> The identifier for the control set. </p>", "GetEvidenceRequest$controlSetId": "<p> The unique identifier for the control set. </p>", "Notification$controlSetId": "<p> The identifier for the control set. </p>", "UpdateAssessmentControlRequest$controlSetId": "<p> The unique identifier for the control set. </p>" } }, "ControlSetName": { "base": null, "refs": { "ControlSet$name": "<p> The name of the control set. </p>", "CreateAssessmentFrameworkControlSet$name": "<p> The name of the control set. </p>", "UpdateAssessmentFrameworkControlSet$id": "<p> The unique identifier for the control set. </p>", "UpdateAssessmentFrameworkControlSet$name": "<p> The name of the control set. </p>" } }, "ControlSetStatus": { "base": null, "refs": { "AssessmentControlSet$status": "<p> The current status of the control set. </p>", "UpdateAssessmentControlSetStatusRequest$status": "<p> The status of the control set that's being updated. </p>" } }, "ControlSets": { "base": null, "refs": { "Framework$controlSets": "<p> The control sets that are associated with the framework. </p>" } }, "ControlSetsCount": { "base": null, "refs": { "AssessmentFrameworkMetadata$controlSetsCount": "<p> The number of control sets that are associated with the framework. </p>" } }, "ControlSources": { "base": null, "refs": { "Control$controlSources": "<p> The data source types that determine where Audit Manager collects evidence from for the control. </p>", "ControlMetadata$controlSources": "<p> The data source that determines where Audit Manager collects evidence from for the control. </p>", "Framework$controlSources": "<p> The control data sources where Audit Manager collects evidence from.</p>" } }, "ControlState": { "base": null, "refs": { "Control$state": "<p>The state of the control. The <code>END_OF_SUPPORT</code> state is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.</p>" } }, "ControlStatus": { "base": null, "refs": { "AssessmentControl$status": "<p> The status of the control. </p>", "UpdateAssessmentControlRequest$controlStatus": "<p> The status of the control. </p>" } }, "ControlType": { "base": null, "refs": { "Control$type": "<p> Specifies whether the control is a standard control or a custom control.</p>", "ListControlsRequest$controlType": "<p>A filter that narrows the list of controls to a specific type. </p>" } }, "Controls": { "base": null, "refs": { "ControlSet$controls": "<p> The list of controls within the control set. </p>" } }, "ControlsCount": { "base": null, "refs": { "AssessmentFrameworkMetadata$controlsCount": "<p> The number of controls that are associated with the framework. </p>" } }, "CreateAssessmentFrameworkControl": { "base": "<p> The control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager. </p>", "refs": { "CreateAssessmentFrameworkControls$member": null } }, "CreateAssessmentFrameworkControlSet": { "base": "<p> A <code>controlSet</code> entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID. </p>", "refs": { "CreateAssessmentFrameworkControlSets$member": null } }, "CreateAssessmentFrameworkControlSets": { "base": null, "refs": { "CreateAssessmentFrameworkRequest$controlSets": "<p> The control sets that are associated with the framework. </p>" } }, "CreateAssessmentFrameworkControls": { "base": null, "refs": { "CreateAssessmentFrameworkControlSet$controls": "<p> The list of controls within the control set. This doesn't contain the control set ID. </p>", "UpdateAssessmentFrameworkControlSet$controls": "<p> The list of controls that are contained within the control set. </p>" } }, "CreateAssessmentFrameworkRequest": { "base": null, "refs": { } }, "CreateAssessmentFrameworkResponse": { "base": null, "refs": { } }, "CreateAssessmentReportRequest": { "base": null, "refs": { } }, "CreateAssessmentReportResponse": { "base": null, "refs": { } }, "CreateAssessmentRequest": { "base": null, "refs": { } }, "CreateAssessmentResponse": { "base": null, "refs": { } }, "CreateControlMappingSource": { "base": "<p>The mapping attributes that determine the evidence source for a given control, along with related parameters and metadata. This doesn't contain <code>mappingID</code>. </p>", "refs": { "CreateControlMappingSources$member": null } }, "CreateControlMappingSources": { "base": null, "refs": { "CreateControlRequest$controlMappingSources": "<p> The data mapping sources for the control. </p>" } }, "CreateControlRequest": { "base": null, "refs": { } }, "CreateControlResponse": { "base": null, "refs": { } }, "CreateDelegationRequest": { "base": "<p> A collection of attributes that's used to create a delegation for an assessment in Audit Manager. </p>", "refs": { "BatchCreateDelegationByAssessmentError$createDelegationRequest": "<p> The API request to batch create delegations in Audit Manager. </p>", "CreateDelegationRequests$member": null } }, "CreateDelegationRequests": { "base": null, "refs": { "BatchCreateDelegationByAssessmentRequest$createDelegationRequests": "<p> The API request to batch create delegations in Audit Manager. </p>" } }, "CreatedBy": { "base": null, "refs": { "Control$createdBy": "<p> The user or role that created the control. </p>", "Delegation$createdBy": "<p> The user or role that created the delegation. </p>", "Framework$createdBy": "<p> The user or role that created the framework. </p>" } }, "DataSourceType": { "base": null, "refs": { "ListKeywordsForDataSourceRequest$source": "<p>The control mapping data source that the keywords apply to. </p>" } }, "DefaultExportDestination": { "base": "<p>The default s3 bucket where Audit Manager saves the files that you export from evidence finder.</p>", "refs": { "Settings$defaultExportDestination": "<p>The default S3 destination bucket for storing evidence finder exports.</p>", "UpdateSettingsRequest$defaultExportDestination": "<p> The default S3 destination bucket for storing evidence finder exports. </p>" } }, "Delegation": { "base": "<p> The assignment of a control set to a delegate for review. </p>", "refs": { "Delegations$member": null } }, "DelegationComment": { "base": null, "refs": { "CreateDelegationRequest$comment": "<p> A comment that's related to the delegation request. </p>", "Delegation$comment": "<p> The comment that's related to the delegation. </p>", "UpdateAssessmentControlSetStatusRequest$comment": "<p> The comment that's related to the status update. </p>" } }, "DelegationIds": { "base": null, "refs": { "BatchDeleteDelegationByAssessmentRequest$delegationIds": "<p> The identifiers for the delegations. </p>" } }, "DelegationMetadata": { "base": "<p> The metadata that's associated with the delegation. </p>", "refs": { "DelegationMetadataList$member": null } }, "DelegationMetadataList": { "base": null, "refs": { "GetDelegationsResponse$delegations": "<p> The list of delegations that the <code>GetDelegations</code> API returned. </p>" } }, "DelegationStatus": { "base": null, "refs": { "Delegation$status": "<p> The status of the delegation. </p>", "DelegationMetadata$status": "<p> The current status of the delegation. </p>" } }, "Delegations": { "base": null, "refs": { "AssessmentControlSet$delegations": "<p> The delegations that are associated with the control set. </p>", "AssessmentMetadata$delegations": "<p> The delegations that are associated with the assessment. </p>", "AssessmentMetadataItem$delegations": "<p> The delegations that are associated with the assessment. </p>", "BatchCreateDelegationByAssessmentResponse$delegations": "<p> The delegations that are associated with the assessment. </p>" } }, "DeleteAssessmentFrameworkRequest": { "base": null, "refs": { } }, "DeleteAssessmentFrameworkResponse": { "base": null, "refs": { } }, "DeleteAssessmentFrameworkShareRequest": { "base": null, "refs": { } }, "DeleteAssessmentFrameworkShareResponse": { "base": null, "refs": { } }, "DeleteAssessmentReportRequest": { "base": null, "refs": { } }, "DeleteAssessmentReportResponse": { "base": null, "refs": { } }, "DeleteAssessmentRequest": { "base": null, "refs": { } }, "DeleteAssessmentResponse": { "base": null, "refs": { } }, "DeleteControlRequest": { "base": null, "refs": { } }, "DeleteControlResponse": { "base": null, "refs": { } }, "DeleteResources": { "base": null, "refs": { "DeregistrationPolicy$deleteResources": "<p>Specifies which Audit Manager data will be deleted when you deregister Audit Manager.</p> <ul> <li> <p>If you set the value to <code>ALL</code>, all of your data is deleted within seven days of deregistration.</p> </li> <li> <p>If you set the value to <code>DEFAULT</code>, none of your data is deleted at the time of deregistration. However, keep in mind that the Audit Manager data retention policy still applies. As a result, any evidence data will be deleted two years after its creation date. Your other Audit Manager resources will continue to exist indefinitely.</p> </li> </ul>" } }, "DeregisterAccountRequest": { "base": null, "refs": { } }, "DeregisterAccountResponse": { "base": null, "refs": { } }, "DeregisterOrganizationAdminAccountRequest": { "base": null, "refs": { } }, "DeregisterOrganizationAdminAccountResponse": { "base": null, "refs": { } }, "DeregistrationPolicy": { "base": "<p>The deregistration policy for the data that's stored in Audit Manager. You can use this attribute to determine how your data is handled when you <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html\">deregister Audit Manager</a>.</p> <p>By default, Audit Manager retains evidence data for two years from the time of its creation. Other Audit Manager resources (including assessments, custom controls, and custom frameworks) remain in Audit Manager indefinitely, and are available if you <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html\">re-register Audit Manager</a> in the future. For more information about data retention, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/data-protection.html\">Data Protection</a> in the <i>Audit Manager User Guide</i>.</p> <important> <p>If you choose to delete all data, this action permanently deletes all evidence data in your account within seven days. It also deletes all of the Audit Manager resources that you created, including assessments, custom controls, and custom frameworks. Your data will not be available if you re-register Audit Manager in the future.</p> </important>", "refs": { "Settings$deregistrationPolicy": "<p>The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager.</p>", "UpdateSettingsRequest$deregistrationPolicy": "<p>The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager.</p>" } }, "DisassociateAssessmentReportEvidenceFolderRequest": { "base": null, "refs": { } }, "DisassociateAssessmentReportEvidenceFolderResponse": { "base": null, "refs": { } }, "EmailAddress": { "base": null, "refs": { "AWSAccount$emailAddress": "<p> The email address that's associated with the Amazon Web Services account. </p>" } }, "ErrorCode": { "base": null, "refs": { "AssessmentReportEvidenceError$errorCode": "<p> The error code that was returned. </p>", "BatchCreateDelegationByAssessmentError$errorCode": "<p> The error code that the <code>BatchCreateDelegationByAssessment</code> API returned. </p>", "BatchDeleteDelegationByAssessmentError$errorCode": "<p> The error code that the <code>BatchDeleteDelegationByAssessment</code> API returned. </p>", "BatchImportEvidenceToAssessmentControlError$errorCode": "<p> The error code that the <code>BatchImportEvidenceToAssessmentControl</code> API returned. </p>" } }, "ErrorMessage": { "base": null, "refs": { "AssessmentReportEvidenceError$errorMessage": "<p> The error message that was returned. </p>", "BatchCreateDelegationByAssessmentError$errorMessage": "<p> The error message that the <code>BatchCreateDelegationByAssessment</code> API returned. </p>", "BatchDeleteDelegationByAssessmentError$errorMessage": "<p> The error message that the <code>BatchDeleteDelegationByAssessment</code> API returned. </p>", "BatchImportEvidenceToAssessmentControlError$errorMessage": "<p> The error message that the <code>BatchImportEvidenceToAssessmentControl</code> API returned. </p>", "EvidenceFinderEnablement$error": "<p>Represents any errors that occurred when enabling or disabling evidence finder. </p>" } }, "EventName": { "base": null, "refs": { "Evidence$eventName": "<p> The name of the evidence event. </p>" } }, "Evidence": { "base": "<p> A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity invoked by a user, or a system configuration snapshot. </p>", "refs": { "EvidenceList$member": null, "GetEvidenceResponse$evidence": "<p> The evidence that the <code>GetEvidence</code> API returned. </p>" } }, "EvidenceAttributeKey": { "base": null, "refs": { "EvidenceAttributes$key": null } }, "EvidenceAttributeValue": { "base": null, "refs": { "EvidenceAttributes$value": null } }, "EvidenceAttributes": { "base": null, "refs": { "Evidence$attributes": "<p> The names and values that are used by the evidence event. This includes an attribute name (such as <code>allowUsersToChangePassword</code>) and value (such as <code>true</code> or <code>false</code>). </p>" } }, "EvidenceFinderBackfillStatus": { "base": null, "refs": { "EvidenceFinderEnablement$backfillStatus": "<p>The current status of the evidence data backfill process. </p> <p>The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that your evidence can be queried.</p> <ul> <li> <p> <code>NOT_STARTED</code> means that the backfill hasn’t started yet. </p> </li> <li> <p> <code>IN_PROGRESS</code> means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data. </p> </li> <li> <p> <code>COMPLETED</code> means that the backfill is complete. All of your past evidence is now queryable. </p> </li> </ul>" } }, "EvidenceFinderEnablement": { "base": "<p>The settings object that specifies whether evidence finder is enabled. This object also describes the related event data store, and the backfill status for populating the event data store with evidence data.</p>", "refs": { "Settings$evidenceFinderEnablement": "<p>The current evidence finder status and event data store details.</p>" } }, "EvidenceFinderEnablementStatus": { "base": null, "refs": { "EvidenceFinderEnablement$enablementStatus": "<p>The current status of the evidence finder feature and the related event data store. </p> <ul> <li> <p> <code>ENABLE_IN_PROGRESS</code> means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.</p> </li> <li> <p> <code>ENABLED</code> means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’ worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete.</p> </li> <li> <p> <code>DISABLE_IN_PROGRESS</code> means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.</p> </li> <li> <p> <code>DISABLED</code> means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point.</p> </li> </ul>" } }, "EvidenceIds": { "base": null, "refs": { "BatchAssociateAssessmentReportEvidenceRequest$evidenceIds": "<p> The list of evidence identifiers. </p>", "BatchAssociateAssessmentReportEvidenceResponse$evidenceIds": "<p> The list of evidence identifiers. </p>", "BatchDisassociateAssessmentReportEvidenceRequest$evidenceIds": "<p> The list of evidence identifiers. </p>", "BatchDisassociateAssessmentReportEvidenceResponse$evidenceIds": "<p> The identifier for the evidence. </p>" } }, "EvidenceInsights": { "base": "<p>A breakdown of the latest compliance check status for the evidence in your Audit Manager assessments. </p>", "refs": { "ControlDomainInsights$evidenceInsights": "<p>A breakdown of the compliance check status for the evidence that’s associated with the control domain. </p>", "ControlInsightsMetadataByAssessmentItem$evidenceInsights": "<p>A breakdown of the compliance check status for the evidence that’s associated with the assessment control. </p>", "ControlInsightsMetadataItem$evidenceInsights": "<p>A breakdown of the compliance check status for the evidence that’s associated with the control. </p>" } }, "EvidenceList": { "base": null, "refs": { "GetEvidenceByEvidenceFolderResponse$evidence": "<p> The list of evidence that the <code>GetEvidenceByEvidenceFolder</code> API returned. </p>" } }, "EvidenceSources": { "base": null, "refs": { "AssessmentControl$evidenceSources": "<p> The list of data sources for the evidence. </p>" } }, "ExportDestinationType": { "base": null, "refs": { "DefaultExportDestination$destinationType": "<p>The destination type, such as Amazon S3.</p>" } }, "Filename": { "base": null, "refs": { "AssessmentFrameworkMetadata$logo": "<p> The logo that's associated with the framework. </p>", "Framework$logo": "<p> The logo that's associated with the framework. </p>", "FrameworkMetadata$logo": "<p> The logo that's associated with the framework. </p>" } }, "Framework": { "base": "<p> The file that's used to structure and automate Audit Manager assessments for a given compliance standard. </p>", "refs": { "CreateAssessmentFrameworkResponse$framework": "<p> The name of the new framework that the <code>CreateAssessmentFramework</code> API returned. </p>", "GetAssessmentFrameworkResponse$framework": "<p> The framework that the <code>GetAssessmentFramework</code> API returned. </p>", "UpdateAssessmentFrameworkResponse$framework": "<p> The name of the framework. </p>" } }, "FrameworkDescription": { "base": null, "refs": { "AssessmentFrameworkMetadata$description": "<p> The description of the framework. </p>", "AssessmentFrameworkShareRequest$frameworkDescription": "<p>The description of the shared custom framework.</p>", "CreateAssessmentFrameworkRequest$description": "<p> An optional description for the new custom framework. </p>", "Framework$description": "<p> The description of the framework. </p>", "UpdateAssessmentFrameworkRequest$description": "<p> The description of the updated framework. </p>" } }, "FrameworkMetadata": { "base": "<p> The metadata of a framework, such as the name, ID, or description. </p>", "refs": { "AssessmentFramework$metadata": null } }, "FrameworkMetadataList": { "base": null, "refs": { "ListAssessmentFrameworksResponse$frameworkMetadataList": "<p> A list of metadata that the <code>ListAssessmentFrameworks</code> API returns for each framework.</p>" } }, "FrameworkName": { "base": null, "refs": { "AssessmentFrameworkMetadata$name": "<p> The name of the framework. </p>", "AssessmentFrameworkShareRequest$frameworkName": "<p> The name of the custom framework that the share request is for. </p>", "CreateAssessmentFrameworkRequest$name": "<p> The name of the new custom framework. </p>", "Framework$name": "<p> The name of the framework. </p>", "UpdateAssessmentFrameworkRequest$name": "<p> The name of the framework to be updated. </p>" } }, "FrameworkType": { "base": null, "refs": { "AssessmentFrameworkMetadata$type": "<p> The framework type, such as a standard framework or a custom framework. </p>", "Framework$type": "<p> Specifies whether the framework is a standard framework or a custom framework.</p>", "ListAssessmentFrameworksRequest$frameworkType": "<p> The type of framework, such as a standard framework or a custom framework. </p>" } }, "GenericArn": { "base": null, "refs": { "Resource$arn": "<p> The Amazon Resource Name (ARN) for the resource. </p>" } }, "GetAccountStatusRequest": { "base": null, "refs": { } }, "GetAccountStatusResponse": { "base": null, "refs": { } }, "GetAssessmentFrameworkRequest": { "base": null, "refs": { } }, "GetAssessmentFrameworkResponse": { "base": null, "refs": { } }, "GetAssessmentReportUrlRequest": { "base": null, "refs": { } }, "GetAssessmentReportUrlResponse": { "base": null, "refs": { } }, "GetAssessmentRequest": { "base": null, "refs": { } }, "GetAssessmentResponse": { "base": null, "refs": { } }, "GetChangeLogsRequest": { "base": null, "refs": { } }, "GetChangeLogsResponse": { "base": null, "refs": { } }, "GetControlRequest": { "base": null, "refs": { } }, "GetControlResponse": { "base": null, "refs": { } }, "GetDelegationsRequest": { "base": null, "refs": { } }, "GetDelegationsResponse": { "base": null, "refs": { } }, "GetEvidenceByEvidenceFolderRequest": { "base": null, "refs": { } }, "GetEvidenceByEvidenceFolderResponse": { "base": null, "refs": { } }, "GetEvidenceFileUploadUrlRequest": { "base": null, "refs": { } }, "GetEvidenceFileUploadUrlResponse": { "base": null, "refs": { } }, "GetEvidenceFolderRequest": { "base": null, "refs": { } }, "GetEvidenceFolderResponse": { "base": null, "refs": { } }, "GetEvidenceFoldersByAssessmentControlRequest": { "base": null, "refs": { } }, "GetEvidenceFoldersByAssessmentControlResponse": { "base": null, "refs": { } }, "GetEvidenceFoldersByAssessmentRequest": { "base": null, "refs": { } }, "GetEvidenceFoldersByAssessmentResponse": { "base": null, "refs": { } }, "GetEvidenceRequest": { "base": null, "refs": { } }, "GetEvidenceResponse": { "base": null, "refs": { } }, "GetInsightsByAssessmentRequest": { "base": null, "refs": { } }, "GetInsightsByAssessmentResponse": { "base": null, "refs": { } }, "GetInsightsRequest": { "base": null, "refs": { } }, "GetInsightsResponse": { "base": null, "refs": { } }, "GetOrganizationAdminAccountRequest": { "base": null, "refs": { } }, "GetOrganizationAdminAccountResponse": { "base": null, "refs": { } }, "GetServicesInScopeRequest": { "base": null, "refs": { } }, "GetServicesInScopeResponse": { "base": null, "refs": { } }, "GetSettingsRequest": { "base": null, "refs": { } }, "GetSettingsResponse": { "base": null, "refs": { } }, "HyperlinkName": { "base": null, "refs": { "URL$hyperlinkName": "<p> The name or word that's used as a hyperlink to the URL. </p>" } }, "IamArn": { "base": null, "refs": { "ChangeLog$createdBy": "<p> The user or role that performed the action. </p>", "CreateDelegationRequest$roleArn": "<p> The Amazon Resource Name (ARN) of the IAM role. </p>", "Delegation$roleArn": "<p> The Amazon Resource Name (ARN) of the IAM role. </p>", "DelegationMetadata$roleArn": "<p> The Amazon Resource Name (ARN) of the IAM role. </p>", "Evidence$iamId": "<p> The unique identifier for the user or role that's associated with the evidence. </p>", "Role$roleArn": "<p> The Amazon Resource Name (ARN) of the IAM role. </p>" } }, "Insights": { "base": "<p>A summary of the latest analytics data for all your active assessments. </p> <p>This summary is a snapshot of the data that your active assessments collected on the <code>lastUpdated</code> 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. </p> <p>The <code>Insights</code> data is eventually consistent. This means that, when you read data from <code>Insights</code>, 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.</p> <note> <p>If you delete an assessment or change its status to inactive, <code>InsightsByAssessment</code> includes data for that assessment as follows.</p> <ul> <li> <p> <b>Inactive assessments</b> - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the <code>InsightsByAssessment</code> counts for that day.</p> </li> <li> <p> <b>Deleted assessments</b> - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the <code>InsightsByAssessment</code> counts for that day.</p> </li> </ul> </note>", "refs": { "GetInsightsResponse$insights": "<p>The analytics data that the <code>GetInsights</code> API returned. </p>" } }, "InsightsByAssessment": { "base": "<p>A summary of the latest analytics data for a specific active assessment.</p> <p>This summary is a snapshot of the data that was collected on the <code>lastUpdated</code> date. It’s important to understand that the totals in <code>InsightsByAssessment</code> are daily counts based on this date — they aren’t a total sum to date. </p> <p>The <code>InsightsByAssessment</code> data is eventually consistent. This means that when you read data from <code>InsightsByAssessment</code>, 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.</p> <note> <p>If you delete an assessment or change its status to inactive, <code>InsightsByAssessment</code> includes data for that assessment as follows.</p> <ul> <li> <p> <b>Inactive assessments</b> - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the <code>InsightsByAssessment</code> counts for that day.</p> </li> <li> <p> <b>Deleted assessments</b> - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the <code>InsightsByAssessment</code> counts for that day.</p> </li> </ul> </note>", "refs": { "GetInsightsByAssessmentResponse$insights": "<p> The assessment analytics data that the <code>GetInsightsByAssessment</code> API returned. </p>" } }, "Integer": { "base": null, "refs": { "AssessmentControl$evidenceCount": "<p> The amount of evidence that's collected for the control. </p>", "AssessmentControl$assessmentReportEvidenceCount": "<p> The amount of evidence in the assessment report. </p>", "AssessmentControlSet$systemEvidenceCount": "<p> The total number of evidence objects that are retrieved automatically for the control set. </p>", "AssessmentControlSet$manualEvidenceCount": "<p> The total number of evidence objects that are uploaded manually to the control set. </p>", "AssessmentEvidenceFolder$totalEvidence": "<p> The total amount of evidence in the evidence folder. </p>", "AssessmentEvidenceFolder$assessmentReportSelectionCount": "<p> The total count of evidence that's included in the assessment report. </p>", "AssessmentEvidenceFolder$evidenceResourcesIncludedCount": "<p> The amount of evidence that's included in the evidence folder. </p>", "AssessmentEvidenceFolder$evidenceByTypeConfigurationDataCount": "<p> 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. </p>", "AssessmentEvidenceFolder$evidenceByTypeManualCount": "<p> The number of evidence that falls under the manual category. This evidence is imported manually. </p>", "AssessmentEvidenceFolder$evidenceByTypeComplianceCheckCount": "<p> The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub. </p>", "AssessmentEvidenceFolder$evidenceByTypeComplianceCheckIssuesCount": "<p> The total number of issues that were reported directly from Security Hub, Config, or both. </p>", "AssessmentEvidenceFolder$evidenceByTypeUserActivityCount": "<p> The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs. </p>", "AssessmentEvidenceFolder$evidenceAwsServiceSourceCount": "<p> The total number of Amazon Web Services resources that were assessed to generate the evidence. </p>" } }, "InternalServerException": { "base": "<p> An internal service error occurred during the processing of your request. Try again later. </p>", "refs": { } }, "KeywordInputType": { "base": null, "refs": { "SourceKeyword$keywordInputType": "<p> The input method for the keyword. </p> <ul> <li> <p> <code>SELECT_FROM_LIST</code> is used when mapping a data source for automated evidence.</p> <ul> <li> <p>When <code>keywordInputType</code> is <code>SELECT_FROM_LIST</code>, a keyword must be selected to collect automated evidence. For example, this keyword 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.</p> </li> </ul> </li> <li> <p> <code>UPLOAD_FILE</code> and <code>INPUT_TEXT</code> are only used when mapping a data source for manual evidence.</p> <ul> <li> <p>When <code>keywordInputType</code> is <code>UPLOAD_FILE</code>, a file must be uploaded as manual evidence.</p> </li> <li> <p>When <code>keywordInputType</code> is <code>INPUT_TEXT</code>, text must be entered as manual evidence.</p> </li> </ul> </li> </ul>" } }, "KeywordValue": { "base": null, "refs": { "Keywords$member": null, "SourceKeyword$keywordValue": "<p> 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. </p> <p>If you’re mapping a data source to a rule in Config, the <code>keywordValue</code> that you specify depends on the type of rule:</p> <ul> <li> <p>For <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">managed rules</a>, you can use the rule identifier as the <code>keywordValue</code>. You can find the rule identifier from the <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html\">list of Config managed rules</a>. For some rules, the rule identifier is different from the rule name. For example, the rule name <code>restricted-ssh</code> has the following rule identifier: <code>INCOMING_SSH_DISABLED</code>. Make sure to use the rule identifier, not the rule name. </p> <p>Keyword example for managed rules:</p> <ul> <li> <p>Managed rule name: <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html\">s3-bucket-acl-prohibited</a> </p> <p> <code>keywordValue</code>: <code>S3_BUCKET_ACL_PROHIBITED</code> </p> </li> </ul> </li> <li> <p>For <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html\">custom rules</a>, you form the <code>keywordValue</code> by adding the <code>Custom_</code> prefix to the rule name. This prefix distinguishes the custom rule from a managed rule. </p> <p>Keyword example for custom rules:</p> <ul> <li> <p>Custom rule name: my-custom-config-rule</p> <p> <code>keywordValue</code>: <code>Custom_my-custom-config-rule</code> </p> </li> </ul> </li> <li> <p>For <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html\">service-linked rules</a>, you form the <code>keywordValue</code> by adding the <code>Custom_</code> prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name. </p> <p>Keyword examples for service-linked rules:</p> <ul> <li> <p>Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w</p> <p> <code>keywordValue</code>: <code>Custom_CustomRuleForAccount-conformance-pack</code> </p> </li> <li> <p>Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba</p> <p> <code>keywordValue</code>: <code>Custom_OrgConfigRule-s3-bucket-versioning-enabled</code> </p> </li> </ul> </li> </ul> <important> <p>The <code>keywordValue</code> is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not successfully collect evidence from that data source as intended. </p> <p>Keep in mind the following requirements, depending on the data source type that you're using. </p> <ol> <li> <p>For Config: </p> <ul> <li> <p>For managed rules, make sure that the <code>keywordValue</code> is the rule identifier in <code>ALL_CAPS_WITH_UNDERSCORES</code>. For example, <code>CLOUDWATCH_LOG_GROUP_ENCRYPTED</code>. For accuracy, we recommend that you reference the list of <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html\">supported Config managed rules</a>.</p> </li> <li> <p>For custom rules, make sure that the <code>keywordValue</code> has the <code>Custom_</code> prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the <a href=\"https://console.aws.amazon.com/config/\">Config console</a> to verify your custom rule name.</p> </li> </ul> </li> <li> <p>For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html\">supported Security Hub controls</a>.</p> </li> <li> <p>For Amazon Web Services API calls: Make sure that the <code>keywordValue</code> is written as <code>serviceprefix_ActionName</code>. For example, <code>iam_ListGroups</code>. For accuracy, we recommend that you reference the list of <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html\">supported API calls</a>.</p> </li> <li> <p>For CloudTrail: Make sure that the <code>keywordValue</code> is written as <code>serviceprefix_ActionName</code>. For example, <code>cloudtrail_StartLogging</code>. For accuracy, we recommend that you review the Amazon Web Service prefix and action names in the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html\">Service Authorization Reference</a>.</p> </li> </ol> </important>" } }, "Keywords": { "base": null, "refs": { "ListKeywordsForDataSourceResponse$keywords": "<p>The list of keywords for the control mapping source.</p>" } }, "KmsKey": { "base": null, "refs": { "RegisterAccountRequest$kmsKey": "<p> The KMS key details. </p>", "Settings$kmsKey": "<p> The KMS key details. </p>", "UpdateSettingsRequest$kmsKey": "<p> The KMS key details. </p>" } }, "LastUpdatedBy": { "base": null, "refs": { "Control$lastUpdatedBy": "<p> The user or role that most recently updated the control. </p>", "Framework$lastUpdatedBy": "<p> The user or role that most recently updated the framework. </p>" } }, "ListAssessmentControlInsightsByControlDomainRequest": { "base": null, "refs": { } }, "ListAssessmentControlInsightsByControlDomainResponse": { "base": null, "refs": { } }, "ListAssessmentFrameworkShareRequestsRequest": { "base": null, "refs": { } }, "ListAssessmentFrameworkShareRequestsResponse": { "base": null, "refs": { } }, "ListAssessmentFrameworksRequest": { "base": null, "refs": { } }, "ListAssessmentFrameworksResponse": { "base": null, "refs": { } }, "ListAssessmentMetadata": { "base": null, "refs": { "ListAssessmentsResponse$assessmentMetadata": "<p>The metadata that the <code>ListAssessments</code> API returns for each assessment.</p>" } }, "ListAssessmentReportsRequest": { "base": null, "refs": { } }, "ListAssessmentReportsResponse": { "base": null, "refs": { } }, "ListAssessmentsRequest": { "base": null, "refs": { } }, "ListAssessmentsResponse": { "base": null, "refs": { } }, "ListControlDomainInsightsByAssessmentRequest": { "base": null, "refs": { } }, "ListControlDomainInsightsByAssessmentResponse": { "base": null, "refs": { } }, "ListControlDomainInsightsRequest": { "base": null, "refs": { } }, "ListControlDomainInsightsResponse": { "base": null, "refs": { } }, "ListControlInsightsByControlDomainRequest": { "base": null, "refs": { } }, "ListControlInsightsByControlDomainResponse": { "base": null, "refs": { } }, "ListControlsRequest": { "base": null, "refs": { } }, "ListControlsResponse": { "base": null, "refs": { } }, "ListKeywordsForDataSourceRequest": { "base": null, "refs": { } }, "ListKeywordsForDataSourceResponse": { "base": null, "refs": { } }, "ListNotificationsRequest": { "base": null, "refs": { } }, "ListNotificationsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ManualEvidence": { "base": "<p> Evidence that's manually added to a control in Audit Manager. <code>manualEvidence</code> can be one of the following: <code>evidenceFileName</code>, <code>s3ResourcePath</code>, or <code>textResponse</code>.</p>", "refs": { "BatchImportEvidenceToAssessmentControlError$manualEvidence": "<p> Manual evidence that can't be collected automatically by Audit Manager. </p>", "ManualEvidenceList$member": null } }, "ManualEvidenceList": { "base": null, "refs": { "BatchImportEvidenceToAssessmentControlRequest$manualEvidence": "<p> The list of manual evidence objects. </p>" } }, "ManualEvidenceLocalFileName": { "base": null, "refs": { "GetEvidenceFileUploadUrlRequest$fileName": "<p>The file that you want to upload. For a list of supported file formats, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files\">Supported file types for manual evidence</a> in the <i>Audit Manager User Guide</i>.</p>", "ManualEvidence$evidenceFileName": "<p>The name of the file that's uploaded as manual evidence. This name is populated using the <code>evidenceFileName</code> value from the <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetEvidenceFileUploadUrl.html\"> <code>GetEvidenceFileUploadUrl</code> </a> API response.</p>" } }, "ManualEvidenceTextResponse": { "base": null, "refs": { "ManualEvidence$textResponse": "<p>The plain text response that's entered and saved as manual evidence.</p>" } }, "MaxResults": { "base": "Max results in the page.", "refs": { "GetChangeLogsRequest$maxResults": "<p>Represents the maximum number of results on a page or for an API request call. </p>", "GetDelegationsRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "GetEvidenceByEvidenceFolderRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "GetEvidenceFoldersByAssessmentControlRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "GetEvidenceFoldersByAssessmentRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "ListAssessmentControlInsightsByControlDomainRequest$maxResults": "<p>Represents the maximum number of results on a page or for an API request call. </p>", "ListAssessmentFrameworkShareRequestsRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "ListAssessmentFrameworksRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "ListAssessmentReportsRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "ListAssessmentsRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "ListControlDomainInsightsByAssessmentRequest$maxResults": "<p>Represents the maximum number of results on a page or for an API request call. </p>", "ListControlDomainInsightsRequest$maxResults": "<p>Represents the maximum number of results on a page or for an API request call. </p>", "ListControlInsightsByControlDomainRequest$maxResults": "<p>Represents the maximum number of results on a page or for an API request call. </p>", "ListControlsRequest$maxResults": "<p>The maximum number of results on a page or for an API request call. </p>", "ListKeywordsForDataSourceRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>", "ListNotificationsRequest$maxResults": "<p> Represents the maximum number of results on a page or for an API request call. </p>" } }, "NonEmptyString": { "base": null, "refs": { "AssessmentControlSet$description": "<p> The description for the control set. </p>", "ChangeLog$objectName": "<p> The name of the object that changed. This could be the name of an assessment, control, or control set.</p>", "ControlInsightsMetadataByAssessmentItem$controlSetName": "<p>The name of the control set that the assessment control belongs to. </p>", "DelegationMetadata$controlSetName": "<p> Specifies the name of the control set that was delegated for review. </p>", "EvidenceSources$member": null, "GetEvidenceFileUploadUrlResponse$evidenceFileName": "<p>The name of the uploaded manual evidence file that the presigned URL was generated for.</p>", "GetEvidenceFileUploadUrlResponse$uploadUrl": "<p>The presigned URL that was generated.</p>", "Notification$controlSetName": "<p> Specifies the name of the control set that the notification is about. </p>", "Notification$description": "<p> The description of the notification. </p>", "Notification$source": "<p> The sender of the notification. </p>", "ServiceMetadata$displayName": "<p> The display name of the Amazon Web Service. </p>", "ServiceMetadata$description": "<p> The description of the Amazon Web Service. </p>", "ServiceMetadata$category": "<p> The category that the Amazon Web Service belongs to, such as compute, storage, or database. </p>", "ValidationErrors$member": null } }, "Notification": { "base": "<p> 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. </p>", "refs": { "Notifications$member": null } }, "Notifications": { "base": null, "refs": { "ListNotificationsResponse$notifications": "<p> The returned list of notifications. </p>" } }, "NullableInteger": { "base": null, "refs": { "AssessmentFrameworkShareRequest$standardControlsCount": "<p>The number of standard controls that are part of the shared custom framework. </p>", "AssessmentFrameworkShareRequest$customControlsCount": "<p>The number of custom controls that are part of the shared custom framework.</p>", "ControlDomainInsights$controlsCountByNoncompliantEvidence": "<p>The number of controls in the control domain that collected non-compliant evidence on the <code>lastUpdated</code> date. </p>", "ControlDomainInsights$totalControlsCount": "<p>The total number of controls in the control domain. </p>", "EvidenceInsights$noncompliantEvidenceCount": "<p>The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a <i>Fail</i> ruling, or collected from Config with a <i>Non-compliant</i> ruling. </p>", "EvidenceInsights$compliantEvidenceCount": "<p>The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a <i>Pass</i> ruling, or collected from Config with a <i>Compliant</i> ruling. </p>", "EvidenceInsights$inconclusiveEvidenceCount": "<p>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). </p> <note> <p>If evidence has a compliance check status of <i>not applicable</i> in the console, it's classified as <i>inconclusive</i> in <code>EvidenceInsights</code> data.</p> </note>", "Insights$activeAssessmentsCount": "<p>The number of active assessments in Audit Manager. </p>", "Insights$noncompliantEvidenceCount": "<p>The number of compliance check evidence that Audit Manager classified as non-compliant on the <code>lastUpdated</code> date. This includes evidence that was collected from Security Hub with a <i>Fail</i> ruling, or collected from Config with a <i>Non-compliant</i> ruling. </p>", "Insights$compliantEvidenceCount": "<p>The number of compliance check evidence that Audit Manager classified as compliant on the <code>lastUpdated</code> date. This includes evidence that was collected from Security Hub with a <i>Pass</i> ruling, or collected from Config with a <i>Compliant</i> ruling. </p>", "Insights$inconclusiveEvidenceCount": "<p>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). </p> <note> <p>If evidence has a compliance check status of <i>not applicable</i>, it's classed as <i>inconclusive</i> in <code>Insights</code> data.</p> </note>", "Insights$assessmentControlsCountByNoncompliantEvidence": "<p>The number of assessment controls that collected non-compliant evidence on the <code>lastUpdated</code> date. </p>", "Insights$totalAssessmentControlsCount": "<p>The total number of controls across all active assessments. </p>", "InsightsByAssessment$noncompliantEvidenceCount": "<p>The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a <i>Fail</i> ruling, or collected from Config with a <i>Non-compliant</i> ruling. </p>", "InsightsByAssessment$compliantEvidenceCount": "<p>The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a <i>Pass</i> ruling, or collected from Config with a <i>Compliant</i> ruling. </p>", "InsightsByAssessment$inconclusiveEvidenceCount": "<p>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). </p> <note> <p>If evidence has a compliance check status of <i>not applicable</i>, it's classified as <i>inconclusive</i> in <code>InsightsByAssessment</code> data.</p> </note>", "InsightsByAssessment$assessmentControlsCountByNoncompliantEvidence": "<p>The number of assessment controls that collected non-compliant evidence on the <code>lastUpdated</code> date. </p>", "InsightsByAssessment$totalAssessmentControlsCount": "<p>The total number of controls in the assessment. </p>" } }, "ObjectTypeEnum": { "base": null, "refs": { "ChangeLog$objectType": "<p> The object that was changed, such as an assessment, control, or control set. </p>" } }, "QueryStatement": { "base": null, "refs": { "CreateAssessmentReportRequest$queryStatement": "<p>A SQL statement that represents an evidence finder query.</p> <p>Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence\">added to a report using the console</a>, or <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html\">associated with a report using the API</a>. </p> <p>To use this parameter, the <a href=\"https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus\">enablementStatus</a> of evidence finder must be <code>ENABLED</code>. </p> <p> For examples and help resolving <code>queryStatement</code> validation exceptions, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions\">Troubleshooting evidence finder issues</a> in the <i>Audit Manager User Guide.</i> </p>" } }, "Region": { "base": null, "refs": { "AssessmentFrameworkShareRequest$destinationRegion": "<p> The Amazon Web Services Region of the recipient. </p>", "StartAssessmentFrameworkShareRequest$destinationRegion": "<p> The Amazon Web Services Region of the recipient. </p>" } }, "RegisterAccountRequest": { "base": null, "refs": { } }, "RegisterAccountResponse": { "base": null, "refs": { } }, "RegisterOrganizationAdminAccountRequest": { "base": null, "refs": { } }, "RegisterOrganizationAdminAccountResponse": { "base": null, "refs": { } }, "Resource": { "base": "<p> A system asset that's evaluated in an Audit Manager assessment. </p>", "refs": { "Resources$member": null } }, "ResourceNotFoundException": { "base": "<p> The resource that's specified in the request can't be found. </p>", "refs": { } }, "Resources": { "base": null, "refs": { "Evidence$resourcesIncluded": "<p> The list of resources that are assessed to generate the evidence. </p>" } }, "Role": { "base": "<p> The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN). </p>", "refs": { "GetAssessmentResponse$userRole": null, "Roles$member": null } }, "RoleType": { "base": null, "refs": { "CreateDelegationRequest$roleType": "<p> The type of customer persona. </p> <note> <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>. </p> <p>In <code>UpdateSettings</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>.</p> <p>In <code>BatchCreateDelegationByAssessment</code>, <code>roleType</code> can only be <code>RESOURCE_OWNER</code>.</p> </note>", "Delegation$roleType": "<p> The type of customer persona. </p> <note> <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>. </p> <p>In <code>UpdateSettings</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>.</p> <p>In <code>BatchCreateDelegationByAssessment</code>, <code>roleType</code> can only be <code>RESOURCE_OWNER</code>.</p> </note>", "Role$roleType": "<p> The type of customer persona. </p> <note> <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>. </p> <p>In <code>UpdateSettings</code>, <code>roleType</code> can only be <code>PROCESS_OWNER</code>.</p> <p>In <code>BatchCreateDelegationByAssessment</code>, <code>roleType</code> can only be <code>RESOURCE_OWNER</code>.</p> </note>" } }, "Roles": { "base": null, "refs": { "AssessmentControlSet$roles": "<p> The roles that are associated with the control set. </p>", "AssessmentMetadata$roles": "<p> The roles that are associated with the assessment. </p>", "AssessmentMetadataItem$roles": "<p> The roles that are associated with the assessment. </p>", "CreateAssessmentRequest$roles": "<p> The list of roles for the assessment. </p>", "Settings$defaultProcessOwners": "<p> The designated default audit owners. </p>", "UpdateAssessmentRequest$roles": "<p> The list of roles for the assessment. </p>", "UpdateSettingsRequest$defaultProcessOwners": "<p> A list of the default audit owners. </p>" } }, "S3Url": { "base": null, "refs": { "AssessmentReportsDestination$destination": "<p> The destination bucket where Audit Manager stores assessment reports. </p>", "DefaultExportDestination$destination": "<p>The destination bucket where Audit Manager stores exported files.</p>", "ManualEvidence$s3ResourcePath": "<p>The S3 URL of the object that's imported as manual evidence. </p>", "ValidateAssessmentReportIntegrityRequest$s3RelativePath": "<p> The relative path of the Amazon S3 bucket that the assessment report is stored in. </p>" } }, "SNSTopic": { "base": null, "refs": { "Settings$snsTopic": "<p> The designated Amazon Simple Notification Service (Amazon SNS) topic. </p>" } }, "Scope": { "base": "<p> The wrapper that contains the Amazon Web Services accounts that are in scope for the assessment. </p> <note> <p>You no longer need to specify which Amazon Web Services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services. </p> <p>If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment.</p> </note>", "refs": { "AssessmentMetadata$scope": "<p> The wrapper of Amazon Web Services accounts and services that are in scope for the assessment. </p>", "CreateAssessmentRequest$scope": null, "UpdateAssessmentRequest$scope": "<p> The scope of the assessment. </p>" } }, "ServiceMetadata": { "base": "<p> The metadata that's associated with the Amazon Web Service. </p>", "refs": { "ServiceMetadataList$member": null } }, "ServiceMetadataList": { "base": null, "refs": { "GetServicesInScopeResponse$serviceMetadata": "<p> The metadata that's associated with the Amazon Web Service. </p>" } }, "ServiceQuotaExceededException": { "base": "<p>You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">request a quota increase</a> from the Service Quotas console. For a list of Audit Manager service quotas, see <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html\">Quotas and restrictions for Audit Manager</a>.</p>", "refs": { } }, "SettingAttribute": { "base": null, "refs": { "GetSettingsRequest$attribute": "<p> The list of setting attribute enum values. </p>" } }, "Settings": { "base": "<p> The settings object that holds all supported Audit Manager settings. </p>", "refs": { "GetSettingsResponse$settings": "<p> The settings object that holds all supported Audit Manager settings. </p>", "UpdateSettingsResponse$settings": "<p> The current list of settings. </p>" } }, "ShareRequestAction": { "base": null, "refs": { "UpdateAssessmentFrameworkShareRequest$action": "<p>Specifies the update action for the share request.</p>" } }, "ShareRequestComment": { "base": null, "refs": { "AssessmentFrameworkShareRequest$comment": "<p> An optional comment from the sender about the share request. </p>", "StartAssessmentFrameworkShareRequest$comment": "<p> An optional comment from the sender about the share request. </p>" } }, "ShareRequestStatus": { "base": null, "refs": { "AssessmentFrameworkShareRequest$status": "<p> The status of the share request. </p>" } }, "ShareRequestType": { "base": null, "refs": { "DeleteAssessmentFrameworkShareRequest$requestType": "<p>Specifies whether the share request is a sent request or a received request.</p>", "ListAssessmentFrameworkShareRequestsRequest$requestType": "<p> Specifies whether the share request is a sent request or a received request.</p>", "UpdateAssessmentFrameworkShareRequest$requestType": "<p>Specifies whether the share request is a sent request or a received request.</p>" } }, "SnsArn": { "base": null, "refs": { "UpdateSettingsRequest$snsTopic": "<p> The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to. </p>" } }, "SourceDescription": { "base": null, "refs": { "ControlMappingSource$sourceDescription": "<p> The description of the source. </p>", "CreateControlMappingSource$sourceDescription": "<p> The description of the data source that determines where Audit Manager collects evidence from for the control. </p>" } }, "SourceFrequency": { "base": null, "refs": { "ControlMappingSource$sourceFrequency": "<p>Specifies how often evidence is collected from the control mapping source. </p>", "CreateControlMappingSource$sourceFrequency": "<p>Specifies how often evidence is collected from the control mapping source. </p>" } }, "SourceKeyword": { "base": "<p>A keyword that relates to the control data source.</p> <p>For manual evidence, this keyword indicates if the manual evidence is a file or text.</p> <p>For automated evidence, this keyword identifies a specific CloudTrail event, Config rule, Security Hub control, or Amazon Web Services API name. </p> <p> To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the <i>Audit Manager User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-config.html\">Config rules supported by Audit Manager</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-ash.html\">Security Hub controls supported by Audit Manager</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-api.html\">API calls supported by Audit Manager</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources-cloudtrail.html\">CloudTrail event names supported by Audit Manager</a> </p> </li> </ul>", "refs": { "ControlMappingSource$sourceKeyword": null, "CreateControlMappingSource$sourceKeyword": null } }, "SourceName": { "base": null, "refs": { "ControlMappingSource$sourceName": "<p> The name of the source. </p>", "CreateControlMappingSource$sourceName": "<p> The name of the control mapping data source. </p>" } }, "SourceSetUpOption": { "base": null, "refs": { "ControlMappingSource$sourceSetUpOption": "<p>The setup option for the data source. This option reflects if the evidence collection method is automated or manual. If you don’t provide a value for <code>sourceSetUpOption</code>, Audit Manager automatically infers and populates the correct value based on the <code>sourceType</code> that you specify.</p>", "CreateControlMappingSource$sourceSetUpOption": "<p>The setup option for the data source. This option reflects if the evidence collection method is automated or manual. If you don’t provide a value for <code>sourceSetUpOption</code>, Audit Manager automatically infers and populates the correct value based on the <code>sourceType</code> that you specify.</p>" } }, "SourceType": { "base": null, "refs": { "ControlMappingSource$sourceType": "<p> Specifies which type of data source is used to collect evidence. </p> <ul> <li> <p>The source can be an individual data source type, such as <code>AWS_Cloudtrail</code>, <code>AWS_Config</code>, <code>AWS_Security_Hub</code>, <code>AWS_API_Call</code>, or <code>MANUAL</code>. </p> </li> <li> <p>The source can also be a managed grouping of data sources, such as a <code>Core_Control</code> or a <code>Common_Control</code>.</p> </li> </ul>", "CreateControlMappingSource$sourceType": "<p> Specifies which type of data source is used to collect evidence. </p> <ul> <li> <p>The source can be an individual data source type, such as <code>AWS_Cloudtrail</code>, <code>AWS_Config</code>, <code>AWS_Security_Hub</code>, <code>AWS_API_Call</code>, or <code>MANUAL</code>. </p> </li> <li> <p>The source can also be a managed grouping of data sources, such as a <code>Core_Control</code> or a <code>Common_Control</code>.</p> </li> </ul>" } }, "StartAssessmentFrameworkShareRequest": { "base": null, "refs": { } }, "StartAssessmentFrameworkShareResponse": { "base": null, "refs": { } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "AssessmentEvidenceFolder$dataSource": "<p> The Amazon Web Service that the evidence was collected from. </p>", "AssessmentEvidenceFolder$author": "<p> The name of the user who created the evidence folder. </p>", "ControlDomainInsights$name": "<p>The name of the control domain. </p>", "ControlInsightsMetadataByAssessmentItem$name": "<p>The name of the assessment control. </p>", "ControlInsightsMetadataItem$name": "<p>The name of the control. </p>", "Evidence$dataSource": "<p> The data source where the evidence was collected from. </p>", "Evidence$evidenceByType": "<p> The type of automated evidence. </p>", "Evidence$complianceCheck": "<p>The evaluation status for automated evidence that falls under the compliance check category.</p> <ul> <li> <p>Audit Manager classes evidence as non-compliant if Security Hub reports a <i>Fail</i> result, or if Config reports a <i>Non-compliant</i> result.</p> </li> <li> <p>Audit Manager classes evidence as compliant if Security Hub reports a <i>Pass</i> result, or if Config reports a <i>Compliant</i> result.</p> </li> <li> <p>If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). </p> </li> </ul>", "Evidence$awsOrganization": "<p> The Amazon Web Services account that the evidence is collected from, and its organization path. </p>", "Evidence$assessmentReportSelection": "<p> Specifies whether the evidence is included in the assessment report. </p>", "InternalServerException$message": null, "Resource$value": "<p> The value of the resource. </p>", "Resource$complianceCheck": "<p> The evaluation status for a resource that was assessed when collecting compliance check evidence. </p> <ul> <li> <p>Audit Manager classes the resource as non-compliant if Security Hub reports a <i>Fail</i> result, or if Config reports a <i>Non-compliant</i> result.</p> </li> <li> <p>Audit Manager classes the resource as compliant if Security Hub reports a <i>Pass</i> result, or if Config reports a <i>Compliant</i> result.</p> </li> <li> <p>If a compliance check isn't available or applicable, then no compliance evaluation can be made for that resource. This is the case if a resource assessment uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the resource assessment uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail). </p> </li> </ul>", "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "<p> The unique identifier for the resource. </p>", "ResourceNotFoundException$resourceType": "<p> The type of resource that's affected by the error. </p>", "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "UpdateAssessmentControlSetStatusRequest$controlSetId": "<p> The unique identifier for the control set. </p>", "ValidateAssessmentReportIntegrityResponse$signatureAlgorithm": "<p> The signature algorithm that's used to code sign the assessment report file. </p>", "ValidateAssessmentReportIntegrityResponse$signatureDateTime": "<p> The date and time signature that specifies when the assessment report was created. </p>", "ValidateAssessmentReportIntegrityResponse$signatureKeyId": "<p> The unique identifier for the validation signature key. </p>", "ValidationException$message": null, "ValidationExceptionField$name": "<p> The name of the validation error. </p>", "ValidationExceptionField$message": "<p> The body of the error message. </p>" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "<p> The name or key of the tag. </p>" } }, "TagMap": { "base": null, "refs": { "Assessment$tags": "<p> The tags that are associated with the assessment. </p>", "Control$tags": "<p> The tags associated with the control. </p>", "CreateAssessmentFrameworkRequest$tags": "<p> The tags that are associated with the framework. </p>", "CreateAssessmentRequest$tags": "<p> The tags that are associated with the assessment. </p>", "CreateControlRequest$tags": "<p> The tags that are associated with the control. </p>", "Framework$tags": "<p> The tags that are associated with the framework. </p>", "ListTagsForResourceResponse$tags": "<p> The list of tags that the <code>ListTagsForResource</code> API returned. </p>", "TagResourceRequest$tags": "<p> The tags that are associated with the resource. </p>" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "TestingInformation": { "base": null, "refs": { "Control$testingInformation": "<p> The steps that you should follow to determine if the control has been satisfied. </p>", "CreateControlRequest$testingInformation": "<p> The steps to follow to determine if the control is satisfied. </p>", "UpdateControlRequest$testingInformation": "<p> The steps that you should follow to determine if the control is met. </p>" } }, "ThrottlingException": { "base": "<p>The request was denied due to request throttling.</p>", "refs": { } }, "Timestamp": { "base": null, "refs": { "AssessmentEvidenceFolder$date": "<p> The date when the first evidence was added to the evidence folder. </p>", "AssessmentFrameworkMetadata$createdAt": "<p> The time when the framework was created. </p>", "AssessmentFrameworkMetadata$lastUpdatedAt": "<p> The time when the framework was most recently updated. </p>", "AssessmentFrameworkShareRequest$expirationTime": "<p> The time when the share request expires. </p>", "AssessmentFrameworkShareRequest$creationTime": "<p> The time when the share request was created. </p>", "AssessmentFrameworkShareRequest$lastUpdated": "<p> Specifies when the share request was last updated. </p>", "AssessmentMetadata$creationTime": "<p> Specifies when the assessment was created. </p>", "AssessmentMetadata$lastUpdated": "<p> The time of the most recent update. </p>", "AssessmentMetadataItem$creationTime": "<p> Specifies when the assessment was created. </p>", "AssessmentMetadataItem$lastUpdated": "<p> The time of the most recent update. </p>", "AssessmentReport$creationTime": "<p> Specifies when the assessment report was created. </p>", "AssessmentReportMetadata$creationTime": "<p> Specifies when the assessment report was created. </p>", "ChangeLog$createdAt": "<p> The time when the action was performed and the changelog record was created. </p>", "Control$createdAt": "<p> The time when the control was created. </p>", "Control$lastUpdatedAt": "<p> The time when the control was most recently updated. </p>", "ControlComment$postedDate": "<p> The time when the comment was posted. </p>", "ControlDomainInsights$lastUpdated": "<p>The time when the control domain insights were last updated. </p>", "ControlInsightsMetadataByAssessmentItem$lastUpdated": "<p>The time when the assessment control insights were last updated. </p>", "ControlInsightsMetadataItem$lastUpdated": "<p>The time when the control insights were last updated. </p>", "ControlMetadata$createdAt": "<p> The time when the control was created. </p>", "ControlMetadata$lastUpdatedAt": "<p> The time when the control was most recently updated. </p>", "Delegation$creationTime": "<p> Specifies when the delegation was created. </p>", "Delegation$lastUpdated": "<p> Specifies when the delegation was last updated. </p>", "DelegationMetadata$creationTime": "<p> Specifies when the delegation was created. </p>", "Evidence$time": "<p> The timestamp that represents when the evidence was collected. </p>", "Framework$createdAt": "<p> The time when the framework was created. </p>", "Framework$lastUpdatedAt": "<p> The time when the framework was most recently updated. </p>", "Insights$lastUpdated": "<p>The time when the cross-assessment insights were last updated. </p>", "InsightsByAssessment$lastUpdated": "<p>The time when the assessment insights were last updated.</p>", "Notification$eventTime": "<p> The time when the notification was sent. </p>" } }, "TimestampUUID": { "base": null, "refs": { "Notification$id": "<p> The unique identifier for the notification. </p>" } }, "Token": { "base": null, "refs": { "GetChangeLogsRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetChangeLogsResponse$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "GetDelegationsRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetDelegationsResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetEvidenceByEvidenceFolderRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetEvidenceByEvidenceFolderResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetEvidenceFoldersByAssessmentControlRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetEvidenceFoldersByAssessmentControlResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetEvidenceFoldersByAssessmentRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "GetEvidenceFoldersByAssessmentResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentControlInsightsByControlDomainRequest$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentControlInsightsByControlDomainResponse$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentFrameworkShareRequestsRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentFrameworkShareRequestsResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentFrameworksRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentFrameworksResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentReportsRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentReportsResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentsRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListAssessmentsResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListControlDomainInsightsByAssessmentRequest$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListControlDomainInsightsByAssessmentResponse$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListControlDomainInsightsRequest$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListControlDomainInsightsResponse$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListControlInsightsByControlDomainRequest$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListControlInsightsByControlDomainResponse$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListControlsRequest$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListControlsResponse$nextToken": "<p>The pagination token that's used to fetch the next set of results. </p>", "ListKeywordsForDataSourceRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListKeywordsForDataSourceResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListNotificationsRequest$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>", "ListNotificationsResponse$nextToken": "<p> The pagination token that's used to fetch the next set of results. </p>" } }, "TroubleshootingText": { "base": null, "refs": { "ControlMappingSource$troubleshootingText": "<p> The instructions for troubleshooting the control. </p>", "CreateControlMappingSource$troubleshootingText": "<p> The instructions for troubleshooting the control. </p>" } }, "URL": { "base": "<p> Short for uniform resource locator. A URL is used as a unique identifier to locate a resource on the internet. </p>", "refs": { "GetAssessmentReportUrlResponse$preSignedUrl": null } }, "UUID": { "base": null, "refs": { "AssessmentControl$id": "<p> The identifier for the control. </p>", "AssessmentEvidenceFolder$assessmentId": "<p> The identifier for the assessment. </p>", "AssessmentEvidenceFolder$controlId": "<p> The unique identifier for the control. </p>", "AssessmentEvidenceFolder$id": "<p> The identifier for the folder that the evidence is stored in. </p>", "AssessmentFramework$id": "<p> The unique identifier for the framework. </p>", "AssessmentFrameworkMetadata$id": "<p> The unique identifier for the framework. </p>", "AssessmentFrameworkShareRequest$id": "<p> The unique identifier for the share request. </p>", "AssessmentFrameworkShareRequest$frameworkId": "<p>The unique identifier for the shared custom framework. </p>", "AssessmentMetadata$id": "<p> The unique identifier for the assessment. </p>", "AssessmentMetadataItem$id": "<p> The unique identifier for the assessment. </p>", "AssessmentReport$id": "<p> The unique identifier for the assessment report. </p>", "AssessmentReport$assessmentId": "<p> The identifier for the specified assessment. </p>", "AssessmentReportEvidenceError$evidenceId": "<p> The identifier for the evidence. </p>", "AssessmentReportMetadata$id": "<p> The unique identifier for the assessment report. </p>", "AssessmentReportMetadata$assessmentId": "<p> The unique identifier for the associated assessment. </p>", "AssociateAssessmentReportEvidenceFolderRequest$assessmentId": "<p> The identifier for the assessment. </p>", "AssociateAssessmentReportEvidenceFolderRequest$evidenceFolderId": "<p> The identifier for the folder that the evidence is stored in. </p>", "BatchAssociateAssessmentReportEvidenceRequest$assessmentId": "<p> The identifier for the assessment. </p>", "BatchAssociateAssessmentReportEvidenceRequest$evidenceFolderId": "<p> The identifier for the folder that the evidence is stored in. </p>", "BatchCreateDelegationByAssessmentRequest$assessmentId": "<p> The identifier for the assessment. </p>", "BatchDeleteDelegationByAssessmentError$delegationId": "<p> The identifier for the delegation. </p>", "BatchDeleteDelegationByAssessmentRequest$assessmentId": "<p> The identifier for the assessment. </p>", "BatchDisassociateAssessmentReportEvidenceRequest$assessmentId": "<p> The identifier for the assessment. </p>", "BatchDisassociateAssessmentReportEvidenceRequest$evidenceFolderId": "<p> The identifier for the folder that the evidence is stored in. </p>", "BatchImportEvidenceToAssessmentControlRequest$assessmentId": "<p> The identifier for the assessment. </p>", "BatchImportEvidenceToAssessmentControlRequest$controlId": "<p> The identifier for the control. </p>", "Control$id": "<p> The unique identifier for the control. </p>", "ControlMappingSource$sourceId": "<p> The unique identifier for the source. </p>", "ControlMetadata$id": "<p> The unique identifier for the control. </p>", "ControlSet$id": "<p> The identifier of the control set in the assessment. This is the control set name in a plain string format. </p>", "CreateAssessmentFrameworkControl$id": "<p> The unique identifier of the control. </p>", "CreateAssessmentReportRequest$assessmentId": "<p> The identifier for the assessment. </p>", "CreateAssessmentRequest$frameworkId": "<p> The identifier for the framework that the assessment will be created from. </p>", "Delegation$id": "<p> The unique identifier for the delegation. </p>", "Delegation$assessmentId": "<p> The identifier for the assessment that's associated with the delegation. </p>", "DelegationIds$member": null, "DelegationMetadata$id": "<p> The unique identifier for the delegation. </p>", "DelegationMetadata$assessmentId": "<p> The unique identifier for the assessment. </p>", "DeleteAssessmentFrameworkRequest$frameworkId": "<p> The identifier for the custom framework. </p>", "DeleteAssessmentFrameworkShareRequest$requestId": "<p>The unique identifier for the share request to be deleted.</p>", "DeleteAssessmentReportRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "DeleteAssessmentReportRequest$assessmentReportId": "<p> The unique identifier for the assessment report. </p>", "DeleteAssessmentRequest$assessmentId": "<p> The identifier for the assessment. </p>", "DeleteControlRequest$controlId": "<p> The unique identifier for the control. </p>", "DisassociateAssessmentReportEvidenceFolderRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "DisassociateAssessmentReportEvidenceFolderRequest$evidenceFolderId": "<p> The unique identifier for the folder that the evidence is stored in. </p>", "Evidence$evidenceFolderId": "<p> The identifier for the folder that the evidence is stored in. </p>", "Evidence$id": "<p> The identifier for the evidence. </p>", "EvidenceIds$member": null, "Framework$id": "<p> The unique identifier for the framework. </p>", "GetAssessmentFrameworkRequest$frameworkId": "<p> The identifier for the framework. </p>", "GetAssessmentReportUrlRequest$assessmentReportId": "<p> The unique identifier for the assessment report. </p>", "GetAssessmentReportUrlRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "GetAssessmentRequest$assessmentId": "<p>The unique identifier for the assessment. </p>", "GetChangeLogsRequest$assessmentId": "<p>The unique identifier for the assessment. </p>", "GetChangeLogsRequest$controlId": "<p> The unique identifier for the control. </p>", "GetControlRequest$controlId": "<p> The identifier for the control. </p>", "GetEvidenceByEvidenceFolderRequest$assessmentId": "<p> The identifier for the assessment. </p>", "GetEvidenceByEvidenceFolderRequest$evidenceFolderId": "<p> The unique identifier for the folder that the evidence is stored in. </p>", "GetEvidenceFolderRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "GetEvidenceFolderRequest$evidenceFolderId": "<p> The unique identifier for the folder that the evidence is stored in. </p>", "GetEvidenceFoldersByAssessmentControlRequest$assessmentId": "<p> The identifier for the assessment. </p>", "GetEvidenceFoldersByAssessmentControlRequest$controlId": "<p> The identifier for the control. </p>", "GetEvidenceFoldersByAssessmentRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "GetEvidenceRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "GetEvidenceRequest$evidenceFolderId": "<p> The unique identifier for the folder that the evidence is stored in. </p>", "GetEvidenceRequest$evidenceId": "<p> The unique identifier for the evidence. </p>", "GetInsightsByAssessmentRequest$assessmentId": "<p>The unique identifier for the assessment. </p>", "ListAssessmentControlInsightsByControlDomainRequest$assessmentId": "<p>The unique identifier for the active assessment. </p>", "ListControlDomainInsightsByAssessmentRequest$assessmentId": "<p>The unique identifier for the active assessment. </p>", "Notification$assessmentId": "<p> The identifier for the assessment. </p>", "StartAssessmentFrameworkShareRequest$frameworkId": "<p> The unique identifier for the custom framework to be shared. </p>", "UpdateAssessmentControlRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "UpdateAssessmentControlRequest$controlId": "<p> The unique identifier for the control. </p>", "UpdateAssessmentControlSetStatusRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "UpdateAssessmentFrameworkRequest$frameworkId": "<p> The unique identifier for the framework. </p>", "UpdateAssessmentFrameworkShareRequest$requestId": "<p> The unique identifier for the share request. </p>", "UpdateAssessmentRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "UpdateAssessmentStatusRequest$assessmentId": "<p> The unique identifier for the assessment. </p>", "UpdateControlRequest$controlId": "<p> The identifier for the control. </p>" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateAssessmentControlRequest": { "base": null, "refs": { } }, "UpdateAssessmentControlResponse": { "base": null, "refs": { } }, "UpdateAssessmentControlSetStatusRequest": { "base": null, "refs": { } }, "UpdateAssessmentControlSetStatusResponse": { "base": null, "refs": { } }, "UpdateAssessmentFrameworkControlSet": { "base": "<p> A <code>controlSet</code> entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID. </p>", "refs": { "UpdateAssessmentFrameworkControlSets$member": null } }, "UpdateAssessmentFrameworkControlSets": { "base": null, "refs": { "UpdateAssessmentFrameworkRequest$controlSets": "<p> The control sets that are associated with the framework. </p>" } }, "UpdateAssessmentFrameworkRequest": { "base": null, "refs": { } }, "UpdateAssessmentFrameworkResponse": { "base": null, "refs": { } }, "UpdateAssessmentFrameworkShareRequest": { "base": null, "refs": { } }, "UpdateAssessmentFrameworkShareResponse": { "base": null, "refs": { } }, "UpdateAssessmentRequest": { "base": null, "refs": { } }, "UpdateAssessmentResponse": { "base": null, "refs": { } }, "UpdateAssessmentStatusRequest": { "base": null, "refs": { } }, "UpdateAssessmentStatusResponse": { "base": null, "refs": { } }, "UpdateControlRequest": { "base": null, "refs": { } }, "UpdateControlResponse": { "base": null, "refs": { } }, "UpdateSettingsRequest": { "base": null, "refs": { } }, "UpdateSettingsResponse": { "base": null, "refs": { } }, "UrlLink": { "base": null, "refs": { "URL$link": "<p> The unique identifier for the internet resource. </p>" } }, "Username": { "base": null, "refs": { "AssessmentReport$author": "<p> The name of the user who created the assessment report. </p>", "AssessmentReportMetadata$author": "<p> The name of the user who created the assessment report. </p>", "ControlComment$authorName": "<p> The name of the user who authored the comment. </p>" } }, "ValidateAssessmentReportIntegrityRequest": { "base": null, "refs": { } }, "ValidateAssessmentReportIntegrityResponse": { "base": null, "refs": { } }, "ValidationErrors": { "base": null, "refs": { "ValidateAssessmentReportIntegrityResponse$validationErrors": "<p> Represents any errors that occurred when validating the assessment report. </p>" } }, "ValidationException": { "base": "<p> The request has invalid or missing parameters. </p>", "refs": { } }, "ValidationExceptionField": { "base": "<p> Indicates that the request has invalid or missing parameters for the field. </p>", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fields": "<p> The fields that caused the error, if applicable. </p>" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "<p> The reason the request failed validation. </p>" } }, "organizationId": { "base": null, "refs": { "GetOrganizationAdminAccountResponse$organizationId": "<p> The identifier for the organization. </p>", "RegisterOrganizationAdminAccountResponse$organizationId": "<p> The identifier for the organization. </p>" } } } }	145.28 KB	2025-05-25 12:27
📄 endpoint-rule-set-1.json { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "Boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "Boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://auditmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://auditmanager-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://auditmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://auditmanager.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }	13.43 KB	2025-05-25 12:27
📄 endpoint-tests-1.json { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://auditmanager.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://auditmanager.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://auditmanager.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", "expect": { "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://auditmanager.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" }	14.99 KB	2025-05-25 12:27
📄 examples-1.json { "version": "1.0", "examples": { } }	44 B	2025-05-25 12:27
📄 paginators-1.json { "pagination": { "GetChangeLogs": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "GetDelegations": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "GetEvidenceByEvidenceFolder": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "GetEvidenceFoldersByAssessment": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "GetEvidenceFoldersByAssessmentControl": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListAssessmentControlInsightsByControlDomain": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListAssessmentFrameworkShareRequests": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListAssessmentFrameworks": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListAssessmentReports": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListAssessments": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListControlDomainInsights": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListControlDomainInsightsByAssessment": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListControlInsightsByControlDomain": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListControls": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListKeywordsForDataSource": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" }, "ListNotifications": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults" } } }	2.27 KB	2025-05-25 12:27

Terminal