software.amazon.awssdk.services.fms

Interface FmsAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface FmsAsyncClient
extends SdkClient

Service client for accessing FMS asynchronously. This can be created using the static builder() method. 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	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<AssociateAdminAccountResponse>	associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest) Sets the AWS Firewall Manager administrator account.
default CompletableFuture<AssociateAdminAccountResponse>	associateAdminAccount(Consumer<AssociateAdminAccountRequest.Builder> associateAdminAccountRequest) Sets the AWS Firewall Manager administrator account.
static FmsAsyncClientBuilder	builder() Create a builder that can be used to configure and create a FmsAsyncClient.
static FmsAsyncClient	create() Create a FmsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<DeleteNotificationChannelResponse>	deleteNotificationChannel(Consumer<DeleteNotificationChannelRequest.Builder> 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.
default CompletableFuture<DeleteNotificationChannelResponse>	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.
default CompletableFuture<DeletePolicyResponse>	deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Permanently deletes an AWS Firewall Manager policy.
default CompletableFuture<DeletePolicyResponse>	deletePolicy(DeletePolicyRequest deletePolicyRequest) Permanently deletes an AWS Firewall Manager policy.
default CompletableFuture<DisassociateAdminAccountResponse>	disassociateAdminAccount(Consumer<DisassociateAdminAccountRequest.Builder> disassociateAdminAccountRequest) Disassociates the account that has been set as the AWS Firewall Manager administrator account.
default CompletableFuture<DisassociateAdminAccountResponse>	disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest) Disassociates the account that has been set as the AWS Firewall Manager administrator account.
default CompletableFuture<GetAdminAccountResponse>	getAdminAccount(Consumer<GetAdminAccountRequest.Builder> getAdminAccountRequest) Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
default CompletableFuture<GetAdminAccountResponse>	getAdminAccount(GetAdminAccountRequest getAdminAccountRequest) Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
default CompletableFuture<GetComplianceDetailResponse>	getComplianceDetail(Consumer<GetComplianceDetailRequest.Builder> getComplianceDetailRequest) Returns detailed compliance information about the specified member account.
default CompletableFuture<GetComplianceDetailResponse>	getComplianceDetail(GetComplianceDetailRequest getComplianceDetailRequest) Returns detailed compliance information about the specified member account.
default CompletableFuture<GetNotificationChannelResponse>	getNotificationChannel(Consumer<GetNotificationChannelRequest.Builder> getNotificationChannelRequest) Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
default CompletableFuture<GetNotificationChannelResponse>	getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest) Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
default CompletableFuture<GetPolicyResponse>	getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Returns information about the specified AWS Firewall Manager policy.
default CompletableFuture<GetPolicyResponse>	getPolicy(GetPolicyRequest getPolicyRequest) Returns information about the specified AWS Firewall Manager policy.
default CompletableFuture<ListComplianceStatusResponse>	listComplianceStatus(Consumer<ListComplianceStatusRequest.Builder> listComplianceStatusRequest) Returns an array of PolicyComplianceStatus objects in the response.
default CompletableFuture<ListComplianceStatusResponse>	listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest) Returns an array of PolicyComplianceStatus objects in the response.
default CompletableFuture<ListMemberAccountsResponse>	listMemberAccounts(Consumer<ListMemberAccountsRequest.Builder> listMemberAccountsRequest) Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
default CompletableFuture<ListMemberAccountsResponse>	listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest) Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
default CompletableFuture<ListPoliciesResponse>	listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns an array of PolicySummary objects in the response.
default CompletableFuture<ListPoliciesResponse>	listPolicies(ListPoliciesRequest listPoliciesRequest) Returns an array of PolicySummary objects in the response.
default CompletableFuture<PutNotificationChannelResponse>	putNotificationChannel(Consumer<PutNotificationChannelRequest.Builder> putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
default CompletableFuture<PutNotificationChannelResponse>	putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
default CompletableFuture<PutPolicyResponse>	putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest) Creates an AWS Firewall Manager policy.
default CompletableFuture<PutPolicyResponse>	putPolicy(PutPolicyRequest putPolicyRequest) Creates an AWS Firewall Manager policy.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static FmsAsyncClient create()

Create a FmsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static FmsAsyncClientBuilder builder()

Create a builder that can be used to configure and create a FmsAsyncClient.

