AuditManagerClient

Index > AuditManager > AuditManagerClient

Auto-generated documentation for AuditManager type annotations stubs module types-boto3-auditmanager.

AuditManagerClient

Type annotations and code completion for boto3.client("auditmanager"). boto3 documentation

# AuditManagerClient usage example

from boto3.session import Session
from types_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 types_boto3_auditmanager.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

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:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("auditmanager").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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: AssociateAssessmentReportEvidenceFolderRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
}

parent.associate_assessment_report_evidence_folder(**kwargs)

1. See AssociateAssessmentReportEvidenceFolderRequestTypeDef

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)
    ...

1. See BatchAssociateAssessmentReportEvidenceResponseTypeDef

# batch_associate_assessment_report_evidence method usage example with argument unpacking

kwargs: BatchAssociateAssessmentReportEvidenceRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
    "evidenceIds": ...,
}

parent.batch_associate_assessment_report_evidence(**kwargs)

1. See BatchAssociateAssessmentReportEvidenceRequestTypeDef

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)
    ...

1. See Sequence[CreateDelegationRequestTypeDef]
2. See BatchCreateDelegationByAssessmentResponseTypeDef

# batch_create_delegation_by_assessment method usage example with argument unpacking

kwargs: BatchCreateDelegationByAssessmentRequestTypeDef = {  # (1)
    "createDelegationRequests": ...,
    "assessmentId": ...,
}

parent.batch_create_delegation_by_assessment(**kwargs)

1. See BatchCreateDelegationByAssessmentRequestTypeDef

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)
    ...

1. See BatchDeleteDelegationByAssessmentResponseTypeDef

# batch_delete_delegation_by_assessment method usage example with argument unpacking

kwargs: BatchDeleteDelegationByAssessmentRequestTypeDef = {  # (1)
    "delegationIds": ...,
    "assessmentId": ...,
}

parent.batch_delete_delegation_by_assessment(**kwargs)

1. See BatchDeleteDelegationByAssessmentRequestTypeDef

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)
    ...

1. See BatchDisassociateAssessmentReportEvidenceResponseTypeDef

# batch_disassociate_assessment_report_evidence method usage example with argument unpacking

kwargs: BatchDisassociateAssessmentReportEvidenceRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
    "evidenceIds": ...,
}

parent.batch_disassociate_assessment_report_evidence(**kwargs)

1. See BatchDisassociateAssessmentReportEvidenceRequestTypeDef

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)
    ...

1. See Sequence[ManualEvidenceTypeDef]
2. See BatchImportEvidenceToAssessmentControlResponseTypeDef

# batch_import_evidence_to_assessment_control method usage example with argument unpacking

kwargs: BatchImportEvidenceToAssessmentControlRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "controlId": ...,
    "manualEvidence": ...,
}

parent.batch_import_evidence_to_assessment_control(**kwargs)

1. See BatchImportEvidenceToAssessmentControlRequestTypeDef

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: ScopeUnionTypeDef,  # (2)
    roles: Sequence[RoleTypeDef],  # (3)
    frameworkId: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAssessmentResponseTypeDef:  # (4)
    ...

1. See AssessmentReportsDestinationTypeDef
2. See ScopeUnionTypeDef
3. See Sequence[RoleTypeDef]
4. See CreateAssessmentResponseTypeDef

# create_assessment method usage example with argument unpacking

kwargs: CreateAssessmentRequestTypeDef = {  # (1)
    "name": ...,
    "assessmentReportsDestination": ...,
    "scope": ...,
    "roles": ...,
    "frameworkId": ...,
}

parent.create_assessment(**kwargs)

1. See CreateAssessmentRequestTypeDef

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)
    ...

1. See Sequence[CreateAssessmentFrameworkControlSetTypeDef]
2. See CreateAssessmentFrameworkResponseTypeDef

# create_assessment_framework method usage example with argument unpacking

kwargs: CreateAssessmentFrameworkRequestTypeDef = {  # (1)
    "name": ...,
    "controlSets": ...,
}

parent.create_assessment_framework(**kwargs)

1. See CreateAssessmentFrameworkRequestTypeDef

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)
    ...

1. See CreateAssessmentReportResponseTypeDef

# create_assessment_report method usage example with argument unpacking

kwargs: CreateAssessmentReportRequestTypeDef = {  # (1)
    "name": ...,
    "assessmentId": ...,
}

parent.create_assessment_report(**kwargs)

1. See CreateAssessmentReportRequestTypeDef

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)
    ...

1. See Sequence[CreateControlMappingSourceTypeDef]
2. See CreateControlResponseTypeDef

# create_control method usage example with argument unpacking

kwargs: CreateControlRequestTypeDef = {  # (1)
    "name": ...,
    "controlMappingSources": ...,
}

parent.create_control(**kwargs)

1. See CreateControlRequestTypeDef

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: DeleteAssessmentRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.delete_assessment(**kwargs)

1. See DeleteAssessmentRequestTypeDef

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

# delete_assessment_framework method definition

def delete_assessment_framework(
    self,
    *,
    frameworkId: str,
) -> Dict[str, Any]:
    ...

# delete_assessment_framework method usage example with argument unpacking

kwargs: DeleteAssessmentFrameworkRequestTypeDef = {  # (1)
    "frameworkId": ...,
}

parent.delete_assessment_framework(**kwargs)

1. See DeleteAssessmentFrameworkRequestTypeDef

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

# delete_assessment_framework_share method definition

def delete_assessment_framework_share(
    self,
    *,
    requestId: str,
    requestType: ShareRequestTypeType,  # (1)
) -> Dict[str, Any]:
    ...

1. See ShareRequestTypeType

# delete_assessment_framework_share method usage example with argument unpacking

kwargs: DeleteAssessmentFrameworkShareRequestTypeDef = {  # (1)
    "requestId": ...,
    "requestType": ...,
}

parent.delete_assessment_framework_share(**kwargs)

1. See DeleteAssessmentFrameworkShareRequestTypeDef

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

# delete_assessment_report method definition

def delete_assessment_report(
    self,
    *,
    assessmentId: str,
    assessmentReportId: str,
) -> Dict[str, Any]:
    ...

# delete_assessment_report method usage example with argument unpacking

kwargs: DeleteAssessmentReportRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "assessmentReportId": ...,
}

parent.delete_assessment_report(**kwargs)

1. See DeleteAssessmentReportRequestTypeDef

delete_control

Deletes a custom control in Audit Manager.

Type annotations and code completion for boto3.client("auditmanager").delete_control method. boto3 documentation

# delete_control method definition

def delete_control(
    self,
    *,
    controlId: str,
) -> Dict[str, Any]:
    ...

# delete_control method usage example with argument unpacking

kwargs: DeleteControlRequestTypeDef = {  # (1)
    "controlId": ...,
}

parent.delete_control(**kwargs)

1. See DeleteControlRequestTypeDef

deregister_account

Deregisters an account in Audit Manager.

Type annotations and code completion for boto3.client("auditmanager").deregister_account method. boto3 documentation

# deregister_account method definition

def deregister_account(
    self,
) -> DeregisterAccountResponseTypeDef:  # (1)
    ...

1. See DeregisterAccountResponseTypeDef

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

# deregister_organization_admin_account method definition

def deregister_organization_admin_account(
    self,
    *,
    adminAccountId: str = ...,
) -> Dict[str, Any]:
    ...

# deregister_organization_admin_account method usage example with argument unpacking

kwargs: DeregisterOrganizationAdminAccountRequestTypeDef = {  # (1)
    "adminAccountId": ...,
}

parent.deregister_organization_admin_account(**kwargs)

1. See DeregisterOrganizationAdminAccountRequestTypeDef

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

# disassociate_assessment_report_evidence_folder method definition

def disassociate_assessment_report_evidence_folder(
    self,
    *,
    assessmentId: str,
    evidenceFolderId: str,
) -> Dict[str, Any]:
    ...

# disassociate_assessment_report_evidence_folder method usage example with argument unpacking

kwargs: DisassociateAssessmentReportEvidenceFolderRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
}

parent.disassociate_assessment_report_evidence_folder(**kwargs)

