Type definitions#
Index > AuditManager > Type definitions
Auto-generated documentation for AuditManager type annotations stubs module mypy-boto3-auditmanager.
AWSAccountTypeDef#
# AWSAccountTypeDef definition
class AWSAccountTypeDef(TypedDict):
id: NotRequired[str],
emailAddress: NotRequired[str],
name: NotRequired[str],
AWSServiceTypeDef#
# AWSServiceTypeDef definition
class AWSServiceTypeDef(TypedDict):
serviceName: NotRequired[str],
DelegationTypeDef#
# DelegationTypeDef definition
class DelegationTypeDef(TypedDict):
id: NotRequired[str],
assessmentName: NotRequired[str],
assessmentId: NotRequired[str],
status: NotRequired[DelegationStatusType], # (1)
roleArn: NotRequired[str],
roleType: NotRequired[RoleTypeType], # (2)
creationTime: NotRequired[datetime],
lastUpdated: NotRequired[datetime],
controlSetId: NotRequired[str],
comment: NotRequired[str],
createdBy: NotRequired[str],
- See DelegationStatusType
- See RoleTypeType
RoleTypeDef#
# RoleTypeDef definition
class RoleTypeDef(TypedDict):
roleType: RoleTypeType, # (1)
roleArn: str,
- See RoleTypeType
ControlCommentTypeDef#
# ControlCommentTypeDef definition
class ControlCommentTypeDef(TypedDict):
authorName: NotRequired[str],
commentBody: NotRequired[str],
postedDate: NotRequired[datetime],
AssessmentEvidenceFolderTypeDef#
# AssessmentEvidenceFolderTypeDef definition
class AssessmentEvidenceFolderTypeDef(TypedDict):
name: NotRequired[str],
date: NotRequired[datetime],
assessmentId: NotRequired[str],
controlSetId: NotRequired[str],
controlId: NotRequired[str],
id: NotRequired[str],
dataSource: NotRequired[str],
author: NotRequired[str],
totalEvidence: NotRequired[int],
assessmentReportSelectionCount: NotRequired[int],
controlName: NotRequired[str],
evidenceResourcesIncludedCount: NotRequired[int],
evidenceByTypeConfigurationDataCount: NotRequired[int],
evidenceByTypeManualCount: NotRequired[int],
evidenceByTypeComplianceCheckCount: NotRequired[int],
evidenceByTypeComplianceCheckIssuesCount: NotRequired[int],
evidenceByTypeUserActivityCount: NotRequired[int],
evidenceAwsServiceSourceCount: NotRequired[int],
AssessmentFrameworkMetadataTypeDef#
# AssessmentFrameworkMetadataTypeDef definition
class AssessmentFrameworkMetadataTypeDef(TypedDict):
arn: NotRequired[str],
id: NotRequired[str],
type: NotRequired[FrameworkTypeType], # (1)
name: NotRequired[str],
description: NotRequired[str],
logo: NotRequired[str],
complianceType: NotRequired[str],
controlsCount: NotRequired[int],
controlSetsCount: NotRequired[int],
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
AssessmentFrameworkShareRequestTypeDef#
# AssessmentFrameworkShareRequestTypeDef definition
class AssessmentFrameworkShareRequestTypeDef(TypedDict):
id: NotRequired[str],
frameworkId: NotRequired[str],
frameworkName: NotRequired[str],
frameworkDescription: NotRequired[str],
status: NotRequired[ShareRequestStatusType], # (1)
sourceAccount: NotRequired[str],
destinationAccount: NotRequired[str],
destinationRegion: NotRequired[str],
expirationTime: NotRequired[datetime],
creationTime: NotRequired[datetime],
lastUpdated: NotRequired[datetime],
comment: NotRequired[str],
standardControlsCount: NotRequired[int],
customControlsCount: NotRequired[int],
complianceType: NotRequired[str],
FrameworkMetadataTypeDef#
# FrameworkMetadataTypeDef definition
class FrameworkMetadataTypeDef(TypedDict):
name: NotRequired[str],
description: NotRequired[str],
logo: NotRequired[str],
complianceType: NotRequired[str],
AssessmentReportsDestinationTypeDef#
# AssessmentReportsDestinationTypeDef definition
class AssessmentReportsDestinationTypeDef(TypedDict):
destinationType: NotRequired[AssessmentReportDestinationTypeType], # (1)
destination: NotRequired[str],
AssessmentReportEvidenceErrorTypeDef#
# AssessmentReportEvidenceErrorTypeDef definition
class AssessmentReportEvidenceErrorTypeDef(TypedDict):
evidenceId: NotRequired[str],
errorCode: NotRequired[str],
errorMessage: NotRequired[str],
AssessmentReportMetadataTypeDef#
# AssessmentReportMetadataTypeDef definition
class AssessmentReportMetadataTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
description: NotRequired[str],
assessmentId: NotRequired[str],
assessmentName: NotRequired[str],
author: NotRequired[str],
status: NotRequired[AssessmentReportStatusType], # (1)
creationTime: NotRequired[datetime],
AssessmentReportTypeDef#
# AssessmentReportTypeDef definition
class AssessmentReportTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
description: NotRequired[str],
awsAccountId: NotRequired[str],
assessmentId: NotRequired[str],
assessmentName: NotRequired[str],
author: NotRequired[str],
status: NotRequired[AssessmentReportStatusType], # (1)
creationTime: NotRequired[datetime],
AssociateAssessmentReportEvidenceFolderRequestRequestTypeDef#
# AssociateAssessmentReportEvidenceFolderRequestRequestTypeDef definition
class AssociateAssessmentReportEvidenceFolderRequestRequestTypeDef(TypedDict):
assessmentId: str,
evidenceFolderId: str,
BatchAssociateAssessmentReportEvidenceRequestRequestTypeDef#
# BatchAssociateAssessmentReportEvidenceRequestRequestTypeDef definition
class BatchAssociateAssessmentReportEvidenceRequestRequestTypeDef(TypedDict):
assessmentId: str,
evidenceFolderId: str,
evidenceIds: Sequence[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateDelegationRequestTypeDef#
# CreateDelegationRequestTypeDef definition
class CreateDelegationRequestTypeDef(TypedDict):
comment: NotRequired[str],
controlSetId: NotRequired[str],
roleArn: NotRequired[str],
roleType: NotRequired[RoleTypeType], # (1)
- See RoleTypeType
BatchDeleteDelegationByAssessmentErrorTypeDef#
# BatchDeleteDelegationByAssessmentErrorTypeDef definition
class BatchDeleteDelegationByAssessmentErrorTypeDef(TypedDict):
delegationId: NotRequired[str],
errorCode: NotRequired[str],
errorMessage: NotRequired[str],
BatchDeleteDelegationByAssessmentRequestRequestTypeDef#
# BatchDeleteDelegationByAssessmentRequestRequestTypeDef definition
class BatchDeleteDelegationByAssessmentRequestRequestTypeDef(TypedDict):
delegationIds: Sequence[str],
assessmentId: str,
BatchDisassociateAssessmentReportEvidenceRequestRequestTypeDef#
# BatchDisassociateAssessmentReportEvidenceRequestRequestTypeDef definition
class BatchDisassociateAssessmentReportEvidenceRequestRequestTypeDef(TypedDict):
assessmentId: str,
evidenceFolderId: str,
evidenceIds: Sequence[str],
ManualEvidenceTypeDef#
# ManualEvidenceTypeDef definition
class ManualEvidenceTypeDef(TypedDict):
s3ResourcePath: NotRequired[str],
textResponse: NotRequired[str],
evidenceFileName: NotRequired[str],
ChangeLogTypeDef#
# ChangeLogTypeDef definition
class ChangeLogTypeDef(TypedDict):
objectType: NotRequired[ObjectTypeEnumType], # (1)
objectName: NotRequired[str],
action: NotRequired[ActionEnumType], # (2)
createdAt: NotRequired[datetime],
createdBy: NotRequired[str],
- See ObjectTypeEnumType
- See ActionEnumType
EvidenceInsightsTypeDef#
# EvidenceInsightsTypeDef definition
class EvidenceInsightsTypeDef(TypedDict):
noncompliantEvidenceCount: NotRequired[int],
compliantEvidenceCount: NotRequired[int],
inconclusiveEvidenceCount: NotRequired[int],
SourceKeywordTypeDef#
# SourceKeywordTypeDef definition
class SourceKeywordTypeDef(TypedDict):
keywordInputType: NotRequired[KeywordInputTypeType], # (1)
keywordValue: NotRequired[str],
ControlMetadataTypeDef#
# ControlMetadataTypeDef definition
class ControlMetadataTypeDef(TypedDict):
arn: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
controlSources: NotRequired[str],
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
CreateAssessmentFrameworkControlTypeDef#
# CreateAssessmentFrameworkControlTypeDef definition
class CreateAssessmentFrameworkControlTypeDef(TypedDict):
id: str,
CreateAssessmentReportRequestRequestTypeDef#
# CreateAssessmentReportRequestRequestTypeDef definition
class CreateAssessmentReportRequestRequestTypeDef(TypedDict):
name: str,
assessmentId: str,
description: NotRequired[str],
queryStatement: NotRequired[str],
DefaultExportDestinationTypeDef#
# DefaultExportDestinationTypeDef definition
class DefaultExportDestinationTypeDef(TypedDict):
destinationType: NotRequired[ExportDestinationTypeType], # (1)
destination: NotRequired[str],
DelegationMetadataTypeDef#
# DelegationMetadataTypeDef definition
class DelegationMetadataTypeDef(TypedDict):
id: NotRequired[str],
assessmentName: NotRequired[str],
assessmentId: NotRequired[str],
status: NotRequired[DelegationStatusType], # (1)
roleArn: NotRequired[str],
creationTime: NotRequired[datetime],
controlSetName: NotRequired[str],
DeleteAssessmentFrameworkRequestRequestTypeDef#
# DeleteAssessmentFrameworkRequestRequestTypeDef definition
class DeleteAssessmentFrameworkRequestRequestTypeDef(TypedDict):
frameworkId: str,
DeleteAssessmentFrameworkShareRequestRequestTypeDef#
# DeleteAssessmentFrameworkShareRequestRequestTypeDef definition
class DeleteAssessmentFrameworkShareRequestRequestTypeDef(TypedDict):
requestId: str,
requestType: ShareRequestTypeType, # (1)
DeleteAssessmentReportRequestRequestTypeDef#
# DeleteAssessmentReportRequestRequestTypeDef definition
class DeleteAssessmentReportRequestRequestTypeDef(TypedDict):
assessmentId: str,
assessmentReportId: str,
DeleteAssessmentRequestRequestTypeDef#
# DeleteAssessmentRequestRequestTypeDef definition
class DeleteAssessmentRequestRequestTypeDef(TypedDict):
assessmentId: str,
DeleteControlRequestRequestTypeDef#
# DeleteControlRequestRequestTypeDef definition
class DeleteControlRequestRequestTypeDef(TypedDict):
controlId: str,
DeregisterOrganizationAdminAccountRequestRequestTypeDef#
# DeregisterOrganizationAdminAccountRequestRequestTypeDef definition
class DeregisterOrganizationAdminAccountRequestRequestTypeDef(TypedDict):
adminAccountId: NotRequired[str],
DeregistrationPolicyTypeDef#
# DeregistrationPolicyTypeDef definition
class DeregistrationPolicyTypeDef(TypedDict):
deleteResources: NotRequired[DeleteResourcesType], # (1)
DisassociateAssessmentReportEvidenceFolderRequestRequestTypeDef#
# DisassociateAssessmentReportEvidenceFolderRequestRequestTypeDef definition
class DisassociateAssessmentReportEvidenceFolderRequestRequestTypeDef(TypedDict):
assessmentId: str,
evidenceFolderId: str,
EvidenceFinderEnablementTypeDef#
# EvidenceFinderEnablementTypeDef definition
class EvidenceFinderEnablementTypeDef(TypedDict):
eventDataStoreArn: NotRequired[str],
enablementStatus: NotRequired[EvidenceFinderEnablementStatusType], # (1)
backfillStatus: NotRequired[EvidenceFinderBackfillStatusType], # (2)
error: NotRequired[str],
ResourceTypeDef#
# ResourceTypeDef definition
class ResourceTypeDef(TypedDict):
arn: NotRequired[str],
value: NotRequired[str],
complianceCheck: NotRequired[str],
GetAssessmentFrameworkRequestRequestTypeDef#
# GetAssessmentFrameworkRequestRequestTypeDef definition
class GetAssessmentFrameworkRequestRequestTypeDef(TypedDict):
frameworkId: str,
GetAssessmentReportUrlRequestRequestTypeDef#
# GetAssessmentReportUrlRequestRequestTypeDef definition
class GetAssessmentReportUrlRequestRequestTypeDef(TypedDict):
assessmentReportId: str,
assessmentId: str,
URLTypeDef#
# URLTypeDef definition
class URLTypeDef(TypedDict):
hyperlinkName: NotRequired[str],
link: NotRequired[str],
GetAssessmentRequestRequestTypeDef#
# GetAssessmentRequestRequestTypeDef definition
class GetAssessmentRequestRequestTypeDef(TypedDict):
assessmentId: str,
GetChangeLogsRequestRequestTypeDef#
# GetChangeLogsRequestRequestTypeDef definition
class GetChangeLogsRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: NotRequired[str],
controlId: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetControlRequestRequestTypeDef#
# GetControlRequestRequestTypeDef definition
class GetControlRequestRequestTypeDef(TypedDict):
controlId: str,
GetDelegationsRequestRequestTypeDef#
# GetDelegationsRequestRequestTypeDef definition
class GetDelegationsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetEvidenceByEvidenceFolderRequestRequestTypeDef#
# GetEvidenceByEvidenceFolderRequestRequestTypeDef definition
class GetEvidenceByEvidenceFolderRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: str,
evidenceFolderId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetEvidenceFileUploadUrlRequestRequestTypeDef#
# GetEvidenceFileUploadUrlRequestRequestTypeDef definition
class GetEvidenceFileUploadUrlRequestRequestTypeDef(TypedDict):
fileName: str,
GetEvidenceFolderRequestRequestTypeDef#
# GetEvidenceFolderRequestRequestTypeDef definition
class GetEvidenceFolderRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: str,
evidenceFolderId: str,
GetEvidenceFoldersByAssessmentControlRequestRequestTypeDef#
# GetEvidenceFoldersByAssessmentControlRequestRequestTypeDef definition
class GetEvidenceFoldersByAssessmentControlRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: str,
controlId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetEvidenceFoldersByAssessmentRequestRequestTypeDef#
# GetEvidenceFoldersByAssessmentRequestRequestTypeDef definition
class GetEvidenceFoldersByAssessmentRequestRequestTypeDef(TypedDict):
assessmentId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
GetEvidenceRequestRequestTypeDef#
# GetEvidenceRequestRequestTypeDef definition
class GetEvidenceRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: str,
evidenceFolderId: str,
evidenceId: str,
GetInsightsByAssessmentRequestRequestTypeDef#
# GetInsightsByAssessmentRequestRequestTypeDef definition
class GetInsightsByAssessmentRequestRequestTypeDef(TypedDict):
assessmentId: str,
InsightsByAssessmentTypeDef#
# InsightsByAssessmentTypeDef definition
class InsightsByAssessmentTypeDef(TypedDict):
noncompliantEvidenceCount: NotRequired[int],
compliantEvidenceCount: NotRequired[int],
inconclusiveEvidenceCount: NotRequired[int],
assessmentControlsCountByNoncompliantEvidence: NotRequired[int],
totalAssessmentControlsCount: NotRequired[int],
lastUpdated: NotRequired[datetime],
InsightsTypeDef#
# InsightsTypeDef definition
class InsightsTypeDef(TypedDict):
activeAssessmentsCount: NotRequired[int],
noncompliantEvidenceCount: NotRequired[int],
compliantEvidenceCount: NotRequired[int],
inconclusiveEvidenceCount: NotRequired[int],
assessmentControlsCountByNoncompliantEvidence: NotRequired[int],
totalAssessmentControlsCount: NotRequired[int],
lastUpdated: NotRequired[datetime],
ServiceMetadataTypeDef#
# ServiceMetadataTypeDef definition
class ServiceMetadataTypeDef(TypedDict):
name: NotRequired[str],
displayName: NotRequired[str],
description: NotRequired[str],
category: NotRequired[str],
GetSettingsRequestRequestTypeDef#
# GetSettingsRequestRequestTypeDef definition
class GetSettingsRequestRequestTypeDef(TypedDict):
attribute: SettingAttributeType, # (1)
ListAssessmentControlInsightsByControlDomainRequestRequestTypeDef#
# ListAssessmentControlInsightsByControlDomainRequestRequestTypeDef definition
class ListAssessmentControlInsightsByControlDomainRequestRequestTypeDef(TypedDict):
controlDomainId: str,
assessmentId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListAssessmentFrameworkShareRequestsRequestRequestTypeDef#
# ListAssessmentFrameworkShareRequestsRequestRequestTypeDef definition
class ListAssessmentFrameworkShareRequestsRequestRequestTypeDef(TypedDict):
requestType: ShareRequestTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListAssessmentFrameworksRequestRequestTypeDef#
# ListAssessmentFrameworksRequestRequestTypeDef definition
class ListAssessmentFrameworksRequestRequestTypeDef(TypedDict):
frameworkType: FrameworkTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListAssessmentReportsRequestRequestTypeDef#
# ListAssessmentReportsRequestRequestTypeDef definition
class ListAssessmentReportsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListAssessmentsRequestRequestTypeDef#
# ListAssessmentsRequestRequestTypeDef definition
class ListAssessmentsRequestRequestTypeDef(TypedDict):
status: NotRequired[AssessmentStatusType], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListControlDomainInsightsByAssessmentRequestRequestTypeDef#
# ListControlDomainInsightsByAssessmentRequestRequestTypeDef definition
class ListControlDomainInsightsByAssessmentRequestRequestTypeDef(TypedDict):
assessmentId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListControlDomainInsightsRequestRequestTypeDef#
# ListControlDomainInsightsRequestRequestTypeDef definition
class ListControlDomainInsightsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListControlInsightsByControlDomainRequestRequestTypeDef#
# ListControlInsightsByControlDomainRequestRequestTypeDef definition
class ListControlInsightsByControlDomainRequestRequestTypeDef(TypedDict):
controlDomainId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListControlsRequestRequestTypeDef#
# ListControlsRequestRequestTypeDef definition
class ListControlsRequestRequestTypeDef(TypedDict):
controlType: ControlTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See ControlTypeType
ListKeywordsForDataSourceRequestRequestTypeDef#
# ListKeywordsForDataSourceRequestRequestTypeDef definition
class ListKeywordsForDataSourceRequestRequestTypeDef(TypedDict):
source: SourceTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See SourceTypeType
ListNotificationsRequestRequestTypeDef#
# ListNotificationsRequestRequestTypeDef definition
class ListNotificationsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
NotificationTypeDef#
# NotificationTypeDef definition
class NotificationTypeDef(TypedDict):
id: NotRequired[str],
assessmentId: NotRequired[str],
assessmentName: NotRequired[str],
controlSetId: NotRequired[str],
controlSetName: NotRequired[str],
description: NotRequired[str],
eventTime: NotRequired[datetime],
source: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
RegisterAccountRequestRequestTypeDef#
# RegisterAccountRequestRequestTypeDef definition
class RegisterAccountRequestRequestTypeDef(TypedDict):
kmsKey: NotRequired[str],
delegatedAdminAccount: NotRequired[str],
RegisterOrganizationAdminAccountRequestRequestTypeDef#
# RegisterOrganizationAdminAccountRequestRequestTypeDef definition
class RegisterOrganizationAdminAccountRequestRequestTypeDef(TypedDict):
adminAccountId: str,
StartAssessmentFrameworkShareRequestRequestTypeDef#
# StartAssessmentFrameworkShareRequestRequestTypeDef definition
class StartAssessmentFrameworkShareRequestRequestTypeDef(TypedDict):
frameworkId: str,
destinationAccount: str,
destinationRegion: str,
comment: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAssessmentControlRequestRequestTypeDef#
# UpdateAssessmentControlRequestRequestTypeDef definition
class UpdateAssessmentControlRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: str,
controlId: str,
controlStatus: NotRequired[ControlStatusType], # (1)
commentBody: NotRequired[str],