Amazon Web Services, Inc.

Firewall Management Service

This is the Firewall Manager API Reference . This guide is for developers who need detailed information about the Firewall Manager API actions, data types,…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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
Service roles for Firewall Manager .

Endpoints 42

  • POSTAssociate admin account/#X-Amz-Target=AWSFMS_20180101.AssociateAdminAccountSets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full…
  • POSTAssociate third party firewall/#X-Amz-Target=AWSFMS_20180101.AssociateThirdPartyFirewallSets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party…
  • POSTBatch associate resource/#X-Amz-Target=AWSFMS_20180101.BatchAssociateResourceAssociate resources to a Firewall Manager resource set.
  • POSTBatch disassociate resource/#X-Amz-Target=AWSFMS_20180101.BatchDisassociateResourceDisassociates resources from a Firewall Manager resource set.
  • POSTDelete apps list/#X-Amz-Target=AWSFMS_20180101.DeleteAppsListPermanently deletes an Firewall Manager applications list.
  • POSTDelete notification channel/#X-Amz-Target=AWSFMS_20180101.DeleteNotificationChannelDeletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS…
  • POSTDelete policy/#X-Amz-Target=AWSFMS_20180101.DeletePolicyPermanently deletes an Firewall Manager policy.
  • POSTDelete protocols list/#X-Amz-Target=AWSFMS_20180101.DeleteProtocolsListPermanently deletes an Firewall Manager protocols list.
  • POSTDelete resource set/#X-Amz-Target=AWSFMS_20180101.DeleteResourceSetDeletes the specified ResourceSet .
  • POSTDisassociate admin account/#X-Amz-Target=AWSFMS_20180101.DisassociateAdminAccountDisassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To…
  • POSTDisassociate third party firewall/#X-Amz-Target=AWSFMS_20180101.DisassociateThirdPartyFirewallDisassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall , the third-party…
  • POSTGet admin account/#X-Amz-Target=AWSFMS_20180101.GetAdminAccountReturns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.
  • POSTGet admin scope/#X-Amz-Target=AWSFMS_20180101.GetAdminScopeReturns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator…
  • POSTGet apps list/#X-Amz-Target=AWSFMS_20180101.GetAppsListReturns information about the specified Firewall Manager applications list.
  • POSTGet compliance detail/#X-Amz-Target=AWSFMS_20180101.GetComplianceDetailReturns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified…
  • POSTGet notification channel/#X-Amz-Target=AWSFMS_20180101.GetNotificationChannelInformation about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
  • POSTGet policy/#X-Amz-Target=AWSFMS_20180101.GetPolicyReturns information about the specified Firewall Manager policy.
  • POSTGet protection status/#X-Amz-Target=AWSFMS_20180101.GetProtectionStatusIf you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are…
  • POSTGet protocols list/#X-Amz-Target=AWSFMS_20180101.GetProtocolsListReturns information about the specified Firewall Manager protocols list.
  • POSTGet resource set/#X-Amz-Target=AWSFMS_20180101.GetResourceSetGets information about a specific resource set.
  • POSTGet third party firewall association status/#X-Amz-Target=AWSFMS_20180101.GetThirdPartyFirewallAssociationStatusThe onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
  • POSTGet violation details/#X-Amz-Target=AWSFMS_20180101.GetViolationDetailsRetrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
  • POSTList admin accounts for organization/#X-Amz-Target=AWSFMS_20180101.ListAdminAccountsForOrganizationReturns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by…
  • POSTList admins managing account/#X-Amz-Target=AWSFMS_20180101.ListAdminsManagingAccountLists 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…
  • POSTList apps lists/#X-Amz-Target=AWSFMS_20180101.ListAppsListsReturns an array of AppsListDataSummary objects.
  • POSTList compliance status/#X-Amz-Target=AWSFMS_20180101.ListComplianceStatusReturns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
  • POSTList discovered resources/#X-Amz-Target=AWSFMS_20180101.ListDiscoveredResourcesReturns an array of resources in the organization's accounts that are available to be associated with a resource set.
  • POSTList member accounts/#X-Amz-Target=AWSFMS_20180101.ListMemberAccountsReturns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization. Either an Firewall Manager…
  • POSTList policies/#X-Amz-Target=AWSFMS_20180101.ListPoliciesReturns an array of PolicySummary objects.
  • POSTList protocols lists/#X-Amz-Target=AWSFMS_20180101.ListProtocolsListsReturns an array of ProtocolsListDataSummary objects.
  • POSTList resource set resources/#X-Amz-Target=AWSFMS_20180101.ListResourceSetResourcesReturns an array of resources that are currently associated to a resource set.
  • POSTList resource sets/#X-Amz-Target=AWSFMS_20180101.ListResourceSetsReturns an array of ResourceSetSummary objects.
  • POSTList tags for resource/#X-Amz-Target=AWSFMS_20180101.ListTagsForResourceRetrieves the list of tags for the specified Amazon Web Services resource.
  • POSTList third party firewall firewall policies/#X-Amz-Target=AWSFMS_20180101.ListThirdPartyFirewallFirewallPoliciesRetrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
  • POSTPut admin account/#X-Amz-Target=AWSFMS_20180101.PutAdminAccountCreates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by…
  • POSTPut apps list/#X-Amz-Target=AWSFMS_20180101.PutAppsListCreates an Firewall Manager applications list.
  • POSTPut notification channel/#X-Amz-Target=AWSFMS_20180101.PutNotificationChannelDesignates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of…
  • POSTPut policy/#X-Amz-Target=AWSFMS_20180101.PutPolicyCreates an Firewall Manager policy. A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across…
  • POSTPut protocols list/#X-Amz-Target=AWSFMS_20180101.PutProtocolsListCreates an Firewall Manager protocols list.
  • POSTPut resource set/#X-Amz-Target=AWSFMS_20180101.PutResourceSetCreates the resource set. An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services…
  • POSTTag resource/#X-Amz-Target=AWSFMS_20180101.TagResourceAdds one or more tags to an Amazon Web Services resource.
  • POSTUntag resource/#X-Amz-Target=AWSFMS_20180101.UntagResourceRemoves one or more tags from an Amazon Web Services resource.

API details

Base URL
https://fms.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
42 operations on 42 pathsPOST 42
Description format
AWS Smithy model, API version 2018-01-01

How to test the Firewall Management Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Firewall Management Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate admin account” (POST /#X-Amz-Target=AWSFMS_20180101.AssociateAdminAccount), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Firewall Management Service?

This is the Firewall Manager API Reference . This guide is for developers who need detailed information about the Firewall Manager API actions, data types,… It is listed under Developer tools and has 42 endpoints.

Who publishes the Firewall Management Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Firewall Management Service?

Requests go to https://fms.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Firewall Management Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Firewall Management Service have?

42 operations on 42 paths (42 POST).

Is forking the Firewall Management Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.