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 AWS Firewall Manager administrator account.
-
#delete_apps_list(params = {}) ⇒ Struct
Permanently deletes an AWS Firewall Manager applications list.
-
#delete_notification_channel(params = {}) ⇒ Struct
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(params = {}) ⇒ Struct
Permanently deletes an AWS Firewall Manager policy.
-
#delete_protocols_list(params = {}) ⇒ Struct
Permanently deletes an AWS Firewall Manager protocols list.
-
#disassociate_admin_account(params = {}) ⇒ Struct
Disassociates the account that has been set as the AWS Firewall Manager administrator account.
-
#get_admin_account(params = {}) ⇒ Types::GetAdminAccountResponse
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
-
#get_apps_list(params = {}) ⇒ Types::GetAppsListResponse
Returns information about the specified AWS 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 AWS Firewall Manager SNS logs.
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Returns information about the specified AWS 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 AWS Firewall Manager protocols list.
-
#get_violation_details(params = {}) ⇒ Types::GetViolationDetailsResponse
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS 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_member_accounts(params = {}) ⇒ Types::ListMemberAccountsResponse
Returns a
MemberAccounts
object that lists the member accounts in the administrator's AWS 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_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for the specified AWS resource.
-
#put_apps_list(params = {}) ⇒ Types::PutAppsListResponse
Creates an AWS Firewall Manager applications list.
-
#put_notification_channel(params = {}) ⇒ Struct
Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.
-
#put_policy(params = {}) ⇒ Types::PutPolicyResponse
Creates an AWS Firewall Manager policy.
-
#put_protocols_list(params = {}) ⇒ Types::PutProtocolsListResponse
Creates an AWS Firewall Manager protocols list.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to an AWS resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an AWS 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.
334 335 336 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#associate_admin_account(params = {}) ⇒ Struct
Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account of your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.
The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account.
373 374 375 376 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 373 def associate_admin_account(params = {}, = {}) req = build_request(:associate_admin_account, params) req.send_request() end |
#delete_apps_list(params = {}) ⇒ Struct
Permanently deletes an AWS Firewall Manager applications list.
397 398 399 400 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 397 def delete_apps_list(params = {}, = {}) req = build_request(:delete_apps_list, params) req.send_request() end |
#delete_notification_channel(params = {}) ⇒ Struct
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.
412 413 414 415 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 412 def delete_notification_channel(params = {}, = {}) req = build_request(:delete_notification_channel, params) req.send_request() end |
#delete_policy(params = {}) ⇒ Struct
Permanently deletes an AWS Firewall Manager policy.
466 467 468 469 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 466 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() end |
#delete_protocols_list(params = {}) ⇒ Struct
Permanently deletes an AWS Firewall Manager protocols list.
490 491 492 493 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 490 def delete_protocols_list(params = {}, = {}) req = build_request(:delete_protocols_list, params) req.send_request() end |
#disassociate_admin_account(params = {}) ⇒ Struct
Disassociates the account that has been set as the AWS Firewall
Manager administrator account. To set a different account as the
administrator account, you must submit an AssociateAdminAccount
request.
506 507 508 509 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 506 def disassociate_admin_account(params = {}, = {}) req = build_request(:disassociate_admin_account, params) req.send_request() end |
#get_admin_account(params = {}) ⇒ Types::GetAdminAccountResponse
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
528 529 530 531 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 528 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 AWS Firewall Manager applications list.
578 579 580 581 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 578 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 AWS 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.
634 635 636 637 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 634 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 AWS Firewall Manager SNS logs.
656 657 658 659 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 656 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 AWS Firewall Manager policy.
705 706 707 708 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 705 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.
777 778 779 780 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 777 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 AWS Firewall Manager protocols list.
823 824 825 826 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 823 def get_protocols_list(params = {}, = {}) req = build_request(:get_protocols_list, params) req.send_request() end |
#get_violation_details(params = {}) ⇒ Types::GetViolationDetailsResponse
Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
946 947 948 949 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 946 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.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1002 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.
1067 1068 1069 1070 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1067 def list_compliance_status(params = {}, = {}) req = build_request(:list_compliance_status, params) req.send_request() end |
#list_member_accounts(params = {}) ⇒ Types::ListMemberAccountsResponse
Returns a MemberAccounts
object that lists the member accounts in
the administrator's AWS organization.
The ListMemberAccounts
must be submitted by the account that is set
as the AWS Firewall Manager administrator.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1118 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.
1170 1171 1172 1173 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1170 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.
1224 1225 1226 1227 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1224 def list_protocols_lists(params = {}, = {}) req = build_request(:list_protocols_lists, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of tags for the specified AWS resource.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1256 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_apps_list(params = {}) ⇒ Types::PutAppsListResponse
Creates an AWS Firewall Manager applications list.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1331 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 AWS 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 AWS Firewall Manager Developer
Guide.
1370 1371 1372 1373 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1370 def put_notification_channel(params = {}, = {}) req = build_request(:put_notification_channel, params) req.send_request() end |
#put_policy(params = {}) ⇒ Types::PutPolicyResponse
Creates an AWS Firewall Manager policy.
Firewall Manager provides the following types of policies:
An AWS WAF policy (type WAFV2), which defines rule groups to run first in the corresponding AWS WAF web ACL and rule groups to run last in the web ACL.
An AWS 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 AWS organization.
An AWS Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon 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.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1480 def put_policy(params = {}, = {}) req = build_request(:put_policy, params) req.send_request() end |
#put_protocols_list(params = {}) ⇒ Types::PutProtocolsListResponse
Creates an AWS Firewall Manager protocols list.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1538 def put_protocols_list(params = {}, = {}) req = build_request(:put_protocols_list, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to an AWS resource.
1571 1572 1573 1574 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1571 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 AWS resource.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/client.rb', line 1599 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |