Class: AWS.FMS

Inherits:
AWS.Service show all
Identifier:
fms
API Version:
2018-01-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This is the AWS Firewall Manager API Reference. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS Firewall Manager Developer Guide.

Some API actions require explicit resource permissions. For information, see the developer guide topic Firewall Manager required permissions for API actions.

Sending a Request Using FMS

var fms = new AWS.FMS();
fms.associateAdminAccount(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the FMS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var fms = new AWS.FMS({apiVersion: '2018-01-01'});

You can also set the API version globally in AWS.config.apiVersions using the fms service identifier:

AWS.config.apiVersions = {
  fms: '2018-01-01',
  // other service API versions
};

var fms = new AWS.FMS();

Version:

  • 2018-01-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.FMS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a FMS object

var fms = new AWS.FMS({apiVersion: '2018-01-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.FMS.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.FMS.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.FMS.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateAdminAccount(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateAdminAccount operation

var params = {
  AdminAccount: 'STRING_VALUE' /* required */
};
fms.associateAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AdminAccount — (String)

      The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see Managing the AWS Accounts in Your Organization.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAppsList(params = {}, callback) ⇒ AWS.Request

Permanently deletes an AWS Firewall Manager applications list.

Service Reference:

Examples:

Calling the deleteAppsList operation

var params = {
  ListId: 'STRING_VALUE' /* required */
};
fms.deleteAppsList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ListId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteNotificationChannel(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteNotificationChannel operation

var params = {
};
fms.deleteNotificationChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deletePolicy(params = {}, callback) ⇒ AWS.Request

Permanently deletes an AWS Firewall Manager policy.

Service Reference:

Examples:

Calling the deletePolicy operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  DeleteAllPolicyResources: true || false
};
fms.deletePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PolicyId — (String)

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

    • DeleteAllPolicyResources — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteProtocolsList(params = {}, callback) ⇒ AWS.Request

Permanently deletes an AWS Firewall Manager protocols list.

Service Reference:

Examples:

Calling the deleteProtocolsList operation

var params = {
  ListId: 'STRING_VALUE' /* required */
};
fms.deleteProtocolsList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ListId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateAdminAccount(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the disassociateAdminAccount operation

var params = {
};
fms.disassociateAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAdminAccount(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getAdminAccount operation

var params = {
};
fms.getAdminAccount(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AdminAccount — (String)

        The AWS account that is set as the AWS Firewall Manager administrator.

      • RoleStatus — (String)

        The status of the AWS account that you set as the AWS Firewall Manager administrator.

        Possible values include:
        • "READY"
        • "CREATING"
        • "PENDING_DELETION"
        • "DELETING"
        • "DELETED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAppsList(params = {}, callback) ⇒ AWS.Request

Returns information about the specified AWS Firewall Manager applications list.

Service Reference:

Examples:

Calling the getAppsList operation

var params = {
  ListId: 'STRING_VALUE', /* required */
  DefaultList: true || false
};
fms.getAppsList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ListId — (String)

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

    • DefaultList — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AppsList — (map)

        Information about the specified AWS Firewall Manager applications list.

        • ListId — (String)

          The ID of the AWS Firewall Manager applications list.

        • ListNamerequired — (String)

          The name of the AWS Firewall Manager applications list.

        • ListUpdateToken — (String)

          A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

        • CreateTime — (Date)

          The time that the AWS Firewall Manager applications list was created.

        • LastUpdateTime — (Date)

          The time that the AWS Firewall Manager applications list was last updated.

        • AppsListrequired — (Array<map>)

          An array of applications in the AWS Firewall Manager applications list.

          • AppNamerequired — (String)

            The application's name.

          • Protocolrequired — (String)

            The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

          • Portrequired — (Integer)

            The application's port number, for example 80.

        • PreviousAppsList — (map<Array<map>>)

          A map of previous version numbers to their corresponding App object arrays.

          • AppNamerequired — (String)

            The application's name.

          • Protocolrequired — (String)

            The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

          • Portrequired — (Integer)

            The application's port number, for example 80.

      • AppsListArn — (String)

        The Amazon Resource Name (ARN) of the applications list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getComplianceDetail(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getComplianceDetail operation

var params = {
  MemberAccount: 'STRING_VALUE', /* required */
  PolicyId: 'STRING_VALUE' /* required */
};
fms.getComplianceDetail(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PolicyId — (String)

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

    • MemberAccount — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyComplianceDetail — (map)

        Information about the resources and the policy that you specified in the GetComplianceDetail request.

        • PolicyOwner — (String)

          The AWS account that created the AWS Firewall Manager policy.

        • PolicyId — (String)

          The ID of the AWS Firewall Manager policy.

        • MemberAccount — (String)

          The AWS account ID.

        • Violators — (Array<map>)

          An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or that aren't in compliance with the security group policy.

          • ResourceId — (String)

            The resource ID.

          • ViolationReason — (String)

            The reason that the resource is not protected by the policy.

            Possible values include:
            • "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"
            • "MISSING_FIREWALL"
            • "MISSING_FIREWALL_SUBNET_IN_AZ"
            • "MISSING_EXPECTED_ROUTE_TABLE"
            • "NETWORK_FIREWALL_POLICY_MODIFIED"
          • ResourceType — (String)

            The resource type. This is in the format shown in the AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy.

        • EvaluationLimitExceeded — (Boolean)

          Indicates if over 100 resources are noncompliant with the AWS Firewall Manager policy.

        • ExpiredAt — (Date)

          A timestamp that indicates when the returned information should be considered out of date.

        • IssueInfoMap — (map<String>)

          Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getNotificationChannel(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getNotificationChannel operation

var params = {
};
fms.getNotificationChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnsTopicArn — (String)

        The SNS topic that records AWS Firewall Manager activity.

      • SnsRoleName — (String)

        The IAM role that is used by AWS Firewall Manager to record activity to SNS.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPolicy(params = {}, callback) ⇒ AWS.Request

Returns information about the specified AWS Firewall Manager policy.

Service Reference:

Examples:

Calling the getPolicy operation

var params = {
  PolicyId: 'STRING_VALUE' /* required */
};
fms.getPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PolicyId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (map)

        Information about the specified AWS Firewall Manager policy.

        • PolicyId — (String)

          The ID of the AWS Firewall Manager policy.

        • PolicyNamerequired — (String)

          The name of the AWS Firewall Manager policy.

        • PolicyUpdateToken — (String)

          A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

        • SecurityServicePolicyDatarequired — (map)

          Details about the security service that is being used to protect the resources.

          • Typerequired — (String)

            The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting AWS Support.

            Possible values include:
            • "WAF"
            • "WAFV2"
            • "SHIELD_ADVANCED"
            • "SECURITY_GROUPS_COMMON"
            • "SECURITY_GROUPS_CONTENT_AUDIT"
            • "SECURITY_GROUPS_USAGE_AUDIT"
            • "NETWORK_FIREWALL"
          • ManagedServiceData — (String)

            Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED, this is an empty string.

            • Example: NETWORK_FIREWALL

              "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\",\"priority\":10}],\"networkFirewallStatelessDefaultActions\":[\"aws:pass\",\"custom1\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"custom2\",\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"custom1\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension1\"}]}}},{\"actionName\":\"custom2\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension2\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":true,\"allowedIPV4CidrList\":[\"10.24.34.0/28\"]} }"

            • Example: WAFV2

              "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"

              In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and the RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD.

            • Example: WAF Classic

              "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"

            • Example: SECURITY_GROUPS_COMMON

              "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"

            • Example: SECURITY_GROUPS_CONTENT_AUDIT

              "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"

              The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.

            • Example: SECURITY_GROUPS_USAGE_AUDIT

              "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"

        • ResourceTyperequired — (String)

          The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an AWS Network Firewall policy, the value is AWS::EC2::VPC.

        • ResourceTypeList — (Array<String>)

          An array of ResourceType.

        • ResourceTags — (Array<map>)

          An array of ResourceTag objects.

          • Keyrequired — (String)

            The resource tag key.

          • Value — (String)

            The resource tag value.

        • ExcludeResourceTagsrequired — (Boolean)

          If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

        • RemediationEnabledrequired — (Boolean)

          Indicates if the policy should be automatically applied to new resources.

        • IncludeMap — (map<Array<String>>)

          Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

          You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

          You can specify account IDs, OUs, or a combination:

          • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

          • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

          • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

        • ExcludeMap — (map<Array<String>>)

          Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

          You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

          You can specify account IDs, OUs, or a combination:

          • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

          • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

          • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

      • PolicyArn — (String)

        The Amazon Resource Name (ARN) of the specified policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getProtectionStatus(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getProtectionStatus operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  MemberAccountId: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
fms.getProtectionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PolicyId — (String)

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

    • MemberAccountId — (String)

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

    • StartTime — (Date)

      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.

    • EndTime — (Date)

      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.

    • NextToken — (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.

    • MaxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AdminAccountId — (String)

        The ID of the AWS Firewall administrator account for this policy.

      • ServiceType — (String)

        The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.

        Possible values include:
        • "WAF"
        • "WAFV2"
        • "SHIELD_ADVANCED"
        • "SECURITY_GROUPS_COMMON"
        • "SECURITY_GROUPS_CONTENT_AUDIT"
        • "SECURITY_GROUPS_USAGE_AUDIT"
        • "NETWORK_FIREWALL"
      • Data — (String)

        Details about the attack, including the following:

        • Attack type

        • Account ID

        • ARN of the resource attacked

        • Start time of the attack

        • End time of the attack (ongoing attacks will not have an end time)

        The details are in JSON format.

      • NextToken — (String)

        If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

        AWS SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getProtocolsList(params = {}, callback) ⇒ AWS.Request

Returns information about the specified AWS Firewall Manager protocols list.

Service Reference:

Examples:

Calling the getProtocolsList operation

var params = {
  ListId: 'STRING_VALUE', /* required */
  DefaultList: true || false
};
fms.getProtocolsList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ListId — (String)

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

    • DefaultList — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProtocolsList — (map)

        Information about the specified AWS Firewall Manager protocols list.

        • ListId — (String)

          The ID of the AWS Firewall Manager protocols list.

        • ListNamerequired — (String)

          The name of the AWS Firewall Manager protocols list.

        • ListUpdateToken — (String)

          A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

        • CreateTime — (Date)

          The time that the AWS Firewall Manager protocols list was created.

        • LastUpdateTime — (Date)

          The time that the AWS Firewall Manager protocols list was last updated.

        • ProtocolsListrequired — (Array<String>)

          An array of protocols in the AWS Firewall Manager protocols list.

        • PreviousProtocolsList — (map<Array<String>>)

          A map of previous version numbers to their corresponding protocol arrays.

      • ProtocolsListArn — (String)

        The Amazon Resource Name (ARN) of the specified protocols list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getViolationDetails(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getViolationDetails operation

var params = {
  MemberAccount: 'STRING_VALUE', /* required */
  PolicyId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE' /* required */
};
fms.getViolationDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PolicyId — (String)

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

    • MemberAccount — (String)

      The AWS account ID that you want the details for.

    • ResourceId — (String)

      The ID of the resource that has violations.

    • ResourceType — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ViolationDetail — (map)

        Violation detail for a resource.

        • PolicyIdrequired — (String)

          The ID of the AWS Firewall Manager policy that the violation details were requested for.

        • MemberAccountrequired — (String)

          The AWS account that the violation details were requested for.

        • ResourceIdrequired — (String)

          The resource ID that the violation details were requested for.

        • ResourceTyperequired — (String)

          The resource type that the violation details were requested for.

        • ResourceViolationsrequired — (Array<map>)

          List of violations for the requested resource.

          • AwsVPCSecurityGroupViolation — (map)

            Violation details for security groups.

            • ViolationTarget — (String)

              The security group rule that is being evaluated.

            • ViolationTargetDescription — (String)

              A description of the security group that violates the policy.

            • PartialMatches — (Array<map>)

              List of rules specified in the security group of the AWS Firewall Manager policy that partially match the ViolationTarget rule.

              • Reference — (String)

                The reference rule from the master security group of the AWS Firewall Manager policy.

              • TargetViolationReasons — (Array<String>)

                The violation reason.

            • PossibleSecurityGroupRemediationActions — (Array<map>)

              Remediation options for the rule specified in the ViolationTarget.

              • RemediationActionType — (String)

                The remediation action that will be performed.

                Possible values include:
                • "REMOVE"
                • "MODIFY"
              • Description — (String)

                Brief description of the action that will be performed.

              • RemediationResult — (map)

                The final state of the rule specified in the ViolationTarget after it is remediated.

                • IPV4Range — (String)

                  The IPv4 ranges for the security group rule.

                • IPV6Range — (String)

                  The IPv6 ranges for the security group rule.

                • PrefixListId — (String)

                  The ID of the prefix list for the security group rule.

                • Protocol — (String)

                  The IP protocol name (tcp, udp, icmp, icmpv6) or number.

                • FromPort — (Integer)

                  The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

                • ToPort — (Integer)

                  The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes.

              • IsDefaultAction — (Boolean)

                Indicates if the current action is the default action.

          • AwsEc2NetworkInterfaceViolation — (map)

            Violation details for network interface.

            • ViolationTarget — (String)

              The resource ID of the network interface.

            • ViolatingSecurityGroups — (Array<String>)

              List of security groups that violate the rules specified in the master security group of the AWS Firewall Manager policy.

          • AwsEc2InstanceViolation — (map)

            Violation details for an EC2 instance.

            • ViolationTarget — (String)

              The resource ID of the EC2 instance.

            • AwsEc2NetworkInterfaceViolations — (Array<map>)

              Violations for network interfaces associated with the EC2 instance.

              • ViolationTarget — (String)

                The resource ID of the network interface.

              • ViolatingSecurityGroups — (Array<String>)

                List of security groups that violate the rules specified in the master security group of the AWS Firewall Manager policy.

          • NetworkFirewallMissingFirewallViolation — (map)

            Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.

            • ViolationTarget — (String)

              The ID of the AWS Network Firewall or VPC resource that's in violation.

            • VPC — (String)

              The resource ID of the VPC associated with a violating subnet.

            • AvailabilityZone — (String)

              The Availability Zone of a violating subnet.

            • TargetViolationReason — (String)

              The reason the resource has this violation, if one is available.

          • NetworkFirewallMissingSubnetViolation — (map)

            Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.

            • ViolationTarget — (String)

              The ID of the AWS Network Firewall or VPC resource that's in violation.

            • VPC — (String)

              The resource ID of the VPC associated with a violating subnet.

            • AvailabilityZone — (String)

              The Availability Zone of a violating subnet.

            • TargetViolationReason — (String)

              The reason the resource has this violation, if one is available.

          • NetworkFirewallMissingExpectedRTViolation — (map)

            Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.

            • ViolationTarget — (String)

              The ID of the AWS Network Firewall or VPC resource that's in violation.

            • VPC — (String)

              The resource ID of the VPC associated with a violating subnet.

            • AvailabilityZone — (String)

              The Availability Zone of a violating subnet.

            • CurrentRouteTable — (String)

              The resource ID of the current route table that's associated with the subnet, if one is available.

            • ExpectedRouteTable — (String)

              The resource ID of the route table that should be associated with the subnet.

          • NetworkFirewallPolicyModifiedViolation — (map)

            Violation detail for an Network Firewall policy that indicates that a firewall policy in an individual account has been modified in a way that makes it noncompliant. For example, the individual account owner might have deleted a rule group, changed the priority of a stateless rule group, or changed a policy default action.

            • ViolationTarget — (String)

              The ID of the AWS Network Firewall or VPC resource that's in violation.

            • CurrentPolicyDescription — (map)

              The policy that's currently in use in the individual account.

              • StatelessRuleGroups — (Array<map>)

                The stateless rule groups that are used in the Network Firewall firewall policy.

                • RuleGroupName — (String)

                  The name of the rule group.

                • ResourceId — (String)

                  The resource ID of the rule group.

                • Priority — (Integer)

                  The priority of the rule group. AWS Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.

              • StatelessDefaultActions — (Array<String>)

                The actions to take on packets that don't match any of the stateless rule groups.

              • StatelessFragmentDefaultActions — (Array<String>)

                The actions to take on packet fragments that don't match any of the stateless rule groups.

              • StatelessCustomActions — (Array<String>)

                Names of custom actions that are available for use in the stateless default actions settings.

              • StatefulRuleGroups — (Array<map>)

                The stateful rule groups that are used in the Network Firewall firewall policy.

                • RuleGroupName — (String)

                  The name of the rule group.

                • ResourceId — (String)

                  The resource ID of the rule group.

            • ExpectedPolicyDescription — (map)

              The policy that should be in use in the individual account in order to be compliant.

              • StatelessRuleGroups — (Array<map>)

                The stateless rule groups that are used in the Network Firewall firewall policy.

                • RuleGroupName — (String)

                  The name of the rule group.

                • ResourceId — (String)

                  The resource ID of the rule group.

                • Priority — (Integer)

                  The priority of the rule group. AWS Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.

              • StatelessDefaultActions — (Array<String>)

                The actions to take on packets that don't match any of the stateless rule groups.

              • StatelessFragmentDefaultActions — (Array<String>)

                The actions to take on packet fragments that don't match any of the stateless rule groups.

              • StatelessCustomActions — (Array<String>)

                Names of custom actions that are available for use in the stateless default actions settings.

              • StatefulRuleGroups — (Array<map>)

                The stateful rule groups that are used in the Network Firewall firewall policy.

                • RuleGroupName — (String)

                  The name of the rule group.

                • ResourceId — (String)

                  The resource ID of the rule group.

        • ResourceTags — (Array<map>)

          The ResourceTag objects associated with the resource.

          • Keyrequired — (String)

            Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

          • Valuerequired — (String)

            Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

        • ResourceDescription — (String)

          Brief description for the requested resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAppsLists(params = {}, callback) ⇒ AWS.Request

Returns an array of AppsListDataSummary objects.

Service Reference:

Examples:

Calling the listAppsLists operation

var params = {
  MaxResults: 'NUMBER_VALUE', /* required */
  DefaultLists: true || false,
  NextToken: 'STRING_VALUE'
};
fms.listAppsLists(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DefaultLists — (Boolean)

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

    • NextToken — (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.

    • MaxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AppsLists — (Array<map>)

        An array of AppsListDataSummary objects.

        • ListArn — (String)

          The Amazon Resource Name (ARN) of the applications list.

        • ListId — (String)

          The ID of the applications list.

        • ListName — (String)

          The name of the applications list.

        • AppsList — (Array<map>)

          An array of App objects in the AWS Firewall Manager applications list.

          • AppNamerequired — (String)

            The application's name.

          • Protocolrequired — (String)

            The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

          • Portrequired — (Integer)

            The application's port number, for example 80.

      • NextToken — (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. You can use this token in subsequent requests to retrieve the next batch of objects.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listComplianceStatus(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listComplianceStatus operation

var params = {
  PolicyId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
fms.listComplianceStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PolicyId — (String)

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

    • NextToken — (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.

    • MaxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyComplianceStatusList — (Array<map>)

        An array of PolicyComplianceStatus objects.

        • PolicyOwner — (String)

          The AWS account that created the AWS Firewall Manager policy.

        • PolicyId — (String)

          The ID of the AWS Firewall Manager policy.

        • PolicyName — (String)

          The name of the AWS Firewall Manager policy.

        • MemberAccount — (String)

          The member account ID.

        • EvaluationResults — (Array<map>)

          An array of EvaluationResult objects.

          • ComplianceStatus — (String)

            Describes an AWS account's compliance with the AWS Firewall Manager policy.

            Possible values include:
            • "COMPLIANT"
            • "NON_COMPLIANT"
          • ViolatorCount — (Integer)

            The number of resources that are noncompliant with the specified policy. For AWS WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn't comply with the rules of the policy and remediation is disabled or not possible.

          • EvaluationLimitExceeded — (Boolean)

            Indicates that over 100 resources are noncompliant with the AWS Firewall Manager policy.

        • LastUpdated — (Date)

          Timestamp of the last update to the EvaluationResult objects.

        • IssueInfoMap — (map<String>)

          Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.

      • NextToken — (String)

        If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listMemberAccounts(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listMemberAccounts operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
fms.listMemberAccounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (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.

    • MaxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MemberAccounts — (Array<String>)

        An array of account IDs.

      • NextToken — (String)

        If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPolicies(params = {}, callback) ⇒ AWS.Request

Returns an array of PolicySummary objects.

Service Reference:

Examples:

Calling the listPolicies operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
fms.listPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (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.

    • MaxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyList — (Array<map>)

        An array of PolicySummary objects.

        • PolicyArn — (String)

          The Amazon Resource Name (ARN) of the specified policy.

        • PolicyId — (String)

          The ID of the specified policy.

        • PolicyName — (String)

          The name of the specified policy.

        • ResourceType — (String)

          The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an AWS Network Firewall policy, the value is AWS::EC2::VPC.

        • SecurityServiceType — (String)

          The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.

          Possible values include:
          • "WAF"
          • "WAFV2"
          • "SHIELD_ADVANCED"
          • "SECURITY_GROUPS_COMMON"
          • "SECURITY_GROUPS_CONTENT_AUDIT"
          • "SECURITY_GROUPS_USAGE_AUDIT"
          • "NETWORK_FIREWALL"
        • RemediationEnabled — (Boolean)

          Indicates if the policy should be automatically applied to new resources.

      • NextToken — (String)

        If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProtocolsLists(params = {}, callback) ⇒ AWS.Request

Returns an array of ProtocolsListDataSummary objects.

Service Reference:

Examples:

Calling the listProtocolsLists operation

var params = {
  MaxResults: 'NUMBER_VALUE', /* required */
  DefaultLists: true || false,
  NextToken: 'STRING_VALUE'
};
fms.listProtocolsLists(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DefaultLists — (Boolean)

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

    • NextToken — (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.

    • MaxResults — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProtocolsLists — (Array<map>)

        An array of ProtocolsListDataSummary objects.

        • ListArn — (String)

          The Amazon Resource Name (ARN) of the specified protocols list.

        • ListId — (String)

          The ID of the specified protocols list.

        • ListName — (String)

          The name of the specified protocols list.

        • ProtocolsList — (Array<String>)

          An array of protocols in the AWS Firewall Manager protocols list.

      • NextToken — (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. You can use this token in subsequent requests to retrieve the next batch of objects.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves the list of tags for the specified AWS resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
fms.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TagList — (Array<map>)

        The tags associated with the resource.

        • Keyrequired — (String)

          Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

        • Valuerequired — (String)

          Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putAppsList(params = {}, callback) ⇒ AWS.Request

Creates an AWS Firewall Manager applications list.

Service Reference:

Examples:

Calling the putAppsList operation

var params = {
  AppsList: { /* required */
    AppsList: [ /* required */
      {
        AppName: 'STRING_VALUE', /* required */
        Port: 'NUMBER_VALUE', /* required */
        Protocol: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    ListName: 'STRING_VALUE', /* required */
    CreateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    LastUpdateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ListId: 'STRING_VALUE',
    ListUpdateToken: 'STRING_VALUE',
    PreviousAppsList: {
      '<PreviousListVersion>': [
        {
          AppName: 'STRING_VALUE', /* required */
          Port: 'NUMBER_VALUE', /* required */
          Protocol: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      /* '<PreviousListVersion>': ... */
    }
  },
  TagList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fms.putAppsList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AppsList — (map)

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

      • ListId — (String)

        The ID of the AWS Firewall Manager applications list.

      • ListNamerequired — (String)

        The name of the AWS Firewall Manager applications list.

      • ListUpdateToken — (String)

        A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

      • CreateTime — (Date)

        The time that the AWS Firewall Manager applications list was created.

      • LastUpdateTime — (Date)

        The time that the AWS Firewall Manager applications list was last updated.

      • AppsListrequired — (Array<map>)

        An array of applications in the AWS Firewall Manager applications list.

        • AppNamerequired — (String)

          The application's name.

        • Protocolrequired — (String)

          The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

        • Portrequired — (Integer)

          The application's port number, for example 80.

      • PreviousAppsList — (map<Array<map>>)

        A map of previous version numbers to their corresponding App object arrays.

        • AppNamerequired — (String)

          The application's name.

        • Protocolrequired — (String)

          The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

        • Portrequired — (Integer)

          The application's port number, for example 80.

    • TagList — (Array<map>)

      The tags associated with the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AppsList — (map)

        The details of the AWS Firewall Manager applications list.

        • ListId — (String)

          The ID of the AWS Firewall Manager applications list.

        • ListNamerequired — (String)

          The name of the AWS Firewall Manager applications list.

        • ListUpdateToken — (String)

          A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

        • CreateTime — (Date)

          The time that the AWS Firewall Manager applications list was created.

        • LastUpdateTime — (Date)

          The time that the AWS Firewall Manager applications list was last updated.

        • AppsListrequired — (Array<map>)

          An array of applications in the AWS Firewall Manager applications list.

          • AppNamerequired — (String)

            The application's name.

          • Protocolrequired — (String)

            The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

          • Portrequired — (Integer)

            The application's port number, for example 80.

        • PreviousAppsList — (map<Array<map>>)

          A map of previous version numbers to their corresponding App object arrays.

          • AppNamerequired — (String)

            The application's name.

          • Protocolrequired — (String)

            The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.

          • Portrequired — (Integer)

            The application's port number, for example 80.

      • AppsListArn — (String)

        The Amazon Resource Name (ARN) of the applications list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putNotificationChannel(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putNotificationChannel operation

var params = {
  SnsRoleName: 'STRING_VALUE', /* required */
  SnsTopicArn: 'STRING_VALUE' /* required */
};
fms.putNotificationChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SnsTopicArn — (String)

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

    • SnsRoleName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the putPolicy operation

var params = {
  Policy: { /* required */
    ExcludeResourceTags: true || false, /* required */
    PolicyName: 'STRING_VALUE', /* required */
    RemediationEnabled: true || false, /* required */
    ResourceType: 'STRING_VALUE', /* required */
    SecurityServicePolicyData: { /* required */
      Type: WAF | WAFV2 | SHIELD_ADVANCED | SECURITY_GROUPS_COMMON | SECURITY_GROUPS_CONTENT_AUDIT | SECURITY_GROUPS_USAGE_AUDIT | NETWORK_FIREWALL, /* required */
      ManagedServiceData: 'STRING_VALUE'
    },
    ExcludeMap: {
      '<CustomerPolicyScopeIdType>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<CustomerPolicyScopeIdType>': ... */
    },
    IncludeMap: {
      '<CustomerPolicyScopeIdType>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<CustomerPolicyScopeIdType>': ... */
    },
    PolicyId: 'STRING_VALUE',
    PolicyUpdateToken: 'STRING_VALUE',
    ResourceTags: [
      {
        Key: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    ResourceTypeList: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  TagList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fms.putPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Policy — (map)

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

      • PolicyId — (String)

        The ID of the AWS Firewall Manager policy.

      • PolicyNamerequired — (String)

        The name of the AWS Firewall Manager policy.

      • PolicyUpdateToken — (String)

        A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

      • SecurityServicePolicyDatarequired — (map)

        Details about the security service that is being used to protect the resources.

        • Typerequired — (String)

          The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting AWS Support.

          Possible values include:
          • "WAF"
          • "WAFV2"
          • "SHIELD_ADVANCED"
          • "SECURITY_GROUPS_COMMON"
          • "SECURITY_GROUPS_CONTENT_AUDIT"
          • "SECURITY_GROUPS_USAGE_AUDIT"
          • "NETWORK_FIREWALL"
        • ManagedServiceData — (String)

          Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED, this is an empty string.

          • Example: NETWORK_FIREWALL

            "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\",\"priority\":10}],\"networkFirewallStatelessDefaultActions\":[\"aws:pass\",\"custom1\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"custom2\",\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"custom1\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension1\"}]}}},{\"actionName\":\"custom2\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension2\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":true,\"allowedIPV4CidrList\":[\"10.24.34.0/28\"]} }"

          • Example: WAFV2

            "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"

            In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and the RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD.

          • Example: WAF Classic

            "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"

          • Example: SECURITY_GROUPS_COMMON

            "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"

          • Example: SECURITY_GROUPS_CONTENT_AUDIT

            "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"

            The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.

          • Example: SECURITY_GROUPS_USAGE_AUDIT

            "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"

      • ResourceTyperequired — (String)

        The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an AWS Network Firewall policy, the value is AWS::EC2::VPC.

      • ResourceTypeList — (Array<String>)

        An array of ResourceType.

      • ResourceTags — (Array<map>)

        An array of ResourceTag objects.

        • Keyrequired — (String)

          The resource tag key.

        • Value — (String)

          The resource tag value.

      • ExcludeResourceTagsrequired — (Boolean)

        If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

      • RemediationEnabledrequired — (Boolean)

        Indicates if the policy should be automatically applied to new resources.

      • IncludeMap — (map<Array<String>>)

        Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

        You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

        You can specify account IDs, OUs, or a combination:

        • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

        • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

        • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

      • ExcludeMap — (map<Array<String>>)

        Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

        You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

        You can specify account IDs, OUs, or a combination:

        • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

        • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

        • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

    • TagList — (Array<map>)

      The tags to add to the AWS resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (map)

        The details of the AWS Firewall Manager policy.

        • PolicyId — (String)

          The ID of the AWS Firewall Manager policy.

        • PolicyNamerequired — (String)

          The name of the AWS Firewall Manager policy.

        • PolicyUpdateToken — (String)

          A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

        • SecurityServicePolicyDatarequired — (map)

          Details about the security service that is being used to protect the resources.

          • Typerequired — (String)

            The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting AWS Support.

            Possible values include:
            • "WAF"
            • "WAFV2"
            • "SHIELD_ADVANCED"
            • "SECURITY_GROUPS_COMMON"
            • "SECURITY_GROUPS_CONTENT_AUDIT"
            • "SECURITY_GROUPS_USAGE_AUDIT"
            • "NETWORK_FIREWALL"
          • ManagedServiceData — (String)

            Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED, this is an empty string.

            • Example: NETWORK_FIREWALL

              "{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2\",\"priority\":10}],\"networkFirewallStatelessDefaultActions\":[\"aws:pass\",\"custom1\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"custom2\",\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"custom1\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension1\"}]}}},{\"actionName\":\"custom2\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"dimension2\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-1:1234567891011:stateful-rulegroup/rulegroup1\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":true,\"allowedIPV4CidrList\":[\"10.24.34.0/28\"]} }"

            • Example: WAFV2

              "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"

              In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and the RedactedFieldType must be one of URI, QUERY_STRING, HEADER, or METHOD.

            • Example: WAF Classic

              "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"

            • Example: SECURITY_GROUPS_COMMON

              "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"

            • Example: SECURITY_GROUPS_CONTENT_AUDIT

              "{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"

              The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.

            • Example: SECURITY_GROUPS_USAGE_AUDIT

              "{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"

        • ResourceTyperequired — (String)

          The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an AWS Network Firewall policy, the value is AWS::EC2::VPC.

        • ResourceTypeList — (Array<String>)

          An array of ResourceType.

        • ResourceTags — (Array<map>)

          An array of ResourceTag objects.

          • Keyrequired — (String)

            The resource tag key.

          • Value — (String)

            The resource tag value.

        • ExcludeResourceTagsrequired — (Boolean)

          If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

        • RemediationEnabledrequired — (Boolean)

          Indicates if the policy should be automatically applied to new resources.

        • IncludeMap — (map<Array<String>>)

          Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

          You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

          You can specify account IDs, OUs, or a combination:

          • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

          • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

          • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

        • ExcludeMap — (map<Array<String>>)

          Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.

          You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager applies the policy to all accounts except for those specified by the ExcludeMap.

          You can specify account IDs, OUs, or a combination:

          • Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.

          • Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: {“ORG_UNIT” : [“ouid111”, “ouid112”]}.

          • Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.

      • PolicyArn — (String)

        The Amazon Resource Name (ARN) of the policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putProtocolsList(params = {}, callback) ⇒ AWS.Request

Creates an AWS Firewall Manager protocols list.

Service Reference:

Examples:

Calling the putProtocolsList operation

var params = {
  ProtocolsList: { /* required */
    ListName: 'STRING_VALUE', /* required */
    ProtocolsList: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    CreateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    LastUpdateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ListId: 'STRING_VALUE',
    ListUpdateToken: 'STRING_VALUE',
    PreviousProtocolsList: {
      '<PreviousListVersion>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<PreviousListVersion>': ... */
    }
  },
  TagList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fms.putProtocolsList(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProtocolsList — (map)

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

      • ListId — (String)

        The ID of the AWS Firewall Manager protocols list.

      • ListNamerequired — (String)

        The name of the AWS Firewall Manager protocols list.

      • ListUpdateToken — (String)

        A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

      • CreateTime — (Date)

        The time that the AWS Firewall Manager protocols list was created.

      • LastUpdateTime — (Date)

        The time that the AWS Firewall Manager protocols list was last updated.

      • ProtocolsListrequired — (Array<String>)

        An array of protocols in the AWS Firewall Manager protocols list.

      • PreviousProtocolsList — (map<Array<String>>)

        A map of previous version numbers to their corresponding protocol arrays.

    • TagList — (Array<map>)

      The tags associated with the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProtocolsList — (map)

        The details of the AWS Firewall Manager protocols list.

        • ListId — (String)

          The ID of the AWS Firewall Manager protocols list.

        • ListNamerequired — (String)

          The name of the AWS Firewall Manager protocols list.

        • ListUpdateToken — (String)

          A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.

        • CreateTime — (Date)

          The time that the AWS Firewall Manager protocols list was created.

        • LastUpdateTime — (Date)

          The time that the AWS Firewall Manager protocols list was last updated.

        • ProtocolsListrequired — (Array<String>)

          An array of protocols in the AWS Firewall Manager protocols list.

        • PreviousProtocolsList — (map<Array<String>>)

          A map of previous version numbers to their corresponding protocol arrays.

      • ProtocolsListArn — (String)

        The Amazon Resource Name (ARN) of the protocols list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds one or more tags to an AWS resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagList: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fms.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (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.

    • TagList — (Array<map>)

      The tags to add to the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from an AWS resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
fms.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (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.

    • TagKeys — (Array<String>)

      The keys of the tags to remove from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.