Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AuditManager.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AssociateAssessmentReportEvidenceFolder

associateAssessmentReportEvidenceFolder_assessmentId :: Lens' AssociateAssessmentReportEvidenceFolder Text Source #

The identifier for the assessment.

associateAssessmentReportEvidenceFolder_evidenceFolderId :: Lens' AssociateAssessmentReportEvidenceFolder Text Source #

The identifier for the folder that the evidence is stored in.

associateAssessmentReportEvidenceFolderResponse_httpStatus :: Lens' AssociateAssessmentReportEvidenceFolderResponse Int Source #

The response's http status code.

BatchAssociateAssessmentReportEvidence

batchAssociateAssessmentReportEvidence_assessmentId :: Lens' BatchAssociateAssessmentReportEvidence Text Source #

The identifier for the assessment.

batchAssociateAssessmentReportEvidence_evidenceFolderId :: Lens' BatchAssociateAssessmentReportEvidence Text Source #

The identifier for the folder that the evidence is stored in.

batchAssociateAssessmentReportEvidence_evidenceIds :: Lens' BatchAssociateAssessmentReportEvidence [Text] Source #

The list of evidence identifiers.

batchAssociateAssessmentReportEvidenceResponse_errors :: Lens' BatchAssociateAssessmentReportEvidenceResponse (Maybe [AssessmentReportEvidenceError]) Source #

A list of errors that the BatchAssociateAssessmentReportEvidence API returned.

batchAssociateAssessmentReportEvidenceResponse_evidenceIds :: Lens' BatchAssociateAssessmentReportEvidenceResponse (Maybe [Text]) Source #

The list of evidence identifiers.

batchAssociateAssessmentReportEvidenceResponse_httpStatus :: Lens' BatchAssociateAssessmentReportEvidenceResponse Int Source #

The response's http status code.

BatchCreateDelegationByAssessment

batchCreateDelegationByAssessment_createDelegationRequests :: Lens' BatchCreateDelegationByAssessment (NonEmpty CreateDelegationRequest) Source #

The API request to batch create delegations in Audit Manager.

batchCreateDelegationByAssessment_assessmentId :: Lens' BatchCreateDelegationByAssessment Text Source #

The identifier for the assessment.

batchCreateDelegationByAssessmentResponse_delegations :: Lens' BatchCreateDelegationByAssessmentResponse (Maybe [Delegation]) Source #

The delegations that are associated with the assessment.

batchCreateDelegationByAssessmentResponse_errors :: Lens' BatchCreateDelegationByAssessmentResponse (Maybe [BatchCreateDelegationByAssessmentError]) Source #

A list of errors that the BatchCreateDelegationByAssessment API returned.

batchCreateDelegationByAssessmentResponse_httpStatus :: Lens' BatchCreateDelegationByAssessmentResponse Int Source #

The response's http status code.

BatchDeleteDelegationByAssessment

batchDeleteDelegationByAssessment_delegationIds :: Lens' BatchDeleteDelegationByAssessment (NonEmpty Text) Source #

The identifiers for the delegations.

batchDeleteDelegationByAssessment_assessmentId :: Lens' BatchDeleteDelegationByAssessment Text Source #

The identifier for the assessment.

batchDeleteDelegationByAssessmentResponse_errors :: Lens' BatchDeleteDelegationByAssessmentResponse (Maybe [BatchDeleteDelegationByAssessmentError]) Source #

A list of errors that the BatchDeleteDelegationByAssessment API returned.

batchDeleteDelegationByAssessmentResponse_httpStatus :: Lens' BatchDeleteDelegationByAssessmentResponse Int Source #

The response's http status code.

BatchDisassociateAssessmentReportEvidence

batchDisassociateAssessmentReportEvidence_assessmentId :: Lens' BatchDisassociateAssessmentReportEvidence Text Source #

The identifier for the assessment.

batchDisassociateAssessmentReportEvidence_evidenceFolderId :: Lens' BatchDisassociateAssessmentReportEvidence Text Source #

The identifier for the folder that the evidence is stored in.

batchDisassociateAssessmentReportEvidence_evidenceIds :: Lens' BatchDisassociateAssessmentReportEvidence [Text] Source #

The list of evidence identifiers.

batchDisassociateAssessmentReportEvidenceResponse_errors :: Lens' BatchDisassociateAssessmentReportEvidenceResponse (Maybe [AssessmentReportEvidenceError]) Source #

A list of errors that the BatchDisassociateAssessmentReportEvidence API returned.

batchDisassociateAssessmentReportEvidenceResponse_evidenceIds :: Lens' BatchDisassociateAssessmentReportEvidenceResponse (Maybe [Text]) Source #

The identifier for the evidence.

batchDisassociateAssessmentReportEvidenceResponse_httpStatus :: Lens' BatchDisassociateAssessmentReportEvidenceResponse Int Source #

The response's http status code.

BatchImportEvidenceToAssessmentControl

batchImportEvidenceToAssessmentControl_assessmentId :: Lens' BatchImportEvidenceToAssessmentControl Text Source #

The identifier for the assessment.

batchImportEvidenceToAssessmentControl_controlSetId :: Lens' BatchImportEvidenceToAssessmentControl Text Source #

The identifier for the control set.

batchImportEvidenceToAssessmentControl_controlId :: Lens' BatchImportEvidenceToAssessmentControl Text Source #

The identifier for the control.

batchImportEvidenceToAssessmentControl_manualEvidence :: Lens' BatchImportEvidenceToAssessmentControl (NonEmpty ManualEvidence) Source #

The list of manual evidence objects.

batchImportEvidenceToAssessmentControlResponse_errors :: Lens' BatchImportEvidenceToAssessmentControlResponse (Maybe [BatchImportEvidenceToAssessmentControlError]) Source #

A list of errors that the BatchImportEvidenceToAssessmentControl API returned.

batchImportEvidenceToAssessmentControlResponse_httpStatus :: Lens' BatchImportEvidenceToAssessmentControlResponse Int Source #

The response's http status code.

CreateAssessment

createAssessment_description :: Lens' CreateAssessment (Maybe Text) Source #

The optional description of the assessment to be created.

createAssessment_tags :: Lens' CreateAssessment (Maybe (HashMap Text Text)) Source #

The tags that are associated with the assessment.

createAssessment_name :: Lens' CreateAssessment Text Source #

The name of the assessment to be created.

createAssessment_assessmentReportsDestination :: Lens' CreateAssessment AssessmentReportsDestination Source #

The assessment report storage destination for the assessment that's being created.

createAssessment_scope :: Lens' CreateAssessment Scope Source #

Undocumented member.

createAssessment_roles :: Lens' CreateAssessment [Role] Source #

The list of roles for the assessment.

createAssessment_frameworkId :: Lens' CreateAssessment Text Source #

The identifier for the framework that the assessment will be created from.

createAssessmentResponse_assessment :: Lens' CreateAssessmentResponse (Maybe Assessment) Source #

Undocumented member.

createAssessmentResponse_httpStatus :: Lens' CreateAssessmentResponse Int Source #

The response's http status code.

CreateAssessmentFramework

createAssessmentFramework_complianceType :: Lens' CreateAssessmentFramework (Maybe Text) Source #

The compliance type that the new custom framework supports, such as CIS or HIPAA.

createAssessmentFramework_description :: Lens' CreateAssessmentFramework (Maybe Text) Source #

An optional description for the new custom framework.

createAssessmentFramework_tags :: Lens' CreateAssessmentFramework (Maybe (HashMap Text Text)) Source #

The tags that are associated with the framework.

createAssessmentFramework_name :: Lens' CreateAssessmentFramework Text Source #

The name of the new custom framework.

createAssessmentFramework_controlSets :: Lens' CreateAssessmentFramework (NonEmpty CreateAssessmentFrameworkControlSet) Source #

The control sets that are associated with the framework.

createAssessmentFrameworkResponse_framework :: Lens' CreateAssessmentFrameworkResponse (Maybe Framework) Source #

The name of the new framework that the CreateAssessmentFramework API returned.

createAssessmentFrameworkResponse_httpStatus :: Lens' CreateAssessmentFrameworkResponse Int Source #

The response's http status code.

CreateAssessmentReport

createAssessmentReport_description :: Lens' CreateAssessmentReport (Maybe Text) Source #

The description of the assessment report.

createAssessmentReport_queryStatement :: Lens' CreateAssessmentReport (Maybe Text) Source #

A SQL statement that represents an evidence finder query.

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 added to a report using the console, or associated with a report using the API.

To use this parameter, the enablementStatus of evidence finder must be ENABLED.

For examples and help resolving queryStatement validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User Guide.

createAssessmentReport_name :: Lens' CreateAssessmentReport Text Source #

The name of the new assessment report.

createAssessmentReport_assessmentId :: Lens' CreateAssessmentReport Text Source #

The identifier for the assessment.

createAssessmentReportResponse_assessmentReport :: Lens' CreateAssessmentReportResponse (Maybe AssessmentReport) Source #

The new assessment report that the CreateAssessmentReport API returned.

createAssessmentReportResponse_httpStatus :: Lens' CreateAssessmentReportResponse Int Source #

The response's http status code.

CreateControl

createControl_actionPlanInstructions :: Lens' CreateControl (Maybe Text) Source #

The recommended actions to carry out if the control isn't fulfilled.

createControl_actionPlanTitle :: Lens' CreateControl (Maybe Text) Source #

The title of the action plan for remediating the control.

createControl_description :: Lens' CreateControl (Maybe Text) Source #

The description of the control.

createControl_tags :: Lens' CreateControl (Maybe (HashMap Text Text)) Source #

The tags that are associated with the control.

createControl_testingInformation :: Lens' CreateControl (Maybe Text) Source #

The steps to follow to determine if the control is satisfied.

createControl_name :: Lens' CreateControl Text Source #

The name of the control.

createControl_controlMappingSources :: Lens' CreateControl (NonEmpty CreateControlMappingSource) Source #

The data mapping sources for the control.

createControlResponse_control :: Lens' CreateControlResponse (Maybe Control) Source #

The new control that the CreateControl API returned.

createControlResponse_httpStatus :: Lens' CreateControlResponse Int Source #

The response's http status code.

DeleteAssessment

deleteAssessment_assessmentId :: Lens' DeleteAssessment Text Source #

The identifier for the assessment.

deleteAssessmentResponse_httpStatus :: Lens' DeleteAssessmentResponse Int Source #

The response's http status code.

DeleteAssessmentFramework

deleteAssessmentFramework_frameworkId :: Lens' DeleteAssessmentFramework Text Source #

The identifier for the custom framework.

deleteAssessmentFrameworkResponse_httpStatus :: Lens' DeleteAssessmentFrameworkResponse Int Source #

The response's http status code.

DeleteAssessmentFrameworkShare

deleteAssessmentFrameworkShare_requestId :: Lens' DeleteAssessmentFrameworkShare Text Source #

The unique identifier for the share request to be deleted.

deleteAssessmentFrameworkShare_requestType :: Lens' DeleteAssessmentFrameworkShare ShareRequestType Source #

Specifies whether the share request is a sent request or a received request.

deleteAssessmentFrameworkShareResponse_httpStatus :: Lens' DeleteAssessmentFrameworkShareResponse Int Source #

The response's http status code.

DeleteAssessmentReport

deleteAssessmentReport_assessmentId :: Lens' DeleteAssessmentReport Text Source #

The unique identifier for the assessment.

deleteAssessmentReport_assessmentReportId :: Lens' DeleteAssessmentReport Text Source #

The unique identifier for the assessment report.

deleteAssessmentReportResponse_httpStatus :: Lens' DeleteAssessmentReportResponse Int Source #

The response's http status code.

DeleteControl

deleteControl_controlId :: Lens' DeleteControl Text Source #

The unique identifier for the control.

deleteControlResponse_httpStatus :: Lens' DeleteControlResponse Int Source #

The response's http status code.

DeregisterAccount

deregisterAccountResponse_status :: Lens' DeregisterAccountResponse (Maybe AccountStatus) Source #

The registration status of the account.

deregisterAccountResponse_httpStatus :: Lens' DeregisterAccountResponse Int Source #

The response's http status code.

DeregisterOrganizationAdminAccount

deregisterOrganizationAdminAccount_adminAccountId :: Lens' DeregisterOrganizationAdminAccount (Maybe Text) Source #

The identifier for the administrator account.

deregisterOrganizationAdminAccountResponse_httpStatus :: Lens' DeregisterOrganizationAdminAccountResponse Int Source #

The response's http status code.

DisassociateAssessmentReportEvidenceFolder

disassociateAssessmentReportEvidenceFolder_assessmentId :: Lens' DisassociateAssessmentReportEvidenceFolder Text Source #

The unique identifier for the assessment.

disassociateAssessmentReportEvidenceFolder_evidenceFolderId :: Lens' DisassociateAssessmentReportEvidenceFolder Text Source #

The unique identifier for the folder that the evidence is stored in.

disassociateAssessmentReportEvidenceFolderResponse_httpStatus :: Lens' DisassociateAssessmentReportEvidenceFolderResponse Int Source #

The response's http status code.

GetAccountStatus

getAccountStatusResponse_status :: Lens' GetAccountStatusResponse (Maybe AccountStatus) Source #

The status of the Amazon Web Services account.

getAccountStatusResponse_httpStatus :: Lens' GetAccountStatusResponse Int Source #

The response's http status code.

GetAssessment

getAssessment_assessmentId :: Lens' GetAssessment Text Source #

The unique identifier for the assessment.

getAssessmentResponse_assessment :: Lens' GetAssessmentResponse (Maybe Assessment) Source #

Undocumented member.

getAssessmentResponse_userRole :: Lens' GetAssessmentResponse (Maybe Role) Source #

Undocumented member.

getAssessmentResponse_httpStatus :: Lens' GetAssessmentResponse Int Source #

The response's http status code.

GetAssessmentFramework

getAssessmentFramework_frameworkId :: Lens' GetAssessmentFramework Text Source #

The identifier for the framework.

getAssessmentFrameworkResponse_framework :: Lens' GetAssessmentFrameworkResponse (Maybe Framework) Source #

The framework that the GetAssessmentFramework API returned.

getAssessmentFrameworkResponse_httpStatus :: Lens' GetAssessmentFrameworkResponse Int Source #

The response's http status code.

GetAssessmentReportUrl

getAssessmentReportUrl_assessmentReportId :: Lens' GetAssessmentReportUrl Text Source #

The unique identifier for the assessment report.

getAssessmentReportUrl_assessmentId :: Lens' GetAssessmentReportUrl Text Source #

The unique identifier for the assessment.

getAssessmentReportUrlResponse_preSignedUrl :: Lens' GetAssessmentReportUrlResponse (Maybe URL) Source #

Undocumented member.

getAssessmentReportUrlResponse_httpStatus :: Lens' GetAssessmentReportUrlResponse Int Source #

The response's http status code.

GetChangeLogs

getChangeLogs_controlId :: Lens' GetChangeLogs (Maybe Text) Source #

The unique identifier for the control.

getChangeLogs_controlSetId :: Lens' GetChangeLogs (Maybe Text) Source #

The unique identifier for the control set.

getChangeLogs_maxResults :: Lens' GetChangeLogs (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

getChangeLogs_nextToken :: Lens' GetChangeLogs (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getChangeLogs_assessmentId :: Lens' GetChangeLogs Text Source #

The unique identifier for the assessment.

getChangeLogsResponse_changeLogs :: Lens' GetChangeLogsResponse (Maybe [ChangeLog]) Source #

The list of user activity for the control.

getChangeLogsResponse_nextToken :: Lens' GetChangeLogsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getChangeLogsResponse_httpStatus :: Lens' GetChangeLogsResponse Int Source #

The response's http status code.

GetControl

getControl_controlId :: Lens' GetControl Text Source #

The identifier for the control.

getControlResponse_control :: Lens' GetControlResponse (Maybe Control) Source #

The name of the control that the GetControl API returned.

getControlResponse_httpStatus :: Lens' GetControlResponse Int Source #

The response's http status code.

GetDelegations

getDelegations_maxResults :: Lens' GetDelegations (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

getDelegations_nextToken :: Lens' GetDelegations (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getDelegationsResponse_delegations :: Lens' GetDelegationsResponse (Maybe [DelegationMetadata]) Source #

The list of delegations that the GetDelegations API returned.

getDelegationsResponse_nextToken :: Lens' GetDelegationsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getDelegationsResponse_httpStatus :: Lens' GetDelegationsResponse Int Source #

The response's http status code.

GetEvidence

getEvidence_assessmentId :: Lens' GetEvidence Text Source #

The unique identifier for the assessment.

getEvidence_controlSetId :: Lens' GetEvidence Text Source #

The unique identifier for the control set.

getEvidence_evidenceFolderId :: Lens' GetEvidence Text Source #

The unique identifier for the folder that the evidence is stored in.

getEvidence_evidenceId :: Lens' GetEvidence Text Source #

The unique identifier for the evidence.

getEvidenceResponse_evidence :: Lens' GetEvidenceResponse (Maybe Evidence) Source #

The evidence that the GetEvidence API returned.

getEvidenceResponse_httpStatus :: Lens' GetEvidenceResponse Int Source #

The response's http status code.

GetEvidenceByEvidenceFolder

getEvidenceByEvidenceFolder_maxResults :: Lens' GetEvidenceByEvidenceFolder (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

getEvidenceByEvidenceFolder_nextToken :: Lens' GetEvidenceByEvidenceFolder (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getEvidenceByEvidenceFolder_assessmentId :: Lens' GetEvidenceByEvidenceFolder Text Source #

The identifier for the assessment.

getEvidenceByEvidenceFolder_controlSetId :: Lens' GetEvidenceByEvidenceFolder Text Source #

The identifier for the control set.

getEvidenceByEvidenceFolder_evidenceFolderId :: Lens' GetEvidenceByEvidenceFolder Text Source #

The unique identifier for the folder that the evidence is stored in.

getEvidenceByEvidenceFolderResponse_evidence :: Lens' GetEvidenceByEvidenceFolderResponse (Maybe [Evidence]) Source #

The list of evidence that the GetEvidenceByEvidenceFolder API returned.

getEvidenceByEvidenceFolderResponse_nextToken :: Lens' GetEvidenceByEvidenceFolderResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getEvidenceByEvidenceFolderResponse_httpStatus :: Lens' GetEvidenceByEvidenceFolderResponse Int Source #

The response's http status code.

GetEvidenceFolder

getEvidenceFolder_assessmentId :: Lens' GetEvidenceFolder Text Source #

The unique identifier for the assessment.

getEvidenceFolder_controlSetId :: Lens' GetEvidenceFolder Text Source #

The unique identifier for the control set.

getEvidenceFolder_evidenceFolderId :: Lens' GetEvidenceFolder Text Source #

The unique identifier for the folder that the evidence is stored in.

getEvidenceFolderResponse_evidenceFolder :: Lens' GetEvidenceFolderResponse (Maybe AssessmentEvidenceFolder) Source #

The folder that the evidence is stored in.

getEvidenceFolderResponse_httpStatus :: Lens' GetEvidenceFolderResponse Int Source #

The response's http status code.

GetEvidenceFoldersByAssessment

getEvidenceFoldersByAssessment_maxResults :: Lens' GetEvidenceFoldersByAssessment (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

getEvidenceFoldersByAssessment_nextToken :: Lens' GetEvidenceFoldersByAssessment (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getEvidenceFoldersByAssessment_assessmentId :: Lens' GetEvidenceFoldersByAssessment Text Source #

The unique identifier for the assessment.

getEvidenceFoldersByAssessmentResponse_evidenceFolders :: Lens' GetEvidenceFoldersByAssessmentResponse (Maybe [AssessmentEvidenceFolder]) Source #

The list of evidence folders that the GetEvidenceFoldersByAssessment API returned.

getEvidenceFoldersByAssessmentResponse_nextToken :: Lens' GetEvidenceFoldersByAssessmentResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getEvidenceFoldersByAssessmentResponse_httpStatus :: Lens' GetEvidenceFoldersByAssessmentResponse Int Source #

The response's http status code.

GetEvidenceFoldersByAssessmentControl

getEvidenceFoldersByAssessmentControl_maxResults :: Lens' GetEvidenceFoldersByAssessmentControl (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

getEvidenceFoldersByAssessmentControl_nextToken :: Lens' GetEvidenceFoldersByAssessmentControl (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getEvidenceFoldersByAssessmentControl_assessmentId :: Lens' GetEvidenceFoldersByAssessmentControl Text Source #

The identifier for the assessment.

getEvidenceFoldersByAssessmentControl_controlSetId :: Lens' GetEvidenceFoldersByAssessmentControl Text Source #

The identifier for the control set.

getEvidenceFoldersByAssessmentControl_controlId :: Lens' GetEvidenceFoldersByAssessmentControl Text Source #

The identifier for the control.

getEvidenceFoldersByAssessmentControlResponse_evidenceFolders :: Lens' GetEvidenceFoldersByAssessmentControlResponse (Maybe [AssessmentEvidenceFolder]) Source #

The list of evidence folders that the GetEvidenceFoldersByAssessmentControl API returned.

getEvidenceFoldersByAssessmentControlResponse_nextToken :: Lens' GetEvidenceFoldersByAssessmentControlResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

getEvidenceFoldersByAssessmentControlResponse_httpStatus :: Lens' GetEvidenceFoldersByAssessmentControlResponse Int Source #

The response's http status code.

GetInsights

getInsightsResponse_insights :: Lens' GetInsightsResponse (Maybe Insights) Source #

The analytics data that the GetInsights API returned.

getInsightsResponse_httpStatus :: Lens' GetInsightsResponse Int Source #

The response's http status code.

GetInsightsByAssessment

getInsightsByAssessment_assessmentId :: Lens' GetInsightsByAssessment Text Source #

The unique identifier for the assessment.

getInsightsByAssessmentResponse_insights :: Lens' GetInsightsByAssessmentResponse (Maybe InsightsByAssessment) Source #

The assessment analytics data that the GetInsightsByAssessment API returned.

getInsightsByAssessmentResponse_httpStatus :: Lens' GetInsightsByAssessmentResponse Int Source #

The response's http status code.

GetOrganizationAdminAccount

getOrganizationAdminAccountResponse_adminAccountId :: Lens' GetOrganizationAdminAccountResponse (Maybe Text) Source #

The identifier for the administrator account.

getOrganizationAdminAccountResponse_organizationId :: Lens' GetOrganizationAdminAccountResponse (Maybe Text) Source #

The identifier for the organization.

getOrganizationAdminAccountResponse_httpStatus :: Lens' GetOrganizationAdminAccountResponse Int Source #

The response's http status code.

GetServicesInScope

getServicesInScopeResponse_serviceMetadata :: Lens' GetServicesInScopeResponse (Maybe [ServiceMetadata]) Source #

The metadata that's associated with the Amazon Web Service.

getServicesInScopeResponse_httpStatus :: Lens' GetServicesInScopeResponse Int Source #

The response's http status code.

GetSettings

getSettings_attribute :: Lens' GetSettings SettingAttribute Source #

The list of setting attribute enum values.

getSettingsResponse_settings :: Lens' GetSettingsResponse (Maybe Settings) Source #

The settings object that holds all supported Audit Manager settings.

getSettingsResponse_httpStatus :: Lens' GetSettingsResponse Int Source #

The response's http status code.

ListAssessmentControlInsightsByControlDomain

listAssessmentControlInsightsByControlDomain_maxResults :: Lens' ListAssessmentControlInsightsByControlDomain (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listAssessmentControlInsightsByControlDomain_nextToken :: Lens' ListAssessmentControlInsightsByControlDomain (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentControlInsightsByControlDomain_controlDomainId :: Lens' ListAssessmentControlInsightsByControlDomain Text Source #

The unique identifier for the control domain.

listAssessmentControlInsightsByControlDomain_assessmentId :: Lens' ListAssessmentControlInsightsByControlDomain Text Source #

The unique identifier for the active assessment.

listAssessmentControlInsightsByControlDomainResponse_controlInsightsByAssessment :: Lens' ListAssessmentControlInsightsByControlDomainResponse (Maybe [ControlInsightsMetadataByAssessmentItem]) Source #

The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain API returned.

listAssessmentControlInsightsByControlDomainResponse_nextToken :: Lens' ListAssessmentControlInsightsByControlDomainResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentControlInsightsByControlDomainResponse_httpStatus :: Lens' ListAssessmentControlInsightsByControlDomainResponse Int Source #

The response's http status code.

ListAssessmentFrameworkShareRequests

listAssessmentFrameworkShareRequests_maxResults :: Lens' ListAssessmentFrameworkShareRequests (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listAssessmentFrameworkShareRequests_nextToken :: Lens' ListAssessmentFrameworkShareRequests (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentFrameworkShareRequests_requestType :: Lens' ListAssessmentFrameworkShareRequests ShareRequestType Source #

Specifies whether the share request is a sent request or a received request.

listAssessmentFrameworkShareRequestsResponse_assessmentFrameworkShareRequests :: Lens' ListAssessmentFrameworkShareRequestsResponse (Maybe [AssessmentFrameworkShareRequest]) Source #

The list of share requests that the ListAssessmentFrameworkShareRequests API returned.

listAssessmentFrameworkShareRequestsResponse_nextToken :: Lens' ListAssessmentFrameworkShareRequestsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentFrameworkShareRequestsResponse_httpStatus :: Lens' ListAssessmentFrameworkShareRequestsResponse Int Source #

The response's http status code.

ListAssessmentFrameworks

listAssessmentFrameworks_maxResults :: Lens' ListAssessmentFrameworks (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listAssessmentFrameworks_nextToken :: Lens' ListAssessmentFrameworks (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentFrameworks_frameworkType :: Lens' ListAssessmentFrameworks FrameworkType Source #

The type of framework, such as a standard framework or a custom framework.

listAssessmentFrameworksResponse_frameworkMetadataList :: Lens' ListAssessmentFrameworksResponse (Maybe [AssessmentFrameworkMetadata]) Source #

The list of metadata objects for the framework.

listAssessmentFrameworksResponse_nextToken :: Lens' ListAssessmentFrameworksResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentFrameworksResponse_httpStatus :: Lens' ListAssessmentFrameworksResponse Int Source #

The response's http status code.

ListAssessmentReports

listAssessmentReports_maxResults :: Lens' ListAssessmentReports (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listAssessmentReports_nextToken :: Lens' ListAssessmentReports (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentReportsResponse_assessmentReports :: Lens' ListAssessmentReportsResponse (Maybe [AssessmentReportMetadata]) Source #

The list of assessment reports that the ListAssessmentReports API returned.

listAssessmentReportsResponse_nextToken :: Lens' ListAssessmentReportsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentReportsResponse_httpStatus :: Lens' ListAssessmentReportsResponse Int Source #

The response's http status code.

ListAssessments

listAssessments_maxResults :: Lens' ListAssessments (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listAssessments_nextToken :: Lens' ListAssessments (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessments_status :: Lens' ListAssessments (Maybe AssessmentStatus) Source #

The current status of the assessment.

listAssessmentsResponse_assessmentMetadata :: Lens' ListAssessmentsResponse (Maybe [AssessmentMetadataItem]) Source #

The metadata that's associated with the assessment.

listAssessmentsResponse_nextToken :: Lens' ListAssessmentsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listAssessmentsResponse_httpStatus :: Lens' ListAssessmentsResponse Int Source #

The response's http status code.

ListControlDomainInsights

listControlDomainInsights_maxResults :: Lens' ListControlDomainInsights (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listControlDomainInsights_nextToken :: Lens' ListControlDomainInsights (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControlDomainInsightsResponse_controlDomainInsights :: Lens' ListControlDomainInsightsResponse (Maybe [ControlDomainInsights]) Source #

The control domain analytics data that the ListControlDomainInsights API returned.

listControlDomainInsightsResponse_nextToken :: Lens' ListControlDomainInsightsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControlDomainInsightsResponse_httpStatus :: Lens' ListControlDomainInsightsResponse Int Source #

The response's http status code.

ListControlDomainInsightsByAssessment

listControlDomainInsightsByAssessment_maxResults :: Lens' ListControlDomainInsightsByAssessment (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listControlDomainInsightsByAssessment_nextToken :: Lens' ListControlDomainInsightsByAssessment (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControlDomainInsightsByAssessment_assessmentId :: Lens' ListControlDomainInsightsByAssessment Text Source #

The unique identifier for the active assessment.

listControlDomainInsightsByAssessmentResponse_controlDomainInsights :: Lens' ListControlDomainInsightsByAssessmentResponse (Maybe [ControlDomainInsights]) Source #

The control domain analytics data that the ListControlDomainInsightsByAssessment API returned.

listControlDomainInsightsByAssessmentResponse_nextToken :: Lens' ListControlDomainInsightsByAssessmentResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControlDomainInsightsByAssessmentResponse_httpStatus :: Lens' ListControlDomainInsightsByAssessmentResponse Int Source #

The response's http status code.

ListControlInsightsByControlDomain

listControlInsightsByControlDomain_maxResults :: Lens' ListControlInsightsByControlDomain (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listControlInsightsByControlDomain_nextToken :: Lens' ListControlInsightsByControlDomain (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControlInsightsByControlDomain_controlDomainId :: Lens' ListControlInsightsByControlDomain Text Source #

The unique identifier for the control domain.

listControlInsightsByControlDomainResponse_controlInsightsMetadata :: Lens' ListControlInsightsByControlDomainResponse (Maybe [ControlInsightsMetadataItem]) Source #

The control analytics data that the ListControlInsightsByControlDomain API returned.

listControlInsightsByControlDomainResponse_nextToken :: Lens' ListControlInsightsByControlDomainResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControlInsightsByControlDomainResponse_httpStatus :: Lens' ListControlInsightsByControlDomainResponse Int Source #

The response's http status code.

ListControls

listControls_maxResults :: Lens' ListControls (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listControls_nextToken :: Lens' ListControls (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControls_controlType :: Lens' ListControls ControlType Source #

The type of control, such as a standard control or a custom control.

listControlsResponse_controlMetadataList :: Lens' ListControlsResponse (Maybe [ControlMetadata]) Source #

The list of control metadata objects that the ListControls API returned.

listControlsResponse_nextToken :: Lens' ListControlsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listControlsResponse_httpStatus :: Lens' ListControlsResponse Int Source #

The response's http status code.

ListKeywordsForDataSource

listKeywordsForDataSource_maxResults :: Lens' ListKeywordsForDataSource (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listKeywordsForDataSource_nextToken :: Lens' ListKeywordsForDataSource (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listKeywordsForDataSource_source :: Lens' ListKeywordsForDataSource SourceType Source #

The control mapping data source that the keywords apply to.

listKeywordsForDataSourceResponse_keywords :: Lens' ListKeywordsForDataSourceResponse (Maybe [Text]) Source #

The list of keywords for the event mapping source.

listKeywordsForDataSourceResponse_nextToken :: Lens' ListKeywordsForDataSourceResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listKeywordsForDataSourceResponse_httpStatus :: Lens' ListKeywordsForDataSourceResponse Int Source #

The response's http status code.

ListNotifications

listNotifications_maxResults :: Lens' ListNotifications (Maybe Natural) Source #

Represents the maximum number of results on a page or for an API request call.

listNotifications_nextToken :: Lens' ListNotifications (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listNotificationsResponse_nextToken :: Lens' ListNotificationsResponse (Maybe Text) Source #

The pagination token that's used to fetch the next set of results.

listNotificationsResponse_notifications :: Lens' ListNotificationsResponse (Maybe [Notification]) Source #

The returned list of notifications.

listNotificationsResponse_httpStatus :: Lens' ListNotificationsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The list of tags that the ListTagsForResource API returned.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

RegisterAccount

registerAccount_delegatedAdminAccount :: Lens' RegisterAccount (Maybe Text) Source #

The delegated administrator account for Audit Manager.

registerAccount_kmsKey :: Lens' RegisterAccount (Maybe Text) Source #

The KMS key details.

registerAccountResponse_status :: Lens' RegisterAccountResponse (Maybe AccountStatus) Source #

The status of the account registration request.

registerAccountResponse_httpStatus :: Lens' RegisterAccountResponse Int Source #

The response's http status code.

RegisterOrganizationAdminAccount

registerOrganizationAdminAccount_adminAccountId :: Lens' RegisterOrganizationAdminAccount Text Source #

The identifier for the delegated administrator account.

registerOrganizationAdminAccountResponse_adminAccountId :: Lens' RegisterOrganizationAdminAccountResponse (Maybe Text) Source #

The identifier for the delegated administrator account.

registerOrganizationAdminAccountResponse_organizationId :: Lens' RegisterOrganizationAdminAccountResponse (Maybe Text) Source #

The identifier for the organization.

registerOrganizationAdminAccountResponse_httpStatus :: Lens' RegisterOrganizationAdminAccountResponse Int Source #

The response's http status code.

StartAssessmentFrameworkShare

startAssessmentFrameworkShare_comment :: Lens' StartAssessmentFrameworkShare (Maybe Text) Source #

An optional comment from the sender about the share request.

startAssessmentFrameworkShare_frameworkId :: Lens' StartAssessmentFrameworkShare Text Source #

The unique identifier for the custom framework to be shared.

startAssessmentFrameworkShare_destinationAccount :: Lens' StartAssessmentFrameworkShare Text Source #

The Amazon Web Services account of the recipient.

startAssessmentFrameworkShare_destinationRegion :: Lens' StartAssessmentFrameworkShare Text Source #

The Amazon Web Services Region of the recipient.

startAssessmentFrameworkShareResponse_assessmentFrameworkShareRequest :: Lens' StartAssessmentFrameworkShareResponse (Maybe AssessmentFrameworkShareRequest) Source #

The share request that's created by the StartAssessmentFrameworkShare API.

startAssessmentFrameworkShareResponse_httpStatus :: Lens' StartAssessmentFrameworkShareResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags that are associated with the resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the specified resource.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The name or key of the tag.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateAssessment

updateAssessment_assessmentDescription :: Lens' UpdateAssessment (Maybe Text) Source #

The description of the assessment.

updateAssessment_assessmentName :: Lens' UpdateAssessment (Maybe Text) Source #

The name of the assessment to be updated.

updateAssessment_assessmentReportsDestination :: Lens' UpdateAssessment (Maybe AssessmentReportsDestination) Source #

The assessment report storage destination for the assessment that's being updated.

updateAssessment_roles :: Lens' UpdateAssessment (Maybe [Role]) Source #

The list of roles for the assessment.

updateAssessment_assessmentId :: Lens' UpdateAssessment Text Source #

The unique identifier for the assessment.

updateAssessment_scope :: Lens' UpdateAssessment Scope Source #

The scope of the assessment.

updateAssessmentResponse_assessment :: Lens' UpdateAssessmentResponse (Maybe Assessment) Source #

The response object for the UpdateAssessment API. This is the name of the updated assessment.

updateAssessmentResponse_httpStatus :: Lens' UpdateAssessmentResponse Int Source #

The response's http status code.

UpdateAssessmentControl

updateAssessmentControl_commentBody :: Lens' UpdateAssessmentControl (Maybe Text) Source #

The comment body text for the control.

updateAssessmentControl_controlStatus :: Lens' UpdateAssessmentControl (Maybe ControlStatus) Source #

The status of the control.

updateAssessmentControl_assessmentId :: Lens' UpdateAssessmentControl Text Source #

The unique identifier for the assessment.

updateAssessmentControl_controlSetId :: Lens' UpdateAssessmentControl Text Source #

The unique identifier for the control set.

updateAssessmentControl_controlId :: Lens' UpdateAssessmentControl Text Source #

The unique identifier for the control.

updateAssessmentControlResponse_control :: Lens' UpdateAssessmentControlResponse (Maybe AssessmentControl) Source #

The name of the updated control set that the UpdateAssessmentControl API returned.

updateAssessmentControlResponse_httpStatus :: Lens' UpdateAssessmentControlResponse Int Source #

The response's http status code.

UpdateAssessmentControlSetStatus

updateAssessmentControlSetStatus_assessmentId :: Lens' UpdateAssessmentControlSetStatus Text Source #

The unique identifier for the assessment.

updateAssessmentControlSetStatus_controlSetId :: Lens' UpdateAssessmentControlSetStatus Text Source #

The unique identifier for the control set.

updateAssessmentControlSetStatus_status :: Lens' UpdateAssessmentControlSetStatus ControlSetStatus Source #

The status of the control set that's being updated.

updateAssessmentControlSetStatus_comment :: Lens' UpdateAssessmentControlSetStatus Text Source #

The comment that's related to the status update.

updateAssessmentControlSetStatusResponse_controlSet :: Lens' UpdateAssessmentControlSetStatusResponse (Maybe AssessmentControlSet) Source #

The name of the updated control set that the UpdateAssessmentControlSetStatus API returned.

updateAssessmentControlSetStatusResponse_httpStatus :: Lens' UpdateAssessmentControlSetStatusResponse Int Source #

The response's http status code.

UpdateAssessmentFramework

updateAssessmentFramework_complianceType :: Lens' UpdateAssessmentFramework (Maybe Text) Source #

The compliance type that the new custom framework supports, such as CIS or HIPAA.

updateAssessmentFramework_description :: Lens' UpdateAssessmentFramework (Maybe Text) Source #

The description of the updated framework.

updateAssessmentFramework_frameworkId :: Lens' UpdateAssessmentFramework Text Source #

The unique identifier for the framework.

updateAssessmentFramework_name :: Lens' UpdateAssessmentFramework Text Source #

The name of the framework to be updated.

updateAssessmentFramework_controlSets :: Lens' UpdateAssessmentFramework (NonEmpty UpdateAssessmentFrameworkControlSet) Source #

The control sets that are associated with the framework.

updateAssessmentFrameworkResponse_framework :: Lens' UpdateAssessmentFrameworkResponse (Maybe Framework) Source #

The name of the framework.

updateAssessmentFrameworkResponse_httpStatus :: Lens' UpdateAssessmentFrameworkResponse Int Source #

The response's http status code.

UpdateAssessmentFrameworkShare

updateAssessmentFrameworkShare_requestId :: Lens' UpdateAssessmentFrameworkShare Text Source #

The unique identifier for the share request.

updateAssessmentFrameworkShare_requestType :: Lens' UpdateAssessmentFrameworkShare ShareRequestType Source #

Specifies whether the share request is a sent request or a received request.

updateAssessmentFrameworkShare_action :: Lens' UpdateAssessmentFrameworkShare ShareRequestAction Source #

Specifies the update action for the share request.

updateAssessmentFrameworkShareResponse_assessmentFrameworkShareRequest :: Lens' UpdateAssessmentFrameworkShareResponse (Maybe AssessmentFrameworkShareRequest) Source #

The updated share request that's returned by the UpdateAssessmentFrameworkShare operation.

updateAssessmentFrameworkShareResponse_httpStatus :: Lens' UpdateAssessmentFrameworkShareResponse Int Source #

The response's http status code.

UpdateAssessmentStatus

updateAssessmentStatus_assessmentId :: Lens' UpdateAssessmentStatus Text Source #

The unique identifier for the assessment.

updateAssessmentStatus_status :: Lens' UpdateAssessmentStatus AssessmentStatus Source #

The current status of the assessment.

updateAssessmentStatusResponse_assessment :: Lens' UpdateAssessmentStatusResponse (Maybe Assessment) Source #

The name of the updated assessment that the UpdateAssessmentStatus API returned.

updateAssessmentStatusResponse_httpStatus :: Lens' UpdateAssessmentStatusResponse Int Source #

The response's http status code.

UpdateControl

updateControl_actionPlanInstructions :: Lens' UpdateControl (Maybe Text) Source #

The recommended actions to carry out if the control isn't fulfilled.

updateControl_actionPlanTitle :: Lens' UpdateControl (Maybe Text) Source #

The title of the action plan for remediating the control.

updateControl_description :: Lens' UpdateControl (Maybe Text) Source #

The optional description of the control.

updateControl_testingInformation :: Lens' UpdateControl (Maybe Text) Source #

The steps that you should follow to determine if the control is met.

updateControl_controlId :: Lens' UpdateControl Text Source #

The identifier for the control.

updateControl_name :: Lens' UpdateControl Text Source #

The name of the updated control.

updateControl_controlMappingSources :: Lens' UpdateControl (NonEmpty ControlMappingSource) Source #

The data mapping sources for the control.

updateControlResponse_control :: Lens' UpdateControlResponse (Maybe Control) Source #

The name of the updated control set that the UpdateControl API returned.

updateControlResponse_httpStatus :: Lens' UpdateControlResponse Int Source #

The response's http status code.

UpdateSettings

updateSettings_defaultAssessmentReportsDestination :: Lens' UpdateSettings (Maybe AssessmentReportsDestination) Source #

The default storage destination for assessment reports.

updateSettings_defaultProcessOwners :: Lens' UpdateSettings (Maybe [Role]) Source #

A list of the default audit owners.

updateSettings_deregistrationPolicy :: Lens' UpdateSettings (Maybe DeregistrationPolicy) Source #

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.

updateSettings_evidenceFinderEnabled :: Lens' UpdateSettings (Maybe Bool) Source #

Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder.

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 deregister and then re-register Audit Manager.

updateSettings_kmsKey :: Lens' UpdateSettings (Maybe Text) Source #

The KMS key details.

updateSettings_snsTopic :: Lens' UpdateSettings (Maybe Text) Source #

The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.

updateSettingsResponse_settings :: Lens' UpdateSettingsResponse (Maybe Settings) Source #

The current list of settings.

updateSettingsResponse_httpStatus :: Lens' UpdateSettingsResponse Int Source #

The response's http status code.

ValidateAssessmentReportIntegrity

validateAssessmentReportIntegrity_s3RelativePath :: Lens' ValidateAssessmentReportIntegrity Text Source #

The relative path of the Amazon S3 bucket that the assessment report is stored in.

validateAssessmentReportIntegrityResponse_signatureAlgorithm :: Lens' ValidateAssessmentReportIntegrityResponse (Maybe Text) Source #

The signature algorithm that's used to code sign the assessment report file.

validateAssessmentReportIntegrityResponse_signatureDateTime :: Lens' ValidateAssessmentReportIntegrityResponse (Maybe Text) Source #

The date and time signature that specifies when the assessment report was created.

validateAssessmentReportIntegrityResponse_signatureKeyId :: Lens' ValidateAssessmentReportIntegrityResponse (Maybe Text) Source #

The unique identifier for the validation signature key.

validateAssessmentReportIntegrityResponse_signatureValid :: Lens' ValidateAssessmentReportIntegrityResponse (Maybe Bool) Source #

Specifies whether the signature key is valid.

validateAssessmentReportIntegrityResponse_validationErrors :: Lens' ValidateAssessmentReportIntegrityResponse (Maybe [Text]) Source #

Represents any errors that occurred when validating the assessment report.

validateAssessmentReportIntegrityResponse_httpStatus :: Lens' ValidateAssessmentReportIntegrityResponse Int Source #

The response's http status code.

Types

AWSAccount

aWSAccount_emailAddress :: Lens' AWSAccount (Maybe Text) Source #

The email address that's associated with the Amazon Web Services account.

aWSAccount_id :: Lens' AWSAccount (Maybe Text) Source #

The identifier for the Amazon Web Services account.

aWSAccount_name :: Lens' AWSAccount (Maybe Text) Source #

The name of the Amazon Web Services account.

AWSService

aWSService_serviceName :: Lens' AWSService (Maybe Text) Source #

The name of the Amazon Web Service.

Assessment

assessment_arn :: Lens' Assessment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the assessment.

assessment_awsAccount :: Lens' Assessment (Maybe AWSAccount) Source #

The Amazon Web Services account that's associated with the assessment.

assessment_framework :: Lens' Assessment (Maybe AssessmentFramework) Source #

The framework that the assessment was created from.

assessment_metadata :: Lens' Assessment (Maybe AssessmentMetadata) Source #

The metadata for the assessment.

assessment_tags :: Lens' Assessment (Maybe (HashMap Text Text)) Source #

The tags that are associated with the assessment.

AssessmentControl

assessmentControl_assessmentReportEvidenceCount :: Lens' AssessmentControl (Maybe Int) Source #

The amount of evidence in the assessment report.

assessmentControl_comments :: Lens' AssessmentControl (Maybe [ControlComment]) Source #

The list of comments that's attached to the control.

assessmentControl_description :: Lens' AssessmentControl (Maybe Text) Source #

The description of the control.

assessmentControl_evidenceCount :: Lens' AssessmentControl (Maybe Int) Source #

The amount of evidence that's collected for the control.

assessmentControl_evidenceSources :: Lens' AssessmentControl (Maybe [Text]) Source #

The list of data sources for the evidence.

assessmentControl_id :: Lens' AssessmentControl (Maybe Text) Source #

The identifier for the control.

assessmentControl_name :: Lens' AssessmentControl (Maybe Text) Source #

The name of the control.

assessmentControl_response :: Lens' AssessmentControl (Maybe ControlResponse) Source #

The response of the control.

assessmentControl_status :: Lens' AssessmentControl (Maybe ControlStatus) Source #

The status of the control.

AssessmentControlSet

assessmentControlSet_controls :: Lens' AssessmentControlSet (Maybe [AssessmentControl]) Source #

The list of controls that's contained with the control set.

assessmentControlSet_delegations :: Lens' AssessmentControlSet (Maybe [Delegation]) Source #

The delegations that are associated with the control set.

assessmentControlSet_description :: Lens' AssessmentControlSet (Maybe Text) Source #

The description for the control set.

assessmentControlSet_id :: Lens' AssessmentControlSet (Maybe Text) Source #

The identifier of the control set in the assessment. This is the control set name in a plain string format.

assessmentControlSet_manualEvidenceCount :: Lens' AssessmentControlSet (Maybe Int) Source #

The total number of evidence objects that are uploaded manually to the control set.

assessmentControlSet_roles :: Lens' AssessmentControlSet (Maybe [Role]) Source #

The roles that are associated with the control set.

assessmentControlSet_status :: Lens' AssessmentControlSet (Maybe ControlSetStatus) Source #

The current status of the control set.

assessmentControlSet_systemEvidenceCount :: Lens' AssessmentControlSet (Maybe Int) Source #

The total number of evidence objects that are retrieved automatically for the control set.

AssessmentEvidenceFolder

assessmentEvidenceFolder_assessmentId :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The identifier for the assessment.

assessmentEvidenceFolder_assessmentReportSelectionCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The total count of evidence that's included in the assessment report.

assessmentEvidenceFolder_author :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The name of the user who created the evidence folder.

assessmentEvidenceFolder_controlId :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The unique identifier for the control.

assessmentEvidenceFolder_controlName :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The name of the control.

assessmentEvidenceFolder_controlSetId :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The identifier for the control set.

assessmentEvidenceFolder_dataSource :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The Amazon Web Service that the evidence was collected from.

assessmentEvidenceFolder_date :: Lens' AssessmentEvidenceFolder (Maybe UTCTime) Source #

The date when the first evidence was added to the evidence folder.

assessmentEvidenceFolder_evidenceAwsServiceSourceCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The total number of Amazon Web Services resources that were assessed to generate the evidence.

assessmentEvidenceFolder_evidenceByTypeComplianceCheckCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.

assessmentEvidenceFolder_evidenceByTypeComplianceCheckIssuesCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The total number of issues that were reported directly from Security Hub, Config, or both.

assessmentEvidenceFolder_evidenceByTypeConfigurationDataCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

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.

assessmentEvidenceFolder_evidenceByTypeManualCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The number of evidence that falls under the manual category. This evidence is imported manually.

assessmentEvidenceFolder_evidenceByTypeUserActivityCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs.

assessmentEvidenceFolder_evidenceResourcesIncludedCount :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The amount of evidence that's included in the evidence folder.

assessmentEvidenceFolder_id :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The identifier for the folder that the evidence is stored in.

assessmentEvidenceFolder_name :: Lens' AssessmentEvidenceFolder (Maybe Text) Source #

The name of the evidence folder.

assessmentEvidenceFolder_totalEvidence :: Lens' AssessmentEvidenceFolder (Maybe Int) Source #

The total amount of evidence in the evidence folder.

AssessmentFramework

assessmentFramework_arn :: Lens' AssessmentFramework (Maybe Text) Source #

The Amazon Resource Name (ARN) of the framework.

assessmentFramework_controlSets :: Lens' AssessmentFramework (Maybe [AssessmentControlSet]) Source #

The control sets that are associated with the framework.

assessmentFramework_id :: Lens' AssessmentFramework (Maybe Text) Source #

The unique identifier for the framework.

assessmentFramework_metadata :: Lens' AssessmentFramework (Maybe FrameworkMetadata) Source #

Undocumented member.

AssessmentFrameworkMetadata

assessmentFrameworkMetadata_arn :: Lens' AssessmentFrameworkMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the framework.

assessmentFrameworkMetadata_complianceType :: Lens' AssessmentFrameworkMetadata (Maybe Text) Source #

The compliance type that the new custom framework supports, such as CIS or HIPAA.

assessmentFrameworkMetadata_controlSetsCount :: Lens' AssessmentFrameworkMetadata (Maybe Int) Source #

The number of control sets that are associated with the framework.

assessmentFrameworkMetadata_controlsCount :: Lens' AssessmentFrameworkMetadata (Maybe Int) Source #

The number of controls that are associated with the framework.

assessmentFrameworkMetadata_createdAt :: Lens' AssessmentFrameworkMetadata (Maybe UTCTime) Source #

The time when the framework was created.

assessmentFrameworkMetadata_description :: Lens' AssessmentFrameworkMetadata (Maybe Text) Source #

The description of the framework.

assessmentFrameworkMetadata_id :: Lens' AssessmentFrameworkMetadata (Maybe Text) Source #

The unique identifier for the framework.

assessmentFrameworkMetadata_lastUpdatedAt :: Lens' AssessmentFrameworkMetadata (Maybe UTCTime) Source #

The time when the framework was most recently updated.

assessmentFrameworkMetadata_logo :: Lens' AssessmentFrameworkMetadata (Maybe Text) Source #

The logo that's associated with the framework.

assessmentFrameworkMetadata_name :: Lens' AssessmentFrameworkMetadata (Maybe Text) Source #

The name of the framework.

assessmentFrameworkMetadata_type :: Lens' AssessmentFrameworkMetadata (Maybe FrameworkType) Source #

The framework type, such as a standard framework or a custom framework.

AssessmentFrameworkShareRequest

assessmentFrameworkShareRequest_comment :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

An optional comment from the sender about the share request.

assessmentFrameworkShareRequest_complianceType :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The compliance type that the shared custom framework supports, such as CIS or HIPAA.

assessmentFrameworkShareRequest_creationTime :: Lens' AssessmentFrameworkShareRequest (Maybe UTCTime) Source #

The time when the share request was created.

assessmentFrameworkShareRequest_customControlsCount :: Lens' AssessmentFrameworkShareRequest (Maybe Int) Source #

The number of custom controls that are part of the shared custom framework.

assessmentFrameworkShareRequest_destinationAccount :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The Amazon Web Services account of the recipient.

assessmentFrameworkShareRequest_destinationRegion :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The Amazon Web Services Region of the recipient.

assessmentFrameworkShareRequest_expirationTime :: Lens' AssessmentFrameworkShareRequest (Maybe UTCTime) Source #

The time when the share request expires.

assessmentFrameworkShareRequest_frameworkDescription :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The description of the shared custom framework.

assessmentFrameworkShareRequest_frameworkId :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The unique identifier for the shared custom framework.

assessmentFrameworkShareRequest_frameworkName :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The name of the custom framework that the share request is for.

assessmentFrameworkShareRequest_id :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The unique identifier for the share request.

assessmentFrameworkShareRequest_lastUpdated :: Lens' AssessmentFrameworkShareRequest (Maybe UTCTime) Source #

Specifies when the share request was last updated.

assessmentFrameworkShareRequest_sourceAccount :: Lens' AssessmentFrameworkShareRequest (Maybe Text) Source #

The Amazon Web Services account of the sender.

assessmentFrameworkShareRequest_standardControlsCount :: Lens' AssessmentFrameworkShareRequest (Maybe Int) Source #

The number of standard controls that are part of the shared custom framework.

assessmentFrameworkShareRequest_status :: Lens' AssessmentFrameworkShareRequest (Maybe ShareRequestStatus) Source #

The status of the share request.

AssessmentMetadata

assessmentMetadata_assessmentReportsDestination :: Lens' AssessmentMetadata (Maybe AssessmentReportsDestination) Source #

The destination that evidence reports are stored in for the assessment.

assessmentMetadata_complianceType :: Lens' AssessmentMetadata (Maybe Text) Source #

The name of the compliance standard that's related to the assessment, such as PCI-DSS.

assessmentMetadata_creationTime :: Lens' AssessmentMetadata (Maybe UTCTime) Source #

Specifies when the assessment was created.

assessmentMetadata_delegations :: Lens' AssessmentMetadata (Maybe [Delegation]) Source #

The delegations that are associated with the assessment.

assessmentMetadata_description :: Lens' AssessmentMetadata (Maybe Text) Source #

The description of the assessment.

assessmentMetadata_id :: Lens' AssessmentMetadata (Maybe Text) Source #

The unique identifier for the assessment.

assessmentMetadata_lastUpdated :: Lens' AssessmentMetadata (Maybe UTCTime) Source #

The time of the most recent update.

assessmentMetadata_name :: Lens' AssessmentMetadata (Maybe Text) Source #

The name of the assessment.

assessmentMetadata_roles :: Lens' AssessmentMetadata (Maybe [Role]) Source #

The roles that are associated with the assessment.

assessmentMetadata_scope :: Lens' AssessmentMetadata (Maybe Scope) Source #

The wrapper of Amazon Web Services accounts and services that are in scope for the assessment.

assessmentMetadata_status :: Lens' AssessmentMetadata (Maybe AssessmentStatus) Source #

The overall status of the assessment.

AssessmentMetadataItem

assessmentMetadataItem_complianceType :: Lens' AssessmentMetadataItem (Maybe Text) Source #

The name of the compliance standard that's related to the assessment, such as PCI-DSS.

assessmentMetadataItem_creationTime :: Lens' AssessmentMetadataItem (Maybe UTCTime) Source #

Specifies when the assessment was created.

assessmentMetadataItem_delegations :: Lens' AssessmentMetadataItem (Maybe [Delegation]) Source #

The delegations that are associated with the assessment.

assessmentMetadataItem_id :: Lens' AssessmentMetadataItem (Maybe Text) Source #

The unique identifier for the assessment.

assessmentMetadataItem_lastUpdated :: Lens' AssessmentMetadataItem (Maybe UTCTime) Source #

The time of the most recent update.

assessmentMetadataItem_name :: Lens' AssessmentMetadataItem (Maybe Text) Source #

The name of the assessment.

assessmentMetadataItem_roles :: Lens' AssessmentMetadataItem (Maybe [Role]) Source #

The roles that are associated with the assessment.

assessmentMetadataItem_status :: Lens' AssessmentMetadataItem (Maybe AssessmentStatus) Source #

The current status of the assessment.

AssessmentReport

assessmentReport_assessmentId :: Lens' AssessmentReport (Maybe Text) Source #

The identifier for the specified assessment.

assessmentReport_assessmentName :: Lens' AssessmentReport (Maybe Text) Source #

The name of the associated assessment.

assessmentReport_author :: Lens' AssessmentReport (Maybe Text) Source #

The name of the user who created the assessment report.

assessmentReport_awsAccountId :: Lens' AssessmentReport (Maybe Text) Source #

The identifier for the specified Amazon Web Services account.

assessmentReport_creationTime :: Lens' AssessmentReport (Maybe UTCTime) Source #

Specifies when the assessment report was created.

assessmentReport_description :: Lens' AssessmentReport (Maybe Text) Source #

The description of the specified assessment report.

assessmentReport_id :: Lens' AssessmentReport (Maybe Text) Source #

The unique identifier for the assessment report.

assessmentReport_name :: Lens' AssessmentReport (Maybe Text) Source #

The name that's given to the assessment report.

assessmentReport_status :: Lens' AssessmentReport (Maybe AssessmentReportStatus) Source #

The current status of the specified assessment report.

AssessmentReportEvidenceError

assessmentReportEvidenceError_errorCode :: Lens' AssessmentReportEvidenceError (Maybe Text) Source #

The error code that was returned.

assessmentReportEvidenceError_errorMessage :: Lens' AssessmentReportEvidenceError (Maybe Text) Source #

The error message that was returned.

assessmentReportEvidenceError_evidenceId :: Lens' AssessmentReportEvidenceError (Maybe Text) Source #

The identifier for the evidence.

AssessmentReportMetadata

assessmentReportMetadata_assessmentId :: Lens' AssessmentReportMetadata (Maybe Text) Source #

The unique identifier for the associated assessment.

assessmentReportMetadata_assessmentName :: Lens' AssessmentReportMetadata (Maybe Text) Source #

The name of the associated assessment.

assessmentReportMetadata_author :: Lens' AssessmentReportMetadata (Maybe Text) Source #

The name of the user who created the assessment report.

assessmentReportMetadata_creationTime :: Lens' AssessmentReportMetadata (Maybe UTCTime) Source #

Specifies when the assessment report was created.

assessmentReportMetadata_description :: Lens' AssessmentReportMetadata (Maybe Text) Source #

The description of the assessment report.

assessmentReportMetadata_id :: Lens' AssessmentReportMetadata (Maybe Text) Source #

The unique identifier for the assessment report.

assessmentReportMetadata_name :: Lens' AssessmentReportMetadata (Maybe Text) Source #

The name of the assessment report.

assessmentReportMetadata_status :: Lens' AssessmentReportMetadata (Maybe AssessmentReportStatus) Source #

The current status of the assessment report.

AssessmentReportsDestination

assessmentReportsDestination_destination :: Lens' AssessmentReportsDestination (Maybe Text) Source #

The destination of the assessment report.

assessmentReportsDestination_destinationType :: Lens' AssessmentReportsDestination (Maybe AssessmentReportDestinationType) Source #

The destination type, such as Amazon S3.

BatchCreateDelegationByAssessmentError

batchCreateDelegationByAssessmentError_createDelegationRequest :: Lens' BatchCreateDelegationByAssessmentError (Maybe CreateDelegationRequest) Source #

The API request to batch create delegations in Audit Manager.

batchCreateDelegationByAssessmentError_errorCode :: Lens' BatchCreateDelegationByAssessmentError (Maybe Text) Source #

The error code that the BatchCreateDelegationByAssessment API returned.

batchCreateDelegationByAssessmentError_errorMessage :: Lens' BatchCreateDelegationByAssessmentError (Maybe Text) Source #

The error message that the BatchCreateDelegationByAssessment API returned.

BatchDeleteDelegationByAssessmentError

batchDeleteDelegationByAssessmentError_delegationId :: Lens' BatchDeleteDelegationByAssessmentError (Maybe Text) Source #

The identifier for the delegation.

batchDeleteDelegationByAssessmentError_errorCode :: Lens' BatchDeleteDelegationByAssessmentError (Maybe Text) Source #

The error code that the BatchDeleteDelegationByAssessment API returned.

batchDeleteDelegationByAssessmentError_errorMessage :: Lens' BatchDeleteDelegationByAssessmentError (Maybe Text) Source #

The error message that the BatchDeleteDelegationByAssessment API returned.

BatchImportEvidenceToAssessmentControlError

batchImportEvidenceToAssessmentControlError_errorCode :: Lens' BatchImportEvidenceToAssessmentControlError (Maybe Text) Source #

The error code that the BatchImportEvidenceToAssessmentControl API returned.

batchImportEvidenceToAssessmentControlError_errorMessage :: Lens' BatchImportEvidenceToAssessmentControlError (Maybe Text) Source #

The error message that the BatchImportEvidenceToAssessmentControl API returned.

batchImportEvidenceToAssessmentControlError_manualEvidence :: Lens' BatchImportEvidenceToAssessmentControlError (Maybe ManualEvidence) Source #

Manual evidence that can't be collected automatically by Audit Manager.

ChangeLog

changeLog_action :: Lens' ChangeLog (Maybe ActionEnum) Source #

The action that was performed.

changeLog_createdAt :: Lens' ChangeLog (Maybe UTCTime) Source #

The time when the action was performed and the changelog record was created.

changeLog_createdBy :: Lens' ChangeLog (Maybe Text) Source #

The IAM user or role that performed the action.

changeLog_objectName :: Lens' ChangeLog (Maybe Text) Source #

The name of the object that changed. This could be the name of an assessment, control, or control set.

changeLog_objectType :: Lens' ChangeLog (Maybe ObjectTypeEnum) Source #

The object that was changed, such as an assessment, control, or control set.

Control

control_actionPlanInstructions :: Lens' Control (Maybe Text) Source #

The recommended actions to carry out if the control isn't fulfilled.

control_actionPlanTitle :: Lens' Control (Maybe Text) Source #

The title of the action plan for remediating the control.

control_arn :: Lens' Control (Maybe Text) Source #

The Amazon Resource Name (ARN) of the control.

control_controlMappingSources :: Lens' Control (Maybe (NonEmpty ControlMappingSource)) Source #

The data mapping sources for the control.

control_controlSources :: Lens' Control (Maybe Text) Source #

The data source types that determine where Audit Manager collects evidence from for the control.

control_createdAt :: Lens' Control (Maybe UTCTime) Source #

The time when the control was created.

control_createdBy :: Lens' Control (Maybe Text) Source #

The IAM user or role that created the control.

control_description :: Lens' Control (Maybe Text) Source #

The description of the control.

control_id :: Lens' Control (Maybe Text) Source #

The unique identifier for the control.

control_lastUpdatedAt :: Lens' Control (Maybe UTCTime) Source #

The time when the control was most recently updated.

control_lastUpdatedBy :: Lens' Control (Maybe Text) Source #

The IAM user or role that most recently updated the control.

control_name :: Lens' Control (Maybe Text) Source #

The name of the control.

control_tags :: Lens' Control (Maybe (HashMap Text Text)) Source #

The tags associated with the control.

control_testingInformation :: Lens' Control (Maybe Text) Source #

The steps that you should follow to determine if the control has been satisfied.

control_type :: Lens' Control (Maybe ControlType) Source #

The type of control, such as a custom control or a standard control.

ControlComment

controlComment_authorName :: Lens' ControlComment (Maybe Text) Source #

The name of the user who authored the comment.

controlComment_commentBody :: Lens' ControlComment (Maybe Text) Source #

The body text of a control comment.

controlComment_postedDate :: Lens' ControlComment (Maybe UTCTime) Source #

The time when the comment was posted.

ControlDomainInsights

controlDomainInsights_controlsCountByNoncompliantEvidence :: Lens' ControlDomainInsights (Maybe Int) Source #

The number of controls in the control domain that collected non-compliant evidence on the lastUpdated date.

controlDomainInsights_evidenceInsights :: Lens' ControlDomainInsights (Maybe EvidenceInsights) Source #

A breakdown of the compliance check status for the evidence that’s associated with the control domain.

controlDomainInsights_id :: Lens' ControlDomainInsights (Maybe Text) Source #

The unique identifier for the control domain.

controlDomainInsights_lastUpdated :: Lens' ControlDomainInsights (Maybe UTCTime) Source #

The time when the control domain insights were last updated.

controlDomainInsights_name :: Lens' ControlDomainInsights (Maybe Text) Source #

The name of the control domain.

controlDomainInsights_totalControlsCount :: Lens' ControlDomainInsights (Maybe Int) Source #

The total number of controls in the control domain.

ControlInsightsMetadataByAssessmentItem

controlInsightsMetadataByAssessmentItem_controlSetName :: Lens' ControlInsightsMetadataByAssessmentItem (Maybe Text) Source #

The name of the control set that the assessment control belongs to.

controlInsightsMetadataByAssessmentItem_evidenceInsights :: Lens' ControlInsightsMetadataByAssessmentItem (Maybe EvidenceInsights) Source #

A breakdown of the compliance check status for the evidence that’s associated with the assessment control.

controlInsightsMetadataByAssessmentItem_id :: Lens' ControlInsightsMetadataByAssessmentItem (Maybe Text) Source #

The unique identifier for the assessment control.

controlInsightsMetadataByAssessmentItem_lastUpdated :: Lens' ControlInsightsMetadataByAssessmentItem (Maybe UTCTime) Source #

The time when the assessment control insights were last updated.

controlInsightsMetadataByAssessmentItem_name :: Lens' ControlInsightsMetadataByAssessmentItem (Maybe Text) Source #

The name of the assessment control.

ControlInsightsMetadataItem

controlInsightsMetadataItem_evidenceInsights :: Lens' ControlInsightsMetadataItem (Maybe EvidenceInsights) Source #

A breakdown of the compliance check status for the evidence that’s associated with the control.

controlInsightsMetadataItem_id :: Lens' ControlInsightsMetadataItem (Maybe Text) Source #

The unique identifier for the control.

controlInsightsMetadataItem_lastUpdated :: Lens' ControlInsightsMetadataItem (Maybe UTCTime) Source #

The time when the control insights were last updated.

controlInsightsMetadataItem_name :: Lens' ControlInsightsMetadataItem (Maybe Text) Source #

The name of the control.

ControlMappingSource

controlMappingSource_sourceDescription :: Lens' ControlMappingSource (Maybe Text) Source #

The description of the source.

controlMappingSource_sourceFrequency :: Lens' ControlMappingSource (Maybe SourceFrequency) Source #

The frequency of evidence collection for the control mapping source.

controlMappingSource_sourceId :: Lens' ControlMappingSource (Maybe Text) Source #

The unique identifier for the source.

controlMappingSource_sourceKeyword :: Lens' ControlMappingSource (Maybe SourceKeyword) Source #

Undocumented member.

controlMappingSource_sourceName :: Lens' ControlMappingSource (Maybe Text) Source #

The name of the source.

controlMappingSource_sourceSetUpOption :: Lens' ControlMappingSource (Maybe SourceSetUpOption) Source #

The setup option for the data source. This option reflects if the evidence collection is automated or manual.

controlMappingSource_sourceType :: Lens' ControlMappingSource (Maybe SourceType) Source #

Specifies one of the five data source types for evidence collection.

controlMappingSource_troubleshootingText :: Lens' ControlMappingSource (Maybe Text) Source #

The instructions for troubleshooting the control.

ControlMetadata

controlMetadata_arn :: Lens' ControlMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the control.

controlMetadata_controlSources :: Lens' ControlMetadata (Maybe Text) Source #

The data source that determines where Audit Manager collects evidence from for the control.

controlMetadata_createdAt :: Lens' ControlMetadata (Maybe UTCTime) Source #

The time when the control was created.

controlMetadata_id :: Lens' ControlMetadata (Maybe Text) Source #

The unique identifier for the control.

controlMetadata_lastUpdatedAt :: Lens' ControlMetadata (Maybe UTCTime) Source #

The time when the control was most recently updated.

controlMetadata_name :: Lens' ControlMetadata (Maybe Text) Source #

The name of the control.

ControlSet

controlSet_controls :: Lens' ControlSet (Maybe (NonEmpty Control)) Source #

The list of controls within the control set.

controlSet_id :: Lens' ControlSet (Maybe Text) Source #

The identifier of the control set in the assessment. This is the control set name in a plain string format.

controlSet_name :: Lens' ControlSet (Maybe Text) Source #

The name of the control set.

CreateAssessmentFrameworkControl

createAssessmentFrameworkControl_id :: Lens' CreateAssessmentFrameworkControl Text Source #

The unique identifier of the control.

CreateAssessmentFrameworkControlSet

createAssessmentFrameworkControlSet_controls :: Lens' CreateAssessmentFrameworkControlSet (Maybe (NonEmpty CreateAssessmentFrameworkControl)) Source #

The list of controls within the control set. This doesn't contain the control set ID.

createAssessmentFrameworkControlSet_name :: Lens' CreateAssessmentFrameworkControlSet Text Source #

The name of the control set.

CreateControlMappingSource

createControlMappingSource_sourceDescription :: Lens' CreateControlMappingSource (Maybe Text) Source #

The description of the data source that determines where Audit Manager collects evidence from for the control.

createControlMappingSource_sourceFrequency :: Lens' CreateControlMappingSource (Maybe SourceFrequency) Source #

The frequency of evidence collection for the control mapping source.

createControlMappingSource_sourceKeyword :: Lens' CreateControlMappingSource (Maybe SourceKeyword) Source #

Undocumented member.

createControlMappingSource_sourceName :: Lens' CreateControlMappingSource (Maybe Text) Source #

The name of the control mapping data source.

createControlMappingSource_sourceSetUpOption :: Lens' CreateControlMappingSource (Maybe SourceSetUpOption) Source #

The setup option for the data source, which reflects if the evidence collection is automated or manual.

createControlMappingSource_sourceType :: Lens' CreateControlMappingSource (Maybe SourceType) Source #

Specifies one of the five types of data sources for evidence collection.

createControlMappingSource_troubleshootingText :: Lens' CreateControlMappingSource (Maybe Text) Source #

The instructions for troubleshooting the control.

CreateDelegationRequest

createDelegationRequest_comment :: Lens' CreateDelegationRequest (Maybe Text) Source #

A comment that's related to the delegation request.

createDelegationRequest_controlSetId :: Lens' CreateDelegationRequest (Maybe Text) Source #

The unique identifier for the control set.

createDelegationRequest_roleArn :: Lens' CreateDelegationRequest (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role.

createDelegationRequest_roleType :: Lens' CreateDelegationRequest (Maybe RoleType) Source #

The type of customer persona.

In CreateAssessment, roleType can only be PROCESS_OWNER.

In UpdateSettings, roleType can only be PROCESS_OWNER.

In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.

Delegation

delegation_assessmentId :: Lens' Delegation (Maybe Text) Source #

The identifier for the assessment that's associated with the delegation.

delegation_assessmentName :: Lens' Delegation (Maybe Text) Source #

The name of the assessment that's associated with the delegation.

delegation_comment :: Lens' Delegation (Maybe Text) Source #

The comment that's related to the delegation.

delegation_controlSetId :: Lens' Delegation (Maybe Text) Source #

The identifier for the control set that's associated with the delegation.

delegation_createdBy :: Lens' Delegation (Maybe Text) Source #

The IAM user or role that created the delegation.

delegation_creationTime :: Lens' Delegation (Maybe UTCTime) Source #

Specifies when the delegation was created.

delegation_id :: Lens' Delegation (Maybe Text) Source #

The unique identifier for the delegation.

delegation_lastUpdated :: Lens' Delegation (Maybe UTCTime) Source #

Specifies when the delegation was last updated.

delegation_roleArn :: Lens' Delegation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role.

delegation_roleType :: Lens' Delegation (Maybe RoleType) Source #

The type of customer persona.

In CreateAssessment, roleType can only be PROCESS_OWNER.

In UpdateSettings, roleType can only be PROCESS_OWNER.

In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.

delegation_status :: Lens' Delegation (Maybe DelegationStatus) Source #

The status of the delegation.

DelegationMetadata

delegationMetadata_assessmentId :: Lens' DelegationMetadata (Maybe Text) Source #

The unique identifier for the assessment.

delegationMetadata_assessmentName :: Lens' DelegationMetadata (Maybe Text) Source #

The name of the associated assessment.

delegationMetadata_controlSetName :: Lens' DelegationMetadata (Maybe Text) Source #

Specifies the name of the control set that was delegated for review.

delegationMetadata_creationTime :: Lens' DelegationMetadata (Maybe UTCTime) Source #

Specifies when the delegation was created.

delegationMetadata_id :: Lens' DelegationMetadata (Maybe Text) Source #

The unique identifier for the delegation.

delegationMetadata_roleArn :: Lens' DelegationMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role.

delegationMetadata_status :: Lens' DelegationMetadata (Maybe DelegationStatus) Source #

The current status of the delegation.

DeregistrationPolicy

deregistrationPolicy_deleteResources :: Lens' DeregistrationPolicy (Maybe DeleteResources) Source #

Specifies which Audit Manager data will be deleted when you deregister Audit Manager.

If you set the value to ALL, all of your data is deleted within seven days of deregistration.
If you set the value to DEFAULT, 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.

Evidence

evidence_assessmentReportSelection :: Lens' Evidence (Maybe Text) Source #

Specifies whether the evidence is included in the assessment report.

evidence_attributes :: Lens' Evidence (Maybe (HashMap Text Text)) Source #

The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).

evidence_awsAccountId :: Lens' Evidence (Maybe Text) Source #

The identifier for the Amazon Web Services account.

evidence_awsOrganization :: Lens' Evidence (Maybe Text) Source #

The Amazon Web Services account that the evidence is collected from, and its organization path.

evidence_complianceCheck :: Lens' Evidence (Maybe Text) Source #

The evaluation status for automated evidence that falls under the compliance check category.

Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.
Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.
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).

evidence_dataSource :: Lens' Evidence (Maybe Text) Source #

The data source where the evidence was collected from.

evidence_eventName :: Lens' Evidence (Maybe Text) Source #

The name of the evidence event.

evidence_eventSource :: Lens' Evidence (Maybe Text) Source #

The Amazon Web Service that the evidence is collected from.

evidence_evidenceAwsAccountId :: Lens' Evidence (Maybe Text) Source #

The identifier for the Amazon Web Services account.

evidence_evidenceByType :: Lens' Evidence (Maybe Text) Source #

The type of automated evidence.

evidence_evidenceFolderId :: Lens' Evidence (Maybe Text) Source #

The identifier for the folder that the evidence is stored in.

evidence_iamId :: Lens' Evidence (Maybe Text) Source #

The unique identifier for the IAM user or role that's associated with the evidence.

evidence_id :: Lens' Evidence (Maybe Text) Source #

The identifier for the evidence.

evidence_resourcesIncluded :: Lens' Evidence (Maybe [Resource]) Source #

The list of resources that are assessed to generate the evidence.

evidence_time :: Lens' Evidence (Maybe UTCTime) Source #

The timestamp that represents when the evidence was collected.

EvidenceFinderEnablement

evidenceFinderEnablement_backfillStatus :: Lens' EvidenceFinderEnablement (Maybe EvidenceFinderBackfillStatus) Source #

The current status of the evidence data backfill process.

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.

NOT_STARTED means that the backfill hasn’t started yet.
IN_PROGRESS means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data.
COMPLETED means that the backfill is complete. All of your past evidence is now queryable.

evidenceFinderEnablement_enablementStatus :: Lens' EvidenceFinderEnablement (Maybe EvidenceFinderEnablementStatus) Source #

The current status of the evidence finder feature and the related event data store.

ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.
ENABLED 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.
DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.
DISABLED 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.

evidenceFinderEnablement_error :: Lens' EvidenceFinderEnablement (Maybe Text) Source #

Represents any errors that occurred when enabling or disabling evidence finder.

evidenceFinderEnablement_eventDataStoreArn :: Lens' EvidenceFinderEnablement (Maybe Text) Source #

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.

EvidenceInsights

evidenceInsights_compliantEvidenceCount :: Lens' EvidenceInsights (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

evidenceInsights_inconclusiveEvidenceCount :: Lens' EvidenceInsights (Maybe Int) Source #

The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data.

evidenceInsights_noncompliantEvidenceCount :: Lens' EvidenceInsights (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

Framework

framework_arn :: Lens' Framework (Maybe Text) Source #

The Amazon Resource Name (ARN) of the framework.

framework_complianceType :: Lens' Framework (Maybe Text) Source #

The compliance type that the new custom framework supports, such as CIS or HIPAA.

framework_controlSets :: Lens' Framework (Maybe (NonEmpty ControlSet)) Source #

The control sets that are associated with the framework.

framework_controlSources :: Lens' Framework (Maybe Text) Source #

The sources that Audit Manager collects evidence from for the control.

framework_createdAt :: Lens' Framework (Maybe UTCTime) Source #

The time when the framework was created.

framework_createdBy :: Lens' Framework (Maybe Text) Source #

The IAM user or role that created the framework.

framework_description :: Lens' Framework (Maybe Text) Source #

The description of the framework.

framework_id :: Lens' Framework (Maybe Text) Source #

The unique identifier for the framework.

framework_lastUpdatedAt :: Lens' Framework (Maybe UTCTime) Source #

The time when the framework was most recently updated.

framework_lastUpdatedBy :: Lens' Framework (Maybe Text) Source #

The IAM user or role that most recently updated the framework.

framework_logo :: Lens' Framework (Maybe Text) Source #

The logo that's associated with the framework.

framework_name :: Lens' Framework (Maybe Text) Source #

The name of the framework.

framework_tags :: Lens' Framework (Maybe (HashMap Text Text)) Source #

The tags that are associated with the framework.

framework_type :: Lens' Framework (Maybe FrameworkType) Source #

The framework type, such as a custom framework or a standard framework.

FrameworkMetadata

frameworkMetadata_complianceType :: Lens' FrameworkMetadata (Maybe Text) Source #

The compliance standard that's associated with the framework. For example, this could be PCI DSS or HIPAA.

frameworkMetadata_description :: Lens' FrameworkMetadata (Maybe Text) Source #

The description of the framework.

frameworkMetadata_logo :: Lens' FrameworkMetadata (Maybe Text) Source #

The logo that's associated with the framework.

frameworkMetadata_name :: Lens' FrameworkMetadata (Maybe Text) Source #

The name of the framework.

Insights

insights_activeAssessmentsCount :: Lens' Insights (Maybe Int) Source #

The number of active assessments in Audit Manager.

insights_assessmentControlsCountByNoncompliantEvidence :: Lens' Insights (Maybe Int) Source #

The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

insights_compliantEvidenceCount :: Lens' Insights (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

insights_inconclusiveEvidenceCount :: Lens' Insights (Maybe Int) Source #

The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data.

insights_lastUpdated :: Lens' Insights (Maybe UTCTime) Source #

The time when the cross-assessment insights were last updated.

insights_noncompliantEvidenceCount :: Lens' Insights (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

insights_totalAssessmentControlsCount :: Lens' Insights (Maybe Int) Source #

The total number of controls across all active assessments.

InsightsByAssessment

insightsByAssessment_assessmentControlsCountByNoncompliantEvidence :: Lens' InsightsByAssessment (Maybe Int) Source #

The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

insightsByAssessment_compliantEvidenceCount :: Lens' InsightsByAssessment (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

insightsByAssessment_inconclusiveEvidenceCount :: Lens' InsightsByAssessment (Maybe Int) Source #

The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data.

insightsByAssessment_lastUpdated :: Lens' InsightsByAssessment (Maybe UTCTime) Source #

The time when the assessment insights were last updated.

insightsByAssessment_noncompliantEvidenceCount :: Lens' InsightsByAssessment (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

insightsByAssessment_totalAssessmentControlsCount :: Lens' InsightsByAssessment (Maybe Int) Source #

The total number of controls in the assessment.

ManualEvidence

manualEvidence_s3ResourcePath :: Lens' ManualEvidence (Maybe Text) Source #

The Amazon S3 URL that points to a manual evidence object.

Notification

notification_assessmentId :: Lens' Notification (Maybe Text) Source #

The identifier for the assessment.

notification_assessmentName :: Lens' Notification (Maybe Text) Source #

The name of the related assessment.

notification_controlSetId :: Lens' Notification (Maybe Text) Source #

The identifier for the control set.

notification_controlSetName :: Lens' Notification (Maybe Text) Source #

Specifies the name of the control set that the notification is about.

notification_description :: Lens' Notification (Maybe Text) Source #

The description of the notification.

notification_eventTime :: Lens' Notification (Maybe UTCTime) Source #

The time when the notification was sent.

notification_id :: Lens' Notification (Maybe Text) Source #

The unique identifier for the notification.

notification_source :: Lens' Notification (Maybe Text) Source #

The sender of the notification.

Resource

resource_arn :: Lens' Resource (Maybe Text) Source #

The Amazon Resource Name (ARN) for the resource.

resource_complianceCheck :: Lens' Resource (Maybe Text) Source #

The evaluation status for a resource that was assessed when collecting compliance check evidence.

Audit Manager classes the resource as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.
Audit Manager classes the resource as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.
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).

resource_value :: Lens' Resource (Maybe Text) Source #

The value of the resource.

Role

role_roleType :: Lens' Role RoleType Source #

The type of customer persona.

In CreateAssessment, roleType can only be PROCESS_OWNER.

In UpdateSettings, roleType can only be PROCESS_OWNER.

In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.

role_roleArn :: Lens' Role Text Source #

The Amazon Resource Name (ARN) of the IAM role.

Scope

scope_awsAccounts :: Lens' Scope (Maybe [AWSAccount]) Source #

The Amazon Web Services accounts that are included in the scope of the assessment.

scope_awsServices :: Lens' Scope (Maybe [AWSService]) Source #

The Amazon Web Services services that are included in the scope of the assessment.

ServiceMetadata

serviceMetadata_category :: Lens' ServiceMetadata (Maybe Text) Source #

The category that the Amazon Web Service belongs to, such as compute, storage, or database.

serviceMetadata_description :: Lens' ServiceMetadata (Maybe Text) Source #

The description of the Amazon Web Service.

serviceMetadata_displayName :: Lens' ServiceMetadata (Maybe Text) Source #

The display name of the Amazon Web Service.

serviceMetadata_name :: Lens' ServiceMetadata (Maybe Text) Source #

The name of the Amazon Web Service.

Settings

settings_defaultAssessmentReportsDestination :: Lens' Settings (Maybe AssessmentReportsDestination) Source #

The default storage destination for assessment reports.

settings_defaultProcessOwners :: Lens' Settings (Maybe [Role]) Source #

The designated default audit owners.

settings_deregistrationPolicy :: Lens' Settings (Maybe DeregistrationPolicy) Source #

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.

settings_evidenceFinderEnablement :: Lens' Settings (Maybe EvidenceFinderEnablement) Source #

The current evidence finder status and event data store details.

settings_isAwsOrgEnabled :: Lens' Settings (Maybe Bool) Source #

Specifies whether Organizations is enabled.

settings_kmsKey :: Lens' Settings (Maybe Text) Source #

The KMS key details.

settings_snsTopic :: Lens' Settings (Maybe Text) Source #

The designated Amazon Simple Notification Service (Amazon SNS) topic.

SourceKeyword

sourceKeyword_keywordInputType :: Lens' SourceKeyword (Maybe KeywordInputType) Source #

The input method for the keyword.

sourceKeyword_keywordValue :: Lens' SourceKeyword (Maybe Text) Source #

The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.

If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:

For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules.
- Managed rule name: s3-bucket-acl-prohibited
  keywordValue: S3_BUCKET_ACL_PROHIBITED
For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the rule from a managed rule.
- Custom rule name: my-custom-config-rule
  keywordValue: Custom_my-custom-config-rule
For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
- Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
  keywordValue: Custom_CustomRuleForAccount-conformance-pack
- Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
  keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled

URL

url_hyperlinkName :: Lens' URL (Maybe Text) Source #

The name or word that's used as a hyperlink to the URL.

url_link :: Lens' URL (Maybe Text) Source #

The unique identifier for the internet resource.

UpdateAssessmentFrameworkControlSet

updateAssessmentFrameworkControlSet_id :: Lens' UpdateAssessmentFrameworkControlSet (Maybe Text) Source #

The unique identifier for the control set.

updateAssessmentFrameworkControlSet_name :: Lens' UpdateAssessmentFrameworkControlSet Text Source #

The name of the control set.

updateAssessmentFrameworkControlSet_controls :: Lens' UpdateAssessmentFrameworkControlSet (NonEmpty CreateAssessmentFrameworkControl) Source #

The list of controls that are contained within the control set.