Skip to content

Auditmanager Classes

AWSAccount

id

  • Type: typing.Optional[str]

emailAddress

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

AWSService

serviceName

  • Type: typing.Optional[str]

Assessment

arn

  • Type: typing.Optional[str]

awsAccount

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AWSAccount]

metadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentMetadata]

framework

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentFramework]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

AssessmentControl

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['INACTIVE', 'REVIEWED', 'UNDER_REVIEW']]

response

  • Type: typing.Optional[typing.Literal['AUTOMATE', 'DEFER', 'IGNORE', 'MANUAL']]

comments

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlComment]]

evidenceSources

  • Type: typing.Optional[typing.List[str]]

evidenceCount

  • Type: typing.Optional[int]

assessmentReportEvidenceCount

  • Type: typing.Optional[int]

AssessmentControlSet

id

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'REVIEWED', 'UNDER_REVIEW']]

roles

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Role]]

controls

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentControl]]

delegations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Delegation]]

systemEvidenceCount

  • Type: typing.Optional[int]

manualEvidenceCount

  • Type: typing.Optional[int]

AssessmentEvidenceFolder

name

  • Type: typing.Optional[str]

date

  • Type: typing.Optional[datetime.datetime]

assessmentId

  • Type: typing.Optional[str]

controlSetId

  • Type: typing.Optional[str]

controlId

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

dataSource

  • Type: typing.Optional[str]

author

  • Type: typing.Optional[str]

totalEvidence

  • Type: typing.Optional[int]

assessmentReportSelectionCount

  • Type: typing.Optional[int]

controlName

  • Type: typing.Optional[str]

evidenceResourcesIncludedCount

  • Type: typing.Optional[int]

evidenceByTypeConfigurationDataCount

  • Type: typing.Optional[int]

evidenceByTypeManualCount

  • Type: typing.Optional[int]

evidenceByTypeComplianceCheckCount

  • Type: typing.Optional[int]

evidenceByTypeComplianceCheckIssuesCount

  • Type: typing.Optional[int]

evidenceByTypeUserActivityCount

  • Type: typing.Optional[int]

evidenceAwsServiceSourceCount

  • Type: typing.Optional[int]

AssessmentFramework

id

  • Type: typing.Optional[str]

arn

  • Type: typing.Optional[str]

metadata

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.FrameworkMetadata]

controlSets

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentControlSet]]

AssessmentFrameworkMetadata

arn

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['Custom', 'Standard']]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]
  • Type: typing.Optional[str]

complianceType

  • Type: typing.Optional[str]

controlsCount

  • Type: typing.Optional[int]

controlSetsCount

  • Type: typing.Optional[int]

createdAt

  • Type: typing.Optional[datetime.datetime]

lastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

AssessmentFrameworkShareRequest

id

  • Type: typing.Optional[str]

frameworkId

  • Type: typing.Optional[str]

frameworkName

  • Type: typing.Optional[str]

frameworkDescription

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'DECLINED', 'EXPIRED', 'EXPIRING', 'FAILED', 'REPLICATING', 'REVOKED', 'SHARED']]

sourceAccount

  • Type: typing.Optional[str]

destinationAccount

  • Type: typing.Optional[str]

destinationRegion

  • Type: typing.Optional[str]

expirationTime

  • Type: typing.Optional[datetime.datetime]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

comment

  • Type: typing.Optional[str]

standardControlsCount

  • Type: typing.Optional[int]

customControlsCount

  • Type: typing.Optional[int]

complianceType

  • Type: typing.Optional[str]

AssessmentMetadata

name

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

complianceType

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]

assessmentReportsDestination

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentReportsDestination]

scope

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ScopeOutput]

roles

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Role]]

delegations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Delegation]]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

AssessmentMetadataItem

name

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

complianceType

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]

roles

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Role]]

delegations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Delegation]]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

AssessmentReport

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

awsAccountId

  • Type: typing.Optional[str]

assessmentId

  • Type: typing.Optional[str]

assessmentName

  • Type: typing.Optional[str]

author

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['COMPLETE', 'FAILED', 'IN_PROGRESS']]

