Skip to content

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

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.

Usage example
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)
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 a Audit Manager assessment.

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

Method definition
def associate_assessment_report_evidence_folder(
    self,
    *,
    assessmentId: str,
    evidenceFolderId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateAssessmentReportEvidenceFolderRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
}

parent.associate_assessment_report_evidence_folder(**kwargs)
  1. See AssociateAssessmentReportEvidenceFolderRequestRequestTypeDef

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

Method definition
def batch_associate_assessment_report_evidence(
    self,
    *,
    assessmentId: str,
    evidenceFolderId: str,
    evidenceIds: Sequence[str],
) -> BatchAssociateAssessmentReportEvidenceResponseTypeDef:  # (1)
    ...
  1. See BatchAssociateAssessmentReportEvidenceResponseTypeDef
Usage example with kwargs
kwargs: BatchAssociateAssessmentReportEvidenceRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
    "evidenceIds": ...,
}

parent.batch_associate_assessment_report_evidence(**kwargs)
  1. See BatchAssociateAssessmentReportEvidenceRequestRequestTypeDef

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

Method definition
def batch_create_delegation_by_assessment(
    self,
    *,
    createDelegationRequests: Sequence[CreateDelegationRequestTypeDef],  # (1)
    assessmentId: str,
) -> BatchCreateDelegationByAssessmentResponseTypeDef:  # (2)
    ...
  1. See CreateDelegationRequestTypeDef
  2. See BatchCreateDelegationByAssessmentResponseTypeDef
Usage example with kwargs
kwargs: BatchCreateDelegationByAssessmentRequestRequestTypeDef = {  # (1)
    "createDelegationRequests": ...,
    "assessmentId": ...,
}

parent.batch_create_delegation_by_assessment(**kwargs)
  1. See BatchCreateDelegationByAssessmentRequestRequestTypeDef

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

Method definition
def batch_delete_delegation_by_assessment(
    self,
    *,
    delegationIds: Sequence[str],
    assessmentId: str,
) -> BatchDeleteDelegationByAssessmentResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteDelegationByAssessmentResponseTypeDef
Usage example with kwargs
kwargs: BatchDeleteDelegationByAssessmentRequestRequestTypeDef = {  # (1)
    "delegationIds": ...,
    "assessmentId": ...,
}

parent.batch_delete_delegation_by_assessment(**kwargs)
  1. See BatchDeleteDelegationByAssessmentRequestRequestTypeDef

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

Method definition
def batch_disassociate_assessment_report_evidence(
    self,
    *,
    assessmentId: str,
    evidenceFolderId: str,
    evidenceIds: Sequence[str],
) -> BatchDisassociateAssessmentReportEvidenceResponseTypeDef:  # (1)
    ...
  1. See BatchDisassociateAssessmentReportEvidenceResponseTypeDef
Usage example with kwargs
kwargs: BatchDisassociateAssessmentReportEvidenceRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
    "evidenceIds": ...,
}

parent.batch_disassociate_assessment_report_evidence(**kwargs)
  1. See BatchDisassociateAssessmentReportEvidenceRequestRequestTypeDef

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

Method definition
def batch_import_evidence_to_assessment_control(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    controlId: str,
    manualEvidence: Sequence[ManualEvidenceTypeDef],  # (1)
) -> BatchImportEvidenceToAssessmentControlResponseTypeDef:  # (2)
    ...
  1. See ManualEvidenceTypeDef
  2. See BatchImportEvidenceToAssessmentControlResponseTypeDef
Usage example with kwargs
kwargs: BatchImportEvidenceToAssessmentControlRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "controlId": ...,
    "manualEvidence": ...,
}

parent.batch_import_evidence_to_assessment_control(**kwargs)
  1. See BatchImportEvidenceToAssessmentControlRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

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

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

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)
    ...
  1. See AssessmentReportsDestinationTypeDef
  2. See ScopeTypeDef
  3. See RoleTypeDef
  4. See CreateAssessmentResponseTypeDef
Usage example with kwargs
kwargs: CreateAssessmentRequestRequestTypeDef = {  # (1)
    "name": ...,
    "assessmentReportsDestination": ...,
    "scope": ...,
    "roles": ...,
    "frameworkId": ...,
}

