fms: Firewall Management Service

Description Usage Arguments Service syntax Operations Examples

View source: R/fms_service.R

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.

Usage

1
fms(config = list())

Arguments

config

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

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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_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
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_compliance_detail Returns detailed compliance information about the specified member account
get_notification_channel Returns 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
list_compliance_status Returns an array of PolicyComplianceStatus objects in the response
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 in the response
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

Examples

1
2
3
4
svc <- fms()
svc$associate_admin_account(
  Foo = 123
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.