1. See DisassociateAssessmentReportEvidenceFolderRequestTypeDef

get_account_status

Gets 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_account_status method definition

def get_account_status(
    self,
) -> GetAccountStatusResponseTypeDef:  # (1)
    ...

1. See GetAccountStatusResponseTypeDef

get_assessment

Gets information about a specified assessment.

Type annotations and code completion for boto3.client("auditmanager").get_assessment method. boto3 documentation

# get_assessment method definition

def get_assessment(
    self,
    *,
    assessmentId: str,
) -> GetAssessmentResponseTypeDef:  # (1)
    ...

1. See GetAssessmentResponseTypeDef

# get_assessment method usage example with argument unpacking

kwargs: GetAssessmentRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_assessment(**kwargs)

1. See GetAssessmentRequestTypeDef

get_assessment_framework

Gets information about a specified framework.

Type annotations and code completion for boto3.client("auditmanager").get_assessment_framework method. boto3 documentation

# get_assessment_framework method definition

def get_assessment_framework(
    self,
    *,
    frameworkId: str,
) -> GetAssessmentFrameworkResponseTypeDef:  # (1)
    ...

1. See GetAssessmentFrameworkResponseTypeDef

# get_assessment_framework method usage example with argument unpacking

kwargs: GetAssessmentFrameworkRequestTypeDef = {  # (1)
    "frameworkId": ...,
}

parent.get_assessment_framework(**kwargs)

1. See GetAssessmentFrameworkRequestTypeDef

get_assessment_report_url

Gets 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

# get_assessment_report_url method definition

def get_assessment_report_url(
    self,
    *,
    assessmentReportId: str,
    assessmentId: str,
) -> GetAssessmentReportUrlResponseTypeDef:  # (1)
    ...

1. See GetAssessmentReportUrlResponseTypeDef

# get_assessment_report_url method usage example with argument unpacking

kwargs: GetAssessmentReportUrlRequestTypeDef = {  # (1)
    "assessmentReportId": ...,
    "assessmentId": ...,
}

parent.get_assessment_report_url(**kwargs)

1. See GetAssessmentReportUrlRequestTypeDef

get_change_logs

Gets a list of changelogs from Audit Manager.

Type annotations and code completion for boto3.client("auditmanager").get_change_logs method. boto3 documentation

# get_change_logs method definition

