software.amazon.awssdk.services.fms

Interface FmsClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing FMS. 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 AssociateAdminAccountResponse	associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest) Sets the AWS Firewall Manager administrator account.
default AssociateAdminAccountResponse	associateAdminAccount(Consumer<AssociateAdminAccountRequest.Builder> associateAdminAccountRequest) Sets the AWS Firewall Manager administrator account.
static FmsClientBuilder	builder() Create a builder that can be used to configure and create a FmsClient.
static FmsClient	create() Create a FmsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default 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 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 DeletePolicyResponse	deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Permanently deletes an AWS Firewall Manager policy.
default DeletePolicyResponse	deletePolicy(DeletePolicyRequest deletePolicyRequest) Permanently deletes an AWS Firewall Manager policy.
default DisassociateAdminAccountResponse	disassociateAdminAccount(Consumer<DisassociateAdminAccountRequest.Builder> disassociateAdminAccountRequest) Disassociates the account that has been set as the AWS Firewall Manager administrator account.
default DisassociateAdminAccountResponse	disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest) Disassociates the account that has been set as the AWS Firewall Manager administrator account.
default 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 GetAdminAccountResponse	getAdminAccount(GetAdminAccountRequest getAdminAccountRequest) Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
default GetComplianceDetailResponse	getComplianceDetail(Consumer<GetComplianceDetailRequest.Builder> getComplianceDetailRequest) Returns detailed compliance information about the specified member account.
default GetComplianceDetailResponse	getComplianceDetail(GetComplianceDetailRequest getComplianceDetailRequest) Returns detailed compliance information about the specified member account.
default 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 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 GetPolicyResponse	getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Returns information about the specified AWS Firewall Manager policy.
default GetPolicyResponse	getPolicy(GetPolicyRequest getPolicyRequest) Returns information about the specified AWS Firewall Manager policy.
default ListComplianceStatusResponse	listComplianceStatus(Consumer<ListComplianceStatusRequest.Builder> listComplianceStatusRequest) Returns an array of PolicyComplianceStatus objects in the response.
default ListComplianceStatusResponse	listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest) Returns an array of PolicyComplianceStatus objects in the response.
default ListMemberAccountsResponse	listMemberAccounts(Consumer<ListMemberAccountsRequest.Builder> listMemberAccountsRequest) Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
default ListMemberAccountsResponse	listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest) Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
default ListPoliciesResponse	listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns an array of PolicySummary objects in the response.
default ListPoliciesResponse	listPolicies(ListPoliciesRequest listPoliciesRequest) Returns an array of PolicySummary objects in the response.
default 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 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 PutPolicyResponse	putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest) Creates an AWS Firewall Manager policy.
default PutPolicyResponse	putPolicy(PutPolicyRequest putPolicyRequest) Creates an AWS Firewall Manager policy.
static ServiceMetadata	serviceMetadata()

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 FmsClient create()

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

builder

static FmsClientBuilder builder()

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

associateAdminAccount

default AssociateAdminAccountResponse associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest)
                                                     throws InvalidOperationException,
                                                            InvalidInputException,
                                                            ResourceNotFoundException,
                                                            InternalErrorException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

associateAdminAccount

default AssociateAdminAccountResponse associateAdminAccount(Consumer<AssociateAdminAccountRequest.Builder> associateAdminAccountRequest)
                                                     throws InvalidOperationException,
                                                            InvalidInputException,
                                                            ResourceNotFoundException,
                                                            InternalErrorException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

deleteNotificationChannel

default DeleteNotificationChannelResponse deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest)
                                                             throws ResourceNotFoundException,
                                                                    InvalidOperationException,
                                                                    InternalErrorException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

deleteNotificationChannel

default DeleteNotificationChannelResponse deleteNotificationChannel(Consumer<DeleteNotificationChannelRequest.Builder> deleteNotificationChannelRequest)
                                                             throws ResourceNotFoundException,
                                                                    InvalidOperationException,
                                                                    InternalErrorException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

deletePolicy

default DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest)
                                   throws ResourceNotFoundException,
                                          InvalidOperationException,
                                          InternalErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

deletePolicy

default DeletePolicyResponse deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest)
                                   throws ResourceNotFoundException,
                                          InvalidOperationException,
                                          InternalErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

disassociateAdminAccount

default DisassociateAdminAccountResponse disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest)
                                                           throws InvalidOperationException,
                                                                  ResourceNotFoundException,
                                                                  InternalErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

disassociateAdminAccount

default DisassociateAdminAccountResponse disassociateAdminAccount(Consumer<DisassociateAdminAccountRequest.Builder> disassociateAdminAccountRequest)
                                                           throws InvalidOperationException,
                                                                  ResourceNotFoundException,
                                                                  InternalErrorException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getAdminAccount

default GetAdminAccountResponse getAdminAccount(GetAdminAccountRequest getAdminAccountRequest)
                                         throws InvalidOperationException,
                                                ResourceNotFoundException,
                                                InternalErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getAdminAccount

default GetAdminAccountResponse getAdminAccount(Consumer<GetAdminAccountRequest.Builder> getAdminAccountRequest)
                                         throws InvalidOperationException,
                                                ResourceNotFoundException,
                                                InternalErrorException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getComplianceDetail

default GetComplianceDetailResponse getComplianceDetail(GetComplianceDetailRequest getComplianceDetailRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getComplianceDetail

default GetComplianceDetailResponse getComplianceDetail(Consumer<GetComplianceDetailRequest.Builder> getComplianceDetailRequest)
                                                 throws ResourceNotFoundException,
                                                        InternalErrorException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getNotificationChannel

default GetNotificationChannelResponse getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest)
                                                       throws ResourceNotFoundException,
                                                              InvalidOperationException,
                                                              InternalErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              FmsException

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

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.

AwsServiceException

See Also:

AWS API Documentation

getNotificationChannel

default GetNotificationChannelResponse getNotificationChannel(Consumer<GetNotificationChannelRequest.Builder> getNotificationChannelRequest)
                                                       throws ResourceNotFoundException,
                                                              InvalidOperationException,
                                                              InternalErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getPolicy

default GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest)
                             throws ResourceNotFoundException,
                                    InvalidOperationException,
                                    InternalErrorException,
                                    InvalidTypeException,
                                    AwsServiceException,
                                    SdkClientException,
                                    FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getPolicy

default GetPolicyResponse getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)
                             throws ResourceNotFoundException,
                                    InvalidOperationException,
                                    InternalErrorException,
                                    InvalidTypeException,
                                    AwsServiceException,
                                    SdkClientException,
                                    FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listComplianceStatus

default ListComplianceStatusResponse listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest)
                                                   throws ResourceNotFoundException,
                                                          InternalErrorException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listComplianceStatus

default ListComplianceStatusResponse listComplianceStatus(Consumer<ListComplianceStatusRequest.Builder> listComplianceStatusRequest)
                                                   throws ResourceNotFoundException,
                                                          InternalErrorException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listMemberAccounts

default ListMemberAccountsResponse listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest)
                                               throws ResourceNotFoundException,
                                                      InternalErrorException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listMemberAccounts

default ListMemberAccountsResponse listMemberAccounts(Consumer<ListMemberAccountsRequest.Builder> listMemberAccountsRequest)
                                               throws ResourceNotFoundException,
                                                      InternalErrorException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listPolicies

default ListPoliciesResponse listPolicies(ListPoliciesRequest listPoliciesRequest)
                                   throws ResourceNotFoundException,
                                          InvalidOperationException,
                                          LimitExceededException,
                                          InternalErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listPolicies

default ListPoliciesResponse listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest)
                                   throws ResourceNotFoundException,
                                          InvalidOperationException,
                                          LimitExceededException,
                                          InternalErrorException,
                                          AwsServiceException,
                                          SdkClientException,
                                          FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

putNotificationChannel

default PutNotificationChannelResponse putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest)
                                                       throws ResourceNotFoundException,
                                                              InvalidOperationException,
                                                              InternalErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              FmsException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

putNotificationChannel

default PutNotificationChannelResponse putNotificationChannel(Consumer<PutNotificationChannelRequest.Builder> putNotificationChannelRequest)
                                                       throws ResourceNotFoundException,
                                                              InvalidOperationException,
                                                              InternalErrorException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

putPolicy

default PutPolicyResponse putPolicy(PutPolicyRequest putPolicyRequest)
                             throws ResourceNotFoundException,
                                    InvalidOperationException,
                                    InvalidInputException,
                                    LimitExceededException,
                                    InternalErrorException,
                                    InvalidTypeException,
                                    AwsServiceException,
                                    SdkClientException,
                                    FmsException

Creates an AWS Firewall Manager policy.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

putPolicy

default PutPolicyResponse putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest)
                             throws ResourceNotFoundException,
                                    InvalidOperationException,
                                    InvalidInputException,
                                    LimitExceededException,
                                    InternalErrorException,
                                    InvalidTypeException,
                                    AwsServiceException,
                                    SdkClientException,
                                    FmsException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()