AWS.FMS (aws-elixir v0.8.0) View Source

This is the Firewall Manager API Reference.

This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide.

Some API actions require explicit resource permissions. For information, see the developer guide topic Firewall Manager required permissions for API actions.

Link to this section Summary

Functions

Sets the Firewall Manager administrator account.

Permanently deletes an Firewall Manager applications list.

Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

Permanently deletes an Firewall Manager policy.

Permanently deletes an Firewall Manager protocols list.

Disassociates the account that has been set as the Firewall Manager administrator account.

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.

Returns information about the specified Firewall Manager applications list.

Returns detailed compliance information about the specified member account.

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

Returns information about the specified Firewall Manager policy.

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.

Returns information about the specified Firewall Manager protocols list.

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

Returns an array of AppsListDataSummary objects.

Returns an array of PolicyComplianceStatus objects.

Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization.

Returns an array of PolicySummary objects.

Returns an array of ProtocolsListDataSummary objects.

Retrieves the list of tags for the specified Amazon Web Services resource.

Creates an Firewall Manager applications list.

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.

Creates an Firewall Manager policy.

Creates an Firewall Manager protocols list.

Adds one or more tags to an Amazon Web Services resource.

Removes one or more tags from an Amazon Web Services resource.

Link to this section Functions

Link to this function

associate_admin_account(client, input, options \\ [])

View Source

Sets the Firewall Manager administrator account.

The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies.

The account that you associate with Firewall Manager is called the Firewall Manager administrator account.

Link to this function

delete_apps_list(client, input, options \\ [])

View Source

Permanently deletes an Firewall Manager applications list.

Link to this function

delete_notification_channel(client, input, options \\ [])

View Source

Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

Link to this function

delete_policy(client, input, options \\ [])

View Source

Permanently deletes an Firewall Manager policy.

Link to this function

delete_protocols_list(client, input, options \\ [])

View Source

Permanently deletes an Firewall Manager protocols list.

Link to this function

disassociate_admin_account(client, input, options \\ [])

View Source

Disassociates the account that has been set as the Firewall Manager administrator account.

To set a different account as the administrator account, you must submit an AssociateAdminAccount request.

Link to this function

get_admin_account(client, input, options \\ [])

View Source

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.

Link to this function

get_apps_list(client, input, options \\ [])

View Source

Returns information about the specified Firewall Manager applications list.

Link to this function

get_compliance_detail(client, input, options \\ [])

View Source

Returns detailed compliance information about the specified member account.

Details include resources that are in and out of compliance with the specified policy.

  • Resources are considered noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them.

  • Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible.

  • Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules.

  • Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.

Link to this function

get_notification_channel(client, input, options \\ [])

View Source

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

Link to this function

get_policy(client, input, options \\ [])

View Source

Returns information about the specified Firewall Manager policy.

Link to this function

get_protection_status(client, input, options \\ [])

View Source

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.

Other policy types are currently unsupported.

Link to this function

get_protocols_list(client, input, options \\ [])

View Source

Returns information about the specified Firewall Manager protocols list.

Link to this function

get_violation_details(client, input, options \\ [])

View Source

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

Link to this function

list_apps_lists(client, input, options \\ [])

View Source

Returns an array of AppsListDataSummary objects.

Link to this function

list_compliance_status(client, input, options \\ [])

View Source

Returns an array of PolicyComplianceStatus objects.

Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

Link to this function

list_member_accounts(client, input, options \\ [])

View Source

Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization.

The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager administrator.

Link to this function

list_policies(client, input, options \\ [])

View Source

Returns an array of PolicySummary objects.

Link to this function

list_protocols_lists(client, input, options \\ [])

View Source

Returns an array of ProtocolsListDataSummary objects.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Retrieves the list of tags for the specified Amazon Web Services resource.

Link to this function

put_apps_list(client, input, options \\ [])

View Source

Creates an Firewall Manager applications list.

Link to this function

put_notification_channel(client, input, options \\ [])

View Source

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.

To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role AWSServiceRoleForFMS to publish SNS logs. For more information, see Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide.

Link to this function

put_policy(client, input, options \\ [])

View Source

Creates an Firewall Manager policy.

Firewall Manager provides the following types of policies:

  • An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL.

  • An WAF Classic policy (type WAF), which defines a rule group.

  • A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.

  • A security group policy, which manages VPC security groups across your Amazon Web Services organization.

  • An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.

  • A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs.

Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.

Link to this function

put_protocols_list(client, input, options \\ [])

View Source

Creates an Firewall Manager protocols list.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds one or more tags to an Amazon Web Services resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes one or more tags from an Amazon Web Services resource.