2018/09/12 - Firewall Management Service - 1 new 5 updated api methods
Changes This update of Amazon Fire Wall Manager adds the ability to scope down the policy as well as to get all the member accounts belonging to a certain Fire Wall Manager admin account.
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.
See also: AWS API Documentation
Request Syntax
client.list_member_accounts(
NextToken='string',
MaxResults=123
)
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.
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. The maximum value for MaxResults is 100.
dict
Response Syntax
{
'MemberAccounts': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
MemberAccounts (list) --
An array of account IDs.
(string) --
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.
{'RoleStatus': 'READY | CREATING | PENDING_DELETION | DELETING | DELETED'}
Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.
See also: AWS API Documentation
Request Syntax
client.get_admin_account()
dict
Response Syntax
{
'AdminAccount': 'string',
'RoleStatus': 'READY'|'CREATING'|'PENDING_DELETION'|'DELETING'|'DELETED'
}
Response Structure
(dict) --
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.
{'PolicyComplianceDetail': {'IssueInfoMap': {'AWSCONFIG | AWSWAF': 'string'}}}
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 non-compliant if the specified policy has not been applied to them.
See also: AWS API Documentation
Request Syntax
client.get_compliance_detail(
PolicyId='string',
MemberAccount='string'
)
string
[REQUIRED]
The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies .
string
[REQUIRED]
The AWS account that owns the resources that you want to get the details for.
dict
Response Syntax
{
'PolicyComplianceDetail': {
'PolicyOwner': 'string',
'PolicyId': 'string',
'MemberAccount': 'string',
'Violators': [
{
'ResourceId': 'string',
'ViolationReason': 'WEB_ACL_MISSING_RULE_GROUP'|'RESOURCE_MISSING_WEB_ACL'|'RESOURCE_INCORRECT_WEB_ACL',
'ResourceType': 'string'
},
],
'EvaluationLimitExceeded': True|False,
'ExpiredAt': datetime(2015, 1, 1),
'IssueInfoMap': {
'string': 'string'
}
}
}
Response Structure
(dict) --
PolicyComplianceDetail (dict) --
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 (list) --
An array of resources that are not protected by the policy.
(dict) --
Details of the resource that is not protected by the policy.
ResourceId (string) --
The resource ID.
ViolationReason (string) --
The reason that the resource is not protected by the policy.
ResourceType (string) --
The resource type. This is in the format shown in AWS Resource Types Reference. Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
EvaluationLimitExceeded (boolean) --
Indicates if over 100 resources are non-compliant with the AWS Firewall Manager policy.
ExpiredAt (datetime) --
A time stamp that indicates when the returned information should be considered out-of-date.
IssueInfoMap (dict) --
Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message recieved indicating the problem with the service.
(string) --
(string) --
{'Policy': {'ExcludeMap': {'ACCOUNT': ['string']},
'IncludeMap': {'ACCOUNT': ['string']}}}
Returns information about the specified AWS Firewall Manager policy.
See also: AWS API Documentation
Request Syntax
client.get_policy(
PolicyId='string'
)
string
[REQUIRED]
The ID of the AWS Firewall Manager policy that you want the details for.
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
'PolicyArn': 'string'
}
Response Structure
(dict) --
Policy (dict) --
Information about the specified AWS Firewall Manager policy.
PolicyId (string) --
The ID of the AWS Firewall Manager policy.
PolicyName (string) --
The friendly 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.
SecurityServicePolicyData (dict) --
Details about the security service that is being used to protect the resources.
Type (string) --
The service that the policy is using to protect the resources. This value is WAF .
ManagedServiceData (string) --
Details about the service. This contains WAF data in JSON format, as shown in the following example:
ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}
ResourceType (string) --
The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution. This is in the format shown in AWS Resource Types Reference. Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
ResourceTags (list) --
An array of ResourceTag objects.
(dict) --
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 (string) --
The resource tag key.
Value (string) --
The resource tag value.
ExcludeResourceTags (boolean) --
If set to True , resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False , and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
RemediationEnabled (boolean) --
Indicates if the policy should be automatically applied to new resources.
IncludeMap (dict) --
Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the AWS Organization are included in the policy. If IncludeMap is not null, only values listed in IncludeMap will be included in the policy.
The key to the map is ACCOUNT . For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]} .
(string) --
(list) --
(string) --
ExcludeMap (dict) --
Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all of the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
The key to the map is ACCOUNT . For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]} .
(string) --
(list) --
(string) --
PolicyArn (string) --
The Amazon Resource Name (ARN) of the specified policy.
{'PolicyComplianceStatusList': {'IssueInfoMap': {'AWSCONFIG | AWSWAF': 'string'}}}
Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
See also: AWS API Documentation
Request Syntax
client.list_compliance_status(
PolicyId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the AWS Firewall Manager policy that you want the details for.
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.
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.
dict
Response Syntax
{
'PolicyComplianceStatusList': [
{
'PolicyOwner': 'string',
'PolicyId': 'string',
'PolicyName': 'string',
'MemberAccount': 'string',
'EvaluationResults': [
{
'ComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT',
'ViolatorCount': 123,
'EvaluationLimitExceeded': True|False
},
],
'LastUpdated': datetime(2015, 1, 1),
'IssueInfoMap': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PolicyComplianceStatusList (list) --
An array of PolicyComplianceStatus objects.
(dict) --
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.
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 friendly name of the AWS Firewall Manager policy.
MemberAccount (string) --
The member account ID.
EvaluationResults (list) --
An array of EvaluationResult objects.
(dict) --
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 (string) --
Describes an AWS account's compliance with the AWS Firewall Manager policy.
ViolatorCount (integer) --
Number of resources that are non-compliant with the specified policy. A resource is considered non-compliant if it is not associated with the specified policy.
EvaluationLimitExceeded (boolean) --
Indicates that over 100 resources are non-compliant with the AWS Firewall Manager policy.
LastUpdated (datetime) --
Time stamp of the last update to the EvaluationResult objects.
IssueInfoMap (dict) --
Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be non-compliant. The details include the name of the dependent service and the error message recieved indicating the problem with the service.
(string) --
(string) --
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.
{'Policy': {'ExcludeMap': {'ACCOUNT': ['string']},
'IncludeMap': {'ACCOUNT': ['string']}}}
Creates an AWS Firewall Manager policy.
See also: AWS API Documentation
Request Syntax
client.put_policy(
Policy={
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
}
)
dict
[REQUIRED]
The details of the AWS Firewall Manager policy to be created.
PolicyId (string) --
The ID of the AWS Firewall Manager policy.
PolicyName (string) -- [REQUIRED]
The friendly 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.
SecurityServicePolicyData (dict) -- [REQUIRED]
Details about the security service that is being used to protect the resources.
Type (string) -- [REQUIRED]
The service that the policy is using to protect the resources. This value is WAF .
ManagedServiceData (string) --
Details about the service. This contains WAF data in JSON format, as shown in the following example:
ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}
ResourceType (string) -- [REQUIRED]
The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution. This is in the format shown in AWS Resource Types Reference. Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
ResourceTags (list) --
An array of ResourceTag objects.
(dict) --
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 (string) -- [REQUIRED]
The resource tag key.
Value (string) --
The resource tag value.
ExcludeResourceTags (boolean) -- [REQUIRED]
If set to True , resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False , and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
RemediationEnabled (boolean) -- [REQUIRED]
Indicates if the policy should be automatically applied to new resources.
IncludeMap (dict) --
Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the AWS Organization are included in the policy. If IncludeMap is not null, only values listed in IncludeMap will be included in the policy.
The key to the map is ACCOUNT . For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]} .
(string) --
(list) --
(string) --
ExcludeMap (dict) --
Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all of the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
The key to the map is ACCOUNT . For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]} .
(string) --
(list) --
(string) --
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
'PolicyArn': 'string'
}
Response Structure
(dict) --
Policy (dict) --
The details of the AWS Firewall Manager policy that was created.
PolicyId (string) --
The ID of the AWS Firewall Manager policy.
PolicyName (string) --
The friendly 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.
SecurityServicePolicyData (dict) --
Details about the security service that is being used to protect the resources.
Type (string) --
The service that the policy is using to protect the resources. This value is WAF .
ManagedServiceData (string) --
Details about the service. This contains WAF data in JSON format, as shown in the following example:
ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}
ResourceType (string) --
The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution. This is in the format shown in AWS Resource Types Reference. Valid values are AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
ResourceTags (list) --
An array of ResourceTag objects.
(dict) --
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 (string) --
The resource tag key.
Value (string) --
The resource tag value.
ExcludeResourceTags (boolean) --
If set to True , resources with the tags that are specified in the ResourceTag array are not protected by the policy. If set to False , and the ResourceTag array is not null, only resources with the specified tags are associated with the policy.
RemediationEnabled (boolean) --
Indicates if the policy should be automatically applied to new resources.
IncludeMap (dict) --
Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the AWS Organization are included in the policy. If IncludeMap is not null, only values listed in IncludeMap will be included in the policy.
The key to the map is ACCOUNT . For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]} .
(string) --
(list) --
(string) --
ExcludeMap (dict) --
Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all of the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.
The key to the map is ACCOUNT . For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]} .
(string) --
(list) --
(string) --
PolicyArn (string) --
The Amazon Resource Name (ARN) of the policy that was created.