amazonaws.com – fms

OpenAPI apis-guru cloud

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 .

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

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:fms/2018-01-01.json
Provider: amazonaws.com:fms / fms
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/fms/2018-01-01/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/fms/2018-01-01/openapi.yaml

Tools (44)

Extracted live via the executor SDK.

xAmzTargetAwsfms20180101AssociateAdminAccount.associateAdminAccount

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 in the Firewall Manager Developer Guide.
xAmzTargetAwsfms20180101AssociateThirdPartyFirewall.associateThirdPartyFirewall

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.
xAmzTargetAwsfms20180101BatchAssociateResource.batchAssociateResource

Associate resources to a Firewall Manager resource set.
xAmzTargetAwsfms20180101BatchDisassociateResource.batchDisassociateResource

Disassociates resources from a Firewall Manager resource set.
xAmzTargetAwsfms20180101DeleteAppsList.deleteAppsList

Permanently deletes an Firewall Manager applications list.
xAmzTargetAwsfms20180101DeleteNotificationChannel.deleteNotificationChannel

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.
xAmzTargetAwsfms20180101DeletePolicy.deletePolicy

Permanently deletes an Firewall Manager policy.
xAmzTargetAwsfms20180101DeleteProtocolsList.deleteProtocolsList

Permanently deletes an Firewall Manager protocols list.
xAmzTargetAwsfms20180101DeleteResourceSet.deleteResourceSet

Deletes the specified ResourceSet [blocked].
xAmzTargetAwsfms20180101DisassociateAdminAccount.disassociateAdminAccount

Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount [blocked] request. To set an account as a default administrator account, you must submit an AssociateAdminAccount [blocked] request.

Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before you can disassociate your account.
xAmzTargetAwsfms20180101DisassociateThirdPartyFirewall.disassociateThirdPartyFirewall

Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.
xAmzTargetAwsfms20180101GetAdminAccount.getAdminAccount

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

Returns information about the specified account's administrative scope. The admistrative scope defines the resources that an Firewall Manager administrator can manage.
xAmzTargetAwsfms20180101GetAppsList.getAppsList

Returns information about the specified Firewall Manager applications list.
xAmzTargetAwsfms20180101GetComplianceDetail.getComplianceDetail
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.
xAmzTargetAwsfms20180101GetNotificationChannel.getNotificationChannel

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

Returns information about the specified Firewall Manager policy.
xAmzTargetAwsfms20180101GetProtectionStatus.getProtectionStatus

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.
xAmzTargetAwsfms20180101GetProtocolsList.getProtocolsList

Returns information about the specified Firewall Manager protocols list.
xAmzTargetAwsfms20180101GetResourceSet.getResourceSet

Gets information about a specific resource set.
xAmzTargetAwsfms20180101GetThirdPartyFirewallAssociationStatus.getThirdPartyFirewallAssociationStatus

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
xAmzTargetAwsfms20180101GetViolationDetails.getViolationDetails

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

Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount [blocked].

This operation can be called only from the organization's management account.
xAmzTargetAwsfms20180101ListAdminsManagingAccount.listAdminsManagingAccount

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 their AdminScope [blocked].
xAmzTargetAwsfms20180101ListAppsLists.listAppsLists

Returns an array of AppsListDataSummary objects.
xAmzTargetAwsfms20180101ListComplianceStatus.listComplianceStatus

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
xAmzTargetAwsfms20180101ListDiscoveredResources.listDiscoveredResources

Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
xAmzTargetAwsfms20180101ListMemberAccounts.listMemberAccounts

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

Either an Firewall Manager administrator or the organization's management account can make this request.
xAmzTargetAwsfms20180101ListPolicies.listPolicies

Returns an array of PolicySummary objects.
xAmzTargetAwsfms20180101ListProtocolsLists.listProtocolsLists

Returns an array of ProtocolsListDataSummary objects.
xAmzTargetAwsfms20180101ListResourceSetResources.listResourceSetResources

Returns an array of resources that are currently associated to a resource set.
xAmzTargetAwsfms20180101ListResourceSets.listResourceSets

Returns an array of ResourceSetSummary objects.
xAmzTargetAwsfms20180101ListTagsForResource.listTagsForResource

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

Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
xAmzTargetAwsfms20180101PutAdminAccount.putAdminAccount

Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount [blocked]. 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 .
xAmzTargetAwsfms20180101PutAppsList.putAppsList

Creates an Firewall Manager applications list.
xAmzTargetAwsfms20180101PutNotificationChannel.putNotificationChannel

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 the SnsRoleName 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 in the Firewall Manager Developer Guide.
xAmzTargetAwsfms20180101PutPolicy.putPolicy
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 .
xAmzTargetAwsfms20180101PutProtocolsList.putProtocolsList

Creates an Firewall Manager protocols list.
xAmzTargetAwsfms20180101PutResourceSet.putResourceSet

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.
xAmzTargetAwsfms20180101TagResource.tagResource

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

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

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools