Skip to content

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],
  1. See DelegationStatusType
  2. See RoleTypeType

RoleTypeDef#

# RoleTypeDef definition

class RoleTypeDef(TypedDict):
    roleType: RoleTypeType,  # (1)
    roleArn: str,
  1. 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],
  1. See FrameworkTypeType

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],
  1. See ShareRequestStatusType

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],
  1. See AssessmentReportDestinationTypeType

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],
  1. See AssessmentReportStatusType

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],
  1. See AssessmentReportStatusType

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)
  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],
  1. See ObjectTypeEnumType
  2. 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],
  1. See KeywordInputTypeType

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],
  1. See ExportDestinationTypeType

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],
  1. See DelegationStatusType

DeleteAssessmentFrameworkRequestRequestTypeDef#

# DeleteAssessmentFrameworkRequestRequestTypeDef definition

class DeleteAssessmentFrameworkRequestRequestTypeDef(TypedDict):
    frameworkId: str,

DeleteAssessmentFrameworkShareRequestRequestTypeDef#

# DeleteAssessmentFrameworkShareRequestRequestTypeDef definition

class DeleteAssessmentFrameworkShareRequestRequestTypeDef(TypedDict):
    requestId: str,
    requestType: ShareRequestTypeType,  # (1)
  1. See ShareRequestTypeType

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)
  1. See DeleteResourcesType

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],
  1. See EvidenceFinderEnablementStatusType
  2. See EvidenceFinderBackfillStatusType

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)
  1. See SettingAttributeType

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],
  1. See ShareRequestTypeType

ListAssessmentFrameworksRequestRequestTypeDef#

# ListAssessmentFrameworksRequestRequestTypeDef definition

class ListAssessmentFrameworksRequestRequestTypeDef(TypedDict):
    frameworkType: FrameworkTypeType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See FrameworkTypeType

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],
  1. See AssessmentStatusType

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],
  1. See ControlTypeType

ListKeywordsForDataSourceRequestRequestTypeDef#

# ListKeywordsForDataSourceRequestRequestTypeDef definition

class ListKeywordsForDataSourceRequestRequestTypeDef(TypedDict):
    source: DataSourceTypeType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See DataSourceTypeType

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],
  1. See ControlStatusType

UpdateAssessmentControlSetStatusRequestRequestTypeDef#

# UpdateAssessmentControlSetStatusRequestRequestTypeDef definition

class UpdateAssessmentControlSetStatusRequestRequestTypeDef(TypedDict):
    assessmentId: str,
    controlSetId: str,
    status: ControlSetStatusType,  # (1)
    comment: str,
  1. See ControlSetStatusType

UpdateAssessmentFrameworkShareRequestRequestTypeDef#

# UpdateAssessmentFrameworkShareRequestRequestTypeDef definition

class UpdateAssessmentFrameworkShareRequestRequestTypeDef(TypedDict):
    requestId: str,
    requestType: ShareRequestTypeType,  # (1)
    action: ShareRequestActionType,  # (2)
  1. See ShareRequestTypeType
  2. See ShareRequestActionType

UpdateAssessmentStatusRequestRequestTypeDef#

# UpdateAssessmentStatusRequestRequestTypeDef definition

class UpdateAssessmentStatusRequestRequestTypeDef(TypedDict):
    assessmentId: str,
    status: AssessmentStatusType,  # (1)
  1. See AssessmentStatusType

ValidateAssessmentReportIntegrityRequestRequestTypeDef#

# ValidateAssessmentReportIntegrityRequestRequestTypeDef definition

class ValidateAssessmentReportIntegrityRequestRequestTypeDef(TypedDict):
    s3RelativePath: str,

ScopeOutputTypeDef#

# ScopeOutputTypeDef definition

class ScopeOutputTypeDef(TypedDict):
    awsAccounts: NotRequired[List[AWSAccountTypeDef]],  # (1)
    awsServices: NotRequired[List[AWSServiceTypeDef]],  # (2)
  1. See AWSAccountTypeDef
  2. See AWSServiceTypeDef

ScopeTypeDef#

# ScopeTypeDef definition

class ScopeTypeDef(TypedDict):
    awsAccounts: NotRequired[Sequence[AWSAccountTypeDef]],  # (1)
    awsServices: NotRequired[Sequence[AWSServiceTypeDef]],  # (2)
  1. See AWSAccountTypeDef
  2. 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],
  1. See AssessmentStatusType
  2. See RoleTypeDef
  3. 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],
  1. See ControlStatusType
  2. See ControlResponseType
  3. See ControlCommentTypeDef