parent.create_assessment(**kwargs)
  1. See CreateAssessmentRequestRequestTypeDef

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

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 CreateAssessmentFrameworkControlSetTypeDef
  2. See CreateAssessmentFrameworkResponseTypeDef
Usage example with kwargs
kwargs: CreateAssessmentFrameworkRequestRequestTypeDef = {  # (1)
    "name": ...,
    "controlSets": ...,
}

parent.create_assessment_framework(**kwargs)
  1. See CreateAssessmentFrameworkRequestRequestTypeDef

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

Method definition
def create_assessment_report(
    self,
    *,
    name: str,
    assessmentId: str,
    description: str = ...,
) -> CreateAssessmentReportResponseTypeDef:  # (1)
    ...
  1. See CreateAssessmentReportResponseTypeDef
Usage example with kwargs
kwargs: CreateAssessmentReportRequestRequestTypeDef = {  # (1)
    "name": ...,
    "assessmentId": ...,
}

parent.create_assessment_report(**kwargs)
  1. See CreateAssessmentReportRequestRequestTypeDef

create_control

Creates a new custom control in Audit Manager.

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

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 CreateControlMappingSourceTypeDef
  2. See CreateControlResponseTypeDef
Usage example with kwargs
kwargs: CreateControlRequestRequestTypeDef = {  # (1)
    "name": ...,
    "controlMappingSources": ...,
}

parent.create_control(**kwargs)
  1. See CreateControlRequestRequestTypeDef

delete_assessment

Deletes an assessment in Audit Manager.

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

Method definition
def delete_assessment(
    self,
    *,
    assessmentId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.delete_assessment(**kwargs)
  1. See DeleteAssessmentRequestRequestTypeDef

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

Method definition
def delete_assessment_framework(
    self,
    *,
    frameworkId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAssessmentFrameworkRequestRequestTypeDef = {  # (1)
    "frameworkId": ...,
}

parent.delete_assessment_framework(**kwargs)
  1. See DeleteAssessmentFrameworkRequestRequestTypeDef

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

Method definition
def delete_assessment_framework_share(
    self,
    *,
    requestId: str,
    requestType: ShareRequestTypeType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ShareRequestTypeType
Usage example with kwargs
kwargs: DeleteAssessmentFrameworkShareRequestRequestTypeDef = {  # (1)
    "requestId": ...,
    "requestType": ...,
}

parent.delete_assessment_framework_share(**kwargs)
  1. See DeleteAssessmentFrameworkShareRequestRequestTypeDef

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

Method definition
def delete_assessment_report(
    self,
    *,
    assessmentId: str,
    assessmentReportId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAssessmentReportRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "assessmentReportId": ...,
}

parent.delete_assessment_report(**kwargs)
  1. See DeleteAssessmentReportRequestRequestTypeDef

delete_control

Deletes a custom control in Audit Manager.

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

Method definition
def delete_control(
    self,
    *,
    controlId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteControlRequestRequestTypeDef = {  # (1)
    "controlId": ...,
}

parent.delete_control(**kwargs)
  1. See DeleteControlRequestRequestTypeDef

deregister_account

Deregisters an account in Audit Manager.

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

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

Method definition
def deregister_organization_admin_account(
    self,
    *,
    adminAccountId: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeregisterOrganizationAdminAccountRequestRequestTypeDef = {  # (1)
    "adminAccountId": ...,
}

parent.deregister_organization_admin_account(**kwargs)
  1. See DeregisterOrganizationAdminAccountRequestRequestTypeDef

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

Method definition
def disassociate_assessment_report_evidence_folder(
    self,
    *,
    assessmentId: str,
    evidenceFolderId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateAssessmentReportEvidenceFolderRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "evidenceFolderId": ...,
}

parent.disassociate_assessment_report_evidence_folder(**kwargs)
  1. See DisassociateAssessmentReportEvidenceFolderRequestRequestTypeDef

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

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

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

get_assessment

Returns an assessment from Audit Manager.

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

Method definition
def get_assessment(
    self,
    *,
    assessmentId: str,
) -> GetAssessmentResponseTypeDef:  # (1)
    ...
  1. See GetAssessmentResponseTypeDef
Usage example with kwargs
kwargs: GetAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_assessment(**kwargs)
  1. See GetAssessmentRequestRequestTypeDef

get_assessment_framework

Returns a framework from Audit Manager.

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

Method definition
def get_assessment_framework(
    self,
    *,
    frameworkId: str,
) -> GetAssessmentFrameworkResponseTypeDef:  # (1)
    ...
  1. See GetAssessmentFrameworkResponseTypeDef
Usage example with kwargs
kwargs: GetAssessmentFrameworkRequestRequestTypeDef = {  # (1)
    "frameworkId": ...,
}

parent.get_assessment_framework(**kwargs)
  1. See GetAssessmentFrameworkRequestRequestTypeDef

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

Method definition
def get_assessment_report_url(
    self,
    *,
    assessmentReportId: str,
    assessmentId: str,
) -> GetAssessmentReportUrlResponseTypeDef:  # (1)
    ...
  1. See GetAssessmentReportUrlResponseTypeDef
Usage example with kwargs
kwargs: GetAssessmentReportUrlRequestRequestTypeDef = {  # (1)
    "assessmentReportId": ...,
    "assessmentId": ...,
}

parent.get_assessment_report_url(**kwargs)
  1. See GetAssessmentReportUrlRequestRequestTypeDef

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

Method definition
def get_change_logs(
    self,
    *,
    assessmentId: str,
    controlSetId: str = ...,
    controlId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetChangeLogsResponseTypeDef:  # (1)
    ...
  1. See GetChangeLogsResponseTypeDef
Usage example with kwargs
kwargs: GetChangeLogsRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_change_logs(**kwargs)
  1. See GetChangeLogsRequestRequestTypeDef

get_control

Returns a control from Audit Manager.

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

Method definition
def get_control(
    self,
    *,
    controlId: str,
) -> GetControlResponseTypeDef:  # (1)
    ...
  1. See GetControlResponseTypeDef
Usage example with kwargs
kwargs: GetControlRequestRequestTypeDef = {  # (1)
    "controlId": ...,
}

parent.get_control(**kwargs)
  1. See GetControlRequestRequestTypeDef

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

Method definition
def get_delegations(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetDelegationsResponseTypeDef:  # (1)
    ...
  1. See GetDelegationsResponseTypeDef
Usage example with kwargs
kwargs: GetDelegationsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.get_delegations(**kwargs)
  1. See GetDelegationsRequestRequestTypeDef

get_evidence

Returns evidence from Audit Manager.

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

Method definition
def get_evidence(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    evidenceFolderId: str,
    evidenceId: str,
) -> GetEvidenceResponseTypeDef:  # (1)
    ...
  1. See GetEvidenceResponseTypeDef
Usage example with kwargs
kwargs: GetEvidenceRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "evidenceFolderId": ...,
    "evidenceId": ...,
}

parent.get_evidence(**kwargs)
  1. See GetEvidenceRequestRequestTypeDef

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

Method definition
def get_evidence_by_evidence_folder(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    evidenceFolderId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetEvidenceByEvidenceFolderResponseTypeDef:  # (1)
    ...
  1. See GetEvidenceByEvidenceFolderResponseTypeDef
Usage example with kwargs
kwargs: GetEvidenceByEvidenceFolderRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "evidenceFolderId": ...,
}

parent.get_evidence_by_evidence_folder(**kwargs)
  1. See GetEvidenceByEvidenceFolderRequestRequestTypeDef

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

Method definition
def get_evidence_folder(
    self,
    *,
    assessmentId: str,
    controlSetId: str,
    evidenceFolderId: str,
) -> GetEvidenceFolderResponseTypeDef:  # (1)
    ...
  1. See GetEvidenceFolderResponseTypeDef
Usage example with kwargs
kwargs: GetEvidenceFolderRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "evidenceFolderId": ...,
}

parent.get_evidence_folder(**kwargs)
  1. See GetEvidenceFolderRequestRequestTypeDef

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

Method definition
def get_evidence_folders_by_assessment(
    self,
    *,
    assessmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetEvidenceFoldersByAssessmentResponseTypeDef:  # (1)
    ...
  1. See GetEvidenceFoldersByAssessmentResponseTypeDef
Usage example with kwargs
kwargs: GetEvidenceFoldersByAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_evidence_folders_by_assessment(**kwargs)
  1. See GetEvidenceFoldersByAssessmentRequestRequestTypeDef

get_evidence_folders_by_assessment_control

Returns a list of evidence folders that are associated with a specified control of an assessment in Audit Manager.

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

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
Usage example with kwargs
kwargs: GetEvidenceFoldersByAssessmentControlRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
    "controlSetId": ...,
    "controlId": ...,
}

parent.get_evidence_folders_by_assessment_control(**kwargs)
  1. See GetEvidenceFoldersByAssessmentControlRequestRequestTypeDef

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

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

Method definition
def get_insights_by_assessment(
    self,
    *,
    assessmentId: str,
) -> GetInsightsByAssessmentResponseTypeDef:  # (1)
    ...
  1. See GetInsightsByAssessmentResponseTypeDef
Usage example with kwargs
kwargs: GetInsightsByAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.get_insights_by_assessment(**kwargs)
  1. See GetInsightsByAssessmentRequestRequestTypeDef

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

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

get_services_in_scope

Returns a list of the in-scope Amazon Web Services for the specified assessment.

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

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

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

Method definition
def get_settings(
    self,
    *,
    attribute: SettingAttributeType,  # (1)
) -> GetSettingsResponseTypeDef:  # (2)
    ...
  1. See SettingAttributeType
  2. See GetSettingsResponseTypeDef
Usage example with kwargs
kwargs: GetSettingsRequestRequestTypeDef = {  # (1)
    "attribute": ...,
}

parent.get_settings(**kwargs)
  1. See GetSettingsRequestRequestTypeDef

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

Method definition
def list_assessment_control_insights_by_control_domain(
    self,
    *,
    controlDomainId: str,
    assessmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentControlInsightsByControlDomainResponseTypeDef:  # (1)
    ...
  1. See ListAssessmentControlInsightsByControlDomainResponseTypeDef
Usage example with kwargs
kwargs: ListAssessmentControlInsightsByControlDomainRequestRequestTypeDef = {  # (1)
    "controlDomainId": ...,
    "assessmentId": ...,
}

parent.list_assessment_control_insights_by_control_domain(**kwargs)
  1. See ListAssessmentControlInsightsByControlDomainRequestRequestTypeDef

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

Method definition
def list_assessment_framework_share_requests(
    self,
    *,
    requestType: ShareRequestTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentFrameworkShareRequestsResponseTypeDef:  # (2)
    ...
  1. See ShareRequestTypeType
  2. See ListAssessmentFrameworkShareRequestsResponseTypeDef
Usage example with kwargs
kwargs: ListAssessmentFrameworkShareRequestsRequestRequestTypeDef = {  # (1)
    "requestType": ...,
}

parent.list_assessment_framework_share_requests(**kwargs)
  1. See ListAssessmentFrameworkShareRequestsRequestRequestTypeDef

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

Method definition
def list_assessment_frameworks(
    self,
    *,
    frameworkType: FrameworkTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentFrameworksResponseTypeDef:  # (2)
    ...
  1. See FrameworkTypeType
  2. See ListAssessmentFrameworksResponseTypeDef
Usage example with kwargs
kwargs: ListAssessmentFrameworksRequestRequestTypeDef = {  # (1)
    "frameworkType": ...,
}

parent.list_assessment_frameworks(**kwargs)
  1. See ListAssessmentFrameworksRequestRequestTypeDef

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

Method definition
def list_assessment_reports(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentReportsResponseTypeDef:  # (1)
    ...
  1. See ListAssessmentReportsResponseTypeDef
Usage example with kwargs
kwargs: ListAssessmentReportsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_assessment_reports(**kwargs)
  1. See ListAssessmentReportsRequestRequestTypeDef

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

Method definition
def list_assessments(
    self,
    *,
    status: AssessmentStatusType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentsResponseTypeDef:  # (2)
    ...
  1. See AssessmentStatusType
  2. See ListAssessmentsResponseTypeDef
Usage example with kwargs
kwargs: ListAssessmentsRequestRequestTypeDef = {  # (1)
    "status": ...,
}

parent.list_assessments(**kwargs)
  1. See ListAssessmentsRequestRequestTypeDef

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

Method definition
def list_control_domain_insights(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListControlDomainInsightsResponseTypeDef:  # (1)
    ...
  1. See ListControlDomainInsightsResponseTypeDef
Usage example with kwargs
kwargs: ListControlDomainInsightsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_control_domain_insights(**kwargs)
  1. See ListControlDomainInsightsRequestRequestTypeDef

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

Method definition
def list_control_domain_insights_by_assessment(
    self,
    *,
    assessmentId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListControlDomainInsightsByAssessmentResponseTypeDef:  # (1)
    ...
  1. See ListControlDomainInsightsByAssessmentResponseTypeDef
Usage example with kwargs
kwargs: ListControlDomainInsightsByAssessmentRequestRequestTypeDef = {  # (1)
    "assessmentId": ...,
}

parent.list_control_domain_insights_by_assessment(**kwargs)
  1. See ListControlDomainInsightsByAssessmentRequestRequestTypeDef

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

Method definition
def list_control_insights_by_control_domain(
    self,
    *,
    controlDomainId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListControlInsightsByControlDomainResponseTypeDef:  # (1)
    ...
  1. See ListControlInsightsByControlDomainResponseTypeDef
Usage example with kwargs
kwargs: ListControlInsightsByControlDomainRequestRequestTypeDef = {  # (1)
    "controlDomainId": ...,
}

parent.list_control_insights_by_control_domain(**kwargs)
  1. See ListControlInsightsByControlDomainRequestRequestTypeDef

list_controls

Returns a list of controls from Audit Manager.

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

Method definition
def list_controls(
    self,
    *,
    controlType: ControlTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListControlsResponseTypeDef:  # (2)
    ...
  1. See ControlTypeType
  2. See ListControlsResponseTypeDef
Usage example with kwargs
kwargs: ListControlsRequestRequestTypeDef = {  # (1)
    "controlType": ...,
}

parent.list_controls(**kwargs)
  1. See ListControlsRequestRequestTypeDef

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

Method definition
def list_keywords_for_data_source(
    self,
    *,
    source: SourceTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListKeywordsForDataSourceResponseTypeDef:  # (2)
    ...
  1. See SourceTypeType
  2. See ListKeywordsForDataSourceResponseTypeDef
Usage example with kwargs
kwargs: ListKeywordsForDataSourceRequestRequestTypeDef = {  # (1)
    "source": ...,
}

parent.list_keywords_for_data_source(**kwargs)
  1. See ListKeywordsForDataSourceRequestRequestTypeDef

list_notifications

Returns a list of all Audit Manager notifications.

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

Method definition
def list_notifications(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListNotificationsResponseTypeDef:  # (1)
    ...
  1. See ListNotificationsResponseTypeDef
Usage example with kwargs
kwargs: ListNotificationsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_notifications(**kwargs)
  1. See ListNotificationsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition
def register_account(
    self,
    *,
    kmsKey: str = ...,
    delegatedAdminAccount: str = ...,
) -> RegisterAccountResponseTypeDef:  # (1)
    ...
  1. See RegisterAccountResponseTypeDef
Usage example with kwargs
kwargs: RegisterAccountRequestRequestTypeDef = {  # (1)
    "kmsKey": ...,
}

parent.register_account(**kwargs)
  1. See RegisterAccountRequestRequestTypeDef

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

Method definition
def register_organization_admin_account(
    self,
    *,
    adminAccountId: str,
) -> RegisterOrganizationAdminAccountResponseTypeDef:  # (1)
    ...
  1. See RegisterOrganizationAdminAccountResponseTypeDef
Usage example with kwargs
kwargs: RegisterOrganizationAdminAccountRequestRequestTypeDef = {  # (1)
    "adminAccountId": ...,
}

parent.register_organization_admin_account(**kwargs)
  1. See RegisterOrganizationAdminAccountRequestRequestTypeDef

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

Method definition
def start_assessment_framework_share(
    self,
    *,
    frameworkId: str,
    destinationAccount: str,
    destinationRegion: str,
    comment: str = ...,
) -> StartAssessmentFrameworkShareResponseTypeDef:  # (1)
    ...
  1. See StartAssessmentFrameworkShareResponseTypeDef
Usage example with kwargs
kwargs: StartAssessmentFrameworkShareRequestRequestTypeDef = {  # (1)
    "frameworkId": ...,
    "destinationAccount": ...,
    "destinationRegion": ...,
}

parent.start_assessment_framework_share(**kwargs)
  1. See StartAssessmentFrameworkShareRequestRequestTypeDef

tag_resource

Tags the specified resource in Audit Manager.

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

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_assessment

Edits an Audit Manager assessment.

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

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