2019/03/25 - Firewall Management Service - 1 new 4 updated api methods
Changes AWS Firewall Manager now allows customer to centrally enable AWS Shield Advanced DDoS protection for their entire AWS infrastructure, across accounts and applications.
If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack.
See also: AWS API Documentation
Request Syntax
client.get_protection_status(
PolicyId='string',
MemberAccountId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the policy for which you want to get the attack information.
string
The AWS account that is in scope of the policy that you want to get the details for.
datetime
The start of the time period to query for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
datetime
The end of the time period to query for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
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 that allows you to list 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.
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.
dict
Response Syntax
{
'AdminAccountId': 'string',
'ServiceType': 'WAF'|'SHIELD_ADVANCED',
'Data': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
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 .
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. An example is shown in the Examples section below.
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.
{'PolicyComplianceDetail': {'Violators': {'ViolationReason': ['RESOURCE_MISSING_SHIELD_PROTECTION']}}}
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'|'RESOURCE_MISSING_SHIELD_PROTECTION',
'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 . For example: 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 received that indicates the problem with the service.
(string) --
(string) --
{'Policy': {'ResourceTypeList': ['string'],
'SecurityServicePolicyData': {'Type': ['SHIELD_ADVANCED']}}}
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'|'SHIELD_ADVANCED',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTypeList': [
'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 specifies the type of policy that is created, either a WAF policy or Shield Advanced policy.
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\"}}
If this is a Shield Advanced policy, this string will be empty.
ResourceType (string) --
The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference . For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
ResourceTypeList (list) --
An array of ResourceType .
(string) --
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 organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are 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 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.
{'PolicyList': {'SecurityServiceType': ['SHIELD_ADVANCED']}}
Returns an array of PolicySummary objects in the response.
See also: AWS API Documentation
Request Syntax
client.list_policies(
NextToken='string',
MaxResults=123
)
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.
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.
dict
Response Syntax
{
'PolicyList': [
{
'PolicyArn': 'string',
'PolicyId': 'string',
'PolicyName': 'string',
'ResourceType': 'string',
'SecurityServiceType': 'WAF'|'SHIELD_ADVANCED',
'RemediationEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PolicyList (list) --
An array of PolicySummary objects.
(dict) --
Details of the AWS Firewall Manager policy.
PolicyArn (string) --
The Amazon Resource Name (ARN) of the specified policy.
PolicyId (string) --
The ID of the specified policy.
PolicyName (string) --
The friendly name of the specified policy.
ResourceType (string) --
The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference . For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
SecurityServiceType (string) --
The service that the policy is using to protect the resources. This specifies the type of policy that is created, either a WAF policy or Shield Advanced policy.
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.
{'Policy': {'ResourceTypeList': ['string'],
'SecurityServicePolicyData': {'Type': ['SHIELD_ADVANCED']}}}
Creates an AWS Firewall Manager policy.
Firewall Manager provides two types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources, or a WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. A policy is specific to either WAF or Shield Advanced. If you want to enforce both WAF rules and Shield Advanced protection across accounts, you can create multiple policies. You can create one or more policies for WAF rules, and one or more policies for Shield Advanced.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information on subscribing to Shield Advanced, see CreateSubscription .
See also: AWS API Documentation
Request Syntax
client.put_policy(
Policy={
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF'|'SHIELD_ADVANCED',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTypeList': [
'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 specifies the type of policy that is created, either a WAF policy or Shield Advanced policy.
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\"}}
If this is a Shield Advanced policy, this string will be empty.
ResourceType (string) -- [REQUIRED]
The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference . For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
ResourceTypeList (list) --
An array of ResourceType .
(string) --
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 organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are 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 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'|'SHIELD_ADVANCED',
'ManagedServiceData': 'string'
},
'ResourceType': 'string',
'ResourceTypeList': [
'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 specifies the type of policy that is created, either a WAF policy or Shield Advanced policy.
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\"}}
If this is a Shield Advanced policy, this string will be empty.
ResourceType (string) --
The type of resource to protect with the policy. This is in the format shown in AWS Resource Types Reference . For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .
ResourceTypeList (list) --
An array of ResourceType .
(string) --
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 organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are 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 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.