@datafire/amazonaws_fms v5.0.0

@datafire/amazonaws_fms

Client library for Firewall Management Service

Installation and Usage

npm install --save @datafire/amazonaws_fms

let amazonaws_fms = require('@datafire/amazonaws_fms').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_fms.AssociateAdminAccount({
  "AdminAccount": ""
}).then(data => {
  console.log(data);
});

Description

AWS Firewall Manager 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.

Actions

AssociateAdminAccount

amazonaws_fms.AssociateAdminAccount({
  "AdminAccount": ""
}, context)

Input

• input object
  • AdminAccount required AWSAccountId

Output

Output schema unknown

DeleteNotificationChannel

amazonaws_fms.DeleteNotificationChannel({}, context)

Input

• input object

Output

Output schema unknown

DeletePolicy

amazonaws_fms.DeletePolicy({
  "PolicyId": ""
}, context)

Input

• input object
  • PolicyId required PolicyId

Output

Output schema unknown

DisassociateAdminAccount

amazonaws_fms.DisassociateAdminAccount({}, context)

Input

• input object

Output

Output schema unknown

GetAdminAccount

amazonaws_fms.GetAdminAccount({}, context)

Input

• input object

Output

• output GetAdminAccountResponse

GetComplianceDetail

amazonaws_fms.GetComplianceDetail({
  "PolicyId": "",
  "MemberAccount": ""
}, context)

Input

• input object
  • MemberAccount required AWSAccountId
  • PolicyId required PolicyId

Output

• output GetComplianceDetailResponse

GetNotificationChannel

amazonaws_fms.GetNotificationChannel({}, context)

Input

• input object

Output

• output GetNotificationChannelResponse

GetPolicy

amazonaws_fms.GetPolicy({
  "PolicyId": ""
}, context)

Input

• input object
  • PolicyId required PolicyId

Output

• output GetPolicyResponse

ListComplianceStatus

amazonaws_fms.ListComplianceStatus({
  "PolicyId": ""
}, context)

Input

• input object
  • MaxResults PaginationMaxResults
  • NextToken PaginationToken
  • PolicyId required PolicyId

Output

• output ListComplianceStatusResponse

ListPolicies

amazonaws_fms.ListPolicies({}, context)

Input

• input object
  • MaxResults PaginationMaxResults
  • NextToken PaginationToken

Output

• output ListPoliciesResponse

PutNotificationChannel

amazonaws_fms.PutNotificationChannel({
  "SnsTopicArn": "",
  "SnsRoleName": ""
}, context)

Input

• input object
  • SnsRoleName required ResourceArn
  • SnsTopicArn required ResourceArn

Output

Output schema unknown

PutPolicy

amazonaws_fms.PutPolicy({
  "Policy": {
    "PolicyName": "",
    "SecurityServicePolicyData": {
      "Type": ""
    },
    "ResourceType": "",
    "ExcludeResourceTags": true,
    "RemediationEnabled": true
  }
}, context)

Input

• input object
  • Policy required Policy

Output

• output PutPolicyResponse

Definitions

AWSAccountId

• AWSAccountId string

AssociateAdminAccountRequest

• AssociateAdminAccountRequest object
  • AdminAccount required AWSAccountId

Boolean

• Boolean boolean

ComplianceViolator

• ComplianceViolator object: Details of the resource that is not protected by the policy.
  • ResourceId ResourceId
  • ResourceType ResourceType
  • ViolationReason ViolationReason

ComplianceViolators

• ComplianceViolators array
  • items ComplianceViolator

DeleteNotificationChannelRequest

• DeleteNotificationChannelRequest object

DeletePolicyRequest

• DeletePolicyRequest object
  • PolicyId required PolicyId

DisassociateAdminAccountRequest

• DisassociateAdminAccountRequest object

ErrorMessage

• ErrorMessage string

EvaluationResult

• EvaluationResult object: Describes the compliance status for the account. An account is considered non-compliant if it includes resources that are not protected by the specified policy.
  • ComplianceStatus PolicyComplianceStatusType
  • EvaluationLimitExceeded Boolean
  • ViolatorCount ResourceCount

EvaluationResults

• EvaluationResults array
  • items EvaluationResult

GetAdminAccountRequest

• GetAdminAccountRequest object

GetAdminAccountResponse

• GetAdminAccountResponse object
  • AdminAccount AWSAccountId

GetComplianceDetailRequest

• GetComplianceDetailRequest object
  • MemberAccount required AWSAccountId
  • PolicyId required PolicyId

GetComplianceDetailResponse

• GetComplianceDetailResponse object
  • PolicyComplianceDetail PolicyComplianceDetail

GetNotificationChannelRequest

• GetNotificationChannelRequest object

GetNotificationChannelResponse

• GetNotificationChannelResponse object
  • SnsRoleName ResourceArn
  • SnsTopicArn ResourceArn

GetPolicyRequest

• GetPolicyRequest object
  • PolicyId required PolicyId

GetPolicyResponse

• GetPolicyResponse object
  • Policy Policy
  • PolicyArn ResourceArn

InternalErrorException

• InternalErrorException object: The operation failed because of a system problem, even though the request was valid. Retry your request.
  • Message ErrorMessage

InvalidInputException

• InvalidInputException object: The parameters of the request were invalid.
  • Message ErrorMessage

InvalidOperationException

• InvalidOperationException object: The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.
  • Message ErrorMessage

LimitExceededException

• LimitExceededException object: The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.
  • Message ErrorMessage

ListComplianceStatusRequest

• ListComplianceStatusRequest object
  • MaxResults PaginationMaxResults
  • NextToken PaginationToken
  • PolicyId required PolicyId

ListComplianceStatusResponse

• ListComplianceStatusResponse object
  • NextToken PaginationToken
  • PolicyComplianceStatusList PolicyComplianceStatusList

ListPoliciesRequest

• ListPoliciesRequest object
  • MaxResults PaginationMaxResults
  • NextToken PaginationToken

ListPoliciesResponse

• ListPoliciesResponse object
  • NextToken PaginationToken
  • PolicyList PolicySummaryList

ManagedServiceData

• ManagedServiceData string

PaginationMaxResults

• PaginationMaxResults integer

PaginationToken

• PaginationToken string

Policy

• Policy object: An AWS Firewall Manager policy.
  • ExcludeResourceTags required Boolean
  • PolicyId PolicyId
  • PolicyName required ResourceName
  • PolicyUpdateToken PolicyUpdateToken
  • RemediationEnabled required Boolean
  • ResourceTags ResourceTags
  • ResourceType required ResourceType
  • SecurityServicePolicyData required SecurityServicePolicyData

PolicyComplianceDetail

• PolicyComplianceDetail object: Describes the non-compliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are non-compliant, EvaluationLimitExceeded is set to True.
  • EvaluationLimitExceeded Boolean
  • ExpiredAt TimeStamp
  • MemberAccount AWSAccountId
  • PolicyId PolicyId
  • PolicyOwner AWSAccountId
  • Violators ComplianceViolators

PolicyComplianceStatus

• PolicyComplianceStatus object: Indicates whether the account is compliant with the specified policy. An account is considered non-compliant if it includes resources that are not protected by the policy.
  • EvaluationResults EvaluationResults
  • LastUpdated TimeStamp
  • MemberAccount AWSAccountId
  • PolicyId PolicyId
  • PolicyName ResourceName
  • PolicyOwner AWSAccountId

PolicyComplianceStatusList

• PolicyComplianceStatusList array
  • items PolicyComplianceStatus

PolicyComplianceStatusType

• PolicyComplianceStatusType string (values: COMPLIANT, NON_COMPLIANT)

PolicyId

• PolicyId string

PolicySummary

• PolicySummary object: Details of the AWS Firewall Manager policy.
  • PolicyArn ResourceArn
  • PolicyId PolicyId
  • PolicyName ResourceName
  • RemediationEnabled Boolean
  • ResourceType ResourceType
  • SecurityServiceType SecurityServiceType

PolicySummaryList

• PolicySummaryList array
  • items PolicySummary

PolicyUpdateToken

• PolicyUpdateToken string

PutNotificationChannelRequest

• PutNotificationChannelRequest object
  • SnsRoleName required ResourceArn
  • SnsTopicArn required ResourceArn

PutPolicyRequest

• PutPolicyRequest object
  • Policy required Policy

PutPolicyResponse

• PutPolicyResponse object
  • Policy Policy
  • PolicyArn ResourceArn

ResourceArn

• ResourceArn string

ResourceCount

• ResourceCount integer

ResourceId

• ResourceId string

ResourceName

• ResourceName string

ResourceNotFoundException

• ResourceNotFoundException object: The specified resource was not found.
  • Message ErrorMessage

ResourceTag

• ResourceTag object: The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from protection by the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. Tags are combined with an "OR." That is, if you add more than one tag, if any of the tags matches, the resource is considered a match for the include or exclude. Working with Tag Editor.
  • Key required TagKey
  • Value TagValue

ResourceTags

• ResourceTags array
  • items ResourceTag

ResourceType

• ResourceType string

SecurityServicePolicyData

• SecurityServicePolicyData object: Details about the security service that is being used to protect the resources.
  • ManagedServiceData ManagedServiceData
  • Type required SecurityServiceType

SecurityServiceType

• SecurityServiceType string (values: WAF)

TagKey

• TagKey string

TagValue

• TagValue string

TimeStamp

• TimeStamp string

ViolationReason

• ViolationReason string (values: WEB_ACL_MISSING_RULE_GROUP, RESOURCE_MISSING_WEB_ACL, RESOURCE_INCORRECT_WEB_ACL)