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

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.

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_fms::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::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_fms::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_fms::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AssociateAdminAccount operation.

Constructs a fluent builder for the AssociateThirdPartyFirewall operation.

Constructs a fluent builder for the DeleteAppsList operation.

Constructs a fluent builder for the DeleteNotificationChannel operation.

Constructs a fluent builder for the DeletePolicy operation.

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

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

      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

      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>

Constructs a fluent builder for the DeleteProtocolsList operation.

Constructs a fluent builder for the DisassociateAdminAccount operation.

Constructs a fluent builder for the DisassociateThirdPartyFirewall operation.

Constructs a fluent builder for the GetAdminAccount operation.

Constructs a fluent builder for the GetAppsList operation.

Constructs a fluent builder for the GetComplianceDetail operation.

Constructs a fluent builder for the GetNotificationChannel operation.

Constructs a fluent builder for the GetPolicy operation.

Constructs a fluent builder for the GetProtectionStatus operation.

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

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

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

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

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

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

      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>

Constructs a fluent builder for the GetProtocolsList operation.

Constructs a fluent builder for the GetThirdPartyFirewallAssociationStatus operation.

  • The fluent builder is configurable:
  • 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 AWS Marketplace.

      • NO_SUBSCRIPTION - The Firewall Manager policy administrator isn’t subscribed to the third-party firewall service in the AWS 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>

Constructs a fluent builder for the GetViolationDetails operation.

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

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

    • next_token(impl Into<String>) / set_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. 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>):

      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>

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

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

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

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

      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>

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

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

      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>

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

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

      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>

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

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

    • next_token(impl Into<String>) / set_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. 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>):

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

Constructs a fluent builder for the ListTagsForResource operation.

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

Constructs a fluent builder for the PutAppsList operation.

Constructs a fluent builder for the PutNotificationChannel operation.

Constructs a fluent builder for the PutPolicy operation.

Constructs a fluent builder for the PutProtocolsList operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

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

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

Calls U::from(self).

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

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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