FMS class

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.

Constructors

FMS({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

associateAdminAccount({required String adminAccount}) → Future<void>
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.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
deleteAppsList({required String listId}) → Future<void>
Permanently deletes an AWS Firewall Manager applications list.
deleteNotificationChannel() → Future<void>
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.
deletePolicy({required String policyId, bool? deleteAllPolicyResources}) → Future<void>
Permanently deletes an AWS Firewall Manager policy.
deleteProtocolsList({required String listId}) → Future<void>
Permanently deletes an AWS Firewall Manager protocols list.
disassociateAdminAccount() → Future<void>
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.
getAdminAccount() → Future<GetAdminAccountResponse>
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
getAppsList({required String listId, bool? defaultList}) → Future<GetAppsListResponse>
Returns information about the specified AWS Firewall Manager applications list.
getComplianceDetail({required String memberAccount, required String policyId}) → Future<GetComplianceDetailResponse>
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.
getNotificationChannel() → Future<GetNotificationChannelResponse>
Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
getPolicy({required String policyId}) → Future<GetPolicyResponse>
Returns information about the specified AWS Firewall Manager policy.
getProtectionStatus({required String policyId, DateTime? endTime, int? maxResults, String? memberAccountId, String? nextToken, DateTime? startTime}) → Future<GetProtectionStatusResponse>
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.
getProtocolsList({required String listId, bool? defaultList}) → Future<GetProtocolsListResponse>
Returns information about the specified AWS Firewall Manager protocols list.
getViolationDetails({required String memberAccount, required String policyId, required String resourceId, required String resourceType}) → Future<GetViolationDetailsResponse>
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
listAppsLists({required int maxResults, bool? defaultLists, String? nextToken}) → Future<ListAppsListsResponse>
Returns an array of AppsListDataSummary objects.
listComplianceStatus({required String policyId, int? maxResults, String? nextToken}) → Future<ListComplianceStatusResponse>
Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
listMemberAccounts({int? maxResults, String? nextToken}) → Future<ListMemberAccountsResponse>
Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.
listPolicies({int? maxResults, String? nextToken}) → Future<ListPoliciesResponse>
Returns an array of PolicySummary objects.
listProtocolsLists({required int maxResults, bool? defaultLists, String? nextToken}) → Future<ListProtocolsListsResponse>
Returns an array of ProtocolsListDataSummary objects.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Retrieves the list of tags for the specified AWS resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putAppsList({required AppsListData appsList, List<Tag>? tagList}) → Future<PutAppsListResponse>
Creates an AWS Firewall Manager applications list.
putNotificationChannel({required String snsRoleName, required String snsTopicArn}) → Future<void>
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
putPolicy({required Policy policy, List<Tag>? tagList}) → Future<PutPolicyResponse>
Creates an AWS Firewall Manager policy.
putProtocolsList({required ProtocolsListData protocolsList, List<Tag>? tagList}) → Future<PutProtocolsListResponse>
Creates an AWS Firewall Manager protocols list.
tagResource({required String resourceArn, required List<Tag> tagList}) → Future<void>
Adds one or more tags to an AWS resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes one or more tags from an AWS resource.

Operators

operator ==(Object other) → bool
The equality operator.
inherited