paws (version 0.2.0)

fms: Firewall Management Service

Description

This is the Firewall Manager API Reference. This guide is for developers who need detailed information about the Firewall Manager API actions, data types, and errors. For detailed information about Firewall Manager features, see the 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.

• access_key_id: AWS access key ID

• secret_access_key: AWS secret access key

• session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

svc <- fms(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical"
  )
)

Operations

associate_admin_account	Sets the Firewall Manager administrator account
associate_third_party_firewall	Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service
delete_apps_list	Permanently deletes an Firewall Manager applications list
delete_notification_channel	Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs
delete_policy	Permanently deletes an Firewall Manager policy
delete_protocols_list	Permanently deletes an Firewall Manager protocols list
disassociate_admin_account	Disassociates the account that has been set as the Firewall Manager administrator account
disassociate_third_party_firewall	Disassociates a Firewall Manager policy administrator from a third-party firewall tenant
get_admin_account	Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator
get_apps_list	Returns information about the specified 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 Firewall Manager SNS logs
get_policy	Returns information about the specified 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 Firewall Manager protocols list
get_third_party_firewall_association_status	The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant
get_violation_details	Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services resource
list_third_party_firewall_firewall_policies	Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account
put_apps_list	Creates an Firewall Manager applications list
put_notification_channel	Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs
put_policy	Creates an Firewall Manager policy
put_protocols_list	Creates an Firewall Manager protocols list
tag_resource	Adds one or more tags to an Amazon Web Services resource
untag_resource	Removes one or more tags from an Amazon Web Services resource

Examples

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