associateAdminAccount

default CompletableFuture<AssociateAdminAccountResponse> associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest)

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account 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:

A Java Future containing the result of the AssociateAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

associateAdminAccount

default CompletableFuture<AssociateAdminAccountResponse> associateAdminAccount(Consumer<AssociateAdminAccountRequest.Builder> associateAdminAccountRequest)

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account 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.

This is a convenience which creates an instance of the AssociateAdminAccountRequest.Builder avoiding the need to create one manually via AssociateAdminAccountRequest.builder()

Parameters:

associateAdminAccountRequest - A Consumer that will call methods on AssociateAdminAccountRequest.Builder to create a request.

Returns:

A Java Future containing the result of the AssociateAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteNotificationChannel

default CompletableFuture<DeleteNotificationChannelResponse> 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:

A Java Future containing the result of the DeleteNotificationChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteNotificationChannel

default CompletableFuture<DeleteNotificationChannelResponse> deleteNotificationChannel(Consumer<DeleteNotificationChannelRequest.Builder> 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.

This is a convenience which creates an instance of the DeleteNotificationChannelRequest.Builder avoiding the need to create one manually via DeleteNotificationChannelRequest.builder()

Parameters:

deleteNotificationChannelRequest - A Consumer that will call methods on DeleteNotificationChannelRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteNotificationChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deletePolicy

default CompletableFuture<DeletePolicyResponse> deletePolicy(DeletePolicyRequest deletePolicyRequest)

Permanently deletes an AWS Firewall Manager policy.

Parameters:

deletePolicyRequest -

Returns:

A Java Future containing the result of the DeletePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deletePolicy

default CompletableFuture<DeletePolicyResponse> deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest)

Permanently deletes an AWS Firewall Manager policy.

This is a convenience which creates an instance of the DeletePolicyRequest.Builder avoiding the need to create one manually via DeletePolicyRequest.builder()

Parameters:

deletePolicyRequest - A Consumer that will call methods on DeletePolicyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeletePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

disassociateAdminAccount

default CompletableFuture<DisassociateAdminAccountResponse> disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest)

Disassociates the account that has been set as the AWS Firewall Manager administrator account. You will need to submit an AssociateAdminAccount request to set a new account as the AWS Firewall administrator.

Parameters:

disassociateAdminAccountRequest -

Returns:

A Java Future containing the result of the DisassociateAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

disassociateAdminAccount

default CompletableFuture<DisassociateAdminAccountResponse> disassociateAdminAccount(Consumer<DisassociateAdminAccountRequest.Builder> disassociateAdminAccountRequest)

Disassociates the account that has been set as the AWS Firewall Manager administrator account. You will need to submit an AssociateAdminAccount request to set a new account as the AWS Firewall administrator.

This is a convenience which creates an instance of the DisassociateAdminAccountRequest.Builder avoiding the need to create one manually via DisassociateAdminAccountRequest.builder()

Parameters:

disassociateAdminAccountRequest - A Consumer that will call methods on DisassociateAdminAccountRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DisassociateAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getAdminAccount

default CompletableFuture<GetAdminAccountResponse> 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:

A Java Future containing the result of the GetAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getAdminAccount

default CompletableFuture<GetAdminAccountResponse> getAdminAccount(Consumer<GetAdminAccountRequest.Builder> getAdminAccountRequest)

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

This is a convenience which creates an instance of the GetAdminAccountRequest.Builder avoiding the need to create one manually via GetAdminAccountRequest.builder()

Parameters:

getAdminAccountRequest - A Consumer that will call methods on GetAdminAccountRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getComplianceDetail

default CompletableFuture<GetComplianceDetailResponse> 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 non-compliant if the specified policy has not been applied to them.

Parameters:

getComplianceDetailRequest -

Returns:

A Java Future containing the result of the GetComplianceDetail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getComplianceDetail

default CompletableFuture<GetComplianceDetailResponse> getComplianceDetail(Consumer<GetComplianceDetailRequest.Builder> 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 non-compliant if the specified policy has not been applied to them.

This is a convenience which creates an instance of the GetComplianceDetailRequest.Builder avoiding the need to create one manually via GetComplianceDetailRequest.builder()

Parameters:

getComplianceDetailRequest - A Consumer that will call methods on GetComplianceDetailRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetComplianceDetail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getNotificationChannel

default CompletableFuture<GetNotificationChannelResponse> getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest)

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