creationTime

  • Type: typing.Optional[datetime.datetime]

AssessmentReportEvidenceError

evidenceId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[str]

errorMessage

  • Type: typing.Optional[str]

AssessmentReportMetadata

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

assessmentId

  • Type: typing.Optional[str]

assessmentName

  • Type: typing.Optional[str]

author

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['COMPLETE', 'FAILED', 'IN_PROGRESS']]

creationTime

  • Type: typing.Optional[datetime.datetime]

AssessmentReportsDestination

destinationType

  • Type: typing.Optional[typing.Literal['S3']]

destination

  • Type: typing.Optional[str]

AssociateAssessmentReportEvidenceFolderRequest

assessmentId

  • Type:
  • Required: Yes

evidenceFolderId

  • Type:
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchAssociateAssessmentReportEvidenceRequest

assessmentId

  • Type:
  • Required: Yes

evidenceFolderId

  • Type:
  • Required: Yes

evidenceIds

  • Type: typing.List[str]
  • Required: Yes

BatchAssociateAssessmentReportEvidenceResponse

evidenceIds

  • Type: typing.List[str]
  • Required: Yes

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentReportEvidenceError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchCreateDelegationByAssessmentError

createDelegationRequest

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.CreateDelegationRequest]

errorCode

  • Type: typing.Optional[str]

errorMessage

  • Type: typing.Optional[str]

BatchCreateDelegationByAssessmentRequest

createDelegationRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.CreateDelegationRequest]
  • Required: Yes

assessmentId

  • Type:
  • Required: Yes

BatchCreateDelegationByAssessmentResponse

delegations

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Delegation]
  • Required: Yes

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.BatchCreateDelegationByAssessmentError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDeleteDelegationByAssessmentError

delegationId

  • Type: typing.Optional[str]

errorCode

  • Type: typing.Optional[str]

errorMessage

  • Type: typing.Optional[str]

BatchDeleteDelegationByAssessmentRequest

delegationIds

  • Type: typing.List[str]
  • Required: Yes

assessmentId

  • Type:
  • Required: Yes

BatchDeleteDelegationByAssessmentResponse

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.BatchDeleteDelegationByAssessmentError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDisassociateAssessmentReportEvidenceRequest

assessmentId

  • Type:
  • Required: Yes

evidenceFolderId

  • Type:
  • Required: Yes

evidenceIds

  • Type: typing.List[str]
  • Required: Yes

BatchDisassociateAssessmentReportEvidenceResponse

evidenceIds

  • Type: typing.List[str]
  • Required: Yes

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentReportEvidenceError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchImportEvidenceToAssessmentControlError

manualEvidence

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ManualEvidence]

errorCode

  • Type: typing.Optional[str]

errorMessage

  • Type: typing.Optional[str]

BatchImportEvidenceToAssessmentControlRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type:
  • Required: Yes

controlId

  • Type:
  • Required: Yes

manualEvidence

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ManualEvidence]
  • Required: Yes

BatchImportEvidenceToAssessmentControlResponse

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.BatchImportEvidenceToAssessmentControlError]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ChangeLog

objectType

  • Type: typing.Optional[typing.Literal['ASSESSMENT', 'ASSESSMENT_REPORT', 'CONTROL', 'CONTROL_SET', 'DELEGATION']]

objectName

  • Type: typing.Optional[str]

action

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE', 'DELETE', 'IMPORT_EVIDENCE', 'INACTIVE', 'REVIEWED', 'UNDER_REVIEW', 'UPDATE_METADATA']]

createdAt

  • Type: typing.Optional[datetime.datetime]

createdBy

  • Type: typing.Optional[str]

Control

arn

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['Core', 'Custom', 'Standard']]

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

testingInformation

  • Type: typing.Optional[str]

actionPlanTitle

  • Type: typing.Optional[str]

actionPlanInstructions

  • Type: typing.Optional[str]

controlSources

  • Type: typing.Optional[str]

controlMappingSources

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlMappingSource]]

createdAt

  • Type: typing.Optional[datetime.datetime]

lastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

createdBy

  • Type: typing.Optional[str]

lastUpdatedBy

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

state

  • Type: typing.Optional[typing.Literal['ACTIVE', 'END_OF_SUPPORT']]

ControlComment

authorName

  • Type: typing.Optional[str]

commentBody

  • Type: typing.Optional[str]

postedDate

  • Type: typing.Optional[datetime.datetime]

ControlDomainInsights

name

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

controlsCountByNoncompliantEvidence

  • Type: typing.Optional[int]

totalControlsCount

  • Type: typing.Optional[int]

evidenceInsights

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.EvidenceInsights]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

ControlInsightsMetadataByAssessmentItem

name

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

evidenceInsights

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.EvidenceInsights]

controlSetName

  • Type: typing.Optional[str]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

ControlInsightsMetadataItem

name

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

evidenceInsights

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.EvidenceInsights]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

ControlMappingSource

sourceId

  • Type: typing.Optional[str]

sourceName

  • Type: typing.Optional[str]

sourceDescription

  • Type: typing.Optional[str]

sourceSetUpOption

  • Type: typing.Optional[typing.Literal['Procedural_Controls_Mapping', 'System_Controls_Mapping']]

sourceType

  • Type: typing.Optional[typing.Literal['AWS_API_Call', 'AWS_Cloudtrail', 'AWS_Config', 'AWS_Security_Hub', 'Common_Control', 'Core_Control', 'MANUAL']]

sourceKeyword

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.SourceKeyword]

sourceFrequency

  • Type: typing.Optional[typing.Literal['DAILY', 'MONTHLY', 'WEEKLY']]

troubleshootingText

  • Type: typing.Optional[str]

ControlMetadata

arn

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

controlSources

  • Type: typing.Optional[str]

createdAt

  • Type: typing.Optional[datetime.datetime]

lastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

ControlSet

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

controls

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Control]]

CreateAssessmentFrameworkControl

id

  • Type:
  • Required: Yes

CreateAssessmentFrameworkControlSet

name

  • Type:
  • Required: Yes

controls

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.CreateAssessmentFrameworkControl]]

CreateAssessmentFrameworkRequest

name

  • Type:
  • Required: Yes

controlSets

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.CreateAssessmentFrameworkControlSet]
  • Required: Yes

description

  • Type: typing.Optional[str]

complianceType

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateAssessmentFrameworkResponse

framework

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAssessmentReportRequest

name

  • Type:
  • Required: Yes

assessmentId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

queryStatement

  • Type: typing.Optional[str]

CreateAssessmentReportResponse

assessmentReport

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAssessmentRequest

name

  • Type:
  • Required: Yes

assessmentReportsDestination

  • Type:
  • Required: Yes

scope

  • Type: typing.Union[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Scope, aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ScopeOutput]
  • Required: Yes

roles

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Role]
  • Required: Yes

frameworkId

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateAssessmentResponse

assessment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateControlMappingSource

sourceName

  • Type: typing.Optional[str]

sourceDescription

  • Type: typing.Optional[str]

sourceSetUpOption

  • Type: typing.Optional[typing.Literal['Procedural_Controls_Mapping', 'System_Controls_Mapping']]

sourceType

  • Type: typing.Optional[typing.Literal['AWS_API_Call', 'AWS_Cloudtrail', 'AWS_Config', 'AWS_Security_Hub', 'Common_Control', 'Core_Control', 'MANUAL']]

sourceKeyword

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.SourceKeyword]

sourceFrequency

  • Type: typing.Optional[typing.Literal['DAILY', 'MONTHLY', 'WEEKLY']]

troubleshootingText

  • Type: typing.Optional[str]

CreateControlRequest

name

  • Type:
  • Required: Yes

controlMappingSources

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.CreateControlMappingSource]
  • Required: Yes

description

  • Type: typing.Optional[str]

testingInformation

  • Type: typing.Optional[str]

actionPlanTitle

  • Type: typing.Optional[str]

actionPlanInstructions

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateControlResponse

control

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDelegationRequest

comment

  • Type: typing.Optional[str]

controlSetId

  • Type: typing.Optional[str]

roleArn

  • Type: typing.Optional[str]

roleType

  • Type: typing.Optional[typing.Literal['PROCESS_OWNER', 'RESOURCE_OWNER']]

DefaultExportDestination

destinationType

  • Type: typing.Optional[typing.Literal['S3']]

destination

  • Type: typing.Optional[str]

Delegation

id

  • Type: typing.Optional[str]

assessmentName

  • Type: typing.Optional[str]

assessmentId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['COMPLETE', 'IN_PROGRESS', 'UNDER_REVIEW']]

roleArn

  • Type: typing.Optional[str]

roleType

  • Type: typing.Optional[typing.Literal['PROCESS_OWNER', 'RESOURCE_OWNER']]

creationTime

  • Type: typing.Optional[datetime.datetime]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

controlSetId

  • Type: typing.Optional[str]

comment

  • Type: typing.Optional[str]

createdBy

  • Type: typing.Optional[str]

DelegationMetadata

id

  • Type: typing.Optional[str]

assessmentName

  • Type: typing.Optional[str]

assessmentId

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['COMPLETE', 'IN_PROGRESS', 'UNDER_REVIEW']]

roleArn

  • Type: typing.Optional[str]

creationTime

  • Type: typing.Optional[datetime.datetime]

controlSetName

  • Type: typing.Optional[str]

DeleteAssessmentFrameworkRequest

frameworkId

  • Type:
  • Required: Yes

DeleteAssessmentFrameworkShareRequest

requestId

  • Type:
  • Required: Yes

requestType

  • Type: typing.Literal['RECEIVED', 'SENT']
  • Required: Yes

DeleteAssessmentReportRequest

assessmentId

  • Type:
  • Required: Yes

assessmentReportId

  • Type:
  • Required: Yes

DeleteAssessmentRequest

assessmentId

  • Type:
  • Required: Yes

DeleteControlRequest

controlId

  • Type:
  • Required: Yes

DeregisterAccountResponse

status

  • Type: typing.Literal['ACTIVE', 'INACTIVE', 'PENDING_ACTIVATION']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeregisterOrganizationAdminAccountRequest

adminAccountId

  • Type: typing.Optional[str]

DeregistrationPolicy

deleteResources

  • Type: typing.Optional[typing.Literal['ALL', 'DEFAULT']]

DisassociateAssessmentReportEvidenceFolderRequest

assessmentId

  • Type:
  • Required: Yes

evidenceFolderId

  • Type:
  • Required: Yes

Evidence

dataSource

  • Type: typing.Optional[str]

evidenceAwsAccountId

  • Type: typing.Optional[str]

time

  • Type: typing.Optional[datetime.datetime]

eventSource

  • Type: typing.Optional[str]

eventName

  • Type: typing.Optional[str]

evidenceByType

  • Type: typing.Optional[str]

resourcesIncluded

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Resource]]

attributes

  • Type: typing.Optional[typing.Dict[str, str]]

iamId

  • Type: typing.Optional[str]

complianceCheck

  • Type: typing.Optional[str]

awsOrganization

  • Type: typing.Optional[str]

awsAccountId

  • Type: typing.Optional[str]

evidenceFolderId

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

assessmentReportSelection

  • Type: typing.Optional[str]

EvidenceFinderEnablement

eventDataStoreArn

  • Type: typing.Optional[str]

enablementStatus

  • Type: typing.Optional[typing.Literal['DISABLED', 'DISABLE_IN_PROGRESS', 'ENABLED', 'ENABLE_IN_PROGRESS']]

backfillStatus

  • Type: typing.Optional[typing.Literal['COMPLETED', 'IN_PROGRESS', 'NOT_STARTED']]

error

  • Type: typing.Optional[str]

EvidenceInsights

noncompliantEvidenceCount

  • Type: typing.Optional[int]

compliantEvidenceCount

  • Type: typing.Optional[int]

inconclusiveEvidenceCount

  • Type: typing.Optional[int]

Framework

arn

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[typing.Literal['Custom', 'Standard']]

complianceType

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

logo

  • Type: typing.Optional[str]

controlSources

  • Type: typing.Optional[str]

controlSets

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlSet]]

createdAt

  • Type: typing.Optional[datetime.datetime]

lastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

createdBy

  • Type: typing.Optional[str]

lastUpdatedBy

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

FrameworkMetadata

name

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

logo

  • Type: typing.Optional[str]

complianceType

  • Type: typing.Optional[str]

GetAccountStatusResponse

status

  • Type: typing.Literal['ACTIVE', 'INACTIVE', 'PENDING_ACTIVATION']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAssessmentFrameworkRequest

frameworkId

  • Type:
  • Required: Yes

GetAssessmentFrameworkResponse

framework

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAssessmentReportUrlRequest

assessmentReportId

  • Type:
  • Required: Yes

assessmentId

  • Type:
  • Required: Yes

GetAssessmentReportUrlResponse

preSignedUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAssessmentRequest

assessmentId

  • Type:
  • Required: Yes

GetAssessmentResponse

assessment

  • Type:
  • Required: Yes

userRole

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetChangeLogsRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type: typing.Optional[str]

controlId

  • Type: typing.Optional[str]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetChangeLogsResponse

changeLogs

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ChangeLog]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetControlRequest

controlId

  • Type:
  • Required: Yes

GetControlResponse

control

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDelegationsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetDelegationsResponse

delegations

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.DelegationMetadata]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetEvidenceByEvidenceFolderRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type:
  • Required: Yes

evidenceFolderId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetEvidenceByEvidenceFolderResponse

evidence

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Evidence]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetEvidenceFileUploadUrlRequest

fileName

  • Type:
  • Required: Yes

GetEvidenceFileUploadUrlResponse

evidenceFileName

  • Type:
  • Required: Yes

uploadUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetEvidenceFolderRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type:
  • Required: Yes

evidenceFolderId

  • Type:
  • Required: Yes

GetEvidenceFolderResponse

evidenceFolder

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetEvidenceFoldersByAssessmentControlRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type:
  • Required: Yes

controlId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetEvidenceFoldersByAssessmentControlResponse

evidenceFolders

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentEvidenceFolder]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetEvidenceFoldersByAssessmentRequest

assessmentId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetEvidenceFoldersByAssessmentResponse

evidenceFolders

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentEvidenceFolder]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetEvidenceRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type:
  • Required: Yes

evidenceFolderId

  • Type:
  • Required: Yes

evidenceId

  • Type:
  • Required: Yes

GetEvidenceResponse

evidence

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetInsightsByAssessmentRequest

assessmentId

  • Type:
  • Required: Yes

GetInsightsByAssessmentResponse

insights

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetInsightsResponse

insights

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetOrganizationAdminAccountResponse

adminAccountId

  • Type:
  • Required: Yes

organizationId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetServicesInScopeResponse

serviceMetadata

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ServiceMetadata]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSettingsRequest

attribute

  • Type: typing.Literal['ALL', 'DEFAULT_ASSESSMENT_REPORTS_DESTINATION', 'DEFAULT_EXPORT_DESTINATION', 'DEFAULT_PROCESS_OWNERS', 'DEREGISTRATION_POLICY', 'EVIDENCE_FINDER_ENABLEMENT', 'IS_AWS_ORG_ENABLED', 'SNS_TOPIC']
  • Required: Yes

GetSettingsResponse

settings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Insights

activeAssessmentsCount

  • Type: typing.Optional[int]

noncompliantEvidenceCount

  • Type: typing.Optional[int]

compliantEvidenceCount

  • Type: typing.Optional[int]

inconclusiveEvidenceCount

  • Type: typing.Optional[int]

assessmentControlsCountByNoncompliantEvidence

  • Type: typing.Optional[int]

totalAssessmentControlsCount

  • Type: typing.Optional[int]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

InsightsByAssessment

noncompliantEvidenceCount

  • Type: typing.Optional[int]

compliantEvidenceCount

  • Type: typing.Optional[int]

inconclusiveEvidenceCount

  • Type: typing.Optional[int]

assessmentControlsCountByNoncompliantEvidence

  • Type: typing.Optional[int]

totalAssessmentControlsCount

  • Type: typing.Optional[int]

