AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing FMS 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.

Inheritance Hierarchy

Amazon.FMS.IAmazonFMS

Namespace: Amazon.FMS
Assembly: AWSSDK.FMS.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonFMS
         IAmazonService, IDisposable

The IAmazonFMS type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateAdminAccount(AssociateAdminAccountRequest)

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with a master account in AWS Organizations 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.

Public Method AssociateAdminAccountAsync(AssociateAdminAccountRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateAdminAccount operation.

Public Method DeleteNotificationChannel(DeleteNotificationChannelRequest)

Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

Public Method DeleteNotificationChannelAsync(DeleteNotificationChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteNotificationChannel operation.

Public Method DeletePolicy(DeletePolicyRequest)

Permanently deletes an AWS Firewall Manager policy.

Public Method DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePolicy operation.

Public Method DisassociateAdminAccount(DisassociateAdminAccountRequest)

Disassociates the account that has been set as the AWS Firewall Manager administrator account. You will need to submit an AssociateAdminAccount request to set a new account as the AWS Firewall administrator.

Public Method DisassociateAdminAccountAsync(DisassociateAdminAccountRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateAdminAccount operation.

Public Method GetAdminAccount(GetAdminAccountRequest)

Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.

Public Method GetAdminAccountAsync(GetAdminAccountRequest, CancellationToken)

Initiates the asynchronous execution of the GetAdminAccount operation.

Public Method GetComplianceDetail(GetComplianceDetailRequest)

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered non-compliant if the specified policy has not been applied to them.

Public Method GetComplianceDetailAsync(GetComplianceDetailRequest, CancellationToken)

Initiates the asynchronous execution of the GetComplianceDetail operation.

Public Method GetNotificationChannel(GetNotificationChannelRequest)

Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

Public Method GetNotificationChannelAsync(GetNotificationChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetNotificationChannel operation.

Public Method GetPolicy(GetPolicyRequest)

Returns information about the specified AWS Firewall Manager policy.

Public Method GetPolicyAsync(GetPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the GetPolicy operation.

Public Method ListComplianceStatus(ListComplianceStatusRequest)

Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

Public Method ListComplianceStatusAsync(ListComplianceStatusRequest, CancellationToken)

Initiates the asynchronous execution of the ListComplianceStatus operation.

Public Method ListPolicies(ListPoliciesRequest)

Returns an array of PolicySummary objects in the response.

Public Method ListPoliciesAsync(ListPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicies operation.

Public Method PutNotificationChannel(PutNotificationChannelRequest)

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.

Public Method PutNotificationChannelAsync(PutNotificationChannelRequest, CancellationToken)

Initiates the asynchronous execution of the PutNotificationChannel operation.

Public Method PutPolicy(PutPolicyRequest)

Creates an AWS Firewall Manager policy.

Public Method PutPolicyAsync(PutPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the PutPolicy operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms