@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSFMSClient extends AmazonWebServiceClient implements AWSFMS
This is the Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide.
Some API actions require explicit resource permissions. For information, see the developer guide topic Service roles for Firewall Manager.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateAdminAccountResult |
associateAdminAccount(AssociateAdminAccountRequest request)
Sets a Firewall Manager default administrator account.
|
AssociateThirdPartyFirewallResult |
associateThirdPartyFirewall(AssociateThirdPartyFirewallRequest request)
Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.
|
BatchAssociateResourceResult |
batchAssociateResource(BatchAssociateResourceRequest request)
Associate resources to a Firewall Manager resource set.
|
BatchDisassociateResourceResult |
batchDisassociateResource(BatchDisassociateResourceRequest request)
Disassociates resources from a Firewall Manager resource set.
|
static AWSFMSClientBuilder |
builder() |
DeleteAppsListResult |
deleteAppsList(DeleteAppsListRequest request)
Permanently deletes an Firewall Manager applications list.
|
DeleteNotificationChannelResult |
deleteNotificationChannel(DeleteNotificationChannelRequest request)
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.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Permanently deletes an Firewall Manager policy.
|
DeleteProtocolsListResult |
deleteProtocolsList(DeleteProtocolsListRequest request)
Permanently deletes an Firewall Manager protocols list.
|
DeleteResourceSetResult |
deleteResourceSet(DeleteResourceSetRequest request)
Deletes the specified ResourceSet.
|
DisassociateAdminAccountResult |
disassociateAdminAccount(DisassociateAdminAccountRequest request)
Disassociates an Firewall Manager administrator account.
|
DisassociateThirdPartyFirewallResult |
disassociateThirdPartyFirewall(DisassociateThirdPartyFirewallRequest request)
Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.
|
GetAdminAccountResult |
getAdminAccount(GetAdminAccountRequest request)
Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default
administrator.
|
GetAdminScopeResult |
getAdminScope(GetAdminScopeRequest request)
Returns information about the specified account's administrative scope.
|
GetAppsListResult |
getAppsList(GetAppsListRequest request)
Returns information about the specified Firewall Manager applications list.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetComplianceDetailResult |
getComplianceDetail(GetComplianceDetailRequest request)
Returns detailed compliance information about the specified member account.
|
GetNotificationChannelResult |
getNotificationChannel(GetNotificationChannelRequest request)
Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS
logs.
|
GetPolicyResult |
getPolicy(GetPolicyRequest request)
Returns information about the specified Firewall Manager policy.
|
GetProtectionStatusResult |
getProtectionStatus(GetProtectionStatusRequest request)
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a
potential DDoS attack.
|
GetProtocolsListResult |
getProtocolsList(GetProtocolsListRequest request)
Returns information about the specified Firewall Manager protocols list.
|
GetResourceSetResult |
getResourceSet(GetResourceSetRequest request)
Gets information about a specific resource set.
|
GetThirdPartyFirewallAssociationStatusResult |
getThirdPartyFirewallAssociationStatus(GetThirdPartyFirewallAssociationStatusRequest request)
The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
|
GetViolationDetailsResult |
getViolationDetails(GetViolationDetailsRequest request)
Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services
account.
|
ListAdminAccountsForOrganizationResult |
listAdminAccountsForOrganization(ListAdminAccountsForOrganizationRequest request)
Returns a
AdminAccounts object that lists the Firewall Manager administrators within the
organization that are onboarded to Firewall Manager by AssociateAdminAccount. |
ListAdminsManagingAccountResult |
listAdminsManagingAccount(ListAdminsManagingAccountRequest request)
Lists the accounts that are managing the specified Organizations member account.
|
ListAppsListsResult |
listAppsLists(ListAppsListsRequest request)
Returns an array of
AppsListDataSummary objects. |
ListComplianceStatusResult |
listComplianceStatus(ListComplianceStatusRequest request)
Returns an array of
PolicyComplianceStatus objects. |
ListDiscoveredResourcesResult |
listDiscoveredResources(ListDiscoveredResourcesRequest request)
Returns an array of resources in the organization's accounts that are available to be associated with a resource
set.
|
ListMemberAccountsResult |
listMemberAccounts(ListMemberAccountsRequest request)
Returns a
MemberAccounts object that lists the member accounts in the administrator's Amazon Web
Services organization. |
ListPoliciesResult |
listPolicies(ListPoliciesRequest request)
Returns an array of
PolicySummary objects. |
ListProtocolsListsResult |
listProtocolsLists(ListProtocolsListsRequest request)
Returns an array of
ProtocolsListDataSummary objects. |
ListResourceSetResourcesResult |
listResourceSetResources(ListResourceSetResourcesRequest request)
Returns an array of resources that are currently associated to a resource set.
|
ListResourceSetsResult |
listResourceSets(ListResourceSetsRequest request)
Returns an array of
ResourceSetSummary objects. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for the specified Amazon Web Services resource.
|
ListThirdPartyFirewallFirewallPoliciesResult |
listThirdPartyFirewallFirewallPolicies(ListThirdPartyFirewallFirewallPoliciesRequest request)
Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall
administrator's account.
|
PutAdminAccountResult |
putAdminAccount(PutAdminAccountRequest request)
Creates or updates an Firewall Manager administrator account.
|
PutAppsListResult |
putAppsList(PutAppsListRequest request)
Creates an Firewall Manager applications list.
|
PutNotificationChannelResult |
putNotificationChannel(PutNotificationChannelRequest request)
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record
SNS logs.
|
PutPolicyResult |
putPolicy(PutPolicyRequest request)
Creates an Firewall Manager policy.
|
PutProtocolsListResult |
putProtocolsList(PutProtocolsListRequest request)
Creates an Firewall Manager protocols list.
|
PutResourceSetResult |
putResourceSet(PutResourceSetRequest request)
Creates the resource set.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to an Amazon Web Services resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from an Amazon Web Services resource.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSFMSClientBuilder builder()
public AssociateAdminAccountResult associateAdminAccount(AssociateAdminAccountRequest request)
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
in interface AWSFMS
associateAdminAccountRequest
- 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.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.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.public AssociateThirdPartyFirewallResult associateThirdPartyFirewall(AssociateThirdPartyFirewallRequest request)
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
in interface AWSFMS
associateThirdPartyFirewallRequest
- 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.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public BatchAssociateResourceResult batchAssociateResource(BatchAssociateResourceRequest request)
Associate resources to a Firewall Manager resource set.
batchAssociateResource
in interface AWSFMS
batchAssociateResourceRequest
- 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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.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.ResourceNotFoundException
- The specified resource was not found.public BatchDisassociateResourceResult batchDisassociateResource(BatchDisassociateResourceRequest request)
Disassociates resources from a Firewall Manager resource set.
batchDisassociateResource
in interface AWSFMS
batchDisassociateResourceRequest
- 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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.public DeleteAppsListResult deleteAppsList(DeleteAppsListRequest request)
Permanently deletes an Firewall Manager applications list.
deleteAppsList
in interface AWSFMS
deleteAppsListRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DeleteNotificationChannelResult deleteNotificationChannel(DeleteNotificationChannelRequest request)
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
in interface AWSFMS
deleteNotificationChannelRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
Permanently deletes an Firewall Manager policy.
deletePolicy
in interface AWSFMS
deletePolicyRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.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.public DeleteProtocolsListResult deleteProtocolsList(DeleteProtocolsListRequest request)
Permanently deletes an Firewall Manager protocols list.
deleteProtocolsList
in interface AWSFMS
deleteProtocolsListRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DeleteResourceSetResult deleteResourceSet(DeleteResourceSetRequest request)
Deletes the specified ResourceSet.
deleteResourceSet
in interface AWSFMS
deleteResourceSetRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.public DisassociateAdminAccountResult disassociateAdminAccount(DisassociateAdminAccountRequest request)
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
in interface AWSFMS
disassociateAdminAccountRequest
- 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.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DisassociateThirdPartyFirewallResult disassociateThirdPartyFirewall(DisassociateThirdPartyFirewallRequest request)
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
in interface AWSFMS
disassociateThirdPartyFirewallRequest
- 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.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetAdminAccountResult getAdminAccount(GetAdminAccountRequest request)
Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.
getAdminAccount
in interface AWSFMS
getAdminAccountRequest
- 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.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetAdminScopeResult getAdminScope(GetAdminScopeRequest request)
Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.
getAdminScope
in interface AWSFMS
getAdminScopeRequest
- 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.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.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.public GetAppsListResult getAppsList(GetAppsListRequest request)
Returns information about the specified Firewall Manager applications list.
getAppsList
in interface AWSFMS
getAppsListRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetComplianceDetailResult getComplianceDetail(GetComplianceDetailRequest request)
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
in interface AWSFMS
getComplianceDetailRequest
- ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.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.public GetNotificationChannelResult getNotificationChannel(GetNotificationChannelRequest request)
Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
getNotificationChannel
in interface AWSFMS
getNotificationChannelRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetPolicyResult getPolicy(GetPolicyRequest request)
Returns information about the specified Firewall Manager policy.
getPolicy
in interface AWSFMS
getPolicyRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidTypeException
- The value of the Type
parameter is invalid.public GetProtectionStatusResult getProtectionStatus(GetProtectionStatusRequest request)
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
in interface AWSFMS
getProtectionStatusRequest
- InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetProtocolsListResult getProtocolsList(GetProtocolsListRequest request)
Returns information about the specified Firewall Manager protocols list.
getProtocolsList
in interface AWSFMS
getProtocolsListRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetResourceSetResult getResourceSet(GetResourceSetRequest request)
Gets information about a specific resource set.
getResourceSet
in interface AWSFMS
getResourceSetRequest
- 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.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetThirdPartyFirewallAssociationStatusResult getThirdPartyFirewallAssociationStatus(GetThirdPartyFirewallAssociationStatusRequest request)
The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
getThirdPartyFirewallAssociationStatus
in interface AWSFMS
getThirdPartyFirewallAssociationStatusRequest
- 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.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetViolationDetailsResult getViolationDetails(GetViolationDetailsRequest request)
Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
getViolationDetails
in interface AWSFMS
getViolationDetailsRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidInputException
- The parameters of the request were invalid.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListAdminAccountsForOrganizationResult listAdminAccountsForOrganization(ListAdminAccountsForOrganizationRequest request)
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
in interface AWSFMS
listAdminAccountsForOrganizationRequest
- 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.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.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.public ListAdminsManagingAccountResult listAdminsManagingAccount(ListAdminsManagingAccountRequest request)
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
in interface AWSFMS
listAdminsManagingAccountRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidInputException
- The parameters of the request were invalid.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListAppsListsResult listAppsLists(ListAppsListsRequest request)
Returns an array of AppsListDataSummary
objects.
listAppsLists
in interface AWSFMS
listAppsListsRequest
- ResourceNotFoundException
- The specified resource was not found.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.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListComplianceStatusResult listComplianceStatus(ListComplianceStatusRequest request)
Returns an array of PolicyComplianceStatus
objects. Use PolicyComplianceStatus
to get a
summary of which member accounts are protected by the specified policy.
listComplianceStatus
in interface AWSFMS
listComplianceStatusRequest
- ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest request)
Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
listDiscoveredResources
in interface AWSFMS
listDiscoveredResourcesRequest
- 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.InvalidInputException
- The parameters of the request were invalid.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListMemberAccountsResult listMemberAccounts(ListMemberAccountsRequest request)
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
in interface AWSFMS
listMemberAccountsRequest
- ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListPoliciesResult listPolicies(ListPoliciesRequest request)
Returns an array of PolicySummary
objects.
listPolicies
in interface AWSFMS
listPoliciesRequest
- ResourceNotFoundException
- The specified resource was not found.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.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListProtocolsListsResult listProtocolsLists(ListProtocolsListsRequest request)
Returns an array of ProtocolsListDataSummary
objects.
listProtocolsLists
in interface AWSFMS
listProtocolsListsRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListResourceSetResourcesResult listResourceSetResources(ListResourceSetResourcesRequest request)
Returns an array of resources that are currently associated to a resource set.
listResourceSetResources
in interface AWSFMS
listResourceSetResourcesRequest
- 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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.public ListResourceSetsResult listResourceSets(ListResourceSetsRequest request)
Returns an array of ResourceSetSummary
objects.
listResourceSets
in interface AWSFMS
listResourceSetsRequest
- 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.InvalidInputException
- The parameters of the request were invalid.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for the specified Amazon Web Services resource.
listTagsForResource
in interface AWSFMS
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.public ListThirdPartyFirewallFirewallPoliciesResult listThirdPartyFirewallFirewallPolicies(ListThirdPartyFirewallFirewallPoliciesRequest request)
Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
listThirdPartyFirewallFirewallPolicies
in interface AWSFMS
listThirdPartyFirewallFirewallPoliciesRequest
- 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.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public PutAdminAccountResult putAdminAccount(PutAdminAccountRequest request)
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
in interface AWSFMS
putAdminAccountRequest
- 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.InvalidInputException
- The parameters of the request were invalid.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.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.public PutAppsListResult putAppsList(PutAppsListRequest request)
Creates an Firewall Manager applications list.
putAppsList
in interface AWSFMS
putAppsListRequest
- ResourceNotFoundException
- The specified resource was not found.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.InvalidInputException
- The parameters of the request were invalid.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public PutNotificationChannelResult putNotificationChannel(PutNotificationChannelRequest request)
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
in interface AWSFMS
putNotificationChannelRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public PutPolicyResult putPolicy(PutPolicyRequest request)
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
in interface AWSFMS
putPolicyRequest
- ResourceNotFoundException
- The specified resource was not found.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.InvalidInputException
- The parameters of the request were invalid.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidTypeException
- The value of the Type
parameter is invalid.public PutProtocolsListResult putProtocolsList(PutProtocolsListRequest request)
Creates an Firewall Manager protocols list.
putProtocolsList
in interface AWSFMS
putProtocolsListRequest
- ResourceNotFoundException
- The specified resource was not found.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.InvalidInputException
- The parameters of the request were invalid.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public PutResourceSetResult putResourceSet(PutResourceSetRequest request)
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
in interface AWSFMS
putResourceSetRequest
- 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.InvalidInputException
- The parameters of the request were invalid.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to an Amazon Web Services resource.
tagResource
in interface AWSFMS
tagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from an Amazon Web Services resource.
untagResource
in interface AWSFMS
untagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.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.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AWSFMS
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSFMS
shutdown
in class AmazonWebServiceClient