Struct aws_sdk_fms::client::Client

pub struct Client { /* private fields */ }

Client for Firewall Management Service

Client for invoking operations on Firewall Management Service. Each operation on Firewall Management Service 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_fms::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_fms::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 AssociateAdminAccount operation has a Client::associate_admin_account, 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_admin_account()
    .admin_account("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_admin_account(&self) -> AssociateAdminAccountFluentBuilder

Constructs a fluent builder for the AssociateAdminAccount operation.

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

    The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager default administrator account. This account must be a member account of the organization in Organizations whose resources you want to protect. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

    
    
• On success, responds with AssociateAdminAccountOutput
• On failure, responds with SdkError<AssociateAdminAccountError>

impl Client

pub fn associate_third_party_firewall( &self ) -> AssociateThirdPartyFirewallFluentBuilder

Constructs a fluent builder for the AssociateThirdPartyFirewall operation.

• The fluent builder is configurable:
  • third_party_firewall(ThirdPartyFirewall) / set_third_party_firewall(Option<ThirdPartyFirewall>):
    required: true
    

    The name of the third-party firewall vendor.

    
    
• On success, responds with AssociateThirdPartyFirewallOutput with field(s):
  • third_party_firewall_status(Option<ThirdPartyFirewallAssociationStatus>):

    The current status for setting a Firewall Manager policy administrator’s account as an administrator of the third-party firewall tenant.

    • ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator.

    • ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator.

    • OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator.

    • OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator.

    • NOT_EXIST - The Firewall Manager policy administrator doesn’t exist as a tenant administrator.

• On failure, responds with SdkError<AssociateThirdPartyFirewallError>

impl Client

pub fn batch_associate_resource(&self) -> BatchAssociateResourceFluentBuilder

Constructs a fluent builder for the BatchAssociateResource operation.

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

    A unique identifier for the resource set, used in a request to refer to the resource set.

    
    
  • items(impl Into<String>) / set_items(Option<Vec::<String>>):
    required: true
    

    The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs).

    
    
• On success, responds with BatchAssociateResourceOutput with field(s):
  • resource_set_identifier(String):

    A unique identifier for the resource set, used in a request to refer to the resource set.

  • failed_items(Vec::<FailedItem>):

    The resources that failed to associate to the resource set.

• On failure, responds with SdkError<BatchAssociateResourceError>

impl Client

pub fn batch_disassociate_resource( &self ) -> BatchDisassociateResourceFluentBuilder

Constructs a fluent builder for the BatchDisassociateResource operation.

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

    A unique identifier for the resource set, used in a request to refer to the resource set.

    
    
  • items(impl Into<String>) / set_items(Option<Vec::<String>>):
    required: true
    

    The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs).

    
    
• On success, responds with BatchDisassociateResourceOutput with field(s):
  • resource_set_identifier(String):

    A unique identifier for the resource set, used in a request to refer to the resource set.

  • failed_items(Vec::<FailedItem>):

    The resources that failed to disassociate from the resource set.

• On failure, responds with SdkError<BatchDisassociateResourceError>

impl Client

pub fn delete_apps_list(&self) -> DeleteAppsListFluentBuilder

Constructs a fluent builder for the DeleteAppsList operation.

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

    The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList, ListAppsLists, and GetAppsList.

    
    
• On success, responds with DeleteAppsListOutput
• On failure, responds with SdkError<DeleteAppsListError>

impl Client

pub fn delete_notification_channel( &self ) -> DeleteNotificationChannelFluentBuilder

Constructs a fluent builder for the DeleteNotificationChannel operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteNotificationChannelOutput
• On failure, responds with SdkError<DeleteNotificationChannelError>

impl Client

pub fn delete_policy(&self) -> DeletePolicyFluentBuilder

Constructs a fluent builder for the DeletePolicy operation.

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

    The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

    
    
  • delete_all_policy_resources(bool) / set_delete_all_policy_resources(Option<bool>):
    required: false
    

    If True, the request performs cleanup according to the policy type.

    For WAF and Shield Advanced policies, the cleanup does the following:

    • Deletes rule groups created by Firewall Manager

    • Removes web ACLs from in-scope resources

    • Deletes web ACLs that contain no rules or rule groups

    For security group policies, the cleanup does the following for each security group in the policy:

    • Disassociates the security group from in-scope resources

    • Deletes the security group if it was created through Firewall Manager and if it’s no longer associated with any resources through another policy

    For security group common policies, even if set to False, Firewall Manager deletes all security groups created by Firewall Manager that aren’t associated with any other resources through another policy.

    After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don’t specify tags or accounts, all resources are in scope.

    
    
• On success, responds with DeletePolicyOutput
• On failure, responds with SdkError<DeletePolicyError>

impl Client

pub fn delete_protocols_list(&self) -> DeleteProtocolsListFluentBuilder

Constructs a fluent builder for the DeleteProtocolsList operation.

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

    The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.

    
    
• On success, responds with DeleteProtocolsListOutput
• On failure, responds with SdkError<DeleteProtocolsListError>

impl Client

pub fn delete_resource_set(&self) -> DeleteResourceSetFluentBuilder

Constructs a fluent builder for the DeleteResourceSet operation.

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

    A unique identifier for the resource set, used in a request to refer to the resource set.

    
    
• On success, responds with DeleteResourceSetOutput
• On failure, responds with SdkError<DeleteResourceSetError>

impl Client

pub fn disassociate_admin_account( &self ) -> DisassociateAdminAccountFluentBuilder

Constructs a fluent builder for the DisassociateAdminAccount operation.

• The fluent builder takes no input, just send it.
• On success, responds with DisassociateAdminAccountOutput
• On failure, responds with SdkError<DisassociateAdminAccountError>

impl Client

pub fn disassociate_third_party_firewall( &self ) -> DisassociateThirdPartyFirewallFluentBuilder

Constructs a fluent builder for the DisassociateThirdPartyFirewall operation.

• The fluent builder is configurable:
  • third_party_firewall(ThirdPartyFirewall) / set_third_party_firewall(Option<ThirdPartyFirewall>):
    required: true
    

    The name of the third-party firewall vendor.

    
    
• On success, responds with DisassociateThirdPartyFirewallOutput with field(s):
  • third_party_firewall_status(Option<ThirdPartyFirewallAssociationStatus>):

    The current status for the disassociation of a Firewall Manager administrators account with a third-party firewall.

• On failure, responds with SdkError<DisassociateThirdPartyFirewallError>

impl Client

pub fn get_admin_account(&self) -> GetAdminAccountFluentBuilder

Constructs a fluent builder for the GetAdminAccount operation.

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

    The account that is set as the Firewall Manager default administrator.

  • role_status(Option<AccountRoleStatus>):

    The status of the account that you set as the Firewall Manager default administrator.

• On failure, responds with SdkError<GetAdminAccountError>

impl Client

pub fn get_admin_scope(&self) -> GetAdminScopeFluentBuilder

Constructs a fluent builder for the GetAdminScope operation.

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

    The administrator account that you want to get the details for.

    
    
• On success, responds with GetAdminScopeOutput with field(s):
  • admin_scope(Option<AdminScope>):

    Contains details about the administrative scope of the requested account.

  • status(Option<OrganizationStatus>):

    The current status of the request to onboard a member account as an Firewall Manager administrator.

    • ONBOARDING - The account is onboarding to Firewall Manager as an administrator.

    • ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.

    • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

    • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

• On failure, responds with SdkError<GetAdminScopeError>

impl Client

pub fn get_apps_list(&self) -> GetAppsListFluentBuilder

Constructs a fluent builder for the GetAppsList operation.

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

    The ID of the Firewall Manager applications list that you want the details for.

    
    
  • default_list(bool) / set_default_list(Option<bool>):
    required: false
    

    Specifies whether the list to retrieve is a default list owned by Firewall Manager.

    
    
• On success, responds with GetAppsListOutput with field(s):
  • apps_list(Option<AppsListData>):

    Information about the specified Firewall Manager applications list.

  • apps_list_arn(Option<String>):

    The Amazon Resource Name (ARN) of the applications list.

• On failure, responds with SdkError<GetAppsListError>

impl Client

pub fn get_compliance_detail(&self) -> GetComplianceDetailFluentBuilder

Constructs a fluent builder for the GetComplianceDetail operation.

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

    The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.

    
    
  • member_account(impl Into<String>) / set_member_account(Option<String>):
    required: true
    

    The Amazon Web Services account that owns the resources that you want to get the details for.

    
    
• On success, responds with GetComplianceDetailOutput with field(s):
  • policy_compliance_detail(Option<PolicyComplianceDetail>):

    Information about the resources and the policy that you specified in the GetComplianceDetail request.

• On failure, responds with SdkError<GetComplianceDetailError>

impl Client

pub fn get_notification_channel(&self) -> GetNotificationChannelFluentBuilder

Constructs a fluent builder for the GetNotificationChannel operation.

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

    The SNS topic that records Firewall Manager activity.

  • sns_role_name(Option<String>):

    The IAM role that is used by Firewall Manager to record activity to SNS.

• On failure, responds with SdkError<GetNotificationChannelError>

impl Client

pub fn get_policy(&self) -> GetPolicyFluentBuilder

Constructs a fluent builder for the GetPolicy operation.

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

    The ID of the Firewall Manager policy that you want the details for.

    
    
• On success, responds with GetPolicyOutput with field(s):
  • policy(Option<Policy>):

    Information about the specified Firewall Manager policy.

  • policy_arn(Option<String>):

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

• On failure, responds with SdkError<GetPolicyError>

impl Client

pub fn get_protection_status(&self) -> GetProtectionStatusFluentBuilder

Constructs a fluent builder for the GetProtectionStatus operation.

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

    The ID of the policy for which you want to get the attack information.

    
    
  • member_account_id(impl Into<String>) / set_member_account_id(Option<String>):
    required: false
    

    The Amazon Web Services account that is in scope of the policy that you want to get the details for.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

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

    If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.

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

    Specifies the number of objects that you want Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects.

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

    The ID of the Firewall Manager administrator account for this policy.

  • service_type(Option<SecurityServiceType>):

    The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.

  • data(Option<String>):

    Details about the attack, including the following:

    • Attack type

    • Account ID

    • ARN of the resource attacked

    • Start time of the attack

    • End time of the attack (ongoing attacks will not have an end time)

    The details are in JSON format.

  • next_token(Option<String>):

    If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

    Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes.

• On failure, responds with SdkError<GetProtectionStatusError>

impl Client

pub fn get_protocols_list(&self) -> GetProtocolsListFluentBuilder

Constructs a fluent builder for the GetProtocolsList operation.

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

    The ID of the Firewall Manager protocols list that you want the details for.

    
    
  • default_list(bool) / set_default_list(Option<bool>):
    required: false
    

    Specifies whether the list to retrieve is a default list owned by Firewall Manager.

    
    
• On success, responds with GetProtocolsListOutput with field(s):
  • protocols_list(Option<ProtocolsListData>):

    Information about the specified Firewall Manager protocols list.

  • protocols_list_arn(Option<String>):

    The Amazon Resource Name (ARN) of the specified protocols list.

• On failure, responds with SdkError<GetProtocolsListError>

impl Client

pub fn get_resource_set(&self) -> GetResourceSetFluentBuilder

Constructs a fluent builder for the GetResourceSet operation.

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

    A unique identifier for the resource set, used in a request to refer to the resource set.

    
    
• On success, responds with GetResourceSetOutput with field(s):
  • resource_set(Option<ResourceSet>):

    Information about the specified resource set.

  • resource_set_arn(String):

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

• On failure, responds with SdkError<GetResourceSetError>

impl Client

pub fn get_third_party_firewall_association_status( &self ) -> GetThirdPartyFirewallAssociationStatusFluentBuilder

Constructs a fluent builder for the GetThirdPartyFirewallAssociationStatus operation.

