Struct ClientCopy item path

Constructs a fluent builder for the AssociateAssessmentReportEvidenceFolder operation.

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

    The identifier for the assessment.

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

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

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

Constructs a fluent builder for the BatchAssociateAssessmentReportEvidence operation.

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

    The identifier for the assessment.

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

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

    
    
  • evidence_ids(impl Into<String>) / set_evidence_ids(Option<Vec::<String>>):
    required: true
    

    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>

Constructs a fluent builder for the BatchCreateDelegationByAssessment operation.

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

    The API request to batch create delegations in Audit Manager.

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

    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>

Constructs a fluent builder for the BatchDeleteDelegationByAssessment operation.

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

    The identifiers for the delegations.

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

    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>

Constructs a fluent builder for the BatchDisassociateAssessmentReportEvidence operation.

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

    The identifier for the assessment.

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

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

    
    
  • evidence_ids(impl Into<String>) / set_evidence_ids(Option<Vec::<String>>):
    required: true
    

    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>

Constructs a fluent builder for the BatchImportEvidenceToAssessmentControl operation.

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

    The identifier for the assessment.

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

    The identifier for the control set.

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

    The identifier for the control.

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

    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>

Constructs a fluent builder for the CreateAssessment operation.

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

    The name of the assessment to be created.

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

    The optional description of the assessment to be created.

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

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

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

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

    You no longer need to specify which Amazon Web Services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services.

    If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment.

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

    The list of roles for the assessment.

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

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

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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>

Constructs a fluent builder for the CreateAssessmentFramework operation.

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

    The name of the new custom framework.

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

    An optional description for the new custom framework.

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

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

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

    The control sets that are associated with the framework.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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>

Constructs a fluent builder for the CreateAssessmentReport operation.

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

    The name of the new assessment report.

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

    The description of the assessment report.

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

    The identifier for the assessment.

    
    
  • query_statement(impl Into<String>) / set_query_statement(Option<String>):
    required: false
    

    A SQL statement that represents an evidence finder query.

    Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API.

    To use this parameter, the enablementStatus of evidence finder must be ENABLED.

    For examples and help resolving queryStatement validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User Guide.

    
    
• 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>

Constructs a fluent builder for the CreateControl operation.

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

    The name of the control.

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

    The description of the control.

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

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

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

    The title of the action plan for remediating the control.

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

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

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

    The data mapping sources for the control.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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>

Constructs a fluent builder for the DeleteAssessment operation.

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

    The identifier for the assessment.

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

Constructs a fluent builder for the DeleteAssessmentFramework operation.

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

    The identifier for the custom framework.

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

Constructs a fluent builder for the DeleteAssessmentFrameworkShare operation.

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

    The unique identifier for the share request to be deleted.

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

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

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

Constructs a fluent builder for the DeleteAssessmentReport operation.

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

    The unique identifier for the assessment.

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

    The unique identifier for the assessment report.

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

Constructs a fluent builder for the DeleteControl operation.

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

    The unique identifier for the control.

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

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>

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>):
    required: false
    

    The identifier for the administrator account.

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

Constructs a fluent builder for the DisassociateAssessmentReportEvidenceFolder operation.

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

    The unique identifier for the assessment.

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

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

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

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>

Constructs a fluent builder for the GetAssessment operation.

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

    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>

Constructs a fluent builder for the GetAssessmentFramework operation.

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

    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>

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>):
    required: true
    

    The unique identifier for the assessment report.

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

    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>

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>):
    required: true
    

    The unique identifier for the assessment.

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

    The unique identifier for the control set.

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

    The unique identifier for the control.

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

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

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

    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>

Constructs a fluent builder for the GetControl operation.

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

    The identifier for the control.

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

    The details of the control that the GetControl API returned.

• On failure, responds with SdkError<GetControlError>

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>):
    required: false
    

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

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

    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>

Constructs a fluent builder for the GetEvidence operation.

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

    The unique identifier for the assessment.

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

    The unique identifier for the control set.

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

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

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

    The unique identifier for the evidence.

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

    The evidence that the GetEvidence API returned.

• On failure, responds with SdkError<GetEvidenceError>

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>):
    required: true
    

    The identifier for the assessment.

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

    The identifier for the control set.

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

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

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

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

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

    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>

Constructs a fluent builder for the GetEvidenceFileUploadUrl operation.

• The fluent builder is configurable:
  • file_name(impl Into<String>) / set_file_name(Option<String>):
    required: true
    

    The file that you want to upload. For a list of supported file formats, see Supported file types for manual evidence in the Audit Manager User Guide.

    
    
• On success, responds with GetEvidenceFileUploadUrlOutput with field(s):
  • evidence_file_name(Option<String>):

    The name of the uploaded manual evidence file that the presigned URL was generated for.

  • upload_url(Option<String>):

    The presigned URL that was generated.

• On failure, responds with SdkError<GetEvidenceFileUploadUrlError>

Constructs a fluent builder for the GetEvidenceFolder operation.

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

    The unique identifier for the assessment.

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

    The unique identifier for the control set.

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

    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>

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>):
    required: true
    

    The unique identifier for the assessment.

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

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

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

    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>

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>):
    required: true
    

    The identifier for the assessment.

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

    The identifier for the control set.

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

    The identifier for the control.

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

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

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

    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>

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>

Constructs a fluent builder for the GetInsightsByAssessment operation.

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

    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>

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>

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>

Constructs a fluent builder for the GetSettings operation.

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

    The list of setting attribute 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>

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>):
    required: true
    

    The unique identifier for the control domain.

    Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference.

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

    The unique identifier for the active assessment.

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

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

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

    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>

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>):
    required: true
    

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

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

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

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

    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>

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>):
    required: true
    

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

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

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

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

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

    A list of metadata that the ListAssessmentFrameworks API returns for each framework.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListAssessmentFrameworksError>

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>):
    required: false
    

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

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

    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>

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>):
    required: false
    

    The current status of the assessment.

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

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

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

    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 the ListAssessments API returns for each assessment.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListAssessmentsError>

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>):
    required: false
    

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

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

    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>

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>):
    required: true
    

    The unique identifier for the active assessment.

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

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

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

    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>

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>):
    required: true
    

    The unique identifier for the control domain.

    Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference.

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

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

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

    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>

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>):
    required: true
    

    A filter that narrows the list of controls to a specific type.

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

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

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

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

    
    
  • control_catalog_id(impl Into<String>) / set_control_catalog_id(Option<String>):
    required: false
    

    A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog.

    To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see ListDomains , ListObjectives , and ListCommonControls .

    You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the ListControls operation separately for each ARN.

    Alternatively, specify UNCATEGORIZED to list controls that aren’t mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don’t belong to any control domain or control objective.

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

    A list of metadata that the ListControls API returns for each control.

  • next_token(Option<String>):

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

• On failure, responds with SdkError<ListControlsError>

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

• The fluent builder is configurable:
  • source(DataSourceType) / set_source(Option<DataSourceType>):
    required: true
    

    The control mapping data source that the keywords apply to.

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

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

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

    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 control 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>

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>):
    required: false
    

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

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

    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>

Constructs a fluent builder for the ListTagsForResource operation.

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

    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>

Constructs a fluent builder for the RegisterAccount operation.

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

    The KMS key details.

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

    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>

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>):
    required: true
    

    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>

Constructs a fluent builder for the StartAssessmentFrameworkShare operation.

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

    The unique identifier for the custom framework to be shared.

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

    The Amazon Web Services account of the recipient.

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

    The Amazon Web Services Region of the recipient.

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

    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>

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags that are associated with the resource.

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

Constructs a fluent builder for the UntagResource operation.

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

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

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The name or key of the tag.

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

Constructs a fluent builder for the UpdateAssessment operation.

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

    The unique identifier for the assessment.

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

    The name of the assessment to be updated.

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

    The description of the assessment.

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

    The scope of the assessment.

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

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

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

    The list of roles for the assessment.

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

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

• On failure, responds with SdkError<UpdateAssessmentError>

Constructs a fluent builder for the UpdateAssessmentControl operation.

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

    The unique identifier for the assessment.

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

    The unique identifier for the control set.

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

    The unique identifier for the control.

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

    The status of the control.

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

    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>

Constructs a fluent builder for the UpdateAssessmentControlSetStatus operation.

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

    The unique identifier for the assessment.

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

    The unique identifier for the control set.

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

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

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

    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>

Constructs a fluent builder for the UpdateAssessmentFramework operation.

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

    The unique identifier for the framework.

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

    The name of the framework to be updated.

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

    The description of the updated framework.

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

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

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

    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>

Constructs a fluent builder for the UpdateAssessmentFrameworkShare operation.

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

    The unique identifier for the share request.

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

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

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

    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>

Constructs a fluent builder for the UpdateAssessmentStatus operation.

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

    The unique identifier for the assessment.

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

    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>

Constructs a fluent builder for the UpdateControl operation.

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

    The identifier for the control.

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

    The name of the updated control.

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

    The optional description of the control.

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

    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>):
    required: false
    

    The title of the action plan for remediating the control.

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

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

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

    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>

Constructs a fluent builder for the UpdateSettings operation.

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

    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>):
    required: false
    

    The default S3 destination bucket for storing assessment reports.

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

    A list of the default audit owners.

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

    The KMS key details.

    
    
  • evidence_finder_enabled(bool) / set_evidence_finder_enabled(Option<bool>):
    required: false
    

    Specifies whether the evidence finder feature is enabled. Change this attribute to enable or disable evidence finder.

    When you use this attribute to disable evidence finder, Audit Manager deletes the event data store that’s used to query your evidence data. As a result, you can’t re-enable evidence finder and use the feature again. Your only alternative is to deregister and then re-register Audit Manager.

    
    
  • deregistration_policy(DeregistrationPolicy) / set_deregistration_policy(Option<DeregistrationPolicy>):
    required: false
    

    The deregistration policy for your Audit Manager data. You can use this attribute to determine how your data is handled when you deregister Audit Manager.

    
    
  • default_export_destination(DefaultExportDestination) / set_default_export_destination(Option<DefaultExportDestination>):
    required: false
    

    The default S3 destination bucket for storing evidence finder exports.

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

    The current list of settings.

• On failure, responds with SdkError<UpdateSettingsError>

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>):
    required: true
    

    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>

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Returns the client’s configuration.

Creates a new client from an SDK Config.

§Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();

Returns self with the fg() set to [Color :: Primary].

§Example

println!("{}", value.primary());

Returns self with the fg() set to [Color :: Fixed].

§Example

println!("{}", value.fixed(color));

Returns self with the fg() set to [Color :: Rgb].

§Example

println!("{}", value.rgb(r, g, b));

Returns self with the fg() set to [Color :: Black].

§Example

println!("{}", value.black());

Returns self with the fg() set to [Color :: Red].

§Example

println!("{}", value.red());

Returns self with the fg() set to [Color :: Green].

§Example

println!("{}", value.green());

Returns self with the fg() set to [Color :: Yellow].

§Example

println!("{}", value.yellow());

Returns self with the fg() set to [Color :: Blue].

§Example

println!("{}", value.blue());

Returns self with the fg() set to [Color :: Magenta].

§Example

println!("{}", value.magenta());

Returns self with the fg() set to [Color :: Cyan].

§Example

println!("{}", value.cyan());

Returns self with the fg() set to [Color :: White].

§Example

println!("{}", value.white());

Returns self with the fg() set to [Color :: BrightBlack].

§Example

println!("{}", value.bright_black());

Returns self with the fg() set to [Color :: BrightRed].

§Example

println!("{}", value.bright_red());

Returns self with the fg() set to [Color :: BrightGreen].

§Example

println!("{}", value.bright_green());

Returns self with the fg() set to [Color :: BrightYellow].

§Example

println!("{}", value.bright_yellow());

Returns self with the fg() set to [Color :: BrightBlue].

§Example

println!("{}", value.bright_blue());

Returns self with the fg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.bright_magenta());

Returns self with the fg() set to [Color :: BrightCyan].

§Example

println!("{}", value.bright_cyan());

Returns self with the fg() set to [Color :: BrightWhite].

§Example

println!("{}", value.bright_white());

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();

Returns self with the bg() set to [Color :: Primary].

§Example

println!("{}", value.on_primary());

Returns self with the bg() set to [Color :: Fixed].

§Example

println!("{}", value.on_fixed(color));

Returns self with the bg() set to [Color :: Rgb].

§Example

println!("{}", value.on_rgb(r, g, b));

Returns self with the bg() set to [Color :: Black].

§Example

println!("{}", value.on_black());

Returns self with the bg() set to [Color :: Red].

§Example

println!("{}", value.on_red());

Returns self with the bg() set to [Color :: Green].

§Example

println!("{}", value.on_green());

Returns self with the bg() set to [Color :: Yellow].

§Example

println!("{}", value.on_yellow());

Returns self with the bg() set to [Color :: Blue].

§Example

println!("{}", value.on_blue());

Returns self with the bg() set to [Color :: Magenta].

§Example

println!("{}", value.on_magenta());

Returns self with the bg() set to [Color :: Cyan].

§Example

println!("{}", value.on_cyan());

Returns self with the bg() set to [Color :: White].

§Example

println!("{}", value.on_white());

Returns self with the bg() set to [Color :: BrightBlack].

§Example

println!("{}", value.on_bright_black());

Returns self with the bg() set to [Color :: BrightRed].

§Example

println!("{}", value.on_bright_red());

Returns self with the bg() set to [Color :: BrightGreen].

§Example

println!("{}", value.on_bright_green());

Returns self with the bg() set to [Color :: BrightYellow].

§Example

println!("{}", value.on_bright_yellow());

Returns self with the bg() set to [Color :: BrightBlue].

§Example

println!("{}", value.on_bright_blue());

Returns self with the bg() set to [Color :: BrightMagenta].

§Example

println!("{}", value.on_bright_magenta());

Returns self with the bg() set to [Color :: BrightCyan].

§Example

println!("{}", value.on_bright_cyan());

Returns self with the bg() set to [Color :: BrightWhite].

§Example

println!("{}", value.on_bright_white());

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();

Returns self with the attr() set to [Attribute :: Bold].

§Example

println!("{}", value.bold());

Returns self with the attr() set to [Attribute :: Dim].

§Example

println!("{}", value.dim());

Returns self with the attr() set to [Attribute :: Italic].

§Example

println!("{}", value.italic());

Returns self with the attr() set to [Attribute :: Underline].

§Example

println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example

println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example

println!("{}", value.rapid_blink());

Returns self with the attr() set to [Attribute :: Invert].

§Example

println!("{}", value.invert());

Returns self with the attr() set to [Attribute :: Conceal].

§Example

println!("{}", value.conceal());

Returns self with the attr() set to [Attribute :: Strike].

§Example

println!("{}", value.strike());

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();

Returns self with the quirk() set to [Quirk :: Mask].

§Example

println!("{}", value.mask());

Returns self with the quirk() set to [Quirk :: Wrap].

§Example

println!("{}", value.wrap());

Returns self with the quirk() set to [Quirk :: Linger].

§Example

println!("{}", value.linger());

Returns self with the quirk() set to [Quirk :: Clear].

§Example

println!("{}", value.clear());

Returns self with the quirk() set to [Quirk :: Resetting].

§Example

println!("{}", value.resetting());

Returns self with the quirk() set to [Quirk :: Bright].

§Example

println!("{}", value.bright());

Returns self with the quirk() set to [Quirk :: OnBright].

§Example

println!("{}", value.on_bright());

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);