com.amazonaws.services.fms

Class AWSFMSClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.fms.AWSFMSClient

All Implemented Interfaces:

AWSFMS

Direct Known Subclasses:

AWSFMSAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSFMSClient
extends AmazonWebServiceClient
implements AWSFMS

Client for accessing FMS. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Firewall Manager

This is the AWS Firewall Manager API Reference. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS 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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.fms.AWSFMS

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateAdminAccountResult	associateAdminAccount(AssociateAdminAccountRequest request) Sets the AWS Firewall Manager administrator account.
static AWSFMSClientBuilder	builder()
DeleteAppsListResult	deleteAppsList(DeleteAppsListRequest request) Permanently deletes an AWS Firewall Manager applications list.
DeleteNotificationChannelResult	deleteNotificationChannel(DeleteNotificationChannelRequest request) Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
DeletePolicyResult	deletePolicy(DeletePolicyRequest request) Permanently deletes an AWS Firewall Manager policy.
DeleteProtocolsListResult	deleteProtocolsList(DeleteProtocolsListRequest request) Permanently deletes an AWS Firewall Manager protocols list.
DisassociateAdminAccountResult	disassociateAdminAccount(DisassociateAdminAccountRequest request) Disassociates the account that has been set as the AWS Firewall Manager administrator account.
GetAdminAccountResult	getAdminAccount(GetAdminAccountRequest request) Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
GetAppsListResult	getAppsList(GetAppsListRequest request) Returns information about the specified AWS 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 AWS Firewall Manager SNS logs.
GetPolicyResult	getPolicy(GetPolicyRequest request) Returns information about the specified AWS 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 AWS Firewall Manager protocols list.
GetViolationDetailsResult	getViolationDetails(GetViolationDetailsRequest request) Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
ListAppsListsResult	listAppsLists(ListAppsListsRequest request) Returns an array of AppsListDataSummary objects.
ListComplianceStatusResult	listComplianceStatus(ListComplianceStatusRequest request) Returns an array of PolicyComplianceStatus objects.
ListMemberAccountsResult	listMemberAccounts(ListMemberAccountsRequest request) Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
ListPoliciesResult	listPolicies(ListPoliciesRequest request) Returns an array of PolicySummary objects.
ListProtocolsListsResult	listProtocolsLists(ListProtocolsListsRequest request) Returns an array of ProtocolsListDataSummary objects.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Retrieves the list of tags for the specified AWS resource.
PutAppsListResult	putAppsList(PutAppsListRequest request) Creates an AWS Firewall Manager applications list.
PutNotificationChannelResult	putNotificationChannel(PutNotificationChannelRequest request) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
PutPolicyResult	putPolicy(PutPolicyRequest request) Creates an AWS Firewall Manager policy.
PutProtocolsListResult	putProtocolsList(PutProtocolsListRequest request) Creates an AWS Firewall Manager protocols list.
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 AWS resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from an AWS resource.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSFMSClientBuilder builder()

associateAdminAccount

public AssociateAdminAccountResult associateAdminAccount(AssociateAdminAccountRequest request)

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account of your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.

The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account.

Specified by:

associateAdminAccount in interface AWSFMS

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 AWS 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 AWS 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.

See Also:

AWS API Documentation

deleteAppsList

public DeleteAppsListResult deleteAppsList(DeleteAppsListRequest request)

Permanently deletes an AWS Firewall Manager applications list.

Specified by:

deleteAppsList in interface AWSFMS

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 AWS 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 AWS 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

public DeleteNotificationChannelResult deleteNotificationChannel(DeleteNotificationChannelRequest request)

Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

Specified by:

deleteNotificationChannel in interface AWSFMS

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 AWS 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 AWS 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

public DeletePolicyResult deletePolicy(DeletePolicyRequest request)

Permanently deletes an AWS Firewall Manager policy.

Specified by:

deletePolicy in interface AWSFMS

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 AWS 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 AWS 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 AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.

See Also:

AWS API Documentation

deleteProtocolsList

public DeleteProtocolsListResult deleteProtocolsList(DeleteProtocolsListRequest request)

Permanently deletes an AWS Firewall Manager protocols list.

Specified by:

deleteProtocolsList in interface AWSFMS

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 AWS 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 AWS 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

public DisassociateAdminAccountResult disassociateAdminAccount(DisassociateAdminAccountRequest request)

Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.

Specified by:

disassociateAdminAccount in interface AWSFMS

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 AWS 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 AWS 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

public GetAdminAccountResult getAdminAccount(GetAdminAccountRequest request)

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

Specified by:

getAdminAccount in interface AWSFMS

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 AWS 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 AWS 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

public GetAppsListResult getAppsList(GetAppsListRequest request)

Returns information about the specified AWS Firewall Manager applications list.

Specified by:

getAppsList in interface AWSFMS

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 AWS 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 AWS 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

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 AWS 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.

Specified by:

getComplianceDetail in interface AWSFMS

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 AWS 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 AWS Organizations before you can access it.

See Also:

AWS API Documentation

getNotificationChannel

public GetNotificationChannelResult getNotificationChannel(GetNotificationChannelRequest request)

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

Specified by:

getNotificationChannel in interface AWSFMS

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 AWS 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 AWS 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

public GetPolicyResult getPolicy(GetPolicyRequest request)

Returns information about the specified AWS Firewall Manager policy.

Specified by:

getPolicy in interface AWSFMS

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 AWS 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 AWS 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

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.

Specified by:

getProtectionStatus in interface AWSFMS

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

public GetProtocolsListResult getProtocolsList(GetProtocolsListRequest request)

Returns information about the specified AWS Firewall Manager protocols list.

Specified by:

getProtocolsList in interface AWSFMS

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 AWS 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 AWS 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

public GetViolationDetailsResult getViolationDetails(GetViolationDetailsRequest request)

Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.

Specified by:

getViolationDetails in interface AWSFMS

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

public ListAppsListsResult listAppsLists(ListAppsListsRequest request)

Returns an array of AppsListDataSummary objects.

Specified by:

listAppsLists in interface AWSFMS

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 AWS 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 AWS 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 AWS account. For more information, see Firewall Manager Limits in the AWS 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

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.

Specified by:

listComplianceStatus in interface AWSFMS

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

public ListMemberAccountsResult listMemberAccounts(ListMemberAccountsRequest request)

Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.

The ListMemberAccounts must be submitted by the account that is set as the AWS Firewall Manager administrator.

Specified by:

listMemberAccounts in interface AWSFMS

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

public ListPoliciesResult listPolicies(ListPoliciesRequest request)

Returns an array of PolicySummary objects.

Specified by:

listPolicies in interface AWSFMS

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 AWS 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 AWS 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 AWS account. For more information, see Firewall Manager Limits in the AWS 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

public ListProtocolsListsResult listProtocolsLists(ListProtocolsListsRequest request)

Returns an array of ProtocolsListDataSummary objects.

Specified by:

listProtocolsLists in interface AWSFMS

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 AWS 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 AWS 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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Retrieves the list of tags for the specified AWS resource.

Specified by:

listTagsForResource in interface AWSFMS

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 AWS 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 AWS 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

public PutAppsListResult putAppsList(PutAppsListRequest request)

Creates an AWS Firewall Manager applications list.

Specified by:

putAppsList in interface AWSFMS

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 AWS 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 AWS 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 AWS account. For more information, see Firewall Manager Limits in the AWS 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

public PutNotificationChannelResult putNotificationChannel(PutNotificationChannelRequest request)

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS 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 AWS Firewall Manager Developer Guide.

Specified by:

putNotificationChannel in interface AWSFMS

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 AWS 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 AWS 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

public PutPolicyResult putPolicy(PutPolicyRequest request)

Creates an AWS Firewall Manager policy.

Firewall Manager provides the following types of policies:

• An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.

• An AWS 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 AWS organization.

• An AWS Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon 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.

Specified by:

putPolicy in interface AWSFMS

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 AWS 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 AWS 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 AWS account. For more information, see Firewall Manager Limits in the AWS 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

public PutProtocolsListResult putProtocolsList(PutProtocolsListRequest request)

Creates an AWS Firewall Manager protocols list.

Specified by:

putProtocolsList in interface AWSFMS

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 AWS 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 AWS 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 AWS account. For more information, see Firewall Manager Limits in the AWS 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

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to an AWS resource.

Specified by:

tagResource in interface AWSFMS

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 AWS 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 AWS 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 AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes one or more tags from an AWS resource.

Specified by:

untagResource in interface AWSFMS

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 AWS 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 AWS 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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSFMS

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSFMS

Overrides:

shutdown in class AmazonWebServiceClient