UNPKG

aws-sdk

Version:
687 lines • 177 kB
import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class FMS extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: FMS.Types.ClientConfiguration) config: Config & FMS.Types.ClientConfiguration; /** * 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 in the Firewall Manager Developer Guide. */ associateAdminAccount(params: FMS.Types.AssociateAdminAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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 in the Firewall Manager Developer Guide. */ associateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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. */ associateThirdPartyFirewall(params: FMS.Types.AssociateThirdPartyFirewallRequest, callback?: (err: AWSError, data: FMS.Types.AssociateThirdPartyFirewallResponse) => void): Request<FMS.Types.AssociateThirdPartyFirewallResponse, AWSError>; /** * 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. */ associateThirdPartyFirewall(callback?: (err: AWSError, data: FMS.Types.AssociateThirdPartyFirewallResponse) => void): Request<FMS.Types.AssociateThirdPartyFirewallResponse, AWSError>; /** * Associate resources to a Firewall Manager resource set. */ batchAssociateResource(params: FMS.Types.BatchAssociateResourceRequest, callback?: (err: AWSError, data: FMS.Types.BatchAssociateResourceResponse) => void): Request<FMS.Types.BatchAssociateResourceResponse, AWSError>; /** * Associate resources to a Firewall Manager resource set. */ batchAssociateResource(callback?: (err: AWSError, data: FMS.Types.BatchAssociateResourceResponse) => void): Request<FMS.Types.BatchAssociateResourceResponse, AWSError>; /** * Disassociates resources from a Firewall Manager resource set. */ batchDisassociateResource(params: FMS.Types.BatchDisassociateResourceRequest, callback?: (err: AWSError, data: FMS.Types.BatchDisassociateResourceResponse) => void): Request<FMS.Types.BatchDisassociateResourceResponse, AWSError>; /** * Disassociates resources from a Firewall Manager resource set. */ batchDisassociateResource(callback?: (err: AWSError, data: FMS.Types.BatchDisassociateResourceResponse) => void): Request<FMS.Types.BatchDisassociateResourceResponse, AWSError>; /** * Permanently deletes an Firewall Manager applications list. */ deleteAppsList(params: FMS.Types.DeleteAppsListRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Permanently deletes an Firewall Manager applications list. */ deleteAppsList(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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. */ deleteNotificationChannel(params: FMS.Types.DeleteNotificationChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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. */ deleteNotificationChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Permanently deletes an Firewall Manager policy. */ deletePolicy(params: FMS.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Permanently deletes an Firewall Manager policy. */ deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Permanently deletes an Firewall Manager protocols list. */ deleteProtocolsList(params: FMS.Types.DeleteProtocolsListRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Permanently deletes an Firewall Manager protocols list. */ deleteProtocolsList(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes the specified ResourceSet. */ deleteResourceSet(params: FMS.Types.DeleteResourceSetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Deletes the specified ResourceSet. */ deleteResourceSet(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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. 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. */ disassociateAdminAccount(params: FMS.Types.DisassociateAdminAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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. 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. */ disassociateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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. */ disassociateThirdPartyFirewall(params: FMS.Types.DisassociateThirdPartyFirewallRequest, callback?: (err: AWSError, data: FMS.Types.DisassociateThirdPartyFirewallResponse) => void): Request<FMS.Types.DisassociateThirdPartyFirewallResponse, AWSError>; /** * 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. */ disassociateThirdPartyFirewall(callback?: (err: AWSError, data: FMS.Types.DisassociateThirdPartyFirewallResponse) => void): Request<FMS.Types.DisassociateThirdPartyFirewallResponse, AWSError>; /** * Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator. */ getAdminAccount(params: FMS.Types.GetAdminAccountRequest, callback?: (err: AWSError, data: FMS.Types.GetAdminAccountResponse) => void): Request<FMS.Types.GetAdminAccountResponse, AWSError>; /** * Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator. */ getAdminAccount(callback?: (err: AWSError, data: FMS.Types.GetAdminAccountResponse) => void): Request<FMS.Types.GetAdminAccountResponse, AWSError>; /** * Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage. */ getAdminScope(params: FMS.Types.GetAdminScopeRequest, callback?: (err: AWSError, data: FMS.Types.GetAdminScopeResponse) => void): Request<FMS.Types.GetAdminScopeResponse, AWSError>; /** * Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage. */ getAdminScope(callback?: (err: AWSError, data: FMS.Types.GetAdminScopeResponse) => void): Request<FMS.Types.GetAdminScopeResponse, AWSError>; /** * Returns information about the specified Firewall Manager applications list. */ getAppsList(params: FMS.Types.GetAppsListRequest, callback?: (err: AWSError, data: FMS.Types.GetAppsListResponse) => void): Request<FMS.Types.GetAppsListResponse, AWSError>; /** * Returns information about the specified Firewall Manager applications list. */ getAppsList(callback?: (err: AWSError, data: FMS.Types.GetAppsListResponse) => void): Request<FMS.Types.GetAppsListResponse, AWSError>; /** * Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. The reasons for resources being considered compliant depend on the Firewall Manager policy type. */ getComplianceDetail(params: FMS.Types.GetComplianceDetailRequest, callback?: (err: AWSError, data: FMS.Types.GetComplianceDetailResponse) => void): Request<FMS.Types.GetComplianceDetailResponse, AWSError>; /** * Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. The reasons for resources being considered compliant depend on the Firewall Manager policy type. */ getComplianceDetail(callback?: (err: AWSError, data: FMS.Types.GetComplianceDetailResponse) => void): Request<FMS.Types.GetComplianceDetailResponse, AWSError>; /** * Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs. */ getNotificationChannel(params: FMS.Types.GetNotificationChannelRequest, callback?: (err: AWSError, data: FMS.Types.GetNotificationChannelResponse) => void): Request<FMS.Types.GetNotificationChannelResponse, AWSError>; /** * Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs. */ getNotificationChannel(callback?: (err: AWSError, data: FMS.Types.GetNotificationChannelResponse) => void): Request<FMS.Types.GetNotificationChannelResponse, AWSError>; /** * Returns information about the specified Firewall Manager policy. */ getPolicy(params: FMS.Types.GetPolicyRequest, callback?: (err: AWSError, data: FMS.Types.GetPolicyResponse) => void): Request<FMS.Types.GetPolicyResponse, AWSError>; /** * Returns information about the specified Firewall Manager policy. */ getPolicy(callback?: (err: AWSError, data: FMS.Types.GetPolicyResponse) => void): Request<FMS.Types.GetPolicyResponse, AWSError>; /** * 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. */ getProtectionStatus(params: FMS.Types.GetProtectionStatusRequest, callback?: (err: AWSError, data: FMS.Types.GetProtectionStatusResponse) => void): Request<FMS.Types.GetProtectionStatusResponse, AWSError>; /** * 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. */ getProtectionStatus(callback?: (err: AWSError, data: FMS.Types.GetProtectionStatusResponse) => void): Request<FMS.Types.GetProtectionStatusResponse, AWSError>; /** * Returns information about the specified Firewall Manager protocols list. */ getProtocolsList(params: FMS.Types.GetProtocolsListRequest, callback?: (err: AWSError, data: FMS.Types.GetProtocolsListResponse) => void): Request<FMS.Types.GetProtocolsListResponse, AWSError>; /** * Returns information about the specified Firewall Manager protocols list. */ getProtocolsList(callback?: (err: AWSError, data: FMS.Types.GetProtocolsListResponse) => void): Request<FMS.Types.GetProtocolsListResponse, AWSError>; /** * Gets information about a specific resource set. */ getResourceSet(params: FMS.Types.GetResourceSetRequest, callback?: (err: AWSError, data: FMS.Types.GetResourceSetResponse) => void): Request<FMS.Types.GetResourceSetResponse, AWSError>; /** * Gets information about a specific resource set. */ getResourceSet(callback?: (err: AWSError, data: FMS.Types.GetResourceSetResponse) => void): Request<FMS.Types.GetResourceSetResponse, AWSError>; /** * The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant. */ getThirdPartyFirewallAssociationStatus(params: FMS.Types.GetThirdPartyFirewallAssociationStatusRequest, callback?: (err: AWSError, data: FMS.Types.GetThirdPartyFirewallAssociationStatusResponse) => void): Request<FMS.Types.GetThirdPartyFirewallAssociationStatusResponse, AWSError>; /** * The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant. */ getThirdPartyFirewallAssociationStatus(callback?: (err: AWSError, data: FMS.Types.GetThirdPartyFirewallAssociationStatusResponse) => void): Request<FMS.Types.GetThirdPartyFirewallAssociationStatusResponse, AWSError>; /** * Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account. */ getViolationDetails(params: FMS.Types.GetViolationDetailsRequest, callback?: (err: AWSError, data: FMS.Types.GetViolationDetailsResponse) => void): Request<FMS.Types.GetViolationDetailsResponse, AWSError>; /** * Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account. */ getViolationDetails(callback?: (err: AWSError, data: FMS.Types.GetViolationDetailsResponse) => void): Request<FMS.Types.GetViolationDetailsResponse, AWSError>; /** * Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount. This operation can be called only from the organization's management account. */ listAdminAccountsForOrganization(params: FMS.Types.ListAdminAccountsForOrganizationRequest, callback?: (err: AWSError, data: FMS.Types.ListAdminAccountsForOrganizationResponse) => void): Request<FMS.Types.ListAdminAccountsForOrganizationResponse, AWSError>; /** * Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount. This operation can be called only from the organization's management account. */ listAdminAccountsForOrganization(callback?: (err: AWSError, data: FMS.Types.ListAdminAccountsForOrganizationResponse) => void): Request<FMS.Types.ListAdminAccountsForOrganizationResponse, AWSError>; /** * 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. */ listAdminsManagingAccount(params: FMS.Types.ListAdminsManagingAccountRequest, callback?: (err: AWSError, data: FMS.Types.ListAdminsManagingAccountResponse) => void): Request<FMS.Types.ListAdminsManagingAccountResponse, AWSError>; /** * 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. */ listAdminsManagingAccount(callback?: (err: AWSError, data: FMS.Types.ListAdminsManagingAccountResponse) => void): Request<FMS.Types.ListAdminsManagingAccountResponse, AWSError>; /** * Returns an array of AppsListDataSummary objects. */ listAppsLists(params: FMS.Types.ListAppsListsRequest, callback?: (err: AWSError, data: FMS.Types.ListAppsListsResponse) => void): Request<FMS.Types.ListAppsListsResponse, AWSError>; /** * Returns an array of AppsListDataSummary objects. */ listAppsLists(callback?: (err: AWSError, data: FMS.Types.ListAppsListsResponse) => void): Request<FMS.Types.ListAppsListsResponse, AWSError>; /** * Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy. */ listComplianceStatus(params: FMS.Types.ListComplianceStatusRequest, callback?: (err: AWSError, data: FMS.Types.ListComplianceStatusResponse) => void): Request<FMS.Types.ListComplianceStatusResponse, AWSError>; /** * Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy. */ listComplianceStatus(callback?: (err: AWSError, data: FMS.Types.ListComplianceStatusResponse) => void): Request<FMS.Types.ListComplianceStatusResponse, AWSError>; /** * Returns an array of resources in the organization's accounts that are available to be associated with a resource set. */ listDiscoveredResources(params: FMS.Types.ListDiscoveredResourcesRequest, callback?: (err: AWSError, data: FMS.Types.ListDiscoveredResourcesResponse) => void): Request<FMS.Types.ListDiscoveredResourcesResponse, AWSError>; /** * Returns an array of resources in the organization's accounts that are available to be associated with a resource set. */ listDiscoveredResources(callback?: (err: AWSError, data: FMS.Types.ListDiscoveredResourcesResponse) => void): Request<FMS.Types.ListDiscoveredResourcesResponse, AWSError>; /** * 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. */ listMemberAccounts(params: FMS.Types.ListMemberAccountsRequest, callback?: (err: AWSError, data: FMS.Types.ListMemberAccountsResponse) => void): Request<FMS.Types.ListMemberAccountsResponse, AWSError>; /** * 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. */ listMemberAccounts(callback?: (err: AWSError, data: FMS.Types.ListMemberAccountsResponse) => void): Request<FMS.Types.ListMemberAccountsResponse, AWSError>; /** * Returns an array of PolicySummary objects. */ listPolicies(params: FMS.Types.ListPoliciesRequest, callback?: (err: AWSError, data: FMS.Types.ListPoliciesResponse) => void): Request<FMS.Types.ListPoliciesResponse, AWSError>; /** * Returns an array of PolicySummary objects. */ listPolicies(callback?: (err: AWSError, data: FMS.Types.ListPoliciesResponse) => void): Request<FMS.Types.ListPoliciesResponse, AWSError>; /** * Returns an array of ProtocolsListDataSummary objects. */ listProtocolsLists(params: FMS.Types.ListProtocolsListsRequest, callback?: (err: AWSError, data: FMS.Types.ListProtocolsListsResponse) => void): Request<FMS.Types.ListProtocolsListsResponse, AWSError>; /** * Returns an array of ProtocolsListDataSummary objects. */ listProtocolsLists(callback?: (err: AWSError, data: FMS.Types.ListProtocolsListsResponse) => void): Request<FMS.Types.ListProtocolsListsResponse, AWSError>; /** * Returns an array of resources that are currently associated to a resource set. */ listResourceSetResources(params: FMS.Types.ListResourceSetResourcesRequest, callback?: (err: AWSError, data: FMS.Types.ListResourceSetResourcesResponse) => void): Request<FMS.Types.ListResourceSetResourcesResponse, AWSError>; /** * Returns an array of resources that are currently associated to a resource set. */ listResourceSetResources(callback?: (err: AWSError, data: FMS.Types.ListResourceSetResourcesResponse) => void): Request<FMS.Types.ListResourceSetResourcesResponse, AWSError>; /** * Returns an array of ResourceSetSummary objects. */ listResourceSets(params: FMS.Types.ListResourceSetsRequest, callback?: (err: AWSError, data: FMS.Types.ListResourceSetsResponse) => void): Request<FMS.Types.ListResourceSetsResponse, AWSError>; /** * Returns an array of ResourceSetSummary objects. */ listResourceSets(callback?: (err: AWSError, data: FMS.Types.ListResourceSetsResponse) => void): Request<FMS.Types.ListResourceSetsResponse, AWSError>; /** * Retrieves the list of tags for the specified Amazon Web Services resource. */ listTagsForResource(params: FMS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: FMS.Types.ListTagsForResourceResponse) => void): Request<FMS.Types.ListTagsForResourceResponse, AWSError>; /** * Retrieves the list of tags for the specified Amazon Web Services resource. */ listTagsForResource(callback?: (err: AWSError, data: FMS.Types.ListTagsForResourceResponse) => void): Request<FMS.Types.ListTagsForResourceResponse, AWSError>; /** * Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account. */ listThirdPartyFirewallFirewallPolicies(params: FMS.Types.ListThirdPartyFirewallFirewallPoliciesRequest, callback?: (err: AWSError, data: FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse) => void): Request<FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse, AWSError>; /** * Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account. */ listThirdPartyFirewallFirewallPolicies(callback?: (err: AWSError, data: FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse) => void): Request<FMS.Types.ListThirdPartyFirewallFirewallPoliciesResponse, AWSError>; /** * 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. 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. */ putAdminAccount(params: FMS.Types.PutAdminAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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. 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. */ putAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * Creates an Firewall Manager applications list. */ putAppsList(params: FMS.Types.PutAppsListRequest, callback?: (err: AWSError, data: FMS.Types.PutAppsListResponse) => void): Request<FMS.Types.PutAppsListResponse, AWSError>; /** * Creates an Firewall Manager applications list. */ putAppsList(callback?: (err: AWSError, data: FMS.Types.PutAppsListResponse) => void): Request<FMS.Types.PutAppsListResponse, AWSError>; /** * 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 Service roles for Firewall Manager in the Firewall Manager Developer Guide. */ putNotificationChannel(params: FMS.Types.PutNotificationChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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 Service roles for Firewall Manager in the Firewall Manager Developer Guide. */ putNotificationChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; /** * 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: WAF policy - This policy applies WAF web ACL protections to specified accounts and resources. 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 ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in Organizations and lets you enforce a baseline set of first and last network ACL 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. 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. */ putPolicy(params: FMS.Types.PutPolicyRequest, callback?: (err: AWSError, data: FMS.Types.PutPolicyResponse) => void): Request<FMS.Types.PutPolicyResponse, AWSError>; /** * 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: WAF policy - This policy applies WAF web ACL protections to specified accounts and resources. 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 ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in Organizations and lets you enforce a baseline set of first and last network ACL 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. 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. */ putPolicy(callback?: (err: AWSError, data: FMS.Types.PutPolicyResponse) => void): Request<FMS.Types.PutPolicyResponse, AWSError>; /** * Creates an Firewall Manager protocols list. */ putProtocolsList(params: FMS.Types.PutProtocolsListRequest, callback?: (err: AWSError, data: FMS.Types.PutProtocolsListResponse) => void): Request<FMS.Types.PutProtocolsListResponse, AWSError>; /** * Creates an Firewall Manager protocols list. */ putProtocolsList(callback?: (err: AWSError, data: FMS.Types.PutProtocolsListResponse) => void): Request<FMS.Types.PutProtocolsListResponse, AWSError>; /** * 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. */ putResourceSet(params: FMS.Types.PutResourceSetRequest, callback?: (err: AWSError, data: FMS.Types.PutResourceSetResponse) => void): Request<FMS.Types.PutResourceSetResponse, AWSError>; /** * 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. */ putResourceSet(callback?: (err: AWSError, data: FMS.Types.PutResourceSetResponse) => void): Request<FMS.Types.PutResourceSetResponse, AWSError>; /** * Adds one or more tags to an Amazon Web Services resource. */ tagResource(params: FMS.Types.TagResourceRequest, callback?: (err: AWSError, data: FMS.Types.TagResourceResponse) => void): Request<FMS.Types.TagResourceResponse, AWSError>; /** * Adds one or more tags to an Amazon Web Services resource. */ tagResource(callback?: (err: AWSError, data: FMS.Types.TagResourceResponse) => void): Request<FMS.Types.TagResourceResponse, AWSError>; /** * Removes one or more tags from an Amazon Web Services resource. */ untagResource(params: FMS.Types.UntagResourceRequest, callback?: (err: AWSError, data: FMS.Types.UntagResourceResponse) => void): Request<FMS.Types.UntagResourceResponse, AWSError>; /** * Removes one or more tags from an Amazon Web Services resource. */ untagResource(callback?: (err: AWSError, data: FMS.Types.UntagResourceResponse) => void): Request<FMS.Types.UntagResourceResponse, AWSError>; } declare namespace FMS { export type AWSAccountId = string; export type AWSAccountIdList = AWSAccountId[]; export type AWSRegion = string; export type AWSRegionList = AWSRegion[]; export type AccountIdList = AWSAccountId[]; export type AccountRoleStatus = "READY"|"CREATING"|"PENDING_DELETION"|"DELETING"|"DELETED"|string; export interface AccountScope { /** * The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list. */ Accounts?: AccountIdList; /** * A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both. */ AllAccountsEnabled?: Boolean; /** * A boolean value that excludes the accounts in AccountScope$Accounts from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both. */ ExcludeSpecifiedAccounts?: Boolean; } export interface ActionTarget { /** * The ID of the remediation target. */ ResourceId?: ResourceId; /** * A description of the remediation action target. */ Description?: LengthBoundedString; } export interface AdminAccountSummary { /** * The Amazon Web Services account ID of the Firewall Manager administrator's account. */ AdminAccount?: AWSAccountId; /** * A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide. */ DefaultAdmin?: Boolean; /** * The current status of the request to onboard a member account as an Firewall Manager administrator. ONBOARDING - The account is onboarding to Firewall Manager as an administrator. ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope. OFFBOARDING - The account is being removed as an Firewall Manager administrator. OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator. */ Status?: OrganizationStatus; } export type AdminAccountSummaryList = AdminAccountSummary[]; export interface AdminScope { /** * Defines the accounts that the specified Firewall Manager administrator can apply policies to. */ AccountScope?: AccountScope; /** * Defines the Organizations organizational units that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide. */ OrganizationalUnitScope?: OrganizationalUnitScope; /** * Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in. */ RegionScope?: RegionScope; /** * Defines the Firewall Manager policy types that the specified Firewall Manager administrator can create and manage. */ PolicyTypeScope?: PolicyTypeScope; } export interface App { /** * The application's name. */ AppName: ResourceName; /** * The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers. */ Protocol: Protocol; /** * The application's port number, for example 80. */ Port: IPPortNumber; } export type AppsList = App[]; export interface AppsListData { /** * The ID of the Firewall Manager applications list. */ ListId?: ListId; /** * The name of the Firewall Manager applications list. */ ListName: ResourceName; /** * A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list. */ ListUpdateToken?: UpdateToken; /** * The time that the Firewall Manager applications list was created. */ CreateTime?: TimeStamp; /** * The time that the Firewall Manager applications list was last updated. */ LastUpdateTime?: TimeStamp; /** * An array of applications in the Firewall Manager applications list. */ AppsList: AppsList; /** * A map of previous version numbers to their corresponding App object arrays. */ PreviousAppsList?: PreviousAppsList; } export interface AppsListDataSummary { /** * The Amazon Resource Name (ARN) of the applications list. */ ListArn?: ResourceArn; /** * The ID of the applications list. */ ListId?: ListId; /** * The name of the applications list. */ ListName?: ResourceName; /** * An array of App objects in the Firewall Manager applications list. */ AppsList?: AppsList; } export type AppsListsData = AppsListDataSummary[]; export interface AssociateAdminAccountRequest { /** * The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager default administrator account. This account must be a member account of the organization in Organizations whose resources you want to protect. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization. */ AdminAccount: AWSAccountId; } export interface AssociateThirdPartyFirewallRequest { /** * The name of the third-party firewall vendor. */ ThirdPartyFirewall: ThirdPartyFirewall; } export interface AssociateThirdPartyFirewallResponse { /** * The current status for setting a Firewall Manager policy administrator's account as an administrator of the third-party firewall tenant. ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant administrator. ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant administrator. OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator. OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant administrator. NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a tenant administrator. */ ThirdPartyFirewallStatus?: ThirdPartyFirewallAssociationStatus; } export interface AwsEc2InstanceViolation { /** * The resource ID of the EC2 instance. */ ViolationTarget?: ViolationTarget; /** * Violation detail for network interfaces associated with the EC2 instance. */ AwsEc2NetworkInterfaceViolations?: AwsEc2NetworkInterfaceViolations; } export interface AwsEc2NetworkInterfaceViolation { /** * The resource ID of the network interface. */ ViolationTarget?: ViolationTarget; /** * List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy. */ ViolatingSecurityGroups?: ResourceIdList; } export type AwsEc2NetworkInterfaceViolations = AwsEc2NetworkInterfaceViolation[]; export interface AwsVPCSecurityGroupViolation { /** * The security group rule that is being evaluated. */ ViolationTarget?: ViolationTarget; /** * A description of the security group that violates the policy. */ ViolationTargetDescription?: LengthBoundedString; /** * List of rules specified in the security group of the Firewall Manager policy that partially match the ViolationTarget rule. */ PartialMatches?: PartialMatches; /** * Remediation options for the rule specified in the ViolationTarget. */ PossibleSecurityGroupRemediationActions?: SecurityGroupRemediationActions; } export type Base62Id = string; export type BasicInteger = number; export interface BatchAssociateResourceRequest { /** * A unique identifier for the resource set, used in a request to refer to the resource set. */ ResourceSetIdentifier: Identifier; /** * The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs). */ Items: IdentifierList; } export interface BatchAssociateResourceResponse { /** * A unique identifier for the resource set, used in a request to refer to the resource set. */ ResourceSetIdentifier: Identifier; /** * The resources that failed to associate to the resource set. */ FailedItems: FailedItemList; } export interface BatchDisassociateResourceRequest { /** * A unique identifier for the resource set, used in a request to refer to the resource set. */ ResourceSetIdentifier: Identifier; /** * The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs). */ Items: IdentifierList; } export interface BatchDisassociateResourceResponse { /** * A unique identifier for the resource set, used in a request to refer to the resource set. */ ResourceSetIdentifier: Identifier; /** * The resources that failed to disassociate from the resource set. */ FailedItems: FailedItemList; } export type Boolean = boolean; export type BooleanObject = boolean; export type CIDR = string; export interface ComplianceViolator { /** * The resource ID. */ ResourceId?: ResourceId; /** * The reason that the resource is not protected by the policy. */ ViolationReason?: ViolationReason; /** * The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy. */ ResourceType?: ResourceType; /** * Metadata about the resource that doesn't comply with the policy scope. */ Metadata?: ComplianceViolatorMetadata; } export type ComplianceViolatorMetadata = {[key: string]: LengthBoundedString}; export type ComplianceViolators = ComplianceViolator[]; export interface CreateNetworkAclAction { /** * Brief description of this remediation action. */ Description?: LengthBoundedString; /** * The VPC that's associated with the remediation action. */ Vpc?: ActionTarget; /** * Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind. */ FMSCanRemediate?: Boolean; } export interface CreateNetworkAclEntriesAction { /** * Brief description of this remediation action. */ Description?: LengthBoundedString; /** * The network ACL that's associated with the remediation action. */ NetworkAclId?: ActionTarget; /** * Lists the entries that the remediation action would create. */ NetworkAclEntriesToBeCreated?: EntriesDescription; /** * Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind. */ FMSCanRemediate?: Boolean; } export type CustomerPolicyScopeId = string; export type CustomerPolicyScopeIdList = CustomerPolicyScopeId[]; export type CustomerPolicyScopeIdType = "ACCOUNT"|"ORG_UNIT"|string; export type CustomerPolicyScopeMap = {[key: string]: CustomerPolicyScopeIdList}; export type CustomerPolicyStatus = "ACTIVE"|"OUT_OF_ADMIN_SCOPE"|string; export interface DeleteAppsListRequest { /** * The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList, ListAppsLists, and GetAppsList. */ ListId: ListId; } export interface DeleteNetworkAclEntriesAction { /** * Brief description of this remediation action. */ Description?: LengthBoundedString; /** * The network ACL that's associated with the remediation action. */ NetworkAclId?: ActionTarget; /** * Lists the entries that the remediation action would delete. */ NetworkAclEntriesToBeDeleted?: EntriesDescription; /** * Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind. */ FMSCanRemediate?: Boolean; } export interface DeleteNotificationChannelRequest { } export interface DeletePolicyRequest { /** * The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies. */ PolicyId: PolicyId; /** * If True, the request performs cleanup according to the policy type. For WAF and Shield Advanced policies, the cleanup does the following: Deletes rule groups created by Firewall Manager Removes web ACLs from in-scope resources Deletes web ACLs that contain no rules or rule groups For security group policies, the cleanup does the following for each security group in the policy: Disassociates the security group from in-scope resources Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy For security group common policies, even if set to False, Firewall Manager deletes all security groups created by Firewall Manager that aren't associated with any other resources through another policy. After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope. */ DeleteAllPolicyResources?: Boolean; } export interface DeleteProtocolsListRequest { /** * The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost. */ ListId: ListId; } export interface DeleteResourceSetRequest { /** * A unique identifier for the resource set, used in a request to refer to the resource set. */ Identifier: Base62Id; } export type DependentServiceName = "AWSCONFIG"|"AWSWAF"|"AWSSHIELD_ADVANCED"|"AWSVPC"|string; export type Descriptio