This is the AWS Firewall Manager API Reference. This guide is for\n developers who need detailed information about the AWS Firewall Manager API actions, data\n types, and errors. For detailed information about AWS Firewall Manager features, see the\n AWS Firewall Manager Developer Guide.
\nSome API actions require explicit resource permissions. For information, see the developer guide topic \n Firewall Manager required permissions for API actions.\n
", "smithy.api#title": "Firewall Management Service" } }, "com.amazonaws.fms#AccountRoleStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "READY", "name": "Ready" }, { "value": "CREATING", "name": "Creating" }, { "value": "PENDING_DELETION", "name": "PendingDeletion" }, { "value": "DELETING", "name": "Deleting" }, { "value": "DELETED", "name": "Deleted" } ] } }, "com.amazonaws.fms#App": { "type": "structure", "members": { "AppName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The application's name.
", "smithy.api#required": {} } }, "Protocol": { "target": "com.amazonaws.fms#Protocol", "traits": { "smithy.api#documentation": "The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.
The application's port number, for example 80.
An individual AWS Firewall Manager application.
" } }, "com.amazonaws.fms#AppsList": { "type": "list", "member": { "target": "com.amazonaws.fms#App" } }, "com.amazonaws.fms#AppsListData": { "type": "structure", "members": { "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager applications list.
" } }, "ListName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The name of the AWS Firewall Manager applications list.
", "smithy.api#required": {} } }, "ListUpdateToken": { "target": "com.amazonaws.fms#UpdateToken", "traits": { "smithy.api#documentation": "A unique identifier for each update to the list. When you update \n the list, the update token must match the token of the current version of the application list. \n You can retrieve the update token by getting the list.
" } }, "CreateTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { "smithy.api#documentation": "The time that the AWS Firewall Manager applications list was created.
" } }, "LastUpdateTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { "smithy.api#documentation": "The time that the AWS Firewall Manager applications list was last updated.
" } }, "AppsList": { "target": "com.amazonaws.fms#AppsList", "traits": { "smithy.api#documentation": "An array of applications in the AWS Firewall Manager applications list.
", "smithy.api#required": {} } }, "PreviousAppsList": { "target": "com.amazonaws.fms#PreviousAppsList", "traits": { "smithy.api#documentation": "A map of previous version numbers to their corresponding App object arrays.
An AWS Firewall Manager applications list.
" } }, "com.amazonaws.fms#AppsListDataSummary": { "type": "structure", "members": { "ListArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the applications list.
" } }, "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the applications list.
" } }, "ListName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The name of the applications list.
" } }, "AppsList": { "target": "com.amazonaws.fms#AppsList", "traits": { "smithy.api#documentation": "An array of App objects in the AWS Firewall Manager applications list.
Details of the AWS Firewall Manager applications list.
" } }, "com.amazonaws.fms#AppsListsData": { "type": "list", "member": { "target": "com.amazonaws.fms#AppsListDataSummary" } }, "com.amazonaws.fms#AssociateAdminAccount": { "type": "operation", "input": { "target": "com.amazonaws.fms#AssociateAdminAccountRequest" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be\n associated with the master account of your AWS organization or associated with a member\n account that has the appropriate permissions. If the account ID that you submit is not an AWS\n Organizations master account, AWS Firewall Manager will set the appropriate permissions for\n the given member account.
\nThe account that you associate with AWS Firewall Manager is called the AWS Firewall\n Manager administrator account.
" } }, "com.amazonaws.fms#AssociateAdminAccountRequest": { "type": "structure", "members": { "AdminAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager\n administrator account. This can be an AWS Organizations master account or a member account.\n For more information about AWS Organizations and master accounts, see \n Managing the AWS Accounts in Your Organization.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#AwsEc2InstanceViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The resource ID of the EC2 instance.
" } }, "AwsEc2NetworkInterfaceViolations": { "target": "com.amazonaws.fms#AwsEc2NetworkInterfaceViolations", "traits": { "smithy.api#documentation": "Violations for network interfaces associated with the EC2 instance.
" } } }, "traits": { "smithy.api#documentation": "Violations for an EC2 instance resource.
" } }, "com.amazonaws.fms#AwsEc2NetworkInterfaceViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The resource ID of the network interface.
" } }, "ViolatingSecurityGroups": { "target": "com.amazonaws.fms#ResourceIdList", "traits": { "smithy.api#documentation": "List of security groups that violate the rules specified in the master security group of the AWS Firewall Manager policy.
" } } }, "traits": { "smithy.api#documentation": "Violations for network interfaces associated with an EC2 instance.
" } }, "com.amazonaws.fms#AwsEc2NetworkInterfaceViolations": { "type": "list", "member": { "target": "com.amazonaws.fms#AwsEc2NetworkInterfaceViolation" } }, "com.amazonaws.fms#AwsVPCSecurityGroupViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The security group rule that is being evaluated.
" } }, "ViolationTargetDescription": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "A description of the security group that violates the policy.
" } }, "PartialMatches": { "target": "com.amazonaws.fms#PartialMatches", "traits": { "smithy.api#documentation": "List of rules specified in the security group of the AWS Firewall Manager policy that partially match the ViolationTarget rule.
Remediation options for the rule specified in the ViolationTarget.
Details of the rule violation in a security group when compared to the master security group of the AWS Firewall Manager policy.
" } }, "com.amazonaws.fms#BasicInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": -2147483648, "max": 2147483647 } } }, "com.amazonaws.fms#Boolean": { "type": "boolean" }, "com.amazonaws.fms#CIDR": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "[a-f0-9:./]+" } }, "com.amazonaws.fms#ComplianceViolator": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID.
" } }, "ViolationReason": { "target": "com.amazonaws.fms#ViolationReason", "traits": { "smithy.api#documentation": "The reason that the resource is not protected by the policy.
" } }, "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { "smithy.api#documentation": "The resource type. This is in the format shown in the AWS Resource Types Reference. For example:\n AWS::ElasticLoadBalancingV2::LoadBalancer, \n AWS::CloudFront::Distribution, or\n AWS::NetworkFirewall::FirewallPolicy.
Details of the resource that is not protected by the policy.
" } }, "com.amazonaws.fms#ComplianceViolators": { "type": "list", "member": { "target": "com.amazonaws.fms#ComplianceViolator" } }, "com.amazonaws.fms#CustomerPolicyScopeId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#CustomerPolicyScopeIdList": { "type": "list", "member": { "target": "com.amazonaws.fms#CustomerPolicyScopeId" } }, "com.amazonaws.fms#CustomerPolicyScopeIdType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACCOUNT", "name": "ACCOUNT" }, { "value": "ORG_UNIT", "name": "ORG_UNIT" } ] } }, "com.amazonaws.fms#CustomerPolicyScopeMap": { "type": "map", "key": { "target": "com.amazonaws.fms#CustomerPolicyScopeIdType" }, "value": { "target": "com.amazonaws.fms#CustomerPolicyScopeIdList" } }, "com.amazonaws.fms#DeleteAppsList": { "type": "operation", "input": { "target": "com.amazonaws.fms#DeleteAppsListRequest" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Permanently deletes an AWS Firewall Manager applications list.
" } }, "com.amazonaws.fms#DeleteAppsListRequest": { "type": "structure", "members": { "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the applications list that you want to delete. You can retrieve this ID from \n PutAppsList, ListAppsLists, and GetAppsList.
Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple\n Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.
" } }, "com.amazonaws.fms#DeleteNotificationChannelRequest": { "type": "structure", "members": {} }, "com.amazonaws.fms#DeletePolicy": { "type": "operation", "input": { "target": "com.amazonaws.fms#DeletePolicyRequest" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#LimitExceededException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Permanently deletes an AWS Firewall Manager policy.
" } }, "com.amazonaws.fms#DeletePolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the policy that you want to delete. You can retrieve this ID from \n PutPolicy and ListPolicies.
If True, the request performs cleanup according to the policy type.
For AWS WAF and Shield Advanced policies, the cleanup does the following:
\nDeletes rule groups created by AWS Firewall Manager
\nRemoves web ACLs from in-scope resources
\nDeletes web ACLs that contain no rules or rule groups
\nFor security group policies, the cleanup does the following for each security group in\n the policy:
\nDisassociates the security group from in-scope resources
\nDeletes the security group if it was created through Firewall Manager and if it's\n no longer associated with any resources through another policy
\nAfter the cleanup, in-scope resources are no longer protected by web ACLs in this policy.\n Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you\n create and accounts that you associate with the policy. When creating the policy, if you\n specify that only resources in specific accounts or with specific tags are in scope of the\n policy, those accounts and resources are handled by the policy. All others are out of scope.\n If you don't specify tags or accounts, all resources are in scope.
" } } } }, "com.amazonaws.fms#DeleteProtocolsList": { "type": "operation", "input": { "target": "com.amazonaws.fms#DeleteProtocolsListRequest" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Permanently deletes an AWS Firewall Manager protocols list.
" } }, "com.amazonaws.fms#DeleteProtocolsListRequest": { "type": "structure", "members": { "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the protocols list that you want to delete. You can retrieve this ID from \n PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.
Disassociates the account that has been set as the AWS Firewall Manager administrator\n account. To set a different account as the administrator account, you must submit an\n AssociateAdminAccount request.
The ID of the VPC.
" } }, "ViolationTargetDescription": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "A description of the violation that specifies the rule group and VPC.
" } } }, "traits": { "smithy.api#documentation": "A DNS Firewall rule group that Firewall Manager \n tried to associate with a VPC is already associated with the VPC and can't be associated again.
" } }, "com.amazonaws.fms#DnsRuleGroupLimitExceededViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The ID of the VPC.
" } }, "ViolationTargetDescription": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "A description of the violation that specifies the rule group and VPC.
" } }, "NumberOfRuleGroupsAlreadyAssociated": { "target": "com.amazonaws.fms#BasicInteger", "traits": { "smithy.api#documentation": "The number of rule groups currently associated with the VPC.
" } } }, "traits": { "smithy.api#documentation": "The VPC that Firewall Manager was applying a DNS Fireall policy to reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed due to the limit.
" } }, "com.amazonaws.fms#DnsRuleGroupPriorities": { "type": "list", "member": { "target": "com.amazonaws.fms#DnsRuleGroupPriority" } }, "com.amazonaws.fms#DnsRuleGroupPriority": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 10000 } } }, "com.amazonaws.fms#DnsRuleGroupPriorityConflictViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The ID of the VPC.
" } }, "ViolationTargetDescription": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "A description of the violation that specifies the VPC and the rule group that's already associated with it.
" } }, "ConflictingPriority": { "target": "com.amazonaws.fms#DnsRuleGroupPriority", "traits": { "smithy.api#documentation": "The priority setting of the two conflicting rule groups.
" } }, "ConflictingPolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. \n This policy contains the rule group that's already associated with the VPC.
" } }, "UnavailablePriorities": { "target": "com.amazonaws.fms#DnsRuleGroupPriorities", "traits": { "smithy.api#documentation": "The priorities of rule groups that are already associated with the VPC. To retry your operation, \n choose priority settings that aren't in this list for the rule groups in your new DNS Firewall policy.
" } } }, "traits": { "smithy.api#documentation": "A rule group that Firewall Manager \n tried to associate with a VPC has the same priority as a rule group that's already associated.
" } }, "com.amazonaws.fms#ErrorMessage": { "type": "string" }, "com.amazonaws.fms#EvaluationResult": { "type": "structure", "members": { "ComplianceStatus": { "target": "com.amazonaws.fms#PolicyComplianceStatusType", "traits": { "smithy.api#documentation": "Describes an AWS account's compliance with the AWS Firewall Manager policy.
" } }, "ViolatorCount": { "target": "com.amazonaws.fms#ResourceCount", "traits": { "smithy.api#documentation": "The number of resources that are noncompliant with the specified policy. For AWS WAF and\n Shield Advanced policies, a resource is considered noncompliant if it is not associated with\n the policy. For security group policies, a resource is considered noncompliant if it doesn't\n comply with the rules of the policy and remediation is disabled or not possible.
" } }, "EvaluationLimitExceeded": { "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#documentation": "Indicates that over 100 resources are noncompliant with the AWS Firewall Manager\n policy.
" } } }, "traits": { "smithy.api#documentation": "Describes the compliance status for the account. An account is considered noncompliant if\n it includes resources that are not protected by the specified policy or that don't comply with\n the policy.
" } }, "com.amazonaws.fms#EvaluationResults": { "type": "list", "member": { "target": "com.amazonaws.fms#EvaluationResult" } }, "com.amazonaws.fms#GetAdminAccount": { "type": "operation", "input": { "target": "com.amazonaws.fms#GetAdminAccountRequest" }, "output": { "target": "com.amazonaws.fms#GetAdminAccountResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns the AWS Organizations master account that is associated with AWS Firewall Manager\n as the AWS Firewall Manager administrator.
" } }, "com.amazonaws.fms#GetAdminAccountRequest": { "type": "structure", "members": {} }, "com.amazonaws.fms#GetAdminAccountResponse": { "type": "structure", "members": { "AdminAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account that is set as the AWS Firewall Manager administrator.
" } }, "RoleStatus": { "target": "com.amazonaws.fms#AccountRoleStatus", "traits": { "smithy.api#documentation": "The status of the AWS account that you set as the AWS Firewall Manager\n administrator.
" } } } }, "com.amazonaws.fms#GetAppsList": { "type": "operation", "input": { "target": "com.amazonaws.fms#GetAppsListRequest" }, "output": { "target": "com.amazonaws.fms#GetAppsListResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns information about the specified AWS Firewall Manager applications list.
" } }, "com.amazonaws.fms#GetAppsListRequest": { "type": "structure", "members": { "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager applications list that you want the details for.
", "smithy.api#required": {} } }, "DefaultList": { "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the list to retrieve is a default list owned by AWS Firewall Manager.
" } } } }, "com.amazonaws.fms#GetAppsListResponse": { "type": "structure", "members": { "AppsList": { "target": "com.amazonaws.fms#AppsListData", "traits": { "smithy.api#documentation": "Information about the specified AWS Firewall Manager applications list.
" } }, "AppsListArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the applications list.
" } } } }, "com.amazonaws.fms#GetComplianceDetail": { "type": "operation", "input": { "target": "com.amazonaws.fms#GetComplianceDetailRequest" }, "output": { "target": "com.amazonaws.fms#GetComplianceDetailResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns detailed compliance information about the specified member account. Details\n include resources that are in and out of compliance with the specified policy. Resources are\n considered noncompliant for AWS WAF and Shield Advanced policies if the specified policy has\n not been applied to them. Resources are considered noncompliant for security group policies if\n they are in scope of the policy, they violate one or more of the policy rules, and remediation\n is disabled or not possible. Resources are considered noncompliant for Network Firewall policies\n if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, \n if a subnet created by the Firewall Manager doesn't have the expected route table, \n and for modifications to a firewall policy that violate the Firewall Manager policy's rules.
" } }, "com.amazonaws.fms#GetComplianceDetailRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the policy that you want to get the details for. PolicyId is\n returned by PutPolicy and by ListPolicies.
The AWS account that owns the resources that you want to get the details for.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#GetComplianceDetailResponse": { "type": "structure", "members": { "PolicyComplianceDetail": { "target": "com.amazonaws.fms#PolicyComplianceDetail", "traits": { "smithy.api#documentation": "Information about the resources and the policy that you specified in the\n GetComplianceDetail request.
Information\n about the Amazon Simple Notification Service (SNS) topic that is used to\n record AWS Firewall Manager SNS logs.
" } }, "com.amazonaws.fms#GetNotificationChannelRequest": { "type": "structure", "members": {} }, "com.amazonaws.fms#GetNotificationChannelResponse": { "type": "structure", "members": { "SnsTopicArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The SNS topic that records AWS Firewall Manager activity.
" } }, "SnsRoleName": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The IAM role that is used by AWS Firewall Manager to record activity to SNS.
" } } } }, "com.amazonaws.fms#GetPolicy": { "type": "operation", "input": { "target": "com.amazonaws.fms#GetPolicyRequest" }, "output": { "target": "com.amazonaws.fms#GetPolicyResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#InvalidTypeException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns information about the specified AWS Firewall Manager policy.
" } }, "com.amazonaws.fms#GetPolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager policy that you want the details for.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#GetPolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.fms#Policy", "traits": { "smithy.api#documentation": "Information about the specified AWS Firewall Manager policy.
" } }, "PolicyArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified policy.
" } } } }, "com.amazonaws.fms#GetProtectionStatus": { "type": "operation", "input": { "target": "com.amazonaws.fms#GetProtectionStatusRequest" }, "output": { "target": "com.amazonaws.fms#GetProtectionStatusResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "If you created a Shield Advanced policy, returns policy-level attack summary information\n in the event of a potential DDoS attack. Other policy types are currently unsupported.
" } }, "com.amazonaws.fms#GetProtectionStatusRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the policy for which you want to get the attack information.
", "smithy.api#required": {} } }, "MemberAccountId": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account that is in scope of the policy that you want to get the details\n for.
" } }, "StartTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { "smithy.api#documentation": "The start of the time period to query for the attacks. This is a timestamp type. The\n request syntax listing indicates a number type because the default used by AWS Firewall\n Manager is Unix time in seconds. However, any valid timestamp format is\n allowed.
The end of the time period to query for the attacks. This is a timestamp type. The\n request syntax listing indicates a number type because the default used by AWS Firewall\n Manager is Unix time in seconds. However, any valid timestamp format is\n allowed.
If you specify a value for MaxResults and you have more objects than the number that you specify \n for MaxResults, AWS Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of \n objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken \n from the previous response to get information about another batch of objects.
Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more \n objects than the number that you specify for MaxResults, the response includes a \n NextToken value that you can use to get another batch of objects.
The ID of the AWS Firewall administrator account for this policy.
" } }, "ServiceType": { "target": "com.amazonaws.fms#SecurityServiceType", "traits": { "smithy.api#documentation": "The service type that is protected by the policy. Currently, this is always\n SHIELD_ADVANCED.
Details about the attack, including the following:
\nAttack type
\nAccount ID
\nARN of the resource attacked
\nStart time of the attack
\nEnd time of the attack (ongoing attacks will not have an end time)
\nThe details are in JSON format.
" } }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { "smithy.api#documentation": "If you have more objects than the number that you specified for MaxResults in the request, \n the response includes a NextToken value. To list more objects, submit another \n GetProtectionStatus request, and specify the NextToken value from the response in the \n NextToken value in the next request.
AWS SDKs provide auto-pagination that identify NextToken in a response and\n make subsequent request calls automatically on your behalf. However, this feature is not\n supported by GetProtectionStatus. You must submit subsequent requests with\n NextToken using your own processes.
Returns information about the specified AWS Firewall Manager protocols list.
" } }, "com.amazonaws.fms#GetProtocolsListRequest": { "type": "structure", "members": { "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager protocols list that you want the details for.
", "smithy.api#required": {} } }, "DefaultList": { "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the list to retrieve is a default list owned by AWS Firewall Manager.
" } } } }, "com.amazonaws.fms#GetProtocolsListResponse": { "type": "structure", "members": { "ProtocolsList": { "target": "com.amazonaws.fms#ProtocolsListData", "traits": { "smithy.api#documentation": "Information about the specified AWS Firewall Manager protocols list.
" } }, "ProtocolsListArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified protocols list.
" } } } }, "com.amazonaws.fms#GetViolationDetails": { "type": "operation", "input": { "target": "com.amazonaws.fms#GetViolationDetailsRequest" }, "output": { "target": "com.amazonaws.fms#GetViolationDetailsResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
" } }, "com.amazonaws.fms#GetViolationDetailsRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.
", "smithy.api#required": {} } }, "MemberAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account ID that you want the details for.
", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The ID of the resource that has violations.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { "smithy.api#documentation": "The resource type. This is in the format shown in the AWS Resource Types Reference.\n Supported resource types are:\n AWS::EC2::Instance,\n AWS::EC2::NetworkInterface, \n AWS::EC2::SecurityGroup,\n AWS::NetworkFirewall::FirewallPolicy, and\n AWS::EC2::Subnet.\n
Violation detail for a resource.
" } } } }, "com.amazonaws.fms#IPPortNumber": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 65535 } } }, "com.amazonaws.fms#InternalErrorException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.fms#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The operation failed because of a system problem, even though the request was valid. Retry\n your request.
", "smithy.api#error": "client" } }, "com.amazonaws.fms#InvalidInputException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.fms#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The parameters of the request were invalid.
", "smithy.api#error": "client" } }, "com.amazonaws.fms#InvalidOperationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.fms#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have\n submitted an AssociateAdminAccount request for an account ID that \n was already set as the AWS Firewall Manager administrator. Or you might have tried to access a Region\n that's disabled by default, and that you need to enable for the Firewall Manager \n administrator account and for AWS Organizations before you can access it.
The value of the Type parameter is invalid.
The operation exceeds a resource limit, for example, the maximum number of\n policy objects that you can create for an AWS account. For more information,\n see Firewall\n Manager Limits in the AWS WAF Developer Guide.
Returns an array of AppsListDataSummary objects.
Specifies whether the lists to retrieve are default lists owned by AWS Firewall Manager.
" } }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { "smithy.api#documentation": "If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n AWS Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request \n in the request parameters, to retrieve the next batch of objects.
The maximum number of objects that you want AWS Firewall Manager to return for this request. If more\n objects are available, in the response, AWS Firewall Manager provides a\n 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.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#ListAppsListsResponse": { "type": "structure", "members": { "AppsLists": { "target": "com.amazonaws.fms#AppsListsData", "traits": { "smithy.api#documentation": "An array of AppsListDataSummary objects.
If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n 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 an array of PolicyComplianceStatus objects. Use\n PolicyComplianceStatus to get a summary of which member accounts are protected\n by the specified policy.
The ID of the AWS Firewall Manager policy that you want the details for.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { "smithy.api#documentation": "If you specify a value for MaxResults and you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, AWS Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicyComplianceStatus objects.\n For the second and subsequent ListComplianceStatus requests, specify the value of\n NextToken from the previous response to get information about another batch of\n PolicyComplianceStatus objects.
Specifies the number of PolicyComplianceStatus objects that you want AWS\n Firewall Manager to return for this request. If you have more\n PolicyComplianceStatus objects than the number that you specify for\n MaxResults, the response includes a NextToken value that you can\n use to get another batch of PolicyComplianceStatus objects.
An array of PolicyComplianceStatus objects.
If you have more PolicyComplianceStatus objects than the number that you\n specified for MaxResults in the request, the response includes a\n NextToken value. To list more PolicyComplianceStatus objects,\n submit another ListComplianceStatus request, and specify the\n NextToken value from the response in the NextToken value in the\n next request.
Returns a MemberAccounts object that lists the member accounts in the\n administrator's AWS organization.
The ListMemberAccounts must be submitted by the account that is set as the\n AWS Firewall Manager administrator.
If you specify a value for MaxResults and you have more account IDs than the\n number that you specify for MaxResults, AWS Firewall Manager returns a\n NextToken value in the response that allows you to list another group of IDs.\n For the second and subsequent ListMemberAccountsRequest requests, specify the\n value of NextToken from the previous response to get information about another\n batch of member account IDs.
Specifies the number of member account IDs that you want AWS Firewall Manager to return\n for this request. If you have more IDs than the number that you specify for\n MaxResults, the response includes a NextToken value that you can\n use to get another batch of member account IDs.
An array of account IDs.
" } }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { "smithy.api#documentation": "If you have more member account IDs than the number that you specified for\n MaxResults in the request, the response includes a NextToken\n value. To list more IDs, submit another ListMemberAccounts request, and specify\n the NextToken value from the response in the NextToken value in the\n next request.
Returns an array of PolicySummary objects.
If you specify a value for MaxResults and you have more\n PolicySummary objects than the number that you specify for\n MaxResults, AWS Firewall Manager returns a NextToken value in the\n response that allows you to list another group of PolicySummary objects. For the\n second and subsequent ListPolicies requests, specify the value of\n NextToken from the previous response to get information about another batch of\n PolicySummary objects.
Specifies the number of PolicySummary objects that you want AWS Firewall\n Manager to return for this request. If you have more PolicySummary objects than\n the number that you specify for MaxResults, the response includes a\n NextToken value that you can use to get another batch of\n PolicySummary objects.
An array of PolicySummary objects.
If you have more PolicySummary objects than the number that you specified for\n MaxResults in the request, the response includes a NextToken\n value. To list more PolicySummary objects, submit another\n ListPolicies request, and specify the NextToken value from the\n response in the NextToken value in the next request.
Returns an array of ProtocolsListDataSummary objects.
Specifies whether the lists to retrieve are default lists owned by AWS Firewall Manager.
" } }, "NextToken": { "target": "com.amazonaws.fms#PaginationToken", "traits": { "smithy.api#documentation": "If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n AWS Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request \n in the request parameters, to retrieve the next batch of objects.
The maximum number of objects that you want AWS Firewall Manager to return for this request. If more\n objects are available, in the response, AWS Firewall Manager provides a\n 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.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#ListProtocolsListsResponse": { "type": "structure", "members": { "ProtocolsLists": { "target": "com.amazonaws.fms#ProtocolsListsData", "traits": { "smithy.api#documentation": "An array of ProtocolsListDataSummary objects.
If you specify a value for MaxResults in your list request, and you have more objects than the maximum, \n AWS Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.
Retrieves the list of tags for the specified AWS resource.
" } }, "com.amazonaws.fms#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#ListTagsForResourceResponse": { "type": "structure", "members": { "TagList": { "target": "com.amazonaws.fms#TagList", "traits": { "smithy.api#documentation": "The tags associated with the resource.
" } } } }, "com.amazonaws.fms#ManagedServiceData": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.fms#MemberAccounts": { "type": "list", "member": { "target": "com.amazonaws.fms#AWSAccountId" } }, "com.amazonaws.fms#NetworkFirewallAction": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.fms#NetworkFirewallActionList": { "type": "list", "member": { "target": "com.amazonaws.fms#NetworkFirewallAction" } }, "com.amazonaws.fms#NetworkFirewallMissingExpectedRTViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The ID of the AWS Network Firewall or VPC resource that's in violation.
" } }, "VPC": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID of the VPC associated with a violating subnet.
" } }, "AvailabilityZone": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "The Availability Zone of a violating subnet.
" } }, "CurrentRouteTable": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID of the current route table that's associated with the subnet, if one is available.
" } }, "ExpectedRouteTable": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID of the route table that should be associated with the subnet.
" } } }, "traits": { "smithy.api#documentation": "Violation details for AWS Network Firewall for a subnet that's not associated to the expected\n Firewall Manager managed route table.
" } }, "com.amazonaws.fms#NetworkFirewallMissingFirewallViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The ID of the AWS Network Firewall or VPC resource that's in violation.
" } }, "VPC": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID of the VPC associated with a violating subnet.
" } }, "AvailabilityZone": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "The Availability Zone of a violating subnet.
" } }, "TargetViolationReason": { "target": "com.amazonaws.fms#TargetViolationReason", "traits": { "smithy.api#documentation": "The reason the resource has this violation, if one is available.
" } } }, "traits": { "smithy.api#documentation": "Violation details for AWS Network Firewall for a subnet that doesn't have a \n Firewall Manager managed firewall in its VPC.
" } }, "com.amazonaws.fms#NetworkFirewallMissingSubnetViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The ID of the AWS Network Firewall or VPC resource that's in violation.
" } }, "VPC": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID of the VPC associated with a violating subnet.
" } }, "AvailabilityZone": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "The Availability Zone of a violating subnet.
" } }, "TargetViolationReason": { "target": "com.amazonaws.fms#TargetViolationReason", "traits": { "smithy.api#documentation": "The reason the resource has this violation, if one is available.
" } } }, "traits": { "smithy.api#documentation": "Violation details for AWS Network Firewall for an Availability Zone that's \n missing the expected Firewall Manager managed subnet.
" } }, "com.amazonaws.fms#NetworkFirewallPolicyDescription": { "type": "structure", "members": { "StatelessRuleGroups": { "target": "com.amazonaws.fms#StatelessRuleGroupList", "traits": { "smithy.api#documentation": "The stateless rule groups that are used in the Network Firewall firewall policy.
" } }, "StatelessDefaultActions": { "target": "com.amazonaws.fms#NetworkFirewallActionList", "traits": { "smithy.api#documentation": "The actions to take on packets that don't match any of the stateless rule groups.
" } }, "StatelessFragmentDefaultActions": { "target": "com.amazonaws.fms#NetworkFirewallActionList", "traits": { "smithy.api#documentation": "The actions to take on packet fragments that don't match any of the stateless rule groups.
" } }, "StatelessCustomActions": { "target": "com.amazonaws.fms#NetworkFirewallActionList", "traits": { "smithy.api#documentation": "Names of custom actions that are available for use in the stateless default actions settings.
" } }, "StatefulRuleGroups": { "target": "com.amazonaws.fms#StatefulRuleGroupList", "traits": { "smithy.api#documentation": "The stateful rule groups that are used in the Network Firewall firewall policy.
" } } }, "traits": { "smithy.api#documentation": "The definition of the AWS Network Firewall firewall policy.
" } }, "com.amazonaws.fms#NetworkFirewallPolicyModifiedViolation": { "type": "structure", "members": { "ViolationTarget": { "target": "com.amazonaws.fms#ViolationTarget", "traits": { "smithy.api#documentation": "The ID of the AWS Network Firewall or VPC resource that's in violation.
" } }, "CurrentPolicyDescription": { "target": "com.amazonaws.fms#NetworkFirewallPolicyDescription", "traits": { "smithy.api#documentation": "The policy that's currently in use in the individual account.
" } }, "ExpectedPolicyDescription": { "target": "com.amazonaws.fms#NetworkFirewallPolicyDescription", "traits": { "smithy.api#documentation": "The policy that should be in use in the individual account in order to be compliant.
" } } }, "traits": { "smithy.api#documentation": "Violation details for AWS Network Firewall for a firewall policy that has a different\n NetworkFirewallPolicyDescription than is required by the Firewall Manager policy.
" } }, "com.amazonaws.fms#NetworkFirewallResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.fms#PaginationMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.fms#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#PartialMatch": { "type": "structure", "members": { "Reference": { "target": "com.amazonaws.fms#ReferenceRule", "traits": { "smithy.api#documentation": "The reference rule from the master security group of the AWS Firewall Manager policy.
" } }, "TargetViolationReasons": { "target": "com.amazonaws.fms#TargetViolationReasons", "traits": { "smithy.api#documentation": "The violation reason.
" } } }, "traits": { "smithy.api#documentation": "The reference rule that partially matches the ViolationTarget rule and violation reason.
The ID of the AWS Firewall Manager policy.
" } }, "PolicyName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The name of the AWS Firewall Manager policy.
", "smithy.api#required": {} } }, "PolicyUpdateToken": { "target": "com.amazonaws.fms#PolicyUpdateToken", "traits": { "smithy.api#documentation": "A unique identifier for each update to the policy. When issuing a PutPolicy\n request, the PolicyUpdateToken in the request must match the\n PolicyUpdateToken of the current policy version. To get the\n PolicyUpdateToken of the current policy version, use a GetPolicy\n request.
Details about the security service that is being used to protect the resources.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { "smithy.api#documentation": "The type of resource protected by or in scope of the policy. This is in the format shown\n in the AWS Resource Types Reference.\n For AWS WAF and Shield Advanced, examples include\n AWS::ElasticLoadBalancingV2::LoadBalancer and\n AWS::CloudFront::Distribution. For a security group common policy, valid values\n are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a\n security group content audit policy, valid values are AWS::EC2::SecurityGroup,\n AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security\n group usage audit policy, the value is AWS::EC2::SecurityGroup. For an AWS Network Firewall policy,\n the value is AWS::EC2::VPC.
An array of ResourceType.
An array of ResourceTag objects.
If set to True, resources with the tags that are specified in the\n ResourceTag array are not in scope of the policy. If set to False,\n and the ResourceTag array is not null, only resources with the specified tags are\n in scope of the policy.
Indicates if the policy should be automatically applied to new resources.
", "smithy.api#required": {} } }, "IncludeMap": { "target": "com.amazonaws.fms#CustomerPolicyScopeMap", "traits": { "smithy.api#documentation": "Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy. \n 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.
\nYou can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager \n applies the policy to all accounts specified by the IncludeMap, and \n does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager \n applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
\nSpecify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: \n {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: \n {“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:\n {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy. \n 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.
\nYou can specify inclusions or exclusions, but not both. If you specify an IncludeMap, AWS Firewall Manager \n applies the policy to all accounts specified by the IncludeMap, and \n does not evaluate any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager \n applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
\nSpecify account IDs by setting the key to ACCOUNT. For example, the following is a valid map: \n {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map: \n {“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:\n {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
An AWS Firewall Manager policy.
" } }, "com.amazonaws.fms#PolicyComplianceDetail": { "type": "structure", "members": { "PolicyOwner": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account that created the AWS Firewall Manager policy.
" } }, "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager policy.
" } }, "MemberAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account ID.
" } }, "Violators": { "target": "com.amazonaws.fms#ComplianceViolators", "traits": { "smithy.api#documentation": "An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or\n that aren't in compliance with the security group policy.
" } }, "EvaluationLimitExceeded": { "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#documentation": "Indicates if over 100 resources are noncompliant with the AWS Firewall Manager\n policy.
" } }, "ExpiredAt": { "target": "com.amazonaws.fms#TimeStamp", "traits": { "smithy.api#documentation": "A timestamp that indicates when the returned information should be considered out of\n date.
" } }, "IssueInfoMap": { "target": "com.amazonaws.fms#IssueInfoMap", "traits": { "smithy.api#documentation": "Details about problems with dependent services, such as AWS WAF or AWS Config, that are\n causing a resource to be noncompliant. The details include the name of the dependent service\n and the error message received that indicates the problem with the service.
" } } }, "traits": { "smithy.api#documentation": "Describes\n the noncompliant resources in a member account for a specific AWS Firewall\n Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are\n noncompliant, EvaluationLimitExceeded is set to True.
The AWS account that created the AWS Firewall Manager policy.
" } }, "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager policy.
" } }, "PolicyName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The name of the AWS Firewall Manager policy.
" } }, "MemberAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The member account ID.
" } }, "EvaluationResults": { "target": "com.amazonaws.fms#EvaluationResults", "traits": { "smithy.api#documentation": "An array of EvaluationResult objects.
Timestamp of the last update to the EvaluationResult objects.
Details about problems with dependent services, such as AWS WAF or AWS Config, that are\n causing a resource to be noncompliant. The details include the name of the dependent service\n and the error message received that indicates the problem with the service.
" } } }, "traits": { "smithy.api#documentation": "Indicates whether the account is compliant with the specified policy. An account is\n considered noncompliant if it includes resources that are not protected by the policy, for AWS\n WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group\n policies.
" } }, "com.amazonaws.fms#PolicyComplianceStatusList": { "type": "list", "member": { "target": "com.amazonaws.fms#PolicyComplianceStatus" } }, "com.amazonaws.fms#PolicyComplianceStatusType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "COMPLIANT", "name": "Compliant" }, { "value": "NON_COMPLIANT", "name": "NonCompliant" } ] } }, "com.amazonaws.fms#PolicyId": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-z0-9A-Z-]{36}$" } }, "com.amazonaws.fms#PolicySummary": { "type": "structure", "members": { "PolicyArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified policy.
" } }, "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the specified policy.
" } }, "PolicyName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The name of the specified policy.
" } }, "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { "smithy.api#documentation": "The type of resource protected by or in scope of the policy. This is in the format shown\n in the AWS Resource Types Reference. \n For AWS WAF and Shield Advanced, examples include\n AWS::ElasticLoadBalancingV2::LoadBalancer and\n AWS::CloudFront::Distribution. For a security group common policy, valid values\n are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a\n security group content audit policy, valid values are AWS::EC2::SecurityGroup,\n AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security\n group usage audit policy, the value is AWS::EC2::SecurityGroup. For an AWS Network Firewall policy,\n the value is AWS::EC2::VPC.
The service that the policy is using to protect the resources. This specifies the type of\n policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security\n group policy.
" } }, "RemediationEnabled": { "target": "com.amazonaws.fms#Boolean", "traits": { "smithy.api#documentation": "Indicates if the policy should be automatically applied to new resources.
" } } }, "traits": { "smithy.api#documentation": "Details of the AWS Firewall Manager policy.
" } }, "com.amazonaws.fms#PolicySummaryList": { "type": "list", "member": { "target": "com.amazonaws.fms#PolicySummary" } }, "com.amazonaws.fms#PolicyUpdateToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#PreviousAppsList": { "type": "map", "key": { "target": "com.amazonaws.fms#PreviousListVersion" }, "value": { "target": "com.amazonaws.fms#AppsList" } }, "com.amazonaws.fms#PreviousListVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2 }, "smithy.api#pattern": "^\\d{1,2}$" } }, "com.amazonaws.fms#PreviousProtocolsList": { "type": "map", "key": { "target": "com.amazonaws.fms#PreviousListVersion" }, "value": { "target": "com.amazonaws.fms#ProtocolsList" } }, "com.amazonaws.fms#ProtectionData": { "type": "string" }, "com.amazonaws.fms#Protocol": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ProtocolsList": { "type": "list", "member": { "target": "com.amazonaws.fms#Protocol" } }, "com.amazonaws.fms#ProtocolsListData": { "type": "structure", "members": { "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager protocols list.
" } }, "ListName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The name of the AWS Firewall Manager protocols list.
", "smithy.api#required": {} } }, "ListUpdateToken": { "target": "com.amazonaws.fms#UpdateToken", "traits": { "smithy.api#documentation": "A unique identifier for each update to the list. When you update \n the list, the update token must match the token of the current version of the application list. \n You can retrieve the update token by getting the list.
" } }, "CreateTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { "smithy.api#documentation": "The time that the AWS Firewall Manager protocols list was created.
" } }, "LastUpdateTime": { "target": "com.amazonaws.fms#TimeStamp", "traits": { "smithy.api#documentation": "The time that the AWS Firewall Manager protocols list was last updated.
" } }, "ProtocolsList": { "target": "com.amazonaws.fms#ProtocolsList", "traits": { "smithy.api#documentation": "An array of protocols in the AWS Firewall Manager protocols list.
", "smithy.api#required": {} } }, "PreviousProtocolsList": { "target": "com.amazonaws.fms#PreviousProtocolsList", "traits": { "smithy.api#documentation": "A map of previous version numbers to their corresponding protocol arrays.
" } } }, "traits": { "smithy.api#documentation": "An AWS Firewall Manager protocols list.
" } }, "com.amazonaws.fms#ProtocolsListDataSummary": { "type": "structure", "members": { "ListArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified protocols list.
" } }, "ListId": { "target": "com.amazonaws.fms#ListId", "traits": { "smithy.api#documentation": "The ID of the specified protocols list.
" } }, "ListName": { "target": "com.amazonaws.fms#ResourceName", "traits": { "smithy.api#documentation": "The name of the specified protocols list.
" } }, "ProtocolsList": { "target": "com.amazonaws.fms#ProtocolsList", "traits": { "smithy.api#documentation": "An array of protocols in the AWS Firewall Manager protocols list.
" } } }, "traits": { "smithy.api#documentation": "Details of the AWS Firewall Manager protocols list.
" } }, "com.amazonaws.fms#ProtocolsListsData": { "type": "list", "member": { "target": "com.amazonaws.fms#ProtocolsListDataSummary" } }, "com.amazonaws.fms#PutAppsList": { "type": "operation", "input": { "target": "com.amazonaws.fms#PutAppsListRequest" }, "output": { "target": "com.amazonaws.fms#PutAppsListResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#LimitExceededException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Creates an AWS Firewall Manager applications list.
" } }, "com.amazonaws.fms#PutAppsListRequest": { "type": "structure", "members": { "AppsList": { "target": "com.amazonaws.fms#AppsListData", "traits": { "smithy.api#documentation": "The details of the AWS Firewall Manager applications list to be created.
", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.fms#TagList", "traits": { "smithy.api#documentation": "The tags associated with the resource.
" } } } }, "com.amazonaws.fms#PutAppsListResponse": { "type": "structure", "members": { "AppsList": { "target": "com.amazonaws.fms#AppsListData", "traits": { "smithy.api#documentation": "The details of the AWS Firewall Manager applications list.
" } }, "AppsListArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the applications list.
" } } } }, "com.amazonaws.fms#PutNotificationChannel": { "type": "operation", "input": { "target": "com.amazonaws.fms#PutNotificationChannelRequest" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS\n Firewall Manager uses to record SNS logs.
\nTo perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager \n role AWSServiceRoleForFMS to publish SNS logs. For more information, see \n Firewall Manager required permissions for API actions in the AWS Firewall Manager Developer Guide.
The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS\n Firewall Manager.
", "smithy.api#required": {} } }, "SnsRoleName": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS\n Firewall Manager activity.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#PutPolicy": { "type": "operation", "input": { "target": "com.amazonaws.fms#PutPolicyRequest" }, "output": { "target": "com.amazonaws.fms#PutPolicyResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#InvalidTypeException" }, { "target": "com.amazonaws.fms#LimitExceededException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Creates an AWS Firewall Manager policy.
\nFirewall Manager provides the following types of policies:
\nAn AWS WAF policy (type WAFV2), which defines rule groups to run first in the \n corresponding AWS WAF web ACL and rule groups to run last in the web ACL.
\nAn AWS WAF Classic policy (type WAF), which defines a rule group.
\nA Shield Advanced policy, which applies Shield Advanced protection to specified\n accounts and resources.
\nA security group policy, which manages VPC security groups across your AWS\n organization.
\nAn AWS Network Firewall policy, which provides firewall rules to filter network traffic in specified \n Amazon VPCs.
\nEach policy is specific to one of the types. If you want to enforce more than one\n policy type across accounts, create multiple policies. You can create multiple\n policies for each type.
\nYou must be subscribed to Shield Advanced to create a Shield Advanced policy. For more\n information about subscribing to Shield Advanced, see \n CreateSubscription.
" } }, "com.amazonaws.fms#PutPolicyRequest": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.fms#Policy", "traits": { "smithy.api#documentation": "The details of the AWS Firewall Manager policy to be created.
", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.fms#TagList", "traits": { "smithy.api#documentation": "The tags to add to the AWS resource.
" } } } }, "com.amazonaws.fms#PutPolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.fms#Policy", "traits": { "smithy.api#documentation": "The details of the AWS Firewall Manager policy.
" } }, "PolicyArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
" } } } }, "com.amazonaws.fms#PutProtocolsList": { "type": "operation", "input": { "target": "com.amazonaws.fms#PutProtocolsListRequest" }, "output": { "target": "com.amazonaws.fms#PutProtocolsListResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#LimitExceededException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Creates an AWS Firewall Manager protocols list.
" } }, "com.amazonaws.fms#PutProtocolsListRequest": { "type": "structure", "members": { "ProtocolsList": { "target": "com.amazonaws.fms#ProtocolsListData", "traits": { "smithy.api#documentation": "The details of the AWS Firewall Manager protocols list to be created.
", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.fms#TagList", "traits": { "smithy.api#documentation": "The tags associated with the resource.
" } } } }, "com.amazonaws.fms#PutProtocolsListResponse": { "type": "structure", "members": { "ProtocolsList": { "target": "com.amazonaws.fms#ProtocolsListData", "traits": { "smithy.api#documentation": "The details of the AWS Firewall Manager protocols list.
" } }, "ProtocolsListArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the protocols list.
" } } } }, "com.amazonaws.fms#ReferenceRule": { "type": "string" }, "com.amazonaws.fms#RemediationActionDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.fms#RemediationActionType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "REMOVE", "name": "Remove" }, { "value": "MODIFY", "name": "Modify" } ] } }, "com.amazonaws.fms#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ResourceCount": { "type": "long", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.fms#ResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ResourceIdList": { "type": "list", "member": { "target": "com.amazonaws.fms#ResourceId" } }, "com.amazonaws.fms#ResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.fms#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The specified resource was not found.
", "smithy.api#error": "client" } }, "com.amazonaws.fms#ResourceTag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.fms#ResourceTagKey", "traits": { "smithy.api#documentation": "The resource tag key.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.fms#ResourceTagValue", "traits": { "smithy.api#documentation": "The resource tag value.
" } } }, "traits": { "smithy.api#documentation": "The resource tags that AWS Firewall Manager uses to determine if a particular resource\n should be included or excluded from the AWS Firewall Manager policy. Tags enable you to\n categorize your AWS resources in different ways, for example, by purpose, owner, or\n environment. Each tag consists of a key and an optional value. Firewall Manager combines the\n tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have\n all the specified tags to be included or excluded. For more information, see \n Working with Tag Editor.
" } }, "com.amazonaws.fms#ResourceTagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ResourceTagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ResourceTags": { "type": "list", "member": { "target": "com.amazonaws.fms#ResourceTag" }, "traits": { "smithy.api#length": { "min": 0, "max": 8 } } }, "com.amazonaws.fms#ResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ResourceTypeList": { "type": "list", "member": { "target": "com.amazonaws.fms#ResourceType" } }, "com.amazonaws.fms#ResourceViolation": { "type": "structure", "members": { "AwsVPCSecurityGroupViolation": { "target": "com.amazonaws.fms#AwsVPCSecurityGroupViolation", "traits": { "smithy.api#documentation": "Violation details for security groups.
" } }, "AwsEc2NetworkInterfaceViolation": { "target": "com.amazonaws.fms#AwsEc2NetworkInterfaceViolation", "traits": { "smithy.api#documentation": "Violation details for network interface.
" } }, "AwsEc2InstanceViolation": { "target": "com.amazonaws.fms#AwsEc2InstanceViolation", "traits": { "smithy.api#documentation": "Violation details for an EC2 instance.
" } }, "NetworkFirewallMissingFirewallViolation": { "target": "com.amazonaws.fms#NetworkFirewallMissingFirewallViolation", "traits": { "smithy.api#documentation": "Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager \n managed firewall in its VPC.
" } }, "NetworkFirewallMissingSubnetViolation": { "target": "com.amazonaws.fms#NetworkFirewallMissingSubnetViolation", "traits": { "smithy.api#documentation": "Violation detail for an Network Firewall policy that indicates that an Availability Zone is \n missing the expected Firewall Manager managed subnet.
" } }, "NetworkFirewallMissingExpectedRTViolation": { "target": "com.amazonaws.fms#NetworkFirewallMissingExpectedRTViolation", "traits": { "smithy.api#documentation": "Violation detail for an Network Firewall policy that indicates that a subnet \n is not associated with the expected Firewall Manager managed route table.
" } }, "NetworkFirewallPolicyModifiedViolation": { "target": "com.amazonaws.fms#NetworkFirewallPolicyModifiedViolation", "traits": { "smithy.api#documentation": "Violation detail for an Network Firewall policy that indicates that a firewall policy \n in an individual account has been modified in a way that makes it noncompliant. \n For example, the individual account owner might have deleted a rule group, \n changed the priority of a stateless rule group, or changed a policy default action.
" } }, "DnsRuleGroupPriorityConflictViolation": { "target": "com.amazonaws.fms#DnsRuleGroupPriorityConflictViolation", "traits": { "smithy.api#documentation": "Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager \n tried to associate with a VPC has the same priority as a rule group that's already associated.
" } }, "DnsDuplicateRuleGroupViolation": { "target": "com.amazonaws.fms#DnsDuplicateRuleGroupViolation", "traits": { "smithy.api#documentation": "Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager \n tried to associate with a VPC is already associated with the VPC and can't be associated again.
" } }, "DnsRuleGroupLimitExceededViolation": { "target": "com.amazonaws.fms#DnsRuleGroupLimitExceededViolation", "traits": { "smithy.api#documentation": "Violation details for a DNS Firewall policy that indicates that the VPC reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed.
" } } }, "traits": { "smithy.api#documentation": "Violation detail based on resource type.
" } }, "com.amazonaws.fms#ResourceViolations": { "type": "list", "member": { "target": "com.amazonaws.fms#ResourceViolation" } }, "com.amazonaws.fms#SecurityGroupRemediationAction": { "type": "structure", "members": { "RemediationActionType": { "target": "com.amazonaws.fms#RemediationActionType", "traits": { "smithy.api#documentation": "The remediation action that will be performed.
" } }, "Description": { "target": "com.amazonaws.fms#RemediationActionDescription", "traits": { "smithy.api#documentation": "Brief description of the action that will be performed.
" } }, "RemediationResult": { "target": "com.amazonaws.fms#SecurityGroupRuleDescription", "traits": { "smithy.api#documentation": "The final state of the rule specified in the ViolationTarget after it is remediated.
Indicates if the current action is the default action.
" } } }, "traits": { "smithy.api#documentation": "Remediation option for the rule specified in the ViolationTarget.
The IPv4 ranges for the security group rule.
" } }, "IPV6Range": { "target": "com.amazonaws.fms#CIDR", "traits": { "smithy.api#documentation": "The IPv6 ranges for the security group rule.
" } }, "PrefixListId": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The ID of the prefix list for the security group rule.
" } }, "Protocol": { "target": "com.amazonaws.fms#LengthBoundedString", "traits": { "smithy.api#documentation": "The IP protocol name (tcp, udp, icmp, icmpv6) or number.
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.
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.
Describes a set of permissions for a security group rule.
" } }, "com.amazonaws.fms#SecurityServicePolicyData": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.fms#SecurityServiceType", "traits": { "smithy.api#documentation": "The service that the policy is using to protect the resources. This specifies the type of\n policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security\n group policy. For security group policies, Firewall Manager supports one security group for\n each common policy and for each content audit policy. This is an adjustable limit that you can\n increase by contacting AWS Support.
", "smithy.api#required": {} } }, "ManagedServiceData": { "target": "com.amazonaws.fms#ManagedServiceData", "traits": { "smithy.api#documentation": "Details about the service that are specific to the service type, in JSON format. For\n service type SHIELD_ADVANCED, this is an empty string.
Example: NETWORK_FIREWALL\n
\n \"{\\\"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\\\"]} }\"\n
Example: WAFV2\n
\n \"{\\\"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\\\"}]}}\"\n
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\n
\n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n
Example: SECURITY_GROUPS_COMMON\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false, \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_CONTENT_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n
The security group action for content audit can be ALLOW or\n DENY. For ALLOW, all in-scope security group rules must be\n within the allowed range of the policy's security group rules. For DENY, all\n in-scope security group rules must not contain a value or a range that matches a rule\n value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n
Details about the security service that is being used to protect the resources.
" } }, "com.amazonaws.fms#SecurityServiceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "WAF", "name": "WAF" }, { "value": "WAFV2", "name": "WAFV2" }, { "value": "SHIELD_ADVANCED", "name": "SHIELD_ADVANCED" }, { "value": "SECURITY_GROUPS_COMMON", "name": "SECURITY_GROUPS_COMMON" }, { "value": "SECURITY_GROUPS_CONTENT_AUDIT", "name": "SECURITY_GROUPS_CONTENT_AUDIT" }, { "value": "SECURITY_GROUPS_USAGE_AUDIT", "name": "SECURITY_GROUPS_USAGE_AUDIT" }, { "value": "NETWORK_FIREWALL", "name": "NETWORK_FIREWALL" }, { "value": "DNS_FIREWALL", "name": "DNS_FIREWALL" } ] } }, "com.amazonaws.fms#StatefulRuleGroup": { "type": "structure", "members": { "RuleGroupName": { "target": "com.amazonaws.fms#NetworkFirewallResourceName", "traits": { "smithy.api#documentation": "The name of the rule group.
" } }, "ResourceId": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID of the rule group.
" } } }, "traits": { "smithy.api#documentation": "AWS Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.
" } }, "com.amazonaws.fms#StatefulRuleGroupList": { "type": "list", "member": { "target": "com.amazonaws.fms#StatefulRuleGroup" } }, "com.amazonaws.fms#StatelessRuleGroup": { "type": "structure", "members": { "RuleGroupName": { "target": "com.amazonaws.fms#NetworkFirewallResourceName", "traits": { "smithy.api#documentation": "The name of the rule group.
" } }, "ResourceId": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID of the rule group.
" } }, "Priority": { "target": "com.amazonaws.fms#StatelessRuleGroupPriority", "traits": { "smithy.api#documentation": "The priority of the rule group. AWS Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.
" } } }, "traits": { "smithy.api#documentation": "AWS Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription.
" } }, "com.amazonaws.fms#StatelessRuleGroupList": { "type": "list", "member": { "target": "com.amazonaws.fms#StatelessRuleGroup" } }, "com.amazonaws.fms#StatelessRuleGroupPriority": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 65535 } } }, "com.amazonaws.fms#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.fms#TagKey", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.fms#TagValue", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource.
" } }, "com.amazonaws.fms#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.fms#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.fms#TagList": { "type": "list", "member": { "target": "com.amazonaws.fms#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.fms#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.fms#TagResourceRequest" }, "output": { "target": "com.amazonaws.fms#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#LimitExceededException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to an AWS resource.
" } }, "com.amazonaws.fms#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "TagList": { "target": "com.amazonaws.fms#TagList", "traits": { "smithy.api#documentation": "The tags to add to the resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.fms#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#TargetViolationReason": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "\\w+" } }, "com.amazonaws.fms#TargetViolationReasons": { "type": "list", "member": { "target": "com.amazonaws.fms#TargetViolationReason" } }, "com.amazonaws.fms#TimeStamp": { "type": "timestamp" }, "com.amazonaws.fms#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.fms#UntagResourceRequest" }, "output": { "target": "com.amazonaws.fms#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" }, { "target": "com.amazonaws.fms#InvalidInputException" }, { "target": "com.amazonaws.fms#InvalidOperationException" }, { "target": "com.amazonaws.fms#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Removes one or more tags from an AWS resource.
" } }, "com.amazonaws.fms#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.fms#ResourceArn", "traits": { "smithy.api#documentation": "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.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.fms#TagKeyList", "traits": { "smithy.api#documentation": "The keys of the tags to remove from the resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.fms#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.fms#UpdateToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.fms#ViolationDetail": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { "smithy.api#documentation": "The ID of the AWS Firewall Manager policy that the violation details were requested for.
", "smithy.api#required": {} } }, "MemberAccount": { "target": "com.amazonaws.fms#AWSAccountId", "traits": { "smithy.api#documentation": "The AWS account that the violation details were requested for.
", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.fms#ResourceId", "traits": { "smithy.api#documentation": "The resource ID that the violation details were requested for.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { "smithy.api#documentation": "The resource type that the violation details were requested for.
", "smithy.api#required": {} } }, "ResourceViolations": { "target": "com.amazonaws.fms#ResourceViolations", "traits": { "smithy.api#documentation": "List of violations for the requested resource.
", "smithy.api#required": {} } }, "ResourceTags": { "target": "com.amazonaws.fms#TagList", "traits": { "smithy.api#documentation": "The ResourceTag objects associated with the resource.
Brief description for the requested resource.
" } } }, "traits": { "smithy.api#documentation": "Violations for a resource based on the specified AWS Firewall Manager policy and AWS account.
" } }, "com.amazonaws.fms#ViolationReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "WEB_ACL_MISSING_RULE_GROUP", "name": "WebAclMissingRuleGroup" }, { "value": "RESOURCE_MISSING_WEB_ACL", "name": "ResourceMissingWebAcl" }, { "value": "RESOURCE_INCORRECT_WEB_ACL", "name": "ResourceIncorrectWebAcl" }, { "value": "RESOURCE_MISSING_SHIELD_PROTECTION", "name": "ResourceMissingShieldProtection" }, { "value": "RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION", "name": "ResourceMissingWebaclOrShieldProtection" }, { "value": "RESOURCE_MISSING_SECURITY_GROUP", "name": "ResourceMissingSecurityGroup" }, { "value": "RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP", "name": "ResourceViolatesAuditSecurityGroup" }, { "value": "SECURITY_GROUP_UNUSED", "name": "SecurityGroupUnused" }, { "value": "SECURITY_GROUP_REDUNDANT", "name": "SecurityGroupRedundant" }, { "value": "FMS_CREATED_SECURITY_GROUP_EDITED", "name": "FMSCreatedSecurityGroupEdited" }, { "value": "MISSING_FIREWALL", "name": "MissingFirewall" }, { "value": "MISSING_FIREWALL_SUBNET_IN_AZ", "name": "MissingFirewallSubnetInAZ" }, { "value": "MISSING_EXPECTED_ROUTE_TABLE", "name": "MissingExpectedRouteTable" }, { "value": "NETWORK_FIREWALL_POLICY_MODIFIED", "name": "NetworkFirewallPolicyModified" }, { "value": "RESOURCE_MISSING_DNS_FIREWALL", "name": "ResourceMissingDnsFirewall" } ] } }, "com.amazonaws.fms#ViolationTarget": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": ".*" } } } }