BatchAssociateAssessmentReportEvidenceResponseTypeDef#

# BatchAssociateAssessmentReportEvidenceResponseTypeDef definition

class BatchAssociateAssessmentReportEvidenceResponseTypeDef(TypedDict):
    evidenceIds: List[str],
    errors: List[AssessmentReportEvidenceErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentReportEvidenceErrorTypeDef
  2. See ResponseMetadataTypeDef

BatchDisassociateAssessmentReportEvidenceResponseTypeDef#

# BatchDisassociateAssessmentReportEvidenceResponseTypeDef definition

class BatchDisassociateAssessmentReportEvidenceResponseTypeDef(TypedDict):
    evidenceIds: List[str],
    errors: List[AssessmentReportEvidenceErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentReportEvidenceErrorTypeDef
  2. See ResponseMetadataTypeDef

CreateAssessmentReportResponseTypeDef#

# CreateAssessmentReportResponseTypeDef definition

class CreateAssessmentReportResponseTypeDef(TypedDict):
    assessmentReport: AssessmentReportTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentReportTypeDef
  2. See ResponseMetadataTypeDef

DeregisterAccountResponseTypeDef#

# DeregisterAccountResponseTypeDef definition

class DeregisterAccountResponseTypeDef(TypedDict):
    status: AccountStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountStatusType
  2. See ResponseMetadataTypeDef

GetAccountStatusResponseTypeDef#

# GetAccountStatusResponseTypeDef definition

class GetAccountStatusResponseTypeDef(TypedDict):
    status: AccountStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountStatusType
  2. See ResponseMetadataTypeDef

GetEvidenceFileUploadUrlResponseTypeDef#

# GetEvidenceFileUploadUrlResponseTypeDef definition

class GetEvidenceFileUploadUrlResponseTypeDef(TypedDict):
    evidenceFileName: str,
    uploadUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetEvidenceFolderResponseTypeDef#

# GetEvidenceFolderResponseTypeDef definition

class GetEvidenceFolderResponseTypeDef(TypedDict):
    evidenceFolder: AssessmentEvidenceFolderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentEvidenceFolderTypeDef
  2. See ResponseMetadataTypeDef

GetEvidenceFoldersByAssessmentControlResponseTypeDef#

# GetEvidenceFoldersByAssessmentControlResponseTypeDef definition

class GetEvidenceFoldersByAssessmentControlResponseTypeDef(TypedDict):
    evidenceFolders: List[AssessmentEvidenceFolderTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AssessmentEvidenceFolderTypeDef
  2. See ResponseMetadataTypeDef

GetEvidenceFoldersByAssessmentResponseTypeDef#

# GetEvidenceFoldersByAssessmentResponseTypeDef definition

class GetEvidenceFoldersByAssessmentResponseTypeDef(TypedDict):
    evidenceFolders: List[AssessmentEvidenceFolderTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AssessmentEvidenceFolderTypeDef
  2. See ResponseMetadataTypeDef

GetOrganizationAdminAccountResponseTypeDef#

# GetOrganizationAdminAccountResponseTypeDef definition

class GetOrganizationAdminAccountResponseTypeDef(TypedDict):
    adminAccountId: str,
    organizationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAssessmentFrameworkShareRequestsResponseTypeDef#

# ListAssessmentFrameworkShareRequestsResponseTypeDef definition

class ListAssessmentFrameworkShareRequestsResponseTypeDef(TypedDict):
    assessmentFrameworkShareRequests: List[AssessmentFrameworkShareRequestTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AssessmentFrameworkShareRequestTypeDef
  2. See ResponseMetadataTypeDef

ListAssessmentFrameworksResponseTypeDef#

# ListAssessmentFrameworksResponseTypeDef definition

class ListAssessmentFrameworksResponseTypeDef(TypedDict):
    frameworkMetadataList: List[AssessmentFrameworkMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AssessmentFrameworkMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListAssessmentReportsResponseTypeDef#

# ListAssessmentReportsResponseTypeDef definition

class ListAssessmentReportsResponseTypeDef(TypedDict):
    assessmentReports: List[AssessmentReportMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AssessmentReportMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListKeywordsForDataSourceResponseTypeDef#

# ListKeywordsForDataSourceResponseTypeDef definition

class ListKeywordsForDataSourceResponseTypeDef(TypedDict):
    keywords: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    nextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterAccountResponseTypeDef#

# RegisterAccountResponseTypeDef definition

class RegisterAccountResponseTypeDef(TypedDict):
    status: AccountStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountStatusType
  2. See ResponseMetadataTypeDef

RegisterOrganizationAdminAccountResponseTypeDef#

# RegisterOrganizationAdminAccountResponseTypeDef definition

class RegisterOrganizationAdminAccountResponseTypeDef(TypedDict):
    adminAccountId: str,
    organizationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartAssessmentFrameworkShareResponseTypeDef#

# StartAssessmentFrameworkShareResponseTypeDef definition

class StartAssessmentFrameworkShareResponseTypeDef(TypedDict):
    assessmentFrameworkShareRequest: AssessmentFrameworkShareRequestTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentFrameworkShareRequestTypeDef
  2. See ResponseMetadataTypeDef

UpdateAssessmentFrameworkShareResponseTypeDef#

# UpdateAssessmentFrameworkShareResponseTypeDef definition

class UpdateAssessmentFrameworkShareResponseTypeDef(TypedDict):
    assessmentFrameworkShareRequest: AssessmentFrameworkShareRequestTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentFrameworkShareRequestTypeDef
  2. See ResponseMetadataTypeDef

ValidateAssessmentReportIntegrityResponseTypeDef#

# ValidateAssessmentReportIntegrityResponseTypeDef definition

class ValidateAssessmentReportIntegrityResponseTypeDef(TypedDict):
    signatureValid: bool,
    signatureAlgorithm: str,
    signatureDateTime: str,
    signatureKeyId: str,
    validationErrors: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BatchCreateDelegationByAssessmentErrorTypeDef#

# BatchCreateDelegationByAssessmentErrorTypeDef definition

class BatchCreateDelegationByAssessmentErrorTypeDef(TypedDict):
    createDelegationRequest: NotRequired[CreateDelegationRequestTypeDef],  # (1)
    errorCode: NotRequired[str],
    errorMessage: NotRequired[str],
  1. See CreateDelegationRequestTypeDef

BatchCreateDelegationByAssessmentRequestRequestTypeDef#

# BatchCreateDelegationByAssessmentRequestRequestTypeDef definition

class BatchCreateDelegationByAssessmentRequestRequestTypeDef(TypedDict):
    createDelegationRequests: Sequence[CreateDelegationRequestTypeDef],  # (1)
    assessmentId: str,
  1. See CreateDelegationRequestTypeDef

BatchDeleteDelegationByAssessmentResponseTypeDef#

# BatchDeleteDelegationByAssessmentResponseTypeDef definition

class BatchDeleteDelegationByAssessmentResponseTypeDef(TypedDict):
    errors: List[BatchDeleteDelegationByAssessmentErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchDeleteDelegationByAssessmentErrorTypeDef
  2. See ResponseMetadataTypeDef

BatchImportEvidenceToAssessmentControlErrorTypeDef#

# BatchImportEvidenceToAssessmentControlErrorTypeDef definition

class BatchImportEvidenceToAssessmentControlErrorTypeDef(TypedDict):
    manualEvidence: NotRequired[ManualEvidenceTypeDef],  # (1)
    errorCode: NotRequired[str],
    errorMessage: NotRequired[str],
  1. See ManualEvidenceTypeDef

BatchImportEvidenceToAssessmentControlRequestRequestTypeDef#

# BatchImportEvidenceToAssessmentControlRequestRequestTypeDef definition

class BatchImportEvidenceToAssessmentControlRequestRequestTypeDef(TypedDict):
    assessmentId: str,
    controlSetId: str,
    controlId: str,
    manualEvidence: Sequence[ManualEvidenceTypeDef],  # (1)
  1. See ManualEvidenceTypeDef

GetChangeLogsResponseTypeDef#

# GetChangeLogsResponseTypeDef definition

class GetChangeLogsResponseTypeDef(TypedDict):
    changeLogs: List[ChangeLogTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ChangeLogTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See EvidenceInsightsTypeDef

ControlInsightsMetadataByAssessmentItemTypeDef#

# ControlInsightsMetadataByAssessmentItemTypeDef definition

class ControlInsightsMetadataByAssessmentItemTypeDef(TypedDict):
    name: NotRequired[str],
    id: NotRequired[str],
    evidenceInsights: NotRequired[EvidenceInsightsTypeDef],  # (1)
    controlSetName: NotRequired[str],
    lastUpdated: NotRequired[datetime],
  1. See EvidenceInsightsTypeDef

ControlInsightsMetadataItemTypeDef#

# ControlInsightsMetadataItemTypeDef definition

class ControlInsightsMetadataItemTypeDef(TypedDict):
    name: NotRequired[str],
    id: NotRequired[str],
    evidenceInsights: NotRequired[EvidenceInsightsTypeDef],  # (1)
    lastUpdated: NotRequired[datetime],
  1. See EvidenceInsightsTypeDef

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],
  1. See SourceSetUpOptionType
  2. See SourceTypeType
  3. See SourceKeywordTypeDef
  4. 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],
  1. See SourceSetUpOptionType
  2. See SourceTypeType
  3. See SourceKeywordTypeDef
  4. See SourceFrequencyType

ListControlsResponseTypeDef#

# ListControlsResponseTypeDef definition

class ListControlsResponseTypeDef(TypedDict):
    controlMetadataList: List[ControlMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ControlMetadataTypeDef
  2. See ResponseMetadataTypeDef

CreateAssessmentFrameworkControlSetTypeDef#

# CreateAssessmentFrameworkControlSetTypeDef definition

class CreateAssessmentFrameworkControlSetTypeDef(TypedDict):
    name: str,
    controls: NotRequired[Sequence[CreateAssessmentFrameworkControlTypeDef]],  # (1)
  1. See CreateAssessmentFrameworkControlTypeDef

UpdateAssessmentFrameworkControlSetTypeDef#

# UpdateAssessmentFrameworkControlSetTypeDef definition

class UpdateAssessmentFrameworkControlSetTypeDef(TypedDict):
    name: str,
    controls: Sequence[CreateAssessmentFrameworkControlTypeDef],  # (1)
    id: NotRequired[str],
  1. See CreateAssessmentFrameworkControlTypeDef

GetDelegationsResponseTypeDef#

# GetDelegationsResponseTypeDef definition

class GetDelegationsResponseTypeDef(TypedDict):
    delegations: List[DelegationMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DelegationMetadataTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See AssessmentReportsDestinationTypeDef
  2. See RoleTypeDef
  3. See DeregistrationPolicyTypeDef
  4. 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)
  1. See AssessmentReportsDestinationTypeDef
  2. See RoleTypeDef
  3. See EvidenceFinderEnablementTypeDef
  4. See DeregistrationPolicyTypeDef
  5. 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],
  1. See ResourceTypeDef

GetAssessmentReportUrlResponseTypeDef#

# GetAssessmentReportUrlResponseTypeDef definition

class GetAssessmentReportUrlResponseTypeDef(TypedDict):
    preSignedUrl: URLTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See URLTypeDef
  2. See ResponseMetadataTypeDef

GetInsightsByAssessmentResponseTypeDef#

# GetInsightsByAssessmentResponseTypeDef definition

class GetInsightsByAssessmentResponseTypeDef(TypedDict):
    insights: InsightsByAssessmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InsightsByAssessmentTypeDef
  2. See ResponseMetadataTypeDef

GetInsightsResponseTypeDef#

# GetInsightsResponseTypeDef definition

class GetInsightsResponseTypeDef(TypedDict):
    insights: InsightsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InsightsTypeDef
  2. See ResponseMetadataTypeDef

GetServicesInScopeResponseTypeDef#

# GetServicesInScopeResponseTypeDef definition

class GetServicesInScopeResponseTypeDef(TypedDict):
    serviceMetadata: List[ServiceMetadataTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListNotificationsResponseTypeDef#

# ListNotificationsResponseTypeDef definition

class ListNotificationsResponseTypeDef(TypedDict):
    notifications: List[NotificationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See NotificationTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See AssessmentStatusType
  2. See AssessmentReportsDestinationTypeDef
  3. See ScopeOutputTypeDef
  4. See RoleTypeDef
  5. 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]],
  1. See AssessmentReportsDestinationTypeDef
  2. See ScopeTypeDef
  3. See RoleTypeDef

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)
  1. See ScopeTypeDef
  2. See AssessmentReportsDestinationTypeDef
  3. See RoleTypeDef

ListAssessmentsResponseTypeDef#

# ListAssessmentsResponseTypeDef definition

class ListAssessmentsResponseTypeDef(TypedDict):
    assessmentMetadata: List[AssessmentMetadataItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AssessmentMetadataItemTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See ControlSetStatusType
  2. See RoleTypeDef
  3. See AssessmentControlTypeDef
  4. See DelegationTypeDef

UpdateAssessmentControlResponseTypeDef#

# UpdateAssessmentControlResponseTypeDef definition

class UpdateAssessmentControlResponseTypeDef(TypedDict):
    control: AssessmentControlTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentControlTypeDef
  2. See ResponseMetadataTypeDef

BatchCreateDelegationByAssessmentResponseTypeDef#

# BatchCreateDelegationByAssessmentResponseTypeDef definition

class BatchCreateDelegationByAssessmentResponseTypeDef(TypedDict):
    delegations: List[DelegationTypeDef],  # (1)
    errors: List[BatchCreateDelegationByAssessmentErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DelegationTypeDef
  2. See BatchCreateDelegationByAssessmentErrorTypeDef
  3. See ResponseMetadataTypeDef

BatchImportEvidenceToAssessmentControlResponseTypeDef#

# BatchImportEvidenceToAssessmentControlResponseTypeDef definition

class BatchImportEvidenceToAssessmentControlResponseTypeDef(TypedDict):
    errors: List[BatchImportEvidenceToAssessmentControlErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchImportEvidenceToAssessmentControlErrorTypeDef
  2. See ResponseMetadataTypeDef

ListControlDomainInsightsByAssessmentResponseTypeDef#

# ListControlDomainInsightsByAssessmentResponseTypeDef definition

class ListControlDomainInsightsByAssessmentResponseTypeDef(TypedDict):
    controlDomainInsights: List[ControlDomainInsightsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ControlDomainInsightsTypeDef
  2. See ResponseMetadataTypeDef

ListControlDomainInsightsResponseTypeDef#

# ListControlDomainInsightsResponseTypeDef definition

class ListControlDomainInsightsResponseTypeDef(TypedDict):
    controlDomainInsights: List[ControlDomainInsightsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ControlDomainInsightsTypeDef
  2. See ResponseMetadataTypeDef

ListAssessmentControlInsightsByControlDomainResponseTypeDef#

# ListAssessmentControlInsightsByControlDomainResponseTypeDef definition

class ListAssessmentControlInsightsByControlDomainResponseTypeDef(TypedDict):
    controlInsightsByAssessment: List[ControlInsightsMetadataByAssessmentItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ControlInsightsMetadataByAssessmentItemTypeDef
  2. See ResponseMetadataTypeDef

ListControlInsightsByControlDomainResponseTypeDef#

# ListControlInsightsByControlDomainResponseTypeDef definition

class ListControlInsightsByControlDomainResponseTypeDef(TypedDict):
    controlInsightsMetadata: List[ControlInsightsMetadataItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ControlInsightsMetadataItemTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See ControlTypeType
  2. See ControlMappingSourceTypeDef
  3. See ControlStateType

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],
  1. See ControlMappingSourceTypeDef

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]],
  1. See CreateControlMappingSourceTypeDef

CreateAssessmentFrameworkRequestRequestTypeDef#

# CreateAssessmentFrameworkRequestRequestTypeDef definition

class CreateAssessmentFrameworkRequestRequestTypeDef(TypedDict):
    name: str,
    controlSets: Sequence[CreateAssessmentFrameworkControlSetTypeDef],  # (1)
    description: NotRequired[str],
    complianceType: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See CreateAssessmentFrameworkControlSetTypeDef

UpdateAssessmentFrameworkRequestRequestTypeDef#

# UpdateAssessmentFrameworkRequestRequestTypeDef definition

class UpdateAssessmentFrameworkRequestRequestTypeDef(TypedDict):
    frameworkId: str,
    name: str,
    controlSets: Sequence[UpdateAssessmentFrameworkControlSetTypeDef],  # (1)
    description: NotRequired[str],
    complianceType: NotRequired[str],
  1. See UpdateAssessmentFrameworkControlSetTypeDef

GetSettingsResponseTypeDef#

# GetSettingsResponseTypeDef definition

class GetSettingsResponseTypeDef(TypedDict):
    settings: SettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SettingsTypeDef
  2. See ResponseMetadataTypeDef

UpdateSettingsResponseTypeDef#

# UpdateSettingsResponseTypeDef definition

class UpdateSettingsResponseTypeDef(TypedDict):
    settings: SettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SettingsTypeDef
  2. See ResponseMetadataTypeDef

GetEvidenceByEvidenceFolderResponseTypeDef#

# GetEvidenceByEvidenceFolderResponseTypeDef definition

class GetEvidenceByEvidenceFolderResponseTypeDef(TypedDict):
    evidence: List[EvidenceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EvidenceTypeDef
  2. See ResponseMetadataTypeDef

GetEvidenceResponseTypeDef#

# GetEvidenceResponseTypeDef definition

class GetEvidenceResponseTypeDef(TypedDict):
    evidence: EvidenceTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EvidenceTypeDef
  2. See ResponseMetadataTypeDef

AssessmentFrameworkTypeDef#

# AssessmentFrameworkTypeDef definition

class AssessmentFrameworkTypeDef(TypedDict):
    id: NotRequired[str],
    arn: NotRequired[str],
    metadata: NotRequired[FrameworkMetadataTypeDef],  # (1)
    controlSets: NotRequired[List[AssessmentControlSetTypeDef]],  # (2)
  1. See FrameworkMetadataTypeDef
  2. See AssessmentControlSetTypeDef

UpdateAssessmentControlSetStatusResponseTypeDef#

# UpdateAssessmentControlSetStatusResponseTypeDef definition

class UpdateAssessmentControlSetStatusResponseTypeDef(TypedDict):
    controlSet: AssessmentControlSetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentControlSetTypeDef
  2. See ResponseMetadataTypeDef

ControlSetTypeDef#

# ControlSetTypeDef definition

class ControlSetTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    controls: NotRequired[List[ControlTypeDef]],  # (1)
  1. See ControlTypeDef

CreateControlResponseTypeDef#

# CreateControlResponseTypeDef definition

class CreateControlResponseTypeDef(TypedDict):
    control: ControlTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ControlTypeDef
  2. See ResponseMetadataTypeDef

GetControlResponseTypeDef#

# GetControlResponseTypeDef definition

class GetControlResponseTypeDef(TypedDict):
    control: ControlTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ControlTypeDef
  2. See ResponseMetadataTypeDef

UpdateControlResponseTypeDef#

# UpdateControlResponseTypeDef definition

class UpdateControlResponseTypeDef(TypedDict):
    control: ControlTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ControlTypeDef
  2. See ResponseMetadataTypeDef

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]],
  1. See AWSAccountTypeDef
  2. See AssessmentMetadataTypeDef
  3. See AssessmentFrameworkTypeDef

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]],
  1. See FrameworkTypeType
  2. See ControlSetTypeDef

CreateAssessmentResponseTypeDef#

# CreateAssessmentResponseTypeDef definition

class CreateAssessmentResponseTypeDef(TypedDict):
    assessment: AssessmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentTypeDef
  2. See ResponseMetadataTypeDef

GetAssessmentResponseTypeDef#

# GetAssessmentResponseTypeDef definition

class GetAssessmentResponseTypeDef(TypedDict):
    assessment: AssessmentTypeDef,  # (1)
    userRole: RoleTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AssessmentTypeDef
  2. See RoleTypeDef
  3. See ResponseMetadataTypeDef

UpdateAssessmentResponseTypeDef#

# UpdateAssessmentResponseTypeDef definition

class UpdateAssessmentResponseTypeDef(TypedDict):
    assessment: AssessmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentTypeDef
  2. See ResponseMetadataTypeDef

UpdateAssessmentStatusResponseTypeDef#

# UpdateAssessmentStatusResponseTypeDef definition

class UpdateAssessmentStatusResponseTypeDef(TypedDict):
    assessment: AssessmentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssessmentTypeDef
  2. See ResponseMetadataTypeDef

CreateAssessmentFrameworkResponseTypeDef#

# CreateAssessmentFrameworkResponseTypeDef definition

class CreateAssessmentFrameworkResponseTypeDef(TypedDict):
    framework: FrameworkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FrameworkTypeDef
  2. See ResponseMetadataTypeDef

GetAssessmentFrameworkResponseTypeDef#

# GetAssessmentFrameworkResponseTypeDef definition

class GetAssessmentFrameworkResponseTypeDef(TypedDict):
    framework: FrameworkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FrameworkTypeDef
  2. See ResponseMetadataTypeDef

UpdateAssessmentFrameworkResponseTypeDef#

# UpdateAssessmentFrameworkResponseTypeDef definition

class UpdateAssessmentFrameworkResponseTypeDef(TypedDict):
    framework: FrameworkTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FrameworkTypeDef
  2. See ResponseMetadataTypeDef