com.amazonaws.services.fms

Interface AWSFMS

All Known Subinterfaces:

AWSFMSAsync

All Known Implementing Classes:

AbstractAWSFMS, AbstractAWSFMSAsync, AWSFMSAsyncClient, AWSFMSClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSFMS

Interface for accessing FMS.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSFMS instead.

This is the Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide.

Some API actions require explicit resource permissions. For information, see the developer guide topic Firewall Manager required permissions for API actions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateAdminAccountResult	associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest) Sets the Firewall Manager administrator account.
DeleteAppsListResult	deleteAppsList(DeleteAppsListRequest deleteAppsListRequest) Permanently deletes an Firewall Manager applications list.
DeleteNotificationChannelResult	deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest) 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 deletePolicyRequest) Permanently deletes an Firewall Manager policy.
DeleteProtocolsListResult	deleteProtocolsList(DeleteProtocolsListRequest deleteProtocolsListRequest) Permanently deletes an Firewall Manager protocols list.
DisassociateAdminAccountResult	disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest) Disassociates the account that has been set as the Firewall Manager administrator account.
GetAdminAccountResult	getAdminAccount(GetAdminAccountRequest getAdminAccountRequest) Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.
GetAppsListResult	getAppsList(GetAppsListRequest getAppsListRequest) 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 getComplianceDetailRequest) Returns detailed compliance information about the specified member account.
GetNotificationChannelResult	getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest) Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
GetPolicyResult	getPolicy(GetPolicyRequest getPolicyRequest) Returns information about the specified Firewall Manager policy.
GetProtectionStatusResult	getProtectionStatus(GetProtectionStatusRequest getProtectionStatusRequest) If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
GetProtocolsListResult	getProtocolsList(GetProtocolsListRequest getProtocolsListRequest) Returns information about the specified Firewall Manager protocols list.
GetViolationDetailsResult	getViolationDetails(GetViolationDetailsRequest getViolationDetailsRequest) Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
ListAppsListsResult	listAppsLists(ListAppsListsRequest listAppsListsRequest) Returns an array of AppsListDataSummary objects.
ListComplianceStatusResult	listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest) Returns an array of PolicyComplianceStatus objects.
ListMemberAccountsResult	listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest) Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization.
ListPoliciesResult	listPolicies(ListPoliciesRequest listPoliciesRequest) Returns an array of PolicySummary objects.
ListProtocolsListsResult	listProtocolsLists(ListProtocolsListsRequest listProtocolsListsRequest) Returns an array of ProtocolsListDataSummary objects.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags for the specified Amazon Web Services resource.
PutAppsListResult	putAppsList(PutAppsListRequest putAppsListRequest) Creates an Firewall Manager applications list.
PutNotificationChannelResult	putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
PutPolicyResult	putPolicy(PutPolicyRequest putPolicyRequest) Creates an Firewall Manager policy.
PutProtocolsListResult	putProtocolsList(PutProtocolsListRequest putProtocolsListRequest) Creates an Firewall Manager protocols list.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to an Amazon Web Services resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from an Amazon Web Services resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateAdminAccount

AssociateAdminAccountResult associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest)

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.

Parameters:

associateAdminAccountRequest -

Returns:

Result of the AssociateAdminAccount operation returned by the service.

Throws:

InvalidOperationException - The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.

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.

See Also:

AWS API Documentation

deleteAppsList

DeleteAppsListResult deleteAppsList(DeleteAppsListRequest deleteAppsListRequest)

Permanently deletes an Firewall Manager applications list.

Parameters:

deleteAppsListRequest -

Returns:

Result of the DeleteAppsList operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteNotificationChannel

DeleteNotificationChannelResult deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest)

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.

Parameters:

deleteNotificationChannelRequest -

Returns:

Result of the DeleteNotificationChannel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deletePolicy

DeletePolicyResult deletePolicy(DeletePolicyRequest deletePolicyRequest)

Permanently deletes an Firewall Manager policy.

Parameters:

deletePolicyRequest -

Returns:

Result of the DeletePolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteProtocolsList

DeleteProtocolsListResult deleteProtocolsList(DeleteProtocolsListRequest deleteProtocolsListRequest)

Permanently deletes an Firewall Manager protocols list.

Parameters:

deleteProtocolsListRequest -

Returns:

Result of the DeleteProtocolsList operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disassociateAdminAccount

DisassociateAdminAccountResult disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest)

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.

Parameters:

disassociateAdminAccountRequest -

Returns:

Result of the DisassociateAdminAccount operation returned by the service.

Throws:

InvalidOperationException - The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.

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.

See Also:

AWS API Documentation

getAdminAccount

GetAdminAccountResult getAdminAccount(GetAdminAccountRequest getAdminAccountRequest)

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.

Parameters:

getAdminAccountRequest -

Returns:

Result of the GetAdminAccount operation returned by the service.

Throws:

InvalidOperationException - The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.

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.

See Also:

AWS API Documentation

getAppsList

GetAppsListResult getAppsList(GetAppsListRequest getAppsListRequest)

Returns information about the specified Firewall Manager applications list.

Parameters:

getAppsListRequest -

Returns:

Result of the GetAppsList operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getComplianceDetail

GetComplianceDetailResult getComplianceDetail(GetComplianceDetailRequest getComplianceDetailRequest)

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.

Parameters:

getComplianceDetailRequest -

Returns:

Result of the GetComplianceDetail operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getNotificationChannel

GetNotificationChannelResult getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest)

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

Parameters:

getNotificationChannelRequest -

Returns:

Result of the GetNotificationChannel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getPolicy

GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)

Returns information about the specified Firewall Manager policy.

Parameters:

getPolicyRequest -

Returns:

Result of the GetPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getProtectionStatus

GetProtectionStatusResult getProtectionStatus(GetProtectionStatusRequest getProtectionStatusRequest)

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.

Parameters:

getProtectionStatusRequest -

Returns:

Result of the GetProtectionStatus operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getProtocolsList

GetProtocolsListResult getProtocolsList(GetProtocolsListRequest getProtocolsListRequest)

Returns information about the specified Firewall Manager protocols list.

Parameters:

getProtocolsListRequest -

Returns:

Result of the GetProtocolsList operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getViolationDetails

GetViolationDetailsResult getViolationDetails(GetViolationDetailsRequest getViolationDetailsRequest)

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

Parameters:

getViolationDetailsRequest -

Returns:

Result of the GetViolationDetails operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAppsLists

ListAppsListsResult listAppsLists(ListAppsListsRequest listAppsListsRequest)

Returns an array of AppsListDataSummary objects.

Parameters:

listAppsListsRequest -

Returns:

Result of the ListAppsLists operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listComplianceStatus

ListComplianceStatusResult listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest)

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

Parameters:

listComplianceStatusRequest -

Returns:

Result of the ListComplianceStatus operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listMemberAccounts

ListMemberAccountsResult listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest)

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.

Parameters:

listMemberAccountsRequest -

Returns:

Result of the ListMemberAccounts operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listPolicies

ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest)

Returns an array of PolicySummary objects.

Parameters:

listPoliciesRequest -

Returns:

Result of the ListPolicies operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listProtocolsLists

ListProtocolsListsResult listProtocolsLists(ListProtocolsListsRequest listProtocolsListsRequest)

Returns an array of ProtocolsListDataSummary objects.

Parameters:

listProtocolsListsRequest -

Returns:

Result of the ListProtocolsLists operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Retrieves the list of tags for the specified Amazon Web Services resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putAppsList

PutAppsListResult putAppsList(PutAppsListRequest putAppsListRequest)

Creates an Firewall Manager applications list.

Parameters:

putAppsListRequest -

Returns:

Result of the PutAppsList operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putNotificationChannel

PutNotificationChannelResult putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest)

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.

Parameters:

putNotificationChannelRequest -

Returns:

Result of the PutNotificationChannel operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putPolicy

PutPolicyResult putPolicy(PutPolicyRequest putPolicyRequest)

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.

Parameters:

putPolicyRequest -

Returns:

Result of the PutPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putProtocolsList

PutProtocolsListResult putProtocolsList(PutProtocolsListRequest putProtocolsListRequest)

Creates an Firewall Manager protocols list.

Parameters:

putProtocolsListRequest -

Returns:

Result of the PutProtocolsList operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds one or more tags to an Amazon Web Services resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from an Amazon Web Services resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.