def get_change_logs(
    self,
    *,
    assessmentId: str,
    controlSetId: str = ...,
    controlId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetChangeLogsResponseTypeDef:  # (1)
    ...

1. See GetChangeLogsResponseTypeDef

# get_change_logs method usage example with argument unpacking

kwargs: GetChangeLogsRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_change_logs(**kwargs)

1. See GetChangeLogsRequestTypeDef

get_control

Gets information about a specified control.

Type annotations and code completion for boto3.client("auditmanager").get_control method. boto3 documentation

# get_control method definition

def get_control(
    self,
    *,
    controlId: str,
) -> GetControlResponseTypeDef:  # (1)
    ...

1. See GetControlResponseTypeDef

# get_control method usage example with argument unpacking

kwargs: GetControlRequestTypeDef = {  # (1)
    "controlId": ...,
}

parent.get_control(**kwargs)

1. See GetControlRequestTypeDef

get_delegations

Gets 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

# get_delegations method definition

def get_delegations(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetDelegationsResponseTypeDef:  # (1)
    ...

1. See GetDelegationsResponseTypeDef

# get_delegations method usage example with argument unpacking

kwargs: GetDelegationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_delegations(**kwargs)

1. See GetDelegationsRequestTypeDef

get_evidence

Gets information about a specified evidence item.

Type annotations and code completion for boto3.client("auditmanager").get_evidence method. boto3 documentation

# get_evidence method definition

def get_evidence(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    evidenceFolderId: str,
    evidenceId: str,
) -> GetEvidenceResponseTypeDef:  # (1)
    ...

1. See GetEvidenceResponseTypeDef

# get_evidence method usage example with argument unpacking

kwargs: GetEvidenceRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "evidenceFolderId": ...,
    "evidenceId": ...,
}

parent.get_evidence(**kwargs)

1. See GetEvidenceRequestTypeDef

get_evidence_by_evidence_folder

Gets 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

# get_evidence_by_evidence_folder method definition

def get_evidence_by_evidence_folder(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    evidenceFolderId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetEvidenceByEvidenceFolderResponseTypeDef:  # (1)
    ...

1. See GetEvidenceByEvidenceFolderResponseTypeDef

# get_evidence_by_evidence_folder method usage example with argument unpacking

kwargs: GetEvidenceByEvidenceFolderRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "evidenceFolderId": ...,
}

parent.get_evidence_by_evidence_folder(**kwargs)

1. See GetEvidenceByEvidenceFolderRequestTypeDef

get_evidence_file_upload_url

Creates a presigned Amazon S3 URL that can be used to upload a file as manual evidence.

Type annotations and code completion for boto3.client("auditmanager").get_evidence_file_upload_url method. boto3 documentation

# get_evidence_file_upload_url method definition

def get_evidence_file_upload_url(
    self,
    *,
    fileName: str,
) -> GetEvidenceFileUploadUrlResponseTypeDef:  # (1)
    ...

1. See GetEvidenceFileUploadUrlResponseTypeDef

# get_evidence_file_upload_url method usage example with argument unpacking

kwargs: GetEvidenceFileUploadUrlRequestTypeDef = {  # (1)
    "fileName": ...,
}

parent.get_evidence_file_upload_url(**kwargs)

1. See GetEvidenceFileUploadUrlRequestTypeDef

get_evidence_folder

Gets an evidence folder from a specified assessment in Audit Manager.

Type annotations and code completion for boto3.client("auditmanager").get_evidence_folder method. boto3 documentation

# get_evidence_folder method definition

def get_evidence_folder(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    evidenceFolderId: str,
) -> GetEvidenceFolderResponseTypeDef:  # (1)
    ...

1. See GetEvidenceFolderResponseTypeDef

# get_evidence_folder method usage example with argument unpacking

kwargs: GetEvidenceFolderRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "evidenceFolderId": ...,
}

parent.get_evidence_folder(**kwargs)

1. See GetEvidenceFolderRequestTypeDef

get_evidence_folders_by_assessment

Gets 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

# get_evidence_folders_by_assessment method definition

def get_evidence_folders_by_assessment(
    self,
    *,
    assessmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetEvidenceFoldersByAssessmentResponseTypeDef:  # (1)
    ...

1. See GetEvidenceFoldersByAssessmentResponseTypeDef

# get_evidence_folders_by_assessment method usage example with argument unpacking

kwargs: GetEvidenceFoldersByAssessmentRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_evidence_folders_by_assessment(**kwargs)

1. See GetEvidenceFoldersByAssessmentRequestTypeDef

get_evidence_folders_by_assessment_control

Gets 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

# get_evidence_folders_by_assessment_control method definition

def get_evidence_folders_by_assessment_control(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    controlId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetEvidenceFoldersByAssessmentControlResponseTypeDef:  # (1)
    ...

1. See GetEvidenceFoldersByAssessmentControlResponseTypeDef

# get_evidence_folders_by_assessment_control method usage example with argument unpacking

kwargs: GetEvidenceFoldersByAssessmentControlRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "controlId": ...,
}

parent.get_evidence_folders_by_assessment_control(**kwargs)

1. See GetEvidenceFoldersByAssessmentControlRequestTypeDef

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 method definition

def get_insights(
    self,
) -> GetInsightsResponseTypeDef:  # (1)
    ...

1. See GetInsightsResponseTypeDef

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

# get_insights_by_assessment method definition

def get_insights_by_assessment(
    self,
    *,
    assessmentId: str,
) -> GetInsightsByAssessmentResponseTypeDef:  # (1)
    ...

1. See GetInsightsByAssessmentResponseTypeDef

# get_insights_by_assessment method usage example with argument unpacking

kwargs: GetInsightsByAssessmentRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_insights_by_assessment(**kwargs)

1. See GetInsightsByAssessmentRequestTypeDef

get_organization_admin_account

Gets the name of the delegated Amazon Web Services administrator account for a specified organization.

Type annotations and code completion for boto3.client("auditmanager").get_organization_admin_account method. boto3 documentation

# get_organization_admin_account method definition

def get_organization_admin_account(
    self,
) -> GetOrganizationAdminAccountResponseTypeDef:  # (1)
    ...

1. See GetOrganizationAdminAccountResponseTypeDef

get_services_in_scope

Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.

Type annotations and code completion for boto3.client("auditmanager").get_services_in_scope method. boto3 documentation

# get_services_in_scope method definition

def get_services_in_scope(
    self,
) -> GetServicesInScopeResponseTypeDef:  # (1)
    ...

1. See GetServicesInScopeResponseTypeDef

get_settings

Gets the settings for a specified Amazon Web Services account.

Type annotations and code completion for boto3.client("auditmanager").get_settings method. boto3 documentation

# get_settings method definition

def get_settings(
    self,
    *,
    attribute: SettingAttributeType,  # (1)
) -> GetSettingsResponseTypeDef:  # (2)
    ...

1. See SettingAttributeType
2. See GetSettingsResponseTypeDef

# get_settings method usage example with argument unpacking

kwargs: GetSettingsRequestTypeDef = {  # (1)
    "attribute": ...,
}

parent.get_settings(**kwargs)

1. See GetSettingsRequestTypeDef

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

# list_assessment_control_insights_by_control_domain method definition

def list_assessment_control_insights_by_control_domain(
    self,
    *,
    controlDomainId: str,
    assessmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentControlInsightsByControlDomainResponseTypeDef:  # (1)
    ...

1. See ListAssessmentControlInsightsByControlDomainResponseTypeDef

# list_assessment_control_insights_by_control_domain method usage example with argument unpacking

kwargs: ListAssessmentControlInsightsByControlDomainRequestTypeDef = {  # (1)
    "controlDomainId": ...,
    "assessmentId": ...,
}

parent.list_assessment_control_insights_by_control_domain(**kwargs)

1. See ListAssessmentControlInsightsByControlDomainRequestTypeDef

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

# list_assessment_framework_share_requests method definition

def list_assessment_framework_share_requests(
    self,
    *,
    requestType: ShareRequestTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentFrameworkShareRequestsResponseTypeDef:  # (2)
    ...

1. See ShareRequestTypeType
2. See ListAssessmentFrameworkShareRequestsResponseTypeDef

# list_assessment_framework_share_requests method usage example with argument unpacking

kwargs: ListAssessmentFrameworkShareRequestsRequestTypeDef = {  # (1)
    "requestType": ...,
}

parent.list_assessment_framework_share_requests(**kwargs)

1. See ListAssessmentFrameworkShareRequestsRequestTypeDef

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

# list_assessment_frameworks method definition

def list_assessment_frameworks(
    self,
    *,
    frameworkType: FrameworkTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentFrameworksResponseTypeDef:  # (2)
    ...

1. See FrameworkTypeType
2. See ListAssessmentFrameworksResponseTypeDef

# list_assessment_frameworks method usage example with argument unpacking

kwargs: ListAssessmentFrameworksRequestTypeDef = {  # (1)
    "frameworkType": ...,
}

parent.list_assessment_frameworks(**kwargs)

1. See ListAssessmentFrameworksRequestTypeDef

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

# list_assessment_reports method definition

def list_assessment_reports(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentReportsResponseTypeDef:  # (1)
    ...

1. See ListAssessmentReportsResponseTypeDef

# list_assessment_reports method usage example with argument unpacking

kwargs: ListAssessmentReportsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_assessment_reports(**kwargs)

1. See ListAssessmentReportsRequestTypeDef

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

# list_assessments method definition

def list_assessments(
    self,
    *,
    status: AssessmentStatusType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentsResponseTypeDef:  # (2)
    ...

1. See AssessmentStatusType
2. See ListAssessmentsResponseTypeDef

# list_assessments method usage example with argument unpacking

kwargs: ListAssessmentsRequestTypeDef = {  # (1)
    "status": ...,
}

parent.list_assessments(**kwargs)

1. See ListAssessmentsRequestTypeDef

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

# list_control_domain_insights method definition

def list_control_domain_insights(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListControlDomainInsightsResponseTypeDef:  # (1)
    ...

1. See ListControlDomainInsightsResponseTypeDef

# list_control_domain_insights method usage example with argument unpacking

kwargs: ListControlDomainInsightsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_control_domain_insights(**kwargs)

1. See ListControlDomainInsightsRequestTypeDef

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

# list_control_domain_insights_by_assessment method definition

def list_control_domain_insights_by_assessment(
    self,
    *,
    assessmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListControlDomainInsightsByAssessmentResponseTypeDef:  # (1)
    ...

1. See ListControlDomainInsightsByAssessmentResponseTypeDef

# list_control_domain_insights_by_assessment method usage example with argument unpacking

kwargs: ListControlDomainInsightsByAssessmentRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.list_control_domain_insights_by_assessment(**kwargs)

1. See ListControlDomainInsightsByAssessmentRequestTypeDef

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

# list_control_insights_by_control_domain method definition

def list_control_insights_by_control_domain(
    self,
    *,
    controlDomainId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListControlInsightsByControlDomainResponseTypeDef:  # (1)
    ...

1. See ListControlInsightsByControlDomainResponseTypeDef

# list_control_insights_by_control_domain method usage example with argument unpacking

kwargs: ListControlInsightsByControlDomainRequestTypeDef = {  # (1)
    "controlDomainId": ...,
}

parent.list_control_insights_by_control_domain(**kwargs)

1. See ListControlInsightsByControlDomainRequestTypeDef

list_controls

Returns a list of controls from Audit Manager.

Type annotations and code completion for boto3.client("auditmanager").list_controls method. boto3 documentation

# list_controls method definition

def list_controls(
    self,
    *,
    controlType: ControlTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    controlCatalogId: str = ...,
) -> ListControlsResponseTypeDef:  # (2)
    ...

1. See ControlTypeType
2. See ListControlsResponseTypeDef

# list_controls method usage example with argument unpacking

kwargs: ListControlsRequestTypeDef = {  # (1)
    "controlType": ...,
}

parent.list_controls(**kwargs)

1. See ListControlsRequestTypeDef

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

# list_keywords_for_data_source method definition

def list_keywords_for_data_source(
    self,
    *,
    source: DataSourceTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKeywordsForDataSourceResponseTypeDef:  # (2)
    ...

1. See DataSourceTypeType
2. See ListKeywordsForDataSourceResponseTypeDef

# list_keywords_for_data_source method usage example with argument unpacking

kwargs: ListKeywordsForDataSourceRequestTypeDef = {  # (1)
    "source": ...,
}

parent.list_keywords_for_data_source(**kwargs)

1. See ListKeywordsForDataSourceRequestTypeDef

list_notifications

Returns a list of all Audit Manager notifications.

Type annotations and code completion for boto3.client("auditmanager").list_notifications method. boto3 documentation

# list_notifications method definition

def list_notifications(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListNotificationsResponseTypeDef:  # (1)
    ...

1. See ListNotificationsResponseTypeDef

# list_notifications method usage example with argument unpacking

kwargs: ListNotificationsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_notifications(**kwargs)

1. See ListNotificationsRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

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

# register_account method definition

def register_account(
    self,
    *,
    kmsKey: str = ...,
    delegatedAdminAccount: str = ...,
) -> RegisterAccountResponseTypeDef:  # (1)
    ...

1. See RegisterAccountResponseTypeDef

# register_account method usage example with argument unpacking

kwargs: RegisterAccountRequestTypeDef = {  # (1)
    "kmsKey": ...,
}

parent.register_account(**kwargs)

1. See RegisterAccountRequestTypeDef

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

# register_organization_admin_account method definition

def register_organization_admin_account(
    self,
    *,
    adminAccountId: str,
) -> RegisterOrganizationAdminAccountResponseTypeDef:  # (1)
    ...

1. See RegisterOrganizationAdminAccountResponseTypeDef

# register_organization_admin_account method usage example with argument unpacking

kwargs: RegisterOrganizationAdminAccountRequestTypeDef = {  # (1)
    "adminAccountId": ...,
}

parent.register_organization_admin_account(**kwargs)

1. See RegisterOrganizationAdminAccountRequestTypeDef

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

# start_assessment_framework_share method definition

def start_assessment_framework_share(
    self,
    *,
    frameworkId: str,
    destinationAccount: str,
    destinationRegion: str,
    comment: str = ...,
) -> StartAssessmentFrameworkShareResponseTypeDef:  # (1)
    ...

1. See StartAssessmentFrameworkShareResponseTypeDef

# start_assessment_framework_share method usage example with argument unpacking

kwargs: StartAssessmentFrameworkShareRequestTypeDef = {  # (1)
    "frameworkId": ...,
    "destinationAccount": ...,
    "destinationRegion": ...,
}

parent.start_assessment_framework_share(**kwargs)

1. See StartAssessmentFrameworkShareRequestTypeDef

tag_resource

Tags the specified resource in Audit Manager.

Type annotations and code completion for boto3.client("auditmanager").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_assessment

Edits an Audit Manager assessment.

Type annotations and code completion for boto3.client("auditmanager").update_assessment method. boto3 documentation

# update_assessment method definition

def update_assessment(
    self,
    *,
    assessmentId: str,
    scope: ScopeUnionTypeDef,  # (1)
    assessmentName: str = ...,
    assessmentDescription: str = ...,
    assessmentReportsDestination: AssessmentReportsDestinationTypeDef = ...,  # (2)
    roles: Sequence[RoleTypeDef] = ...,  # (3)
) -> UpdateAssessmentResponseTypeDef:  # (4)
    ...

1. See ScopeUnionTypeDef
2. See AssessmentReportsDestinationTypeDef
3. See Sequence[RoleTypeDef]
4. See UpdateAssessmentResponseTypeDef

# update_assessment method usage example with argument unpacking

kwargs: UpdateAssessmentRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "scope": ...,
}

parent.update_assessment(**kwargs)

1. See UpdateAssessmentRequestTypeDef

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

# update_assessment_control method definition

def update_assessment_control(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    controlId: str,
    controlStatus: ControlStatusType = ...,  # (1)
    commentBody: str = ...,
) -> UpdateAssessmentControlResponseTypeDef:  # (2)
    ...

1. See ControlStatusType
2. See UpdateAssessmentControlResponseTypeDef

# update_assessment_control method usage example with argument unpacking

kwargs: UpdateAssessmentControlRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "controlId": ...,
}

parent.update_assessment_control(**kwargs)

1. See UpdateAssessmentControlRequestTypeDef

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

# update_assessment_control_set_status method definition

def update_assessment_control_set_status(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    status: ControlSetStatusType,  # (1)
    comment: str,
) -> UpdateAssessmentControlSetStatusResponseTypeDef:  # (2)
    ...

1. See ControlSetStatusType
2. See UpdateAssessmentControlSetStatusResponseTypeDef

# update_assessment_control_set_status method usage example with argument unpacking

kwargs: UpdateAssessmentControlSetStatusRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "status": ...,
    "comment": ...,
}

parent.update_assessment_control_set_status(**kwargs)

1. See UpdateAssessmentControlSetStatusRequestTypeDef

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

# update_assessment_framework method definition

def update_assessment_framework(
    self,
    *,
    frameworkId: str,
    name: str,
    controlSets: Sequence[UpdateAssessmentFrameworkControlSetTypeDef],  # (1)
    description: str = ...,
    complianceType: str = ...,
) -> UpdateAssessmentFrameworkResponseTypeDef:  # (2)
    ...

1. See Sequence[UpdateAssessmentFrameworkControlSetTypeDef]
2. See UpdateAssessmentFrameworkResponseTypeDef

# update_assessment_framework method usage example with argument unpacking

kwargs: UpdateAssessmentFrameworkRequestTypeDef = {  # (1)
    "frameworkId": ...,
    "name": ...,
    "controlSets": ...,
}

parent.update_assessment_framework(**kwargs)

1. See UpdateAssessmentFrameworkRequestTypeDef

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

# update_assessment_framework_share method definition

def update_assessment_framework_share(
    self,
    *,
    requestId: str,
    requestType: ShareRequestTypeType,  # (1)
    action: ShareRequestActionType,  # (2)
) -> UpdateAssessmentFrameworkShareResponseTypeDef:  # (3)
    ...

1. See ShareRequestTypeType
2. See ShareRequestActionType
3. See UpdateAssessmentFrameworkShareResponseTypeDef

# update_assessment_framework_share method usage example with argument unpacking

kwargs: UpdateAssessmentFrameworkShareRequestTypeDef = {  # (1)
    "requestId": ...,
    "requestType": ...,
    "action": ...,
}

parent.update_assessment_framework_share(**kwargs)

1. See UpdateAssessmentFrameworkShareRequestTypeDef

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

# update_assessment_status method definition

def update_assessment_status(
    self,
    *,
    assessmentId: str,
    status: AssessmentStatusType,  # (1)
) -> UpdateAssessmentStatusResponseTypeDef:  # (2)
    ...

1. See AssessmentStatusType
2. See UpdateAssessmentStatusResponseTypeDef

# update_assessment_status method usage example with argument unpacking

kwargs: UpdateAssessmentStatusRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "status": ...,
}

parent.update_assessment_status(**kwargs)

1. See UpdateAssessmentStatusRequestTypeDef

update_control

Updates a custom control in Audit Manager.

Type annotations and code completion for boto3.client("auditmanager").update_control method. boto3 documentation

# update_control method definition

def update_control(
    self,
    *,
    controlId: str,
    name: str,
    controlMappingSources: Sequence[ControlMappingSourceTypeDef],  # (1)
    description: str = ...,
    testingInformation: str = ...,
    actionPlanTitle: str = ...,
    actionPlanInstructions: str = ...,
) -> UpdateControlResponseTypeDef:  # (2)
    ...

1. See Sequence[ControlMappingSourceTypeDef]
2. See UpdateControlResponseTypeDef

# update_control method usage example with argument unpacking

kwargs: UpdateControlRequestTypeDef = {  # (1)
    "controlId": ...,
    "name": ...,
    "controlMappingSources": ...,
}

parent.update_control(**kwargs)

1. See UpdateControlRequestTypeDef

update_settings

Updates Audit Manager settings for the current account.

Type annotations and code completion for boto3.client("auditmanager").update_settings method. boto3 documentation

# update_settings method definition

def update_settings(
    self,
    *,
    snsTopic: str = ...,
    defaultAssessmentReportsDestination: AssessmentReportsDestinationTypeDef = ...,  # (1)
    defaultProcessOwners: Sequence[RoleTypeDef] = ...,  # (2)
    kmsKey: str = ...,
    evidenceFinderEnabled: bool = ...,
    deregistrationPolicy: DeregistrationPolicyTypeDef = ...,  # (3)
    defaultExportDestination: DefaultExportDestinationTypeDef = ...,  # (4)
) -> UpdateSettingsResponseTypeDef:  # (5)
    ...

1. See AssessmentReportsDestinationTypeDef
2. See Sequence[RoleTypeDef]
3. See DeregistrationPolicyTypeDef
4. See DefaultExportDestinationTypeDef
5. See UpdateSettingsResponseTypeDef

# update_settings method usage example with argument unpacking

kwargs: UpdateSettingsRequestTypeDef = {  # (1)
    "snsTopic": ...,
}

parent.update_settings(**kwargs)

1. See UpdateSettingsRequestTypeDef

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

# validate_assessment_report_integrity method definition

def validate_assessment_report_integrity(
    self,
    *,
    s3RelativePath: str,
) -> ValidateAssessmentReportIntegrityResponseTypeDef:  # (1)
    ...

1. See ValidateAssessmentReportIntegrityResponseTypeDef

# validate_assessment_report_integrity method usage example with argument unpacking

kwargs: ValidateAssessmentReportIntegrityRequestTypeDef = {  # (1)
    "s3RelativePath": ...,
}

parent.validate_assessment_report_integrity(**kwargs)

1. See ValidateAssessmentReportIntegrityRequestTypeDef