openapi: 3.2.0 info: contact: {} description: "The V2 API provides enhanced operations for managing Cloud NGFW resources. This version introduces new features and improvements for firewall management, including support for managing firewalls by ID and name, content version updates, and feature management.\n\n### Key Features\n\n- Manage firewalls by firewall ID or firewall name\n- Update firewall content versions\n- Configure firewall features \n- Link firewalls across accounts\n- Enhanced log profile and rulestack management\n\n### Permission Policies\n\n| Action | Local Firewall Administrator | Local Rulestack Administrator | Global Rulestack Administrator |\n| -------------------------------------- | :---------------------------: | :---------------------------: | :----------------------------: |\n| Create/Delete Firewall | **☑** | ☐ | ☐ |\n| Update Firewall | **☑** | ☐ | ☐ |\n| Manage Firewall Features | **☑** | ☐ | ☐ |\n| Link Accounts | **☑** | ☐ | ☐ |\n" title: Manage Cloud NGFW (V2) Manage NGFW V2 API version: 1.0.0 servers: - url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com tags: - name: ManageNGFW-V2 paths: /v2/linkaccounts: delete: description: 'Delete a link account from V2 API configuration. ' operationId: delete-v2-linkaccounts parameters: - description: Authorization in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.DeleteLinkAccountAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.DeleteLinkAccountAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.DeleteLinkAccountAPIOutput' description: Bad Request summary: Delete link account tags: - ManageNGFW-V2 get: description: 'List all link accounts configured for V2 API. ' operationId: get-v2-linkaccounts parameters: - description: Max results in: query name: maxresults schema: type: string - description: describe the Accounts in: query name: describe schema: type: string - description: Next token in: query name: nexttoken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.ListLinkAccountsAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.ListLinkAccountsAPIOutput' description: Bad Request summary: List link accounts tags: - ManageNGFW-V2 post: description: 'Create a new link account for V2 API access. ' operationId: post-v2-linkaccounts parameters: - description: Authorization in: header name: Authorization required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.CreateLinkAccountAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.CreateLinkAccountAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.CreateLinkAccountAPIOutput' description: Bad Request summary: Create link account tags: - ManageNGFW-V2 /v2/ngfirewalls: get: description: 'List all Cloud NGFW resources in your account using V2 API. ' operationId: get-v2-ngfirewalls-v2 parameters: - description: FW region in: query name: region required: true schema: type: string - description: Max results in: query name: maxresults schema: type: string - description: describe the FW in: query name: describe schema: type: string - description: Next token in: query name: nexttoken schema: type: string - description: rulestack name in: query name: rulestackname schema: type: string - description: global rulestack name in: query name: globalrulestackname schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.ListFirewallsAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.ListFirewallsAPIOutput' description: Bad Request summary: List V2 firewalls tags: - ManageNGFW-V2 post: description: 'Create a new Cloud NGFW resource using V2 API. ' operationId: post-v2-ngfirewalls-v2 parameters: - description: FW region in: query name: region required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.CreateFirewallAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.CreateFirewallAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.CreateFirewallAPIOutput' description: Bad Request summary: Create V2 firewall tags: - ManageNGFW-V2 /v2/ngfirewalls/: get: description: 'List V1 firewalls using V2 endpoint. ' operationId: get-v2-ngfirewalls-v1 parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.ListFirewallsAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.ListFirewallsAPIOutput' description: Bad Request summary: List V1 firewalls tags: - ManageNGFW-V2 post: description: 'Create V1 firewalls using V2 endpoint. ' operationId: post-v2-ngfirewalls-v1 parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.CreateFirewallAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.CreateFirewallAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.CreateFirewallAPIOutput' description: Bad Request summary: Create V1 firewall tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_id}: delete: description: 'Delete a specific firewall by firewall ID. ' operationId: delete-v2-ngfirewalls-firewall_id parameters: - description: FW region in: query name: region required: true schema: type: string - description: 'The unique identifier of the firewall. ' in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.DeleteFirewallAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.DeleteFirewallAPIOutput' description: Bad Request summary: Delete firewall by ID tags: - ManageNGFW-V2 get: description: 'Retrieve details of a specific firewall by firewall ID. ' operationId: get-v2-ngfirewalls-firewall_id parameters: - description: FW region in: query name: region required: true schema: type: string - description: 'The unique identifier of the firewall. ' in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.ReadFirewallAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.ReadFirewallAPIOutput' description: Bad Request summary: Retrieve firewall by ID tags: - ManageNGFW-V2 patch: description: update ngfirewall operationId: patch-v2-ngfirewalls-firewall_id parameters: - description: FW region in: query name: region required: true schema: type: string - description: Firewall ID in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.UpdateFirewallAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.UpdateFirewallAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.UpdateFirewallAPIOutput' description: Bad Request summary: update ngfirewall tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_id}/link: delete: description: disassociate fw link operationId: delete-v2-ngfirewalls-firewall_id-link parameters: - description: FW region in: query name: region required: true schema: type: string - description: Firewall ID in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.DisassociateLinkInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.DisassociateLinkOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.DisassociateLinkOutput' description: Bad Request summary: disassociate fw link tags: - ManageNGFW-V2 post: description: associate fw link operationId: post-v2-ngfirewalls-firewall_id-link parameters: - description: FW region in: query name: region required: true schema: type: string - description: Firewall ID in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.AssociateLinkInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.AssociateLinkOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.AssociateLinkOutput' description: Bad Request summary: associate fw link tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_id}/logprofile: get: description: read logprofile operationId: get-v2-ngfirewalls-firewall_id-logprofile parameters: - description: FW region in: query name: region required: true schema: type: string - description: Firewall ID in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.ReadLogProfileInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.ReadLogProfileOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.ReadLogProfileOutput' description: Bad Request summary: read logprofile tags: - ManageNGFW-V2 post: description: update logprofile operationId: post-v2-ngfirewalls-firewall_id-logprofile parameters: - description: FW region in: query name: region required: true schema: type: string - description: Firewall ID in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.UpdateLogProfileInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.UpdateLogProfileOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.UpdateLogProfileOutput' description: Bad Request summary: update logprofile tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_id}/rulestack: delete: description: disassociate rulestack operationId: delete-v2-ngfirewalls-firewall_id-rulestack parameters: - description: FW region in: query name: region required: true schema: type: string - description: Firewall ID in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.DisassociateRuleStackInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.DisassociateRuleStackOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.DisassociateRuleStackOutput' description: Bad Request summary: disassociate rulestack tags: - ManageNGFW-V2 post: description: associate rulestack operationId: post-v2-ngfirewalls-firewall_id-rulestack parameters: - description: FW region in: query name: region required: true schema: type: string - description: Firewall ID in: path name: firewall_id required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v2.AssociateRuleStackInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v2.AssociateRuleStackOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v2.AssociateRuleStackOutput' description: Bad Request summary: associate rulestack tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}: delete: description: v1 delete firewall operationId: delete-v2-ngfirewalls-firewall_name parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.DeleteFirewallAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.DeleteFirewallAPIOutput' description: Bad Request summary: v1 delete firewall tags: - ManageNGFW-V2 get: description: 'Retrieve details of a specific firewall by firewall name. ' operationId: get-v2-ngfirewalls-firewall_name parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.ReadFirewallAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.ReadFirewallAPIOutput' description: Bad Request summary: Retrieve firewall by name tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}/contentversion: put: description: 'Update the content version for a firewall by firewall name. ' operationId: put-v2-ngfirewalls-firewall_name-contentversion parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.UpdateContentVersionAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateContentVersionAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateContentVersionAPIOutput' description: Bad Request summary: Update firewall content version tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}/description: put: description: 'Update the description of a firewall by firewall name. ' operationId: put-v2-ngfirewalls-firewall_name-description parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.UpdateDescriptionAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateDescriptionAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateDescriptionAPIOutput' description: Bad Request summary: Update firewall description tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}/features: put: description: 'Configure firewall features by firewall name. ' operationId: put-v2-ngfirewalls-firewall_name-features parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.UpdateFeaturesAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateFeaturesAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateFeaturesAPIOutput' description: Bad Request summary: Configure firewall features tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}/logprofile: get: description: v1 read logprofile operationId: get-v2-ngfirewalls-firewall_name-logprofile parameters: - description: FW region in: query name: region required: true schema: type: string - description: account id in: query name: accountid required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.ReadLogProfileAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.ReadLogProfileAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.ReadLogProfileAPIOutput' description: Bad Request summary: v1 read logprofile tags: - ManageNGFW-V2 post: description: v1 update logprofile operationId: post-v2-ngfirewalls-firewall_name-logprofile parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.UpdateLogProfileAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateLogProfileAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateLogProfileAPIOutput' description: Bad Request summary: v1 update logprofile tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}/rulestack: post: description: v1 associate rulestack operationId: post-v2-ngfirewalls-firewall_name-rulestack parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: string - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.AssociateRuleStackAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.AssociateRuleStackAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.AssociateRuleStackAPIOutput' description: Bad Request summary: v1 associate rulestack tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}/subnets: post: description: v1 update subnet mappings operationId: post-v2-ngfirewalls-firewall_name-subnets parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.UpdateSubnetMappingsAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateSubnetMappingsAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateSubnetMappingsAPIOutput' description: Bad Request summary: v1 update subnet mappings tags: - ManageNGFW-V2 /v2/ngfirewalls/{firewall_name}/tags: delete: description: 'Remove tags from a firewall by firewall name. ' operationId: delete-v2-ngfirewalls-firewall_name-tags parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.DeleteTagsAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.DeleteTagsAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.DeleteTagsAPIOutput' description: Bad Request summary: Remove firewall tags tags: - ManageNGFW-V2 get: description: 'List tags for a firewall by firewall name. ' operationId: get-v2-ngfirewalls-firewall_name-tags parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.ListTagsAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.ListTagsAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.ListTagsAPIOutput' description: Bad Request summary: Retrieve firewall tags tags: - ManageNGFW-V2 post: description: 'Add tags to a firewall by firewall name. ' operationId: post-v2-ngfirewalls-firewall_name-tags parameters: - description: FW region in: query name: region required: true schema: type: string - description: v1 route in: query name: v1route required: true schema: type: boolean - description: Authorization in: header name: Authorization required: true schema: type: string - description: x-api-key in: header name: x-api-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.UpdateTagsAPIInput' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateTagsAPIOutput' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/v1.UpdateTagsAPIOutput' description: Bad Request summary: Add firewall tags tags: - ManageNGFW-V2 components: schemas: model.Notification: properties: ExpiryTime: type: integer Id: type: string Link: $ref: '#/components/schemas/model.NotificationLink' Msg: type: string type: object v1.AssociateRuleStackResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string RuleStackName: maxLength: 128 minLength: 1 type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallName - RuleStackName type: object v1.DeleteTagsAPIOutput: properties: Response: $ref: '#/components/schemas/v1.DeleteTagsResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object model.UserIDConfig: properties: AgentName: type: string CFTURLLink: type: string CollectorName: type: string CustomIncludeExcludeNetwork: items: $ref: '#/components/schemas/model.UserIDCustomSubnetFilter' type: array Enabled: type: boolean EndpointDNS: type: string Port: type: integer SecretKeyARN: type: string UserIDStatus: enum: - EndpointPending - EndpointFail - CommitFail - Enabled - Disabled - DisablePending - UpdatePending - UpdateFail type: string type: object model.ResourceStatus: properties: DeviceRuleStackCommitInfo: $ref: '#/components/schemas/model.RuleStackCommitData' DeviceRuleStackCommitState: enum: - Submitted - None type: string DeviceRuleStackCommitStatus: enum: - Running - Uncommitted - Precommit - PrecommitDone - PrevalidateDone - Committing - Failed - Success type: string FailureReason: type: string FirewallStatus: enum: - CREATING - UPDATING - DELETING - CREATE_COMPLETE - UPDATE_COMPLETE - CREATE_FAIL - UPDATE_FAIL - DELETE_FAIL - DELETE_COMPLETE type: string GlobalRuleStackCommitInfo: $ref: '#/components/schemas/model.RuleStackCommitData' GlobalRuleStackStatus: enum: - Running - Uncommitted - Precommit - PrecommitDone - PrevalidateDone - Committing - Failed - Success type: string PublicIPs: items: $ref: '#/components/schemas/model.PublicIP' type: array RuleStackCommitInfo: $ref: '#/components/schemas/model.RuleStackCommitData' RuleStackStatus: enum: - Running - Uncommitted - Precommit - PrecommitDone - PrevalidateDone - Committing - Failed - Success type: string SCMAssocStatus: type: boolean type: object v1.CreateFirewallAPIOutput: properties: Response: $ref: '#/components/schemas/v1.CreateFirewallAPIResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.ListTagsAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string required: - FirewallName type: object model.FirewallRoles: properties: EndpointRole: type: string LoggingRole: type: string type: object v1.CreateFirewallAPIResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string Description: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' EndpointMode: enum: - ServiceManaged - CustomerManaged type: string FirewallName: type: string GlobalRuleStackName: maxLength: 128 minLength: 1 type: string LinkId: type: string LinkStatus: type: string MultiVpcEnable: type: boolean PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' RuleStackName: maxLength: 128 minLength: 1 type: string SecurityZones: items: $ref: '#/components/schemas/model.EndpointConfig' type: array SubnetMappings: items: $ref: '#/components/schemas/model.SubnetMapping' type: array Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: type: string UserID: $ref: '#/components/schemas/model.UserIDConfig' VpcId: type: string required: - AccountId - EndpointMode - FirewallName - SubnetMappings - VpcId type: object v1.ListFirewallsAPIOutput: properties: Response: $ref: '#/components/schemas/v1.ListFirewallsResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.UpdateTagsResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array required: - FirewallName type: object model.LogConfig: properties: AccountId: maxLength: 12 minLength: 12 type: string LogDestination: type: string LogDestinationType: enum: - S3 - CloudWatchLogs - KinesisDataFirehose type: string LogType: items: enum: - TRAFFIC - DECRYPTION - THREAT - USER_ID type: string type: array RoleType: enum: - ResourceBased - IamBased type: string required: - LogDestination - LogDestinationType - LogType - RoleType type: object v2.ReadFirewallResource: properties: AdvancedThreatLog: type: boolean AllowListAccounts: items: type: string type: array ChangeProtection: items: type: string type: array CloudwatchMetrics: $ref: '#/components/schemas/model.CloudwatchMetrics' CustomerZoneIdList: items: type: string type: array DeploymentUpdateToken: type: string Description: type: string DeviceRuleStackCommitStatus: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' EndpointServiceName: type: string Endpoints: items: $ref: '#/components/schemas/model.EndpointConfig' type: array FirewallId: type: string GWLB: $ref: '#/components/schemas/model.GWLBConfig' GlobalRuleStackName: maxLength: 128 minLength: 1 type: string Ipv6: $ref: '#/components/schemas/model.Ipv6Config' LinkId: type: string LinkStatus: type: string LogConfig: $ref: '#/components/schemas/v2.ReadLogConfig' Notifications: items: $ref: '#/components/schemas/model.Notification' type: array PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' Region: type: string RuleStackName: maxLength: 128 minLength: 1 type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: type: string UserID: $ref: '#/components/schemas/model.UserIDConfig' required: - CustomerZoneIdList type: object model.NotificationLink: properties: Target: type: string Text: type: string type: object v2.CreateFirewallAPIInput: properties: AllowListAccounts: items: type: string maxItems: 300 type: array ChangeProtection: items: type: string type: array CustomerZoneIdList: items: type: string type: array Description: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' GlobalRuleStackName: maxLength: 128 minLength: 1 type: string LinkId: type: string RuleStackName: maxLength: 128 minLength: 1 type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array required: - CustomerZoneIdList type: object model.PrivateAccessConfig: properties: ResourceID: type: string Type: enum: - NetworkLoadBalancer type: string type: object model.UserIDCustomSubnetFilter: properties: DiscoveryInclude: type: boolean Enabled: type: boolean Name: type: string NetworkAddress: type: string type: object v1.UpdateFeaturesAPIOutput: properties: Response: $ref: '#/components/schemas/v1.UpdateFeaturesAPIResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.UpdateDescriptionAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string Description: type: string FirewallName: type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - Description - FirewallName type: object v2.AssociateLinkOutput: properties: Response: $ref: '#/components/schemas/v2.AssociateLinkResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.DisassociateRuleStackResponse: properties: FirewallId: type: string RuleStackName: maxLength: 128 type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallId - UpdateToken type: object v2.UpdateLogProfileInput: properties: AdvancedThreatLog: type: boolean CloudwatchMetrics: $ref: '#/components/schemas/model.CloudwatchMetrics' LogConfig: $ref: '#/components/schemas/model.LogConfig' UpdateToken: maxLength: 1024 minLength: 1 type: string type: object model.TagEntry: properties: Key: maxLength: 128 minLength: 1 type: string Value: maxLength: 256 minLength: 1 type: string type: object v1.Features: properties: EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' SecurityZones: items: $ref: '#/components/schemas/model.EndpointConfig' type: array UserID: $ref: '#/components/schemas/v2.UserIDRequest' type: object v2.EndpointRequest: properties: AccountId: maxLength: 12 minLength: 12 type: string EgressNATEnabled: type: boolean EndpointId: type: string Mode: enum: - ServiceManaged - CustomerManaged type: string Prefixes: $ref: '#/components/schemas/model.PrefixInfo' SubnetId: type: string VpcId: type: string ZoneId: type: string required: - Mode type: object v2.DisassociateRuleStackInput: properties: RuleStackName: maxLength: 128 minLength: 1 type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - UpdateToken type: object v2.CreateLinkAccountAPIOutput: properties: Response: $ref: '#/components/schemas/v2.CreateLinkAccountAPIResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.ReadFirewallResponse: properties: Firewall: $ref: '#/components/schemas/v1.ReadFirewallResource' Status: $ref: '#/components/schemas/model.ResourceStatus' type: object v2.DisassociateLinkInput: properties: LinkId: type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - LinkId - UpdateToken type: object model.EndpointConfig: properties: AccountId: maxLength: 12 minLength: 12 type: string EgressNATEnabled: type: boolean EndpointId: type: string Mode: enum: - ServiceManaged - CustomerManaged type: string Prefixes: $ref: '#/components/schemas/model.PrefixInfo' RejectedReason: type: string Status: enum: - Pending - Accepted - Rejected - Created - Creating - Deleting type: string SubnetId: type: string VpcId: type: string ZoneId: type: string required: - Mode type: object v1.UpdateFeaturesAPIResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string Features: $ref: '#/components/schemas/v1.Features' FirewallName: type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallName type: object v1.UpdateSubnetMappingsAPIOutput: properties: Response: $ref: '#/components/schemas/v1.UpdateSubnetMappingsAPIResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.AssociateRuleStackInput: properties: AccountId: maxLength: 12 minLength: 12 type: string RuleStackName: maxLength: 128 minLength: 1 type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - RuleStackName - UpdateToken type: object v2.ListLinkAccountsResponse: properties: AccountDetails: items: $ref: '#/components/schemas/v2.AccountDetails' type: array AccountIds: items: type: string type: array MpRegion: type: string NextToken: type: string XAccountDetails: items: $ref: '#/components/schemas/v2.ListLinkAccountXaccountDetails' type: array type: object v1.DeleteTagsAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string TagKeys: items: maxLength: 128 type: string maxItems: 128 type: array required: - FirewallName - TagKeys type: object v1.ReadLogProfileAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string required: - FirewallName type: object v1.UpdateDescriptionAPIOutput: properties: Response: $ref: '#/components/schemas/v1.UpdateDescriptionResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.AssociateLinkResponse: properties: FirewallId: type: string LinkId: type: string LinkStatus: enum: - Active - Updating type: string UpdateToken: maxLength: 1024 type: string required: - FirewallId - LinkId - UpdateToken type: object v2.UpdateFirewallAPIOutput: properties: Response: $ref: '#/components/schemas/v2.UpdateResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.LogDestinationConfig: properties: LogDestination: type: string LogDestinationType: enum: - S3 - CloudWatchLogs - KinesisDataFirehose type: string LogType: enum: - TRAFFIC - DECRYPTION - THREAT - USER_ID type: string required: - LogDestination - LogDestinationType - LogType type: object v2.ReadLogProfileInput: type: object v1.ReadLogProfileResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string AdvancedThreatLog: type: boolean CloudWatchMetricNamespace: type: string CloudWatchMetricsFields: items: type: string type: array FirewallId: type: string FirewallName: type: string LogDestinationConfigs: items: $ref: '#/components/schemas/v1.LogDestinationConfig' type: array required: - FirewallName type: object v2.DeleteLinkAccountAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string required: - AccountId type: object model.PublicIP: properties: IPAddress: type: string IPSource: type: string IPStatus: type: string type: object v1.ReadLogProfileAPIOutput: properties: Response: $ref: '#/components/schemas/v1.ReadLogProfileResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object model.CloudwatchMetrics: properties: AccountId: maxLength: 12 minLength: 12 type: string CloudWatchMetricNamespace: type: string CloudWatchMetricsFields: items: type: string type: array required: - AccountId - CloudWatchMetricNamespace type: object model.GWLBConfig: properties: DeregistrationDelay: default: 300 type: integer RejectedFlowCountAlertThreshold: default: 10 type: integer RejectedFlowCountTCPAlertThreshold: default: 10 type: integer SessionRebalanceEnabled: default: false description: Omitempty skips creation of the field when false type: boolean TCPIdleTimeout: default: 350 type: integer type: object v1.AssociateRuleStackAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string RuleStackName: maxLength: 128 minLength: 1 type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallName - RuleStackName type: object v1.UpdateLogProfileAPIOutput: properties: Response: $ref: '#/components/schemas/v1.UpdateLogProfileResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.DeleteLinkAccountResponse: properties: AccountId: type: string ExternalId: type: string Organization: type: string type: object v1.ListTagsAPIOutput: properties: Response: $ref: '#/components/schemas/v1.ListTagsResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.DeleteFirewallAPIOutput: properties: Response: $ref: '#/components/schemas/v1.FirewallResource' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.CreateFirewallAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string Description: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' EndpointMode: enum: - ServiceManaged - CustomerManaged type: string FirewallName: type: string GlobalRuleStackName: maxLength: 128 minLength: 1 type: string LinkId: type: string MultiVpcEnable: type: boolean RuleStackName: maxLength: 128 minLength: 1 type: string SubnetMappings: items: $ref: '#/components/schemas/model.SubnetMapping' type: array Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array VpcId: type: string required: - AccountId - EndpointMode - FirewallName - SubnetMappings - VpcId type: object v2.ListFirewallsResponse: properties: Firewalls: items: $ref: '#/components/schemas/v2.FirewallInfo' type: array FirewallsDescribe: items: $ref: '#/components/schemas/v2.FirewallInfoDescribe' type: array NextToken: type: string type: object v1.UpdateLogProfileResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string AdvancedThreatLog: type: boolean CloudWatchMetricNamespace: type: string CloudWatchMetricsFields: items: type: string type: array FirewallId: type: string FirewallName: type: string LogDestinationConfigs: items: $ref: '#/components/schemas/v1.LogDestinationConfig' type: array required: - FirewallName type: object v1.UpdateLogProfileAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string AdvancedThreatLog: type: boolean CloudWatchMetricNamespace: type: string CloudWatchMetricsFields: items: type: string type: array FirewallName: type: string LogDestinationConfigs: items: $ref: '#/components/schemas/v1.LogDestinationConfig' type: array required: - FirewallName type: object model.Ipv6Config: properties: Enabled: type: boolean type: object v2.AssociateRuleStackOutput: properties: Response: $ref: '#/components/schemas/v2.AssociateRuleStackResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.CreateFirewallAPIResponse: properties: AllowListAccounts: items: type: string maxItems: 300 type: array ChangeProtection: items: type: string type: array CustomerZoneIdList: items: type: string type: array Description: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' FirewallId: type: string GlobalRuleStackName: maxLength: 128 minLength: 1 type: string LinkId: type: string RuleStackName: maxLength: 128 minLength: 1 type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: type: string required: - CustomerZoneIdList type: object v1.ReadFirewallAPIOutput: properties: Response: $ref: '#/components/schemas/v1.ReadFirewallResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.UserIDRequest: properties: AgentName: type: string CollectorName: type: string CustomIncludeExcludeNetwork: items: $ref: '#/components/schemas/model.UserIDCustomSubnetFilter' type: array Enabled: type: boolean Port: type: integer SecretKeyARN: type: string type: object model.RuleStackCommitData: properties: CommitMessages: items: type: string type: array CommitTS: type: string type: object v1.DeleteTagsResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string TagKeys: items: maxLength: 128 type: string maxItems: 128 type: array required: - FirewallName - TagKeys type: object v2.UpdateLogProfileOutput: properties: Response: $ref: '#/components/schemas/v2.UpdateLogProfileResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object model.EgressNATSettings: properties: IPAMPoolId: type: string IPPoolType: enum: - AWSService - BYOIP type: string type: object v2.DeleteFirewallAPIResponse: properties: AllowListAccounts: items: type: string type: array ChangeProtection: items: type: string type: array CustomerZoneIdList: items: type: string type: array Description: type: string DeviceRuleStackCommitStatus: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' Endpoints: items: $ref: '#/components/schemas/model.EndpointConfig' type: array FirewallId: type: string FirewallStatus: type: string GWLB: $ref: '#/components/schemas/model.GWLBConfig' GlobalRuleStackName: maxLength: 128 minLength: 1 type: string Ipv6: $ref: '#/components/schemas/model.Ipv6Config' LinkId: type: string PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' RuleStackName: maxLength: 128 minLength: 1 type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: type: string UserID: $ref: '#/components/schemas/model.UserIDConfig' required: - CustomerZoneIdList type: object v2.AssociateLinkInput: properties: LinkId: type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - LinkId - UpdateToken type: object v1.ListFirewallsResponse: properties: Firewalls: items: $ref: '#/components/schemas/v1.FirewallInfo' type: array FirewallsDescribe: items: $ref: '#/components/schemas/v1.ReadFirewallResponse' type: array NextToken: type: string type: object v2.CreateFirewallAPIOutput: properties: Response: $ref: '#/components/schemas/v2.CreateFirewallAPIResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.UpdateLogProfileResponse: properties: AdvancedThreatLog: type: boolean CloudwatchMetrics: $ref: '#/components/schemas/model.CloudwatchMetrics' FirewallId: type: string LogConfig: $ref: '#/components/schemas/model.LogConfig' Region: type: string UpdateToken: type: string type: object v2.ReadLogConfig: properties: AccountId: maxLength: 12 minLength: 12 type: string LogDestination: type: string LogDestinationRegion: type: string LogDestinationType: enum: - S3 - CloudWatchLogs - KinesisDataFirehose type: string LogType: items: enum: - TRAFFIC - DECRYPTION - THREAT - USER_ID type: string type: array RoleType: enum: - ResourceBased - IamBased type: string required: - LogDestination - LogDestinationType - LogType - RoleType type: object v1.UpdateSubnetMappingsAPIResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string MultiVpcEnable: type: boolean SubnetMappings: items: $ref: '#/components/schemas/model.SubnetMapping' type: array UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallName type: object v2.DisassociateRuleStackOutput: properties: Response: $ref: '#/components/schemas/v2.DisassociateRuleStackResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.ReadLogProfileResponse: properties: AdvancedThreatLog: type: boolean CloudwatchMetrics: $ref: '#/components/schemas/model.CloudwatchMetrics' FirewallId: type: string LogConfig: $ref: '#/components/schemas/model.LogConfig' Region: type: string UpdateToken: type: string type: object model.PrefixInfo: properties: PrivatePrefix: $ref: '#/components/schemas/model.PrefixConfig' PublicPrefix: $ref: '#/components/schemas/model.PrefixConfig' type: object v2.FirewallInfoDescribe: properties: Firewall: $ref: '#/components/schemas/v2.ReadFirewallResource' Status: $ref: '#/components/schemas/model.ResourceStatus' type: object v2.ReadFirewallAPIOutput: properties: Response: $ref: '#/components/schemas/v2.FirewallInfoDescribe' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.ReadLogProfileOutput: properties: Response: $ref: '#/components/schemas/v2.ReadLogProfileResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.CreateLinkAccountAPIInput: properties: AWSMarketplaceToken: type: string AccountId: maxLength: 12 minLength: 12 type: string AgreementId: type: string EnableCFTRoleURLCreation: type: boolean EndpointMode: enum: - ServiceManaged - CustomerManaged type: string Existing: type: boolean OnboardingRegion: type: string Origin: default: CloudNGFWConsole enum: - AWSMarketplace - CloudNGFWConsole - ProgrammaticAccess type: string ProductId: type: string type: object v1.UpdateDescriptionResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string Description: type: string FirewallName: type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - Description - FirewallName type: object v1.UpdateContentVersionResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string AppIdVersion: type: string AutomaticUpgradeAppIdVersion: type: boolean FirewallName: type: string required: - FirewallName type: object v2.DeleteFirewallAPIOutput: properties: Response: $ref: '#/components/schemas/v2.DeleteFirewallAPIResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.AccountDetails: properties: AccountId: type: string CloudFormationTemplateURL: type: string ExternalId: type: string OnboardingStatus: type: string PrimaryAccount: type: boolean ServiceAccountId: type: string SnsTopicArn: type: string UpdateToken: type: string type: object v1.ReadFirewallResource: properties: AccountId: type: string AppIdVersion: type: string AutomaticUpgradeAppIdVersion: type: boolean Description: type: string DeviceRuleStackCommitStatus: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' EndpointMode: type: string EndpointServiceName: type: string FirewallId: type: string FirewallName: type: string GlobalRuleStackName: maxLength: 128 minLength: 1 type: string LinkId: type: string LinkStatus: type: string MultiVpcEnable: type: boolean Notifications: items: $ref: '#/components/schemas/model.Notification' type: array PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' RuleStackName: maxLength: 128 minLength: 1 type: string SecurityZones: items: $ref: '#/components/schemas/model.EndpointConfig' type: array SubnetMappings: items: $ref: '#/components/schemas/model.SubnetMapping' type: array Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: type: string UserID: $ref: '#/components/schemas/model.UserIDConfig' VpcId: type: string type: object v2.DeleteLinkAccountAPIOutput: properties: Response: $ref: '#/components/schemas/v2.DeleteLinkAccountResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.ListLinkAccountsAPIOutput: properties: Response: $ref: '#/components/schemas/v2.ListLinkAccountsResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.UpdateSubnetMappingsAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string AssociateSubnetMappings: items: $ref: '#/components/schemas/model.SubnetMapping' type: array DisassociateSubnetMappings: items: $ref: '#/components/schemas/model.SubnetMapping' type: array FirewallName: type: string MultiVpcEnable: type: boolean UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallName type: object v2.ListFirewallsAPIOutput: properties: Response: $ref: '#/components/schemas/v2.ListFirewallsResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object model.PrefixConfig: properties: Cidrs: items: type: string type: array type: object v1.UpdateTagsAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array required: - FirewallName - Tags type: object model.SubnetMapping: properties: AvailabilityZone: type: string AvailabilityZoneId: type: string SubnetId: type: string type: object model.RuleStackRoles: properties: DecryptionRole: type: string NetworkMonitoringRole: type: string type: object response.ResponseStatus: properties: ErrorCode: type: integer Reason: type: string type: object v2.AssociateRuleStackResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallId: type: string RuleStackName: maxLength: 128 minLength: 1 type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallId - RuleStackName - UpdateToken type: object v2.FirewallInfo: properties: FirewallId: type: string Region: type: string type: object v1.AssociateRuleStackAPIOutput: properties: Response: $ref: '#/components/schemas/v1.AssociateRuleStackResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.ListLinkAccountXaccountDetails: properties: AccountId: type: string AllowedMode: type: string CloudTrailRole: type: string DefaultRole: type: string Firewall: $ref: '#/components/schemas/model.FirewallRoles' RuleStack: $ref: '#/components/schemas/model.RuleStackRoles' type: object v1.FirewallResource: properties: AccountId: type: string AppIdVersion: type: string AutomaticUpgradeAppIdVersion: type: boolean Description: type: string DeviceRuleStackCommitStatus: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' EndpointMode: type: string FirewallName: type: string GlobalRuleStackName: maxLength: 128 minLength: 1 type: string LinkId: type: string LinkStatus: type: string MultiVpcEnable: type: boolean PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' RuleStackName: maxLength: 128 minLength: 1 type: string SecurityZones: items: $ref: '#/components/schemas/model.EndpointConfig' type: array SubnetMappings: items: $ref: '#/components/schemas/model.SubnetMapping' type: array Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: type: string UserID: $ref: '#/components/schemas/model.UserIDConfig' VpcId: type: string type: object v2.DisassociateLinkOutput: properties: Response: $ref: '#/components/schemas/v2.DisassociateLinkResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object model.EgressNATConfig: properties: Enabled: type: boolean Settings: $ref: '#/components/schemas/model.EgressNATSettings' type: object v2.UpdateResponse: properties: AllowListAccounts: items: type: string type: array ChangeProtection: items: type: string type: array CustomerZoneIdList: items: type: string type: array DeploymentUpdateToken: type: string Description: type: string DeviceRuleStackCommitStatus: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' Endpoints: items: $ref: '#/components/schemas/model.EndpointConfig' type: array FirewallId: type: string GWLB: $ref: '#/components/schemas/model.GWLBConfig' GlobalRuleStackName: maxLength: 128 minLength: 1 type: string GwlbTcpIdleTimeout: maximum: 3600 minimum: 0 type: integer Ipv6: $ref: '#/components/schemas/model.Ipv6Config' LinkId: type: string PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' Region: type: string RuleStackName: maxLength: 128 minLength: 1 type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: type: string UserID: $ref: '#/components/schemas/model.UserIDConfig' required: - CustomerZoneIdList type: object v1.FirewallInfo: properties: AccountId: type: string FirewallName: type: string type: object v1.UpdateFeaturesAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string Features: $ref: '#/components/schemas/v1.Features' FirewallName: type: string UpdateToken: maxLength: 1024 minLength: 1 type: string required: - FirewallName type: object v1.UpdateContentVersionAPIInput: properties: AccountId: maxLength: 12 minLength: 12 type: string AppIdVersion: type: string AutomaticUpgradeAppIdVersion: type: boolean FirewallName: type: string required: - FirewallName type: object v2.UpdateFirewallAPIInput: properties: AllowListAccounts: items: type: string maxItems: 300 type: array ChangeProtection: items: type: string type: array CustomerZoneIdList: items: type: string type: array DeploymentUpdateToken: maxLength: 1024 minLength: 1 type: string Description: type: string EgressNAT: $ref: '#/components/schemas/model.EgressNATConfig' Endpoints: items: $ref: '#/components/schemas/v2.EndpointRequest' type: array GwlbTcpIdleTimeout: maximum: 3600 minimum: 0 type: integer PrivateAccess: $ref: '#/components/schemas/model.PrivateAccessConfig' Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array UpdateToken: maxLength: 1024 minLength: 1 type: string UserID: $ref: '#/components/schemas/v2.UserIDRequest' required: - DeploymentUpdateToken - UpdateToken type: object v2.DisassociateLinkResponse: properties: FirewallId: type: string LinkStatus: enum: - Active - Updating type: string UpdateToken: type: string required: - FirewallId - UpdateToken type: object v1.UpdateTagsAPIOutput: properties: Response: $ref: '#/components/schemas/v1.UpdateTagsResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v1.ListTagsResponse: properties: AccountId: maxLength: 12 minLength: 12 type: string FirewallName: type: string Tags: items: $ref: '#/components/schemas/model.TagEntry' maxItems: 50 type: array required: - FirewallName type: object v1.UpdateContentVersionAPIOutput: properties: Response: $ref: '#/components/schemas/v1.UpdateContentVersionResponse' ResponseStatus: $ref: '#/components/schemas/response.ResponseStatus' type: object v2.CreateLinkAccountAPIResponse: properties: AccountId: type: string CFTRoleURL: type: string EndpointMode: type: string Existing: type: boolean ExternalId: type: string Origin: type: string SNSTopicArn: type: string SecretsToken: type: string ServiceAccountId: type: string type: object