Struct aws_sdk_auditmanager::Client

pub struct Client { /* private fields */ }

Client for AWS Audit Manager

Client for invoking operations on AWS Audit Manager. Each operation on AWS Audit Manager is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_auditmanager::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_auditmanager::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_auditmanager::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn associate_assessment_report_evidence_folder(
    &self
) -> AssociateAssessmentReportEvidenceFolder

Constructs a fluent builder for the AssociateAssessmentReportEvidenceFolder operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

  • evidence_folder_id(impl Into<String>) / set_evidence_folder_id(Option<String>):

    The identifier for the folder that the evidence is stored in.

• On success, responds with AssociateAssessmentReportEvidenceFolderOutput
• On failure, responds with SdkError<AssociateAssessmentReportEvidenceFolderError>

pub fn batch_associate_assessment_report_evidence(
    &self
) -> BatchAssociateAssessmentReportEvidence

Constructs a fluent builder for the BatchAssociateAssessmentReportEvidence operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

  • evidence_folder_id(impl Into<String>) / set_evidence_folder_id(Option<String>):

    The identifier for the folder that the evidence is stored in.

  • evidence_ids(Vec<String>) / set_evidence_ids(Option<Vec<String>>):

    The list of evidence identifiers.

• On success, responds with BatchAssociateAssessmentReportEvidenceOutput with field(s):
  • evidence_ids(Option<Vec<String>>):

    The list of evidence identifiers.

  • errors(Option<Vec<AssessmentReportEvidenceError>>):

    A list of errors that the BatchAssociateAssessmentReportEvidence API returned.

• On failure, responds with SdkError<BatchAssociateAssessmentReportEvidenceError>

pub fn batch_create_delegation_by_assessment(
    &self
) -> BatchCreateDelegationByAssessment

Constructs a fluent builder for the BatchCreateDelegationByAssessment operation.

• The fluent builder is configurable:
  • create_delegation_requests(Vec<CreateDelegationRequest>) / set_create_delegation_requests(Option<Vec<CreateDelegationRequest>>):

    The API request to batch create delegations in Audit Manager.

  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

• On success, responds with BatchCreateDelegationByAssessmentOutput with field(s):
  • delegations(Option<Vec<Delegation>>):

    The delegations that are associated with the assessment.

  • errors(Option<Vec<BatchCreateDelegationByAssessmentError>>):

    A list of errors that the BatchCreateDelegationByAssessment API returned.

• On failure, responds with SdkError<BatchCreateDelegationByAssessmentError>

pub fn batch_delete_delegation_by_assessment(
    &self
) -> BatchDeleteDelegationByAssessment

Constructs a fluent builder for the BatchDeleteDelegationByAssessment operation.

• The fluent builder is configurable:
  • delegation_ids(Vec<String>) / set_delegation_ids(Option<Vec<String>>):

    The identifiers for the delegations.

  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

• On success, responds with BatchDeleteDelegationByAssessmentOutput with field(s):
  • errors(Option<Vec<BatchDeleteDelegationByAssessmentError>>):

    A list of errors that the BatchDeleteDelegationByAssessment API returned.

• On failure, responds with SdkError<BatchDeleteDelegationByAssessmentError>

pub fn batch_disassociate_assessment_report_evidence(
    &self
) -> BatchDisassociateAssessmentReportEvidence

Constructs a fluent builder for the BatchDisassociateAssessmentReportEvidence operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

  • evidence_folder_id(impl Into<String>) / set_evidence_folder_id(Option<String>):

    The identifier for the folder that the evidence is stored in.

  • evidence_ids(Vec<String>) / set_evidence_ids(Option<Vec<String>>):

    The list of evidence identifiers.

• On success, responds with BatchDisassociateAssessmentReportEvidenceOutput with field(s):
  • evidence_ids(Option<Vec<String>>):

    The identifier for the evidence.

  • errors(Option<Vec<AssessmentReportEvidenceError>>):

    A list of errors that the BatchDisassociateAssessmentReportEvidence API returned.

• On failure, responds with SdkError<BatchDisassociateAssessmentReportEvidenceError>

pub fn batch_import_evidence_to_assessment_control(
    &self
) -> BatchImportEvidenceToAssessmentControl

Constructs a fluent builder for the BatchImportEvidenceToAssessmentControl operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The identifier for the control set.

  • control_id(impl Into<String>) / set_control_id(Option<String>):

    The identifier for the control.

  • manual_evidence(Vec<ManualEvidence>) / set_manual_evidence(Option<Vec<ManualEvidence>>):

    The list of manual evidence objects.

• On success, responds with BatchImportEvidenceToAssessmentControlOutput with field(s):
  • errors(Option<Vec<BatchImportEvidenceToAssessmentControlError>>):

    A list of errors that the BatchImportEvidenceToAssessmentControl API returned.

• On failure, responds with SdkError<BatchImportEvidenceToAssessmentControlError>

pub fn create_assessment(&self) -> CreateAssessment

Constructs a fluent builder for the CreateAssessment operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the assessment to be created.

  • description(impl Into<String>) / set_description(Option<String>):

    The optional description of the assessment to be created.

  • assessment_reports_destination(AssessmentReportsDestination) / set_assessment_reports_destination(Option<AssessmentReportsDestination>):

    The assessment report storage destination for the assessment that’s being created.

  • scope(Scope) / set_scope(Option<Scope>):

    The wrapper that contains the Amazon Web Services accounts and services that are in scope for the assessment.

  • roles(Vec<Role>) / set_roles(Option<Vec<Role>>):

    The list of roles for the assessment.

  • framework_id(impl Into<String>) / set_framework_id(Option<String>):

    The identifier for the framework that the assessment will be created from.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags that are associated with the assessment.

• On success, responds with CreateAssessmentOutput with field(s):
  • assessment(Option<Assessment>):

    An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework.

• On failure, responds with SdkError<CreateAssessmentError>

pub fn create_assessment_framework(&self) -> CreateAssessmentFramework

Constructs a fluent builder for the CreateAssessmentFramework operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the new custom framework.

  • description(impl Into<String>) / set_description(Option<String>):

    An optional description for the new custom framework.

  • compliance_type(impl Into<String>) / set_compliance_type(Option<String>):

    The compliance type that the new custom framework supports, such as CIS or HIPAA.

  • control_sets(Vec<CreateAssessmentFrameworkControlSet>) / set_control_sets(Option<Vec<CreateAssessmentFrameworkControlSet>>):

    The control sets that are associated with the framework.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags that are associated with the framework.

• On success, responds with CreateAssessmentFrameworkOutput with field(s):
  • framework(Option<Framework>):

    The name of the new framework that the CreateAssessmentFramework API returned.

• On failure, responds with SdkError<CreateAssessmentFrameworkError>

pub fn create_assessment_report(&self) -> CreateAssessmentReport

Constructs a fluent builder for the CreateAssessmentReport operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the new assessment report.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the assessment report.

  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

• On success, responds with CreateAssessmentReportOutput with field(s):
  • assessment_report(Option<AssessmentReport>):

    The new assessment report that the CreateAssessmentReport API returned.

• On failure, responds with SdkError<CreateAssessmentReportError>

pub fn create_control(&self) -> CreateControl

Constructs a fluent builder for the CreateControl operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the control.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the control.

  • testing_information(impl Into<String>) / set_testing_information(Option<String>):

    The steps to follow to determine if the control is satisfied.

  • action_plan_title(impl Into<String>) / set_action_plan_title(Option<String>):

    The title of the action plan for remediating the control.

  • action_plan_instructions(impl Into<String>) / set_action_plan_instructions(Option<String>):

    The recommended actions to carry out if the control isn’t fulfilled.

  • control_mapping_sources(Vec<CreateControlMappingSource>) / set_control_mapping_sources(Option<Vec<CreateControlMappingSource>>):

    The data mapping sources for the control.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags that are associated with the control.

• On success, responds with CreateControlOutput with field(s):
  • control(Option<Control>):

    The new control that the CreateControl API returned.

• On failure, responds with SdkError<CreateControlError>

pub fn delete_assessment(&self) -> DeleteAssessment

Constructs a fluent builder for the DeleteAssessment operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

• On success, responds with DeleteAssessmentOutput
• On failure, responds with SdkError<DeleteAssessmentError>

pub fn delete_assessment_framework(&self) -> DeleteAssessmentFramework

Constructs a fluent builder for the DeleteAssessmentFramework operation.

• The fluent builder is configurable:
  • framework_id(impl Into<String>) / set_framework_id(Option<String>):

    The identifier for the custom framework.

• On success, responds with DeleteAssessmentFrameworkOutput
• On failure, responds with SdkError<DeleteAssessmentFrameworkError>

pub fn delete_assessment_framework_share(
    &self
) -> DeleteAssessmentFrameworkShare

Constructs a fluent builder for the DeleteAssessmentFrameworkShare operation.

• The fluent builder is configurable:
  • request_id(impl Into<String>) / set_request_id(Option<String>):

    The unique identifier for the share request to be deleted.

  • request_type(ShareRequestType) / set_request_type(Option<ShareRequestType>):

    Specifies whether the share request is a sent request or a received request.

• On success, responds with DeleteAssessmentFrameworkShareOutput
• On failure, responds with SdkError<DeleteAssessmentFrameworkShareError>

pub fn delete_assessment_report(&self) -> DeleteAssessmentReport

Constructs a fluent builder for the DeleteAssessmentReport operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • assessment_report_id(impl Into<String>) / set_assessment_report_id(Option<String>):

    The unique identifier for the assessment report.

• On success, responds with DeleteAssessmentReportOutput
• On failure, responds with SdkError<DeleteAssessmentReportError>

pub fn delete_control(&self) -> DeleteControl

Constructs a fluent builder for the DeleteControl operation.

• The fluent builder is configurable:
  • control_id(impl Into<String>) / set_control_id(Option<String>):

    The unique identifier for the control.

• On success, responds with DeleteControlOutput
• On failure, responds with SdkError<DeleteControlError>

pub fn deregister_account(&self) -> DeregisterAccount

Constructs a fluent builder for the DeregisterAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeregisterAccountOutput with field(s):
  • status(Option<AccountStatus>):

    The registration status of the account.

• On failure, responds with SdkError<DeregisterAccountError>

pub fn deregister_organization_admin_account(
    &self
) -> DeregisterOrganizationAdminAccount

Constructs a fluent builder for the DeregisterOrganizationAdminAccount operation.

• The fluent builder is configurable:
  • admin_account_id(impl Into<String>) / set_admin_account_id(Option<String>):

    The identifier for the administrator account.

• On success, responds with DeregisterOrganizationAdminAccountOutput
• On failure, responds with SdkError<DeregisterOrganizationAdminAccountError>

pub fn disassociate_assessment_report_evidence_folder(
    &self
) -> DisassociateAssessmentReportEvidenceFolder

Constructs a fluent builder for the DisassociateAssessmentReportEvidenceFolder operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • evidence_folder_id(impl Into<String>) / set_evidence_folder_id(Option<String>):

    The unique identifier for the folder that the evidence is stored in.

• On success, responds with DisassociateAssessmentReportEvidenceFolderOutput
• On failure, responds with SdkError<DisassociateAssessmentReportEvidenceFolderError>

pub fn get_account_status(&self) -> GetAccountStatus

Constructs a fluent builder for the GetAccountStatus operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountStatusOutput with field(s):
  • status(Option<AccountStatus>):

    The status of the Amazon Web Services account.

• On failure, responds with SdkError<GetAccountStatusError>

pub fn get_assessment(&self) -> GetAssessment

Constructs a fluent builder for the GetAssessment operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

• On success, responds with GetAssessmentOutput with field(s):
  • assessment(Option<Assessment>):

    An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework.

  • user_role(Option<Role>):

    The wrapper that contains the Audit Manager role information of the current user. This includes the role type and IAM Amazon Resource Name (ARN).

• On failure, responds with SdkError<GetAssessmentError>

pub fn get_assessment_framework(&self) -> GetAssessmentFramework

Constructs a fluent builder for the GetAssessmentFramework operation.

• The fluent builder is configurable:
  • framework_id(impl Into<String>) / set_framework_id(Option<String>):

    The identifier for the framework.

• On success, responds with GetAssessmentFrameworkOutput with field(s):
  • framework(Option<Framework>):

    The framework that the GetAssessmentFramework API returned.

• On failure, responds with SdkError<GetAssessmentFrameworkError>

pub fn get_assessment_report_url(&self) -> GetAssessmentReportUrl

Constructs a fluent builder for the GetAssessmentReportUrl operation.

• The fluent builder is configurable:
  • assessment_report_id(impl Into<String>) / set_assessment_report_id(Option<String>):

    The unique identifier for the assessment report.

  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

• On success, responds with GetAssessmentReportUrlOutput with field(s):
  • pre_signed_url(Option<Url>):

    Short for uniform resource locator. A URL is used as a unique identifier to locate a resource on the internet.

• On failure, responds with SdkError<GetAssessmentReportUrlError>

pub fn get_change_logs(&self) -> GetChangeLogs

Constructs a fluent builder for the GetChangeLogs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The unique identifier for the control set.

  • control_id(impl Into<String>) / set_control_id(Option<String>):

    The unique identifier for the control.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with GetChangeLogsOutput with field(s):
  • change_logs(Option<Vec<ChangeLog>>):

    The list of user activity for the control.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<GetChangeLogsError>

pub fn get_control(&self) -> GetControl

Constructs a fluent builder for the GetControl operation.

• The fluent builder is configurable:
  • control_id(impl Into<String>) / set_control_id(Option<String>):

    The identifier for the control.

• On success, responds with GetControlOutput with field(s):
  • control(Option<Control>):

    The name of the control that the GetControl API returned.

• On failure, responds with SdkError<GetControlError>

pub fn get_delegations(&self) -> GetDelegations

Constructs a fluent builder for the GetDelegations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with GetDelegationsOutput with field(s):
  • delegations(Option<Vec<DelegationMetadata>>):

    The list of delegations that the GetDelegations API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<GetDelegationsError>

pub fn get_evidence(&self) -> GetEvidence

Constructs a fluent builder for the GetEvidence operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The unique identifier for the control set.

  • evidence_folder_id(impl Into<String>) / set_evidence_folder_id(Option<String>):

    The unique identifier for the folder that the evidence is stored in.

  • evidence_id(impl Into<String>) / set_evidence_id(Option<String>):

    The unique identifier for the evidence.

• On success, responds with GetEvidenceOutput with field(s):
  • evidence(Option<Evidence>):

    The evidence that the GetEvidenceResponse API returned.

• On failure, responds with SdkError<GetEvidenceError>

pub fn get_evidence_by_evidence_folder(&self) -> GetEvidenceByEvidenceFolder

Constructs a fluent builder for the GetEvidenceByEvidenceFolder operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The identifier for the control set.

  • evidence_folder_id(impl Into<String>) / set_evidence_folder_id(Option<String>):

    The unique identifier for the folder that the evidence is stored in.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with GetEvidenceByEvidenceFolderOutput with field(s):
  • evidence(Option<Vec<Evidence>>):

    The list of evidence that the GetEvidenceByEvidenceFolder API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<GetEvidenceByEvidenceFolderError>

pub fn get_evidence_folder(&self) -> GetEvidenceFolder

Constructs a fluent builder for the GetEvidenceFolder operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The unique identifier for the control set.

  • evidence_folder_id(impl Into<String>) / set_evidence_folder_id(Option<String>):

    The unique identifier for the folder that the evidence is stored in.

• On success, responds with GetEvidenceFolderOutput with field(s):
  • evidence_folder(Option<AssessmentEvidenceFolder>):

    The folder that the evidence is stored in.

• On failure, responds with SdkError<GetEvidenceFolderError>

pub fn get_evidence_folders_by_assessment(
    &self
) -> GetEvidenceFoldersByAssessment

Constructs a fluent builder for the GetEvidenceFoldersByAssessment operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with GetEvidenceFoldersByAssessmentOutput with field(s):
  • evidence_folders(Option<Vec<AssessmentEvidenceFolder>>):

    The list of evidence folders that the GetEvidenceFoldersByAssessment API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<GetEvidenceFoldersByAssessmentError>

pub fn get_evidence_folders_by_assessment_control(
    &self
) -> GetEvidenceFoldersByAssessmentControl

Constructs a fluent builder for the GetEvidenceFoldersByAssessmentControl operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The identifier for the control set.

  • control_id(impl Into<String>) / set_control_id(Option<String>):

    The identifier for the control.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with GetEvidenceFoldersByAssessmentControlOutput with field(s):
  • evidence_folders(Option<Vec<AssessmentEvidenceFolder>>):

    The list of evidence folders that the GetEvidenceFoldersByAssessmentControl API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<GetEvidenceFoldersByAssessmentControlError>

pub fn get_insights(&self) -> GetInsights

Constructs a fluent builder for the GetInsights operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetInsightsOutput with field(s):
  • insights(Option<Insights>):

    The analytics data that the GetInsights API returned.

• On failure, responds with SdkError<GetInsightsError>

pub fn get_insights_by_assessment(&self) -> GetInsightsByAssessment

Constructs a fluent builder for the GetInsightsByAssessment operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

• On success, responds with GetInsightsByAssessmentOutput with field(s):
  • insights(Option<InsightsByAssessment>):

    The assessment analytics data that the GetInsightsByAssessment API returned.

• On failure, responds with SdkError<GetInsightsByAssessmentError>

pub fn get_organization_admin_account(&self) -> GetOrganizationAdminAccount

Constructs a fluent builder for the GetOrganizationAdminAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetOrganizationAdminAccountOutput with field(s):
  • admin_account_id(Option<String>):

    The identifier for the administrator account.

  • organization_id(Option<String>):

    The identifier for the organization.

• On failure, responds with SdkError<GetOrganizationAdminAccountError>

pub fn get_services_in_scope(&self) -> GetServicesInScope

Constructs a fluent builder for the GetServicesInScope operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetServicesInScopeOutput with field(s):
  • service_metadata(Option<Vec<ServiceMetadata>>):

    The metadata that’s associated with the Amazon Web Service.

• On failure, responds with SdkError<GetServicesInScopeError>

pub fn get_settings(&self) -> GetSettings

Constructs a fluent builder for the GetSettings operation.

• The fluent builder is configurable:
  • attribute(SettingAttribute) / set_attribute(Option<SettingAttribute>):

    The list of SettingAttribute enum values.

• On success, responds with GetSettingsOutput with field(s):
  • settings(Option<Settings>):

    The settings object that holds all supported Audit Manager settings.

• On failure, responds with SdkError<GetSettingsError>

pub fn list_assessment_control_insights_by_control_domain(
    &self
) -> ListAssessmentControlInsightsByControlDomain

Constructs a fluent builder for the ListAssessmentControlInsightsByControlDomain operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • control_domain_id(impl Into<String>) / set_control_domain_id(Option<String>):

    The unique identifier for the control domain.

  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the active assessment.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListAssessmentControlInsightsByControlDomainOutput with field(s):
  • control_insights_by_assessment(Option<Vec<ControlInsightsMetadataByAssessmentItem>>):

    The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListAssessmentControlInsightsByControlDomainError>

pub fn list_assessment_frameworks(&self) -> ListAssessmentFrameworks

Constructs a fluent builder for the ListAssessmentFrameworks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • framework_type(FrameworkType) / set_framework_type(Option<FrameworkType>):

    The type of framework, such as a standard framework or a custom framework.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListAssessmentFrameworksOutput with field(s):
  • framework_metadata_list(Option<Vec<AssessmentFrameworkMetadata>>):

    The list of metadata objects for the framework.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListAssessmentFrameworksError>

pub fn list_assessment_framework_share_requests(
    &self
) -> ListAssessmentFrameworkShareRequests

Constructs a fluent builder for the ListAssessmentFrameworkShareRequests operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • request_type(ShareRequestType) / set_request_type(Option<ShareRequestType>):

    Specifies whether the share request is a sent request or a received request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListAssessmentFrameworkShareRequestsOutput with field(s):
  • assessment_framework_share_requests(Option<Vec<AssessmentFrameworkShareRequest>>):

    The list of share requests that the ListAssessmentFrameworkShareRequests API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListAssessmentFrameworkShareRequestsError>

pub fn list_assessment_reports(&self) -> ListAssessmentReports

Constructs a fluent builder for the ListAssessmentReports operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListAssessmentReportsOutput with field(s):
  • assessment_reports(Option<Vec<AssessmentReportMetadata>>):

    The list of assessment reports that the ListAssessmentReports API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListAssessmentReportsError>

pub fn list_assessments(&self) -> ListAssessments

Constructs a fluent builder for the ListAssessments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • status(AssessmentStatus) / set_status(Option<AssessmentStatus>):

    The current status of the assessment.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListAssessmentsOutput with field(s):
  • assessment_metadata(Option<Vec<AssessmentMetadataItem>>):

    The metadata that’s associated with the assessment.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListAssessmentsError>

pub fn list_control_domain_insights(&self) -> ListControlDomainInsights

Constructs a fluent builder for the ListControlDomainInsights operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListControlDomainInsightsOutput with field(s):
  • control_domain_insights(Option<Vec<ControlDomainInsights>>):

    The control domain analytics data that the ListControlDomainInsights API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListControlDomainInsightsError>

pub fn list_control_domain_insights_by_assessment(
    &self
) -> ListControlDomainInsightsByAssessment

Constructs a fluent builder for the ListControlDomainInsightsByAssessment operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the active assessment.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListControlDomainInsightsByAssessmentOutput with field(s):
  • control_domain_insights(Option<Vec<ControlDomainInsights>>):

    The control domain analytics data that the ListControlDomainInsightsByAssessment API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListControlDomainInsightsByAssessmentError>

pub fn list_control_insights_by_control_domain(
    &self
) -> ListControlInsightsByControlDomain

Constructs a fluent builder for the ListControlInsightsByControlDomain operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • control_domain_id(impl Into<String>) / set_control_domain_id(Option<String>):

    The unique identifier for the control domain.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListControlInsightsByControlDomainOutput with field(s):
  • control_insights_metadata(Option<Vec<ControlInsightsMetadataItem>>):

    The control analytics data that the ListControlInsightsByControlDomain API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListControlInsightsByControlDomainError>

pub fn list_controls(&self) -> ListControls

Constructs a fluent builder for the ListControls operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • control_type(ControlType) / set_control_type(Option<ControlType>):

    The type of control, such as a standard control or a custom control.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListControlsOutput with field(s):
  • control_metadata_list(Option<Vec<ControlMetadata>>):

    The list of control metadata objects that the ListControls API returned.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListControlsError>

pub fn list_keywords_for_data_source(&self) -> ListKeywordsForDataSource

Constructs a fluent builder for the ListKeywordsForDataSource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • source(SourceType) / set_source(Option<SourceType>):

    The control mapping data source that the keywords apply to.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListKeywordsForDataSourceOutput with field(s):
  • keywords(Option<Vec<String>>):

    The list of keywords for the event mapping source.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListKeywordsForDataSourceError>

pub fn list_notifications(&self) -> ListNotifications

Constructs a fluent builder for the ListNotifications operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

  • max_results(i32) / set_max_results(Option<i32>):

    Represents the maximum number of results on a page or for an API request call.

• On success, responds with ListNotificationsOutput with field(s):
  • notifications(Option<Vec<Notification>>):

    The returned list of notifications.

  • next_token(Option<String>):

    The pagination token that’s used to fetch the next set of results.

• On failure, responds with SdkError<ListNotificationsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    The list of tags that the ListTagsForResource API returned.

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn register_account(&self) -> RegisterAccount

Constructs a fluent builder for the RegisterAccount operation.

• The fluent builder is configurable:
  • kms_key(impl Into<String>) / set_kms_key(Option<String>):

    The KMS key details.

  • delegated_admin_account(impl Into<String>) / set_delegated_admin_account(Option<String>):

    The delegated administrator account for Audit Manager.

• On success, responds with RegisterAccountOutput with field(s):
  • status(Option<AccountStatus>):

    The status of the account registration request.

• On failure, responds with SdkError<RegisterAccountError>

pub fn register_organization_admin_account(
    &self
) -> RegisterOrganizationAdminAccount

Constructs a fluent builder for the RegisterOrganizationAdminAccount operation.

• The fluent builder is configurable:
  • admin_account_id(impl Into<String>) / set_admin_account_id(Option<String>):

    The identifier for the delegated administrator account.

• On success, responds with RegisterOrganizationAdminAccountOutput with field(s):
  • admin_account_id(Option<String>):

    The identifier for the delegated administrator account.

  • organization_id(Option<String>):

    The identifier for the organization.

• On failure, responds with SdkError<RegisterOrganizationAdminAccountError>

pub fn start_assessment_framework_share(&self) -> StartAssessmentFrameworkShare

Constructs a fluent builder for the StartAssessmentFrameworkShare operation.

• The fluent builder is configurable:
  • framework_id(impl Into<String>) / set_framework_id(Option<String>):

    The unique identifier for the custom framework to be shared.

  • destination_account(impl Into<String>) / set_destination_account(Option<String>):

    The Amazon Web Services account of the recipient.

  • destination_region(impl Into<String>) / set_destination_region(Option<String>):

    The Amazon Web Services Region of the recipient.

  • comment(impl Into<String>) / set_comment(Option<String>):

    An optional comment from the sender about the share request.

• On success, responds with StartAssessmentFrameworkShareOutput with field(s):
  • assessment_framework_share_request(Option<AssessmentFrameworkShareRequest>):

    The share request that’s created by the StartAssessmentFrameworkShare API.

• On failure, responds with SdkError<StartAssessmentFrameworkShareError>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags that are associated with the resource.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the specified resource.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The name or key of the tag.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

pub fn update_assessment(&self) -> UpdateAssessment

Constructs a fluent builder for the UpdateAssessment operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • assessment_name(impl Into<String>) / set_assessment_name(Option<String>):

    The name of the assessment to be updated.

  • assessment_description(impl Into<String>) / set_assessment_description(Option<String>):

    The description of the assessment.

  • scope(Scope) / set_scope(Option<Scope>):

    The scope of the assessment.

  • assessment_reports_destination(AssessmentReportsDestination) / set_assessment_reports_destination(Option<AssessmentReportsDestination>):

    The assessment report storage destination for the assessment that’s being updated.

  • roles(Vec<Role>) / set_roles(Option<Vec<Role>>):

    The list of roles for the assessment.

• On success, responds with UpdateAssessmentOutput with field(s):
  • assessment(Option<Assessment>):

    The response object for the UpdateAssessmentRequest API. This is the name of the updated assessment.

• On failure, responds with SdkError<UpdateAssessmentError>

pub fn update_assessment_control(&self) -> UpdateAssessmentControl

Constructs a fluent builder for the UpdateAssessmentControl operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The unique identifier for the control set.

  • control_id(impl Into<String>) / set_control_id(Option<String>):

    The unique identifier for the control.

  • control_status(ControlStatus) / set_control_status(Option<ControlStatus>):

    The status of the control.

  • comment_body(impl Into<String>) / set_comment_body(Option<String>):

    The comment body text for the control.

• On success, responds with UpdateAssessmentControlOutput with field(s):
  • control(Option<AssessmentControl>):

    The name of the updated control set that the UpdateAssessmentControl API returned.

• On failure, responds with SdkError<UpdateAssessmentControlError>

pub fn update_assessment_control_set_status(
    &self
) -> UpdateAssessmentControlSetStatus

Constructs a fluent builder for the UpdateAssessmentControlSetStatus operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • control_set_id(impl Into<String>) / set_control_set_id(Option<String>):

    The unique identifier for the control set.

  • status(ControlSetStatus) / set_status(Option<ControlSetStatus>):

    The status of the control set that’s being updated.

  • comment(impl Into<String>) / set_comment(Option<String>):

    The comment that’s related to the status update.

• On success, responds with UpdateAssessmentControlSetStatusOutput with field(s):
  • control_set(Option<AssessmentControlSet>):

    The name of the updated control set that the UpdateAssessmentControlSetStatus API returned.

• On failure, responds with SdkError<UpdateAssessmentControlSetStatusError>

pub fn update_assessment_framework(&self) -> UpdateAssessmentFramework

Constructs a fluent builder for the UpdateAssessmentFramework operation.

• The fluent builder is configurable:
  • framework_id(impl Into<String>) / set_framework_id(Option<String>):

    The unique identifier for the framework.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the framework to be updated.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the updated framework.

  • compliance_type(impl Into<String>) / set_compliance_type(Option<String>):

    The compliance type that the new custom framework supports, such as CIS or HIPAA.

  • control_sets(Vec<UpdateAssessmentFrameworkControlSet>) / set_control_sets(Option<Vec<UpdateAssessmentFrameworkControlSet>>):

    The control sets that are associated with the framework.

• On success, responds with UpdateAssessmentFrameworkOutput with field(s):
  • framework(Option<Framework>):

    The name of the framework.

• On failure, responds with SdkError<UpdateAssessmentFrameworkError>

pub fn update_assessment_framework_share(
    &self
) -> UpdateAssessmentFrameworkShare

Constructs a fluent builder for the UpdateAssessmentFrameworkShare operation.

• The fluent builder is configurable:
  • request_id(impl Into<String>) / set_request_id(Option<String>):

    The unique identifier for the share request.

  • request_type(ShareRequestType) / set_request_type(Option<ShareRequestType>):

    Specifies whether the share request is a sent request or a received request.

  • action(ShareRequestAction) / set_action(Option<ShareRequestAction>):

    Specifies the update action for the share request.

• On success, responds with UpdateAssessmentFrameworkShareOutput with field(s):
  • assessment_framework_share_request(Option<AssessmentFrameworkShareRequest>):

    The updated share request that’s returned by the UpdateAssessmentFrameworkShare operation.

• On failure, responds with SdkError<UpdateAssessmentFrameworkShareError>

pub fn update_assessment_status(&self) -> UpdateAssessmentStatus

Constructs a fluent builder for the UpdateAssessmentStatus operation.

• The fluent builder is configurable:
  • assessment_id(impl Into<String>) / set_assessment_id(Option<String>):

    The unique identifier for the assessment.

  • status(AssessmentStatus) / set_status(Option<AssessmentStatus>):

    The current status of the assessment.

• On success, responds with UpdateAssessmentStatusOutput with field(s):
  • assessment(Option<Assessment>):

    The name of the updated assessment that the UpdateAssessmentStatus API returned.

• On failure, responds with SdkError<UpdateAssessmentStatusError>

pub fn update_control(&self) -> UpdateControl

Constructs a fluent builder for the UpdateControl operation.

• The fluent builder is configurable:
  • control_id(impl Into<String>) / set_control_id(Option<String>):

    The identifier for the control.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the updated control.

  • description(impl Into<String>) / set_description(Option<String>):

    The optional description of the control.

  • testing_information(impl Into<String>) / set_testing_information(Option<String>):

    The steps that you should follow to determine if the control is met.

  • action_plan_title(impl Into<String>) / set_action_plan_title(Option<String>):

    The title of the action plan for remediating the control.

  • action_plan_instructions(impl Into<String>) / set_action_plan_instructions(Option<String>):

    The recommended actions to carry out if the control isn’t fulfilled.

  • control_mapping_sources(Vec<ControlMappingSource>) / set_control_mapping_sources(Option<Vec<ControlMappingSource>>):

    The data mapping sources for the control.

• On success, responds with UpdateControlOutput with field(s):
  • control(Option<Control>):

    The name of the updated control set that the UpdateControl API returned.

• On failure, responds with SdkError<UpdateControlError>

pub fn update_settings(&self) -> UpdateSettings

Constructs a fluent builder for the UpdateSettings operation.

• The fluent builder is configurable:
  • sns_topic(impl Into<String>) / set_sns_topic(Option<String>):

    The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends notifications to.

  • default_assessment_reports_destination(AssessmentReportsDestination) / set_default_assessment_reports_destination(Option<AssessmentReportsDestination>):

    The default storage destination for assessment reports.

  • default_process_owners(Vec<Role>) / set_default_process_owners(Option<Vec<Role>>):

    A list of the default audit owners.

  • kms_key(impl Into<String>) / set_kms_key(Option<String>):

    The KMS key details.

• On success, responds with UpdateSettingsOutput with field(s):
  • settings(Option<Settings>):

    The current list of settings.

• On failure, responds with SdkError<UpdateSettingsError>

pub fn validate_assessment_report_integrity(
    &self
) -> ValidateAssessmentReportIntegrity

Constructs a fluent builder for the ValidateAssessmentReportIntegrity operation.

• The fluent builder is configurable:
  • s3_relative_path(impl Into<String>) / set_s3_relative_path(Option<String>):

    The relative path of the Amazon S3 bucket that the assessment report is stored in.

• On success, responds with ValidateAssessmentReportIntegrityOutput with field(s):
  • signature_valid(Option<bool>):

    Specifies whether the signature key is valid.

  • signature_algorithm(Option<String>):

    The signature algorithm that’s used to code sign the assessment report file.

  • signature_date_time(Option<String>):

    The date and time signature that specifies when the assessment report was created.

  • signature_key_id(Option<String>):

    The unique identifier for the validation signature key.

  • validation_errors(Option<Vec<String>>):

    Represents any errors that occurred when validating the assessment report.

• On failure, responds with SdkError<ValidateAssessmentReportIntegrityError>

impl Client

pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>, 

Creates a client with the given service config and connector override.

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.