@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSFMSClient extends AmazonWebServiceClient implements AWSFMS
This is the AWS Firewall Manager API Reference. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS Firewall Manager Developer Guide.
Some API actions require explicit resource permissions. For information, see the developer guide topic Firewall Manager required permissions for API actions.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateAdminAccountResult |
associateAdminAccount(AssociateAdminAccountRequest request)
Sets the AWS Firewall Manager administrator account.
|
static AWSFMSClientBuilder |
builder() |
DeleteAppsListResult |
deleteAppsList(DeleteAppsListRequest request)
Permanently deletes an AWS Firewall Manager applications list.
|
DeleteNotificationChannelResult |
deleteNotificationChannel(DeleteNotificationChannelRequest request)
Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS)
topic that is used to record AWS Firewall Manager SNS logs.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest request)
Permanently deletes an AWS Firewall Manager policy.
|
DeleteProtocolsListResult |
deleteProtocolsList(DeleteProtocolsListRequest request)
Permanently deletes an AWS Firewall Manager protocols list.
|
DisassociateAdminAccountResult |
disassociateAdminAccount(DisassociateAdminAccountRequest request)
Disassociates the account that has been set as the AWS Firewall Manager administrator account.
|
GetAdminAccountResult |
getAdminAccount(GetAdminAccountRequest request)
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall
Manager administrator.
|
GetAppsListResult |
getAppsList(GetAppsListRequest request)
Returns information about the specified AWS Firewall Manager applications list.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetComplianceDetailResult |
getComplianceDetail(GetComplianceDetailRequest request)
Returns detailed compliance information about the specified member account.
|
GetNotificationChannelResult |
getNotificationChannel(GetNotificationChannelRequest request)
Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager
SNS logs.
|
GetPolicyResult |
getPolicy(GetPolicyRequest request)
Returns information about the specified AWS Firewall Manager policy.
|
GetProtectionStatusResult |
getProtectionStatus(GetProtectionStatusRequest request)
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a
potential DDoS attack.
|
GetProtocolsListResult |
getProtocolsList(GetProtocolsListRequest request)
Returns information about the specified AWS Firewall Manager protocols list.
|
GetViolationDetailsResult |
getViolationDetails(GetViolationDetailsRequest request)
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
|
ListAppsListsResult |
listAppsLists(ListAppsListsRequest request)
Returns an array of
AppsListDataSummary objects. |
ListComplianceStatusResult |
listComplianceStatus(ListComplianceStatusRequest request)
Returns an array of
PolicyComplianceStatus objects. |
ListMemberAccountsResult |
listMemberAccounts(ListMemberAccountsRequest request)
Returns a
MemberAccounts object that lists the member accounts in the administrator's AWS
organization. |
ListPoliciesResult |
listPolicies(ListPoliciesRequest request)
Returns an array of
PolicySummary objects. |
ListProtocolsListsResult |
listProtocolsLists(ListProtocolsListsRequest request)
Returns an array of
ProtocolsListDataSummary objects. |
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for the specified AWS resource.
|
PutAppsListResult |
putAppsList(PutAppsListRequest request)
Creates an AWS Firewall Manager applications list.
|
PutNotificationChannelResult |
putNotificationChannel(PutNotificationChannelRequest request)
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to
record SNS logs.
|
PutPolicyResult |
putPolicy(PutPolicyRequest request)
Creates an AWS Firewall Manager policy.
|
PutProtocolsListResult |
putProtocolsList(PutProtocolsListRequest request)
Creates an AWS Firewall Manager protocols list.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to an AWS resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from an AWS resource.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSFMSClientBuilder builder()
public AssociateAdminAccountResult associateAdminAccount(AssociateAdminAccountRequest request)
Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account of your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.
The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account.
associateAdminAccount
in interface AWSFMS
associateAdminAccountRequest
- InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InvalidInputException
- The parameters of the request were invalid.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DeleteAppsListResult deleteAppsList(DeleteAppsListRequest request)
Permanently deletes an AWS Firewall Manager applications list.
deleteAppsList
in interface AWSFMS
deleteAppsListRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DeleteNotificationChannelResult deleteNotificationChannel(DeleteNotificationChannelRequest request)
Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
deleteNotificationChannel
in interface AWSFMS
deleteNotificationChannelRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
Permanently deletes an AWS Firewall Manager policy.
deletePolicy
in interface AWSFMS
deletePolicyRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.LimitExceededException
- The operation exceeds a resource limit, for example, the maximum number of policy
objects
that you can create for an AWS account. For more information, see Firewall Manager Limits
in the AWS WAF Developer Guide.public DeleteProtocolsListResult deleteProtocolsList(DeleteProtocolsListRequest request)
Permanently deletes an AWS Firewall Manager protocols list.
deleteProtocolsList
in interface AWSFMS
deleteProtocolsListRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public DisassociateAdminAccountResult disassociateAdminAccount(DisassociateAdminAccountRequest request)
Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different
account as the administrator account, you must submit an AssociateAdminAccount
request.
disassociateAdminAccount
in interface AWSFMS
disassociateAdminAccountRequest
- InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetAdminAccountResult getAdminAccount(GetAdminAccountRequest request)
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
getAdminAccount
in interface AWSFMS
getAdminAccountRequest
- InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetAppsListResult getAppsList(GetAppsListRequest request)
Returns information about the specified AWS Firewall Manager applications list.
getAppsList
in interface AWSFMS
getAppsListRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetComplianceDetailResult getComplianceDetail(GetComplianceDetailRequest request)
Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for AWS WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible. Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules.
getComplianceDetail
in interface AWSFMS
getComplianceDetailRequest
- ResourceNotFoundException
- The specified resource was not found.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.public GetNotificationChannelResult getNotificationChannel(GetNotificationChannelRequest request)
Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
getNotificationChannel
in interface AWSFMS
getNotificationChannelRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetPolicyResult getPolicy(GetPolicyRequest request)
Returns information about the specified AWS Firewall Manager policy.
getPolicy
in interface AWSFMS
getPolicyRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidTypeException
- The value of the Type
parameter is invalid.public GetProtectionStatusResult getProtectionStatus(GetProtectionStatusRequest request)
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.
getProtectionStatus
in interface AWSFMS
getProtectionStatusRequest
- 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.public GetProtocolsListResult getProtocolsList(GetProtocolsListRequest request)
Returns information about the specified AWS Firewall Manager protocols list.
getProtocolsList
in interface AWSFMS
getProtocolsListRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public GetViolationDetailsResult getViolationDetails(GetViolationDetailsRequest request)
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
getViolationDetails
in interface AWSFMS
getViolationDetailsRequest
- 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.public ListAppsListsResult listAppsLists(ListAppsListsRequest request)
Returns an array of AppsListDataSummary
objects.
listAppsLists
in interface AWSFMS
listAppsListsRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.LimitExceededException
- The operation exceeds a resource limit, for example, the maximum number of policy
objects
that you can create for an AWS account. For more information, see Firewall Manager Limits
in the AWS WAF Developer Guide.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListComplianceStatusResult listComplianceStatus(ListComplianceStatusRequest request)
Returns an array of PolicyComplianceStatus
objects. Use PolicyComplianceStatus
to get a
summary of which member accounts are protected by the specified policy.
listComplianceStatus
in interface AWSFMS
listComplianceStatusRequest
- 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.public ListMemberAccountsResult listMemberAccounts(ListMemberAccountsRequest request)
Returns a MemberAccounts
object that lists the member accounts in the administrator's AWS
organization.
The ListMemberAccounts
must be submitted by the account that is set as the AWS Firewall Manager
administrator.
listMemberAccounts
in interface AWSFMS
listMemberAccountsRequest
- 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.public ListPoliciesResult listPolicies(ListPoliciesRequest request)
Returns an array of PolicySummary
objects.
listPolicies
in interface AWSFMS
listPoliciesRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.LimitExceededException
- The operation exceeds a resource limit, for example, the maximum number of policy
objects
that you can create for an AWS account. For more information, see Firewall Manager Limits
in the AWS WAF Developer Guide.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListProtocolsListsResult listProtocolsLists(ListProtocolsListsRequest request)
Returns an array of ProtocolsListDataSummary
objects.
listProtocolsLists
in interface AWSFMS
listProtocolsListsRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for the specified AWS resource.
listTagsForResource
in interface AWSFMS
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.public PutAppsListResult putAppsList(PutAppsListRequest request)
Creates an AWS Firewall Manager applications list.
putAppsList
in interface AWSFMS
putAppsListRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InvalidInputException
- The parameters of the request were invalid.LimitExceededException
- The operation exceeds a resource limit, for example, the maximum number of policy
objects
that you can create for an AWS account. For more information, see Firewall Manager Limits
in the AWS WAF Developer Guide.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public PutNotificationChannelResult putNotificationChannel(PutNotificationChannelRequest request)
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager
role AWSServiceRoleForFMS
to publish SNS logs. For more information, see Firewall Manager
required permissions for API actions in the AWS Firewall Manager Developer Guide.
putNotificationChannel
in interface AWSFMS
putNotificationChannelRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public PutPolicyResult putPolicy(PutPolicyRequest request)
Creates an AWS Firewall Manager policy.
Firewall Manager provides the following types of policies:
An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.
An AWS WAF Classic policy (type WAF), which defines a rule group.
A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.
A security group policy, which manages VPC security groups across your AWS organization.
An AWS Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.
Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
putPolicy
in interface AWSFMS
putPolicyRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InvalidInputException
- The parameters of the request were invalid.LimitExceededException
- The operation exceeds a resource limit, for example, the maximum number of policy
objects
that you can create for an AWS account. For more information, see Firewall Manager Limits
in the AWS WAF Developer Guide.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidTypeException
- The value of the Type
parameter is invalid.public PutProtocolsListResult putProtocolsList(PutProtocolsListRequest request)
Creates an AWS Firewall Manager protocols list.
putProtocolsList
in interface AWSFMS
putProtocolsListRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InvalidInputException
- The parameters of the request were invalid.LimitExceededException
- The operation exceeds a resource limit, for example, the maximum number of policy
objects
that you can create for an AWS account. For more information, see Firewall Manager Limits
in the AWS WAF Developer Guide.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to an AWS resource.
tagResource
in interface AWSFMS
tagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.LimitExceededException
- The operation exceeds a resource limit, for example, the maximum number of policy
objects
that you can create for an AWS account. For more information, see Firewall Manager Limits
in the AWS WAF Developer Guide.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from an AWS resource.
untagResource
in interface AWSFMS
untagResourceRequest
- ResourceNotFoundException
- The specified resource was not found.InvalidOperationException
- The operation failed because there was nothing to do or the operation wasn't possible. For example, you
might have submitted an AssociateAdminAccount
request for an account ID that was already set
as the AWS Firewall Manager administrator. Or you might have tried to access a Region that's disabled by
default, and that you need to enable for the Firewall Manager administrator account and for AWS
Organizations before you can access it.InternalErrorException
- The operation failed because of a system problem, even though the request was valid. Retry your request.InvalidInputException
- The parameters of the request were invalid.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSFMS
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSFMS
shutdown
in class AmazonWebServiceClient