com.amazonaws.services.fms.AWSFMS Maven / Gradle / Ivy

Go to download

/* * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.fms; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.fms.model.*; /** * Interface for accessing FMS. * * Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.fms.AbstractAWSFMS} instead. * * * * 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 Firewall Manager required * permissions for API actions. * */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSFMS { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "fms"; /** * * Sets the Firewall Manager administrator account. The account must be a member of the organization in * Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account * to administer your Firewall Manager policies. * * * The account that you associate with Firewall Manager is called the Firewall Manager administrator account. * * * @param associateAdminAccountRequest * @return Result of the AssociateAdminAccount operation returned by the service. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @sample AWSFMS.AssociateAdminAccount * @see AWS API * Documentation */ AssociateAdminAccountResult associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest); /** * * 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. * * * @param associateThirdPartyFirewallRequest * @return Result of the AssociateThirdPartyFirewall operation returned by the service. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.AssociateThirdPartyFirewall * @see AWS API Documentation */ AssociateThirdPartyFirewallResult associateThirdPartyFirewall(AssociateThirdPartyFirewallRequest associateThirdPartyFirewallRequest); /** * * Permanently deletes an Firewall Manager applications list. * * * @param deleteAppsListRequest * @return Result of the DeleteAppsList operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.DeleteAppsList * @see AWS API * Documentation */ DeleteAppsListResult deleteAppsList(DeleteAppsListRequest deleteAppsListRequest); /** * * 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. * * * @param deleteNotificationChannelRequest * @return Result of the DeleteNotificationChannel operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.DeleteNotificationChannel * @see AWS * API Documentation */ DeleteNotificationChannelResult deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest); /** * * Permanently deletes an Firewall Manager policy. * * * @param deletePolicyRequest * @return Result of the DeletePolicy operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws InvalidInputException * The parameters of the request were invalid. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @sample AWSFMS.DeletePolicy * @see AWS API * Documentation */ DeletePolicyResult deletePolicy(DeletePolicyRequest deletePolicyRequest); /** * * Permanently deletes an Firewall Manager protocols list. * * * @param deleteProtocolsListRequest * @return Result of the DeleteProtocolsList operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.DeleteProtocolsList * @see AWS API * Documentation */ DeleteProtocolsListResult deleteProtocolsList(DeleteProtocolsListRequest deleteProtocolsListRequest); /** * * Disassociates the account that has been set as the Firewall Manager administrator account. To set a different * account as the administrator account, you must submit an AssociateAdminAccount request. * * * @param disassociateAdminAccountRequest * @return Result of the DisassociateAdminAccount operation returned by the service. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.DisassociateAdminAccount * @see AWS * API Documentation */ DisassociateAdminAccountResult disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest); /** * * 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. * * * @param disassociateThirdPartyFirewallRequest * @return Result of the DisassociateThirdPartyFirewall operation returned by the service. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.DisassociateThirdPartyFirewall * @see AWS API Documentation */ DisassociateThirdPartyFirewallResult disassociateThirdPartyFirewall(DisassociateThirdPartyFirewallRequest disassociateThirdPartyFirewallRequest); /** * * Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator. * * * @param getAdminAccountRequest * @return Result of the GetAdminAccount operation returned by the service. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.GetAdminAccount * @see AWS API * Documentation */ GetAdminAccountResult getAdminAccount(GetAdminAccountRequest getAdminAccountRequest); /** * * Returns information about the specified Firewall Manager applications list. * * * @param getAppsListRequest * @return Result of the GetAppsList operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.GetAppsList * @see AWS API * Documentation */ GetAppsListResult getAppsList(GetAppsListRequest getAppsListRequest); /** * * 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. * * * * * @param getComplianceDetailRequest * @return Result of the GetComplianceDetail operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws InvalidInputException * The parameters of the request were invalid. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @sample AWSFMS.GetComplianceDetail * @see AWS API * Documentation */ GetComplianceDetailResult getComplianceDetail(GetComplianceDetailRequest getComplianceDetailRequest); /** * * Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS * logs. * * * @param getNotificationChannelRequest * @return Result of the GetNotificationChannel operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.GetNotificationChannel * @see AWS API * Documentation */ GetNotificationChannelResult getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest); /** * * Returns information about the specified Firewall Manager policy. * * * @param getPolicyRequest * @return Result of the GetPolicy operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws InvalidTypeException * The value of the Type parameter is invalid. * @sample AWSFMS.GetPolicy * @see AWS API * Documentation */ GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest); /** * * 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. * * * @param getProtectionStatusRequest * @return Result of the GetProtectionStatus operation returned by the service. * @throws InvalidInputException * The parameters of the request were invalid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.GetProtectionStatus * @see AWS API * Documentation */ GetProtectionStatusResult getProtectionStatus(GetProtectionStatusRequest getProtectionStatusRequest); /** * * Returns information about the specified Firewall Manager protocols list. * * * @param getProtocolsListRequest * @return Result of the GetProtocolsList operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.GetProtocolsList * @see AWS API * Documentation */ GetProtocolsListResult getProtocolsList(GetProtocolsListRequest getProtocolsListRequest); /** * * The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant. * * * @param getThirdPartyFirewallAssociationStatusRequest * @return Result of the GetThirdPartyFirewallAssociationStatus operation returned by the service. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.GetThirdPartyFirewallAssociationStatus * @see AWS API Documentation */ GetThirdPartyFirewallAssociationStatusResult getThirdPartyFirewallAssociationStatus( GetThirdPartyFirewallAssociationStatusRequest getThirdPartyFirewallAssociationStatusRequest); /** * * Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services * account. * * * @param getViolationDetailsRequest * @return Result of the GetViolationDetails operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidInputException * The parameters of the request were invalid. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.GetViolationDetails * @see AWS API * Documentation */ GetViolationDetailsResult getViolationDetails(GetViolationDetailsRequest getViolationDetailsRequest); /** * * Returns an array of AppsListDataSummary objects. * * * @param listAppsListsRequest * @return Result of the ListAppsLists operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.ListAppsLists * @see AWS API * Documentation */ ListAppsListsResult listAppsLists(ListAppsListsRequest listAppsListsRequest); /** * * Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a * summary of which member accounts are protected by the specified policy. * * * @param listComplianceStatusRequest * @return Result of the ListComplianceStatus operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.ListComplianceStatus * @see AWS API * Documentation */ ListComplianceStatusResult listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest); /** * * Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web * Services organization. * * * The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager * administrator. * * * @param listMemberAccountsRequest * @return Result of the ListMemberAccounts operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.ListMemberAccounts * @see AWS API * Documentation */ ListMemberAccountsResult listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest); /** * * Returns an array of PolicySummary objects. * * * @param listPoliciesRequest * @return Result of the ListPolicies operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.ListPolicies * @see AWS API * Documentation */ ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest); /** * * Returns an array of ProtocolsListDataSummary objects. * * * @param listProtocolsListsRequest * @return Result of the ListProtocolsLists operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.ListProtocolsLists * @see AWS API * Documentation */ ListProtocolsListsResult listProtocolsLists(ListProtocolsListsRequest listProtocolsListsRequest); /** * * Retrieves the list of tags for the specified Amazon Web Services resource. * * * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws InvalidInputException * The parameters of the request were invalid. * @sample AWSFMS.ListTagsForResource * @see AWS API * Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** * * Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall * administrator's account. * * * @param listThirdPartyFirewallFirewallPoliciesRequest * @return Result of the ListThirdPartyFirewallFirewallPolicies operation returned by the service. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.ListThirdPartyFirewallFirewallPolicies * @see AWS API Documentation */ ListThirdPartyFirewallFirewallPoliciesResult listThirdPartyFirewallFirewallPolicies( ListThirdPartyFirewallFirewallPoliciesRequest listThirdPartyFirewallFirewallPoliciesRequest); /** * * Creates an Firewall Manager applications list. * * * @param putAppsListRequest * @return Result of the PutAppsList operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.PutAppsList * @see AWS API * Documentation */ PutAppsListResult putAppsList(PutAppsListRequest putAppsListRequest); /** * * 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 configure the SNS topic to allow the Firewall Manager * role AWSServiceRoleForFMS to publish SNS logs. For more information, see Firewall Manager * required permissions for API actions in the Firewall Manager Developer Guide. * * * @param putNotificationChannelRequest * @return Result of the PutNotificationChannel operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.PutNotificationChannel * @see AWS API * Documentation */ PutNotificationChannelResult putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest); /** * * 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 CreateSubscription. * * * @param putPolicyRequest * @return Result of the PutPolicy operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws InvalidTypeException * The value of the Type parameter is invalid. * @sample AWSFMS.PutPolicy * @see AWS API * Documentation */ PutPolicyResult putPolicy(PutPolicyRequest putPolicyRequest); /** * * Creates an Firewall Manager protocols list. * * * @param putProtocolsListRequest * @return Result of the PutProtocolsList operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InvalidInputException * The parameters of the request were invalid. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @sample AWSFMS.PutProtocolsList * @see AWS API * Documentation */ PutProtocolsListResult putProtocolsList(PutProtocolsListRequest putProtocolsListRequest); /** * * Adds one or more tags to an Amazon Web Services resource. * * * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws InvalidInputException * The parameters of the request were invalid. * @throws LimitExceededException * The operation exceeds a resource limit, for example, the maximum number of policy objects * that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits * in the WAF Developer Guide. * @sample AWSFMS.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** * * Removes one or more tags from an Amazon Web Services resource. * * * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InvalidOperationException * The operation failed because there was nothing to do or the operation wasn't possible. For example, you * might have submitted an AssociateAdminAccount request for an account ID that was already set * as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by * default, and that you need to enable for the Firewall Manager administrator account and for Organizations * before you can access it. * @throws InternalErrorException * The operation failed because of a system problem, even though the request was valid. Retry your request. * @throws InvalidInputException * The parameters of the request were invalid. * @sample AWSFMS.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }