AuditManagerClient
Index > AuditManager > AuditManagerClient
Auto-generated documentation for AuditManager type annotations stubs module mypy-boto3-auditmanager.
AuditManagerClient
Type annotations and code completion for boto3.client("auditmanager")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_auditmanager.client import AuditManagerClient
def get_auditmanager_client() -> AuditManagerClient:
return Session().client("auditmanager")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("auditmanager").exceptions
structure.
client = boto3.client("auditmanager")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_auditmanager.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
associate_assessment_report_evidence_folder
Associates an evidence folder to an assessment report in an Audit Manager assessment.
Type annotations and code completion for boto3.client("auditmanager").associate_assessment_report_evidence_folder
method.
boto3 documentation
def associate_assessment_report_evidence_folder(
self,
*,
assessmentId: str,
evidenceFolderId: str,
) -> Dict[str, Any]:
...
kwargs: AssociateAssessmentReportEvidenceFolderRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"evidenceFolderId": ...,
}
parent.associate_assessment_report_evidence_folder(**kwargs)
batch_associate_assessment_report_evidence
Associates a list of evidence to an assessment report in an Audit Manager assessment.
Type annotations and code completion for boto3.client("auditmanager").batch_associate_assessment_report_evidence
method.
boto3 documentation
def batch_associate_assessment_report_evidence(
self,
*,
assessmentId: str,
evidenceFolderId: str,
evidenceIds: Sequence[str],
) -> BatchAssociateAssessmentReportEvidenceResponseTypeDef: # (1)
...
kwargs: BatchAssociateAssessmentReportEvidenceRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"evidenceFolderId": ...,
"evidenceIds": ...,
}
parent.batch_associate_assessment_report_evidence(**kwargs)
batch_create_delegation_by_assessment
Creates a batch of delegations for an assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").batch_create_delegation_by_assessment
method.
boto3 documentation
def batch_create_delegation_by_assessment(
self,
*,
createDelegationRequests: Sequence[CreateDelegationRequestTypeDef], # (1)
assessmentId: str,
) -> BatchCreateDelegationByAssessmentResponseTypeDef: # (2)
...
kwargs: BatchCreateDelegationByAssessmentRequestRequestTypeDef = { # (1)
"createDelegationRequests": ...,
"assessmentId": ...,
}
parent.batch_create_delegation_by_assessment(**kwargs)
batch_delete_delegation_by_assessment
Deletes a batch of delegations for an assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").batch_delete_delegation_by_assessment
method.
boto3 documentation
def batch_delete_delegation_by_assessment(
self,
*,
delegationIds: Sequence[str],
assessmentId: str,
) -> BatchDeleteDelegationByAssessmentResponseTypeDef: # (1)
...
kwargs: BatchDeleteDelegationByAssessmentRequestRequestTypeDef = { # (1)
"delegationIds": ...,
"assessmentId": ...,
}
parent.batch_delete_delegation_by_assessment(**kwargs)
batch_disassociate_assessment_report_evidence
Disassociates a list of evidence from an assessment report in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").batch_disassociate_assessment_report_evidence
method.
boto3 documentation
def batch_disassociate_assessment_report_evidence(
self,
*,
assessmentId: str,
evidenceFolderId: str,
evidenceIds: Sequence[str],
) -> BatchDisassociateAssessmentReportEvidenceResponseTypeDef: # (1)
...
kwargs: BatchDisassociateAssessmentReportEvidenceRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"evidenceFolderId": ...,
"evidenceIds": ...,
}
parent.batch_disassociate_assessment_report_evidence(**kwargs)
batch_import_evidence_to_assessment_control
Uploads one or more pieces of evidence to a control in an Audit Manager assessment.
Type annotations and code completion for boto3.client("auditmanager").batch_import_evidence_to_assessment_control
method.
boto3 documentation
def batch_import_evidence_to_assessment_control(
self,
*,
assessmentId: str,
controlSetId: str,
controlId: str,
manualEvidence: Sequence[ManualEvidenceTypeDef], # (1)
) -> BatchImportEvidenceToAssessmentControlResponseTypeDef: # (2)
...
kwargs: BatchImportEvidenceToAssessmentControlRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"controlSetId": ...,
"controlId": ...,
"manualEvidence": ...,
}
parent.batch_import_evidence_to_assessment_control(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("auditmanager").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("auditmanager").close
method.
boto3 documentation
create_assessment
Creates an assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").create_assessment
method.
boto3 documentation
def create_assessment(
self,
*,
name: str,
assessmentReportsDestination: AssessmentReportsDestinationTypeDef, # (1)
scope: ScopeTypeDef, # (2)
roles: Sequence[RoleTypeDef], # (3)
frameworkId: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateAssessmentResponseTypeDef: # (4)
...
- See AssessmentReportsDestinationTypeDef
- See ScopeTypeDef
- See RoleTypeDef
- See CreateAssessmentResponseTypeDef
kwargs: CreateAssessmentRequestRequestTypeDef = { # (1)
"name": ...,
"assessmentReportsDestination": ...,
"scope": ...,
"roles": ...,
"frameworkId": ...,
}
parent.create_assessment(**kwargs)
create_assessment_framework
Creates a custom framework in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").create_assessment_framework
method.
boto3 documentation
def create_assessment_framework(
self,
*,
name: str,
controlSets: Sequence[CreateAssessmentFrameworkControlSetTypeDef], # (1)
description: str = ...,
complianceType: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateAssessmentFrameworkResponseTypeDef: # (2)
...
kwargs: CreateAssessmentFrameworkRequestRequestTypeDef = { # (1)
"name": ...,
"controlSets": ...,
}
parent.create_assessment_framework(**kwargs)
create_assessment_report
Creates an assessment report for the specified assessment.
Type annotations and code completion for boto3.client("auditmanager").create_assessment_report
method.
boto3 documentation
def create_assessment_report(
self,
*,
name: str,
assessmentId: str,
description: str = ...,
queryStatement: str = ...,
) -> CreateAssessmentReportResponseTypeDef: # (1)
...
kwargs: CreateAssessmentReportRequestRequestTypeDef = { # (1)
"name": ...,
"assessmentId": ...,
}
parent.create_assessment_report(**kwargs)
create_control
Creates a new custom control in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").create_control
method.
boto3 documentation
def create_control(
self,
*,
name: str,
controlMappingSources: Sequence[CreateControlMappingSourceTypeDef], # (1)
description: str = ...,
testingInformation: str = ...,
actionPlanTitle: str = ...,
actionPlanInstructions: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateControlResponseTypeDef: # (2)
...
kwargs: CreateControlRequestRequestTypeDef = { # (1)
"name": ...,
"controlMappingSources": ...,
}
parent.create_control(**kwargs)
delete_assessment
Deletes an assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").delete_assessment
method.
boto3 documentation
kwargs: DeleteAssessmentRequestRequestTypeDef = { # (1)
"assessmentId": ...,
}
parent.delete_assessment(**kwargs)
delete_assessment_framework
Deletes a custom framework in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").delete_assessment_framework
method.
boto3 documentation
def delete_assessment_framework(
self,
*,
frameworkId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteAssessmentFrameworkRequestRequestTypeDef = { # (1)
"frameworkId": ...,
}
parent.delete_assessment_framework(**kwargs)
delete_assessment_framework_share
Deletes a share request for a custom framework in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").delete_assessment_framework_share
method.
boto3 documentation
def delete_assessment_framework_share(
self,
*,
requestId: str,
requestType: ShareRequestTypeType, # (1)
) -> Dict[str, Any]:
...
kwargs: DeleteAssessmentFrameworkShareRequestRequestTypeDef = { # (1)
"requestId": ...,
"requestType": ...,
}
parent.delete_assessment_framework_share(**kwargs)
delete_assessment_report
Deletes an assessment report in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").delete_assessment_report
method.
boto3 documentation
def delete_assessment_report(
self,
*,
assessmentId: str,
assessmentReportId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteAssessmentReportRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"assessmentReportId": ...,
}
parent.delete_assessment_report(**kwargs)
delete_control
Deletes a custom control in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").delete_control
method.
boto3 documentation
kwargs: DeleteControlRequestRequestTypeDef = { # (1)
"controlId": ...,
}
parent.delete_control(**kwargs)
deregister_account
Deregisters an account in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").deregister_account
method.
boto3 documentation
deregister_organization_admin_account
Removes the specified Amazon Web Services account as a delegated administrator for Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").deregister_organization_admin_account
method.
boto3 documentation
def deregister_organization_admin_account(
self,
*,
adminAccountId: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeregisterOrganizationAdminAccountRequestRequestTypeDef = { # (1)
"adminAccountId": ...,
}
parent.deregister_organization_admin_account(**kwargs)
disassociate_assessment_report_evidence_folder
Disassociates an evidence folder from the specified assessment report in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").disassociate_assessment_report_evidence_folder
method.
boto3 documentation
def disassociate_assessment_report_evidence_folder(
self,
*,
assessmentId: str,
evidenceFolderId: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateAssessmentReportEvidenceFolderRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"evidenceFolderId": ...,
}
parent.disassociate_assessment_report_evidence_folder(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("auditmanager").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_account_status
Returns the registration status of an account in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_account_status
method.
boto3 documentation
get_assessment
Returns an assessment from Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_assessment
method.
boto3 documentation
def get_assessment(
self,
*,
assessmentId: str,
) -> GetAssessmentResponseTypeDef: # (1)
...
kwargs: GetAssessmentRequestRequestTypeDef = { # (1)
"assessmentId": ...,
}
parent.get_assessment(**kwargs)
get_assessment_framework
Returns a framework from Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_assessment_framework
method.
boto3 documentation
def get_assessment_framework(
self,
*,
frameworkId: str,
) -> GetAssessmentFrameworkResponseTypeDef: # (1)
...
kwargs: GetAssessmentFrameworkRequestRequestTypeDef = { # (1)
"frameworkId": ...,
}
parent.get_assessment_framework(**kwargs)
get_assessment_report_url
Returns the URL of an assessment report in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_assessment_report_url
method.
boto3 documentation
def get_assessment_report_url(
self,
*,
assessmentReportId: str,
assessmentId: str,
) -> GetAssessmentReportUrlResponseTypeDef: # (1)
...
kwargs: GetAssessmentReportUrlRequestRequestTypeDef = { # (1)
"assessmentReportId": ...,
"assessmentId": ...,
}
parent.get_assessment_report_url(**kwargs)
get_change_logs
Returns a list of changelogs from Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_change_logs
method.
boto3 documentation
def get_change_logs(
self,
*,
assessmentId: str,
controlSetId: str = ...,
controlId: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetChangeLogsResponseTypeDef: # (1)
...
kwargs: GetChangeLogsRequestRequestTypeDef = { # (1)
"assessmentId": ...,
}
parent.get_change_logs(**kwargs)
get_control
Returns a control from Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_control
method.
boto3 documentation
def get_control(
self,
*,
controlId: str,
) -> GetControlResponseTypeDef: # (1)
...
kwargs: GetControlRequestRequestTypeDef = { # (1)
"controlId": ...,
}
parent.get_control(**kwargs)
get_delegations
Returns a list of delegations from an audit owner to a delegate.
Type annotations and code completion for boto3.client("auditmanager").get_delegations
method.
boto3 documentation
def get_delegations(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> GetDelegationsResponseTypeDef: # (1)
...
kwargs: GetDelegationsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.get_delegations(**kwargs)
get_evidence
Returns evidence from Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_evidence
method.
boto3 documentation
def get_evidence(
self,
*,
assessmentId: str,
controlSetId: str,
evidenceFolderId: str,
evidenceId: str,
) -> GetEvidenceResponseTypeDef: # (1)
...
kwargs: GetEvidenceRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"controlSetId": ...,
"evidenceFolderId": ...,
"evidenceId": ...,
}
parent.get_evidence(**kwargs)
get_evidence_by_evidence_folder
Returns all evidence from a specified evidence folder in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_evidence_by_evidence_folder
method.
boto3 documentation
def get_evidence_by_evidence_folder(
self,
*,
assessmentId: str,
controlSetId: str,
evidenceFolderId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetEvidenceByEvidenceFolderResponseTypeDef: # (1)
...
kwargs: GetEvidenceByEvidenceFolderRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"controlSetId": ...,
"evidenceFolderId": ...,
}
parent.get_evidence_by_evidence_folder(**kwargs)
get_evidence_folder
Returns an evidence folder from the specified assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_evidence_folder
method.
boto3 documentation
def get_evidence_folder(
self,
*,
assessmentId: str,
controlSetId: str,
evidenceFolderId: str,
) -> GetEvidenceFolderResponseTypeDef: # (1)
...
kwargs: GetEvidenceFolderRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"controlSetId": ...,
"evidenceFolderId": ...,
}
parent.get_evidence_folder(**kwargs)
get_evidence_folders_by_assessment
Returns the evidence folders from a specified assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").get_evidence_folders_by_assessment
method.
boto3 documentation
def get_evidence_folders_by_assessment(
self,
*,
assessmentId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetEvidenceFoldersByAssessmentResponseTypeDef: # (1)
...
kwargs: GetEvidenceFoldersByAssessmentRequestRequestTypeDef = { # (1)
"assessmentId": ...,
}
parent.get_evidence_folders_by_assessment(**kwargs)
get_evidence_folders_by_assessment_control
Returns a list of evidence folders that are associated with a specified control in an Audit Manager assessment.
Type annotations and code completion for boto3.client("auditmanager").get_evidence_folders_by_assessment_control
method.
boto3 documentation
def get_evidence_folders_by_assessment_control(
self,
*,
assessmentId: str,
controlSetId: str,
controlId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetEvidenceFoldersByAssessmentControlResponseTypeDef: # (1)
...
kwargs: GetEvidenceFoldersByAssessmentControlRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"controlSetId": ...,
"controlId": ...,
}
parent.get_evidence_folders_by_assessment_control(**kwargs)
get_insights
Gets the latest analytics data for all your current active assessments.
Type annotations and code completion for boto3.client("auditmanager").get_insights
method.
boto3 documentation
get_insights_by_assessment
Gets the latest analytics data for a specific active assessment.
Type annotations and code completion for boto3.client("auditmanager").get_insights_by_assessment
method.
boto3 documentation
def get_insights_by_assessment(
self,
*,
assessmentId: str,
) -> GetInsightsByAssessmentResponseTypeDef: # (1)
...
kwargs: GetInsightsByAssessmentRequestRequestTypeDef = { # (1)
"assessmentId": ...,
}
parent.get_insights_by_assessment(**kwargs)
get_organization_admin_account
Returns the name of the delegated Amazon Web Services administrator account for the organization.
Type annotations and code completion for boto3.client("auditmanager").get_organization_admin_account
method.
boto3 documentation
def get_organization_admin_account(
self,
) -> GetOrganizationAdminAccountResponseTypeDef: # (1)
...
get_services_in_scope
Returns a list of all of the Amazon Web Services that you can choose to include in your assessment.
Type annotations and code completion for boto3.client("auditmanager").get_services_in_scope
method.
boto3 documentation
get_settings
Returns the settings for the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("auditmanager").get_settings
method.
boto3 documentation
def get_settings(
self,
*,
attribute: SettingAttributeType, # (1)
) -> GetSettingsResponseTypeDef: # (2)
...
kwargs: GetSettingsRequestRequestTypeDef = { # (1)
"attribute": ...,
}
parent.get_settings(**kwargs)
list_assessment_control_insights_by_control_domain
Lists the latest analytics data for controls within a specific control domain and a specific active assessment.
Type annotations and code completion for boto3.client("auditmanager").list_assessment_control_insights_by_control_domain
method.
boto3 documentation
def list_assessment_control_insights_by_control_domain(
self,
*,
controlDomainId: str,
assessmentId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentControlInsightsByControlDomainResponseTypeDef: # (1)
...
kwargs: ListAssessmentControlInsightsByControlDomainRequestRequestTypeDef = { # (1)
"controlDomainId": ...,
"assessmentId": ...,
}
parent.list_assessment_control_insights_by_control_domain(**kwargs)
list_assessment_framework_share_requests
Returns a list of sent or received share requests for custom frameworks in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").list_assessment_framework_share_requests
method.
boto3 documentation
def list_assessment_framework_share_requests(
self,
*,
requestType: ShareRequestTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentFrameworkShareRequestsResponseTypeDef: # (2)
...
kwargs: ListAssessmentFrameworkShareRequestsRequestRequestTypeDef = { # (1)
"requestType": ...,
}
parent.list_assessment_framework_share_requests(**kwargs)
list_assessment_frameworks
Returns a list of the frameworks that are available in the Audit Manager framework library.
Type annotations and code completion for boto3.client("auditmanager").list_assessment_frameworks
method.
boto3 documentation
def list_assessment_frameworks(
self,
*,
frameworkType: FrameworkTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentFrameworksResponseTypeDef: # (2)
...
kwargs: ListAssessmentFrameworksRequestRequestTypeDef = { # (1)
"frameworkType": ...,
}
parent.list_assessment_frameworks(**kwargs)
list_assessment_reports
Returns a list of assessment reports created in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").list_assessment_reports
method.
boto3 documentation
def list_assessment_reports(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentReportsResponseTypeDef: # (1)
...
kwargs: ListAssessmentReportsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_assessment_reports(**kwargs)
list_assessments
Returns a list of current and past assessments from Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").list_assessments
method.
boto3 documentation
def list_assessments(
self,
*,
status: AssessmentStatusType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentsResponseTypeDef: # (2)
...
kwargs: ListAssessmentsRequestRequestTypeDef = { # (1)
"status": ...,
}
parent.list_assessments(**kwargs)
list_control_domain_insights
Lists the latest analytics data for control domains across all of your active assessments.
Type annotations and code completion for boto3.client("auditmanager").list_control_domain_insights
method.
boto3 documentation
def list_control_domain_insights(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListControlDomainInsightsResponseTypeDef: # (1)
...
kwargs: ListControlDomainInsightsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_control_domain_insights(**kwargs)
list_control_domain_insights_by_assessment
Lists analytics data for control domains within a specified active assessment.
Type annotations and code completion for boto3.client("auditmanager").list_control_domain_insights_by_assessment
method.
boto3 documentation
def list_control_domain_insights_by_assessment(
self,
*,
assessmentId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListControlDomainInsightsByAssessmentResponseTypeDef: # (1)
...
kwargs: ListControlDomainInsightsByAssessmentRequestRequestTypeDef = { # (1)
"assessmentId": ...,
}
parent.list_control_domain_insights_by_assessment(**kwargs)
list_control_insights_by_control_domain
Lists the latest analytics data for controls within a specific control domain across all active assessments.
Type annotations and code completion for boto3.client("auditmanager").list_control_insights_by_control_domain
method.
boto3 documentation
def list_control_insights_by_control_domain(
self,
*,
controlDomainId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListControlInsightsByControlDomainResponseTypeDef: # (1)
...
kwargs: ListControlInsightsByControlDomainRequestRequestTypeDef = { # (1)
"controlDomainId": ...,
}
parent.list_control_insights_by_control_domain(**kwargs)
list_controls
Returns a list of controls from Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").list_controls
method.
boto3 documentation
def list_controls(
self,
*,
controlType: ControlTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListControlsResponseTypeDef: # (2)
...
kwargs: ListControlsRequestRequestTypeDef = { # (1)
"controlType": ...,
}
parent.list_controls(**kwargs)
list_keywords_for_data_source
Returns a list of keywords that are pre-mapped to the specified control data source.
Type annotations and code completion for boto3.client("auditmanager").list_keywords_for_data_source
method.
boto3 documentation
def list_keywords_for_data_source(
self,
*,
source: SourceTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListKeywordsForDataSourceResponseTypeDef: # (2)
...
kwargs: ListKeywordsForDataSourceRequestRequestTypeDef = { # (1)
"source": ...,
}
parent.list_keywords_for_data_source(**kwargs)
list_notifications
Returns a list of all Audit Manager notifications.
Type annotations and code completion for boto3.client("auditmanager").list_notifications
method.
boto3 documentation
def list_notifications(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListNotificationsResponseTypeDef: # (1)
...
kwargs: ListNotificationsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_notifications(**kwargs)
list_tags_for_resource
Returns a list of tags for the specified resource in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
register_account
Enables Audit Manager for the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("auditmanager").register_account
method.
boto3 documentation
def register_account(
self,
*,
kmsKey: str = ...,
delegatedAdminAccount: str = ...,
) -> RegisterAccountResponseTypeDef: # (1)
...
kwargs: RegisterAccountRequestRequestTypeDef = { # (1)
"kmsKey": ...,
}
parent.register_account(**kwargs)
register_organization_admin_account
Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").register_organization_admin_account
method.
boto3 documentation
def register_organization_admin_account(
self,
*,
adminAccountId: str,
) -> RegisterOrganizationAdminAccountResponseTypeDef: # (1)
...
kwargs: RegisterOrganizationAdminAccountRequestRequestTypeDef = { # (1)
"adminAccountId": ...,
}
parent.register_organization_admin_account(**kwargs)
start_assessment_framework_share
Creates a share request for a custom framework in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").start_assessment_framework_share
method.
boto3 documentation
def start_assessment_framework_share(
self,
*,
frameworkId: str,
destinationAccount: str,
destinationRegion: str,
comment: str = ...,
) -> StartAssessmentFrameworkShareResponseTypeDef: # (1)
...
kwargs: StartAssessmentFrameworkShareRequestRequestTypeDef = { # (1)
"frameworkId": ...,
"destinationAccount": ...,
"destinationRegion": ...,
}
parent.start_assessment_framework_share(**kwargs)
tag_resource
Tags the specified resource in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag from a resource in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_assessment
Edits an Audit Manager assessment.
Type annotations and code completion for boto3.client("auditmanager").update_assessment
method.
boto3 documentation
def update_assessment(
self,
*,
assessmentId: str,
scope: ScopeTypeDef, # (1)
assessmentName: str = ...,
assessmentDescription: str = ...,
assessmentReportsDestination: AssessmentReportsDestinationTypeDef = ..., # (2)
roles: Sequence[RoleTypeDef] = ..., # (3)
) -> UpdateAssessmentResponseTypeDef: # (4)
...
- See ScopeTypeDef
- See AssessmentReportsDestinationTypeDef
- See RoleTypeDef
- See UpdateAssessmentResponseTypeDef
kwargs: UpdateAssessmentRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"scope": ...,
}
parent.update_assessment(**kwargs)
update_assessment_control
Updates a control within an assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").update_assessment_control
method.
boto3 documentation
def update_assessment_control(
self,
*,
assessmentId: str,
controlSetId: str,
controlId: str,
controlStatus: ControlStatusType = ..., # (1)
commentBody: str = ...,
) -> UpdateAssessmentControlResponseTypeDef: # (2)
...
kwargs: UpdateAssessmentControlRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"controlSetId": ...,
"controlId": ...,
}
parent.update_assessment_control(**kwargs)
update_assessment_control_set_status
Updates the status of a control set in an Audit Manager assessment.
Type annotations and code completion for boto3.client("auditmanager").update_assessment_control_set_status
method.
boto3 documentation
def update_assessment_control_set_status(
self,
*,
assessmentId: str,
controlSetId: str,
status: ControlSetStatusType, # (1)
comment: str,
) -> UpdateAssessmentControlSetStatusResponseTypeDef: # (2)
...
kwargs: UpdateAssessmentControlSetStatusRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"controlSetId": ...,
"status": ...,
"comment": ...,
}
parent.update_assessment_control_set_status(**kwargs)
update_assessment_framework
Updates a custom framework in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").update_assessment_framework
method.
boto3 documentation
def update_assessment_framework(
self,
*,
frameworkId: str,
name: str,
controlSets: Sequence[UpdateAssessmentFrameworkControlSetTypeDef], # (1)
description: str = ...,
complianceType: str = ...,
) -> UpdateAssessmentFrameworkResponseTypeDef: # (2)
...
kwargs: UpdateAssessmentFrameworkRequestRequestTypeDef = { # (1)
"frameworkId": ...,
"name": ...,
"controlSets": ...,
}
parent.update_assessment_framework(**kwargs)
update_assessment_framework_share
Updates a share request for a custom framework in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").update_assessment_framework_share
method.
boto3 documentation
def update_assessment_framework_share(
self,
*,
requestId: str,
requestType: ShareRequestTypeType, # (1)
action: ShareRequestActionType, # (2)
) -> UpdateAssessmentFrameworkShareResponseTypeDef: # (3)
...
- See ShareRequestTypeType
- See ShareRequestActionType
- See UpdateAssessmentFrameworkShareResponseTypeDef
kwargs: UpdateAssessmentFrameworkShareRequestRequestTypeDef = { # (1)
"requestId": ...,
"requestType": ...,
"action": ...,
}
parent.update_assessment_framework_share(**kwargs)
update_assessment_status
Updates the status of an assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").update_assessment_status
method.
boto3 documentation
def update_assessment_status(
self,
*,
assessmentId: str,
status: AssessmentStatusType, # (1)
) -> UpdateAssessmentStatusResponseTypeDef: # (2)
...
kwargs: UpdateAssessmentStatusRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"status": ...,
}
parent.update_assessment_status(**kwargs)
update_control
Updates a custom control in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").update_control
method.
boto3 documentation
def update_control(
self,
*,
controlId: str,
name: str,
controlMappingSources: Sequence[ControlMappingSourceTypeDef], # (1)
description: str = ...,
testingInformation: str = ...,
actionPlanTitle: str = ...,
actionPlanInstructions: str = ...,
) -> UpdateControlResponseTypeDef: # (2)
...
kwargs: UpdateControlRequestRequestTypeDef = { # (1)
"controlId": ...,
"name": ...,
"controlMappingSources": ...,
}
parent.update_control(**kwargs)
update_settings
Updates Audit Manager settings for the current account.
Type annotations and code completion for boto3.client("auditmanager").update_settings
method.
boto3 documentation
def update_settings(
self,
*,
snsTopic: str = ...,
defaultAssessmentReportsDestination: AssessmentReportsDestinationTypeDef = ..., # (1)
defaultProcessOwners: Sequence[RoleTypeDef] = ..., # (2)
kmsKey: str = ...,
evidenceFinderEnabled: bool = ...,
deregistrationPolicy: DeregistrationPolicyTypeDef = ..., # (3)
) -> UpdateSettingsResponseTypeDef: # (4)
...
- See AssessmentReportsDestinationTypeDef
- See RoleTypeDef
- See DeregistrationPolicyTypeDef
- See UpdateSettingsResponseTypeDef
kwargs: UpdateSettingsRequestRequestTypeDef = { # (1)
"snsTopic": ...,
}
parent.update_settings(**kwargs)
validate_assessment_report_integrity
Validates the integrity of an assessment report in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").validate_assessment_report_integrity
method.
boto3 documentation
def validate_assessment_report_integrity(
self,
*,
s3RelativePath: str,
) -> ValidateAssessmentReportIntegrityResponseTypeDef: # (1)
...