• The fluent builder is configurable:
  • third_party_firewall(ThirdPartyFirewall) / set_third_party_firewall(Option<ThirdPartyFirewall>):
    required: true
    

    The name of the third-party firewall vendor.

    
    
• On success, responds with GetThirdPartyFirewallAssociationStatusOutput with field(s):
  • third_party_firewall_status(Option<ThirdPartyFirewallAssociationStatus>):

    The current status for setting a Firewall Manager policy administrators account as an administrator of the third-party firewall tenant.

    • ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator.

    • ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator.

    • OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator.

    • OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator.

    • NOT_EXIST - The Firewall Manager policy administrator doesn’t exist as a tenant administrator.

  • marketplace_onboarding_status(Option<MarketplaceSubscriptionOnboardingStatus>):

    The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.

    • NO_SUBSCRIPTION - The Firewall Manager policy administrator isn’t subscribed to the third-party firewall service in the Amazon Web Services Marketplace.

    • NOT_COMPLETE - The Firewall Manager policy administrator is in the process of subscribing to the third-party firewall service in the Amazon Web Services Marketplace, but doesn’t yet have an active subscription.

    • COMPLETE - The Firewall Manager policy administrator has an active subscription to the third-party firewall service in the Amazon Web Services Marketplace.

• On failure, responds with SdkError<GetThirdPartyFirewallAssociationStatusError>

impl Client

pub fn get_violation_details(&self) -> GetViolationDetailsFluentBuilder

Constructs a fluent builder for the GetViolationDetails operation.

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

    The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:

    • DNS Firewall

    • Imported Network Firewall

    • Network Firewall

    • Security group content audit

    • Network ACL

    • Third-party firewall

    
    
  • member_account(impl Into<String>) / set_member_account(Option<String>):
    required: true
    

    The Amazon Web Services account ID that you want the details for.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The ID of the resource that has violations.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: true
    

    The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance, AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy, and AWS::EC2::Subnet.

    
    
• On success, responds with GetViolationDetailsOutput with field(s):
  • violation_detail(Option<ViolationDetail>):

    Violation detail for a resource.

• On failure, responds with SdkError<GetViolationDetailsError>

impl Client

pub fn list_admin_accounts_for_organization( &self ) -> ListAdminAccountsForOrganizationFluentBuilder

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

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

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    
    
• On success, responds with ListAdminAccountsForOrganizationOutput with field(s):
  • admin_accounts(Option<Vec::<AdminAccountSummary>>):

    A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by AssociateAdminAccount or PutAdminAccount.

  • next_token(Option<String>):

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

• On failure, responds with SdkError<ListAdminAccountsForOrganizationError>

impl Client

pub fn list_admins_managing_account( &self ) -> ListAdminsManagingAccountFluentBuilder

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

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

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

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

    The list of accounts who manage member accounts within their AdminScope.

  • next_token(Option<String>):

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

• On failure, responds with SdkError<ListAdminsManagingAccountError>

impl Client

pub fn list_apps_lists(&self) -> ListAppsListsFluentBuilder

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

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

    Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

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

    If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

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

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don’t specify this, Firewall Manager returns all available objects.

    
    
• On success, responds with ListAppsListsOutput with field(s):
  • apps_lists(Option<Vec::<AppsListDataSummary>>):

    An array of AppsListDataSummary objects.

  • next_token(Option<String>):

    If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

• On failure, responds with SdkError<ListAppsListsError>

impl Client

pub fn list_compliance_status(&self) -> ListComplianceStatusFluentBuilder

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

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

    The ID of the Firewall Manager policy that you want the details for.

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

    If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

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

    Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.

    
    
• On success, responds with ListComplianceStatusOutput with field(s):
  • policy_compliance_status_list(Option<Vec::<PolicyComplianceStatus>>):

    An array of PolicyComplianceStatus objects.

  • next_token(Option<String>):

    If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

• On failure, responds with SdkError<ListComplianceStatusError>

impl Client

pub fn list_discovered_resources(&self) -> ListDiscoveredResourcesFluentBuilder

Constructs a fluent builder for the ListDiscoveredResources operation.

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

    The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.

    
    
  • resource_type(impl Into<String>) / set_resource_type(Option<String>):
    required: true
    

    The type of resources to discover.

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

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

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

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

    
    
• On success, responds with ListDiscoveredResourcesOutput with field(s):
  • items(Option<Vec::<DiscoveredResource>>):

    Details of the resources that were discovered.

  • next_token(Option<String>):

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

• On failure, responds with SdkError<ListDiscoveredResourcesError>

impl Client

pub fn list_member_accounts(&self) -> ListMemberAccountsFluentBuilder

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

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

    If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

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

    Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

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

    An array of account IDs.

  • next_token(Option<String>):

    If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

• On failure, responds with SdkError<ListMemberAccountsError>

impl Client

pub fn list_policies(&self) -> ListPoliciesFluentBuilder

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

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

    If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

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

    Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

    
    
• On success, responds with ListPoliciesOutput with field(s):
  • policy_list(Option<Vec::<PolicySummary>>):

    An array of PolicySummary objects.

  • next_token(Option<String>):

    If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

• On failure, responds with SdkError<ListPoliciesError>

impl Client

pub fn list_protocols_lists(&self) -> ListProtocolsListsFluentBuilder

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

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

    Specifies whether the lists to retrieve are default lists owned by Firewall Manager.

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

    If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

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

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don’t specify this, Firewall Manager returns all available objects.

    
    
• On success, responds with ListProtocolsListsOutput with field(s):
  • protocols_lists(Option<Vec::<ProtocolsListDataSummary>>):

    An array of ProtocolsListDataSummary objects.

  • next_token(Option<String>):

    If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.

• On failure, responds with SdkError<ListProtocolsListsError>

impl Client

pub fn list_resource_set_resources( &self ) -> ListResourceSetResourcesFluentBuilder

Constructs a fluent builder for the ListResourceSetResources operation.

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

    A unique identifier for the resource set, used in a request to refer to the resource set.

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

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

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

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

    
    
• On success, responds with ListResourceSetResourcesOutput with field(s):
  • items(Vec::<Resource>):

    An array of the associated resources’ uniform resource identifiers (URI).

  • next_token(Option<String>):

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

• On failure, responds with SdkError<ListResourceSetResourcesError>

impl Client

pub fn list_resource_sets(&self) -> ListResourceSetsFluentBuilder

Constructs a fluent builder for the ListResourceSets operation.

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

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

    The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    
    
• On success, responds with ListResourceSetsOutput with field(s):
  • resource_sets(Option<Vec::<ResourceSetSummary>>):

    An array of ResourceSetSummary objects.

  • next_token(Option<String>):

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

• On failure, responds with SdkError<ListResourceSetsError>

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 Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_third_party_firewall_firewall_policies( &self ) -> ListThirdPartyFirewallFirewallPoliciesFluentBuilder

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

• The fluent builder is configurable:
  • third_party_firewall(ThirdPartyFirewall) / set_third_party_firewall(Option<ThirdPartyFirewall>):
    required: true
    

    The name of the third-party firewall vendor.

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

    If the previous response included a NextToken element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit another ListThirdPartyFirewallFirewallPoliciesRequest request.

    For the value of NextToken, specify the value of NextToken from the previous response. If the previous response didn’t include a NextToken element, there are no more third-party firewall policies to get.

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

    The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than MaxResults firewall policies, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.

    
    
• On success, responds with ListThirdPartyFirewallFirewallPoliciesOutput with field(s):
  • third_party_firewall_firewall_policies(Option<Vec::<ThirdPartyFirewallFirewallPolicy>>):

    A list that contains one ThirdPartyFirewallFirewallPolicies element for each third-party firewall policies that the specified third-party firewall vendor is associated with. Each ThirdPartyFirewallFirewallPolicies element contains the firewall policy name and ID.

  • next_token(Option<String>):

    The value that you will use for NextToken in the next ListThirdPartyFirewallFirewallPolicies request.

• On failure, responds with SdkError<ListThirdPartyFirewallFirewallPoliciesError>

impl Client

pub fn put_admin_account(&self) -> PutAdminAccountFluentBuilder

Constructs a fluent builder for the PutAdminAccount operation.

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

    The Amazon Web Services account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

    
    
  • admin_scope(AdminScope) / set_admin_scope(Option<AdminScope>):
    required: false
    

    Configures the resources that the specified Firewall Manager administrator can manage. As a best practice, set the administrative scope according to the principles of least privilege. Only grant the administrator the specific resources or permissions that they need to perform the duties of their role.

    
    
• On success, responds with PutAdminAccountOutput
• On failure, responds with SdkError<PutAdminAccountError>

impl Client

pub fn put_apps_list(&self) -> PutAppsListFluentBuilder

Constructs a fluent builder for the PutAppsList operation.

• The fluent builder is configurable:
  • apps_list(AppsListData) / set_apps_list(Option<AppsListData>):
    required: true
    

    The details of the Firewall Manager applications list to be created.

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: false
    

    The tags associated with the resource.

    
    
• On success, responds with PutAppsListOutput with field(s):
  • apps_list(Option<AppsListData>):

    The details of the Firewall Manager applications list.

  • apps_list_arn(Option<String>):

    The Amazon Resource Name (ARN) of the applications list.

• On failure, responds with SdkError<PutAppsListError>

impl Client

pub fn put_notification_channel(&self) -> PutNotificationChannelFluentBuilder

Constructs a fluent builder for the PutNotificationChannel operation.

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

    The Amazon Resource Name (ARN) of the SNS topic that collects notifications from Firewall Manager.

    
    
  • sns_role_name(impl Into<String>) / set_sns_role_name(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record Firewall Manager activity.

    
    
• On success, responds with PutNotificationChannelOutput
• On failure, responds with SdkError<PutNotificationChannelError>

impl Client

pub fn put_policy(&self) -> PutPolicyFluentBuilder

Constructs a fluent builder for the PutPolicy operation.

• The fluent builder is configurable:
  • policy(Policy) / set_policy(Option<Policy>):
    required: true
    

    The details of the Firewall Manager policy to be created.

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: false
    

    The tags to add to the Amazon Web Services resource.

    
    
• On success, responds with PutPolicyOutput with field(s):
  • policy(Option<Policy>):

    The details of the Firewall Manager policy.

  • policy_arn(Option<String>):

    The Amazon Resource Name (ARN) of the policy.

• On failure, responds with SdkError<PutPolicyError>

impl Client

pub fn put_protocols_list(&self) -> PutProtocolsListFluentBuilder

Constructs a fluent builder for the PutProtocolsList operation.

• The fluent builder is configurable:
  • protocols_list(ProtocolsListData) / set_protocols_list(Option<ProtocolsListData>):
    required: true
    

    The details of the Firewall Manager protocols list to be created.

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: false
    

    The tags associated with the resource.

    
    
• On success, responds with PutProtocolsListOutput with field(s):
  • protocols_list(Option<ProtocolsListData>):

    The details of the Firewall Manager protocols list.

  • protocols_list_arn(Option<String>):

    The Amazon Resource Name (ARN) of the protocols list.

• On failure, responds with SdkError<PutProtocolsListError>

impl Client

pub fn put_resource_set(&self) -> PutResourceSetFluentBuilder

Constructs a fluent builder for the PutResourceSet operation.

• The fluent builder is configurable:
  • resource_set(ResourceSet) / set_resource_set(Option<ResourceSet>):
    required: true
    

    Details about the resource set to be created or updated.>

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: false
    

    Retrieves the tags associated with the specified resource set. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to “customer” and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

    
    
• On success, responds with PutResourceSetOutput with field(s):
  • resource_set(Option<ResourceSet>):

    Details about the resource set.

  • resource_set_arn(String):

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

• On failure, responds with SdkError<PutResourceSetError>

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 return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

    
    
  • tag_list(Tag) / set_tag_list(Option<Vec::<Tag>>):
    required: true
    

    The tags to add to the 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) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

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

    The keys of the tags to remove from the resource.

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

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.