lastUpdated

  • Type: typing.Optional[datetime.datetime]

ListAssessmentControlInsightsByControlDomainRequest

controlDomainId

  • Type:
  • Required: Yes

assessmentId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAssessmentControlInsightsByControlDomainResponse

controlInsightsByAssessment

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlInsightsMetadataByAssessmentItem]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssessmentFrameworkShareRequestsRequest

requestType

  • Type: typing.Literal['RECEIVED', 'SENT']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAssessmentFrameworkShareRequestsResponse

assessmentFrameworkShareRequests

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentFrameworkShareRequest]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssessmentFrameworksRequest

frameworkType

  • Type: typing.Literal['Custom', 'Standard']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAssessmentFrameworksResponse

frameworkMetadataList

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentFrameworkMetadata]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssessmentReportsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAssessmentReportsResponse

assessmentReports

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentReportMetadata]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssessmentsRequest

status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'INACTIVE']]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAssessmentsResponse

assessmentMetadata

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentMetadataItem]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListControlDomainInsightsByAssessmentRequest

assessmentId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListControlDomainInsightsByAssessmentResponse

controlDomainInsights

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlDomainInsights]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListControlDomainInsightsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListControlDomainInsightsResponse

controlDomainInsights

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlDomainInsights]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListControlInsightsByControlDomainRequest

controlDomainId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListControlInsightsByControlDomainResponse

controlInsightsMetadata

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlInsightsMetadataItem]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListControlsRequest

controlType

  • Type: typing.Literal['Core', 'Custom', 'Standard']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

controlCatalogId

  • Type: typing.Optional[str]

ListControlsResponse

controlMetadataList

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlMetadata]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListKeywordsForDataSourceRequest

source

  • Type: typing.Literal['AWS_API_Call', 'AWS_Cloudtrail', 'AWS_Config', 'AWS_Security_Hub', 'MANUAL']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListKeywordsForDataSourceResponse

keywords

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListNotificationsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListNotificationsResponse

notifications

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Notification]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ManualEvidence

s3ResourcePath

  • Type: typing.Optional[str]

textResponse

  • Type: typing.Optional[str]

evidenceFileName

  • Type: typing.Optional[str]

Notification

id

  • Type: typing.Optional[str]

assessmentId

  • Type: typing.Optional[str]

assessmentName

  • Type: typing.Optional[str]

controlSetId

  • Type: typing.Optional[str]

controlSetName

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

eventTime

  • Type: typing.Optional[datetime.datetime]

source

  • Type: typing.Optional[str]

RegisterAccountRequest

kmsKey

  • Type: typing.Optional[str]

delegatedAdminAccount

  • Type: typing.Optional[str]

RegisterAccountResponse

status

  • Type: typing.Literal['ACTIVE', 'INACTIVE', 'PENDING_ACTIVATION']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RegisterOrganizationAdminAccountRequest

adminAccountId

  • Type:
  • Required: Yes

RegisterOrganizationAdminAccountResponse

adminAccountId

  • Type:
  • Required: Yes

organizationId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Resource

arn

  • Type: typing.Optional[str]

value

  • Type: typing.Optional[str]

complianceCheck

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

Role

roleType

  • Type: typing.Literal['PROCESS_OWNER', 'RESOURCE_OWNER']
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

Scope

awsAccounts

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AWSAccount]]

awsServices

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AWSService]]

ScopeOutput

awsAccounts

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AWSAccount]]

awsServices

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AWSService]]

ServiceMetadata

name

  • Type: typing.Optional[str]

displayName

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

category

  • Type: typing.Optional[str]

Settings

isAwsOrgEnabled

  • Type: typing.Optional[bool]

snsTopic

  • Type: typing.Optional[str]

defaultAssessmentReportsDestination

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentReportsDestination]

defaultProcessOwners

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Role]]

kmsKey

  • Type: typing.Optional[str]

evidenceFinderEnablement

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.EvidenceFinderEnablement]

deregistrationPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.DeregistrationPolicy]

defaultExportDestination

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.DefaultExportDestination]

SourceKeyword

keywordInputType

  • Type: typing.Optional[typing.Literal['INPUT_TEXT', 'SELECT_FROM_LIST', 'UPLOAD_FILE']]

keywordValue

  • Type: typing.Optional[str]

StartAssessmentFrameworkShareRequest

frameworkId

  • Type:
  • Required: Yes

destinationAccount

  • Type:
  • Required: Yes

destinationRegion

  • Type:
  • Required: Yes

comment

  • Type: typing.Optional[str]

StartAssessmentFrameworkShareResponse

assessmentFrameworkShareRequest

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

URL

hyperlinkName

  • Type: typing.Optional[str]
  • Type: typing.Optional[str]

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateAssessmentControlRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type:
  • Required: Yes

controlId

  • Type:
  • Required: Yes

controlStatus

  • Type: typing.Optional[typing.Literal['INACTIVE', 'REVIEWED', 'UNDER_REVIEW']]

commentBody

  • Type: typing.Optional[str]

UpdateAssessmentControlResponse

control

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAssessmentControlSetStatusRequest

assessmentId

  • Type:
  • Required: Yes

controlSetId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'REVIEWED', 'UNDER_REVIEW']
  • Required: Yes

comment

  • Type:
  • Required: Yes

UpdateAssessmentControlSetStatusResponse

controlSet

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAssessmentFrameworkControlSet

name

  • Type:
  • Required: Yes

controls

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.CreateAssessmentFrameworkControl]
  • Required: Yes

id

  • Type: typing.Optional[str]

UpdateAssessmentFrameworkRequest

frameworkId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

controlSets

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.UpdateAssessmentFrameworkControlSet]
  • Required: Yes

description

  • Type: typing.Optional[str]

complianceType

  • Type: typing.Optional[str]

UpdateAssessmentFrameworkResponse

framework

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAssessmentFrameworkShareRequest

requestId

  • Type:
  • Required: Yes

requestType

  • Type: typing.Literal['RECEIVED', 'SENT']
  • Required: Yes

action

  • Type: typing.Literal['ACCEPT', 'DECLINE', 'REVOKE']
  • Required: Yes

UpdateAssessmentFrameworkShareResponse

assessmentFrameworkShareRequest

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAssessmentRequest

assessmentId

  • Type:
  • Required: Yes

scope

  • Type: typing.Union[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Scope, aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ScopeOutput]
  • Required: Yes

assessmentName

  • Type: typing.Optional[str]

assessmentDescription

  • Type: typing.Optional[str]

assessmentReportsDestination

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentReportsDestination]

roles

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Role]]

UpdateAssessmentResponse

assessment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAssessmentStatusRequest

assessmentId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'INACTIVE']
  • Required: Yes

UpdateAssessmentStatusResponse

assessment

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateControlRequest

controlId

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

controlMappingSources

  • Type: typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.ControlMappingSource]
  • Required: Yes

description

  • Type: typing.Optional[str]

testingInformation

  • Type: typing.Optional[str]

actionPlanTitle

  • Type: typing.Optional[str]

actionPlanInstructions

  • Type: typing.Optional[str]

UpdateControlResponse

control

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateSettingsRequest

snsTopic

  • Type: typing.Optional[str]

defaultAssessmentReportsDestination

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.AssessmentReportsDestination]

defaultProcessOwners

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.Role]]

kmsKey

  • Type: typing.Optional[str]

evidenceFinderEnabled

  • Type: typing.Optional[bool]

deregistrationPolicy

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.DeregistrationPolicy]

defaultExportDestination

  • Type: typing.Optional[aws_resource_validator.pydantic_models.auditmanager.auditmanager_classes.DefaultExportDestination]

UpdateSettingsResponse

settings

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValidateAssessmentReportIntegrityRequest

s3RelativePath

  • Type:
  • Required: Yes

ValidateAssessmentReportIntegrityResponse

signatureValid

  • Type:
  • Required: Yes

signatureAlgorithm

  • Type:
  • Required: Yes

signatureDateTime

  • Type:
  • Required: Yes

signatureKeyId

  • Type:
  • Required: Yes

validationErrors

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes