Fms

associate_admin_account(admin_account)
associate_admin_account(admin_account, params::Dict{String,<:Any})

Sets the Firewall Manager administrator account. The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies. The account that you associate with Firewall Manager is called the Firewall Manager administrator account.

Arguments

• admin_account: The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager administrator account. This must be an Organizations member account. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

associate_third_party_firewall(third_party_firewall)
associate_third_party_firewall(third_party_firewall, params::Dict{String,<:Any})

Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account.

Arguments

• third_party_firewall: The name of the third-party firewall vendor.

batch_associate_resource(items, resource_set_identifier)
batch_associate_resource(items, resource_set_identifier, params::Dict{String,<:Any})

Associate resources to a Firewall Manager resource set.

Arguments

• items: The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs).
• resource_set_identifier: A unique identifier for the resource set, used in a TODO to refer to the resource set.

batch_disassociate_resource(items, resource_set_identifier)
batch_disassociate_resource(items, resource_set_identifier, params::Dict{String,<:Any})

Disassociates resources from a Firewall Manager resource set.

Arguments

• items: The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs).
• resource_set_identifier: A unique identifier for the resource set, used in a TODO to refer to the resource set.

delete_apps_list(list_id)
delete_apps_list(list_id, params::Dict{String,<:Any})

Permanently deletes an Firewall Manager applications list.

Arguments

• list_id: The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList, ListAppsLists, and GetAppsList.

delete_notification_channel()
delete_notification_channel(params::Dict{String,<:Any})

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(policy_id)
delete_policy(policy_id, params::Dict{String,<:Any})

Permanently deletes an Firewall Manager policy.

Arguments

• policy_id: The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DeleteAllPolicyResources": If True, the request performs cleanup according to the policy type. For WAF and Shield Advanced policies, the cleanup does the following: Deletes rule groups created by Firewall Manager Removes web ACLs from in-scope resources Deletes web ACLs that contain no rules or rule groups For security group policies, the cleanup does the following for each security group in the policy: Disassociates the security group from in-scope resources Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.

delete_protocols_list(list_id)
delete_protocols_list(list_id, params::Dict{String,<:Any})

Permanently deletes an Firewall Manager protocols list.

Arguments

• list_id: The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.

delete_resource_set(identifier)
delete_resource_set(identifier, params::Dict{String,<:Any})

Deletes the specified ResourceSet.

Arguments

• identifier: A unique identifier for the resource set, used in a TODO to refer to the resource set.

disassociate_admin_account()
disassociate_admin_account(params::Dict{String,<:Any})

Disassociates the account that has been set as the Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.

disassociate_third_party_firewall(third_party_firewall)
disassociate_third_party_firewall(third_party_firewall, params::Dict{String,<:Any})

Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call DisassociateThirdPartyFirewall, the third-party firewall vendor deletes all of the firewalls that are associated with the account.

Arguments

• third_party_firewall: The name of the third-party firewall vendor.

get_admin_account()
get_admin_account(params::Dict{String,<:Any})

Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.

get_apps_list(list_id)
get_apps_list(list_id, params::Dict{String,<:Any})

Returns information about the specified Firewall Manager applications list.

Arguments

• list_id: The ID of the Firewall Manager applications list that you want the details for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DefaultList": Specifies whether the list to retrieve is a default list owned by Firewall Manager.

get_compliance_detail(member_account, policy_id)
get_compliance_detail(member_account, policy_id, params::Dict{String,<:Any})

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible. Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules. Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.

Arguments

• member_account: The Amazon Web Services account that owns the resources that you want to get the details for.
• policy_id: The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.

get_notification_channel()
get_notification_channel(params::Dict{String,<:Any})

Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.

get_policy(policy_id)
get_policy(policy_id, params::Dict{String,<:Any})

Returns information about the specified Firewall Manager policy.

Arguments

• policy_id: The ID of the Firewall Manager policy that you want the details for.

get_protection_status(policy_id)
get_protection_status(policy_id, params::Dict{String,<:Any})

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

Arguments

• policy_id: The ID of the policy for which you want to get the attack information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "EndTime": The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
• "MaxResults": Specifies the number of objects that you want Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects.
• "MemberAccountId": The Amazon Web Services account that is in scope of the policy that you want to get the details for.
• "NextToken": If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.
• "StartTime": The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

get_protocols_list(list_id)
get_protocols_list(list_id, params::Dict{String,<:Any})

Returns information about the specified Firewall Manager protocols list.

Arguments

• list_id: The ID of the Firewall Manager protocols list that you want the details for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DefaultList": Specifies whether the list to retrieve is a default list owned by Firewall Manager.

get_resource_set(identifier)
get_resource_set(identifier, params::Dict{String,<:Any})

Gets information about a specific resource set.

Arguments

• identifier: A unique identifier for the resource set, used in a TODO to refer to the resource set.

get_third_party_firewall_association_status(third_party_firewall)
get_third_party_firewall_association_status(third_party_firewall, params::Dict{String,<:Any})

The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.

Arguments

• third_party_firewall: The name of the third-party firewall vendor.

get_violation_details(member_account, policy_id, resource_id, resource_type)
get_violation_details(member_account, policy_id, resource_id, resource_type, params::Dict{String,<:Any})

Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.

Arguments

• member_account: The Amazon Web Services account ID that you want the details for.
• policy_id: The ID of the Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.
• resource_id: The ID of the resource that has violations.
• resource_type: The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance, AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy, and AWS::EC2::Subnet.

list_apps_lists(max_results)
list_apps_lists(max_results, params::Dict{String,<:Any})

Returns an array of AppsListDataSummary objects.

Arguments

• max_results: The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects. If you don't specify this, Firewall Manager returns all available objects.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DefaultLists": Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
• "NextToken": If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

list_compliance_status(policy_id)
list_compliance_status(policy_id, params::Dict{String,<:Any})

Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

Arguments

• policy_id: The ID of the Firewall Manager policy that you want the details for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.
• "NextToken": If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

list_discovered_resources(member_account_ids, resource_type)
list_discovered_resources(member_account_ids, resource_type, params::Dict{String,<:Any})

Returns an array of resources in the organization's accounts that are available to be associated with a resource set.

Arguments

• member_account_ids: The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.
• resource_type: The type of resources to discover.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
• "NextToken": When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

list_member_accounts()
list_member_accounts(params::Dict{String,<:Any})

Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization. The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager administrator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.
• "NextToken": If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

list_policies()
list_policies(params::Dict{String,<:Any})

Returns an array of PolicySummary objects.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": Specifies the number of PolicySummary objects that you want Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.
• "NextToken": If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

list_protocols_lists(max_results)
list_protocols_lists(max_results, params::Dict{String,<:Any})

Returns an array of ProtocolsListDataSummary objects.

Arguments

• max_results: The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects. If you don't specify this, Firewall Manager returns all available objects.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DefaultLists": Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
• "NextToken": If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.

list_resource_set_resources(identifier)
list_resource_set_resources(identifier, params::Dict{String,<:Any})

Returns an array of resources that are currently associated to a resource set.

Arguments

• identifier: A unique identifier for the resource set, used in a TODO to refer to the resource set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
• "NextToken": When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

list_resource_sets()
list_resource_sets(params::Dict{String,<:Any})

Returns an array of ResourceSetSummary objects.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
• "NextToken": When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Firewall Manager returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Retrieves the list of tags for the specified Amazon Web Services resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.

list_third_party_firewall_firewall_policies(max_results, third_party_firewall)
list_third_party_firewall_firewall_policies(max_results, third_party_firewall, params::Dict{String,<:Any})

Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.

Arguments

• max_results: The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than MaxResults firewall policies, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.
• third_party_firewall: The name of the third-party firewall vendor.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "NextToken": If the previous response included a NextToken element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit another ListThirdPartyFirewallFirewallPoliciesRequest request. For the value of NextToken, specify the value of NextToken from the previous response. If the previous response didn't include a NextToken element, there are no more third-party firewall policies to get.

put_apps_list(apps_list)
put_apps_list(apps_list, params::Dict{String,<:Any})

Creates an Firewall Manager applications list.

Arguments

• apps_list: The details of the Firewall Manager applications list to be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "TagList": The tags associated with the resource.

put_notification_channel(sns_role_name, sns_topic_arn)
put_notification_channel(sns_role_name, sns_topic_arn, params::Dict{String,<:Any})

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role AWSServiceRoleForFMS to publish SNS logs. For more information, see Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide.

Arguments

• sns_role_name: The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record Firewall Manager activity.
• sns_topic_arn: The Amazon Resource Name (ARN) of the SNS topic that collects notifications from Firewall Manager.

put_policy(policy)
put_policy(policy, params::Dict{String,<:Any})

Creates an Firewall Manager policy. Firewall Manager provides the following types of policies: An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL. An WAF Classic policy (type WAF), which defines a rule group. A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources. A security group policy, which manages VPC security groups across your Amazon Web Services organization. An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs. A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs. Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.

Arguments

• policy: The details of the Firewall Manager policy to be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "TagList": The tags to add to the Amazon Web Services resource.

put_protocols_list(protocols_list)
put_protocols_list(protocols_list, params::Dict{String,<:Any})

Creates an Firewall Manager protocols list.

Arguments

• protocols_list: The details of the Firewall Manager protocols list to be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "TagList": The tags associated with the resource.

put_resource_set(resource_set)
put_resource_set(resource_set, params::Dict{String,<:Any})

Creates the resource set. An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

Arguments

• resource_set: Details about the resource set to be created or updated.>

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "TagList": Retrieves the tags associated with the specified resource set. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

tag_resource(resource_arn, tag_list)
tag_resource(resource_arn, tag_list, params::Dict{String,<:Any})

Adds one or more tags to an Amazon Web Services resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.
• tag_list: The tags to add to the resource.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes one or more tags from an Amazon Web Services resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.
• tag_keys: The keys of the tags to remove from the resource.