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 Service roles for Firewall Manager.
fms(config = list(), credentials = list(), endpoint = NULL, region = NULL)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.
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
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.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
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.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
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",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| associate_admin_account | Sets a Firewall Manager default administrator account |
| associate_third_party_firewall | Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service |
| batch_associate_resource | Associate resources to a Firewall Manager resource set |
| batch_disassociate_resource | Disassociates resources from a Firewall Manager resource set |
| 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 |
| delete_resource_set | Deletes the specified ResourceSet |
| disassociate_admin_account | Disassociates an 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 default administrator |
| get_admin_scope | Returns information about the specified account's administrative scope |
| 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_resource_set | Gets information about a specific resource set |
| 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_admin_accounts_for_organization | Returns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount |
| list_admins_managing_account | Lists the accounts that are managing the specified Organizations member account |
| list_apps_lists | Returns an array of AppsListDataSummary objects |
| list_compliance_status | Returns an array of PolicyComplianceStatus objects |
| list_discovered_resources | Returns an array of resources in the organization's accounts that are available to be associated with a resource set |
| 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_resource_set_resources | Returns an array of resources that are currently associated to a resource set |
| list_resource_sets | Returns an array of ResourceSetSummary 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_admin_account | Creates or updates an Firewall Manager administrator 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 |
| put_resource_set | Creates the resource set |
| 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 |
if (FALSE) {
svc <- fms()
svc$associate_admin_account(
Foo = 123
)
}
Run the code above in your browser using DataLab