Class: Aws::FMS::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When ‘:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.



334
335
336
 
# File 'lib/aws-sdk-fms/client.rb', line 334

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1641
1642
1643
 
# File 'lib/aws-sdk-fms/client.rb', line 1641

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1644
1645
1646
 
# File 'lib/aws-sdk-fms/client.rb', line 1644

def errors_module
  Errors
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.

Examples:

Request syntax with placeholder values


resp = client.({
  admin_account: "AWSAccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



373
374
375
376
 
# File 'lib/aws-sdk-fms/client.rb', line 373

def (params = {}, options = {})
  req = build_request(:associate_admin_account, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'lib/aws-sdk-fms/client.rb', line 1619

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-fms'
  context[:gem_version] = '1.36.0'
  Seahorse::Client::Request.new(handlers, context)
end

#delete_apps_list(params = {}) ⇒ Struct

Permanently deletes an AWS Firewall Manager applications list.

Examples:

Request syntax with placeholder values


resp = client.delete_apps_list({
  list_id: "ListId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :list_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



397
398
399
400
 
# File 'lib/aws-sdk-fms/client.rb', line 397

def delete_apps_list(params = {}, options = {})
  req = build_request(:delete_apps_list, params)
  req.send_request(options)
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.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



412
413
414
415
 
# File 'lib/aws-sdk-fms/client.rb', line 412

def delete_notification_channel(params = {}, options = {})
  req = build_request(:delete_notification_channel, params)
  req.send_request(options)
end

#delete_policy(params = {}) ⇒ Struct

Permanently deletes an AWS Firewall Manager policy.

Examples:

Request syntax with placeholder values


resp = client.delete_policy({
  policy_id: "PolicyId", # required
  delete_all_policy_resources: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The ID of the policy that you want to delete. You can retrieve this ID from ‘PutPolicy` and `ListPolicies`.

  • :delete_all_policy_resources (Boolean) —

    If ‘True`, the request performs cleanup according to the policy type.

    For AWS WAF and Shield Advanced policies, the cleanup does the following:

    • Deletes rule groups created by AWS 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



466
467
468
469
 
# File 'lib/aws-sdk-fms/client.rb', line 466

def delete_policy(params = {}, options = {})
  req = build_request(:delete_policy, params)
  req.send_request(options)
end

#delete_protocols_list(params = {}) ⇒ Struct

Permanently deletes an AWS Firewall Manager protocols list.

Examples:

Request syntax with placeholder values


resp = client.delete_protocols_list({
  list_id: "ListId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :list_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



490
491
492
493
 
# File 'lib/aws-sdk-fms/client.rb', line 490

def delete_protocols_list(params = {}, options = {})
  req = build_request(:delete_protocols_list, params)
  req.send_request(options)
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.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



506
507
508
509
 
# File 'lib/aws-sdk-fms/client.rb', line 506

def (params = {}, options = {})
  req = build_request(:disassociate_admin_account, params)
  req.send_request(options)
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.

Examples:

Response structure


resp. #=> String
resp.role_status #=> String, one of "READY", "CREATING", "PENDING_DELETION", "DELETING", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



528
529
530
531
 
# File 'lib/aws-sdk-fms/client.rb', line 528

def (params = {}, options = {})
  req = build_request(:get_admin_account, params)
  req.send_request(options)
end

#get_apps_list(params = {}) ⇒ Types::GetAppsListResponse

Returns information about the specified AWS Firewall Manager applications list.

Examples:

Request syntax with placeholder values


resp = client.get_apps_list({
  list_id: "ListId", # required
  default_list: false,
})

Response structure


resp.apps_list.list_id #=> String
resp.apps_list.list_name #=> String
resp.apps_list.list_update_token #=> String
resp.apps_list.create_time #=> Time
resp.apps_list.last_update_time #=> Time
resp.apps_list.apps_list #=> Array
resp.apps_list.apps_list[0].app_name #=> String
resp.apps_list.apps_list[0].protocol #=> String
resp.apps_list.apps_list[0].port #=> Integer
resp.apps_list.previous_apps_list #=> Hash
resp.apps_list.previous_apps_list["PreviousListVersion"] #=> Array
resp.apps_list.previous_apps_list["PreviousListVersion"][0].app_name #=> String
resp.apps_list.previous_apps_list["PreviousListVersion"][0].protocol #=> String
resp.apps_list.previous_apps_list["PreviousListVersion"][0].port #=> Integer
resp.apps_list_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :list_id (required, String) —

    The ID of the AWS Firewall Manager applications list that you want the details for.

  • :default_list (Boolean) —

    Specifies whether the list to retrieve is a default list owned by AWS Firewall Manager.

Returns:

See Also:



578
579
580
581
 
# File 'lib/aws-sdk-fms/client.rb', line 578

def get_apps_list(params = {}, options = {})
  req = build_request(:get_apps_list, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_compliance_detail({
  policy_id: "PolicyId", # required
  member_account: "AWSAccountId", # required
})

Response structure


resp.policy_compliance_detail.policy_owner #=> String
resp.policy_compliance_detail.policy_id #=> String
resp.policy_compliance_detail. #=> String
resp.policy_compliance_detail.violators #=> Array
resp.policy_compliance_detail.violators[0].resource_id #=> String
resp.policy_compliance_detail.violators[0].violation_reason #=> String, one of "WEB_ACL_MISSING_RULE_GROUP", "RESOURCE_MISSING_WEB_ACL", "RESOURCE_INCORRECT_WEB_ACL", "RESOURCE_MISSING_SHIELD_PROTECTION", "RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION", "RESOURCE_MISSING_SECURITY_GROUP", "RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP", "SECURITY_GROUP_UNUSED", "SECURITY_GROUP_REDUNDANT", "FMS_CREATED_SECURITY_GROUP_EDITED", "MISSING_FIREWALL", "MISSING_FIREWALL_SUBNET_IN_AZ", "MISSING_EXPECTED_ROUTE_TABLE", "NETWORK_FIREWALL_POLICY_MODIFIED", "RESOURCE_MISSING_DNS_FIREWALL"
resp.policy_compliance_detail.violators[0].resource_type #=> String
resp.policy_compliance_detail.evaluation_limit_exceeded #=> Boolean
resp.policy_compliance_detail.expired_at #=> Time
resp.policy_compliance_detail.issue_info_map #=> Hash
resp.policy_compliance_detail.issue_info_map["DependentServiceName"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The ID of the policy that you want to get the details for. ‘PolicyId` is returned by `PutPolicy` and by `ListPolicies`.

  • :member_account (required, String) —

    The AWS account that owns the resources that you want to get the details for.

Returns:

See Also:



634
635
636
637
 
# File 'lib/aws-sdk-fms/client.rb', line 634

def get_compliance_detail(params = {}, options = {})
  req = build_request(:get_compliance_detail, params)
  req.send_request(options)
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.

Examples:

Response structure


resp.sns_topic_arn #=> String
resp.sns_role_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



656
657
658
659
 
# File 'lib/aws-sdk-fms/client.rb', line 656

def get_notification_channel(params = {}, options = {})
  req = build_request(:get_notification_channel, params)
  req.send_request(options)
end

#get_policy(params = {}) ⇒ Types::GetPolicyResponse

Returns information about the specified AWS Firewall Manager policy.

Examples:

Request syntax with placeholder values


resp = client.get_policy({
  policy_id: "PolicyId", # required
})

Response structure


resp.policy.policy_id #=> String
resp.policy.policy_name #=> String
resp.policy.policy_update_token #=> String
resp.policy.security_service_policy_data.type #=> String, one of "WAF", "WAFV2", "SHIELD_ADVANCED", "SECURITY_GROUPS_COMMON", "SECURITY_GROUPS_CONTENT_AUDIT", "SECURITY_GROUPS_USAGE_AUDIT", "NETWORK_FIREWALL", "DNS_FIREWALL"
resp.policy.security_service_policy_data.managed_service_data #=> String
resp.policy.resource_type #=> String
resp.policy.resource_type_list #=> Array
resp.policy.resource_type_list[0] #=> String
resp.policy.resource_tags #=> Array
resp.policy.resource_tags[0].key #=> String
resp.policy.resource_tags[0].value #=> String
resp.policy.exclude_resource_tags #=> Boolean
resp.policy.remediation_enabled #=> Boolean
resp.policy.include_map #=> Hash
resp.policy.include_map["CustomerPolicyScopeIdType"] #=> Array
resp.policy.include_map["CustomerPolicyScopeIdType"][0] #=> String
resp.policy.exclude_map #=> Hash
resp.policy.exclude_map["CustomerPolicyScopeIdType"] #=> Array
resp.policy.exclude_map["CustomerPolicyScopeIdType"][0] #=> String
resp.policy_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The ID of the AWS Firewall Manager policy that you want the details for.

Returns:

See Also:



705
706
707
708
 
# File 'lib/aws-sdk-fms/client.rb', line 705

def get_policy(params = {}, options = {})
  req = build_request(:get_policy, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_protection_status({
  policy_id: "PolicyId", # required
  member_account_id: "AWSAccountId",
  start_time: Time.now,
  end_time: Time.now,
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp. #=> String
resp.service_type #=> String, one of "WAF", "WAFV2", "SHIELD_ADVANCED", "SECURITY_GROUPS_COMMON", "SECURITY_GROUPS_CONTENT_AUDIT", "SECURITY_GROUPS_USAGE_AUDIT", "NETWORK_FIREWALL", "DNS_FIREWALL"
resp.data #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

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

  • :member_account_id (String) —

    The AWS account that is in scope of the policy that you want to get the details for.

  • :start_time (Time, DateTime, Date, Integer, String) —

    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 AWS Firewall Manager is Unix time in seconds. However, any valid `timestamp` format is allowed.

  • :end_time (Time, DateTime, Date, Integer, String) —

    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 AWS Firewall Manager is Unix time in seconds. However, any valid `timestamp` format is allowed.

  • :next_token (String) —

    If you specify a value for ‘MaxResults` and you have more objects than the number that you specify for `MaxResults`, AWS 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.

  • :max_results (Integer) —

    Specifies the number of objects that you want AWS 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.

Returns:

See Also:



777
778
779
780
 
# File 'lib/aws-sdk-fms/client.rb', line 777

def get_protection_status(params = {}, options = {})
  req = build_request(:get_protection_status, params)
  req.send_request(options)
end

#get_protocols_list(params = {}) ⇒ Types::GetProtocolsListResponse

Returns information about the specified AWS Firewall Manager protocols list.

Examples:

Request syntax with placeholder values


resp = client.get_protocols_list({
  list_id: "ListId", # required
  default_list: false,
})

Response structure


resp.protocols_list.list_id #=> String
resp.protocols_list.list_name #=> String
resp.protocols_list.list_update_token #=> String
resp.protocols_list.create_time #=> Time
resp.protocols_list.last_update_time #=> Time
resp.protocols_list.protocols_list #=> Array
resp.protocols_list.protocols_list[0] #=> String
resp.protocols_list.previous_protocols_list #=> Hash
resp.protocols_list.previous_protocols_list["PreviousListVersion"] #=> Array
resp.protocols_list.previous_protocols_list["PreviousListVersion"][0] #=> String
resp.protocols_list_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :list_id (required, String) —

    The ID of the AWS Firewall Manager protocols list that you want the details for.

  • :default_list (Boolean) —

    Specifies whether the list to retrieve is a default list owned by AWS Firewall Manager.

Returns:

See Also:



823
824
825
826
 
# File 'lib/aws-sdk-fms/client.rb', line 823

def get_protocols_list(params = {}, options = {})
  req = build_request(:get_protocols_list, params)
  req.send_request(options)
end

#get_violation_details(params = {}) ⇒ Types::GetViolationDetailsResponse

Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.

Examples:

Request syntax with placeholder values


resp = client.get_violation_details({
  policy_id: "PolicyId", # required
  member_account: "AWSAccountId", # required
  resource_id: "ResourceId", # required
  resource_type: "ResourceType", # required
})

Response structure


resp.violation_detail.policy_id #=> String
resp.violation_detail. #=> String
resp.violation_detail.resource_id #=> String
resp.violation_detail.resource_type #=> String
resp.violation_detail.resource_violations #=> Array
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.violation_target_description #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.partial_matches #=> Array
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.partial_matches[0].reference #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.partial_matches[0].target_violation_reasons #=> Array
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.partial_matches[0].target_violation_reasons[0] #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions #=> Array
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].remediation_action_type #=> String, one of "REMOVE", "MODIFY"
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].description #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].remediation_result.ipv4_range #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].remediation_result.ipv6_range #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].remediation_result.prefix_list_id #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].remediation_result.protocol #=> String
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].remediation_result.from_port #=> Integer
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].remediation_result.to_port #=> Integer
resp.violation_detail.resource_violations[0].aws_vpc_security_group_violation.possible_security_group_remediation_actions[0].is_default_action #=> Boolean
resp.violation_detail.resource_violations[0].aws_ec2_network_interface_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].aws_ec2_network_interface_violation.violating_security_groups #=> Array
resp.violation_detail.resource_violations[0].aws_ec2_network_interface_violation.violating_security_groups[0] #=> String
resp.violation_detail.resource_violations[0].aws_ec2_instance_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].aws_ec2_instance_violation.aws_ec2_network_interface_violations #=> Array
resp.violation_detail.resource_violations[0].aws_ec2_instance_violation.aws_ec2_network_interface_violations[0].violation_target #=> String
resp.violation_detail.resource_violations[0].aws_ec2_instance_violation.aws_ec2_network_interface_violations[0].violating_security_groups #=> Array
resp.violation_detail.resource_violations[0].aws_ec2_instance_violation.aws_ec2_network_interface_violations[0].violating_security_groups[0] #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_firewall_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_firewall_violation.vpc #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_firewall_violation.availability_zone #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_firewall_violation.target_violation_reason #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_subnet_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_subnet_violation.vpc #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_subnet_violation.availability_zone #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_subnet_violation.target_violation_reason #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_expected_rt_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_expected_rt_violation.vpc #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_expected_rt_violation.availability_zone #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_expected_rt_violation.current_route_table #=> String
resp.violation_detail.resource_violations[0].network_firewall_missing_expected_rt_violation.expected_route_table #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_rule_groups #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_rule_groups[0].rule_group_name #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_rule_groups[0].resource_id #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_rule_groups[0].priority #=> Integer
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_default_actions #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_default_actions[0] #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_fragment_default_actions #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_fragment_default_actions[0] #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_custom_actions #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateless_custom_actions[0] #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateful_rule_groups #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateful_rule_groups[0].rule_group_name #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.current_policy_description.stateful_rule_groups[0].resource_id #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_rule_groups #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_rule_groups[0].rule_group_name #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_rule_groups[0].resource_id #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_rule_groups[0].priority #=> Integer
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_default_actions #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_default_actions[0] #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_fragment_default_actions #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_fragment_default_actions[0] #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_custom_actions #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateless_custom_actions[0] #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateful_rule_groups #=> Array
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateful_rule_groups[0].rule_group_name #=> String
resp.violation_detail.resource_violations[0].network_firewall_policy_modified_violation.expected_policy_description.stateful_rule_groups[0].resource_id #=> String
resp.violation_detail.resource_violations[0].dns_rule_group_priority_conflict_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].dns_rule_group_priority_conflict_violation.violation_target_description #=> String
resp.violation_detail.resource_violations[0].dns_rule_group_priority_conflict_violation.conflicting_priority #=> Integer
resp.violation_detail.resource_violations[0].dns_rule_group_priority_conflict_violation.conflicting_policy_id #=> String
resp.violation_detail.resource_violations[0].dns_rule_group_priority_conflict_violation.unavailable_priorities #=> Array
resp.violation_detail.resource_violations[0].dns_rule_group_priority_conflict_violation.unavailable_priorities[0] #=> Integer
resp.violation_detail.resource_violations[0].dns_duplicate_rule_group_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].dns_duplicate_rule_group_violation.violation_target_description #=> String
resp.violation_detail.resource_violations[0].dns_rule_group_limit_exceeded_violation.violation_target #=> String
resp.violation_detail.resource_violations[0].dns_rule_group_limit_exceeded_violation.violation_target_description #=> String
resp.violation_detail.resource_violations[0].dns_rule_group_limit_exceeded_violation.number_of_rule_groups_already_associated #=> Integer
resp.violation_detail.resource_tags #=> Array
resp.violation_detail.resource_tags[0].key #=> String
resp.violation_detail.resource_tags[0].value #=> String
resp.violation_detail.resource_description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The ID of the AWS Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.

  • :member_account (required, String) —

    The AWS account ID that you want the details for.

  • :resource_id (required, String) —

    The ID of the resource that has violations.

  • :resource_type (required, String) —

    The resource type. This is in the format shown in the [AWS Resource Types Reference]. Supported resource types are: ‘AWS::EC2::Instance`, `AWS::EC2::NetworkInterface`, `AWS::EC2::SecurityGroup`, `AWS::NetworkFirewall::FirewallPolicy`, and `AWS::EC2::Subnet`.

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

See Also:



957
958
959
960
 
# File 'lib/aws-sdk-fms/client.rb', line 957

def get_violation_details(params = {}, options = {})
  req = build_request(:get_violation_details, params)
  req.send_request(options)
end

#list_apps_lists(params = {}) ⇒ Types::ListAppsListsResponse

Returns an array of ‘AppsListDataSummary` objects.

Examples:

Request syntax with placeholder values


resp = client.list_apps_lists({
  default_lists: false,
  next_token: "PaginationToken",
  max_results: 1, # required
})

Response structure


resp.apps_lists #=> Array
resp.apps_lists[0].list_arn #=> String
resp.apps_lists[0].list_id #=> String
resp.apps_lists[0].list_name #=> String
resp.apps_lists[0].apps_list #=> Array
resp.apps_lists[0].apps_list[0].app_name #=> String
resp.apps_lists[0].apps_list[0].protocol #=> String
resp.apps_lists[0].apps_list[0].port #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :default_lists (Boolean) —

    Specifies whether the lists to retrieve are default lists owned by AWS Firewall Manager.

  • :next_token (String) —

    If you specify a value for ‘MaxResults` in your list request, and you have more objects than the maximum, AWS 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.

  • :max_results (required, Integer) —

    The maximum number of objects that you want AWS Firewall Manager to return for this request. If more objects are available, in the response, AWS 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, AWS Firewall Manager returns all available objects.

Returns:

See Also:



1013
1014
1015
1016
 
# File 'lib/aws-sdk-fms/client.rb', line 1013

def list_apps_lists(params = {}, options = {})
  req = build_request(:list_apps_lists, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_compliance_status({
  policy_id: "PolicyId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.policy_compliance_status_list #=> Array
resp.policy_compliance_status_list[0].policy_owner #=> String
resp.policy_compliance_status_list[0].policy_id #=> String
resp.policy_compliance_status_list[0].policy_name #=> String
resp.policy_compliance_status_list[0]. #=> String
resp.policy_compliance_status_list[0].evaluation_results #=> Array
resp.policy_compliance_status_list[0].evaluation_results[0].compliance_status #=> String, one of "COMPLIANT", "NON_COMPLIANT"
resp.policy_compliance_status_list[0].evaluation_results[0].violator_count #=> Integer
resp.policy_compliance_status_list[0].evaluation_results[0].evaluation_limit_exceeded #=> Boolean
resp.policy_compliance_status_list[0].last_updated #=> Time
resp.policy_compliance_status_list[0].issue_info_map #=> Hash
resp.policy_compliance_status_list[0].issue_info_map["DependentServiceName"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy_id (required, String) —

    The ID of the AWS Firewall Manager policy that you want the details for.

  • :next_token (String) —

    If you specify a value for ‘MaxResults` and you have more `PolicyComplianceStatus` objects than the number that you specify for `MaxResults`, AWS 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.

  • :max_results (Integer) —

    Specifies the number of ‘PolicyComplianceStatus` objects that you want AWS 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.

Returns:

See Also:



1078
1079
1080
1081
 
# File 'lib/aws-sdk-fms/client.rb', line 1078

def list_compliance_status(params = {}, options = {})
  req = build_request(:list_compliance_status, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_member_accounts({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.member_accounts #=> Array
resp.member_accounts[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    If you specify a value for ‘MaxResults` and you have more account IDs than the number that you specify for `MaxResults`, AWS 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.

  • :max_results (Integer) —

    Specifies the number of member account IDs that you want AWS 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.

Returns:

See Also:



1129
1130
1131
1132
 
# File 'lib/aws-sdk-fms/client.rb', line 1129

def list_member_accounts(params = {}, options = {})
  req = build_request(:list_member_accounts, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_policies({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.policy_list #=> Array
resp.policy_list[0].policy_arn #=> String
resp.policy_list[0].policy_id #=> String
resp.policy_list[0].policy_name #=> String
resp.policy_list[0].resource_type #=> String
resp.policy_list[0].security_service_type #=> String, one of "WAF", "WAFV2", "SHIELD_ADVANCED", "SECURITY_GROUPS_COMMON", "SECURITY_GROUPS_CONTENT_AUDIT", "SECURITY_GROUPS_USAGE_AUDIT", "NETWORK_FIREWALL", "DNS_FIREWALL"
resp.policy_list[0].remediation_enabled #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    If you specify a value for ‘MaxResults` and you have more `PolicySummary` objects than the number that you specify for `MaxResults`, AWS 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.

  • :max_results (Integer) —

    Specifies the number of ‘PolicySummary` objects that you want AWS 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.

Returns:

See Also:



1181
1182
1183
1184
 
# File 'lib/aws-sdk-fms/client.rb', line 1181

def list_policies(params = {}, options = {})
  req = build_request(:list_policies, params)
  req.send_request(options)
end

#list_protocols_lists(params = {}) ⇒ Types::ListProtocolsListsResponse

Returns an array of ‘ProtocolsListDataSummary` objects.

Examples:

Request syntax with placeholder values


resp = client.list_protocols_lists({
  default_lists: false,
  next_token: "PaginationToken",
  max_results: 1, # required
})

Response structure


resp.protocols_lists #=> Array
resp.protocols_lists[0].list_arn #=> String
resp.protocols_lists[0].list_id #=> String
resp.protocols_lists[0].list_name #=> String
resp.protocols_lists[0].protocols_list #=> Array
resp.protocols_lists[0].protocols_list[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :default_lists (Boolean) —

    Specifies whether the lists to retrieve are default lists owned by AWS Firewall Manager.

  • :next_token (String) —

    If you specify a value for ‘MaxResults` in your list request, and you have more objects than the maximum, AWS 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.

  • :max_results (required, Integer) —

    The maximum number of objects that you want AWS Firewall Manager to return for this request. If more objects are available, in the response, AWS 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, AWS Firewall Manager returns all available objects.

Returns:

See Also:



1235
1236
1237
1238
 
# File 'lib/aws-sdk-fms/client.rb', line 1235

def list_protocols_lists(params = {}, options = {})
  req = build_request(:list_protocols_lists, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves the list of tags for the specified AWS resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



1267
1268
1269
1270
 
# File 'lib/aws-sdk-fms/client.rb', line 1267

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_apps_list(params = {}) ⇒ Types::PutAppsListResponse

Creates an AWS Firewall Manager applications list.

Examples:

Request syntax with placeholder values


resp = client.put_apps_list({
  apps_list: { # required
    list_id: "ListId",
    list_name: "ResourceName", # required
    list_update_token: "UpdateToken",
    create_time: Time.now,
    last_update_time: Time.now,
    apps_list: [ # required
      {
        app_name: "ResourceName", # required
        protocol: "Protocol", # required
        port: 1, # required
      },
    ],
    previous_apps_list: {
      "PreviousListVersion" => [
        {
          app_name: "ResourceName", # required
          protocol: "Protocol", # required
          port: 1, # required
        },
      ],
    },
  },
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.apps_list.list_id #=> String
resp.apps_list.list_name #=> String
resp.apps_list.list_update_token #=> String
resp.apps_list.create_time #=> Time
resp.apps_list.last_update_time #=> Time
resp.apps_list.apps_list #=> Array
resp.apps_list.apps_list[0].app_name #=> String
resp.apps_list.apps_list[0].protocol #=> String
resp.apps_list.apps_list[0].port #=> Integer
resp.apps_list.previous_apps_list #=> Hash
resp.apps_list.previous_apps_list["PreviousListVersion"] #=> Array
resp.apps_list.previous_apps_list["PreviousListVersion"][0].app_name #=> String
resp.apps_list.previous_apps_list["PreviousListVersion"][0].protocol #=> String
resp.apps_list.previous_apps_list["PreviousListVersion"][0].port #=> Integer
resp.apps_list_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :apps_list (required, Types::AppsListData) —

    The details of the AWS Firewall Manager applications list to be created.

  • :tag_list (Array<Types::Tag>) —

    The tags associated with the resource.

Returns:

See Also:



1342
1343
1344
1345
 
# File 'lib/aws-sdk-fms/client.rb', line 1342

def put_apps_list(params = {}, options = {})
  req = build_request(:put_apps_list, params)
  req.send_request(options)
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*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html

Examples:

Request syntax with placeholder values


resp = client.put_notification_channel({
  sns_topic_arn: "ResourceArn", # required
  sns_role_name: "ResourceArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :sns_topic_arn (required, String) —

    The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.

  • :sns_role_name (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1381
1382
1383
1384
 
# File 'lib/aws-sdk-fms/client.rb', line 1381

def put_notification_channel(params = {}, options = {})
  req = build_request(:put_notification_channel, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html

Examples:

Request syntax with placeholder values


resp = client.put_policy({
  policy: { # required
    policy_id: "PolicyId",
    policy_name: "ResourceName", # required
    policy_update_token: "PolicyUpdateToken",
    security_service_policy_data: { # required
      type: "WAF", # required, accepts WAF, WAFV2, SHIELD_ADVANCED, SECURITY_GROUPS_COMMON, SECURITY_GROUPS_CONTENT_AUDIT, SECURITY_GROUPS_USAGE_AUDIT, NETWORK_FIREWALL, DNS_FIREWALL
      managed_service_data: "ManagedServiceData",
    },
    resource_type: "ResourceType", # required
    resource_type_list: ["ResourceType"],
    resource_tags: [
      {
        key: "ResourceTagKey", # required
        value: "ResourceTagValue",
      },
    ],
    exclude_resource_tags: false, # required
    remediation_enabled: false, # required
    include_map: {
      "ACCOUNT" => ["CustomerPolicyScopeId"],
    },
    exclude_map: {
      "ACCOUNT" => ["CustomerPolicyScopeId"],
    },
  },
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.policy.policy_id #=> String
resp.policy.policy_name #=> String
resp.policy.policy_update_token #=> String
resp.policy.security_service_policy_data.type #=> String, one of "WAF", "WAFV2", "SHIELD_ADVANCED", "SECURITY_GROUPS_COMMON", "SECURITY_GROUPS_CONTENT_AUDIT", "SECURITY_GROUPS_USAGE_AUDIT", "NETWORK_FIREWALL", "DNS_FIREWALL"
resp.policy.security_service_policy_data.managed_service_data #=> String
resp.policy.resource_type #=> String
resp.policy.resource_type_list #=> Array
resp.policy.resource_type_list[0] #=> String
resp.policy.resource_tags #=> Array
resp.policy.resource_tags[0].key #=> String
resp.policy.resource_tags[0].value #=> String
resp.policy.exclude_resource_tags #=> Boolean
resp.policy.remediation_enabled #=> Boolean
resp.policy.include_map #=> Hash
resp.policy.include_map["CustomerPolicyScopeIdType"] #=> Array
resp.policy.include_map["CustomerPolicyScopeIdType"][0] #=> String
resp.policy.exclude_map #=> Hash
resp.policy.exclude_map["CustomerPolicyScopeIdType"] #=> Array
resp.policy.exclude_map["CustomerPolicyScopeIdType"][0] #=> String
resp.policy_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :policy (required, Types::Policy) —

    The details of the AWS Firewall Manager policy to be created.

  • :tag_list (Array<Types::Tag>) —

    The tags to add to the AWS resource.

Returns:

See Also:



1491
1492
1493
1494
 
# File 'lib/aws-sdk-fms/client.rb', line 1491

def put_policy(params = {}, options = {})
  req = build_request(:put_policy, params)
  req.send_request(options)
end

#put_protocols_list(params = {}) ⇒ Types::PutProtocolsListResponse

Creates an AWS Firewall Manager protocols list.

Examples:

Request syntax with placeholder values


resp = client.put_protocols_list({
  protocols_list: { # required
    list_id: "ListId",
    list_name: "ResourceName", # required
    list_update_token: "UpdateToken",
    create_time: Time.now,
    last_update_time: Time.now,
    protocols_list: ["Protocol"], # required
    previous_protocols_list: {
      "PreviousListVersion" => ["Protocol"],
    },
  },
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.protocols_list.list_id #=> String
resp.protocols_list.list_name #=> String
resp.protocols_list.list_update_token #=> String
resp.protocols_list.create_time #=> Time
resp.protocols_list.last_update_time #=> Time
resp.protocols_list.protocols_list #=> Array
resp.protocols_list.protocols_list[0] #=> String
resp.protocols_list.previous_protocols_list #=> Hash
resp.protocols_list.previous_protocols_list["PreviousListVersion"] #=> Array
resp.protocols_list.previous_protocols_list["PreviousListVersion"][0] #=> String
resp.protocols_list_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :protocols_list (required, Types::ProtocolsListData) —

    The details of the AWS Firewall Manager protocols list to be created.

  • :tag_list (Array<Types::Tag>) —

    The tags associated with the resource.

Returns:

See Also:



1549
1550
1551
1552
 
# File 'lib/aws-sdk-fms/client.rb', line 1549

def put_protocols_list(params = {}, options = {})
  req = build_request(:put_protocols_list, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to an AWS resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tag_list: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_list (required, Array<Types::Tag>) —

    The tags to add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1582
1583
1584
1585
 
# File 'lib/aws-sdk-fms/client.rb', line 1582

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from an AWS resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    The keys of the tags to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1610
1611
1612
1613
 
# File 'lib/aws-sdk-fms/client.rb', line 1610

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1634
1635
1636
 
# File 'lib/aws-sdk-fms/client.rb', line 1634

def waiter_names
  []
end