Struct aws_sdk_securityhub::client::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Client for AWS SecurityHub

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

Examples

Constructing a client and invoking an operation

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

Constructing a client with custom configuration

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

Implementations§

source §

impl Client

source

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

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source §

impl Client

source

pub fn accept_administrator_invitation(&self) -> AcceptAdministratorInvitation

Constructs a fluent builder for the AcceptAdministratorInvitation operation.

The fluent builder is configurable:
- administrator_id(impl Into<String>) / set_administrator_id(Option<String>):
 The account ID of the Security Hub administrator account that sent the invitation.
- invitation_id(impl Into<String>) / set_invitation_id(Option<String>):
 The identifier of the invitation sent from the Security Hub administrator account.
On success, responds with AcceptAdministratorInvitationOutput
On failure, responds with SdkError<AcceptAdministratorInvitationError>

source

pub fn accept_invitation(&self) -> AcceptInvitation

Constructs a fluent builder for the AcceptInvitation operation.

The fluent builder is configurable:
- master_id(impl Into<String>) / set_master_id(Option<String>):
 The account ID of the Security Hub administrator account that sent the invitation.
- invitation_id(impl Into<String>) / set_invitation_id(Option<String>):
 The identifier of the invitation sent from the Security Hub administrator account.
On success, responds with AcceptInvitationOutput
On failure, responds with SdkError<AcceptInvitationError>

source

pub fn batch_disable_standards(&self) -> BatchDisableStandards

Constructs a fluent builder for the BatchDisableStandards operation.

The fluent builder is configurable:
- standards_subscription_arns(Vec<String>) / set_standards_subscription_arns(Option<Vec<String>>):
 The ARNs of the standards subscriptions to disable.
On success, responds with BatchDisableStandardsOutput with field(s):
- standards_subscriptions(Option<Vec<StandardsSubscription>>):
 The details of the standards subscriptions that were disabled.
On failure, responds with SdkError<BatchDisableStandardsError>

source

pub fn batch_enable_standards(&self) -> BatchEnableStandards

Constructs a fluent builder for the BatchEnableStandards operation.

The fluent builder is configurable:
- standards_subscription_requests(Vec<StandardsSubscriptionRequest>) / set_standards_subscription_requests(Option<Vec<StandardsSubscriptionRequest>>):
 The list of standards checks to enable.
On success, responds with BatchEnableStandardsOutput with field(s):
- standards_subscriptions(Option<Vec<StandardsSubscription>>):
 The details of the standards subscriptions that were enabled.
On failure, responds with SdkError<BatchEnableStandardsError>

source

pub fn batch_import_findings(&self) -> BatchImportFindings

Constructs a fluent builder for the BatchImportFindings operation.

The fluent builder is configurable:
- findings(Vec<AwsSecurityFinding>) / set_findings(Option<Vec<AwsSecurityFinding>>):
 A list of findings to import. To successfully import a finding, it must follow the Amazon Web Services Security Finding Format. Maximum of 100 findings per request.
On success, responds with BatchImportFindingsOutput with field(s):
- failed_count(i32):
 The number of findings that failed to import.
- success_count(i32):
 The number of findings that were successfully imported.
- failed_findings(Option<Vec<ImportFindingsError>>):
 The list of findings that failed to import.
On failure, responds with SdkError<BatchImportFindingsError>

source

pub fn batch_update_findings(&self) -> BatchUpdateFindings

Constructs a fluent builder for the BatchUpdateFindings operation.

The fluent builder is configurable:
- finding_identifiers(Vec<AwsSecurityFindingIdentifier>) / set_finding_identifiers(Option<Vec<AwsSecurityFindingIdentifier>>):
 The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.
 
 For each finding, the list provides the finding identifier and the ARN of the finding provider.
- note(NoteUpdate) / set_note(Option<NoteUpdate>):
 The updated note.
- severity(SeverityUpdate) / set_severity(Option<SeverityUpdate>):
 Used to update the finding severity.
- verification_state(VerificationState) / set_verification_state(Option<VerificationState>):
 Indicates the veracity of a finding.
 
 The available values for VerificationState are as follows.
 - UNKNOWN – The default disposition of a security finding
 - TRUE_POSITIVE – The security finding is confirmed
 - FALSE_POSITIVE – The security finding was determined to be a false alarm
 - BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn’t pose any threat, is expected, or both
- confidence(i32) / set_confidence(i32):
 The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
 
 Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
- criticality(i32) / set_criticality(i32):
 The updated value for the level of importance assigned to the resources associated with the findings.
 
 A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- types(Vec<String>) / set_types(Option<Vec<String>>):
 One or more finding types in the format of namespace/category/classifier that classify a finding.
 
 Valid namespace values are as follows.
 - Software and Configuration Checks
 - TTPs
 - Effects
 - Unusual Behaviors
 - Sensitive Data Identifications
- user_defined_fields(HashMap<String, String>) / set_user_defined_fields(Option<HashMap<String, String>>):
 A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
- workflow(WorkflowUpdate) / set_workflow(Option<WorkflowUpdate>):
 Used to update the workflow status of a finding.
 
 The workflow status indicates the progress of the investigation into the finding.
- related_findings(Vec<RelatedFinding>) / set_related_findings(Option<Vec<RelatedFinding>>):
 A list of findings that are related to the updated findings.
On success, responds with BatchUpdateFindingsOutput with field(s):
- processed_findings(Option<Vec<AwsSecurityFindingIdentifier>>):
 The list of findings that were updated successfully.
- unprocessed_findings(Option<Vec<BatchUpdateFindingsUnprocessedFinding>>):
 The list of findings that were not updated.
On failure, responds with SdkError<BatchUpdateFindingsError>

source

pub fn create_action_target(&self) -> CreateActionTarget

Constructs a fluent builder for the CreateActionTarget operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the custom action target. Can contain up to 20 characters.
- description(impl Into<String>) / set_description(Option<String>):
 The description for the custom action target.
- id(impl Into<String>) / set_id(Option<String>):
 The ID for the custom action target. Can contain up to 20 alphanumeric characters.
On success, responds with CreateActionTargetOutput with field(s):
- action_target_arn(Option<String>):
 The ARN for the custom action target.
On failure, responds with SdkError<CreateActionTargetError>

source

pub fn create_finding_aggregator(&self) -> CreateFindingAggregator

Constructs a fluent builder for the CreateFindingAggregator operation.

The fluent builder is configurable:
- region_linking_mode(impl Into<String>) / set_region_linking_mode(Option<String>):
 Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
 
 The selected option also determines how to use the Regions provided in the Regions list.
 
 The options are as follows:
 - ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
 - ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
 - SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
- regions(Vec<String>) / set_regions(Option<Vec<String>>):
 If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.
 
 If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
On success, responds with CreateFindingAggregatorOutput with field(s):
- finding_aggregator_arn(Option<String>):
 The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.
- finding_aggregation_region(Option<String>):
 The aggregation Region.
- region_linking_mode(Option<String>):
 Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
- regions(Option<Vec<String>>):
 The list of excluded Regions or included Regions.
On failure, responds with SdkError<CreateFindingAggregatorError>

source

pub fn create_insight(&self) -> CreateInsight

Constructs a fluent builder for the CreateInsight operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the custom insight to create.
- filters(AwsSecurityFindingFilters) / set_filters(Option<AwsSecurityFindingFilters>):
 One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.
- group_by_attribute(impl Into<String>) / set_group_by_attribute(Option<String>):
 The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
On success, responds with CreateInsightOutput with field(s):
- insight_arn(Option<String>):
 The ARN of the insight created.
On failure, responds with SdkError<CreateInsightError>

source

pub fn create_members(&self) -> CreateMembers

Constructs a fluent builder for the CreateMembers operation.

The fluent builder is configurable:
- account_details(Vec<AccountDetails>) / set_account_details(Option<Vec<AccountDetails>>):
 The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.
On success, responds with CreateMembersOutput with field(s):
- unprocessed_accounts(Option<Vec<Result>>):
 The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.
On failure, responds with SdkError<CreateMembersError>

source

pub fn decline_invitations(&self) -> DeclineInvitations

Constructs a fluent builder for the DeclineInvitations operation.

The fluent builder is configurable:
- account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):
 The list of account IDs for the accounts from which to decline the invitations to Security Hub.
On success, responds with DeclineInvitationsOutput with field(s):
- unprocessed_accounts(Option<Vec<Result>>):
 The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.
On failure, responds with SdkError<DeclineInvitationsError>

source

pub fn delete_action_target(&self) -> DeleteActionTarget

Constructs a fluent builder for the DeleteActionTarget operation.

The fluent builder is configurable:
- action_target_arn(impl Into<String>) / set_action_target_arn(Option<String>):
 The ARN of the custom action target to delete.
On success, responds with DeleteActionTargetOutput with field(s):
- action_target_arn(Option<String>):
 The ARN of the custom action target that was deleted.
On failure, responds with SdkError<DeleteActionTargetError>

source

pub fn delete_finding_aggregator(&self) -> DeleteFindingAggregator

Constructs a fluent builder for the DeleteFindingAggregator operation.

The fluent builder is configurable:
- finding_aggregator_arn(impl Into<String>) / set_finding_aggregator_arn(Option<String>):
 The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.
On success, responds with DeleteFindingAggregatorOutput
On failure, responds with SdkError<DeleteFindingAggregatorError>

source

pub fn delete_insight(&self) -> DeleteInsight

Constructs a fluent builder for the DeleteInsight operation.

The fluent builder is configurable:
- insight_arn(impl Into<String>) / set_insight_arn(Option<String>):
 The ARN of the insight to delete.
On success, responds with DeleteInsightOutput with field(s):
- insight_arn(Option<String>):
 The ARN of the insight that was deleted.
On failure, responds with SdkError<DeleteInsightError>

source

pub fn delete_invitations(&self) -> DeleteInvitations

Constructs a fluent builder for the DeleteInvitations operation.

The fluent builder is configurable:
- account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):
 The list of the account IDs that sent the invitations to delete.
On success, responds with DeleteInvitationsOutput with field(s):
- unprocessed_accounts(Option<Vec<Result>>):
 The list of Amazon Web Services accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.
On failure, responds with SdkError<DeleteInvitationsError>

source

pub fn delete_members(&self) -> DeleteMembers

Constructs a fluent builder for the DeleteMembers operation.

The fluent builder is configurable:
- account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):
 The list of account IDs for the member accounts to delete.
On success, responds with DeleteMembersOutput with field(s):
- unprocessed_accounts(Option<Vec<Result>>):
 The list of Amazon Web Services accounts that were not deleted. For each account, the list includes the account ID and the email address.
On failure, responds with SdkError<DeleteMembersError>

source

pub fn describe_action_targets(&self) -> DescribeActionTargets

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

The fluent builder is configurable:
- action_target_arns(Vec<String>) / set_action_target_arns(Option<Vec<String>>):
 A list of custom action target ARNs for the custom action targets to retrieve.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the DescribeActionTargets operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of results to return.
On success, responds with DescribeActionTargetsOutput with field(s):
- action_targets(Option<Vec<ActionTarget>>):
 A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<DescribeActionTargetsError>

source

pub fn describe_hub(&self) -> DescribeHub

Constructs a fluent builder for the DescribeHub operation.

The fluent builder is configurable:
- hub_arn(impl Into<String>) / set_hub_arn(Option<String>):
 The ARN of the Hub resource to retrieve.
On success, responds with DescribeHubOutput with field(s):
- hub_arn(Option<String>):
 The ARN of the Hub resource that was retrieved.
- subscribed_at(Option<String>):
 The date and time when Security Hub was enabled in the account.
- auto_enable_controls(bool):
 Whether to automatically enable new controls when they are added to standards that are enabled.
 
 If set to true, then new controls for enabled standards are enabled automatically. If set to false, then new controls are not enabled.
On failure, responds with SdkError<DescribeHubError>

source

pub fn describe_organization_configuration(
&self
) -> DescribeOrganizationConfiguration

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(bool):
 Whether to automatically enable Security Hub for new accounts in the organization.
 
 If set to true, then Security Hub is enabled for new accounts. If set to false, then new accounts are not added automatically.
- member_account_limit_reached(bool):
 Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- auto_enable_standards(Option<AutoEnableStandards>):
 Whether to automatically enable Security Hub default standards for new member accounts in the organization.
 
 The default value of this parameter is equal to DEFAULT.
 
 If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts.
On failure, responds with SdkError<DescribeOrganizationConfigurationError>

source

pub fn describe_products(&self) -> DescribeProducts

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

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the DescribeProducts operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of results to return.
- product_arn(impl Into<String>) / set_product_arn(Option<String>):
 The ARN of the integration to return.
On success, responds with DescribeProductsOutput with field(s):
- products(Option<Vec<Product>>):
 A list of products, including details for each product.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<DescribeProductsError>

source

pub fn describe_standards(&self) -> DescribeStandards

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

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the DescribeStandards operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of standards to return.
On success, responds with DescribeStandardsOutput with field(s):
- standards(Option<Vec<Standard>>):
 A list of available standards.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<DescribeStandardsError>

source

pub fn describe_standards_controls(&self) -> DescribeStandardsControls

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

The fluent builder is configurable:
- standards_subscription_arn(impl Into<String>) / set_standards_subscription_arn(Option<String>):
 The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the GetEnabledStandards operation.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the DescribeStandardsControls operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of security standard controls to return.
On success, responds with DescribeStandardsControlsOutput with field(s):
- controls(Option<Vec<StandardsControl>>):
 A list of security standards controls.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<DescribeStandardsControlsError>

source

pub fn disable_import_findings_for_product(
&self
) -> DisableImportFindingsForProduct

Constructs a fluent builder for the DisableImportFindingsForProduct operation.

The fluent builder is configurable:
- product_subscription_arn(impl Into<String>) / set_product_subscription_arn(Option<String>):
 The ARN of the integrated product to disable the integration for.
On success, responds with DisableImportFindingsForProductOutput
On failure, responds with SdkError<DisableImportFindingsForProductError>

source

pub fn disable_organization_admin_account(
&self
) -> DisableOrganizationAdminAccount

Constructs a fluent builder for the DisableOrganizationAdminAccount operation.

The fluent builder is configurable:
- admin_account_id(impl Into<String>) / set_admin_account_id(Option<String>):
 The Amazon Web Services account identifier of the Security Hub administrator account.
On success, responds with DisableOrganizationAdminAccountOutput
On failure, responds with SdkError<DisableOrganizationAdminAccountError>

source

pub fn disable_security_hub(&self) -> DisableSecurityHub

Constructs a fluent builder for the DisableSecurityHub operation.

The fluent builder takes no input, just send it.
On success, responds with DisableSecurityHubOutput
On failure, responds with SdkError<DisableSecurityHubError>

source

pub fn disassociate_from_administrator_account(
&self
) -> DisassociateFromAdministratorAccount

Constructs a fluent builder for the DisassociateFromAdministratorAccount operation.

The fluent builder takes no input, just send it.
On success, responds with DisassociateFromAdministratorAccountOutput
On failure, responds with SdkError<DisassociateFromAdministratorAccountError>

source

pub fn disassociate_from_master_account(&self) -> DisassociateFromMasterAccount

Constructs a fluent builder for the DisassociateFromMasterAccount operation.

The fluent builder takes no input, just send it.
On success, responds with DisassociateFromMasterAccountOutput
On failure, responds with SdkError<DisassociateFromMasterAccountError>

source

pub fn disassociate_members(&self) -> DisassociateMembers

Constructs a fluent builder for the DisassociateMembers operation.

The fluent builder is configurable:
- account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):
 The account IDs of the member accounts to disassociate from the administrator account.
On success, responds with DisassociateMembersOutput
On failure, responds with SdkError<DisassociateMembersError>

source

pub fn enable_import_findings_for_product(
&self
) -> EnableImportFindingsForProduct

Constructs a fluent builder for the EnableImportFindingsForProduct operation.

The fluent builder is configurable:
- product_arn(impl Into<String>) / set_product_arn(Option<String>):
 The ARN of the product to enable the integration for.
On success, responds with EnableImportFindingsForProductOutput with field(s):
- product_subscription_arn(Option<String>):
 The ARN of your subscription to the product to enable integrations for.
On failure, responds with SdkError<EnableImportFindingsForProductError>

source

pub fn enable_organization_admin_account(
&self
) -> EnableOrganizationAdminAccount

Constructs a fluent builder for the EnableOrganizationAdminAccount operation.

The fluent builder is configurable:
- admin_account_id(impl Into<String>) / set_admin_account_id(Option<String>):
 The Amazon Web Services account identifier of the account to designate as the Security Hub administrator account.
On success, responds with EnableOrganizationAdminAccountOutput
On failure, responds with SdkError<EnableOrganizationAdminAccountError>

source

pub fn enable_security_hub(&self) -> EnableSecurityHub

Constructs a fluent builder for the EnableSecurityHub operation.

The fluent builder is configurable:
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 The tags to add to the hub resource when you enable Security Hub.
- enable_default_standards(bool) / set_enable_default_standards(bool):
 Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.
On success, responds with EnableSecurityHubOutput
On failure, responds with SdkError<EnableSecurityHubError>

source

pub fn get_administrator_account(&self) -> GetAdministratorAccount

Constructs a fluent builder for the GetAdministratorAccount operation.

The fluent builder takes no input, just send it.
On success, responds with GetAdministratorAccountOutput with field(s):
- administrator(Option<Invitation>):
 Details about an invitation.
On failure, responds with SdkError<GetAdministratorAccountError>

source

pub fn get_enabled_standards(&self) -> GetEnabledStandards

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

The fluent builder is configurable:
- standards_subscription_arns(Vec<String>) / set_standards_subscription_arns(Option<Vec<String>>):
 The list of the standards subscription ARNs for the standards to retrieve.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of results to return in the response.
On success, responds with GetEnabledStandardsOutput with field(s):
- standards_subscriptions(Option<Vec<StandardsSubscription>>):
 The list of StandardsSubscriptions objects that include information about the enabled standards.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<GetEnabledStandardsError>

source

pub fn get_finding_aggregator(&self) -> GetFindingAggregator

Constructs a fluent builder for the GetFindingAggregator operation.

The fluent builder is configurable:
- finding_aggregator_arn(impl Into<String>) / set_finding_aggregator_arn(Option<String>):
 The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.
On success, responds with GetFindingAggregatorOutput with field(s):
- finding_aggregator_arn(Option<String>):
 The ARN of the finding aggregator.
- finding_aggregation_region(Option<String>):
 The aggregation Region.
- region_linking_mode(Option<String>):
 Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
- regions(Option<Vec<String>>):
 The list of excluded Regions or included Regions.
On failure, responds with SdkError<GetFindingAggregatorError>

source

pub fn get_findings(&self) -> GetFindings

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

The fluent builder is configurable:
- filters(AwsSecurityFindingFilters) / set_filters(Option<AwsSecurityFindingFilters>):
 The finding attributes used to define a condition to filter the returned findings.
 
 You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.
 
 Note that in the available filter fields, WorkflowState is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.
- sort_criteria(Vec<SortCriterion>) / set_sort_criteria(Option<Vec<SortCriterion>>):
 The finding attributes used to sort the list of returned findings.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the GetFindings operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of findings to return.
On success, responds with GetFindingsOutput with field(s):
- findings(Option<Vec<AwsSecurityFinding>>):
 The findings that matched the filters specified in the request.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<GetFindingsError>

source

pub fn get_insight_results(&self) -> GetInsightResults

Constructs a fluent builder for the GetInsightResults operation.

The fluent builder is configurable:
- insight_arn(impl Into<String>) / set_insight_arn(Option<String>):
 The ARN of the insight for which to return results.
On success, responds with GetInsightResultsOutput with field(s):
- insight_results(Option<InsightResults>):
 The insight results returned by the operation.
On failure, responds with SdkError<GetInsightResultsError>

source

pub fn get_insights(&self) -> GetInsights

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

The fluent builder is configurable:
- insight_arns(Vec<String>) / set_insight_arns(Option<Vec<String>>):
 The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of items to return in the response.
On success, responds with GetInsightsOutput with field(s):
- insights(Option<Vec<Insight>>):
 The insights returned by the operation.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<GetInsightsError>

source

pub fn get_invitations_count(&self) -> GetInvitationsCount

Constructs a fluent builder for the GetInvitationsCount operation.

The fluent builder takes no input, just send it.
On success, responds with GetInvitationsCountOutput with field(s):
- invitations_count(i32):
  The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.
On failure, responds with SdkError<GetInvitationsCountError>

source

pub fn get_master_account(&self) -> GetMasterAccount

Constructs a fluent builder for the GetMasterAccount operation.

The fluent builder takes no input, just send it.
On success, responds with GetMasterAccountOutput with field(s):
- master(Option<Invitation>):
 A list of details about the Security Hub administrator account for the current member account.
On failure, responds with SdkError<GetMasterAccountError>

source

pub fn get_members(&self) -> GetMembers

Constructs a fluent builder for the GetMembers operation.

The fluent builder is configurable:
- account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):
 The list of account IDs for the Security Hub member accounts to return the details for.
On success, responds with GetMembersOutput with field(s):
- members(Option<Vec<Member>>):
 The list of details about the Security Hub member accounts.
- unprocessed_accounts(Option<Vec<Result>>):
 The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.
On failure, responds with SdkError<GetMembersError>

source

pub fn invite_members(&self) -> InviteMembers

Constructs a fluent builder for the InviteMembers operation.

The fluent builder is configurable:
- account_ids(Vec<String>) / set_account_ids(Option<Vec<String>>):
 The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.
On success, responds with InviteMembersOutput with field(s):
- unprocessed_accounts(Option<Vec<Result>>):
 The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.
On failure, responds with SdkError<InviteMembersError>

source

pub fn list_enabled_products_for_import(&self) -> ListEnabledProductsForImport

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

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the ListEnabledProductsForImport operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- max_results(i32) / set_max_results(i32):
 The maximum number of items to return in the response.
On success, responds with ListEnabledProductsForImportOutput with field(s):
- product_subscriptions(Option<Vec<String>>):
 The list of ARNs for the resources that represent your subscriptions to products.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<ListEnabledProductsForImportError>

source

pub fn list_finding_aggregators(&self) -> ListFindingAggregators

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

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned with the previous set of results. Identifies the next set of results to return.
- max_results(i32) / set_max_results(i32):
 The maximum number of results to return. This operation currently only returns a single result.
On success, responds with ListFindingAggregatorsOutput with field(s):
- finding_aggregators(Option<Vec<FindingAggregator>>):
 The list of finding aggregators. This operation currently only returns a single result.
- next_token(Option<String>):
 If there are more results, this is the token to provide in the next call to ListFindingAggregators.
 
 This operation currently only returns a single result.
On failure, responds with SdkError<ListFindingAggregatorsError>

source

pub fn list_invitations(&self) -> ListInvitations

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

The fluent builder is configurable:
- max_results(i32) / set_max_results(i32):
 The maximum number of items to return in the response.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the ListInvitations operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
On success, responds with ListInvitationsOutput with field(s):
- invitations(Option<Vec<Invitation>>):
 The details of the invitations returned by the operation.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<ListInvitationsError>

source

pub fn list_members(&self) -> ListMembers

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(bool):
 Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE.
 
 If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED.
 
 If OnlyAssociated is set to FALSE, the response includes all existing member accounts.
- max_results(i32) / set_max_results(i32):
 The maximum number of items to return in the response.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL.
 
 For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
On success, responds with ListMembersOutput with field(s):
- members(Option<Vec<Member>>):
 Member details returned by the operation.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<ListMembersError>

source

pub fn list_organization_admin_accounts(&self) -> ListOrganizationAdminAccounts

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

The fluent builder is configurable:
- max_results(i32) / set_max_results(i32):
 The maximum number of items to return in the response.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
On success, responds with ListOrganizationAdminAccountsOutput with field(s):
- admin_accounts(Option<Vec<AdminAccount>>):
 The list of Security Hub administrator accounts.
- next_token(Option<String>):
 The pagination token to use to request the next page of results.
On failure, responds with SdkError<ListOrganizationAdminAccountsError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The ARN of the resource to retrieve tags for.
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, String>>):
 The tags associated with a resource.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The ARN of the resource to apply the tags to.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>

source

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The ARN of the resource to remove the tags from.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
 The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.
On success, responds with UntagResourceOutput
On failure, responds with SdkError<UntagResourceError>

source

pub fn update_action_target(&self) -> UpdateActionTarget

Constructs a fluent builder for the UpdateActionTarget operation.

The fluent builder is configurable:
- action_target_arn(impl Into<String>) / set_action_target_arn(Option<String>):
 The ARN of the custom action target to update.
- name(impl Into<String>) / set_name(Option<String>):
 The updated name of the custom action target.
- description(impl Into<String>) / set_description(Option<String>):
 The updated description for the custom action target.
On success, responds with UpdateActionTargetOutput
On failure, responds with SdkError<UpdateActionTargetError>

source

pub fn update_finding_aggregator(&self) -> UpdateFindingAggregator

Constructs a fluent builder for the UpdateFindingAggregator operation.

The fluent builder is configurable:
- finding_aggregator_arn(impl Into<String>) / set_finding_aggregator_arn(Option<String>):
 The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
- region_linking_mode(impl Into<String>) / set_region_linking_mode(Option<String>):
 Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
 
 The selected option also determines how to use the Regions provided in the Regions list.
 
 The options are as follows:
 - ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
 - ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
 - SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
- regions(Vec<String>) / set_regions(Option<Vec<String>>):
 If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.
 
 If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
On success, responds with UpdateFindingAggregatorOutput with field(s):
- finding_aggregator_arn(Option<String>):
 The ARN of the finding aggregator.
- finding_aggregation_region(Option<String>):
 The aggregation Region.
- region_linking_mode(Option<String>):
 Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
- regions(Option<Vec<String>>):
 The list of excluded Regions or included Regions.
On failure, responds with SdkError<UpdateFindingAggregatorError>

source

pub fn update_findings(&self) -> UpdateFindings

Constructs a fluent builder for the UpdateFindings operation.

The fluent builder is configurable:
- filters(AwsSecurityFindingFilters) / set_filters(Option<AwsSecurityFindingFilters>):
 A collection of attributes that specify which findings you want to update.
- note(NoteUpdate) / set_note(Option<NoteUpdate>):
 The updated note for the finding.
- record_state(RecordState) / set_record_state(Option<RecordState>):
 The updated record state for the finding.
On success, responds with UpdateFindingsOutput
On failure, responds with SdkError<UpdateFindingsError>

source

pub fn update_insight(&self) -> UpdateInsight

Constructs a fluent builder for the UpdateInsight operation.

The fluent builder is configurable:
- insight_arn(impl Into<String>) / set_insight_arn(Option<String>):
 The ARN of the insight that you want to update.
- name(impl Into<String>) / set_name(Option<String>):
 The updated name for the insight.
- filters(AwsSecurityFindingFilters) / set_filters(Option<AwsSecurityFindingFilters>):
 The updated filters that define this insight.
- group_by_attribute(impl Into<String>) / set_group_by_attribute(Option<String>):
 The updated GroupBy attribute that defines this insight.
On success, responds with UpdateInsightOutput
On failure, responds with SdkError<UpdateInsightError>

source

pub fn update_organization_configuration(
&self
) -> UpdateOrganizationConfiguration

Constructs a fluent builder for the UpdateOrganizationConfiguration operation.

The fluent builder is configurable:
- auto_enable(bool) / set_auto_enable(bool):
 Whether to automatically enable Security Hub for new accounts in the organization.
 
 By default, this is false, and new accounts are not added automatically.
 
 To automatically enable Security Hub for new accounts, set this to true.
- auto_enable_standards(AutoEnableStandards) / set_auto_enable_standards(Option<AutoEnableStandards>):
 Whether to automatically enable Security Hub default standards for new member accounts in the organization.
 
 By default, this parameter is equal to DEFAULT, and new member accounts are automatically enabled with default Security Hub standards.
 
 To opt out of enabling default standards for new member accounts, set this parameter equal to NONE.
On success, responds with UpdateOrganizationConfigurationOutput
On failure, responds with SdkError<UpdateOrganizationConfigurationError>

source

pub fn update_security_hub_configuration(
&self
) -> UpdateSecurityHubConfiguration

Constructs a fluent builder for the UpdateSecurityHubConfiguration operation.

The fluent builder is configurable:
- auto_enable_controls(bool) / set_auto_enable_controls(bool):
  Whether to automatically enable new controls when they are added to standards that are enabled.
  
  By default, this is set to true, and new controls are enabled automatically. To not automatically enable new controls, set this to false.
On success, responds with UpdateSecurityHubConfigurationOutput
On failure, responds with SdkError<UpdateSecurityHubConfigurationError>

source

pub fn update_standards_control(&self) -> UpdateStandardsControl

Constructs a fluent builder for the UpdateStandardsControl operation.

The fluent builder is configurable:
- standards_control_arn(impl Into<String>) / set_standards_control_arn(Option<String>):
 The ARN of the security standard control to enable or disable.
- control_status(ControlStatus) / set_control_status(Option<ControlStatus>):
 The updated status of the security standard control.
- disabled_reason(impl Into<String>) / set_disabled_reason(Option<String>):
 A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.
On success, responds with UpdateStandardsControlOutput
On failure, responds with SdkError<UpdateStandardsControlError>

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.

source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.