paws.security.identity (version 0.1.12)

fms: Firewall Management Service

Description

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.

Some API actions require explicit resource permissions. For information, see the developer guide topic Firewall Manager required permissions for API actions.

Usage

fms(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- fms(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_admin_account	Sets the AWS Firewall Manager administrator account
delete_apps_list	Permanently deletes an AWS Firewall Manager applications list
delete_notification_channel	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
delete_policy	Permanently deletes an AWS Firewall Manager policy
delete_protocols_list	Permanently deletes an AWS Firewall Manager protocols list
disassociate_admin_account	Disassociates the account that has been set as the AWS Firewall Manager administrator account
get_admin_account	Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator
get_apps_list	Returns information about the specified AWS Firewall Manager applications list
get_compliance_detail	Returns detailed compliance information about the specified member account
get_notification_channel	Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs
get_policy	Returns information about the specified AWS Firewall Manager policy
get_protection_status	If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack
get_protocols_list	Returns information about the specified AWS Firewall Manager protocols list
get_violation_details	Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account
list_apps_lists	Returns an array of AppsListDataSummary objects
list_compliance_status	Returns an array of PolicyComplianceStatus objects
list_member_accounts	Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization
list_policies	Returns an array of PolicySummary objects
list_protocols_lists	Returns an array of ProtocolsListDataSummary objects
list_tags_for_resource	Retrieves the list of tags for the specified AWS resource
put_apps_list	Creates an AWS Firewall Manager applications list
put_notification_channel	Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs
put_policy	Creates an AWS Firewall Manager policy
put_protocols_list	Creates an AWS Firewall Manager protocols list
tag_resource	Adds one or more tags to an AWS resource
untag_resource	Removes one or more tags from an AWS resource

Examples

if (FALSE) {
svc <- fms()
svc$associate_admin_account(
  Foo = 123
)
}