@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 Firewall Manager required permissions for API actions.
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AssociateAdminAccountResult |
associateAdminAccount(AssociateAdminAccountRequest request)
Sets the Firewall Manager 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 the account that has been set as the 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 administrator.
|
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.
|
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.
|
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, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AWSFMSClientBuilder builder()
public AssociateAdminAccountResult associateAdminAccount(AssociateAdminAccountRequest request)
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.
associateAdminAccount in interface AWSFMSassociateAdminAccountRequest - 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 AWSFMSassociateThirdPartyFirewallRequest - 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 AWSFMSbatchAssociateResourceRequest - 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 AWSFMSbatchDisassociateResourceRequest - 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 AWSFMSdeleteAppsListRequest - 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 AWSFMSdeleteNotificationChannelRequest - 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 AWSFMSdeletePolicyRequest - 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 AWSFMSdeleteProtocolsListRequest - 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 AWSFMSdeleteResourceSetRequest - 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 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.
disassociateAdminAccount in interface AWSFMSdisassociateAdminAccountRequest - 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 AWSFMSdisassociateThirdPartyFirewallRequest - 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 administrator.
getAdminAccount in interface AWSFMSgetAdminAccountRequest - 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 GetAppsListResult getAppsList(GetAppsListRequest request)
Returns information about the specified Firewall Manager applications list.
getAppsList in interface AWSFMSgetAppsListRequest - 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.
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.
getComplianceDetail in interface AWSFMSgetComplianceDetailRequest - 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 AWSFMSgetNotificationChannelRequest - 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 AWSFMSgetPolicyRequest - 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 AWSFMSgetProtectionStatusRequest - 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 AWSFMSgetProtocolsListRequest - 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 AWSFMSgetResourceSetRequest - 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 AWSFMSgetThirdPartyFirewallAssociationStatusRequest - 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 AWSFMSgetViolationDetailsRequest - 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 AWSFMSlistAppsListsRequest - 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 AWSFMSlistComplianceStatusRequest - 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 AWSFMSlistDiscoveredResourcesRequest - 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.
The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager
administrator.
listMemberAccounts in interface AWSFMSlistMemberAccountsRequest - 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 AWSFMSlistPoliciesRequest - 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 AWSFMSlistProtocolsListsRequest - 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 AWSFMSlistResourceSetResourcesRequest - 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 AWSFMSlistResourceSetsRequest - 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 AWSFMSlistTagsForResourceRequest - 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 AWSFMSlistThirdPartyFirewallFirewallPoliciesRequest - 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 PutAppsListResult putAppsList(PutAppsListRequest request)
Creates an Firewall Manager applications list.
putAppsList in interface AWSFMSputAppsListRequest - 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 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.
putNotificationChannel in interface AWSFMSputNotificationChannelRequest - 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.
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.
putPolicy in interface AWSFMSputPolicyRequest - 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 AWSFMSputProtocolsListRequest - 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 AWSFMSputResourceSetRequest - 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 AWSFMStagResourceRequest - 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 AWSFMSuntagResourceRequest - 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 AWSFMSrequest - The originally executed requestpublic void shutdown()
AWSFMSshutdown in interface AWSFMSshutdown in class AmazonWebServiceClientCopyright © 2023. All rights reserved.