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
# AuditManagerClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("auditmanager")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
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
# associate_assessment_report_evidence_folder method definition
def associate_assessment_report_evidence_folder(
self,
*,
assessmentId: str,
evidenceFolderId: str,
) -> Dict[str, Any]:
...
# associate_assessment_report_evidence_folder method usage example with argument unpacking
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
# batch_associate_assessment_report_evidence method definition
def batch_associate_assessment_report_evidence(
self,
*,
assessmentId: str,
evidenceFolderId: str,
evidenceIds: Sequence[str],
) -> BatchAssociateAssessmentReportEvidenceResponseTypeDef: # (1)
...
# batch_associate_assessment_report_evidence method usage example with argument unpacking
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
# batch_create_delegation_by_assessment method definition
def batch_create_delegation_by_assessment(
self,
*,
createDelegationRequests: Sequence[CreateDelegationRequestTypeDef], # (1)
assessmentId: str,
) -> BatchCreateDelegationByAssessmentResponseTypeDef: # (2)
...
# batch_create_delegation_by_assessment method usage example with argument unpacking
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
# batch_delete_delegation_by_assessment method definition
def batch_delete_delegation_by_assessment(
self,
*,
delegationIds: Sequence[str],
assessmentId: str,
) -> BatchDeleteDelegationByAssessmentResponseTypeDef: # (1)
...
# batch_delete_delegation_by_assessment method usage example with argument unpacking
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
# batch_disassociate_assessment_report_evidence method definition
def batch_disassociate_assessment_report_evidence(
self,
*,
assessmentId: str,
evidenceFolderId: str,
evidenceIds: Sequence[str],
) -> BatchDisassociateAssessmentReportEvidenceResponseTypeDef: # (1)
...
# batch_disassociate_assessment_report_evidence method usage example with argument unpacking
kwargs: BatchDisassociateAssessmentReportEvidenceRequestRequestTypeDef = { # (1)
"assessmentId": ...,
"evidenceFolderId": ...,
"evidenceIds": ...,
}
parent.batch_disassociate_assessment_report_evidence(**kwargs)
batch_import_evidence_to_assessment_control#
Adds 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
# batch_import_evidence_to_assessment_control method definition
def batch_import_evidence_to_assessment_control(
self,
*,
assessmentId: str,
controlSetId: str,
controlId: str,
manualEvidence: Sequence[ManualEvidenceTypeDef], # (1)
) -> BatchImportEvidenceToAssessmentControlResponseTypeDef: # (2)
...
# batch_import_evidence_to_assessment_control method usage example with argument unpacking
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("auditmanager").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_assessment#
Creates an assessment in Audit Manager.
Type annotations and code completion for boto3.client("auditmanager").create_assessment
method.
boto3 documentation
# create_assessment method definition
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
# create_assessment method usage example with argument unpacking
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
# create_assessment_framework method definition
def create_assessment_framework(
self,
*,
name: str,
controlSets: Sequence[CreateAssessmentFrameworkControlSetTypeDef], # (1)
description: str = ...,
complianceType: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateAssessmentFrameworkResponseTypeDef: # (2)
...
# create_assessment_framework method usage example with argument unpacking
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
# create_assessment_report method definition
def create_assessment_report(
self,
*,
name: str,
assessmentId: str,
description: str = ...,
queryStatement: str = ...,
) -> CreateAssessmentReportResponseTypeDef: # (1)
...
# create_assessment_report method usage example with argument unpacking
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
# create_control method definition
def create_control(
self,
*,
name: str,
controlMappingSources: Sequence[CreateControlMappingSourceTypeDef], # (1)
description: str = ...,
testingInformation: str = ...,
actionPlanTitle: str = ...,
actionPlanInstructions: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateControlResponseTypeDef: # (2)
...
# create_control method usage example with argument unpacking
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
# delete_assessment method definition
def delete_assessment(
self,
*,
assessmentId: str,
) -> Dict[str, Any]:
...
# delete_assessment method usage example with argument unpacking
kwargs: DeleteAssessmentRequestRequestTypeDef = { # (1)
"assessmentId": ...,
}
parent.delete_asses