Parameters:

getNotificationChannelRequest -

Returns:

A Java Future containing the result of the GetNotificationChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getNotificationChannel

default CompletableFuture<GetNotificationChannelResponse> getNotificationChannel(Consumer<GetNotificationChannelRequest.Builder> getNotificationChannelRequest)

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

This is a convenience which creates an instance of the GetNotificationChannelRequest.Builder avoiding the need to create one manually via GetNotificationChannelRequest.builder()

Parameters:

getNotificationChannelRequest - A Consumer that will call methods on GetNotificationChannelRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetNotificationChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getPolicy

default CompletableFuture<GetPolicyResponse> getPolicy(GetPolicyRequest getPolicyRequest)

Returns information about the specified AWS Firewall Manager policy.

Parameters:

getPolicyRequest -

Returns:

A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getPolicy

default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)

Returns information about the specified AWS Firewall Manager policy.

This is a convenience which creates an instance of the GetPolicyRequest.Builder avoiding the need to create one manually via GetPolicyRequest.builder()

Parameters:

getPolicyRequest - A Consumer that will call methods on GetPolicyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listComplianceStatus

default CompletableFuture<ListComplianceStatusResponse> 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:

A Java Future containing the result of the ListComplianceStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listComplianceStatus

default CompletableFuture<ListComplianceStatusResponse> listComplianceStatus(Consumer<ListComplianceStatusRequest.Builder> 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.

This is a convenience which creates an instance of the ListComplianceStatusRequest.Builder avoiding the need to create one manually via ListComplianceStatusRequest.builder()

Parameters:

listComplianceStatusRequest - A Consumer that will call methods on ListComplianceStatusRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListComplianceStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listMemberAccounts

default CompletableFuture<ListMemberAccountsResponse> 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:

A Java Future containing the result of the ListMemberAccounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listMemberAccounts

default CompletableFuture<ListMemberAccountsResponse> listMemberAccounts(Consumer<ListMemberAccountsRequest.Builder> 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.

This is a convenience which creates an instance of the ListMemberAccountsRequest.Builder avoiding the need to create one manually via ListMemberAccountsRequest.builder()

Parameters:

listMemberAccountsRequest - A Consumer that will call methods on ListMemberAccountsRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListMemberAccounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listPolicies

default CompletableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest listPoliciesRequest)

Returns an array of PolicySummary objects in the response.

Parameters:

listPoliciesRequest -

Returns:

A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listPolicies

default CompletableFuture<ListPoliciesResponse> listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest)

Returns an array of PolicySummary objects in the response.

This is a convenience which creates an instance of the ListPoliciesRequest.Builder avoiding the need to create one manually via ListPoliciesRequest.builder()

Parameters:

listPoliciesRequest - A Consumer that will call methods on ListPoliciesRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

putNotificationChannel

default CompletableFuture<PutNotificationChannelResponse> 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:

A Java Future containing the result of the PutNotificationChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

putNotificationChannel

default CompletableFuture<PutNotificationChannelResponse> putNotificationChannel(Consumer<PutNotificationChannelRequest.Builder> putNotificationChannelRequest)

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

This is a convenience which creates an instance of the PutNotificationChannelRequest.Builder avoiding the need to create one manually via PutNotificationChannelRequest.builder()

Parameters:

putNotificationChannelRequest - A Consumer that will call methods on PutNotificationChannelRequest.Builder to create a request.

Returns:

A Java Future containing the result of the PutNotificationChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

putPolicy

default CompletableFuture<PutPolicyResponse> putPolicy(PutPolicyRequest putPolicyRequest)

Creates an AWS Firewall Manager policy.

Parameters:

putPolicyRequest -

Returns:

A Java Future containing the result of the PutPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

putPolicy

default CompletableFuture<PutPolicyResponse> putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest)

Creates an AWS Firewall Manager policy.

This is a convenience which creates an instance of the PutPolicyRequest.Builder avoiding the need to create one manually via PutPolicyRequest.builder()

Parameters:

putPolicyRequest - A Consumer that will call methods on PutPolicyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the PutPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• FmsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation