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,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
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],
controlCatalogId: NotRequired[str],
- See ControlTypeType
ListKeywordsForDataSourceRequestRequestTypeDef#
# ListKeywordsForDataSourceRequestRequestTypeDef definition
class ListKeywordsForDataSourceRequestRequestTypeDef(TypedDict):
source: DataSourceTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
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],
UpdateAssessmentControlSetStatusRequestRequestTypeDef#
# UpdateAssessmentControlSetStatusRequestRequestTypeDef definition
class UpdateAssessmentControlSetStatusRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: str,
status: ControlSetStatusType, # (1)
comment: str,
UpdateAssessmentFrameworkShareRequestRequestTypeDef#
# UpdateAssessmentFrameworkShareRequestRequestTypeDef definition
class UpdateAssessmentFrameworkShareRequestRequestTypeDef(TypedDict):
requestId: str,
requestType: ShareRequestTypeType, # (1)
action: ShareRequestActionType, # (2)
UpdateAssessmentStatusRequestRequestTypeDef#
# UpdateAssessmentStatusRequestRequestTypeDef definition
class UpdateAssessmentStatusRequestRequestTypeDef(TypedDict):
assessmentId: str,
status: AssessmentStatusType, # (1)
ValidateAssessmentReportIntegrityRequestRequestTypeDef#
# ValidateAssessmentReportIntegrityRequestRequestTypeDef definition
class ValidateAssessmentReportIntegrityRequestRequestTypeDef(TypedDict):
s3RelativePath: str,
ScopeOutputTypeDef#
# ScopeOutputTypeDef definition
class ScopeOutputTypeDef(TypedDict):
awsAccounts: NotRequired[list[AWSAccountTypeDef]], # (1)
awsServices: NotRequired[list[AWSServiceTypeDef]], # (2)
- See AWSAccountTypeDef
- See AWSServiceTypeDef
ScopeTypeDef#
# ScopeTypeDef definition
class ScopeTypeDef(TypedDict):
awsAccounts: NotRequired[Sequence[AWSAccountTypeDef]], # (1)
awsServices: NotRequired[Sequence[AWSServiceTypeDef]], # (2)
- See AWSAccountTypeDef
- See AWSServiceTypeDef
AssessmentMetadataItemTypeDef#
# AssessmentMetadataItemTypeDef definition
class AssessmentMetadataItemTypeDef(TypedDict):
name: NotRequired[str],
id: NotRequired[str],
complianceType: NotRequired[str],
status: NotRequired[AssessmentStatusType], # (1)
roles: NotRequired[list[RoleTypeDef]], # (2)
delegations: NotRequired[list[DelegationTypeDef]], # (3)
creationTime: NotRequired[datetime],
lastUpdated: NotRequired[datetime],
- See AssessmentStatusType
- See RoleTypeDef
- See DelegationTypeDef
AssessmentControlTypeDef#
# AssessmentControlTypeDef definition
class AssessmentControlTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
description: NotRequired[str],
status: NotRequired[ControlStatusType], # (1)
response: NotRequired[ControlResponseType], # (2)
comments: NotRequired[list[ControlCommentTypeDef]], # (3)
evidenceSources: NotRequired[list[str]],
evidenceCount: NotRequired[int],
assessmentReportEvidenceCount: NotRequired[int],
BatchAssociateAssessmentReportEvidenceResponseTypeDef#
# BatchAssociateAssessmentReportEvidenceResponseTypeDef definition
class BatchAssociateAssessmentReportEvidenceResponseTypeDef(TypedDict):
evidenceIds: list[str],
errors: list[AssessmentReportEvidenceErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDisassociateAssessmentReportEvidenceResponseTypeDef#
# BatchDisassociateAssessmentReportEvidenceResponseTypeDef definition
class BatchDisassociateAssessmentReportEvidenceResponseTypeDef(TypedDict):
evidenceIds: list[str],
errors: list[AssessmentReportEvidenceErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAssessmentReportResponseTypeDef#
# CreateAssessmentReportResponseTypeDef definition
class CreateAssessmentReportResponseTypeDef(TypedDict):
assessmentReport: AssessmentReportTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeregisterAccountResponseTypeDef#
# DeregisterAccountResponseTypeDef definition
class DeregisterAccountResponseTypeDef(TypedDict):
status: AccountStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAccountStatusResponseTypeDef#
# GetAccountStatusResponseTypeDef definition
class GetAccountStatusResponseTypeDef(TypedDict):
status: AccountStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEvidenceFileUploadUrlResponseTypeDef#
# GetEvidenceFileUploadUrlResponseTypeDef definition
class GetEvidenceFileUploadUrlResponseTypeDef(TypedDict):
evidenceFileName: str,
uploadUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetEvidenceFolderResponseTypeDef#
# GetEvidenceFolderResponseTypeDef definition
class GetEvidenceFolderResponseTypeDef(TypedDict):
evidenceFolder: AssessmentEvidenceFolderTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEvidenceFoldersByAssessmentControlResponseTypeDef#
# GetEvidenceFoldersByAssessmentControlResponseTypeDef definition
class GetEvidenceFoldersByAssessmentControlResponseTypeDef(TypedDict):
evidenceFolders: list[AssessmentEvidenceFolderTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetEvidenceFoldersByAssessmentResponseTypeDef#
# GetEvidenceFoldersByAssessmentResponseTypeDef definition
class GetEvidenceFoldersByAssessmentResponseTypeDef(TypedDict):
evidenceFolders: list[AssessmentEvidenceFolderTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetOrganizationAdminAccountResponseTypeDef#
# GetOrganizationAdminAccountResponseTypeDef definition
class GetOrganizationAdminAccountResponseTypeDef(TypedDict):
adminAccountId: str,
organizationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAssessmentFrameworkShareRequestsResponseTypeDef#
# ListAssessmentFrameworkShareRequestsResponseTypeDef definition
class ListAssessmentFrameworkShareRequestsResponseTypeDef(TypedDict):
assessmentFrameworkShareRequests: list[AssessmentFrameworkShareRequestTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListAssessmentFrameworksResponseTypeDef#
# ListAssessmentFrameworksResponseTypeDef definition
class ListAssessmentFrameworksResponseTypeDef(TypedDict):
frameworkMetadataList: list[AssessmentFrameworkMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListAssessmentReportsResponseTypeDef#
# ListAssessmentReportsResponseTypeDef definition
class ListAssessmentReportsResponseTypeDef(TypedDict):
assessmentReports: list[AssessmentReportMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListKeywordsForDataSourceResponseTypeDef#
# ListKeywordsForDataSourceResponseTypeDef definition
class ListKeywordsForDataSourceResponseTypeDef(TypedDict):
keywords: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RegisterAccountResponseTypeDef#
# RegisterAccountResponseTypeDef definition
class RegisterAccountResponseTypeDef(TypedDict):
status: AccountStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RegisterOrganizationAdminAccountResponseTypeDef#
# RegisterOrganizationAdminAccountResponseTypeDef definition
class RegisterOrganizationAdminAccountResponseTypeDef(TypedDict):
adminAccountId: str,
organizationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartAssessmentFrameworkShareResponseTypeDef#
# StartAssessmentFrameworkShareResponseTypeDef definition
class StartAssessmentFrameworkShareResponseTypeDef(TypedDict):
assessmentFrameworkShareRequest: AssessmentFrameworkShareRequestTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAssessmentFrameworkShareResponseTypeDef#
# UpdateAssessmentFrameworkShareResponseTypeDef definition
class UpdateAssessmentFrameworkShareResponseTypeDef(TypedDict):
assessmentFrameworkShareRequest: AssessmentFrameworkShareRequestTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ValidateAssessmentReportIntegrityResponseTypeDef#
# ValidateAssessmentReportIntegrityResponseTypeDef definition
class ValidateAssessmentReportIntegrityResponseTypeDef(TypedDict):
signatureValid: bool,
signatureAlgorithm: str,
signatureDateTime: str,
signatureKeyId: str,
validationErrors: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
BatchCreateDelegationByAssessmentErrorTypeDef#
# BatchCreateDelegationByAssessmentErrorTypeDef definition
class BatchCreateDelegationByAssessmentErrorTypeDef(TypedDict):
createDelegationRequest: NotRequired[CreateDelegationRequestTypeDef], # (1)
errorCode: NotRequired[str],
errorMessage: NotRequired[str],
BatchCreateDelegationByAssessmentRequestRequestTypeDef#
# BatchCreateDelegationByAssessmentRequestRequestTypeDef definition
class BatchCreateDelegationByAssessmentRequestRequestTypeDef(TypedDict):
createDelegationRequests: Sequence[CreateDelegationRequestTypeDef], # (1)
assessmentId: str,
BatchDeleteDelegationByAssessmentResponseTypeDef#
# BatchDeleteDelegationByAssessmentResponseTypeDef definition
class BatchDeleteDelegationByAssessmentResponseTypeDef(TypedDict):
errors: list[BatchDeleteDelegationByAssessmentErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchImportEvidenceToAssessmentControlErrorTypeDef#
# BatchImportEvidenceToAssessmentControlErrorTypeDef definition
class BatchImportEvidenceToAssessmentControlErrorTypeDef(TypedDict):
manualEvidence: NotRequired[ManualEvidenceTypeDef], # (1)
errorCode: NotRequired[str],
errorMessage: NotRequired[str],
BatchImportEvidenceToAssessmentControlRequestRequestTypeDef#
# BatchImportEvidenceToAssessmentControlRequestRequestTypeDef definition
class BatchImportEvidenceToAssessmentControlRequestRequestTypeDef(TypedDict):
assessmentId: str,
controlSetId: str,
controlId: str,
manualEvidence: Sequence[ManualEvidenceTypeDef], # (1)
GetChangeLogsResponseTypeDef#
# GetChangeLogsResponseTypeDef definition
class GetChangeLogsResponseTypeDef(TypedDict):
changeLogs: list[ChangeLogTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ControlDomainInsightsTypeDef#
# ControlDomainInsightsTypeDef definition
class ControlDomainInsightsTypeDef(TypedDict):
name: NotRequired[str],
id: NotRequired[str],
controlsCountByNoncompliantEvidence: NotRequired[int],
totalControlsCount: NotRequired[int],
evidenceInsights: NotRequired[EvidenceInsightsTypeDef], # (1)
lastUpdated: NotRequired[datetime],
ControlInsightsMetadataByAssessmentItemTypeDef#
# ControlInsightsMetadataByAssessmentItemTypeDef definition
class ControlInsightsMetadataByAssessmentItemTypeDef(TypedDict):
name: NotRequired[str],
id: NotRequired[str],
evidenceInsights: NotRequired[EvidenceInsightsTypeDef], # (1)
controlSetName: NotRequired[str],
lastUpdated: NotRequired[datetime],
ControlInsightsMetadataItemTypeDef#
# ControlInsightsMetadataItemTypeDef definition
class ControlInsightsMetadataItemTypeDef(TypedDict):
name: NotRequired[str],
id: NotRequired[str],
evidenceInsights: NotRequired[EvidenceInsightsTypeDef], # (1)
lastUpdated: NotRequired[datetime],
ControlMappingSourceTypeDef#
# ControlMappingSourceTypeDef definition
class ControlMappingSourceTypeDef(TypedDict):
sourceId: NotRequired[str],
sourceName: NotRequired[str],
sourceDescription: NotRequired[str],
sourceSetUpOption: NotRequired[SourceSetUpOptionType], # (1)
sourceType: NotRequired[SourceTypeType], # (2)
sourceKeyword: NotRequired[SourceKeywordTypeDef], # (3)
sourceFrequency: NotRequired[SourceFrequencyType], # (4)
troubleshootingText: NotRequired[str],
- See SourceSetUpOptionType
- See SourceTypeType
- See SourceKeywordTypeDef
- See SourceFrequencyType
CreateControlMappingSourceTypeDef#
# CreateControlMappingSourceTypeDef definition
class CreateControlMappingSourceTypeDef(TypedDict):
sourceName: NotRequired[str],
sourceDescription: NotRequired[str],
sourceSetUpOption: NotRequired[SourceSetUpOptionType], # (1)
sourceType: NotRequired[SourceTypeType], # (2)
sourceKeyword: NotRequired[SourceKeywordTypeDef], # (3)
sourceFrequency: NotRequired[SourceFrequencyType], # (4)
troubleshootingText: NotRequired[str],
- See SourceSetUpOptionType
- See SourceTypeType
- See SourceKeywordTypeDef
- See SourceFrequencyType
ListControlsResponseTypeDef#
# ListControlsResponseTypeDef definition
class ListControlsResponseTypeDef(TypedDict):
controlMetadataList: list[ControlMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
CreateAssessmentFrameworkControlSetTypeDef#
# CreateAssessmentFrameworkControlSetTypeDef definition
class CreateAssessmentFrameworkControlSetTypeDef(TypedDict):
name: str,
controls: NotRequired[Sequence[CreateAssessmentFrameworkControlTypeDef]], # (1)
UpdateAssessmentFrameworkControlSetTypeDef#
# UpdateAssessmentFrameworkControlSetTypeDef definition
class UpdateAssessmentFrameworkControlSetTypeDef(TypedDict):
name: str,
controls: Sequence[CreateAssessmentFrameworkControlTypeDef], # (1)
id: NotRequired[str],
GetDelegationsResponseTypeDef#
# GetDelegationsResponseTypeDef definition
class GetDelegationsResponseTypeDef(TypedDict):
delegations: list[DelegationMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
UpdateSettingsRequestRequestTypeDef#
# UpdateSettingsRequestRequestTypeDef definition
class UpdateSettingsRequestRequestTypeDef(TypedDict):
snsTopic: NotRequired[str],
defaultAssessmentReportsDestination: NotRequired[AssessmentReportsDestinationTypeDef], # (1)
defaultProcessOwners: NotRequired[Sequence[RoleTypeDef]], # (2)
kmsKey: NotRequired[str],
evidenceFinderEnabled: NotRequired[bool],
deregistrationPolicy: NotRequired[DeregistrationPolicyTypeDef], # (3)
defaultExportDestination: NotRequired[DefaultExportDestinationTypeDef], # (4)
- See AssessmentReportsDestinationTypeDef
- See RoleTypeDef
- See DeregistrationPolicyTypeDef
- See DefaultExportDestinationTypeDef
SettingsTypeDef#
# SettingsTypeDef definition
class SettingsTypeDef(TypedDict):
isAwsOrgEnabled: NotRequired[bool],
snsTopic: NotRequired[str],
defaultAssessmentReportsDestination: NotRequired[AssessmentReportsDestinationTypeDef], # (1)
defaultProcessOwners: NotRequired[list[RoleTypeDef]], # (2)
kmsKey: NotRequired[str],
evidenceFinderEnablement: NotRequired[EvidenceFinderEnablementTypeDef], # (3)
deregistrationPolicy: NotRequired[DeregistrationPolicyTypeDef], # (4)
defaultExportDestination: NotRequired[DefaultExportDestinationTypeDef], # (5)
- See AssessmentReportsDestinationTypeDef
- See RoleTypeDef
- See EvidenceFinderEnablementTypeDef
- See DeregistrationPolicyTypeDef
- See DefaultExportDestinationTypeDef
EvidenceTypeDef#
# EvidenceTypeDef definition
class EvidenceTypeDef(TypedDict):
dataSource: NotRequired[str],
evidenceAwsAccountId: NotRequired[str],
time: NotRequired[datetime],
eventSource: NotRequired[str],
eventName: NotRequired[str],
evidenceByType: NotRequired[str],
resourcesIncluded: NotRequired[list[ResourceTypeDef]], # (1)
attributes: NotRequired[dict[str, str]],
iamId: NotRequired[str],
complianceCheck: NotRequired[str],
awsOrganization: NotRequired[str],
awsAccountId: NotRequired[str],
evidenceFolderId: NotRequired[str],
id: NotRequired[str],
assessmentReportSelection: NotRequired[str],
- See ResourceTypeDef
GetAssessmentReportUrlResponseTypeDef#
# GetAssessmentReportUrlResponseTypeDef definition
class GetAssessmentReportUrlResponseTypeDef(TypedDict):
preSignedUrl: URLTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See URLTypeDef
- See ResponseMetadataTypeDef
GetInsightsByAssessmentResponseTypeDef#
# GetInsightsByAssessmentResponseTypeDef definition
class GetInsightsByAssessmentResponseTypeDef(TypedDict):
insights: InsightsByAssessmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetInsightsResponseTypeDef#
# GetInsightsResponseTypeDef definition
class GetInsightsResponseTypeDef(TypedDict):
insights: InsightsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetServicesInScopeResponseTypeDef#
# GetServicesInScopeResponseTypeDef definition
class GetServicesInScopeResponseTypeDef(TypedDict):
serviceMetadata: list[ServiceMetadataTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNotificationsResponseTypeDef#
# ListNotificationsResponseTypeDef definition
class ListNotificationsResponseTypeDef(TypedDict):
notifications: list[NotificationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
AssessmentMetadataTypeDef#
# AssessmentMetadataTypeDef definition
class AssessmentMetadataTypeDef(TypedDict):
name: NotRequired[str],
id: NotRequired[str],
description: NotRequired[str],
complianceType: NotRequired[str],
status: NotRequired[AssessmentStatusType], # (1)
assessmentReportsDestination: NotRequired[AssessmentReportsDestinationTypeDef], # (2)
scope: NotRequired[ScopeOutputTypeDef], # (3)
roles: NotRequired[list[RoleTypeDef]], # (4)
delegations: NotRequired[list[DelegationTypeDef]], # (5)
creationTime: NotRequired[datetime],
lastUpdated: NotRequired[datetime],
- See AssessmentStatusType
- See AssessmentReportsDestinationTypeDef
- See ScopeOutputTypeDef
- See RoleTypeDef
- See DelegationTypeDef
CreateAssessmentRequestRequestTypeDef#
# CreateAssessmentRequestRequestTypeDef definition
class CreateAssessmentRequestRequestTypeDef(TypedDict):
name: str,
assessmentReportsDestination: AssessmentReportsDestinationTypeDef, # (1)
scope: ScopeTypeDef, # (2)
roles: Sequence[RoleTypeDef], # (3)
frameworkId: str,
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
UpdateAssessmentRequestRequestTypeDef#
# UpdateAssessmentRequestRequestTypeDef definition
class UpdateAssessmentRequestRequestTypeDef(TypedDict):
assessmentId: str,
scope: ScopeTypeDef, # (1)
assessmentName: NotRequired[str],
assessmentDescription: NotRequired[str],
assessmentReportsDestination: NotRequired[AssessmentReportsDestinationTypeDef], # (2)
roles: NotRequired[Sequence[RoleTypeDef]], # (3)
ListAssessmentsResponseTypeDef#
# ListAssessmentsResponseTypeDef definition
class ListAssessmentsResponseTypeDef(TypedDict):
assessmentMetadata: list[AssessmentMetadataItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
AssessmentControlSetTypeDef#
# AssessmentControlSetTypeDef definition
class AssessmentControlSetTypeDef(TypedDict):
id: NotRequired[str],
description: NotRequired[str],
status: NotRequired[ControlSetStatusType], # (1)
roles: NotRequired[list[RoleTypeDef]], # (2)
controls: NotRequired[list[AssessmentControlTypeDef]], # (3)
delegations: NotRequired[list[DelegationTypeDef]], # (4)
systemEvidenceCount: NotRequired[int],
manualEvidenceCount: NotRequired[int],
- See ControlSetStatusType
- See RoleTypeDef
- See AssessmentControlTypeDef
- See DelegationTypeDef
UpdateAssessmentControlResponseTypeDef#
# UpdateAssessmentControlResponseTypeDef definition
class UpdateAssessmentControlResponseTypeDef(TypedDict):
control: AssessmentControlTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchCreateDelegationByAssessmentResponseTypeDef#
# BatchCreateDelegationByAssessmentResponseTypeDef definition
class BatchCreateDelegationByAssessmentResponseTypeDef(TypedDict):
delegations: list[DelegationTypeDef], # (1)
errors: list[BatchCreateDelegationByAssessmentErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchImportEvidenceToAssessmentControlResponseTypeDef#
# BatchImportEvidenceToAssessmentControlResponseTypeDef definition
class BatchImportEvidenceToAssessmentControlResponseTypeDef(TypedDict):
errors: list[BatchImportEvidenceToAssessmentControlErrorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListControlDomainInsightsByAssessmentResponseTypeDef#
# ListControlDomainInsightsByAssessmentResponseTypeDef definition
class ListControlDomainInsightsByAssessmentResponseTypeDef(TypedDict):
controlDomainInsights: list[ControlDomainInsightsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListControlDomainInsightsResponseTypeDef#
# ListControlDomainInsightsResponseTypeDef definition
class ListControlDomainInsightsResponseTypeDef(TypedDict):
controlDomainInsights: list[ControlDomainInsightsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListAssessmentControlInsightsByControlDomainResponseTypeDef#
# ListAssessmentControlInsightsByControlDomainResponseTypeDef definition
class ListAssessmentControlInsightsByControlDomainResponseTypeDef(TypedDict):
controlInsightsByAssessment: list[ControlInsightsMetadataByAssessmentItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ListControlInsightsByControlDomainResponseTypeDef#
# ListControlInsightsByControlDomainResponseTypeDef definition
class ListControlInsightsByControlDomainResponseTypeDef(TypedDict):
controlInsightsMetadata: list[ControlInsightsMetadataItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
ControlTypeDef#
# ControlTypeDef definition
class ControlTypeDef(TypedDict):
arn: NotRequired[str],
id: NotRequired[str],
type: NotRequired[ControlTypeType], # (1)
name: NotRequired[str],
description: NotRequired[str],
testingInformation: NotRequired[str],
actionPlanTitle: NotRequired[str],
actionPlanInstructions: NotRequired[str],
controlSources: NotRequired[str],
controlMappingSources: NotRequired[list[ControlMappingSourceTypeDef]], # (2)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
createdBy: NotRequired[str],
lastUpdatedBy: NotRequired[str],
tags: NotRequired[dict[str, str]],
state: NotRequired[ControlStateType], # (3)
UpdateControlRequestRequestTypeDef#
# UpdateControlRequestRequestTypeDef definition
class UpdateControlRequestRequestTypeDef(TypedDict):
controlId: str,
name: str,
controlMappingSources: Sequence[ControlMappingSourceTypeDef], # (1)
description: NotRequired[str],
testingInformation: NotRequired[str],
actionPlanTitle: NotRequired[str],
actionPlanInstructions: NotRequired[str],
CreateControlRequestRequestTypeDef#
# CreateControlRequestRequestTypeDef definition
class CreateControlRequestRequestTypeDef(TypedDict):
name: str,
controlMappingSources: Sequence[CreateControlMappingSourceTypeDef], # (1)
description: NotRequired[str],
testingInformation: NotRequired[str],
actionPlanTitle: NotRequired[str],
actionPlanInstructions: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateAssessmentFrameworkRequestRequestTypeDef#
# CreateAssessmentFrameworkRequestRequestTypeDef definition
class CreateAssessmentFrameworkRequestRequestTypeDef(TypedDict):
name: str,
controlSets: Sequence[CreateAssessmentFrameworkControlSetTypeDef], # (1)
description: NotRequired[str],
complianceType: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
UpdateAssessmentFrameworkRequestRequestTypeDef#
# UpdateAssessmentFrameworkRequestRequestTypeDef definition
class UpdateAssessmentFrameworkRequestRequestTypeDef(TypedDict):
frameworkId: str,
name: str,
controlSets: Sequence[UpdateAssessmentFrameworkControlSetTypeDef], # (1)
description: NotRequired[str],
complianceType: NotRequired[str],
GetSettingsResponseTypeDef#
# GetSettingsResponseTypeDef definition
class GetSettingsResponseTypeDef(TypedDict):
settings: SettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateSettingsResponseTypeDef#
# UpdateSettingsResponseTypeDef definition
class UpdateSettingsResponseTypeDef(TypedDict):
settings: SettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEvidenceByEvidenceFolderResponseTypeDef#
# GetEvidenceByEvidenceFolderResponseTypeDef definition
class GetEvidenceByEvidenceFolderResponseTypeDef(TypedDict):
evidence: list[EvidenceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
GetEvidenceResponseTypeDef#
# GetEvidenceResponseTypeDef definition
class GetEvidenceResponseTypeDef(TypedDict):
evidence: EvidenceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssessmentFrameworkTypeDef#
# AssessmentFrameworkTypeDef definition
class AssessmentFrameworkTypeDef(TypedDict):
id: NotRequired[str],
arn: NotRequired[str],
metadata: NotRequired[FrameworkMetadataTypeDef], # (1)
controlSets: NotRequired[list[AssessmentControlSetTypeDef]], # (2)
UpdateAssessmentControlSetStatusResponseTypeDef#
# UpdateAssessmentControlSetStatusResponseTypeDef definition
class UpdateAssessmentControlSetStatusResponseTypeDef(TypedDict):
controlSet: AssessmentControlSetTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ControlSetTypeDef#
# ControlSetTypeDef definition
class ControlSetTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
controls: NotRequired[list[ControlTypeDef]], # (1)
- See ControlTypeDef
CreateControlResponseTypeDef#
# CreateControlResponseTypeDef definition
class CreateControlResponseTypeDef(TypedDict):
control: ControlTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetControlResponseTypeDef#
# GetControlResponseTypeDef definition
class GetControlResponseTypeDef(TypedDict):
control: ControlTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateControlResponseTypeDef#
# UpdateControlResponseTypeDef definition
class UpdateControlResponseTypeDef(TypedDict):
control: ControlTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssessmentTypeDef#
# AssessmentTypeDef definition
class AssessmentTypeDef(TypedDict):
arn: NotRequired[str],
awsAccount: NotRequired[AWSAccountTypeDef], # (1)
metadata: NotRequired[AssessmentMetadataTypeDef], # (2)
framework: NotRequired[AssessmentFrameworkTypeDef], # (3)
tags: NotRequired[dict[str, str]],
FrameworkTypeDef#
# FrameworkTypeDef definition
class FrameworkTypeDef(TypedDict):
arn: NotRequired[str],
id: NotRequired[str],
name: NotRequired[str],
type: NotRequired[FrameworkTypeType], # (1)
complianceType: NotRequired[str],
description: NotRequired[str],
logo: NotRequired[str],
controlSources: NotRequired[str],
controlSets: NotRequired[list[ControlSetTypeDef]], # (2)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
createdBy: NotRequired[str],
lastUpdatedBy: NotRequired[str],
tags: NotRequired[dict[str, str]],
- See FrameworkTypeType
- See ControlSetTypeDef
CreateAssessmentResponseTypeDef#
# CreateAssessmentResponseTypeDef definition
class CreateAssessmentResponseTypeDef(TypedDict):
assessment: AssessmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAssessmentResponseTypeDef#
# GetAssessmentResponseTypeDef definition
class GetAssessmentResponseTypeDef(TypedDict):
assessment: AssessmentTypeDef, # (1)
userRole: RoleTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See AssessmentTypeDef
- See RoleTypeDef
- See ResponseMetadataTypeDef
UpdateAssessmentResponseTypeDef#
# UpdateAssessmentResponseTypeDef definition
class UpdateAssessmentResponseTypeDef(TypedDict):
assessment: AssessmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAssessmentStatusResponseTypeDef#
# UpdateAssessmentStatusResponseTypeDef definition
class UpdateAssessmentStatusResponseTypeDef(TypedDict):
assessment: AssessmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAssessmentFrameworkResponseTypeDef#
# CreateAssessmentFrameworkResponseTypeDef definition
class CreateAssessmentFrameworkResponseTypeDef(TypedDict):
framework: FrameworkTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAssessmentFrameworkResponseTypeDef#
# GetAssessmentFrameworkResponseTypeDef definition
class GetAssessmentFrameworkResponseTypeDef(TypedDict):
framework: FrameworkTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAssessmentFrameworkResponseTypeDef#
# UpdateAssessmentFrameworkResponseTypeDef definition
class UpdateAssessmentFrameworkResponseTypeDef(TypedDict):
framework: FrameworkTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)