pub struct Client { /* private fields */ }
Expand description

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 Config 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§

source§

impl Client

source

pub fn associate_member(&self) -> AssociateMemberFluentBuilder

Constructs a fluent builder for the AssociateMember operation.

source§

impl Client

source

pub fn batch_get_account_status(&self) -> BatchGetAccountStatusFluentBuilder

Constructs a fluent builder for the BatchGetAccountStatus operation.

source§

impl Client

source

pub fn batch_get_code_snippet(&self) -> BatchGetCodeSnippetFluentBuilder

Constructs a fluent builder for the BatchGetCodeSnippet operation.

source§

impl Client

source

pub fn batch_get_finding_details(&self) -> BatchGetFindingDetailsFluentBuilder

Constructs a fluent builder for the BatchGetFindingDetails operation.

source§

impl Client

source

pub fn batch_get_free_trial_info(&self) -> BatchGetFreeTrialInfoFluentBuilder

Constructs a fluent builder for the BatchGetFreeTrialInfo operation.

source§

impl Client

source

pub fn batch_get_member_ec2_deep_inspection_status( &self ) -> BatchGetMemberEc2DeepInspectionStatusFluentBuilder

Constructs a fluent builder for the BatchGetMemberEc2DeepInspectionStatus operation.

source§

impl Client

source

pub fn batch_update_member_ec2_deep_inspection_status( &self ) -> BatchUpdateMemberEc2DeepInspectionStatusFluentBuilder

Constructs a fluent builder for the BatchUpdateMemberEc2DeepInspectionStatus operation.

source§

impl Client

source

pub fn cancel_findings_report(&self) -> CancelFindingsReportFluentBuilder

Constructs a fluent builder for the CancelFindingsReport operation.

source§

impl Client

source

pub fn cancel_sbom_export(&self) -> CancelSbomExportFluentBuilder

Constructs a fluent builder for the CancelSbomExport operation.

source§

impl Client

source

pub fn create_cis_scan_configuration( &self ) -> CreateCisScanConfigurationFluentBuilder

Constructs a fluent builder for the CreateCisScanConfiguration operation.

source§

impl Client

source

pub fn create_filter(&self) -> CreateFilterFluentBuilder

Constructs a fluent builder for the CreateFilter operation.

source§

impl Client

source

pub fn create_findings_report(&self) -> CreateFindingsReportFluentBuilder

Constructs a fluent builder for the CreateFindingsReport operation.

source§

impl Client

source

pub fn create_sbom_export(&self) -> CreateSbomExportFluentBuilder

Constructs a fluent builder for the CreateSbomExport operation.

source§

impl Client

source

pub fn delete_cis_scan_configuration( &self ) -> DeleteCisScanConfigurationFluentBuilder

Constructs a fluent builder for the DeleteCisScanConfiguration operation.

source§

impl Client

source

pub fn delete_filter(&self) -> DeleteFilterFluentBuilder

Constructs a fluent builder for the DeleteFilter operation.

source§

impl Client

source

pub fn describe_organization_configuration( &self ) -> DescribeOrganizationConfigurationFluentBuilder

Constructs a fluent builder for the DescribeOrganizationConfiguration operation.

source§

impl Client

source

pub fn disable(&self) -> DisableFluentBuilder

Constructs a fluent builder for the Disable operation.

source§

impl Client

source

pub fn disable_delegated_admin_account( &self ) -> DisableDelegatedAdminAccountFluentBuilder

Constructs a fluent builder for the DisableDelegatedAdminAccount operation.

source§

impl Client

source

pub fn disassociate_member(&self) -> DisassociateMemberFluentBuilder

Constructs a fluent builder for the DisassociateMember operation.

source§

impl Client

source

pub fn enable(&self) -> EnableFluentBuilder

Constructs a fluent builder for the Enable operation.

source§

impl Client

source

pub fn enable_delegated_admin_account( &self ) -> EnableDelegatedAdminAccountFluentBuilder

Constructs a fluent builder for the EnableDelegatedAdminAccount operation.

source§

impl Client

source

pub fn get_cis_scan_report(&self) -> GetCisScanReportFluentBuilder

Constructs a fluent builder for the GetCisScanReport operation.

source§

impl Client

source

pub fn get_cis_scan_result_details( &self ) -> GetCisScanResultDetailsFluentBuilder

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

source§

impl Client

source

pub fn get_configuration(&self) -> GetConfigurationFluentBuilder

Constructs a fluent builder for the GetConfiguration operation.

source§

impl Client

source

pub fn get_delegated_admin_account( &self ) -> GetDelegatedAdminAccountFluentBuilder

