Data retrieval APIs for AWS Firewall Manager - AWS Online Register of Data Formats

Data retrieval APIs for AWS Firewall Manager

AWS Firewall Manager provides the following APIs for data retrieval.

Actions Description Access level
GetAdminAccountReturn the AWS Organizations account that is associated with AWS Firewall Manager as the AWS Firewall Manager administratorRead
GetAdminScopeReturn information about the specified account's administrative scopeRead
GetAppsListReturn information about the specified AWS Firewall Manager applications listRead
GetComplianceDetailRetrieve detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policyRead
GetNotificationChannelRetrieve information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logsRead
GetPolicyRetrieve information about the specified AWS Firewall Manager policyRead
GetProtectionStatusRetrieve policy-level attack summary information in the event of a potential DDoS attackRead
GetProtocolsListReturn information about the specified AWS Firewall Manager protocols listRead
GetResourceSetRetrieve information about the specified AWS Firewall Manager resource setRead
GetThirdPartyFirewallAssociationStatusRetrieve the onboarding status of a Firewall Manager administrator account to third-party firewall vendor tenantRead
GetViolationDetailsRetrieve violations for a resource based on the specified AWS Firewall Manager policy and AWS accountRead
ListAdminAccountsForOrganizationReturn a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccountList
ListAdminsManagingAccountList the accounts that are managing the specified AWS Organizations member accountList
ListAppsListsReturn an array of AppsListDataSummary objectsList
ListComplianceStatusRetrieve an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policyList
ListDiscoveredResourcesRetrieve an array of resources in the organization's accounts that are available to be associated with a resource setList
ListMemberAccountsRetrieve an array of member account ids if the caller is FMS admin accountList
ListPoliciesRetrieve an array of PolicySummary objects in the responseList
ListProtocolsListsReturn an array of ProtocolsListDataSummary objectsList
ListResourceSetResourcesRetrieve an array of resources that are currently associated to a resource setList
ListResourceSetsRetrieve an array of ResourceSetSummary objectsList
ListTagsForResourceList Tags for a given resourceRead
ListThirdPartyFirewallFirewallPoliciesRetrieve a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's accountList