View on GitHub
FMS Structure Reference
FMS
public struct FMSClient object for interacting with AWS FMS service.
AWS Firewall Manager This is the AWS Firewall Manager API Reference. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS Firewall Manager Developer Guide.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the FMS client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
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.
Declaration
Swift
@discardableResult public func associateAdminAccount(_ input: AssociateAdminAccountRequest) -> EventLoopFuture<Void> -
Permanently deletes an AWS Firewall Manager applications list.
Declaration
Swift
@discardableResult public func deleteAppsList(_ input: DeleteAppsListRequest) -> EventLoopFuture<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.
Declaration
Swift
@discardableResult public func deleteNotificationChannel(_ input: DeleteNotificationChannelRequest) -> EventLoopFuture<Void> -
Permanently deletes an AWS Firewall Manager policy.
Declaration
Swift
@discardableResult public func deletePolicy(_ input: DeletePolicyRequest) -> EventLoopFuture<Void> -
Permanently deletes an AWS Firewall Manager protocols list.
Declaration
Swift
@discardableResult public func deleteProtocolsList(_ input: DeleteProtocolsListRequest) -> EventLoopFuture<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.
Declaration
Swift
@discardableResult public func disassociateAdminAccount(_ input: DisassociateAdminAccountRequest) -> EventLoopFuture<Void> -
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
Declaration
Swift
public func getAdminAccount(_ input: GetAdminAccountRequest) -> EventLoopFuture<GetAdminAccountResponse> -
Returns information about the specified AWS Firewall Manager applications list.
Declaration
Swift
public func getAppsList(_ input: GetAppsListRequest) -> EventLoopFuture<GetAppsListResponse> -
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.
Declaration
Swift
public func getComplianceDetail(_ input: GetComplianceDetailRequest) -> EventLoopFuture<GetComplianceDetailResponse> -
Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
Declaration
Swift
public func getNotificationChannel(_ input: GetNotificationChannelRequest) -> EventLoopFuture<GetNotificationChannelResponse> -
Returns information about the specified AWS Firewall Manager policy.
Declaration
Swift
public func getPolicy(_ input: GetPolicyRequest) -> EventLoopFuture<GetPolicyResponse> -
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.
Declaration
Swift
public func getProtectionStatus(_ input: GetProtectionStatusRequest) -> EventLoopFuture<GetProtectionStatusResponse> -
Returns information about the specified AWS Firewall Manager protocols list.
Declaration
Swift
public func getProtocolsList(_ input: GetProtocolsListRequest) -> EventLoopFuture<GetProtocolsListResponse> -
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
Declaration
Swift
public func getViolationDetails(_ input: GetViolationDetailsRequest) -> EventLoopFuture<GetViolationDetailsResponse> -
Returns an array of AppsListDataSummary objects.
Declaration
Swift
public func listAppsLists(_ input: ListAppsListsRequest) -> EventLoopFuture<ListAppsListsResponse> -
Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
Declaration
Swift
public func listComplianceStatus(_ input: ListComplianceStatusRequest) -> EventLoopFuture<ListComplianceStatusResponse> -
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.
Declaration
Swift
public func listMemberAccounts(_ input: ListMemberAccountsRequest) -> EventLoopFuture<ListMemberAccountsResponse> -
Returns an array of PolicySummary objects.
Declaration
Swift
public func listPolicies(_ input: ListPoliciesRequest) -> EventLoopFuture<ListPoliciesResponse> -
Returns an array of ProtocolsListDataSummary objects.
Declaration
Swift
public func listProtocolsLists(_ input: ListProtocolsListsRequest) -> EventLoopFuture<ListProtocolsListsResponse> -
Retrieves the list of tags for the specified AWS resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Creates an AWS Firewall Manager applications list.
Declaration
Swift
public func putAppsList(_ input: PutAppsListRequest) -> EventLoopFuture<PutAppsListResponse> -
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
Declaration
Swift
@discardableResult public func putNotificationChannel(_ input: PutNotificationChannelRequest) -> EventLoopFuture<Void> -
Creates an AWS Firewall Manager policy. Firewall Manager provides the following types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources 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 security group policy, which manages VPC security groups across your AWS organization. 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.
Declaration
Swift
public func putPolicy(_ input: PutPolicyRequest) -> EventLoopFuture<PutPolicyResponse> -
Creates an AWS Firewall Manager protocols list.
Declaration
Swift
public func putProtocolsList(_ input: PutProtocolsListRequest) -> EventLoopFuture<PutProtocolsListResponse> -
Adds one or more tags to an AWS resource.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Removes one or more tags from an AWS resource.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>
-
Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
Declaration
Swift
public func listComplianceStatusPaginator(_ input: ListComplianceStatusRequest, onPage: @escaping (ListComplianceStatusResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
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.
Declaration
Swift
public func listMemberAccountsPaginator(_ input: ListMemberAccountsRequest, onPage: @escaping (ListMemberAccountsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Returns an array of PolicySummary objects.
Declaration
Swift
public func listPoliciesPaginator(_ input: ListPoliciesRequest, onPage: @escaping (ListPoliciesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListComplianceStatusRequest : AWSShapeextension FMS.ListComplianceStatusRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListMemberAccountsRequest : AWSShapeextension FMS.ListMemberAccountsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListPoliciesRequest : AWSShapeextension FMS.ListPoliciesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AccountRoleStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum CustomerPolicyScopeIdType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DependentServiceName : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PolicyComplianceStatusType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RemediationActionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SecurityServiceType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ViolationReason : String, CustomStringConvertible, Codable