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.

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.

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 AWS Firewall Manager administrator account.
DeleteNotificationChannelResult	deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest) 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 deletePolicyRequest) Permanently deletes an AWS Firewall Manager policy.
DisassociateAdminAccountResult	disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest) Disassociates the account that has been set as the AWS Firewall Manager administrator account.
GetAdminAccountResult	getAdminAccount(GetAdminAccountRequest getAdminAccountRequest) Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
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 AWS Firewall Manager SNS logs.
GetPolicyResult	getPolicy(GetPolicyRequest getPolicyRequest) Returns information about the specified AWS 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.
ListComplianceStatusResult	listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest) Returns an array of PolicyComplianceStatus objects in the response.
ListMemberAccountsResult	listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest) Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
ListPoliciesResult	listPolicies(ListPoliciesRequest listPoliciesRequest) Returns an array of PolicySummary objects in the response.
PutNotificationChannelResult	putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
PutPolicyResult	putPolicy(PutPolicyRequest putPolicyRequest) Creates an AWS Firewall Manager policy.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

Parameters:

associateAdminAccountRequest -

Returns:

Result of the AssociateAdminAccount operation returned by the service.

Throws:

InvalidOperationException - The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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

deleteNotificationChannel

DeleteNotificationChannelResult deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest)

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.

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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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 AWS 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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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 AWS 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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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 AWS Organizations master account that is associated with AWS Firewall Manager as the AWS 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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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

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

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.

See Also:

AWS API Documentation

getNotificationChannel

GetNotificationChannelResult getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest)

Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS 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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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 AWS 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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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

listComplianceStatus

ListComplianceStatusResult listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest)

Returns an array of PolicyComplianceStatus objects in the response. 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 AWS organization.

The ListMemberAccounts must be submitted by the account that is set as the AWS 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 in the response.

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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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

PutNotificationChannelResult putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest)

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.

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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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 AWS Firewall Manager policy.

Firewall Manager provides the following types of policies:

• A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources

• An AWS WAF policy, which contains a rule group and defines which resources are to be protected by that rule group

• A security group policy, which manages VPC security groups across your AWS organization.

Each policy is specific to one of the three types. If you want to enforce more than one policy type across accounts, you can 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. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

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

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.