Constructs a fluent builder for the GetDelegatedAdminAccount operation.

source§

impl Client

source

pub fn get_ec2_deep_inspection_configuration( &self ) -> GetEc2DeepInspectionConfigurationFluentBuilder

Constructs a fluent builder for the GetEc2DeepInspectionConfiguration operation.

source§

impl Client

source

pub fn get_encryption_key(&self) -> GetEncryptionKeyFluentBuilder

Constructs a fluent builder for the GetEncryptionKey operation.

source§

impl Client

source

pub fn get_findings_report_status(&self) -> GetFindingsReportStatusFluentBuilder

Constructs a fluent builder for the GetFindingsReportStatus operation.

source§

impl Client

source

pub fn get_member(&self) -> GetMemberFluentBuilder

Constructs a fluent builder for the GetMember operation.

source§

impl Client

source

pub fn get_sbom_export(&self) -> GetSbomExportFluentBuilder

Constructs a fluent builder for the GetSbomExport operation.

source§

impl Client

source

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>
source§

impl Client

source

pub fn list_cis_scan_configurations( &self ) -> ListCisScanConfigurationsFluentBuilder

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

source§

impl Client

source

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

source§

impl Client

source

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

source§

impl Client

source

pub fn list_cis_scans(&self) -> ListCisScansFluentBuilder

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

source§

impl Client

source

pub fn list_coverage(&self) -> ListCoverageFluentBuilder

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

source§

impl Client

source

pub fn list_coverage_statistics(&self) -> ListCoverageStatisticsFluentBuilder

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

source§

impl Client

source

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>
source§

impl Client

source

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:
  • 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>
source§

impl Client

source

pub fn list_finding_aggregations(&self) -> ListFindingAggregationsFluentBuilder

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

source§

impl Client

source

pub fn list_findings(&self) -> ListFindingsFluentBuilder

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

source§

impl Client

source

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):
  • On failure, responds with SdkError<ListMembersError>
source§

impl Client

source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

source§

impl Client

source

pub fn list_usage_totals(&self) -> ListUsageTotalsFluentBuilder

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

source§

impl Client

source

pub fn reset_encryption_key(&self) -> ResetEncryptionKeyFluentBuilder

Constructs a fluent builder for the ResetEncryptionKey operation.

source§

impl Client

source

pub fn search_vulnerabilities(&self) -> SearchVulnerabilitiesFluentBuilder

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

source§

impl Client

source

pub fn send_cis_session_health(&self) -> SendCisSessionHealthFluentBuilder

Constructs a fluent builder for the SendCisSessionHealth operation.

source§

impl Client

source

pub fn send_cis_session_telemetry(&self) -> SendCisSessionTelemetryFluentBuilder

Constructs a fluent builder for the SendCisSessionTelemetry operation.

source§

impl Client

source

pub fn start_cis_session(&self) -> StartCisSessionFluentBuilder

Constructs a fluent builder for the StartCisSession operation.

source§

impl Client

source

pub fn stop_cis_session(&self) -> StopCisSessionFluentBuilder

Constructs a fluent builder for the StopCisSession operation.

source§

impl Client

source

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

source§

impl Client

source

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

source§

impl Client

source

pub fn update_cis_scan_configuration( &self ) -> UpdateCisScanConfigurationFluentBuilder

Constructs a fluent builder for the UpdateCisScanConfiguration operation.

source§

impl Client

source

pub fn update_configuration(&self) -> UpdateConfigurationFluentBuilder

Constructs a fluent builder for the UpdateConfiguration operation.

source§

impl Client

source

pub fn update_ec2_deep_inspection_configuration( &self ) -> UpdateEc2DeepInspectionConfigurationFluentBuilder

Constructs a fluent builder for the UpdateEc2DeepInspectionConfiguration operation.

source§

impl Client

source

pub fn update_encryption_key(&self) -> UpdateEncryptionKeyFluentBuilder

Constructs a fluent builder for the UpdateEncryptionKey operation.

source§

impl Client

source

pub fn update_filter(&self) -> UpdateFilterFluentBuilder

Constructs a fluent builder for the UpdateFilter operation.

source§

impl Client

source

pub fn update_org_ec2_deep_inspection_configuration( &self ) -> UpdateOrgEc2DeepInspectionConfigurationFluentBuilder

Constructs a fluent builder for the UpdateOrgEc2DeepInspectionConfiguration operation.

source§

impl Client

source

pub fn update_organization_configuration( &self ) -> UpdateOrganizationConfigurationFluentBuilder

Constructs a fluent builder for the UpdateOrganizationConfiguration operation.

source§

impl Client

source

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.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more