Class: Aws::FMS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::FMS::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb
Overview
An API client for FMS. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::FMS::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_admin_account(params = {}) ⇒ Struct
Sets the Firewall Manager administrator account.
-
#associate_third_party_firewall(params = {}) ⇒ Types::AssociateThirdPartyFirewallResponse
Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service.
-
#batch_associate_resource(params = {}) ⇒ Types::BatchAssociateResourceResponse
Associate resources to a Firewall Manager resource set.
-
#batch_disassociate_resource(params = {}) ⇒ Types::BatchDisassociateResourceResponse
Disassociates resources from a Firewall Manager resource set.
-
#delete_apps_list(params = {}) ⇒ Struct
Permanently deletes an Firewall Manager applications list.
-
#delete_notification_channel(params = {}) ⇒ Struct
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(params = {}) ⇒ Struct
Permanently deletes an Firewall Manager policy.
-
#delete_protocols_list(params = {}) ⇒ Struct
Permanently deletes an Firewall Manager protocols list.
-
#delete_resource_set(params = {}) ⇒ Struct
Deletes the specified ResourceSet.
-
#disassociate_admin_account(params = {}) ⇒ Struct
Disassociates the account that has been set as the Firewall Manager administrator account.
-
#disassociate_third_party_firewall(params = {}) ⇒ Types::DisassociateThirdPartyFirewallResponse
Disassociates a Firewall Manager policy administrator from a third-party firewall tenant.
-
#get_admin_account(params = {}) ⇒ Types::GetAdminAccountResponse
Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.
-
#get_apps_list(params = {}) ⇒ Types::GetAppsListResponse
Returns information about the specified Firewall Manager applications list.
-
#get_compliance_detail(params = {}) ⇒ Types::GetComplianceDetailResponse
Returns detailed compliance information about the specified member account.
-
#get_notification_channel(params = {}) ⇒ Types::GetNotificationChannelResponse
Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Returns information about the specified Firewall Manager policy.
-
#get_protection_status(params = {}) ⇒ Types::GetProtectionStatusResponse
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
-
#get_protocols_list(params = {}) ⇒ Types::GetProtocolsListResponse
Returns information about the specified Firewall Manager protocols list.
-
#get_resource_set(params = {}) ⇒ Types::GetResourceSetResponse
Gets information about a specific resource set.
-
#get_third_party_firewall_association_status(params = {}) ⇒ Types::GetThirdPartyFirewallAssociationStatusResponse
The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
-
#get_violation_details(params = {}) ⇒ Types::GetViolationDetailsResponse
Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
-
#list_apps_lists(params = {}) ⇒ Types::ListAppsListsResponse
Returns an array of
AppsListDataSummary
objects. -
#list_compliance_status(params = {}) ⇒ Types::ListComplianceStatusResponse
Returns an array of
PolicyComplianceStatus
objects. -
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResponse
Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
-
#list_member_accounts(params = {}) ⇒ Types::ListMemberAccountsResponse
Returns a
MemberAccounts
object that lists the member accounts in the administrator's Amazon Web Services organization. -
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Returns an array of
PolicySummary
objects. -
#list_protocols_lists(params = {}) ⇒ Types::ListProtocolsListsResponse
Returns an array of
ProtocolsListDataSummary
objects. -
#list_resource_set_resources(params = {}) ⇒ Types::ListResourceSetResourcesResponse
Returns an array of resources that are currently associated to a resource set.
-
#list_resource_sets(params = {}) ⇒ Types::ListResourceSetsResponse
Returns an array of
ResourceSetSummary
objects. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for the specified Amazon Web Services resource.
-
#list_third_party_firewall_firewall_policies(params = {}) ⇒ Types::ListThirdPartyFirewallFirewallPoliciesResponse
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(params = {}) ⇒ Types::PutAppsListResponse
Creates an Firewall Manager applications list.
-
#put_notification_channel(params = {}) ⇒ Struct
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs.
-
#put_policy(params = {}) ⇒ Types::PutPolicyResponse
Creates an Firewall Manager policy.
-
#put_protocols_list(params = {}) ⇒ Types::PutProtocolsListResponse
Creates an Firewall Manager protocols list.
-
#put_resource_set(params = {}) ⇒ Types::PutResourceSetResponse
Creates the resource set.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to an Amazon Web Services resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an Amazon Web Services resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
375 376 377 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 375 def initialize(*args) super end |
Instance Method Details
#associate_admin_account(params = {}) ⇒ Struct
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.
412 413 414 415 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 412 def associate_admin_account(params = {}, = {}) req = build_request(:associate_admin_account, params) req.send_request() end |
#associate_third_party_firewall(params = {}) ⇒ Types::AssociateThirdPartyFirewallResponse
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.
443 444 445 446 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 443 def associate_third_party_firewall(params = {}, = {}) req = build_request(:associate_third_party_firewall, params) req.send_request() end |
#batch_associate_resource(params = {}) ⇒ Types::BatchAssociateResourceResponse
Associate resources to a Firewall Manager resource set.
482 483 484 485 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 482 def batch_associate_resource(params = {}, = {}) req = build_request(:batch_associate_resource, params) req.send_request() end |
#batch_disassociate_resource(params = {}) ⇒ Types::BatchDisassociateResourceResponse
Disassociates resources from a Firewall Manager resource set.
521 522 523 524 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 521 def batch_disassociate_resource(params = {}, = {}) req = build_request(:batch_disassociate_resource, params) req.send_request() end |
#delete_apps_list(params = {}) ⇒ Struct
Permanently deletes an Firewall Manager applications list.
545 546 547 548 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 545 def delete_apps_list(params = {}, = {}) req = build_request(:delete_apps_list, params) req.send_request() end |
#delete_notification_channel(params = {}) ⇒ Struct
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.
560 561 562 563 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 560 def delete_notification_channel(params = {}, = {}) req = build_request(:delete_notification_channel, params) req.send_request() end |
#delete_policy(params = {}) ⇒ Struct
Permanently deletes an Firewall Manager policy.
613 614 615 616 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 613 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() end |
#delete_protocols_list(params = {}) ⇒ Struct
Permanently deletes an Firewall Manager protocols list.
637 638 639 640 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 637 def delete_protocols_list(params = {}, = {}) req = build_request(:delete_protocols_list, params) req.send_request() end |
#delete_resource_set(params = {}) ⇒ Struct
Deletes the specified ResourceSet.
660 661 662 663 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 660 def delete_resource_set(params = {}, = {}) req = build_request(:delete_resource_set, params) req.send_request() end |
#disassociate_admin_account(params = {}) ⇒ Struct
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.
675 676 677 678 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 675 def disassociate_admin_account(params = {}, = {}) req = build_request(:disassociate_admin_account, params) req.send_request() end |
#disassociate_third_party_firewall(params = {}) ⇒ Types::DisassociateThirdPartyFirewallResponse
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.
706 707 708 709 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 706 def disassociate_third_party_firewall(params = {}, = {}) req = build_request(:disassociate_third_party_firewall, params) req.send_request() end |
#get_admin_account(params = {}) ⇒ Types::GetAdminAccountResponse
Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.
728 729 730 731 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 728 def get_admin_account(params = {}, = {}) req = build_request(:get_admin_account, params) req.send_request() end |
#get_apps_list(params = {}) ⇒ Types::GetAppsListResponse
Returns information about the specified Firewall Manager applications list.
778 779 780 781 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 778 def get_apps_list(params = {}, = {}) req = build_request(:get_apps_list, params) req.send_request() end |
#get_compliance_detail(params = {}) ⇒ Types::GetComplianceDetailResponse
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.
844 845 846 847 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 844 def get_compliance_detail(params = {}, = {}) req = build_request(:get_compliance_detail, params) req.send_request() end |
#get_notification_channel(params = {}) ⇒ Types::GetNotificationChannelResponse
Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
866 867 868 869 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 866 def get_notification_channel(params = {}, = {}) req = build_request(:get_notification_channel, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Returns information about the specified Firewall Manager policy.
920 921 922 923 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 920 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#get_protection_status(params = {}) ⇒ Types::GetProtectionStatusResponse
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.
992 993 994 995 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 992 def get_protection_status(params = {}, = {}) req = build_request(:get_protection_status, params) req.send_request() end |
#get_protocols_list(params = {}) ⇒ Types::GetProtocolsListResponse
Returns information about the specified Firewall Manager protocols list.
1038 1039 1040 1041 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1038 def get_protocols_list(params = {}, = {}) req = build_request(:get_protocols_list, params) req.send_request() end |
#get_resource_set(params = {}) ⇒ Types::GetResourceSetResponse
Gets information about a specific resource set.
1075 1076 1077 1078 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1075 def get_resource_set(params = {}, = {}) req = build_request(:get_resource_set, params) req.send_request() end |
#get_third_party_firewall_association_status(params = {}) ⇒ Types::GetThirdPartyFirewallAssociationStatusResponse
The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.
1106 1107 1108 1109 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1106 def get_third_party_firewall_association_status(params = {}, = {}) req = build_request(:get_third_party_firewall_association_status, params) req.send_request() end |
#get_violation_details(params = {}) ⇒ Types::GetViolationDetailsResponse
Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1471 def get_violation_details(params = {}, = {}) req = build_request(:get_violation_details, params) req.send_request() end |
#list_apps_lists(params = {}) ⇒ Types::ListAppsListsResponse
Returns an array of AppsListDataSummary
objects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1529 1530 1531 1532 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1529 def list_apps_lists(params = {}, = {}) req = build_request(:list_apps_lists, params) req.send_request() end |
#list_compliance_status(params = {}) ⇒ Types::ListComplianceStatusResponse
Returns an array of PolicyComplianceStatus
objects. Use
PolicyComplianceStatus
to get a summary of which member accounts are
protected by the specified policy.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1593 def list_compliance_status(params = {}, = {}) req = build_request(:list_compliance_status, params) req.send_request() end |
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResponse
Returns an array of resources in the organization's accounts that are available to be associated with a resource set.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1649 def list_discovered_resources(params = {}, = {}) req = build_request(:list_discovered_resources, params) req.send_request() end |
#list_member_accounts(params = {}) ⇒ Types::ListMemberAccountsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1700 def list_member_accounts(params = {}, = {}) req = build_request(:list_member_accounts, params) req.send_request() end |
#list_policies(params = {}) ⇒ Types::ListPoliciesResponse
Returns an array of PolicySummary
objects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1753 1754 1755 1756 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1753 def list_policies(params = {}, = {}) req = build_request(:list_policies, params) req.send_request() end |
#list_protocols_lists(params = {}) ⇒ Types::ListProtocolsListsResponse
Returns an array of ProtocolsListDataSummary
objects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1809 1810 1811 1812 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1809 def list_protocols_lists(params = {}, = {}) req = build_request(:list_protocols_lists, params) req.send_request() end |
#list_resource_set_resources(params = {}) ⇒ Types::ListResourceSetResourcesResponse
Returns an array of resources that are currently associated to a resource set.
1858 1859 1860 1861 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1858 def list_resource_set_resources(params = {}, = {}) req = build_request(:list_resource_set_resources, params) req.send_request() end |
#list_resource_sets(params = {}) ⇒ Types::ListResourceSetsResponse
Returns an array of ResourceSetSummary
objects.
1903 1904 1905 1906 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1903 def list_resource_sets(params = {}, = {}) req = build_request(:list_resource_sets, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for the specified Amazon Web Services resource.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1936 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_third_party_firewall_firewall_policies(params = {}) ⇒ Types::ListThirdPartyFirewallFirewallPoliciesResponse
Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1993 1994 1995 1996 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1993 def list_third_party_firewall_firewall_policies(params = {}, = {}) req = build_request(:list_third_party_firewall_firewall_policies, params) req.send_request() end |
#put_apps_list(params = {}) ⇒ Types::PutAppsListResponse
Creates an Firewall Manager applications list.
2067 2068 2069 2070 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 2067 def put_apps_list(params = {}, = {}) req = build_request(:put_apps_list, params) req.send_request() end |
#put_notification_channel(params = {}) ⇒ Struct
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.
2106 2107 2108 2109 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 2106 def put_notification_channel(params = {}, = {}) req = build_request(:put_notification_channel, params) req.send_request() end |
#put_policy(params = {}) ⇒ Types::PutPolicyResponse
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.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 2236 def put_policy(params = {}, = {}) req = build_request(:put_policy, params) req.send_request() end |
#put_protocols_list(params = {}) ⇒ Types::PutProtocolsListResponse
Creates an Firewall Manager protocols list.
2294 2295 2296 2297 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 2294 def put_protocols_list(params = {}, = {}) req = build_request(:put_protocols_list, params) req.send_request() end |
#put_resource_set(params = {}) ⇒ Types::PutResourceSetResponse
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.
2354 2355 2356 2357 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 2354 def put_resource_set(params = {}, = {}) req = build_request(:put_resource_set, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to an Amazon Web Services resource.
2387 2388 2389 2390 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 2387 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an Amazon Web Services resource.
2415 2416 2417 2418 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 2415 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |