prowler-sdk-poc
Version:
947 lines • 89.6 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class FMS extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: FMS.Types.ClientConfiguration)
config: Config & FMS.Types.ClientConfiguration;
/**
* Sets the Firewall Manager administrator account. The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies. The account that you associate with Firewall Manager is called the Firewall Manager administrator account.
*/
associateAdminAccount(params: FMS.Types.AssociateAdminAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the Firewall Manager administrator account. The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies. The account that you associate with Firewall Manager is called the Firewall Manager administrator account.
*/
associateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Permanently deletes an Firewall Manager applications list.
*/
deleteAppsList(params: FMS.Types.DeleteAppsListRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Permanently deletes an Firewall Manager applications list.
*/
deleteAppsList(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
*/
deleteNotificationChannel(params: FMS.Types.DeleteNotificationChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
*/
deleteNotificationChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Permanently deletes an Firewall Manager policy.
*/
deletePolicy(params: FMS.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Permanently deletes an Firewall Manager policy.
*/
deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Permanently deletes an Firewall Manager protocols list.
*/
deleteProtocolsList(params: FMS.Types.DeleteProtocolsListRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Permanently deletes an Firewall Manager protocols list.
*/
deleteProtocolsList(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates the account that has been set as the Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.
*/
disassociateAdminAccount(params: FMS.Types.DisassociateAdminAccountRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates the account that has been set as the Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.
*/
disassociateAdminAccount(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.
*/
getAdminAccount(params: FMS.Types.GetAdminAccountRequest, callback?: (err: AWSError, data: FMS.Types.GetAdminAccountResponse) => void): Request<FMS.Types.GetAdminAccountResponse, AWSError>;
/**
* Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator.
*/
getAdminAccount(callback?: (err: AWSError, data: FMS.Types.GetAdminAccountResponse) => void): Request<FMS.Types.GetAdminAccountResponse, AWSError>;
/**
* Returns information about the specified Firewall Manager applications list.
*/
getAppsList(params: FMS.Types.GetAppsListRequest, callback?: (err: AWSError, data: FMS.Types.GetAppsListResponse) => void): Request<FMS.Types.GetAppsListResponse, AWSError>;
/**
* Returns information about the specified Firewall Manager applications list.
*/
getAppsList(callback?: (err: AWSError, data: FMS.Types.GetAppsListResponse) => void): Request<FMS.Types.GetAppsListResponse, AWSError>;
/**
* Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible. Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules. Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.
*/
getComplianceDetail(params: FMS.Types.GetComplianceDetailRequest, callback?: (err: AWSError, data: FMS.Types.GetComplianceDetailResponse) => void): Request<FMS.Types.GetComplianceDetailResponse, AWSError>;
/**
* Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible. Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules. Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.
*/
getComplianceDetail(callback?: (err: AWSError, data: FMS.Types.GetComplianceDetailResponse) => void): Request<FMS.Types.GetComplianceDetailResponse, AWSError>;
/**
* Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
*/
getNotificationChannel(params: FMS.Types.GetNotificationChannelRequest, callback?: (err: AWSError, data: FMS.Types.GetNotificationChannelResponse) => void): Request<FMS.Types.GetNotificationChannelResponse, AWSError>;
/**
* Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.
*/
getNotificationChannel(callback?: (err: AWSError, data: FMS.Types.GetNotificationChannelResponse) => void): Request<FMS.Types.GetNotificationChannelResponse, AWSError>;
/**
* Returns information about the specified Firewall Manager policy.
*/
getPolicy(params: FMS.Types.GetPolicyRequest, callback?: (err: AWSError, data: FMS.Types.GetPolicyResponse) => void): Request<FMS.Types.GetPolicyResponse, AWSError>;
/**
* Returns information about the specified Firewall Manager policy.
*/
getPolicy(callback?: (err: AWSError, data: FMS.Types.GetPolicyResponse) => void): Request<FMS.Types.GetPolicyResponse, AWSError>;
/**
* If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.
*/
getProtectionStatus(params: FMS.Types.GetProtectionStatusRequest, callback?: (err: AWSError, data: FMS.Types.GetProtectionStatusResponse) => void): Request<FMS.Types.GetProtectionStatusResponse, AWSError>;
/**
* If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.
*/
getProtectionStatus(callback?: (err: AWSError, data: FMS.Types.GetProtectionStatusResponse) => void): Request<FMS.Types.GetProtectionStatusResponse, AWSError>;
/**
* Returns information about the specified Firewall Manager protocols list.
*/
getProtocolsList(params: FMS.Types.GetProtocolsListRequest, callback?: (err: AWSError, data: FMS.Types.GetProtocolsListResponse) => void): Request<FMS.Types.GetProtocolsListResponse, AWSError>;
/**
* Returns information about the specified Firewall Manager protocols list.
*/
getProtocolsList(callback?: (err: AWSError, data: FMS.Types.GetProtocolsListResponse) => void): Request<FMS.Types.GetProtocolsListResponse, AWSError>;
/**
* Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
*/
getViolationDetails(params: FMS.Types.GetViolationDetailsRequest, callback?: (err: AWSError, data: FMS.Types.GetViolationDetailsResponse) => void): Request<FMS.Types.GetViolationDetailsResponse, AWSError>;
/**
* Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
*/
getViolationDetails(callback?: (err: AWSError, data: FMS.Types.GetViolationDetailsResponse) => void): Request<FMS.Types.GetViolationDetailsResponse, AWSError>;
/**
* Returns an array of AppsListDataSummary objects.
*/
listAppsLists(params: FMS.Types.ListAppsListsRequest, callback?: (err: AWSError, data: FMS.Types.ListAppsListsResponse) => void): Request<FMS.Types.ListAppsListsResponse, AWSError>;
/**
* Returns an array of AppsListDataSummary objects.
*/
listAppsLists(callback?: (err: AWSError, data: FMS.Types.ListAppsListsResponse) => void): Request<FMS.Types.ListAppsListsResponse, AWSError>;
/**
* Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
*/
listComplianceStatus(params: FMS.Types.ListComplianceStatusRequest, callback?: (err: AWSError, data: FMS.Types.ListComplianceStatusResponse) => void): Request<FMS.Types.ListComplianceStatusResponse, AWSError>;
/**
* Returns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.
*/
listComplianceStatus(callback?: (err: AWSError, data: FMS.Types.ListComplianceStatusResponse) => void): Request<FMS.Types.ListComplianceStatusResponse, AWSError>;
/**
* Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization. The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager administrator.
*/
listMemberAccounts(params: FMS.Types.ListMemberAccountsRequest, callback?: (err: AWSError, data: FMS.Types.ListMemberAccountsResponse) => void): Request<FMS.Types.ListMemberAccountsResponse, AWSError>;
/**
* Returns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization. The ListMemberAccounts must be submitted by the account that is set as the Firewall Manager administrator.
*/
listMemberAccounts(callback?: (err: AWSError, data: FMS.Types.ListMemberAccountsResponse) => void): Request<FMS.Types.ListMemberAccountsResponse, AWSError>;
/**
* Returns an array of PolicySummary objects.
*/
listPolicies(params: FMS.Types.ListPoliciesRequest, callback?: (err: AWSError, data: FMS.Types.ListPoliciesResponse) => void): Request<FMS.Types.ListPoliciesResponse, AWSError>;
/**
* Returns an array of PolicySummary objects.
*/
listPolicies(callback?: (err: AWSError, data: FMS.Types.ListPoliciesResponse) => void): Request<FMS.Types.ListPoliciesResponse, AWSError>;
/**
* Returns an array of ProtocolsListDataSummary objects.
*/
listProtocolsLists(params: FMS.Types.ListProtocolsListsRequest, callback?: (err: AWSError, data: FMS.Types.ListProtocolsListsResponse) => void): Request<FMS.Types.ListProtocolsListsResponse, AWSError>;
/**
* Returns an array of ProtocolsListDataSummary objects.
*/
listProtocolsLists(callback?: (err: AWSError, data: FMS.Types.ListProtocolsListsResponse) => void): Request<FMS.Types.ListProtocolsListsResponse, AWSError>;
/**
* Retrieves the list of tags for the specified Amazon Web Services resource.
*/
listTagsForResource(params: FMS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: FMS.Types.ListTagsForResourceResponse) => void): Request<FMS.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves the list of tags for the specified Amazon Web Services resource.
*/
listTagsForResource(callback?: (err: AWSError, data: FMS.Types.ListTagsForResourceResponse) => void): Request<FMS.Types.ListTagsForResourceResponse, AWSError>;
/**
* Creates an Firewall Manager applications list.
*/
putAppsList(params: FMS.Types.PutAppsListRequest, callback?: (err: AWSError, data: FMS.Types.PutAppsListResponse) => void): Request<FMS.Types.PutAppsListResponse, AWSError>;
/**
* Creates an Firewall Manager applications list.
*/
putAppsList(callback?: (err: AWSError, data: FMS.Types.PutAppsListResponse) => void): Request<FMS.Types.PutAppsListResponse, AWSError>;
/**
* Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role AWSServiceRoleForFMS to publish SNS logs. For more information, see Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide.
*/
putNotificationChannel(params: FMS.Types.PutNotificationChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role AWSServiceRoleForFMS to publish SNS logs. For more information, see Firewall Manager required permissions for API actions in the Firewall Manager Developer Guide.
*/
putNotificationChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates an Firewall Manager policy. Firewall Manager provides the following types of policies: An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL. An WAF Classic policy (type WAF), which defines a rule group. A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources. A security group policy, which manages VPC security groups across your Amazon Web Services organization. An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs. A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs. Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
*/
putPolicy(params: FMS.Types.PutPolicyRequest, callback?: (err: AWSError, data: FMS.Types.PutPolicyResponse) => void): Request<FMS.Types.PutPolicyResponse, AWSError>;
/**
* Creates an Firewall Manager policy. Firewall Manager provides the following types of policies: An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL. An WAF Classic policy (type WAF), which defines a rule group. A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources. A security group policy, which manages VPC security groups across your Amazon Web Services organization. An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs. A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs. Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
*/
putPolicy(callback?: (err: AWSError, data: FMS.Types.PutPolicyResponse) => void): Request<FMS.Types.PutPolicyResponse, AWSError>;
/**
* Creates an Firewall Manager protocols list.
*/
putProtocolsList(params: FMS.Types.PutProtocolsListRequest, callback?: (err: AWSError, data: FMS.Types.PutProtocolsListResponse) => void): Request<FMS.Types.PutProtocolsListResponse, AWSError>;
/**
* Creates an Firewall Manager protocols list.
*/
putProtocolsList(callback?: (err: AWSError, data: FMS.Types.PutProtocolsListResponse) => void): Request<FMS.Types.PutProtocolsListResponse, AWSError>;
/**
* Adds one or more tags to an Amazon Web Services resource.
*/
tagResource(params: FMS.Types.TagResourceRequest, callback?: (err: AWSError, data: FMS.Types.TagResourceResponse) => void): Request<FMS.Types.TagResourceResponse, AWSError>;
/**
* Adds one or more tags to an Amazon Web Services resource.
*/
tagResource(callback?: (err: AWSError, data: FMS.Types.TagResourceResponse) => void): Request<FMS.Types.TagResourceResponse, AWSError>;
/**
* Removes one or more tags from an Amazon Web Services resource.
*/
untagResource(params: FMS.Types.UntagResourceRequest, callback?: (err: AWSError, data: FMS.Types.UntagResourceResponse) => void): Request<FMS.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from an Amazon Web Services resource.
*/
untagResource(callback?: (err: AWSError, data: FMS.Types.UntagResourceResponse) => void): Request<FMS.Types.UntagResourceResponse, AWSError>;
}
declare namespace FMS {
export type AWSAccountId = string;
export type AccountRoleStatus = "READY"|"CREATING"|"PENDING_DELETION"|"DELETING"|"DELETED"|string;
export interface ActionTarget {
/**
* The ID of the remediation target.
*/
ResourceId?: ResourceId;
/**
* A description of the remediation action target.
*/
Description?: LengthBoundedString;
}
export interface App {
/**
* The application's name.
*/
AppName: ResourceName;
/**
* The IP protocol name or number. The name can be one of tcp, udp, or icmp. For information on possible numbers, see Protocol Numbers.
*/
Protocol: Protocol;
/**
* The application's port number, for example 80.
*/
Port: IPPortNumber;
}
export type AppsList = App[];
export interface AppsListData {
/**
* The ID of the Firewall Manager applications list.
*/
ListId?: ListId;
/**
* The name of the Firewall Manager applications list.
*/
ListName: ResourceName;
/**
* A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.
*/
ListUpdateToken?: UpdateToken;
/**
* The time that the Firewall Manager applications list was created.
*/
CreateTime?: TimeStamp;
/**
* The time that the Firewall Manager applications list was last updated.
*/
LastUpdateTime?: TimeStamp;
/**
* An array of applications in the Firewall Manager applications list.
*/
AppsList: AppsList;
/**
* A map of previous version numbers to their corresponding App object arrays.
*/
PreviousAppsList?: PreviousAppsList;
}
export interface AppsListDataSummary {
/**
* The Amazon Resource Name (ARN) of the applications list.
*/
ListArn?: ResourceArn;
/**
* The ID of the applications list.
*/
ListId?: ListId;
/**
* The name of the applications list.
*/
ListName?: ResourceName;
/**
* An array of App objects in the Firewall Manager applications list.
*/
AppsList?: AppsList;
}
export type AppsListsData = AppsListDataSummary[];
export interface AssociateAdminAccountRequest {
/**
* The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager administrator account. This must be an Organizations member account. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.
*/
AdminAccount: AWSAccountId;
}
export interface AwsEc2InstanceViolation {
/**
* The resource ID of the EC2 instance.
*/
ViolationTarget?: ViolationTarget;
/**
* Violation detail for network interfaces associated with the EC2 instance.
*/
AwsEc2NetworkInterfaceViolations?: AwsEc2NetworkInterfaceViolations;
}
export interface AwsEc2NetworkInterfaceViolation {
/**
* The resource ID of the network interface.
*/
ViolationTarget?: ViolationTarget;
/**
* List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy.
*/
ViolatingSecurityGroups?: ResourceIdList;
}
export type AwsEc2NetworkInterfaceViolations = AwsEc2NetworkInterfaceViolation[];
export interface AwsVPCSecurityGroupViolation {
/**
* The security group rule that is being evaluated.
*/
ViolationTarget?: ViolationTarget;
/**
* A description of the security group that violates the policy.
*/
ViolationTargetDescription?: LengthBoundedString;
/**
* List of rules specified in the security group of the Firewall Manager policy that partially match the ViolationTarget rule.
*/
PartialMatches?: PartialMatches;
/**
* Remediation options for the rule specified in the ViolationTarget.
*/
PossibleSecurityGroupRemediationActions?: SecurityGroupRemediationActions;
}
export type BasicInteger = number;
export type Boolean = boolean;
export type CIDR = string;
export interface ComplianceViolator {
/**
* The resource ID.
*/
ResourceId?: ResourceId;
/**
* The reason that the resource is not protected by the policy.
*/
ViolationReason?: ViolationReason;
/**
* The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy.
*/
ResourceType?: ResourceType;
}
export type ComplianceViolators = ComplianceViolator[];
export type CustomerPolicyScopeId = string;
export type CustomerPolicyScopeIdList = CustomerPolicyScopeId[];
export type CustomerPolicyScopeIdType = "ACCOUNT"|"ORG_UNIT"|string;
export type CustomerPolicyScopeMap = {[key: string]: CustomerPolicyScopeIdList};
export interface DeleteAppsListRequest {
/**
* The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList, ListAppsLists, and GetAppsList.
*/
ListId: ListId;
}
export interface DeleteNotificationChannelRequest {
}
export interface DeletePolicyRequest {
/**
* The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and ListPolicies.
*/
PolicyId: PolicyId;
/**
* If True, the request performs cleanup according to the policy type. For WAF and Shield Advanced policies, the cleanup does the following: Deletes rule groups created by Firewall Manager Removes web ACLs from in-scope resources Deletes web ACLs that contain no rules or rule groups For security group policies, the cleanup does the following for each security group in the policy: Disassociates the security group from in-scope resources Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.
*/
DeleteAllPolicyResources?: Boolean;
}
export interface DeleteProtocolsListRequest {
/**
* The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.
*/
ListId: ListId;
}
export type DependentServiceName = "AWSCONFIG"|"AWSWAF"|"AWSSHIELD_ADVANCED"|"AWSVPC"|string;
export type DestinationType = "IPV4"|"IPV6"|"PREFIX_LIST"|string;
export type DetailedInfo = string;
export interface DisassociateAdminAccountRequest {
}
export interface DnsDuplicateRuleGroupViolation {
/**
* Information about the VPC ID.
*/
ViolationTarget?: ViolationTarget;
/**
* A description of the violation that specifies the rule group and VPC.
*/
ViolationTargetDescription?: LengthBoundedString;
}
export interface DnsRuleGroupLimitExceededViolation {
/**
* Information about the VPC ID.
*/
ViolationTarget?: ViolationTarget;
/**
* A description of the violation that specifies the rule group and VPC.
*/
ViolationTargetDescription?: LengthBoundedString;
/**
* The number of rule groups currently associated with the VPC.
*/
NumberOfRuleGroupsAlreadyAssociated?: BasicInteger;
}
export type DnsRuleGroupPriorities = DnsRuleGroupPriority[];
export type DnsRuleGroupPriority = number;
export interface DnsRuleGroupPriorityConflictViolation {
/**
* Information about the VPC ID.
*/
ViolationTarget?: ViolationTarget;
/**
* A description of the violation that specifies the VPC and the rule group that's already associated with it.
*/
ViolationTargetDescription?: LengthBoundedString;
/**
* The priority setting of the two conflicting rule groups.
*/
ConflictingPriority?: DnsRuleGroupPriority;
/**
* The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. This policy contains the rule group that's already associated with the VPC.
*/
ConflictingPolicyId?: PolicyId;
/**
* The priorities of rule groups that are already associated with the VPC. To retry your operation, choose priority settings that aren't in this list for the rule groups in your new DNS Firewall policy.
*/
UnavailablePriorities?: DnsRuleGroupPriorities;
}
export interface EC2AssociateRouteTableAction {
/**
* A description of the EC2 route table that is associated with the remediation action.
*/
Description?: LengthBoundedString;
/**
* The ID of the EC2 route table that is associated with the remediation action.
*/
RouteTableId: ActionTarget;
/**
* The ID of the subnet for the EC2 route table that is associated with the remediation action.
*/
SubnetId?: ActionTarget;
/**
* The ID of the gateway to be used with the EC2 route table that is associated with the remediation action.
*/
GatewayId?: ActionTarget;
}
export interface EC2CopyRouteTableAction {
/**
* A description of the copied EC2 route table that is associated with the remediation action.
*/
Description?: LengthBoundedString;
/**
* The VPC ID of the copied EC2 route table that is associated with the remediation action.
*/
VpcId: ActionTarget;
/**
* The ID of the copied EC2 route table that is associated with the remediation action.
*/
RouteTableId: ActionTarget;
}
export interface EC2CreateRouteAction {
/**
* A description of CreateRoute action in Amazon EC2.
*/
Description?: LengthBoundedString;
/**
* Information about the IPv4 CIDR address block used for the destination match.
*/
DestinationCidrBlock?: CIDR;
/**
* Information about the ID of a prefix list used for the destination match.
*/
DestinationPrefixListId?: ResourceId;
/**
* Information about the IPv6 CIDR block destination.
*/
DestinationIpv6CidrBlock?: CIDR;
/**
* Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
*/
VpcEndpointId?: ActionTarget;
/**
* Information about the ID of an internet gateway or virtual private gateway attached to your VPC.
*/
GatewayId?: ActionTarget;
/**
* Information about the ID of the route table for the route.
*/
RouteTableId: ActionTarget;
}
export interface EC2CreateRouteTableAction {
/**
* A description of the CreateRouteTable action.
*/
Description?: LengthBoundedString;
/**
* Information about the ID of a VPC.
*/
VpcId: ActionTarget;
}
export interface EC2DeleteRouteAction {
/**
* A description of the DeleteRoute action.
*/
Description?: LengthBoundedString;
/**
* Information about the IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
*/
DestinationCidrBlock?: CIDR;
/**
* Information about the ID of the prefix list for the route.
*/
DestinationPrefixListId?: ResourceId;
/**
* Information about the IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
*/
DestinationIpv6CidrBlock?: CIDR;
/**
* Information about the ID of the route table.
*/
RouteTableId: ActionTarget;
}
export interface EC2ReplaceRouteAction {
/**
* A description of the ReplaceRoute action in Amazon EC2.
*/
Description?: LengthBoundedString;
/**
* Information about the IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
*/
DestinationCidrBlock?: CIDR;
/**
* Information about the ID of the prefix list for the route.
*/
DestinationPrefixListId?: ResourceId;
/**
* Information about the IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
*/
DestinationIpv6CidrBlock?: CIDR;
/**
* Information about the ID of an internet gateway or virtual private gateway.
*/
GatewayId?: ActionTarget;
/**
* Information about the ID of the route table.
*/
RouteTableId: ActionTarget;
}
export interface EC2ReplaceRouteTableAssociationAction {
/**
* A description of the ReplaceRouteTableAssociation action in Amazon EC2.
*/
Description?: LengthBoundedString;
/**
* Information about the association ID.
*/
AssociationId: ActionTarget;
/**
* Information about the ID of the new route table to associate with the subnet.
*/
RouteTableId: ActionTarget;
}
export interface EvaluationResult {
/**
* Describes an Amazon Web Services account's compliance with the Firewall Manager policy.
*/
ComplianceStatus?: PolicyComplianceStatusType;
/**
* The number of resources that are noncompliant with the specified policy. For WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn't comply with the rules of the policy and remediation is disabled or not possible.
*/
ViolatorCount?: ResourceCount;
/**
* Indicates that over 100 resources are noncompliant with the Firewall Manager policy.
*/
EvaluationLimitExceeded?: Boolean;
}
export type EvaluationResults = EvaluationResult[];
export interface ExpectedRoute {
/**
* Information about the IPv4 CIDR block.
*/
IpV4Cidr?: CIDR;
/**
* Information about the ID of the prefix list for the route.
*/
PrefixListId?: CIDR;
/**
* Information about the IPv6 CIDR block.
*/
IpV6Cidr?: CIDR;
/**
* Information about the contributing subnets.
*/
ContributingSubnets?: ResourceIdList;
/**
* Information about the allowed targets.
*/
AllowedTargets?: LengthBoundedStringList;
/**
* Information about the route table ID.
*/
RouteTableId?: ResourceId;
}
export type ExpectedRoutes = ExpectedRoute[];
export interface GetAdminAccountRequest {
}
export interface GetAdminAccountResponse {
/**
* The Amazon Web Services account that is set as the Firewall Manager administrator.
*/
AdminAccount?: AWSAccountId;
/**
* The status of the Amazon Web Services account that you set as the Firewall Manager administrator.
*/
RoleStatus?: AccountRoleStatus;
}
export interface GetAppsListRequest {
/**
* The ID of the Firewall Manager applications list that you want the details for.
*/
ListId: ListId;
/**
* Specifies whether the list to retrieve is a default list owned by Firewall Manager.
*/
DefaultList?: Boolean;
}
export interface GetAppsListResponse {
/**
* Information about the specified Firewall Manager applications list.
*/
AppsList?: AppsListData;
/**
* The Amazon Resource Name (ARN) of the applications list.
*/
AppsListArn?: ResourceArn;
}
export interface GetComplianceDetailRequest {
/**
* The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.
*/
PolicyId: PolicyId;
/**
* The Amazon Web Services account that owns the resources that you want to get the details for.
*/
MemberAccount: AWSAccountId;
}
export interface GetComplianceDetailResponse {
/**
* Information about the resources and the policy that you specified in the GetComplianceDetail request.
*/
PolicyComplianceDetail?: PolicyComplianceDetail;
}
export interface GetNotificationChannelRequest {
}
export interface GetNotificationChannelResponse {
/**
* The SNS topic that records Firewall Manager activity.
*/
SnsTopicArn?: ResourceArn;
/**
* The IAM role that is used by Firewall Manager to record activity to SNS.
*/
SnsRoleName?: ResourceArn;
}
export interface GetPolicyRequest {
/**
* The ID of the Firewall Manager policy that you want the details for.
*/
PolicyId: PolicyId;
}
export interface GetPolicyResponse {
/**
* Information about the specified Firewall Manager policy.
*/
Policy?: Policy;
/**
* The Amazon Resource Name (ARN) of the specified policy.
*/
PolicyArn?: ResourceArn;
}
export interface GetProtectionStatusRequest {
/**
* The ID of the policy for which you want to get the attack information.
*/
PolicyId: PolicyId;
/**
* The Amazon Web Services account that is in scope of the policy that you want to get the details for.
*/
MemberAccountId?: AWSAccountId;
/**
* The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
*/
StartTime?: TimeStamp;
/**
* The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.
*/
EndTime?: TimeStamp;
/**
* If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.
*/
NextToken?: PaginationToken;
/**
* Specifies the number of objects that you want 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.
*/
MaxResults?: PaginationMaxResults;
}
export interface GetProtectionStatusResponse {
/**
* The ID of the Firewall Manager administrator account for this policy.
*/
AdminAccountId?: AWSAccountId;
/**
* The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.
*/
ServiceType?: SecurityServiceType;
/**
* 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.
*/
Data?: ProtectionData;
/**
* 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. Amazon Web Services 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.
*/
NextToken?: PaginationToken;
}
export interface GetProtocolsListRequest {
/**
* The ID of the Firewall Manager protocols list that you want the details for.
*/
ListId: ListId;
/**
* Specifies whether the list to retrieve is a default list owned by Firewall Manager.
*/
DefaultList?: Boolean;
}
export interface GetProtocolsListResponse {
/**
* Information about the specified Firewall Manager protocols list.
*/
ProtocolsList?: ProtocolsListData;
/**
* The Amazon Resource Name (ARN) of the specified protocols list.
*/
ProtocolsListArn?: ResourceArn;
}
export interface GetViolationDetailsRequest {
/**
* The ID of the Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.
*/
PolicyId: PolicyId;
/**
* The Amazon Web Services account ID that you want the details for.
*/
MemberAccount: AWSAccountId;
/**
* The ID of the resource that has violations.
*/
ResourceId: ResourceId;
/**
* The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance, AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup, AWS::NetworkFirewall::FirewallPolicy, and AWS::EC2::Subnet.
*/
ResourceType: ResourceType;
}
export interface GetViolationDetailsResponse {
/**
* Violation detail for a resource.
*/
ViolationDetail?: ViolationDetail;
}
export type IPPortNumber = number;
export type IssueInfoMap = {[key: string]: DetailedInfo};
export type LengthBoundedString = string;
export type LengthBoundedStringList = LengthBoundedString[];
export interface ListAppsListsRequest {
/**
* Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
*/
DefaultLists?: Boolean;
/**
* If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.
*/
NextToken?: PaginationToken;
/**
* The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects. If you don't specify this, Firewall Manager returns all available objects.
*/
MaxResults: PaginationMaxResults;
}
export interface ListAppsListsResponse {
/**
* An array of AppsListDataSummary objects.
*/
AppsLists?: AppsListsData;
/**
* If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.
*/
NextToken?: PaginationToken;
}
export interface ListComplianceStatusRequest {
/**
* The ID of the Firewall Manager policy that you want the details for.
*/
PolicyId: PolicyId;
/**
* If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.
*/
NextToken?: PaginationToken;
/**
* Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.
*/
MaxResults?: PaginationMaxResults;
}
export interface ListComplianceStatusResponse {
/**
* An array of PolicyComplianceStatus objects.
*/
PolicyComplianceStatusList?: PolicyComplianceStatusList;
/**
* If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.
*/
NextToken?: PaginationToken;
}
export type ListId = string;
export interface ListMemberAccountsRequest {
/**
* If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.
*/
NextToken?: PaginationToken;
/**
* Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.
*/
MaxResults?: PaginationMaxResults;
}
export interface ListMemberAccountsResponse {
/**
* An array of account IDs.
*/
MemberAccounts?: MemberAccounts;
/**
* If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.
*/
NextToken?: PaginationToken;
}
export interface ListPoliciesRequest {
/**
* If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, 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.
*/
NextToken?: PaginationToken;
/**
* Specifies the number of PolicySummary objects that you want 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.
*/
MaxResults?: PaginationMaxResults;
}
export interface ListPoliciesResponse {
/**
* An array of PolicySummary objects.
*/
PolicyList?: PolicySummaryList;
/**
* 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.
*/
NextToken?: PaginationToken;
}
export interface ListProtocolsListsRequest {
/**
* Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
*/
DefaultLists?: Boolean;
/**
* If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.
*/
NextToken?: PaginationToken;
/**
* The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a NextToken value that you can use in a subsequent call to get the next batch of objects. If you don't specify this, Firewall Manager returns all available objects.
*/
MaxResults: PaginationMaxResults;
}
export interface ListProtocolsListsResponse {
/**
* An array of ProtocolsListDataSummary objects.
*/
ProtocolsLists?: ProtocolsListsData;
/**
* If you specify a value for MaxResults in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to retrieve the next batch of objects.
*/
NextToken?: PaginationToken;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.
*/
ResourceArn: ResourceArn;
}
export interface ListTagsForResourceResponse {
/**
* The tags associated with the resource.
*/
TagList?: TagList;
}
export type ManagedServiceData = string;
export type MemberAccounts = AWSAccountId[];
export type NetworkFirewallAction = string;
export type NetworkFirewallActionList = NetworkFirewallAction[];
export interface NetworkFirewallBlackHoleRouteDetectedViolation {
/**
* The subnet that has an inactive state.
*/
ViolationTarget?: ViolationTarget;
/**
* Information about the route table ID.
*/
RouteTableId?: ResourceId;
/**
* Information about the VPC ID.
*/
VpcId?: ResourceId;
/**
* Information about the route or routes that are in violation.
*/
ViolatingRoutes?: Routes;
}
export interface NetworkFirewallInternetTrafficNotInspectedViolation {
/**
* The subnet ID.
*/
SubnetId?: ResourceId;
/**
* The subnet Availability Zone.
*/
SubnetAvailabilityZone?: LengthBoundedString;
/**
* Information about the route table ID.
*/
Route