Struct Client

pub struct Client { /* private fields */ }

Client for Inspector2

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

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_inspector2::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_inspector2::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateMember operation has a Client::associate_member, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_member()
    .account_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_member(&self) -> AssociateMemberFluentBuilder

Constructs a fluent builder for the AssociateMember operation.

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

    The Amazon Web Services account ID of the member account to be associated.

    
    
• On success, responds with AssociateMemberOutput with field(s):
  • account_id(String):

    The Amazon Web Services account ID of the successfully associated member account.

• On failure, responds with SdkError<AssociateMemberError>

impl Client

pub fn batch_get_account_status(&self) -> BatchGetAccountStatusFluentBuilder

Constructs a fluent builder for the BatchGetAccountStatus operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.

    
    
• On success, responds with BatchGetAccountStatusOutput with field(s):
  • accounts(Vec::<AccountState>):

    An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.

  • failed_accounts(Option<Vec::<FailedAccount>>):

    An array of objects detailing any accounts that failed to enable Amazon Inspector and why.

• On failure, responds with SdkError<BatchGetAccountStatusError>

impl Client

pub fn batch_get_code_snippet(&self) -> BatchGetCodeSnippetFluentBuilder

Constructs a fluent builder for the BatchGetCodeSnippet operation.

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

    An array of finding ARNs for the findings you want to retrieve code snippets from.

    
    
• On success, responds with BatchGetCodeSnippetOutput with field(s):
  • code_snippet_results(Option<Vec::<CodeSnippetResult>>):

    The retrieved code snippets associated with the provided finding ARNs.

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

    Any errors Amazon Inspector encountered while trying to retrieve the requested code snippets.

• On failure, responds with SdkError<BatchGetCodeSnippetError>

impl Client

pub fn batch_get_finding_details(&self) -> BatchGetFindingDetailsFluentBuilder

Constructs a fluent builder for the BatchGetFindingDetails operation.

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

    A list of finding ARNs.

    
    
• On success, responds with BatchGetFindingDetailsOutput with field(s):
  • finding_details(Option<Vec::<FindingDetail>>):

    A finding’s vulnerability details.

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

    Error information for findings that details could not be returned for.

• On failure, responds with SdkError<BatchGetFindingDetailsError>

impl Client

pub fn batch_get_free_trial_info(&self) -> BatchGetFreeTrialInfoFluentBuilder

Constructs a fluent builder for the BatchGetFreeTrialInfo operation.

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

    The account IDs to get free trial status for.

    
    
• On success, responds with BatchGetFreeTrialInfoOutput with field(s):
  • accounts(Vec::<FreeTrialAccountInfo>):

    An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.

  • failed_accounts(Vec::<FreeTrialInfoError>):

    An array of objects detailing any accounts that free trial data could not be returned for.

• On failure, responds with SdkError<BatchGetFreeTrialInfoError>

impl Client

pub fn batch_get_member_ec2_deep_inspection_status( &self, ) -> BatchGetMemberEc2DeepInspectionStatusFluentBuilder

Constructs a fluent builder for the BatchGetMemberEc2DeepInspectionStatus operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    The unique identifiers for the Amazon Web Services accounts to retrieve Amazon Inspector deep inspection activation status for.

    
    
• On success, responds with BatchGetMemberEc2DeepInspectionStatusOutput with field(s):
  • account_ids(Option<Vec::<MemberAccountEc2DeepInspectionStatusState>>):

    An array of objects that provide details on the activation status of Amazon Inspector deep inspection for each of the requested accounts.

  • failed_account_ids(Option<Vec::<FailedMemberAccountEc2DeepInspectionStatusState>>):

    An array of objects that provide details on any accounts that failed to activate Amazon Inspector deep inspection and why.

• On failure, responds with SdkError<BatchGetMemberEc2DeepInspectionStatusError>

impl Client

pub fn batch_update_member_ec2_deep_inspection_status( &self, ) -> BatchUpdateMemberEc2DeepInspectionStatusFluentBuilder

Constructs a fluent builder for the BatchUpdateMemberEc2DeepInspectionStatus operation.

• The fluent builder is configurable:
  • account_ids(MemberAccountEc2DeepInspectionStatus) / set_account_ids(Option<Vec::<MemberAccountEc2DeepInspectionStatus>>):
    required: true
    

    The unique identifiers for the Amazon Web Services accounts to change Amazon Inspector deep inspection status for.

    
    
• On success, responds with BatchUpdateMemberEc2DeepInspectionStatusOutput with field(s):
  • account_ids(Option<Vec::<MemberAccountEc2DeepInspectionStatusState>>):

    An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status was successfully changed for.

  • failed_account_ids(Option<Vec::<FailedMemberAccountEc2DeepInspectionStatusState>>):

    An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status could not be successfully changed for.

• On failure, responds with SdkError<BatchUpdateMemberEc2DeepInspectionStatusError>

impl Client

pub fn cancel_findings_report(&self) -> CancelFindingsReportFluentBuilder

