View Source aws_fms (aws v1.0.4)
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: https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html.
Some API actions require explicit resource permissions. For information, see the developer guide topic Service roles for Firewall Manager: https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service.Summary
Functions
Sets a Firewall Manager default administrator account.
Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.
ResourceSet.Disassociates an Firewall Manager administrator account.
Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.
Returns information about the specified account's administrative scope.
Returns detailed compliance information about the specified member account.
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.
Lists the accounts that are managing the specified Organizations member account.
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.
PolicySummary objects.ProtocolsListDataSummary objects.ResourceSetSummary objects.Creates or updates an Firewall Manager administrator account.
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 the resource set.
Functions
Sets a Firewall Manager default administrator account.
The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect.
For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators: https://docs.aws.amazon.com/organizations/latest/userguide/fms-administrators.html in the Firewall Manager Developer Guide.Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.
A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.ResourceSet.
Disassociates an Firewall Manager administrator account.
To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request.
Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.
When you callDisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.
Returns information about the specified account's administrative scope.
The admistrative scope defines the resources that an Firewall Manager administrator can manage.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.
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.get_third_party_firewall_association_status(Client, Input, Options)
View SourceReturns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.
Lists the accounts that are managing the specified Organizations member account.
This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within theirAdminScope.
AppsListDataSummary objects.
Returns an array of PolicyComplianceStatus objects.
PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization.
PolicySummary objects.
ProtocolsListDataSummary objects.
ResourceSetSummary objects.
list_third_party_firewall_firewall_policies(Client, Input, Options)
View SourceCreates or updates an Firewall Manager administrator account.
The account must be a member of the organization that was onboarded to Firewall Manager byAssociateAdminAccount. Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn't a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html.
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 first configure the SNS topic's access policy to allow theSnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager: https://docs.aws.amazon.com/waf/latest/developerguide/fms-security_iam_service-with-iam.html#fms-security_iam_service-with-iam-roles-service in the Firewall Manager Developer Guide.
Creates an Firewall Manager policy.
A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.
If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.
Firewall Manager provides the following types of policies:
Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in Organizations and lets you enforce a baseline set of rules across your organization.
Network Firewall policy - This policy applies Network Firewall protection to your organization's VPCs.
DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace: https://aws.amazon.com/marketplace.
Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
Creates the resource set.
An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.