Expand description
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.
If you’re using the service, you’re probably looking for FmsClient and Fms.
Structs§
- Associate
Admin Account Request - Compliance
Violator Details of the resource that is not protected by the policy.
- Delete
Notification Channel Request - Delete
Policy Request - Disassociate
Admin Account Request - Evaluation
Result Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don't comply with the policy.
- FmsClient
- A client for the FMS API.
- GetAdmin
Account Request - GetAdmin
Account Response - GetCompliance
Detail Request - GetCompliance
Detail Response - GetNotification
Channel Request - GetNotification
Channel Response - GetPolicy
Request - GetPolicy
Response - GetProtection
Status Request - GetProtection
Status Response - List
Compliance Status Request - List
Compliance Status Response - List
Member Accounts Request - List
Member Accounts Response - List
Policies Request - List
Policies Response - List
Tags ForResource Request - List
Tags ForResource Response - Policy
An AWS Firewall Manager policy.
- Policy
Compliance Detail Describes the noncompliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant,
EvaluationLimitExceededis set toTrue.- Policy
Compliance Status Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for AWS WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.
- Policy
Summary Details of the AWS Firewall Manager policy.
- PutNotification
Channel Request - PutPolicy
Request - PutPolicy
Response - Resource
Tag The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.
- Security
Service Policy Data Details about the security service that is being used to protect the resources.
- Tag
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
- TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response
Enums§
- Associate
Admin Account Error - Errors returned by AssociateAdminAccount
- Delete
Notification Channel Error - Errors returned by DeleteNotificationChannel
- Delete
Policy Error - Errors returned by DeletePolicy
- Disassociate
Admin Account Error - Errors returned by DisassociateAdminAccount
- GetAdmin
Account Error - Errors returned by GetAdminAccount
- GetCompliance
Detail Error - Errors returned by GetComplianceDetail
- GetNotification
Channel Error - Errors returned by GetNotificationChannel
- GetPolicy
Error - Errors returned by GetPolicy
- GetProtection
Status Error - Errors returned by GetProtectionStatus
- List
Compliance Status Error - Errors returned by ListComplianceStatus
- List
Member Accounts Error - Errors returned by ListMemberAccounts
- List
Policies Error - Errors returned by ListPolicies
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutNotification
Channel Error - Errors returned by PutNotificationChannel
- PutPolicy
Error - Errors returned by PutPolicy
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
Traits§
- Fms
- Trait representing the capabilities of the FMS API. FMS clients implement this trait.