Interface FmsAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The
asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the
SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such
as credentials retrieval and endpoint discovery as part of the async API call.
This is the Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the Firewall Manager Developer Guide.
Some API actions require explicit resource permissions. For information, see the developer guide topic Service roles for Firewall Manager.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionassociateAdminAccount(Consumer<AssociateAdminAccountRequest.Builder> associateAdminAccountRequest) Sets a Firewall Manager default administrator account.associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest) Sets a Firewall Manager default administrator account.associateThirdPartyFirewall(Consumer<AssociateThirdPartyFirewallRequest.Builder> associateThirdPartyFirewallRequest) Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.associateThirdPartyFirewall(AssociateThirdPartyFirewallRequest associateThirdPartyFirewallRequest) Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.batchAssociateResource(Consumer<BatchAssociateResourceRequest.Builder> batchAssociateResourceRequest) Associate resources to a Firewall Manager resource set.batchAssociateResource(BatchAssociateResourceRequest batchAssociateResourceRequest) Associate resources to a Firewall Manager resource set.batchDisassociateResource(Consumer<BatchDisassociateResourceRequest.Builder> batchDisassociateResourceRequest) Disassociates resources from a Firewall Manager resource set.batchDisassociateResource(BatchDisassociateResourceRequest batchDisassociateResourceRequest) Disassociates resources from a Firewall Manager resource set.static FmsAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aFmsAsyncClient.static FmsAsyncClientcreate()Create aFmsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<DeleteAppsListResponse> deleteAppsList(Consumer<DeleteAppsListRequest.Builder> deleteAppsListRequest) Permanently deletes an Firewall Manager applications list.default CompletableFuture<DeleteAppsListResponse> deleteAppsList(DeleteAppsListRequest deleteAppsListRequest) Permanently deletes an Firewall Manager applications list.deleteNotificationChannel(Consumer<DeleteNotificationChannelRequest.Builder> deleteNotificationChannelRequest) Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest) Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.default CompletableFuture<DeletePolicyResponse> deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Permanently deletes an Firewall Manager policy.default CompletableFuture<DeletePolicyResponse> deletePolicy(DeletePolicyRequest deletePolicyRequest) Permanently deletes an Firewall Manager policy.deleteProtocolsList(Consumer<DeleteProtocolsListRequest.Builder> deleteProtocolsListRequest) Permanently deletes an Firewall Manager protocols list.deleteProtocolsList(DeleteProtocolsListRequest deleteProtocolsListRequest) Permanently deletes an Firewall Manager protocols list.deleteResourceSet(Consumer<DeleteResourceSetRequest.Builder> deleteResourceSetRequest) Deletes the specified ResourceSet.deleteResourceSet(DeleteResourceSetRequest deleteResourceSetRequest) Deletes the specified ResourceSet.disassociateAdminAccount(Consumer<DisassociateAdminAccountRequest.Builder> disassociateAdminAccountRequest) Disassociates an Firewall Manager administrator account.disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest) Disassociates an Firewall Manager administrator account.disassociateThirdPartyFirewall(Consumer<DisassociateThirdPartyFirewallRequest.Builder> disassociateThirdPartyFirewallRequest) Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.disassociateThirdPartyFirewall(DisassociateThirdPartyFirewallRequest disassociateThirdPartyFirewallRequest) Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.default CompletableFuture<GetAdminAccountResponse> getAdminAccount(Consumer<GetAdminAccountRequest.Builder> getAdminAccountRequest) Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.default CompletableFuture<GetAdminAccountResponse> getAdminAccount(GetAdminAccountRequest getAdminAccountRequest) Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.default CompletableFuture<GetAdminScopeResponse> getAdminScope(Consumer<GetAdminScopeRequest.Builder> getAdminScopeRequest) Returns information about the specified account's administrative scope.default CompletableFuture<GetAdminScopeResponse> getAdminScope(GetAdminScopeRequest getAdminScopeRequest) Returns information about the specified account's administrative scope.default CompletableFuture<GetAppsListResponse> getAppsList(Consumer<GetAppsListRequest.Builder> getAppsListRequest) Returns information about the specified Firewall Manager applications list.default CompletableFuture<GetAppsListResponse> getAppsList(GetAppsListRequest getAppsListRequest) Returns information about the specified Firewall Manager applications list.getComplianceDetail(Consumer<GetComplianceDetailRequest.Builder> getComplianceDetailRequest) Returns detailed compliance information about the specified member account.getComplianceDetail(GetComplianceDetailRequest getComplianceDetailRequest) Returns detailed compliance information about the specified member account.getNotificationChannel(Consumer<GetNotificationChannelRequest.Builder> getNotificationChannelRequest) Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest) Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Returns information about the specified Firewall Manager policy.default CompletableFuture<GetPolicyResponse> getPolicy(GetPolicyRequest getPolicyRequest) Returns information about the specified Firewall Manager policy.getProtectionStatus(Consumer<GetProtectionStatusRequest.Builder> getProtectionStatusRequest) If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.getProtectionStatus(GetProtectionStatusRequest getProtectionStatusRequest) If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.getProtocolsList(Consumer<GetProtocolsListRequest.Builder> getProtocolsListRequest) Returns information about the specified Firewall Manager protocols list.getProtocolsList(GetProtocolsListRequest getProtocolsListRequest) Returns information about the specified Firewall Manager protocols list.default CompletableFuture<GetResourceSetResponse> getResourceSet(Consumer<GetResourceSetRequest.Builder> getResourceSetRequest) Gets information about a specific resource set.default CompletableFuture<GetResourceSetResponse> getResourceSet(GetResourceSetRequest getResourceSetRequest) Gets information about a specific resource set.getThirdPartyFirewallAssociationStatus(Consumer<GetThirdPartyFirewallAssociationStatusRequest.Builder> getThirdPartyFirewallAssociationStatusRequest) The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.getThirdPartyFirewallAssociationStatus(GetThirdPartyFirewallAssociationStatusRequest getThirdPartyFirewallAssociationStatusRequest) The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.getViolationDetails(Consumer<GetViolationDetailsRequest.Builder> getViolationDetailsRequest) Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.getViolationDetails(GetViolationDetailsRequest getViolationDetailsRequest) Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.listAdminAccountsForOrganization(Consumer<ListAdminAccountsForOrganizationRequest.Builder> listAdminAccountsForOrganizationRequest) Returns aAdminAccountsobject that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.listAdminAccountsForOrganization(ListAdminAccountsForOrganizationRequest listAdminAccountsForOrganizationRequest) Returns aAdminAccountsobject that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.listAdminAccountsForOrganizationPaginator(Consumer<ListAdminAccountsForOrganizationRequest.Builder> listAdminAccountsForOrganizationRequest) This is a variant oflistAdminAccountsForOrganization(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationRequest)operation.listAdminAccountsForOrganizationPaginator(ListAdminAccountsForOrganizationRequest listAdminAccountsForOrganizationRequest) This is a variant oflistAdminAccountsForOrganization(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationRequest)operation.listAdminsManagingAccount(Consumer<ListAdminsManagingAccountRequest.Builder> listAdminsManagingAccountRequest) Lists the accounts that are managing the specified Organizations member account.listAdminsManagingAccount(ListAdminsManagingAccountRequest listAdminsManagingAccountRequest) Lists the accounts that are managing the specified Organizations member account.listAdminsManagingAccountPaginator(Consumer<ListAdminsManagingAccountRequest.Builder> listAdminsManagingAccountRequest) This is a variant oflistAdminsManagingAccount(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountRequest)operation.listAdminsManagingAccountPaginator(ListAdminsManagingAccountRequest listAdminsManagingAccountRequest) This is a variant oflistAdminsManagingAccount(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountRequest)operation.default CompletableFuture<ListAppsListsResponse> listAppsLists(Consumer<ListAppsListsRequest.Builder> listAppsListsRequest) Returns an array ofAppsListDataSummaryobjects.default CompletableFuture<ListAppsListsResponse> listAppsLists(ListAppsListsRequest listAppsListsRequest) Returns an array ofAppsListDataSummaryobjects.default ListAppsListsPublisherlistAppsListsPaginator(Consumer<ListAppsListsRequest.Builder> listAppsListsRequest) This is a variant oflistAppsLists(software.amazon.awssdk.services.fms.model.ListAppsListsRequest)operation.default ListAppsListsPublisherlistAppsListsPaginator(ListAppsListsRequest listAppsListsRequest) This is a variant oflistAppsLists(software.amazon.awssdk.services.fms.model.ListAppsListsRequest)operation.listComplianceStatus(Consumer<ListComplianceStatusRequest.Builder> listComplianceStatusRequest) Returns an array ofPolicyComplianceStatusobjects.listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest) Returns an array ofPolicyComplianceStatusobjects.default ListComplianceStatusPublisherlistComplianceStatusPaginator(Consumer<ListComplianceStatusRequest.Builder> listComplianceStatusRequest) This is a variant oflistComplianceStatus(software.amazon.awssdk.services.fms.model.ListComplianceStatusRequest)operation.default ListComplianceStatusPublisherlistComplianceStatusPaginator(ListComplianceStatusRequest listComplianceStatusRequest) This is a variant oflistComplianceStatus(software.amazon.awssdk.services.fms.model.ListComplianceStatusRequest)operation.listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) Returns an array of resources in the organization's accounts that are available to be associated with a resource set.listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) Returns an array of resources in the organization's accounts that are available to be associated with a resource set.listMemberAccounts(Consumer<ListMemberAccountsRequest.Builder> listMemberAccountsRequest) Returns aMemberAccountsobject that lists the member accounts in the administrator's Amazon Web Services organization.listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest) Returns aMemberAccountsobject that lists the member accounts in the administrator's Amazon Web Services organization.default ListMemberAccountsPublisherlistMemberAccountsPaginator(Consumer<ListMemberAccountsRequest.Builder> listMemberAccountsRequest) This is a variant oflistMemberAccounts(software.amazon.awssdk.services.fms.model.ListMemberAccountsRequest)operation.default ListMemberAccountsPublisherlistMemberAccountsPaginator(ListMemberAccountsRequest listMemberAccountsRequest) This is a variant oflistMemberAccounts(software.amazon.awssdk.services.fms.model.ListMemberAccountsRequest)operation.default CompletableFuture<ListPoliciesResponse> listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns an array ofPolicySummaryobjects.default CompletableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest listPoliciesRequest) Returns an array ofPolicySummaryobjects.default ListPoliciesPublisherlistPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.fms.model.ListPoliciesRequest)operation.default ListPoliciesPublisherlistPoliciesPaginator(ListPoliciesRequest listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.fms.model.ListPoliciesRequest)operation.listProtocolsLists(Consumer<ListProtocolsListsRequest.Builder> listProtocolsListsRequest) Returns an array ofProtocolsListDataSummaryobjects.listProtocolsLists(ListProtocolsListsRequest listProtocolsListsRequest) Returns an array ofProtocolsListDataSummaryobjects.default ListProtocolsListsPublisherlistProtocolsListsPaginator(Consumer<ListProtocolsListsRequest.Builder> listProtocolsListsRequest) This is a variant oflistProtocolsLists(software.amazon.awssdk.services.fms.model.ListProtocolsListsRequest)operation.default ListProtocolsListsPublisherlistProtocolsListsPaginator(ListProtocolsListsRequest listProtocolsListsRequest) This is a variant oflistProtocolsLists(software.amazon.awssdk.services.fms.model.ListProtocolsListsRequest)operation.listResourceSetResources(Consumer<ListResourceSetResourcesRequest.Builder> listResourceSetResourcesRequest) Returns an array of resources that are currently associated to a resource set.listResourceSetResources(ListResourceSetResourcesRequest listResourceSetResourcesRequest) Returns an array of resources that are currently associated to a resource set.listResourceSets(Consumer<ListResourceSetsRequest.Builder> listResourceSetsRequest) Returns an array ofResourceSetSummaryobjects.listResourceSets(ListResourceSetsRequest listResourceSetsRequest) Returns an array ofResourceSetSummaryobjects.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the list of tags for the specified Amazon Web Services resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags for the specified Amazon Web Services resource.listThirdPartyFirewallFirewallPolicies(Consumer<ListThirdPartyFirewallFirewallPoliciesRequest.Builder> listThirdPartyFirewallFirewallPoliciesRequest) Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.listThirdPartyFirewallFirewallPolicies(ListThirdPartyFirewallFirewallPoliciesRequest listThirdPartyFirewallFirewallPoliciesRequest) Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.listThirdPartyFirewallFirewallPoliciesPaginator(Consumer<ListThirdPartyFirewallFirewallPoliciesRequest.Builder> listThirdPartyFirewallFirewallPoliciesRequest) This is a variant oflistThirdPartyFirewallFirewallPolicies(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesRequest)operation.listThirdPartyFirewallFirewallPoliciesPaginator(ListThirdPartyFirewallFirewallPoliciesRequest listThirdPartyFirewallFirewallPoliciesRequest) This is a variant oflistThirdPartyFirewallFirewallPolicies(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesRequest)operation.default CompletableFuture<PutAdminAccountResponse> putAdminAccount(Consumer<PutAdminAccountRequest.Builder> putAdminAccountRequest) Creates or updates an Firewall Manager administrator account.default CompletableFuture<PutAdminAccountResponse> putAdminAccount(PutAdminAccountRequest putAdminAccountRequest) Creates or updates an Firewall Manager administrator account.default CompletableFuture<PutAppsListResponse> putAppsList(Consumer<PutAppsListRequest.Builder> putAppsListRequest) Creates an Firewall Manager applications list.default CompletableFuture<PutAppsListResponse> putAppsList(PutAppsListRequest putAppsListRequest) Creates an Firewall Manager applications list.putNotificationChannel(Consumer<PutNotificationChannelRequest.Builder> putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.default CompletableFuture<PutPolicyResponse> putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest) Creates an Firewall Manager policy.default CompletableFuture<PutPolicyResponse> putPolicy(PutPolicyRequest putPolicyRequest) Creates an Firewall Manager policy.putProtocolsList(Consumer<PutProtocolsListRequest.Builder> putProtocolsListRequest) Creates an Firewall Manager protocols list.putProtocolsList(PutProtocolsListRequest putProtocolsListRequest) Creates an Firewall Manager protocols list.default CompletableFuture<PutResourceSetResponse> putResourceSet(Consumer<PutResourceSetRequest.Builder> putResourceSetRequest) Creates the resource set.default CompletableFuture<PutResourceSetResponse> putResourceSet(PutResourceSetRequest putResourceSetRequest) Creates the resource set.default FmsServiceClientConfigurationThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to an Amazon Web Services resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to an Amazon Web Services resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from an Amazon Web Services resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from an Amazon Web Services resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
associateAdminAccount
default CompletableFuture<AssociateAdminAccountResponse> associateAdminAccount(AssociateAdminAccountRequest associateAdminAccountRequest) Sets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect.
For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
associateAdminAccount
default CompletableFuture<AssociateAdminAccountResponse> associateAdminAccount(Consumer<AssociateAdminAccountRequest.Builder> associateAdminAccountRequest) Sets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect.
For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.
This is a convenience which creates an instance of the
AssociateAdminAccountRequest.Builderavoiding the need to create one manually viaAssociateAdminAccountRequest.builder()- Parameters:
associateAdminAccountRequest- AConsumerthat will call methods onAssociateAdminAccountRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
associateThirdPartyFirewall
default CompletableFuture<AssociateThirdPartyFirewallResponse> associateThirdPartyFirewall(AssociateThirdPartyFirewallRequest associateThirdPartyFirewallRequest) Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.
- Parameters:
associateThirdPartyFirewallRequest-- Returns:
- A Java Future containing the result of the AssociateThirdPartyFirewall operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
associateThirdPartyFirewall
default CompletableFuture<AssociateThirdPartyFirewallResponse> associateThirdPartyFirewall(Consumer<AssociateThirdPartyFirewallRequest.Builder> associateThirdPartyFirewallRequest) Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.
This is a convenience which creates an instance of the
AssociateThirdPartyFirewallRequest.Builderavoiding the need to create one manually viaAssociateThirdPartyFirewallRequest.builder()- Parameters:
associateThirdPartyFirewallRequest- AConsumerthat will call methods onAssociateThirdPartyFirewallRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssociateThirdPartyFirewall operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
batchAssociateResource
default CompletableFuture<BatchAssociateResourceResponse> batchAssociateResource(BatchAssociateResourceRequest batchAssociateResourceRequest) Associate resources to a Firewall Manager resource set.
- Parameters:
batchAssociateResourceRequest-- Returns:
- A Java Future containing the result of the BatchAssociateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - ResourceNotFoundException The specified resource was not found.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
batchAssociateResource
default CompletableFuture<BatchAssociateResourceResponse> batchAssociateResource(Consumer<BatchAssociateResourceRequest.Builder> batchAssociateResourceRequest) Associate resources to a Firewall Manager resource set.
This is a convenience which creates an instance of the
BatchAssociateResourceRequest.Builderavoiding the need to create one manually viaBatchAssociateResourceRequest.builder()- Parameters:
batchAssociateResourceRequest- AConsumerthat will call methods onBatchAssociateResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchAssociateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - ResourceNotFoundException The specified resource was not found.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
batchDisassociateResource
default CompletableFuture<BatchDisassociateResourceResponse> batchDisassociateResource(BatchDisassociateResourceRequest batchDisassociateResourceRequest) Disassociates resources from a Firewall Manager resource set.
- Parameters:
batchDisassociateResourceRequest-- Returns:
- A Java Future containing the result of the BatchDisassociateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
batchDisassociateResource
default CompletableFuture<BatchDisassociateResourceResponse> batchDisassociateResource(Consumer<BatchDisassociateResourceRequest.Builder> batchDisassociateResourceRequest) Disassociates resources from a Firewall Manager resource set.
This is a convenience which creates an instance of the
BatchDisassociateResourceRequest.Builderavoiding the need to create one manually viaBatchDisassociateResourceRequest.builder()- Parameters:
batchDisassociateResourceRequest- AConsumerthat will call methods onBatchDisassociateResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDisassociateResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
deleteAppsList
default CompletableFuture<DeleteAppsListResponse> deleteAppsList(DeleteAppsListRequest deleteAppsListRequest) Permanently deletes an Firewall Manager applications list.
- Parameters:
deleteAppsListRequest-- Returns:
- A Java Future containing the result of the DeleteAppsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
deleteAppsList
default CompletableFuture<DeleteAppsListResponse> deleteAppsList(Consumer<DeleteAppsListRequest.Builder> deleteAppsListRequest) Permanently deletes an Firewall Manager applications list.
This is a convenience which creates an instance of the
DeleteAppsListRequest.Builderavoiding the need to create one manually viaDeleteAppsListRequest.builder()- Parameters:
deleteAppsListRequest- AConsumerthat will call methods onDeleteAppsListRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAppsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
deleteNotificationChannel
default CompletableFuture<DeleteNotificationChannelResponse> deleteNotificationChannel(DeleteNotificationChannelRequest deleteNotificationChannelRequest) Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
- Parameters:
deleteNotificationChannelRequest-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
deleteNotificationChannel
default CompletableFuture<DeleteNotificationChannelResponse> deleteNotificationChannel(Consumer<DeleteNotificationChannelRequest.Builder> deleteNotificationChannelRequest) Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
This is a convenience which creates an instance of the
DeleteNotificationChannelRequest.Builderavoiding the need to create one manually viaDeleteNotificationChannelRequest.builder()- Parameters:
deleteNotificationChannelRequest- AConsumerthat will call methods onDeleteNotificationChannelRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
deletePolicy
default CompletableFuture<DeletePolicyResponse> deletePolicy(DeletePolicyRequest deletePolicyRequest) Permanently deletes an 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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:
-
deletePolicy
default CompletableFuture<DeletePolicyResponse> deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Permanently deletes an Firewall Manager policy.
This is a convenience which creates an instance of the
DeletePolicyRequest.Builderavoiding the need to create one manually viaDeletePolicyRequest.builder()- Parameters:
deletePolicyRequest- AConsumerthat will call methods onDeletePolicyRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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:
-
deleteProtocolsList
default CompletableFuture<DeleteProtocolsListResponse> deleteProtocolsList(DeleteProtocolsListRequest deleteProtocolsListRequest) Permanently deletes an Firewall Manager protocols list.
- Parameters:
deleteProtocolsListRequest-- Returns:
- A Java Future containing the result of the DeleteProtocolsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
deleteProtocolsList
default CompletableFuture<DeleteProtocolsListResponse> deleteProtocolsList(Consumer<DeleteProtocolsListRequest.Builder> deleteProtocolsListRequest) Permanently deletes an Firewall Manager protocols list.
This is a convenience which creates an instance of the
DeleteProtocolsListRequest.Builderavoiding the need to create one manually viaDeleteProtocolsListRequest.builder()- Parameters:
deleteProtocolsListRequest- AConsumerthat will call methods onDeleteProtocolsListRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteProtocolsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
deleteResourceSet
default CompletableFuture<DeleteResourceSetResponse> deleteResourceSet(DeleteResourceSetRequest deleteResourceSetRequest) Deletes the specified ResourceSet.
- Parameters:
deleteResourceSetRequest-- Returns:
- A Java Future containing the result of the DeleteResourceSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- 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:
-
deleteResourceSet
default CompletableFuture<DeleteResourceSetResponse> deleteResourceSet(Consumer<DeleteResourceSetRequest.Builder> deleteResourceSetRequest) Deletes the specified ResourceSet.
This is a convenience which creates an instance of the
DeleteResourceSetRequest.Builderavoiding the need to create one manually viaDeleteResourceSetRequest.builder()- Parameters:
deleteResourceSetRequest- AConsumerthat will call methods onDeleteResourceSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteResourceSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- 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:
-
disassociateAdminAccount
default CompletableFuture<DisassociateAdminAccountResponse> disassociateAdminAccount(DisassociateAdminAccountRequest disassociateAdminAccountRequest) Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request.
Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before you can disassociate your account.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
disassociateAdminAccount
default CompletableFuture<DisassociateAdminAccountResponse> disassociateAdminAccount(Consumer<DisassociateAdminAccountRequest.Builder> disassociateAdminAccountRequest) Disassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request.
Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before you can disassociate your account.
This is a convenience which creates an instance of the
DisassociateAdminAccountRequest.Builderavoiding the need to create one manually viaDisassociateAdminAccountRequest.builder()- Parameters:
disassociateAdminAccountRequest- AConsumerthat will call methods onDisassociateAdminAccountRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
disassociateThirdPartyFirewall
default CompletableFuture<DisassociateThirdPartyFirewallResponse> disassociateThirdPartyFirewall(DisassociateThirdPartyFirewallRequest disassociateThirdPartyFirewallRequest) Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call
DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.- Parameters:
disassociateThirdPartyFirewallRequest-- Returns:
- A Java Future containing the result of the DisassociateThirdPartyFirewall operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
disassociateThirdPartyFirewall
default CompletableFuture<DisassociateThirdPartyFirewallResponse> disassociateThirdPartyFirewall(Consumer<DisassociateThirdPartyFirewallRequest.Builder> disassociateThirdPartyFirewallRequest) Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call
DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.
This is a convenience which creates an instance of the
DisassociateThirdPartyFirewallRequest.Builderavoiding the need to create one manually viaDisassociateThirdPartyFirewallRequest.builder()- Parameters:
disassociateThirdPartyFirewallRequest- AConsumerthat will call methods onDisassociateThirdPartyFirewallRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateThirdPartyFirewall operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getAdminAccount
default CompletableFuture<GetAdminAccountResponse> getAdminAccount(GetAdminAccountRequest getAdminAccountRequest) Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getAdminAccount
default CompletableFuture<GetAdminAccountResponse> getAdminAccount(Consumer<GetAdminAccountRequest.Builder> getAdminAccountRequest) Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.
This is a convenience which creates an instance of the
GetAdminAccountRequest.Builderavoiding the need to create one manually viaGetAdminAccountRequest.builder()- Parameters:
getAdminAccountRequest- AConsumerthat will call methods onGetAdminAccountRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getAdminScope
default CompletableFuture<GetAdminScopeResponse> getAdminScope(GetAdminScopeRequest getAdminScopeRequest) Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.
- Parameters:
getAdminScopeRequest-- Returns:
- A Java Future containing the result of the GetAdminScope operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getAdminScope
default CompletableFuture<GetAdminScopeResponse> getAdminScope(Consumer<GetAdminScopeRequest.Builder> getAdminScopeRequest) Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.
This is a convenience which creates an instance of the
GetAdminScopeRequest.Builderavoiding the need to create one manually viaGetAdminScopeRequest.builder()- Parameters:
getAdminScopeRequest- AConsumerthat will call methods onGetAdminScopeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAdminScope operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getAppsList
Returns information about the specified Firewall Manager applications list.
- Parameters:
getAppsListRequest-- Returns:
- A Java Future containing the result of the GetAppsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
getAppsList
default CompletableFuture<GetAppsListResponse> getAppsList(Consumer<GetAppsListRequest.Builder> getAppsListRequest) Returns information about the specified Firewall Manager applications list.
This is a convenience which creates an instance of the
GetAppsListRequest.Builderavoiding the need to create one manually viaGetAppsListRequest.builder()- Parameters:
getAppsListRequest- AConsumerthat will call methods onGetAppsListRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAppsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
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.
The reasons for resources being considered compliant depend on the Firewall Manager policy type.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - 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:
-
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.
The reasons for resources being considered compliant depend on the Firewall Manager policy type.
This is a convenience which creates an instance of the
GetComplianceDetailRequest.Builderavoiding the need to create one manually viaGetComplianceDetailRequest.builder()- Parameters:
getComplianceDetailRequest- AConsumerthat will call methods onGetComplianceDetailRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - 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:
-
getNotificationChannel
default CompletableFuture<GetNotificationChannelResponse> getNotificationChannel(GetNotificationChannelRequest getNotificationChannelRequest) Information about the Amazon Simple Notification Service (SNS) topic that is used to record 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
getNotificationChannel
default CompletableFuture<GetNotificationChannelResponse> getNotificationChannel(Consumer<GetNotificationChannelRequest.Builder> getNotificationChannelRequest) Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
This is a convenience which creates an instance of the
GetNotificationChannelRequest.Builderavoiding the need to create one manually viaGetNotificationChannelRequest.builder()- Parameters:
getNotificationChannelRequest- AConsumerthat will call methods onGetNotificationChannelRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
getPolicy
Returns information about the specified 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidTypeException The value of the
Typeparameter 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:
-
getPolicy
default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Returns information about the specified Firewall Manager policy.
This is a convenience which creates an instance of the
GetPolicyRequest.Builderavoiding the need to create one manually viaGetPolicyRequest.builder()- Parameters:
getPolicyRequest- AConsumerthat will call methods onGetPolicyRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidTypeException The value of the
Typeparameter 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:
-
getProtectionStatus
default CompletableFuture<GetProtectionStatusResponse> getProtectionStatus(GetProtectionStatusRequest getProtectionStatusRequest) If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.
- Parameters:
getProtectionStatusRequest-- Returns:
- A Java Future containing the result of the GetProtectionStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
getProtectionStatus
default CompletableFuture<GetProtectionStatusResponse> getProtectionStatus(Consumer<GetProtectionStatusRequest.Builder> getProtectionStatusRequest) If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.
This is a convenience which creates an instance of the
GetProtectionStatusRequest.Builderavoiding the need to create one manually viaGetProtectionStatusRequest.builder()- Parameters:
getProtectionStatusRequest- AConsumerthat will call methods onGetProtectionStatusRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetProtectionStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
getProtocolsList
default CompletableFuture<GetProtocolsListResponse> getProtocolsList(GetProtocolsListRequest getProtocolsListRequest) Returns information about the specified Firewall Manager protocols list.
- Parameters:
getProtocolsListRequest-- Returns:
- A Java Future containing the result of the GetProtocolsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
getProtocolsList
default CompletableFuture<GetProtocolsListResponse> getProtocolsList(Consumer<GetProtocolsListRequest.Builder> getProtocolsListRequest) Returns information about the specified Firewall Manager protocols list.
This is a convenience which creates an instance of the
GetProtocolsListRequest.Builderavoiding the need to create one manually viaGetProtocolsListRequest.builder()- Parameters:
getProtocolsListRequest- AConsumerthat will call methods onGetProtocolsListRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetProtocolsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
getResourceSet
default CompletableFuture<GetResourceSetResponse> getResourceSet(GetResourceSetRequest getResourceSetRequest) Gets information about a specific resource set.
- Parameters:
getResourceSetRequest-- Returns:
- A Java Future containing the result of the GetResourceSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getResourceSet
default CompletableFuture<GetResourceSetResponse> getResourceSet(Consumer<GetResourceSetRequest.Builder> getResourceSetRequest) Gets information about a specific resource set.
This is a convenience which creates an instance of the
GetResourceSetRequest.Builderavoiding the need to create one manually viaGetResourceSetRequest.builder()- Parameters:
getResourceSetRequest- AConsumerthat will call methods onGetResourceSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetResourceSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getThirdPartyFirewallAssociationStatus
default CompletableFuture<GetThirdPartyFirewallAssociationStatusResponse> getThirdPartyFirewallAssociationStatus(GetThirdPartyFirewallAssociationStatusRequest getThirdPartyFirewallAssociationStatusRequest) The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
- Parameters:
getThirdPartyFirewallAssociationStatusRequest-- Returns:
- A Java Future containing the result of the GetThirdPartyFirewallAssociationStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getThirdPartyFirewallAssociationStatus
default CompletableFuture<GetThirdPartyFirewallAssociationStatusResponse> getThirdPartyFirewallAssociationStatus(Consumer<GetThirdPartyFirewallAssociationStatusRequest.Builder> getThirdPartyFirewallAssociationStatusRequest) The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
This is a convenience which creates an instance of the
GetThirdPartyFirewallAssociationStatusRequest.Builderavoiding the need to create one manually viaGetThirdPartyFirewallAssociationStatusRequest.builder()- Parameters:
getThirdPartyFirewallAssociationStatusRequest- AConsumerthat will call methods onGetThirdPartyFirewallAssociationStatusRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetThirdPartyFirewallAssociationStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
getViolationDetails
default CompletableFuture<GetViolationDetailsResponse> getViolationDetails(GetViolationDetailsRequest getViolationDetailsRequest) Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
- Parameters:
getViolationDetailsRequest-- Returns:
- A Java Future containing the result of the GetViolationDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
getViolationDetails
default CompletableFuture<GetViolationDetailsResponse> getViolationDetails(Consumer<GetViolationDetailsRequest.Builder> getViolationDetailsRequest) Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
This is a convenience which creates an instance of the
GetViolationDetailsRequest.Builderavoiding the need to create one manually viaGetViolationDetailsRequest.builder()- Parameters:
getViolationDetailsRequest- AConsumerthat will call methods onGetViolationDetailsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetViolationDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAdminAccountsForOrganization
default CompletableFuture<ListAdminAccountsForOrganizationResponse> listAdminAccountsForOrganization(ListAdminAccountsForOrganizationRequest listAdminAccountsForOrganizationRequest) Returns a
AdminAccountsobject that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.This operation can be called only from the organization's management account.
- Parameters:
listAdminAccountsForOrganizationRequest-- Returns:
- A Java Future containing the result of the ListAdminAccountsForOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listAdminAccountsForOrganization
default CompletableFuture<ListAdminAccountsForOrganizationResponse> listAdminAccountsForOrganization(Consumer<ListAdminAccountsForOrganizationRequest.Builder> listAdminAccountsForOrganizationRequest) Returns a
AdminAccountsobject that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount.This operation can be called only from the organization's management account.
This is a convenience which creates an instance of the
ListAdminAccountsForOrganizationRequest.Builderavoiding the need to create one manually viaListAdminAccountsForOrganizationRequest.builder()- Parameters:
listAdminAccountsForOrganizationRequest- AConsumerthat will call methods onListAdminAccountsForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAdminAccountsForOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listAdminAccountsForOrganizationPaginator
default ListAdminAccountsForOrganizationPublisher listAdminAccountsForOrganizationPaginator(ListAdminAccountsForOrganizationRequest listAdminAccountsForOrganizationRequest) This is a variant of
listAdminAccountsForOrganization(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListAdminAccountsForOrganizationPublisher publisher = client.listAdminAccountsForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListAdminAccountsForOrganizationPublisher publisher = client.listAdminAccountsForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAdminAccountsForOrganization(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationRequest)operation.- Parameters:
listAdminAccountsForOrganizationRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listAdminAccountsForOrganizationPaginator
default ListAdminAccountsForOrganizationPublisher listAdminAccountsForOrganizationPaginator(Consumer<ListAdminAccountsForOrganizationRequest.Builder> listAdminAccountsForOrganizationRequest) This is a variant of
listAdminAccountsForOrganization(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListAdminAccountsForOrganizationPublisher publisher = client.listAdminAccountsForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListAdminAccountsForOrganizationPublisher publisher = client.listAdminAccountsForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAdminAccountsForOrganization(software.amazon.awssdk.services.fms.model.ListAdminAccountsForOrganizationRequest)operation.
This is a convenience which creates an instance of the
ListAdminAccountsForOrganizationRequest.Builderavoiding the need to create one manually viaListAdminAccountsForOrganizationRequest.builder()- Parameters:
listAdminAccountsForOrganizationRequest- AConsumerthat will call methods onListAdminAccountsForOrganizationRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listAdminsManagingAccount
default CompletableFuture<ListAdminsManagingAccountResponse> listAdminsManagingAccount(ListAdminsManagingAccountRequest listAdminsManagingAccountRequest) Lists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within their AdminScope.
- Parameters:
listAdminsManagingAccountRequest-- Returns:
- A Java Future containing the result of the ListAdminsManagingAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAdminsManagingAccount
default CompletableFuture<ListAdminsManagingAccountResponse> listAdminsManagingAccount(Consumer<ListAdminsManagingAccountRequest.Builder> listAdminsManagingAccountRequest) Lists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within their AdminScope.
This is a convenience which creates an instance of the
ListAdminsManagingAccountRequest.Builderavoiding the need to create one manually viaListAdminsManagingAccountRequest.builder()- Parameters:
listAdminsManagingAccountRequest- AConsumerthat will call methods onListAdminsManagingAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAdminsManagingAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAdminsManagingAccountPaginator
default ListAdminsManagingAccountPublisher listAdminsManagingAccountPaginator(ListAdminsManagingAccountRequest listAdminsManagingAccountRequest) This is a variant of
listAdminsManagingAccount(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListAdminsManagingAccountPublisher publisher = client.listAdminsManagingAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListAdminsManagingAccountPublisher publisher = client.listAdminsManagingAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAdminsManagingAccount(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountRequest)operation.- Parameters:
listAdminsManagingAccountRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAdminsManagingAccountPaginator
default ListAdminsManagingAccountPublisher listAdminsManagingAccountPaginator(Consumer<ListAdminsManagingAccountRequest.Builder> listAdminsManagingAccountRequest) This is a variant of
listAdminsManagingAccount(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListAdminsManagingAccountPublisher publisher = client.listAdminsManagingAccountPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListAdminsManagingAccountPublisher publisher = client.listAdminsManagingAccountPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAdminsManagingAccount(software.amazon.awssdk.services.fms.model.ListAdminsManagingAccountRequest)operation.
This is a convenience which creates an instance of the
ListAdminsManagingAccountRequest.Builderavoiding the need to create one manually viaListAdminsManagingAccountRequest.builder()- Parameters:
listAdminsManagingAccountRequest- AConsumerthat will call methods onListAdminsManagingAccountRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAppsLists
default CompletableFuture<ListAppsListsResponse> listAppsLists(ListAppsListsRequest listAppsListsRequest) Returns an array of
AppsListDataSummaryobjects.- Parameters:
listAppsListsRequest-- Returns:
- A Java Future containing the result of the ListAppsLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAppsLists
default CompletableFuture<ListAppsListsResponse> listAppsLists(Consumer<ListAppsListsRequest.Builder> listAppsListsRequest) Returns an array of
AppsListDataSummaryobjects.
This is a convenience which creates an instance of the
ListAppsListsRequest.Builderavoiding the need to create one manually viaListAppsListsRequest.builder()- Parameters:
listAppsListsRequest- AConsumerthat will call methods onListAppsListsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAppsLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAppsListsPaginator
This is a variant of
listAppsLists(software.amazon.awssdk.services.fms.model.ListAppsListsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListAppsListsPublisher publisher = client.listAppsListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListAppsListsPublisher publisher = client.listAppsListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListAppsListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListAppsListsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppsLists(software.amazon.awssdk.services.fms.model.ListAppsListsRequest)operation.- Parameters:
listAppsListsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listAppsListsPaginator
default ListAppsListsPublisher listAppsListsPaginator(Consumer<ListAppsListsRequest.Builder> listAppsListsRequest) This is a variant of
listAppsLists(software.amazon.awssdk.services.fms.model.ListAppsListsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListAppsListsPublisher publisher = client.listAppsListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListAppsListsPublisher publisher = client.listAppsListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListAppsListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListAppsListsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppsLists(software.amazon.awssdk.services.fms.model.ListAppsListsRequest)operation.
This is a convenience which creates an instance of the
ListAppsListsRequest.Builderavoiding the need to create one manually viaListAppsListsRequest.builder()- Parameters:
listAppsListsRequest- AConsumerthat will call methods onListAppsListsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listComplianceStatus
default CompletableFuture<ListComplianceStatusResponse> listComplianceStatus(ListComplianceStatusRequest listComplianceStatusRequest) Returns an array of
PolicyComplianceStatusobjects. UsePolicyComplianceStatusto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listComplianceStatus
default CompletableFuture<ListComplianceStatusResponse> listComplianceStatus(Consumer<ListComplianceStatusRequest.Builder> listComplianceStatusRequest) Returns an array of
PolicyComplianceStatusobjects. UsePolicyComplianceStatusto get a summary of which member accounts are protected by the specified policy.
This is a convenience which creates an instance of the
ListComplianceStatusRequest.Builderavoiding the need to create one manually viaListComplianceStatusRequest.builder()- Parameters:
listComplianceStatusRequest- AConsumerthat will call methods onListComplianceStatusRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listComplianceStatusPaginator
default ListComplianceStatusPublisher listComplianceStatusPaginator(ListComplianceStatusRequest listComplianceStatusRequest) This is a variant of
listComplianceStatus(software.amazon.awssdk.services.fms.model.ListComplianceStatusRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListComplianceStatusPublisher publisher = client.listComplianceStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListComplianceStatusPublisher publisher = client.listComplianceStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListComplianceStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListComplianceStatusResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComplianceStatus(software.amazon.awssdk.services.fms.model.ListComplianceStatusRequest)operation.- Parameters:
listComplianceStatusRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listComplianceStatusPaginator
default ListComplianceStatusPublisher listComplianceStatusPaginator(Consumer<ListComplianceStatusRequest.Builder> listComplianceStatusRequest) This is a variant of
listComplianceStatus(software.amazon.awssdk.services.fms.model.ListComplianceStatusRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListComplianceStatusPublisher publisher = client.listComplianceStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListComplianceStatusPublisher publisher = client.listComplianceStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListComplianceStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListComplianceStatusResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComplianceStatus(software.amazon.awssdk.services.fms.model.ListComplianceStatusRequest)operation.
This is a convenience which creates an instance of the
ListComplianceStatusRequest.Builderavoiding the need to create one manually viaListComplianceStatusRequest.builder()- Parameters:
listComplianceStatusRequest- AConsumerthat will call methods onListComplianceStatusRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listDiscoveredResources
default CompletableFuture<ListDiscoveredResourcesResponse> listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
- Parameters:
listDiscoveredResourcesRequest-- Returns:
- A Java Future containing the result of the ListDiscoveredResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listDiscoveredResources
default CompletableFuture<ListDiscoveredResourcesResponse> listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
This is a convenience which creates an instance of the
ListDiscoveredResourcesRequest.Builderavoiding the need to create one manually viaListDiscoveredResourcesRequest.builder()- Parameters:
listDiscoveredResourcesRequest- AConsumerthat will call methods onListDiscoveredResourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDiscoveredResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listMemberAccounts
default CompletableFuture<ListMemberAccountsResponse> listMemberAccounts(ListMemberAccountsRequest listMemberAccountsRequest) Returns a
MemberAccountsobject that lists the member accounts in the administrator's Amazon Web Services organization.Either an Firewall Manager administrator or the organization's management account can make this request.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listMemberAccounts
default CompletableFuture<ListMemberAccountsResponse> listMemberAccounts(Consumer<ListMemberAccountsRequest.Builder> listMemberAccountsRequest) Returns a
MemberAccountsobject that lists the member accounts in the administrator's Amazon Web Services organization.Either an Firewall Manager administrator or the organization's management account can make this request.
This is a convenience which creates an instance of the
ListMemberAccountsRequest.Builderavoiding the need to create one manually viaListMemberAccountsRequest.builder()- Parameters:
listMemberAccountsRequest- AConsumerthat will call methods onListMemberAccountsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listMemberAccountsPaginator
default ListMemberAccountsPublisher listMemberAccountsPaginator(ListMemberAccountsRequest listMemberAccountsRequest) This is a variant of
listMemberAccounts(software.amazon.awssdk.services.fms.model.ListMemberAccountsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListMemberAccountsPublisher publisher = client.listMemberAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListMemberAccountsPublisher publisher = client.listMemberAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListMemberAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListMemberAccountsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMemberAccounts(software.amazon.awssdk.services.fms.model.ListMemberAccountsRequest)operation.- Parameters:
listMemberAccountsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listMemberAccountsPaginator
default ListMemberAccountsPublisher listMemberAccountsPaginator(Consumer<ListMemberAccountsRequest.Builder> listMemberAccountsRequest) This is a variant of
listMemberAccounts(software.amazon.awssdk.services.fms.model.ListMemberAccountsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListMemberAccountsPublisher publisher = client.listMemberAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListMemberAccountsPublisher publisher = client.listMemberAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListMemberAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListMemberAccountsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMemberAccounts(software.amazon.awssdk.services.fms.model.ListMemberAccountsRequest)operation.
This is a convenience which creates an instance of the
ListMemberAccountsRequest.Builderavoiding the need to create one manually viaListMemberAccountsRequest.builder()- Parameters:
listMemberAccountsRequest- AConsumerthat will call methods onListMemberAccountsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listPolicies
default CompletableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest listPoliciesRequest) Returns an array of
PolicySummaryobjects.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listPolicies
default CompletableFuture<ListPoliciesResponse> listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Returns an array of
PolicySummaryobjects.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builderavoiding the need to create one manually viaListPoliciesRequest.builder()- Parameters:
listPoliciesRequest- AConsumerthat will call methods onListPoliciesRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listPoliciesPaginator
This is a variant of
listPolicies(software.amazon.awssdk.services.fms.model.ListPoliciesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListPoliciesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.fms.model.ListPoliciesRequest)operation.- Parameters:
listPoliciesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listPoliciesPaginator
default ListPoliciesPublisher listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant of
listPolicies(software.amazon.awssdk.services.fms.model.ListPoliciesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListPoliciesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.fms.model.ListPoliciesRequest)operation.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builderavoiding the need to create one manually viaListPoliciesRequest.builder()- Parameters:
listPoliciesRequest- AConsumerthat will call methods onListPoliciesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listProtocolsLists
default CompletableFuture<ListProtocolsListsResponse> listProtocolsLists(ListProtocolsListsRequest listProtocolsListsRequest) Returns an array of
ProtocolsListDataSummaryobjects.- Parameters:
listProtocolsListsRequest-- Returns:
- A Java Future containing the result of the ListProtocolsLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listProtocolsLists
default CompletableFuture<ListProtocolsListsResponse> listProtocolsLists(Consumer<ListProtocolsListsRequest.Builder> listProtocolsListsRequest) Returns an array of
ProtocolsListDataSummaryobjects.
This is a convenience which creates an instance of the
ListProtocolsListsRequest.Builderavoiding the need to create one manually viaListProtocolsListsRequest.builder()- Parameters:
listProtocolsListsRequest- AConsumerthat will call methods onListProtocolsListsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListProtocolsLists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listProtocolsListsPaginator
default ListProtocolsListsPublisher listProtocolsListsPaginator(ListProtocolsListsRequest listProtocolsListsRequest) This is a variant of
listProtocolsLists(software.amazon.awssdk.services.fms.model.ListProtocolsListsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListProtocolsListsPublisher publisher = client.listProtocolsListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListProtocolsListsPublisher publisher = client.listProtocolsListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListProtocolsListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListProtocolsListsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtocolsLists(software.amazon.awssdk.services.fms.model.ListProtocolsListsRequest)operation.- Parameters:
listProtocolsListsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listProtocolsListsPaginator
default ListProtocolsListsPublisher listProtocolsListsPaginator(Consumer<ListProtocolsListsRequest.Builder> listProtocolsListsRequest) This is a variant of
listProtocolsLists(software.amazon.awssdk.services.fms.model.ListProtocolsListsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListProtocolsListsPublisher publisher = client.listProtocolsListsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListProtocolsListsPublisher publisher = client.listProtocolsListsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListProtocolsListsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListProtocolsListsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtocolsLists(software.amazon.awssdk.services.fms.model.ListProtocolsListsRequest)operation.
This is a convenience which creates an instance of the
ListProtocolsListsRequest.Builderavoiding the need to create one manually viaListProtocolsListsRequest.builder()- Parameters:
listProtocolsListsRequest- AConsumerthat will call methods onListProtocolsListsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
listResourceSetResources
default CompletableFuture<ListResourceSetResourcesResponse> listResourceSetResources(ListResourceSetResourcesRequest listResourceSetResourcesRequest) Returns an array of resources that are currently associated to a resource set.
- Parameters:
listResourceSetResourcesRequest-- Returns:
- A Java Future containing the result of the ListResourceSetResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listResourceSetResources
default CompletableFuture<ListResourceSetResourcesResponse> listResourceSetResources(Consumer<ListResourceSetResourcesRequest.Builder> listResourceSetResourcesRequest) Returns an array of resources that are currently associated to a resource set.
This is a convenience which creates an instance of the
ListResourceSetResourcesRequest.Builderavoiding the need to create one manually viaListResourceSetResourcesRequest.builder()- Parameters:
listResourceSetResourcesRequest- AConsumerthat will call methods onListResourceSetResourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListResourceSetResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listResourceSets
default CompletableFuture<ListResourceSetsResponse> listResourceSets(ListResourceSetsRequest listResourceSetsRequest) Returns an array of
ResourceSetSummaryobjects.- Parameters:
listResourceSetsRequest-- Returns:
- A Java Future containing the result of the ListResourceSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listResourceSets
default CompletableFuture<ListResourceSetsResponse> listResourceSets(Consumer<ListResourceSetsRequest.Builder> listResourceSetsRequest) Returns an array of
ResourceSetSummaryobjects.
This is a convenience which creates an instance of the
ListResourceSetsRequest.Builderavoiding the need to create one manually viaListResourceSetsRequest.builder()- Parameters:
listResourceSetsRequest- AConsumerthat will call methods onListResourceSetsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListResourceSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of tags for the specified Amazon Web Services resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- 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:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the list of tags for the specified Amazon Web Services resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- 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:
-
listThirdPartyFirewallFirewallPolicies
default CompletableFuture<ListThirdPartyFirewallFirewallPoliciesResponse> listThirdPartyFirewallFirewallPolicies(ListThirdPartyFirewallFirewallPoliciesRequest listThirdPartyFirewallFirewallPoliciesRequest) Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
- Parameters:
listThirdPartyFirewallFirewallPoliciesRequest-- Returns:
- A Java Future containing the result of the ListThirdPartyFirewallFirewallPolicies operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listThirdPartyFirewallFirewallPolicies
default CompletableFuture<ListThirdPartyFirewallFirewallPoliciesResponse> listThirdPartyFirewallFirewallPolicies(Consumer<ListThirdPartyFirewallFirewallPoliciesRequest.Builder> listThirdPartyFirewallFirewallPoliciesRequest) Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
This is a convenience which creates an instance of the
ListThirdPartyFirewallFirewallPoliciesRequest.Builderavoiding the need to create one manually viaListThirdPartyFirewallFirewallPoliciesRequest.builder()- Parameters:
listThirdPartyFirewallFirewallPoliciesRequest- AConsumerthat will call methods onListThirdPartyFirewallFirewallPoliciesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListThirdPartyFirewallFirewallPolicies operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listThirdPartyFirewallFirewallPoliciesPaginator
default ListThirdPartyFirewallFirewallPoliciesPublisher listThirdPartyFirewallFirewallPoliciesPaginator(ListThirdPartyFirewallFirewallPoliciesRequest listThirdPartyFirewallFirewallPoliciesRequest) This is a variant of
listThirdPartyFirewallFirewallPolicies(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListThirdPartyFirewallFirewallPoliciesPublisher publisher = client.listThirdPartyFirewallFirewallPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListThirdPartyFirewallFirewallPoliciesPublisher publisher = client.listThirdPartyFirewallFirewallPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThirdPartyFirewallFirewallPolicies(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesRequest)operation.- Parameters:
listThirdPartyFirewallFirewallPoliciesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
listThirdPartyFirewallFirewallPoliciesPaginator
default ListThirdPartyFirewallFirewallPoliciesPublisher listThirdPartyFirewallFirewallPoliciesPaginator(Consumer<ListThirdPartyFirewallFirewallPoliciesRequest.Builder> listThirdPartyFirewallFirewallPoliciesRequest) This is a variant of
listThirdPartyFirewallFirewallPolicies(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.fms.paginators.ListThirdPartyFirewallFirewallPoliciesPublisher publisher = client.listThirdPartyFirewallFirewallPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.fms.paginators.ListThirdPartyFirewallFirewallPoliciesPublisher publisher = client.listThirdPartyFirewallFirewallPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThirdPartyFirewallFirewallPolicies(software.amazon.awssdk.services.fms.model.ListThirdPartyFirewallFirewallPoliciesRequest)operation.
This is a convenience which creates an instance of the
ListThirdPartyFirewallFirewallPoliciesRequest.Builderavoiding the need to create one manually viaListThirdPartyFirewallFirewallPoliciesRequest.builder()- Parameters:
listThirdPartyFirewallFirewallPoliciesRequest- AConsumerthat will call methods onListThirdPartyFirewallFirewallPoliciesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- ResourceNotFoundException The specified resource was not found.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
putAdminAccount
default CompletableFuture<PutAdminAccountResponse> putAdminAccount(PutAdminAccountRequest putAdminAccountRequest) Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn't a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization.
- Parameters:
putAdminAccountRequest-- Returns:
- A Java Future containing the result of the PutAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
putAdminAccount
default CompletableFuture<PutAdminAccountResponse> putAdminAccount(Consumer<PutAdminAccountRequest.Builder> putAdminAccountRequest) Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn't a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization.
This is a convenience which creates an instance of the
PutAdminAccountRequest.Builderavoiding the need to create one manually viaPutAdminAccountRequest.builder()- Parameters:
putAdminAccountRequest- AConsumerthat will call methods onPutAdminAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutAdminAccount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
putAppsList
Creates an Firewall Manager applications list.
- Parameters:
putAppsListRequest-- Returns:
- A Java Future containing the result of the PutAppsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
putAppsList
default CompletableFuture<PutAppsListResponse> putAppsList(Consumer<PutAppsListRequest.Builder> putAppsListRequest) Creates an Firewall Manager applications list.
This is a convenience which creates an instance of the
PutAppsListRequest.Builderavoiding the need to create one manually viaPutAppsListRequest.builder()- Parameters:
putAppsListRequest- AConsumerthat will call methods onPutAppsListRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutAppsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
putNotificationChannel
default CompletableFuture<PutNotificationChannelResponse> putNotificationChannel(PutNotificationChannelRequest putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
To perform this action outside of the console, you must first configure the SNS topic's access policy to allow the
SnsRoleNameto publish SNS logs. If theSnsRoleNameprovided is a role other than theAWSServiceRoleForFMSservice-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principalfms.amazonaws.comto assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager Developer Guide.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
putNotificationChannel
default CompletableFuture<PutNotificationChannelResponse> putNotificationChannel(Consumer<PutNotificationChannelRequest.Builder> putNotificationChannelRequest) Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
To perform this action outside of the console, you must first configure the SNS topic's access policy to allow the
SnsRoleNameto publish SNS logs. If theSnsRoleNameprovided is a role other than theAWSServiceRoleForFMSservice-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principalfms.amazonaws.comto assume this role. For information about configuring an SNS access policy, see Service roles for Firewall Manager in the Firewall Manager Developer Guide.
This is a convenience which creates an instance of the
PutNotificationChannelRequest.Builderavoiding the need to create one manually viaPutNotificationChannelRequest.builder()- Parameters:
putNotificationChannelRequest- AConsumerthat will call methods onPutNotificationChannelRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
putPolicy
Creates an Firewall Manager policy.
A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.
If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.
Firewall Manager provides the following types of policies:
-
WAF policy - This policy applies WAF web ACL protections to specified accounts and resources.
-
Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
-
Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in Organizations and lets you enforce a baseline set of rules across your organization.
-
Network ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
-
Network Firewall policy - This policy applies Network Firewall protection to your organization's VPCs.
-
DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
-
Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
-
Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
-
Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
-
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidTypeException The value of the
Typeparameter 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:
-
-
putPolicy
default CompletableFuture<PutPolicyResponse> putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest) Creates an Firewall Manager policy.
A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.
If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.
Firewall Manager provides the following types of policies:
-
WAF policy - This policy applies WAF web ACL protections to specified accounts and resources.
-
Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
-
Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in Organizations and lets you enforce a baseline set of rules across your organization.
-
Network ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
-
Network Firewall policy - This policy applies Network Firewall protection to your organization's VPCs.
-
DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization's VPCs.
-
Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the Amazon Web Services Marketplace console at Amazon Web Services Marketplace.
-
Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization's VPCs.
-
Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
-
This is a convenience which creates an instance of the
PutPolicyRequest.Builderavoiding the need to create one manually viaPutPolicyRequest.builder()- Parameters:
putPolicyRequest- AConsumerthat will call methods onPutPolicyRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidTypeException The value of the
Typeparameter 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:
-
-
putProtocolsList
default CompletableFuture<PutProtocolsListResponse> putProtocolsList(PutProtocolsListRequest putProtocolsListRequest) Creates an Firewall Manager protocols list.
- Parameters:
putProtocolsListRequest-- Returns:
- A Java Future containing the result of the PutProtocolsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
putProtocolsList
default CompletableFuture<PutProtocolsListResponse> putProtocolsList(Consumer<PutProtocolsListRequest.Builder> putProtocolsListRequest) Creates an Firewall Manager protocols list.
This is a convenience which creates an instance of the
PutProtocolsListRequest.Builderavoiding the need to create one manually viaPutProtocolsListRequest.builder()- Parameters:
putProtocolsListRequest- AConsumerthat will call methods onPutProtocolsListRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutProtocolsList operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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:
-
putResourceSet
default CompletableFuture<PutResourceSetResponse> putResourceSet(PutResourceSetRequest putResourceSetRequest) Creates the resource set.
An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.
- Parameters:
putResourceSetRequest-- Returns:
- A Java Future containing the result of the PutResourceSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
putResourceSet
default CompletableFuture<PutResourceSetResponse> putResourceSet(Consumer<PutResourceSetRequest.Builder> putResourceSetRequest) Creates the resource set.
An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.
This is a convenience which creates an instance of the
PutResourceSetRequest.Builderavoiding the need to create one manually viaPutResourceSetRequest.builder()- Parameters:
putResourceSetRequest- AConsumerthat will call methods onPutResourceSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutResourceSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- 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.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
- See Also:
-
tagResource
Adds one or more tags to an Amazon Web Services resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to an Amazon Web Services resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- LimitExceededException The operation exceeds a resource limit, for example, the maximum number of
policyobjects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide. - 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:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from an Amazon Web Services resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- 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:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from an Amazon Web Services resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InvalidOperationException The operation failed because there was nothing to do or the operation
wasn't possible. For example, you might have submitted an
AssociateAdminAccountrequest for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it. - InternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
- InvalidInputException The parameters of the request were invalid.
- 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:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aFmsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aFmsAsyncClient.
-