Constructs a fluent builder for the CancelFindingsReport operation.

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

    The ID of the report to be canceled.

    
    
• On success, responds with CancelFindingsReportOutput with field(s):
  • report_id(String):

    The ID of the canceled report.

• On failure, responds with SdkError<CancelFindingsReportError>

impl Client

pub fn cancel_sbom_export(&self) -> CancelSbomExportFluentBuilder

Constructs a fluent builder for the CancelSbomExport operation.

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

    The report ID of the SBOM export to cancel.

    
    
• On success, responds with CancelSbomExportOutput with field(s):
  • report_id(Option<String>):

    The report ID of the canceled SBOM export.

• On failure, responds with SdkError<CancelSbomExportError>

impl Client

pub fn create_cis_scan_configuration( &self, ) -> CreateCisScanConfigurationFluentBuilder

Constructs a fluent builder for the CreateCisScanConfiguration operation.

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

    The scan name for the CIS scan configuration.

    
    
  • security_level(CisSecurityLevel) / set_security_level(Option<CisSecurityLevel>):
    required: true
    

    The security level for the CIS scan configuration. Security level refers to the Benchmark levels that CIS assigns to a profile.

    
    
  • schedule(Schedule) / set_schedule(Option<Schedule>):
    required: true
    

    The schedule for the CIS scan configuration.

    
    
  • targets(CreateCisTargets) / set_targets(Option<CreateCisTargets>):
    required: true
    

    The targets for the CIS scan configuration.

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

    The tags for the CIS scan configuration.

    
    
• On success, responds with CreateCisScanConfigurationOutput with field(s):
  • scan_configuration_arn(Option<String>):

    The scan configuration ARN for the CIS scan configuration.

• On failure, responds with SdkError<CreateCisScanConfigurationError>

impl Client

pub fn create_filter(&self) -> CreateFilterFluentBuilder

Constructs a fluent builder for the CreateFilter operation.

• The fluent builder is configurable:
  • action(FilterAction) / set_action(Option<FilterAction>):
    required: true
    

    Defines the action that is to be applied to the findings that match the filter.

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

    A description of the filter.

    
    
  • filter_criteria(FilterCriteria) / set_filter_criteria(Option<FilterCriteria>):
    required: true
    

    Defines the criteria to be used in the filter for querying findings.

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

    The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.

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

    A list of tags for the filter.

    
    
  • reason(impl Into<String>) / set_reason(Option<String>):
    required: false
    

    The reason for creating the filter.

    
    
• On success, responds with CreateFilterOutput with field(s):
  • arn(String):

    The Amazon Resource Number (ARN) of the successfully created filter.

• On failure, responds with SdkError<CreateFilterError>

impl Client

pub fn create_findings_report(&self) -> CreateFindingsReportFluentBuilder

Constructs a fluent builder for the CreateFindingsReport operation.

• The fluent builder is configurable:
  • filter_criteria(FilterCriteria) / set_filter_criteria(Option<FilterCriteria>):
    required: false
    

    The filter criteria to apply to the results of the finding report.

    
    
  • report_format(ReportFormat) / set_report_format(Option<ReportFormat>):
    required: true
    

    The format to generate the report in.

    
    
  • s3_destination(Destination) / set_s3_destination(Option<Destination>):
    required: true
    

    The Amazon S3 export destination for the report.

    
    
• On success, responds with CreateFindingsReportOutput with field(s):
  • report_id(Option<String>):

    The ID of the report.

• On failure, responds with SdkError<CreateFindingsReportError>

impl Client

pub fn create_sbom_export(&self) -> CreateSbomExportFluentBuilder

Constructs a fluent builder for the CreateSbomExport operation.

• The fluent builder is configurable:
  • resource_filter_criteria(ResourceFilterCriteria) / set_resource_filter_criteria(Option<ResourceFilterCriteria>):
    required: false
    

    The resource filter criteria for the software bill of materials (SBOM) report.

    
    
  • report_format(SbomReportFormat) / set_report_format(Option<SbomReportFormat>):
    required: true
    

    The output format for the software bill of materials (SBOM) report.

    
    
  • s3_destination(Destination) / set_s3_destination(Option<Destination>):
    required: true
    

    Contains details of the Amazon S3 bucket and KMS key used to export findings.

    
    
• On success, responds with CreateSbomExportOutput with field(s):
  • report_id(Option<String>):

    The report ID for the software bill of materials (SBOM) report.

• On failure, responds with SdkError<CreateSbomExportError>

impl Client

pub fn delete_cis_scan_configuration( &self, ) -> DeleteCisScanConfigurationFluentBuilder

Constructs a fluent builder for the DeleteCisScanConfiguration operation.

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

    The ARN of the CIS scan configuration.

    
    
• On success, responds with DeleteCisScanConfigurationOutput with field(s):
  • scan_configuration_arn(String):

    The ARN of the CIS scan configuration.

• On failure, responds with SdkError<DeleteCisScanConfigurationError>

impl Client

pub fn delete_filter(&self) -> DeleteFilterFluentBuilder

Constructs a fluent builder for the DeleteFilter operation.

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

    The Amazon Resource Number (ARN) of the filter to be deleted.

    
    
• On success, responds with DeleteFilterOutput with field(s):
  • arn(String):

    The Amazon Resource Number (ARN) of the filter that has been deleted.

• On failure, responds with SdkError<DeleteFilterError>

impl Client

pub fn describe_organization_configuration( &self, ) -> DescribeOrganizationConfigurationFluentBuilder

Constructs a fluent builder for the DescribeOrganizationConfiguration operation.

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

    The scan types are automatically enabled for new members of your organization.

  • max_account_limit_reached(Option<bool>):

    Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.

• On failure, responds with SdkError<DescribeOrganizationConfigurationError>

impl Client

pub fn disable(&self) -> DisableFluentBuilder

Constructs a fluent builder for the Disable operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    An array of account IDs you want to disable Amazon Inspector scans for.

    
    
  • resource_types(ResourceScanType) / set_resource_types(Option<Vec::<ResourceScanType>>):
    required: false
    

    The resource scan types you want to disable.

    
    
• On success, responds with DisableOutput with field(s):
  • accounts(Vec::<Account>):

    Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are provided for each account.

  • failed_accounts(Option<Vec::<FailedAccount>>):

    Information on any accounts for which Amazon Inspector scans could not be disabled. Details are provided for each account.

• On failure, responds with SdkError<DisableError>

impl Client

pub fn disable_delegated_admin_account( &self, ) -> DisableDelegatedAdminAccountFluentBuilder

Constructs a fluent builder for the DisableDelegatedAdminAccount operation.

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

    The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.

    
    
• On success, responds with DisableDelegatedAdminAccountOutput with field(s):
  • delegated_admin_account_id(String):

    The Amazon Web Services account ID of the successfully disabled delegated administrator.

• On failure, responds with SdkError<DisableDelegatedAdminAccountError>

impl Client

pub fn disassociate_member(&self) -> DisassociateMemberFluentBuilder

Constructs a fluent builder for the DisassociateMember operation.

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

    The Amazon Web Services account ID of the member account to disassociate.

    
    
• On success, responds with DisassociateMemberOutput with field(s):
  • account_id(String):

    The Amazon Web Services account ID of the successfully disassociated member.

• On failure, responds with SdkError<DisassociateMemberError>

impl Client

pub fn enable(&self) -> EnableFluentBuilder

Constructs a fluent builder for the Enable operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    A list of account IDs you want to enable Amazon Inspector scans for.

    
    
  • resource_types(ResourceScanType) / set_resource_types(Option<Vec::<ResourceScanType>>):
    required: true
    

    The resource scan types you want to enable.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the request.

    
    
• On success, responds with EnableOutput with field(s):
  • accounts(Vec::<Account>):

    Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are provided for each account.

  • failed_accounts(Option<Vec::<FailedAccount>>):

    Information on any accounts for which Amazon Inspector scans could not be enabled. Details are provided for each account.

• On failure, responds with SdkError<EnableError>

impl Client

pub fn enable_delegated_admin_account( &self, ) -> EnableDelegatedAdminAccountFluentBuilder

Constructs a fluent builder for the EnableDelegatedAdminAccount operation.

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

    The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the request.

    
    
• On success, responds with EnableDelegatedAdminAccountOutput with field(s):
  • delegated_admin_account_id(String):

    The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.

• On failure, responds with SdkError<EnableDelegatedAdminAccountError>

impl Client

pub fn get_cis_scan_report(&self) -> GetCisScanReportFluentBuilder

Constructs a fluent builder for the GetCisScanReport operation.

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

    The scan ARN.

    
    
  • target_accounts(impl Into<String>) / set_target_accounts(Option<Vec::<String>>):
    required: false
    

    The target accounts.

    
    
  • report_format(CisReportFormat) / set_report_format(Option<CisReportFormat>):
    required: false
    

    The format of the report. Valid values are PDF and CSV. If no value is specified, the report format defaults to PDF.

    
    
• On success, responds with GetCisScanReportOutput with field(s):
  • url(Option<String>):

    The URL where a PDF or CSV of the CIS scan report can be downloaded.

  • status(Option<CisReportStatus>):

    The status.

• On failure, responds with SdkError<GetCisScanReportError>

impl Client

pub fn get_cis_scan_result_details( &self, ) -> GetCisScanResultDetailsFluentBuilder

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

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

    The scan ARN.

    
    
  • target_resource_id(impl Into<String>) / set_target_resource_id(Option<String>):
    required: true
    

    The target resource ID.

    
    
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: true
    

    The account ID.

    
    
  • filter_criteria(CisScanResultDetailsFilterCriteria) / set_filter_criteria(Option<CisScanResultDetailsFilterCriteria>):
    required: false
    

    The filter criteria.

    
    
  • sort_by(CisScanResultDetailsSortBy) / set_sort_by(Option<CisScanResultDetailsSortBy>):
    required: false
    

    The sort by order.

    
    
  • sort_order(CisSortOrder) / set_sort_order(Option<CisSortOrder>):
    required: false
    

    The sort order.

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

    The pagination token from a previous request that’s used to retrieve the next page of results.

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

    The maximum number of CIS scan result details to be returned in a single page of results.

    
    
• On success, responds with GetCisScanResultDetailsOutput with field(s):
  • scan_result_details(Option<Vec::<CisScanResultDetails>>):

    The scan result details.

  • next_token(Option<String>):

    The pagination token from a previous request that’s used to retrieve the next page of results.

• On failure, responds with SdkError<GetCisScanResultDetailsError>

impl Client

pub fn get_clusters_for_image(&self) -> GetClustersForImageFluentBuilder

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

• The fluent builder is configurable:
  • filter(ClusterForImageFilterCriteria) / set_filter(Option<ClusterForImageFilterCriteria>):
    required: true
    

    The resource Id for the Amazon ECR image.

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

    The maximum number of results to be returned in a single page of results.

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

    The pagination token from a previous request used to retrieve the next page of results.

    
    
• On success, responds with GetClustersForImageOutput with field(s):
  • cluster(Vec::<ClusterInformation>):

    A unit of work inside of a cluster, which can include metadata about the cluster.

  • next_token(Option<String>):

    The pagination token from a previous request used to retrieve the next page of results.

• On failure, responds with SdkError<GetClustersForImageError>

impl Client

pub fn get_configuration(&self) -> GetConfigurationFluentBuilder

Constructs a fluent builder for the GetConfiguration operation.

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

    Specifies how the ECR automated re-scan duration is currently configured for your environment.

  • ec2_configuration(Option<Ec2ConfigurationState>):

    Specifies how the Amazon EC2 automated scan mode is currently configured for your environment.

• On failure, responds with SdkError<GetConfigurationError>

impl Client

pub fn get_delegated_admin_account( &self, ) -> GetDelegatedAdminAccountFluentBuilder

Constructs a fluent builder for the GetDelegatedAdminAccount operation.

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

    The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

• On failure, responds with SdkError<GetDelegatedAdminAccountError>

impl Client

pub fn get_ec2_deep_inspection_configuration( &self, ) -> GetEc2DeepInspectionConfigurationFluentBuilder

Constructs a fluent builder for the GetEc2DeepInspectionConfiguration operation.

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

    The Amazon Inspector deep inspection custom paths for your account.

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

    The Amazon Inspector deep inspection custom paths for your organization.

  • status(Option<Ec2DeepInspectionStatus>):

    The activation status of Amazon Inspector deep inspection in your account.

  • error_message(Option<String>):

    An error message explaining why Amazon Inspector deep inspection configurations could not be retrieved for your account.

• On failure, responds with SdkError<GetEc2DeepInspectionConfigurationError>

impl Client

pub fn get_encryption_key(&self) -> GetEncryptionKeyFluentBuilder

Constructs a fluent builder for the GetEncryptionKey operation.

• The fluent builder is configurable:
  • scan_type(ScanType) / set_scan_type(Option<ScanType>):
    required: true
    

    The scan type the key encrypts.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: true
    

    The resource type the key encrypts.

    
    
• On success, responds with GetEncryptionKeyOutput with field(s):
  • kms_key_id(String):

    A kms key ID.

• On failure, responds with SdkError<GetEncryptionKeyError>

impl Client

pub fn get_findings_report_status(&self) -> GetFindingsReportStatusFluentBuilder

Constructs a fluent builder for the GetFindingsReportStatus operation.

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

    The ID of the report to retrieve the status of.

    
    
• On success, responds with GetFindingsReportStatusOutput with field(s):
  • report_id(Option<String>):

    The ID of the report.

  • status(Option<ExternalReportStatus>):

    The status of the report.

  • error_code(Option<ReportingErrorCode>):

    The error code of the report.

  • error_message(Option<String>):

    The error message of the report.

  • destination(Option<Destination>):

    The destination of the report.

  • filter_criteria(Option<FilterCriteria>):

    The filter criteria associated with the report.

• On failure, responds with SdkError<GetFindingsReportStatusError>

impl Client

pub fn get_member(&self) -> GetMemberFluentBuilder

Constructs a fluent builder for the GetMember operation.

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

    The Amazon Web Services account ID of the member account to retrieve information on.

    
    
• On success, responds with GetMemberOutput with field(s):
  • member(Option<Member>):

    Details of the retrieved member account.

• On failure, responds with SdkError<GetMemberError>

impl Client

pub fn get_sbom_export(&self) -> GetSbomExportFluentBuilder

Constructs a fluent builder for the GetSbomExport operation.

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

    The report ID of the SBOM export to get details for.

    
    
• On success, responds with GetSbomExportOutput with field(s):
  • report_id(Option<String>):

    The report ID of the software bill of materials (SBOM) report.

  • format(Option<SbomReportFormat>):

    The format of the software bill of materials (SBOM) report.

  • status(Option<ExternalReportStatus>):

    The status of the software bill of materials (SBOM) report.

  • error_code(Option<ReportingErrorCode>):

    An error code.

  • error_message(Option<String>):

    An error message.

  • s3_destination(Option<Destination>):

    Contains details of the Amazon S3 bucket and KMS key used to export findings

  • filter_criteria(Option<ResourceFilterCriteria>):

    Contains details about the resource filter criteria used for the software bill of materials (SBOM) report.

• On failure, responds with SdkError<GetSbomExportError>

impl Client

pub fn list_account_permissions(&self) -> ListAccountPermissionsFluentBuilder

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

• The fluent builder is configurable:
  • service(Service) / set_service(Option<Service>):
    required: false
    

    The service scan type to check permissions for.

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

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with ListAccountPermissionsOutput with field(s):
  • permissions(Vec::<Permission>):

    Contains details on the permissions an account has to configure Amazon Inspector.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

• On failure, responds with SdkError<ListAccountPermissionsError>

impl Client

pub fn list_cis_scan_configurations( &self, ) -> ListCisScanConfigurationsFluentBuilder

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

• The fluent builder is configurable:
  • filter_criteria(ListCisScanConfigurationsFilterCriteria) / set_filter_criteria(Option<ListCisScanConfigurationsFilterCriteria>):
    required: false
    

    The CIS scan configuration filter criteria.

    
    
  • sort_by(CisScanConfigurationsSortBy) / set_sort_by(Option<CisScanConfigurationsSortBy>):
    required: false
    

    The CIS scan configuration sort by order.

    
    
  • sort_order(CisSortOrder) / set_sort_order(Option<CisSortOrder>):
    required: false
    

    The CIS scan configuration sort order order.

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

    The pagination token from a previous request that’s used to retrieve the next page of results.

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

    The maximum number of CIS scan configurations to be returned in a single page of results.

    
    
• On success, responds with ListCisScanConfigurationsOutput with field(s):
  • scan_configurations(Option<Vec::<CisScanConfiguration>>):

    The CIS scan configuration scan configurations.

  • next_token(Option<String>):

    The pagination token from a previous request that’s used to retrieve the next page of results.

• On failure, responds with SdkError<ListCisScanConfigurationsError>

impl Client

pub fn list_cis_scan_results_aggregated_by_checks( &self, ) -> ListCisScanResultsAggregatedByChecksFluentBuilder

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

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

    The scan ARN.

    
    
  • filter_criteria(CisScanResultsAggregatedByChecksFilterCriteria) / set_filter_criteria(Option<CisScanResultsAggregatedByChecksFilterCriteria>):
    required: false
    

    The filter criteria.

    
    
  • sort_by(CisScanResultsAggregatedByChecksSortBy) / set_sort_by(Option<CisScanResultsAggregatedByChecksSortBy>):
    required: false
    

    The sort by order.

    
    
  • sort_order(CisSortOrder) / set_sort_order(Option<CisSortOrder>):
    required: false
    

    The sort order.

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

    The pagination token from a previous request that’s used to retrieve the next page of results.

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

    The maximum number of scan results aggregated by checks to be returned in a single page of results.

    
    
• On success, responds with ListCisScanResultsAggregatedByChecksOutput with field(s):
  • check_aggregations(Option<Vec::<CisCheckAggregation>>):

    The check aggregations.

  • next_token(Option<String>):

    The pagination token from a previous request that’s used to retrieve the next page of results.

• On failure, responds with SdkError<ListCisScanResultsAggregatedByChecksError>

impl Client

pub fn list_cis_scan_results_aggregated_by_target_resource( &self, ) -> ListCisScanResultsAggregatedByTargetResourceFluentBuilder

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

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

    The scan ARN.

    
    
  • filter_criteria(CisScanResultsAggregatedByTargetResourceFilterCriteria) / set_filter_criteria(Option<CisScanResultsAggregatedByTargetResourceFilterCriteria>):
    required: false
    

    The filter criteria.

    
    
  • sort_by(CisScanResultsAggregatedByTargetResourceSortBy) / set_sort_by(Option<CisScanResultsAggregatedByTargetResourceSortBy>):
    required: false
    

    The sort by order.

    
    
  • sort_order(CisSortOrder) / set_sort_order(Option<CisSortOrder>):
    required: false
    

    The sort order.

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

    The pagination token from a previous request that’s used to retrieve the next page of results.

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

    The maximum number of scan results aggregated by a target resource to be returned in a single page of results.

    
    
• On success, responds with ListCisScanResultsAggregatedByTargetResourceOutput with field(s):
  • target_resource_aggregations(Option<Vec::<CisTargetResourceAggregation>>):

    The resource aggregations.

  • next_token(Option<String>):

    The pagination token from a previous request that’s used to retrieve the next page of results.

• On failure, responds with SdkError<ListCisScanResultsAggregatedByTargetResourceError>

impl Client

pub fn list_cis_scans(&self) -> ListCisScansFluentBuilder

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

• The fluent builder is configurable:
  • filter_criteria(ListCisScansFilterCriteria) / set_filter_criteria(Option<ListCisScansFilterCriteria>):
    required: false
    

    The CIS scan filter criteria.

    
    
  • detail_level(ListCisScansDetailLevel) / set_detail_level(Option<ListCisScansDetailLevel>):
    required: false
    

    The detail applied to the CIS scan.

    
    
  • sort_by(ListCisScansSortBy) / set_sort_by(Option<ListCisScansSortBy>):
    required: false
    

    The CIS scans sort by order.

    
    
  • sort_order(CisSortOrder) / set_sort_order(Option<CisSortOrder>):
    required: false
    

    The CIS scans sort order.

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

    The pagination token from a previous request that’s used to retrieve the next page of results.

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

    The maximum number of results to be returned.

    
    
• On success, responds with ListCisScansOutput with field(s):
  • scans(Option<Vec::<CisScan>>):

    The CIS scans.

  • next_token(Option<String>):

    The pagination token from a previous request that’s used to retrieve the next page of results.

• On failure, responds with SdkError<ListCisScansError>

impl Client

pub fn list_coverage(&self) -> ListCoverageFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

    
    
  • filter_criteria(CoverageFilterCriteria) / set_filter_criteria(Option<CoverageFilterCriteria>):
    required: false
    

    An object that contains details on the filters to apply to the coverage data for your environment.

    
    
• On success, responds with ListCoverageOutput with field(s):
  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

  • covered_resources(Option<Vec::<CoveredResource>>):

    An object that contains details on the covered resources in your environment.

• On failure, responds with SdkError<ListCoverageError>

impl Client

pub fn list_coverage_statistics(&self) -> ListCoverageStatisticsFluentBuilder

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

• The fluent builder is configurable:
  • filter_criteria(CoverageFilterCriteria) / set_filter_criteria(Option<CoverageFilterCriteria>):
    required: false
    

    An object that contains details on the filters to apply to the coverage data for your environment.

    
    
  • group_by(GroupKey) / set_group_by(Option<GroupKey>):
    required: false
    

    The value to group the results by.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with ListCoverageStatisticsOutput with field(s):
  • counts_by_group(Option<Vec::<Counts>>):

    An array with the number for each group.

  • total_counts(i64):

    The total number for all groups.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

• On failure, responds with SdkError<ListCoverageStatisticsError>

impl Client

pub fn list_delegated_admin_accounts( &self, ) -> ListDelegatedAdminAccountsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with ListDelegatedAdminAccountsOutput with field(s):
  • delegated_admin_accounts(Option<Vec::<DelegatedAdminAccount>>):

    Details of the Amazon Inspector delegated administrator of your organization.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

• On failure, responds with SdkError<ListDelegatedAdminAccountsError>

impl Client

pub fn list_filters(&self) -> ListFiltersFluentBuilder

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

• The fluent builder is configurable:
  • arns(impl Into<String>) / set_arns(Option<Vec::<String>>):
    required: false
    

    The Amazon resource number (ARN) of the filter.

    
    
  • action(FilterAction) / set_action(Option<FilterAction>):
    required: false
    

    The action the filter applies to matched findings.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

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

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

    
    
• On success, responds with ListFiltersOutput with field(s):
  • filters(Vec::<Filter>):

    Contains details on the filters associated with your account.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

• On failure, responds with SdkError<ListFiltersError>

impl Client

pub fn list_finding_aggregations(&self) -> ListFindingAggregationsFluentBuilder

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

• The fluent builder is configurable:
  • aggregation_type(AggregationType) / set_aggregation_type(Option<AggregationType>):
    required: true
    

    The type of the aggregation request.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

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

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

    
    
  • account_ids(StringFilter) / set_account_ids(Option<Vec::<StringFilter>>):
    required: false
    

    The Amazon Web Services account IDs to retrieve finding aggregation data for.

    
    
  • aggregation_request(AggregationRequest) / set_aggregation_request(Option<AggregationRequest>):
    required: false
    

    Details of the aggregation request that is used to filter your aggregation results.

    
    
• On success, responds with ListFindingAggregationsOutput with field(s):
  • aggregation_type(AggregationType):

    The type of aggregation to perform.

  • responses(Option<Vec::<AggregationResponse>>):

    Objects that contain the results of an aggregation operation.

  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

• On failure, responds with SdkError<ListFindingAggregationsError>

impl Client

pub fn list_findings(&self) -> ListFindingsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

    
    
  • filter_criteria(FilterCriteria) / set_filter_criteria(Option<FilterCriteria>):
    required: false
    

    Details on the filters to apply to your finding results.

    
    
  • sort_criteria(SortCriteria) / set_sort_criteria(Option<SortCriteria>):
    required: false
    

    Details on the sort criteria to apply to your finding results.

    
    
• On success, responds with ListFindingsOutput with field(s):
  • next_token(Option<String>):

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

  • findings(Option<Vec::<Finding>>):

    Contains details on the findings in your environment.

• On failure, responds with SdkError<ListFindingsError>

impl Client

pub fn list_members(&self) -> ListMembersFluentBuilder

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

• The fluent builder is configurable:
  • only_associated(bool) / set_only_associated(Option<bool>):
    required: false
    

    Specifies whether to list only currently associated members if True or to list all members within the organization if False.

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

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with ListMembersOutput with field(s):
  • members(Option<Vec::<Member>>):

    An object that contains details for each member account.

  • next_token(Option<String>):

    The pagination parameter to be used on the next list operation to retrieve more items.

• On failure, responds with SdkError<ListMembersError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

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 number (ARN) of the resource to list tags of.

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

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_usage_totals(&self) -> ListUsageTotalsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    The Amazon Web Services account IDs to retrieve usage totals for.

    
    
• On success, responds with ListUsageTotalsOutput with field(s):
  • next_token(Option<String>):

    The pagination parameter to be used on the next list operation to retrieve more items.

  • totals(Option<Vec::<UsageTotal>>):

    An object with details on the total usage for the requested account.

• On failure, responds with SdkError<ListUsageTotalsError>

impl Client

pub fn reset_encryption_key(&self) -> ResetEncryptionKeyFluentBuilder

Constructs a fluent builder for the ResetEncryptionKey operation.

• The fluent builder is configurable:
  • scan_type(ScanType) / set_scan_type(Option<ScanType>):
    required: true
    

    The scan type the key encrypts.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: true
    

    The resource type the key encrypts.

    
    
• On success, responds with ResetEncryptionKeyOutput
• On failure, responds with SdkError<ResetEncryptionKeyError>

impl Client

pub fn search_vulnerabilities(&self) -> SearchVulnerabilitiesFluentBuilder

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

• The fluent builder is configurable:
  • filter_criteria(SearchVulnerabilitiesFilterCriteria) / set_filter_criteria(Option<SearchVulnerabilitiesFilterCriteria>):
    required: true
    

    The criteria used to filter the results of a vulnerability search.

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

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with SearchVulnerabilitiesOutput with field(s):
  • vulnerabilities(Vec::<Vulnerability>):

    Details about the listed vulnerability.

  • next_token(Option<String>):

    The pagination parameter to be used on the next list operation to retrieve more items.

• On failure, responds with SdkError<SearchVulnerabilitiesError>

impl Client

pub fn send_cis_session_health(&self) -> SendCisSessionHealthFluentBuilder

Constructs a fluent builder for the SendCisSessionHealth operation.

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

    A unique identifier for the scan job.

    
    
  • session_token(impl Into<String>) / set_session_token(Option<String>):
    required: true
    

    The unique token that identifies the CIS session.

    
    
• On success, responds with SendCisSessionHealthOutput
• On failure, responds with SdkError<SendCisSessionHealthError>

impl Client

pub fn send_cis_session_telemetry(&self) -> SendCisSessionTelemetryFluentBuilder

Constructs a fluent builder for the SendCisSessionTelemetry operation.

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

    A unique identifier for the scan job.

    
    
  • session_token(impl Into<String>) / set_session_token(Option<String>):
    required: true
    

    The unique token that identifies the CIS session.

    
    
  • messages(CisSessionMessage) / set_messages(Option<Vec::<CisSessionMessage>>):
    required: true
    

    The CIS session telemetry messages.

    
    
• On success, responds with SendCisSessionTelemetryOutput
• On failure, responds with SdkError<SendCisSessionTelemetryError>

impl Client

pub fn start_cis_session(&self) -> StartCisSessionFluentBuilder

Constructs a fluent builder for the StartCisSession operation.

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

    A unique identifier for the scan job.

    
    
  • message(StartCisSessionMessage) / set_message(Option<StartCisSessionMessage>):
    required: true
    

    The start CIS session message.

    
    
• On success, responds with StartCisSessionOutput
• On failure, responds with SdkError<StartCisSessionError>

impl Client

pub fn stop_cis_session(&self) -> StopCisSessionFluentBuilder

Constructs a fluent builder for the StopCisSession operation.

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

    A unique identifier for the scan job.

    
    
  • session_token(impl Into<String>) / set_session_token(Option<String>):
    required: true
    

    The unique token that identifies the CIS session.

    
    
  • message(StopCisSessionMessage) / set_message(Option<StopCisSessionMessage>):
    required: true
    

    The stop CIS session message.

    
    
• On success, responds with StopCisSessionOutput
• On failure, responds with SdkError<StopCisSessionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

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 to apply a tag to.

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

    The tags to be added to a resource.

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

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) for the resource to remove tags from.

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

    The tag keys to remove from the resource.

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

impl Client

pub fn update_cis_scan_configuration( &self, ) -> UpdateCisScanConfigurationFluentBuilder

Constructs a fluent builder for the UpdateCisScanConfiguration operation.

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

    The CIS scan configuration ARN.

    
    
  • scan_name(impl Into<String>) / set_scan_name(Option<String>):
    required: false
    

    The scan name for the CIS scan configuration.

    
    
  • security_level(CisSecurityLevel) / set_security_level(Option<CisSecurityLevel>):
    required: false
    

    The security level for the CIS scan configuration. Security level refers to the Benchmark levels that CIS assigns to a profile.

    
    
  • schedule(Schedule) / set_schedule(Option<Schedule>):
    required: false
    

    The schedule for the CIS scan configuration.

    
    
  • targets(UpdateCisTargets) / set_targets(Option<UpdateCisTargets>):
    required: false
    

    The targets for the CIS scan configuration.

    
    
• On success, responds with UpdateCisScanConfigurationOutput with field(s):
  • scan_configuration_arn(String):

    The CIS scan configuration ARN.

• On failure, responds with SdkError<UpdateCisScanConfigurationError>

impl Client

pub fn update_configuration(&self) -> UpdateConfigurationFluentBuilder

Constructs a fluent builder for the UpdateConfiguration operation.

• The fluent builder is configurable:
  • ecr_configuration(EcrConfiguration) / set_ecr_configuration(Option<EcrConfiguration>):
    required: false
    

    Specifies how the ECR automated re-scan will be updated for your environment.

    
    
  • ec2_configuration(Ec2Configuration) / set_ec2_configuration(Option<Ec2Configuration>):
    required: false
    

    Specifies how the Amazon EC2 automated scan will be updated for your environment.

    
    
• On success, responds with UpdateConfigurationOutput
• On failure, responds with SdkError<UpdateConfigurationError>

impl Client

pub fn update_ec2_deep_inspection_configuration( &self, ) -> UpdateEc2DeepInspectionConfigurationFluentBuilder

Constructs a fluent builder for the UpdateEc2DeepInspectionConfiguration operation.

• The fluent builder is configurable:
  • activate_deep_inspection(bool) / set_activate_deep_inspection(Option<bool>):
    required: false
    

    Specify TRUE to activate Amazon Inspector deep inspection in your account, or FALSE to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using BatchUpdateMemberEc2DeepInspectionStatus.

    
    
  • package_paths(impl Into<String>) / set_package_paths(Option<Vec::<String>>):
    required: false
    

    The Amazon Inspector deep inspection custom paths you are adding for your account.

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

    The current Amazon Inspector deep inspection custom paths for your account.

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

    The current Amazon Inspector deep inspection custom paths for the organization.

  • status(Option<Ec2DeepInspectionStatus>):

    The status of Amazon Inspector deep inspection in your account.

  • error_message(Option<String>):

    An error message explaining why new Amazon Inspector deep inspection custom paths could not be added.

• On failure, responds with SdkError<UpdateEc2DeepInspectionConfigurationError>

impl Client

pub fn update_encryption_key(&self) -> UpdateEncryptionKeyFluentBuilder

Constructs a fluent builder for the UpdateEncryptionKey operation.

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

    A KMS key ID for the encryption key.

    
    
  • scan_type(ScanType) / set_scan_type(Option<ScanType>):
    required: true
    

    The scan type for the encryption key.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: true
    

    The resource type for the encryption key.

    
    
• On success, responds with UpdateEncryptionKeyOutput
• On failure, responds with SdkError<UpdateEncryptionKeyError>

impl Client

pub fn update_filter(&self) -> UpdateFilterFluentBuilder

Constructs a fluent builder for the UpdateFilter operation.

• The fluent builder is configurable:
  • action(FilterAction) / set_action(Option<FilterAction>):
    required: false
    

    Specifies the action that is to be applied to the findings that match the filter.

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

    A description of the filter.

    
    
  • filter_criteria(FilterCriteria) / set_filter_criteria(Option<FilterCriteria>):
    required: false
    

    Defines the criteria to be update in the filter.

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

    The name of the filter.

    
    
  • filter_arn(impl Into<String>) / set_filter_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the filter to update.

    
    
  • reason(impl Into<String>) / set_reason(Option<String>):
    required: false
    

    The reason the filter was updated.

    
    
• On success, responds with UpdateFilterOutput with field(s):
  • arn(String):

    The Amazon Resource Number (ARN) of the successfully updated filter.

• On failure, responds with SdkError<UpdateFilterError>

impl Client

pub fn update_org_ec2_deep_inspection_configuration( &self, ) -> UpdateOrgEc2DeepInspectionConfigurationFluentBuilder

Constructs a fluent builder for the UpdateOrgEc2DeepInspectionConfiguration operation.

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

    The Amazon Inspector deep inspection custom paths you are adding for your organization.

    
    
• On success, responds with UpdateOrgEc2DeepInspectionConfigurationOutput
• On failure, responds with SdkError<UpdateOrgEc2DeepInspectionConfigurationError>

impl Client

pub fn update_organization_configuration( &self, ) -> UpdateOrganizationConfigurationFluentBuilder

Constructs a fluent builder for the UpdateOrganizationConfiguration operation.

• The fluent builder is configurable:
  • auto_enable(AutoEnable) / set_auto_enable(Option<AutoEnable>):
    required: true
    

    Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.

    
    
• On success, responds with UpdateOrganizationConfigurationOutput with field(s):
  • auto_enable(Option<AutoEnable>):

    The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.

• On failure, responds with SdkError<UpdateOrganizationConfigurationError>

impl Client

pub fn from_conf(conf: Config) -> Self

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.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

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.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.