{ "smithy": "2.0", "shapes": { "com.amazonaws.networksecuritymanager#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "
You do not have sufficient permissions to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.networksecuritymanager#AccountFilter": { "type": "union", "members": { "includeAll": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Includes all accounts. No account filtering is applied.
" } }, "include": { "target": "com.amazonaws.networksecuritymanager#AccountSet", "traits": { "smithy.api#documentation": "Includes only the specified accounts and organizational units.
" } }, "exclude": { "target": "com.amazonaws.networksecuritymanager#AccountSet", "traits": { "smithy.api#documentation": "Excludes the specified accounts and organizational units. All others are in scope.
" } } }, "traits": { "smithy.api#documentation": "Determines which accounts are in scope. Exactly one of includeAll, include, or exclude is set.
The AWS account ID.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.networksecuritymanager#SensitiveAccountName", "traits": { "smithy.api#documentation": "The display name of the account.
" } }, "email": { "target": "com.amazonaws.networksecuritymanager#SensitiveAccountEmail", "traits": { "smithy.api#documentation": "The email address associated with the account.
" } } }, "traits": { "smithy.api#documentation": "A reference to an AWS account, with optional display metadata.
" } }, "com.amazonaws.networksecuritymanager#AccountReferenceList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#AccountReference" }, "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.networksecuritymanager#AccountSet": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.networksecuritymanager#AccountList", "traits": { "smithy.api#documentation": "The list of AWS account IDs.
" } }, "organizationalUnits": { "target": "com.amazonaws.networksecuritymanager#OrganizationalUnitList", "traits": { "smithy.api#documentation": "The AWS Organizations organizational units (OUs) in the selection.
" } } }, "traits": { "smithy.api#documentation": "A set of AWS accounts and organizational units.
" } }, "com.amazonaws.networksecuritymanager#AdminAccountDetails": { "type": "structure", "members": { "adminAccount": { "target": "com.amazonaws.networksecuritymanager#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the administrator account.
", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.networksecuritymanager#AdminPriority", "traits": { "smithy.api#documentation": "The priority assigned to the administrator account.
", "smithy.api#required": {} } }, "adminScope": { "target": "com.amazonaws.networksecuritymanager#AdminScope", "traits": { "smithy.api#documentation": "The administrative scope, which defines the accounts, organizational units, and firewall types that the administrator can manage.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#AdminAccountStatus", "traits": { "smithy.api#documentation": "The status of the administrator account, either ONBOARDED or OFFBOARDED.
The details of an AWS Network Security Manager administrator account.
" } }, "com.amazonaws.networksecuritymanager#AdminAccountStatus": { "type": "enum", "members": { "ONBOARDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ONBOARDED" } }, "OFFBOARDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFFBOARDED" } } } }, "com.amazonaws.networksecuritymanager#AdminAccountSummary": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.networksecuritymanager#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID.
", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.networksecuritymanager#AdminPriority", "traits": { "smithy.api#documentation": "The priority assigned to the administrator account.
" } }, "name": { "target": "com.amazonaws.networksecuritymanager#SensitiveName", "traits": { "smithy.api#documentation": "The name of the administrator account.
" } }, "email": { "target": "com.amazonaws.networksecuritymanager#SensitiveEmail", "traits": { "smithy.api#documentation": "The email address associated with the account.
" } } }, "traits": { "smithy.api#documentation": "Summary information about an AWS Network Security Manager administrator account.
" } }, "com.amazonaws.networksecuritymanager#AdminAccountSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#AdminAccountSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#AdminFirewallTypeScope": { "type": "structure", "members": { "allFirewallTypesEnabled": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the administrator can manage all firewall types, except for third-party firewall types.
" } }, "firewallTypes": { "target": "com.amazonaws.networksecuritymanager#FirewallTypeList", "traits": { "smithy.api#documentation": "The list of firewall types that the administrator can manage.
" } } }, "traits": { "smithy.api#documentation": "Defines the firewall types that an administrator can create and manage.
" } }, "com.amazonaws.networksecuritymanager#AdminPriority": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.networksecuritymanager#AdminScope": { "type": "structure", "members": { "scopeFilter": { "target": "com.amazonaws.networksecuritymanager#AdminScopeFilter", "traits": { "smithy.api#documentation": "The filter that determines which accounts and organizational units are in the administrator's scope.
" } }, "firewallTypeScope": { "target": "com.amazonaws.networksecuritymanager#AdminFirewallTypeScope", "traits": { "smithy.api#documentation": "The firewall types that the administrator can create and manage.
" } } }, "traits": { "smithy.api#documentation": "Defines the accounts, organizational units, and firewall types that an administrator can manage.
" } }, "com.amazonaws.networksecuritymanager#AdminScopeFilter": { "type": "union", "members": { "includeAll": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "All accounts and organizational units are in scope.
" } }, "includeOnly": { "target": "com.amazonaws.networksecuritymanager#AdminScopeSelection", "traits": { "smithy.api#documentation": "Only the specified accounts and organizational units are in the administrator's scope.
" } }, "excludeOnly": { "target": "com.amazonaws.networksecuritymanager#AdminScopeSelection", "traits": { "smithy.api#documentation": "The accounts and organizational units to exclude from the administrator's scope. All others are in scope.
" } } }, "traits": { "smithy.api#documentation": "Determines which accounts and organizational units are in an administrator's scope. This is the reference form, which includes display metadata.
" } }, "com.amazonaws.networksecuritymanager#AdminScopeFilterInput": { "type": "union", "members": { "includeAll": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "All accounts and organizational units are in scope.
" } }, "includeOnly": { "target": "com.amazonaws.networksecuritymanager#AdminScopeSelectionInput", "traits": { "smithy.api#documentation": "Only the specified accounts and organizational units are in the administrator's scope.
" } }, "excludeOnly": { "target": "com.amazonaws.networksecuritymanager#AdminScopeSelectionInput", "traits": { "smithy.api#documentation": "The accounts and organizational units to exclude from the administrator's scope. All others are in scope.
" } } }, "traits": { "smithy.api#documentation": "Determines which accounts and organizational units are in an administrator's scope. This is the input form, which uses account and organizational unit IDs.
" } }, "com.amazonaws.networksecuritymanager#AdminScopeInput": { "type": "structure", "members": { "scopeFilter": { "target": "com.amazonaws.networksecuritymanager#AdminScopeFilterInput", "traits": { "smithy.api#documentation": "The filter that determines which accounts and organizational units are in the administrator's scope.
" } }, "firewallTypeScope": { "target": "com.amazonaws.networksecuritymanager#AdminFirewallTypeScope", "traits": { "smithy.api#documentation": "The firewall types that the administrator can create and manage.
" } } }, "traits": { "smithy.api#documentation": "The administrative scope configuration provided on input, using account and organizational unit IDs.
" } }, "com.amazonaws.networksecuritymanager#AdminScopeSelection": { "type": "structure", "members": { "accounts": { "target": "com.amazonaws.networksecuritymanager#AccountReferenceList", "traits": { "smithy.api#documentation": "The AWS accounts in the selection.
" } }, "organizationalUnits": { "target": "com.amazonaws.networksecuritymanager#OrganizationalUnitReferenceList", "traits": { "smithy.api#documentation": "The AWS Organizations organizational units (OUs) in the selection.
" } } }, "traits": { "smithy.api#documentation": "A selection of accounts and organizational units. This is the reference form, which includes display metadata.
" } }, "com.amazonaws.networksecuritymanager#AdminScopeSelectionInput": { "type": "structure", "members": { "accounts": { "target": "com.amazonaws.networksecuritymanager#AccountIdList", "traits": { "smithy.api#documentation": "The AWS accounts in the selection.
" } }, "organizationalUnits": { "target": "com.amazonaws.networksecuritymanager#OrganizationalUnitIdList", "traits": { "smithy.api#documentation": "The AWS Organizations organizational units (OUs) in the selection.
" } } }, "traits": { "smithy.api#documentation": "A selection of accounts and organizational units. This is the input form, which uses account and organizational unit IDs.
" } }, "com.amazonaws.networksecuritymanager#AlbConfiguration": { "type": "structure", "members": { "scheme": { "target": "com.amazonaws.networksecuritymanager#Scheme", "traits": { "smithy.api#documentation": "The scheme of the Application Load Balancer, either internet-facing or internal.
The IP address type of the Application Load Balancer.
" } } }, "traits": { "smithy.api#documentation": "Filter criteria specific to Application Load Balancers.
" } }, "com.amazonaws.networksecuritymanager#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 1010 }, "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)$" } }, "com.amazonaws.networksecuritymanager#AssociatedPolicy": { "type": "structure", "members": { "policyArn": { "target": "com.amazonaws.networksecuritymanager#PolicyArn", "traits": { "smithy.api#documentation": "The ARN of the associated policy, including its version qualifier when a specific published version is pinned (for example, ...:policy:abc123:3).
An association between a deployment and a policy, as returned in outputs. The corresponding request structure is PolicyReference.
The ARN of the associated rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An association between a template and a rule, as returned in outputs. The corresponding request structure is RuleReference.
The ARN of the associated scope.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An association between a deployment and a scope, as returned in outputs. The corresponding request structure is ScopeReference.
The ARN of the associated template.
" } }, "ruleArn": { "target": "com.amazonaws.networksecuritymanager#RuleArn", "traits": { "smithy.api#documentation": "The ARN of the associated rule.
" } } }, "traits": { "smithy.api#documentation": "An association between a policy and either a template or a rule, as returned in outputs. Exactly one of templateArn or ruleArn is set. The corresponding request structure is TemplateOrRuleReference.
The name of the configuration setting that is in conflict.
" } }, "expectedValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The configuration value that AWS Network Security Manager expected.
" } }, "actualValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The configuration value that was found on the resource.
" } } }, "traits": { "smithy.api#documentation": "Describes a single configuration value that does not match the intended configuration.
" } }, "com.amazonaws.networksecuritymanager#ConfigurationIssueList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#ConfigurationIssue" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the resource that is in conflict with the request.
" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource that is in conflict with the request.
" } } }, "traits": { "smithy.api#documentation": "The request conflicts with the current state of the resource. For example, the resource was modified concurrently, or it is in a state that does not allow the requested operation.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.networksecuritymanager#CreateDeployment": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateDeploymentInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateDeploymentOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceUnavailableException" }, { "target": "com.amazonaws.networksecuritymanager#TagPolicyViolationException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a deployment", "resources": { "required": { "policy": {}, "policy-snapshot": {}, "scope": {}, "scope-snapshot": {} } } }, "smithy.api#documentation": "Creates a deployment. A deployment applies one or more policies to the accounts and resources selected by a scope. Use isPublished to create the deployment in published (ACTIVE) or draft (DRAFT) state. The response includes coverage information and any warnings about the deployment.
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "deploymentName": { "target": "com.amazonaws.networksecuritymanager#DeploymentName", "traits": { "smithy.api#documentation": "The name of the deployment.
", "smithy.api#required": {} } }, "deploymentDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the deployment.
" } }, "deploymentConfiguration": { "target": "com.amazonaws.networksecuritymanager#DeploymentConfiguration", "traits": { "smithy.api#documentation": "The configuration settings for the deployment.
", "smithy.api#required": {} } }, "associatedPolicyList": { "target": "com.amazonaws.networksecuritymanager#PolicyReferenceList", "traits": { "smithy.api#documentation": "The policies associated with the deployment.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "associatedScopeList": { "target": "com.amazonaws.networksecuritymanager#ScopeReferenceList", "traits": { "smithy.api#documentation": "The scope associated with the deployment. A deployment has exactly one scope.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#default": true, "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.
The tags to add to the resource when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#CreateDeploymentOutput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.networksecuritymanager#DeploymentId", "traits": { "smithy.api#documentation": "The service-generated id of the deployment.
", "smithy.api#required": {} } }, "deploymentArn": { "target": "com.amazonaws.networksecuritymanager#DeploymentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deployment.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "deploymentIdentifier" } }, "deploymentName": { "target": "com.amazonaws.networksecuritymanager#DeploymentName", "traits": { "smithy.api#documentation": "The name of the deployment.
", "smithy.api#required": {} } }, "deploymentDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the deployment.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The configuration settings for the deployment.
" } }, "associatedPolicyList": { "target": "com.amazonaws.networksecuritymanager#AssociatedPolicyList", "traits": { "smithy.api#documentation": "The policies associated with the deployment.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "associatedScopeList": { "target": "com.amazonaws.networksecuritymanager#AssociatedScopeList", "traits": { "smithy.api#documentation": "The scope associated with the deployment. A deployment has exactly one scope.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "deploymentCoverage": { "target": "com.amazonaws.networksecuritymanager#DeploymentCoverageList", "traits": { "smithy.api#documentation": "The coverage information for the deployment. For each firewall type, it shows which policies have that firewall type and which in-scope resource types the firewall type protects.
", "smithy.api#notProperty": {} } }, "warnings": { "target": "com.amazonaws.networksecuritymanager#DeploymentWarningList", "traits": { "smithy.api#documentation": "Warnings about potential issues, such as a policy that has no applicable resources in the deployment's scope.
", "smithy.api#notProperty": {} } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreateDeploymentSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateDeploymentSnapshotInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateDeploymentSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a snapshot of a deployment", "resources": { "required": { "deployment": {} } }, "createsResources": [ "deployment-snapshot" ] }, "smithy.api#documentation": "Creates a snapshot of the current published version of the specified deployment.
", "smithy.api#examples": [ { "title": "Create a deployment snapshot", "documentation": "Creates an immutable snapshot of the current published version of a deployment. The snapshot is addressable by a version-qualified ARN.", "input": { "deploymentIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456", "clientToken": "550e8400-e29b-41d4-a716-446655440014" }, "output": { "deploymentId": "def456", "deploymentArn": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456:2", "deploymentName": "prod-us-east-1-deployment", "status": "ACTIVE", "deploymentConfiguration": { "enableCrossAccountVisibility": true }, "associatedPolicyList": [ { "policyArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789" } ], "associatedScopeList": [ { "scopeArn": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123" } ], "version": "2", "isSnapshot": true, "updatedAt": "2026-08-20T12:00:00Z" } } ], "smithy.api#http": { "uri": "/deployments/{deploymentIdentifier}/snapshots", "method": "POST", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#CreateDeploymentSnapshotInput": { "type": "structure", "members": { "deploymentIdentifier": { "target": "com.amazonaws.networksecuritymanager#DeploymentIdentifier", "traits": { "smithy.api#documentation": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networksecuritymanager#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networksecuritymanager#TagMap", "traits": { "smithy.api#documentation": "The tags to add to the snapshot when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Deployment" } ] } }, "com.amazonaws.networksecuritymanager#CreateDeploymentSnapshotOutput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.networksecuritymanager#DeploymentId", "traits": { "smithy.api#documentation": "The service-generated id of the deployment.
", "smithy.api#required": {} } }, "deploymentArn": { "target": "com.amazonaws.networksecuritymanager#DeploymentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deployment.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "deploymentIdentifier" } }, "deploymentName": { "target": "com.amazonaws.networksecuritymanager#DeploymentName", "traits": { "smithy.api#documentation": "The name of the deployment.
", "smithy.api#required": {} } }, "deploymentDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the deployment.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The configuration settings for the deployment.
" } }, "associatedPolicyList": { "target": "com.amazonaws.networksecuritymanager#AssociatedPolicyList", "traits": { "smithy.api#documentation": "The policies associated with the deployment.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "associatedScopeList": { "target": "com.amazonaws.networksecuritymanager#AssociatedScopeList", "traits": { "smithy.api#documentation": "The scope associated with the deployment. A deployment has exactly one scope.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the snapshot was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreatePolicy": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreatePolicyInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreatePolicyOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceUnavailableException" }, { "target": "com.amazonaws.networksecuritymanager#TagPolicyViolationException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a policy", "resources": { "optional": { "rule": {}, "rule-snapshot": {}, "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Creates a policy. A policy combines templates and rules with enforcement settings for a firewall type, such as AWS WAF or AWS Shield Advanced. Use isPublished to create the policy in published (ACTIVE) or draft (DRAFT) state.
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "policyName": { "target": "com.amazonaws.networksecuritymanager#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the policy.
" } }, "priority": { "target": "com.amazonaws.networksecuritymanager#Priority", "traits": { "smithy.api#documentation": "The priority of the resource. A lower number indicates a higher priority.
", "smithy.api#required": {} } }, "associatedTemplateAndRuleList": { "target": "com.amazonaws.networksecuritymanager#TemplateAndRuleReferenceList", "traits": { "smithy.api#documentation": "The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.
", "smithy.api#notProperty": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "policyConfiguration": { "target": "com.amazonaws.networksecuritymanager#PolicyConfiguration", "traits": { "smithy.api#documentation": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
", "smithy.api#required": {} } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#default": true, "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.
The tags to add to the resource when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#CreatePolicyOutput": { "type": "structure", "members": { "policyId": { "target": "com.amazonaws.networksecuritymanager#PolicyId", "traits": { "smithy.api#documentation": "The service-generated id of the policy.
", "smithy.api#required": {} } }, "policyArn": { "target": "com.amazonaws.networksecuritymanager#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "policyIdentifier" } }, "policyName": { "target": "com.amazonaws.networksecuritymanager#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the policy.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The priority of the resource. A lower number indicates a higher priority.
", "smithy.api#required": {} } }, "associatedTemplateAndRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedTemplateAndRuleList", "traits": { "smithy.api#documentation": "The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "policyConfiguration": { "target": "com.amazonaws.networksecuritymanager#PolicyConfiguration", "traits": { "smithy.api#documentation": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreatePolicySnapshot": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreatePolicySnapshotInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreatePolicySnapshotOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a snapshot of a policy", "resources": { "required": { "policy": {} } }, "createsResources": [ "policy-snapshot" ] }, "smithy.api#documentation": "Creates a snapshot of the current published version of the specified policy.
", "smithy.api#examples": [ { "title": "Create a policy snapshot", "documentation": "Creates an immutable snapshot of the current published version of a policy. The snapshot is addressable by a version-qualified ARN.", "input": { "policyIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789", "clientToken": "550e8400-e29b-41d4-a716-446655440013" }, "output": { "policyId": "xyz789", "policyArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789:2", "policyName": "web-app-waf-policy", "status": "ACTIVE", "priority": 2, "associatedTemplateAndRuleList": [ { "templateArn": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789" } ], "version": "2", "isSnapshot": true, "firewallType": "WAF", "policyConfiguration": { "remediationEnabled": true, "resourcesCleanUp": false, "wafConfig": { "existingCustomerWebACLResolution": "NO_REMEDIATION", "conflictResolution": "MERGE_WHERE_APPLICABLE" } }, "updatedAt": "2026-08-20T12:00:00Z" } } ], "smithy.api#http": { "uri": "/policies/{policyIdentifier}/snapshots", "method": "POST", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#CreatePolicySnapshotInput": { "type": "structure", "members": { "policyIdentifier": { "target": "com.amazonaws.networksecuritymanager#PolicyIdentifier", "traits": { "smithy.api#documentation": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networksecuritymanager#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networksecuritymanager#TagMap", "traits": { "smithy.api#documentation": "The tags to add to the snapshot when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Policy" } ] } }, "com.amazonaws.networksecuritymanager#CreatePolicySnapshotOutput": { "type": "structure", "members": { "policyId": { "target": "com.amazonaws.networksecuritymanager#PolicyId", "traits": { "smithy.api#documentation": "The service-generated id of the policy.
", "smithy.api#required": {} } }, "policyArn": { "target": "com.amazonaws.networksecuritymanager#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "policyIdentifier" } }, "policyName": { "target": "com.amazonaws.networksecuritymanager#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the policy.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The priority of the resource. A lower number indicates a higher priority.
", "smithy.api#required": {} } }, "associatedTemplateAndRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedTemplateAndRuleList", "traits": { "smithy.api#documentation": "The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "policyConfiguration": { "target": "com.amazonaws.networksecuritymanager#PolicyConfiguration", "traits": { "smithy.api#documentation": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the snapshot was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreateRule": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateRuleInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateRuleOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceUnavailableException" }, { "target": "com.amazonaws.networksecuritymanager#TagPolicyViolationException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a rule", "resources": {} }, "smithy.api#documentation": "Creates a rule. A rule defines a network security configuration to enforce, such as an AWS WAF rule group or configuration data. Use isPublished to create the rule in published (ACTIVE) or draft (DRAFT) state.
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "ruleName": { "target": "com.amazonaws.networksecuritymanager#RuleName", "traits": { "smithy.api#documentation": "The name of the rule.
", "smithy.api#required": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType", "traits": { "smithy.api#documentation": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
A description of the rule.
" } }, "configuration": { "target": "com.amazonaws.networksecuritymanager#JsonDocument", "traits": { "smithy.api#documentation": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF INSPECTION rule, provide an AWS WAF rule group. For an AWS WAF CONFIGURATION rule, provide a single web ACL setting, such as DefaultAction or VisibilityConfig; use wafConfigDataType to declare which setting the document contains. For the schema of each setting and complete examples, see Writing rule configurations in the AWS Network Security Manager Developer Guide.
Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.
The tags to add to the resource when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#CreateRuleOutput": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.networksecuritymanager#RuleId", "traits": { "smithy.api#documentation": "The service-generated id of the rule.
", "smithy.api#required": {} } }, "ruleArn": { "target": "com.amazonaws.networksecuritymanager#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ruleIdentifier" } }, "ruleName": { "target": "com.amazonaws.networksecuritymanager#RuleName", "traits": { "smithy.api#documentation": "The name of the rule.
", "smithy.api#required": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType", "traits": { "smithy.api#documentation": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
A description of the rule.
" } }, "configuration": { "target": "com.amazonaws.networksecuritymanager#JsonDocument", "traits": { "smithy.api#documentation": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreateRuleSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateRuleSnapshotInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateRuleSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a snapshot of a rule", "resources": { "required": { "rule": {} } }, "createsResources": [ "rule-snapshot" ] }, "smithy.api#documentation": "Creates a snapshot of the current published version of the specified rule. A snapshot is an immutable, versioned copy that other resources can reference.
", "smithy.api#examples": [ { "title": "Create a rule snapshot", "documentation": "Creates an immutable snapshot of the current published version of a rule. The snapshot is addressable by a version-qualified ARN.", "input": { "ruleIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123", "clientToken": "550e8400-e29b-41d4-a716-446655440011" }, "output": { "ruleId": "abc123", "ruleArn": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123:2", "ruleName": "block-known-bad-ips", "firewallType": "WAF", "ruleType": "INSPECTION", "configuration": {}, "status": "ACTIVE", "version": "2", "isSnapshot": true, "updatedAt": "2026-08-20T12:00:00Z" } } ], "smithy.api#http": { "uri": "/rules/{ruleIdentifier}/snapshots", "method": "POST", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#CreateRuleSnapshotInput": { "type": "structure", "members": { "ruleIdentifier": { "target": "com.amazonaws.networksecuritymanager#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networksecuritymanager#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networksecuritymanager#TagMap", "traits": { "smithy.api#documentation": "The tags to add to the snapshot when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Rule" } ] } }, "com.amazonaws.networksecuritymanager#CreateRuleSnapshotOutput": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.networksecuritymanager#RuleId", "traits": { "smithy.api#documentation": "The service-generated id of the rule.
", "smithy.api#required": {} } }, "ruleArn": { "target": "com.amazonaws.networksecuritymanager#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ruleIdentifier" } }, "ruleName": { "target": "com.amazonaws.networksecuritymanager#RuleName", "traits": { "smithy.api#documentation": "The name of the rule.
", "smithy.api#required": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType", "traits": { "smithy.api#documentation": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
A description of the rule.
" } }, "configuration": { "target": "com.amazonaws.networksecuritymanager#JsonDocument", "traits": { "smithy.api#documentation": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the snapshot was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreateScope": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateScopeInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateScopeOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceUnavailableException" }, { "target": "com.amazonaws.networksecuritymanager#TagPolicyViolationException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a scope", "resources": {} }, "smithy.api#documentation": "Creates a scope. A scope selects the accounts and resources that a deployment applies to. Use isPublished to create the scope in published (ACTIVE) or draft (DRAFT) state.
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "scopeName": { "target": "com.amazonaws.networksecuritymanager#ScopeName", "traits": { "smithy.api#documentation": "The name of the scope.
", "smithy.api#required": {} } }, "scopeDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the scope.
" } }, "scopeConfiguration": { "target": "com.amazonaws.networksecuritymanager#ScopeConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines which accounts and resources are in scope.
", "smithy.api#required": {} } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#default": true, "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.
The tags to add to the resource when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#CreateScopeOutput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networksecuritymanager#ScopeId", "traits": { "smithy.api#documentation": "The service-generated id of the scope.
", "smithy.api#required": {} } }, "scopeArn": { "target": "com.amazonaws.networksecuritymanager#ScopeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "scopeIdentifier" } }, "scopeName": { "target": "com.amazonaws.networksecuritymanager#ScopeName", "traits": { "smithy.api#documentation": "The name of the scope.
", "smithy.api#required": {} } }, "scopeDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the scope.
" } }, "scopeConfiguration": { "target": "com.amazonaws.networksecuritymanager#ScopeConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines which accounts and resources are in scope.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreateScopeSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateScopeSnapshotInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateScopeSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a snapshot of a scope", "resources": { "required": { "scope": {} } }, "createsResources": [ "scope-snapshot" ] }, "smithy.api#documentation": "Creates a snapshot of the current published version of the specified scope.
", "smithy.api#examples": [ { "title": "Create a scope snapshot", "documentation": "Creates an immutable snapshot of the current published version of a scope. The snapshot is addressable by a version-qualified ARN.", "input": { "scopeIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123", "clientToken": "550e8400-e29b-41d4-a716-446655440010" }, "output": { "scopeId": "abc123", "scopeArn": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123:2", "scopeName": "production-web-apps", "scopeConfiguration": { "accountFilter": { "includeAll": {} }, "resourceScopes": {} }, "status": "ACTIVE", "version": "2", "isSnapshot": true, "updatedAt": "2026-08-20T12:00:00Z" } } ], "smithy.api#http": { "uri": "/scopes/{scopeIdentifier}/snapshots", "method": "POST", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#CreateScopeSnapshotInput": { "type": "structure", "members": { "scopeIdentifier": { "target": "com.amazonaws.networksecuritymanager#ScopeIdentifier", "traits": { "smithy.api#documentation": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networksecuritymanager#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networksecuritymanager#TagMap", "traits": { "smithy.api#documentation": "The tags to add to the snapshot when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Scope" } ] } }, "com.amazonaws.networksecuritymanager#CreateScopeSnapshotOutput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networksecuritymanager#ScopeId", "traits": { "smithy.api#documentation": "The service-generated id of the scope.
", "smithy.api#required": {} } }, "scopeArn": { "target": "com.amazonaws.networksecuritymanager#ScopeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "scopeIdentifier" } }, "scopeName": { "target": "com.amazonaws.networksecuritymanager#ScopeName", "traits": { "smithy.api#documentation": "The name of the scope.
", "smithy.api#required": {} } }, "scopeDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the scope.
" } }, "scopeConfiguration": { "target": "com.amazonaws.networksecuritymanager#ScopeConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines which accounts and resources are in scope.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the snapshot was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreateTemplate": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateTemplateInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateTemplateOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceUnavailableException" }, { "target": "com.amazonaws.networksecuritymanager#TagPolicyViolationException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a template", "resources": { "required": { "rule": {}, "rule-snapshot": {} } } }, "smithy.api#documentation": "Creates a template. A template groups one or more rules to simplify reuse across policies. You can also associate rules with a policy directly, without a template. Use isPublished to create the template in published (ACTIVE) or draft (DRAFT) state.
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "templateName": { "target": "com.amazonaws.networksecuritymanager#TemplateName", "traits": { "smithy.api#documentation": "The name of the template.
", "smithy.api#required": {} } }, "templateDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the template.
" } }, "associatedRuleList": { "target": "com.amazonaws.networksecuritymanager#RuleReferenceList", "traits": { "smithy.api#documentation": "The rules associated with the template.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#TemplateFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#default": true, "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.
The tags to add to the resource when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#CreateTemplateOutput": { "type": "structure", "members": { "templateId": { "target": "com.amazonaws.networksecuritymanager#TemplateId", "traits": { "smithy.api#documentation": "The service-generated id of the template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.networksecuritymanager#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "templateIdentifier" } }, "templateName": { "target": "com.amazonaws.networksecuritymanager#TemplateName", "traits": { "smithy.api#documentation": "The name of the template.
", "smithy.api#required": {} } }, "templateDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the template.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "associatedRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedRuleList", "traits": { "smithy.api#documentation": "The rules associated with the template.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#TemplateFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#CreateTemplateSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#CreateTemplateSnapshotInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#CreateTemplateSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#iamAction": { "documentation": "Grants permission to create a snapshot of a template", "resources": { "required": { "template": {} } }, "createsResources": [ "template-snapshot" ] }, "smithy.api#documentation": "Creates a snapshot of the current published version of the specified template.
", "smithy.api#examples": [ { "title": "Create a template snapshot", "documentation": "Creates an immutable snapshot of the current published version of a template. The snapshot is addressable by a version-qualified ARN.", "input": { "templateIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789", "clientToken": "550e8400-e29b-41d4-a716-446655440012" }, "output": { "templateId": "xyz789", "templateArn": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789:2", "templateName": "standard-waf-template", "status": "ACTIVE", "version": "2", "associatedRuleList": [ { "ruleArn": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123" } ], "isSnapshot": true, "firewallType": "WAF", "updatedAt": "2026-08-20T12:00:00Z" } } ], "smithy.api#http": { "uri": "/templates/{templateIdentifier}/snapshots", "method": "POST", "code": 201 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#CreateTemplateSnapshotInput": { "type": "structure", "members": { "templateIdentifier": { "target": "com.amazonaws.networksecuritymanager#TemplateIdentifier", "traits": { "smithy.api#documentation": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.networksecuritymanager#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.networksecuritymanager#TagMap", "traits": { "smithy.api#documentation": "The tags to add to the snapshot when it is created.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Template" } ] } }, "com.amazonaws.networksecuritymanager#CreateTemplateSnapshotOutput": { "type": "structure", "members": { "templateId": { "target": "com.amazonaws.networksecuritymanager#TemplateId", "traits": { "smithy.api#documentation": "The service-generated id of the template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.networksecuritymanager#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "templateIdentifier" } }, "templateName": { "target": "com.amazonaws.networksecuritymanager#TemplateName", "traits": { "smithy.api#documentation": "The name of the template.
", "smithy.api#required": {} } }, "templateDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the template.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "associatedRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedRuleList", "traits": { "smithy.api#documentation": "The rules associated with the template.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#TemplateFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the snapshot was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#DateTimestamp": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.networksecuritymanager#DeleteAdminAccount": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#DeleteAdminAccountRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to remove a Network Security Manager administrator account" }, "smithy.api#documentation": "Removes the specified AWS Network Security Manager administrator account.
", "smithy.api#examples": [ { "title": "Remove an administrator account", "documentation": "Removes an account's Network Security Manager administrator designation.", "input": { "accountId": "234567890123" } } ], "smithy.api#http": { "uri": "/admin-account/{accountId}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#DeleteAdminAccountRequest": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.networksecuritymanager#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the administrator account to remove.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#DeleteDeployment": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#DeleteDeploymentInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a deployment", "resources": { "required": { "deployment": {}, "deployment-snapshot": {} } } }, "smithy.api#documentation": "Deletes the specified deployment.
", "smithy.api#examples": [ { "title": "Delete a deployment", "documentation": "Deletes a deployment by its ARN. Deleting an active deployment stops enforcement and triggers cleanup of managed firewall resources.", "input": { "deploymentIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456" } } ], "smithy.api#http": { "uri": "/deployments/{deploymentIdentifier}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#DeleteDeploymentInput": { "type": "structure", "members": { "deploymentIdentifier": { "target": "com.amazonaws.networksecuritymanager#DeploymentIdentifier", "traits": { "smithy.api#documentation": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Deployment" } ] } }, "com.amazonaws.networksecuritymanager#DeletePolicy": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#DeletePolicyInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a policy", "resources": { "required": { "policy": {}, "policy-snapshot": {} } } }, "smithy.api#documentation": "Deletes the specified policy.
", "smithy.api#examples": [ { "title": "Delete a policy", "documentation": "Deletes a policy by its ARN. The policy must not be associated with any deployment.", "input": { "policyIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789" } } ], "smithy.api#http": { "uri": "/policies/{policyIdentifier}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#DeletePolicyInput": { "type": "structure", "members": { "policyIdentifier": { "target": "com.amazonaws.networksecuritymanager#PolicyIdentifier", "traits": { "smithy.api#documentation": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Policy" } ] } }, "com.amazonaws.networksecuritymanager#DeleteRule": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#DeleteRuleInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a rule", "resources": { "required": { "rule": {}, "rule-snapshot": {} } } }, "smithy.api#documentation": "Deletes the specified rule.
", "smithy.api#examples": [ { "title": "Delete a rule", "documentation": "Deletes a rule by its ARN. The rule must not be associated with any template or policy.", "input": { "ruleIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123" } } ], "smithy.api#http": { "uri": "/rules/{ruleIdentifier}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#DeleteRuleInput": { "type": "structure", "members": { "ruleIdentifier": { "target": "com.amazonaws.networksecuritymanager#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Rule" } ] } }, "com.amazonaws.networksecuritymanager#DeleteScope": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#DeleteScopeInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a scope", "resources": { "required": { "scope": {}, "scope-snapshot": {} } } }, "smithy.api#documentation": "Deletes the specified scope.
", "smithy.api#examples": [ { "title": "Delete a scope", "documentation": "Deletes a scope by its ARN. The scope must not be associated with any deployment.", "input": { "scopeIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123" } } ], "smithy.api#http": { "uri": "/scopes/{scopeIdentifier}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#DeleteScopeInput": { "type": "structure", "members": { "scopeIdentifier": { "target": "com.amazonaws.networksecuritymanager#ScopeIdentifier", "traits": { "smithy.api#documentation": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Scope" } ] } }, "com.amazonaws.networksecuritymanager#DeleteTemplate": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#DeleteTemplateInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a template", "resources": { "required": { "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Deletes the specified template.
", "smithy.api#examples": [ { "title": "Delete a template", "documentation": "Deletes a template by its ARN. The template must not be associated with any policy.", "input": { "templateIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789" } } ], "smithy.api#http": { "uri": "/templates/{templateIdentifier}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#DeleteTemplateInput": { "type": "structure", "members": { "templateIdentifier": { "target": "com.amazonaws.networksecuritymanager#TemplateIdentifier", "traits": { "smithy.api#documentation": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Template" } ] } }, "com.amazonaws.networksecuritymanager#Deployment": { "type": "resource", "identifiers": { "deploymentIdentifier": { "target": "com.amazonaws.networksecuritymanager#DeploymentIdentifier" } }, "properties": { "deploymentId": { "target": "com.amazonaws.networksecuritymanager#DeploymentId" }, "deploymentName": { "target": "com.amazonaws.networksecuritymanager#DeploymentName" }, "deploymentDescription": { "target": "com.amazonaws.networksecuritymanager#Description" }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus" }, "deploymentConfiguration": { "target": "com.amazonaws.networksecuritymanager#DeploymentConfiguration" }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion" }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken" }, "isSnapshot": { "target": "com.amazonaws.networksecuritymanager#IsSnapshot" }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion" }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp" } }, "create": { "target": "com.amazonaws.networksecuritymanager#CreateDeployment" }, "read": { "target": "com.amazonaws.networksecuritymanager#GetDeployment" }, "update": { "target": "com.amazonaws.networksecuritymanager#UpdateDeployment" }, "delete": { "target": "com.amazonaws.networksecuritymanager#DeleteDeployment" }, "list": { "target": "com.amazonaws.networksecuritymanager#ListDeployments" }, "operations": [ { "target": "com.amazonaws.networksecuritymanager#CreateDeploymentSnapshot" }, { "target": "com.amazonaws.networksecuritymanager#ListDeploymentSnapshots" }, { "target": "com.amazonaws.networksecuritymanager#ListResourceSynchronizationStatuses" } ], "traits": { "aws.api#arn": { "template": "{deploymentIdentifier}", "absolute": true }, "aws.api#taggable": {}, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "deployment", "relativeDocumentation": "deployment.html" }, "smithy.api#documentation": "Represents a deployment that applies policies to resources in the associated scopes" } }, "com.amazonaws.networksecuritymanager#DeploymentArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::NetworkSecurityManager::Deployment" }, "smithy.api#length": { "min": 20, "max": 1010 }, "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)$" } }, "com.amazonaws.networksecuritymanager#DeploymentConfiguration": { "type": "structure", "members": { "enableCrossAccountVisibility": { "target": "com.amazonaws.networksecuritymanager#EnableCrossAccountVisibility", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether aggregate synchronization status details for the resources covered by this deployment are visible across accounts. Default: false.
Configuration settings that control a deployment's behavior.
" } }, "com.amazonaws.networksecuritymanager#DeploymentCoverageEntry": { "type": "structure", "members": { "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType", "traits": { "smithy.api#documentation": "The firewall type that the policies in this entry share.
", "smithy.api#required": {} } }, "policyArns": { "target": "com.amazonaws.networksecuritymanager#DeploymentPolicyArnList", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the deployment's policies that have this firewall type.
", "smithy.api#required": {} } }, "inScopeResourceTypes": { "target": "com.amazonaws.networksecuritymanager#DeploymentResourceTypeList", "traits": { "smithy.api#documentation": "The resource types in the deployment's scope that this firewall type protects. This list is empty if the scope does not select any resource types that the firewall type protects.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Coverage information for one firewall type within a deployment. It lists the deployment's policies that have this firewall type. It also lists the resource types in the deployment's scope that the firewall type protects.
" } }, "com.amazonaws.networksecuritymanager#DeploymentCoverageList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#DeploymentCoverageEntry" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.networksecuritymanager#DeploymentId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]{1,64}$" } }, "com.amazonaws.networksecuritymanager#DeploymentIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1010 } } }, "com.amazonaws.networksecuritymanager#DeploymentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9 _.:/=+\\-@]*$" } }, "com.amazonaws.networksecuritymanager#DeploymentPolicyArnList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#PolicyArn" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#DeploymentResourceTypeList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#ScopeResourceType" }, "traits": { "smithy.api#length": { "max": 50 } } }, "com.amazonaws.networksecuritymanager#DeploymentSummary": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.networksecuritymanager#DeploymentId", "traits": { "smithy.api#documentation": "The service-generated id of the deployment.
", "smithy.api#required": {} } }, "deploymentArn": { "target": "com.amazonaws.networksecuritymanager#DeploymentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deployment.
", "smithy.api#required": {} } }, "deploymentName": { "target": "com.amazonaws.networksecuritymanager#DeploymentName", "traits": { "smithy.api#documentation": "The name of the deployment.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
The version of the resource.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a deployment.
" } }, "com.amazonaws.networksecuritymanager#DeploymentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#DeploymentSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#DeploymentWarningEntry": { "type": "structure", "members": { "code": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A code that identifies the type of warning.
", "smithy.api#required": {} } }, "policyArn": { "target": "com.amazonaws.networksecuritymanager#PolicyArn", "traits": { "smithy.api#documentation": "The ARN of the policy that the warning relates to.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable description of the warning.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A warning about a potential issue with a deployment.
", "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Policy", "ids": { "policyIdentifier": "policyArn" } } ] } }, "com.amazonaws.networksecuritymanager#DeploymentWarningList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#DeploymentWarningEntry" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#Description": { "type": "string", "traits": { "smithy.api#length": { "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:/=+\\-@]*$" } }, "com.amazonaws.networksecuritymanager#EnableCrossAccountVisibility": { "type": "boolean" }, "com.amazonaws.networksecuritymanager#EntityStatus": { "type": "enum", "members": { "DRAFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRAFT" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.networksecuritymanager#EntityStatusFilter": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DRAFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRAFT" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.networksecuritymanager#EntityVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#pattern": "^[1-9][0-9]*$" } }, "com.amazonaws.networksecuritymanager#ExistingCustomerWebACLResolution": { "type": "enum", "members": { "RETROFIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETROFIT" } }, "OVERRIDE_ASSOCIATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OVERRIDE_ASSOCIATION" } }, "NO_REMEDIATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_REMEDIATION" } } } }, "com.amazonaws.networksecuritymanager#FirewallSyncReason": { "type": "union", "members": { "missingFirewall": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Indicates that an expected firewall is missing. The value describes the missing firewall.
" } }, "invalidFirewall": { "target": "com.amazonaws.networksecuritymanager#InvalidFirewallReasons", "traits": { "smithy.api#documentation": "Details about a firewall whose configuration does not match the intended configuration.
" } } }, "traits": { "smithy.api#documentation": "Describes why a firewall is out of sync. Exactly one of missingFirewall or invalidFirewall is set.
Generates a rule configuration from a natural-language description. Provide a prompt along with the rule's firewall type and rule type. The service returns a configuration that you can use when you create or update a rule. If you also provide an existing configuration, the service edits that configuration instead of generating a new one.
", "smithy.api#examples": [ { "title": "Generate a rule configuration from a description", "documentation": "Generates a firewall rule configuration from a natural language description. The response contains the generated configuration as a JSON string, ready to use as the configuration of a rule.", "input": { "prompt": "Create a rate limiting rule that blocks IP addresses sending more than 2000 requests in 5 minutes", "ruleFirewallType": "WAF", "ruleType": "INSPECTION", "clientToken": "550e8400-e29b-41d4-a716-446655440015" }, "output": { "configuration": "{\"name\":\"rate-limit-rule\",\"priority\":1,\"statement\":{\"rateBasedStatement\":{\"limit\":2000,\"evaluationWindowSec\":300,\"aggregateKeyType\":\"IP\"}},\"action\":{\"block\":{}}}" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/GenerateRuleConfiguration" } } }, "com.amazonaws.networksecuritymanager#GenerateRuleConfigurationRequest": { "type": "structure", "members": { "prompt": { "target": "com.amazonaws.networksecuritymanager#SensitiveString", "traits": { "smithy.api#documentation": "A natural-language description of the configuration that you want to generate.
", "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#pattern": "^[A-Za-z0-9.,?!@&:;()'\"\\s\\-\\/\\n_=<>+*\\#\\[\\]{}]*$", "smithy.api#required": {} } }, "ruleFirewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType", "traits": { "smithy.api#documentation": "The firewall type of the rule.
", "smithy.api#required": {} } }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType", "traits": { "smithy.api#documentation": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
For AWS WAF configuration rules, the specific AWS WAF configuration variant to generate. This is optional; if you omit it, the service selects the variant.
" } }, "currentConfiguration": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An existing configuration to edit, as a JSON string. When you provide this value, the operation edits the configuration. When you omit it, the operation generates a new configuration.
", "smithy.api#length": { "max": 32768 } } }, "clientToken": { "target": "com.amazonaws.networksecuritymanager#IdempotencyToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#GenerateRuleConfigurationResponse": { "type": "structure", "members": { "configuration": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The generated configuration, as a JSON string. You can use this value in the configuration field of a rule.
Reserved for a future human-readable description of the generated configuration. This field is currently not populated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#GetAdminAccount": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#GetAdminAccountRequest" }, "output": { "target": "com.amazonaws.networksecuritymanager#GetAdminAccountResponse" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve a Network Security Manager administrator account" }, "smithy.api#documentation": "Retrieves the details of the specified AWS Network Security Manager administrator account.
", "smithy.api#examples": [ { "title": "Get an administrator account", "documentation": "Retrieves the details and administrative scope of a Network Security Manager administrator account.", "input": { "accountId": "234567890123" }, "output": { "adminAccountDetails": { "adminAccount": "234567890123", "priority": 2, "adminScope": { "scopeFilter": { "includeOnly": { "organizationalUnits": [ { "ouId": "ou-abcd-12345678", "name": "Production" } ] } }, "firewallTypeScope": { "allFirewallTypesEnabled": false, "firewallTypes": [ "WAF" ] } }, "status": "ONBOARDED" } } } ], "smithy.api#http": { "uri": "/admin-account/{accountId}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#GetAdminAccountRequest": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.networksecuritymanager#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the administrator account to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#GetAdminAccountResponse": { "type": "structure", "members": { "adminAccountDetails": { "target": "com.amazonaws.networksecuritymanager#AdminAccountDetails", "traits": { "smithy.api#documentation": "The details of the administrator account.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#GetDeployment": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#GetDeploymentInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#GetDeploymentOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve a deployment", "resources": { "required": { "deployment": {}, "deployment-snapshot": {} } } }, "smithy.api#documentation": "Retrieves the details of the specified deployment, including coverage information and any warnings.
", "smithy.api#examples": [ { "title": "Get a deployment", "documentation": "Retrieves the current published version of a deployment by its base ARN, including per-firewall-type coverage showing which in-scope resource types each policy protects.", "input": { "deploymentIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456" }, "output": { "deploymentId": "def456", "deploymentArn": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456", "deploymentName": "prod-us-east-1-deployment", "deploymentDescription": "Production deployment for US East 1 region", "status": "ACTIVE", "deploymentConfiguration": { "enableCrossAccountVisibility": false }, "associatedPolicyList": [ { "policyArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789" } ], "associatedScopeList": [ { "scopeArn": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123" } ], "version": "1", "updateToken": "f4a5b6c7-7d8e-4f9a-8b1c-1d2e3f4a5b6c", "isSnapshot": false, "hasPublishedVersion": true, "deploymentCoverage": [ { "firewallType": "WAF", "policyArns": [ "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789" ], "inScopeResourceTypes": [ "AWS::ElasticLoadBalancingV2::LoadBalancer::application", "AWS::CloudFront::Distribution" ] } ] } } ], "smithy.api#http": { "uri": "/deployments/{deploymentIdentifier}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#GetDeploymentInput": { "type": "structure", "members": { "deploymentIdentifier": { "target": "com.amazonaws.networksecuritymanager#DeploymentIdentifier", "traits": { "smithy.api#documentation": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Deployment" } ] } }, "com.amazonaws.networksecuritymanager#GetDeploymentOutput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.networksecuritymanager#DeploymentId", "traits": { "smithy.api#documentation": "The service-generated id of the deployment.
", "smithy.api#required": {} } }, "deploymentArn": { "target": "com.amazonaws.networksecuritymanager#DeploymentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deployment.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "deploymentIdentifier" } }, "deploymentName": { "target": "com.amazonaws.networksecuritymanager#DeploymentName", "traits": { "smithy.api#documentation": "The name of the deployment.
", "smithy.api#required": {} } }, "deploymentDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the deployment.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
The configuration settings for the deployment.
" } }, "associatedPolicyList": { "target": "com.amazonaws.networksecuritymanager#AssociatedPolicyList", "traits": { "smithy.api#documentation": "The policies associated with the deployment.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "associatedScopeList": { "target": "com.amazonaws.networksecuritymanager#AssociatedScopeList", "traits": { "smithy.api#documentation": "The scope associated with the deployment. A deployment has exactly one scope.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } }, "deploymentCoverage": { "target": "com.amazonaws.networksecuritymanager#DeploymentCoverageList", "traits": { "smithy.api#documentation": "The coverage information for the deployment. For each firewall type, it shows which policies have that firewall type and which in-scope resource types the firewall type protects.
", "smithy.api#notProperty": {} } }, "warnings": { "target": "com.amazonaws.networksecuritymanager#DeploymentWarningList", "traits": { "smithy.api#documentation": "Warnings about potential issues, such as a policy that has no applicable resources in the deployment's scope.
", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#GetPolicy": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#GetPolicyInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#GetPolicyOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve a policy", "resources": { "required": { "policy": {}, "policy-snapshot": {} } } }, "smithy.api#documentation": "Retrieves the details of the specified policy.
", "smithy.api#examples": [ { "title": "Get a policy", "documentation": "Retrieves the current published version of a policy by its base ARN, including its associated templates and rules and its enforcement configuration.", "input": { "policyIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789" }, "output": { "policyId": "xyz789", "policyArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789", "policyName": "web-app-waf-policy", "policyDescription": "WAF policy for web application protection", "status": "ACTIVE", "priority": 1, "associatedTemplateAndRuleList": [ { "templateArn": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789" } ], "version": "1", "updateToken": "e3f4a5b6-6c7d-4e8f-9a0b-0c1d2e3f4a5b", "isSnapshot": false, "hasPublishedVersion": true, "firewallType": "WAF", "policyConfiguration": { "remediationEnabled": true, "resourcesCleanUp": false, "wafConfig": { "existingCustomerWebACLResolution": "NO_REMEDIATION", "conflictResolution": "MERGE_WHERE_APPLICABLE" } } } } ], "smithy.api#http": { "uri": "/policies/{policyIdentifier}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#GetPolicyInput": { "type": "structure", "members": { "policyIdentifier": { "target": "com.amazonaws.networksecuritymanager#PolicyIdentifier", "traits": { "smithy.api#documentation": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Policy" } ] } }, "com.amazonaws.networksecuritymanager#GetPolicyOutput": { "type": "structure", "members": { "policyId": { "target": "com.amazonaws.networksecuritymanager#PolicyId", "traits": { "smithy.api#documentation": "The service-generated id of the policy.
", "smithy.api#required": {} } }, "policyArn": { "target": "com.amazonaws.networksecuritymanager#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "policyIdentifier" } }, "policyName": { "target": "com.amazonaws.networksecuritymanager#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the policy.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The priority of the resource. A lower number indicates a higher priority.
", "smithy.api#required": {} } }, "associatedTemplateAndRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedTemplateAndRuleList", "traits": { "smithy.api#documentation": "The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "policyConfiguration": { "target": "com.amazonaws.networksecuritymanager#PolicyConfiguration", "traits": { "smithy.api#documentation": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#GetRule": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#GetRuleInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#GetRuleOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve a rule", "resources": { "required": { "rule": {}, "rule-snapshot": {} } } }, "smithy.api#documentation": "Retrieves the details of the specified rule.
", "smithy.api#examples": [ { "title": "Get a rule", "documentation": "Retrieves the current published version of a rule by its base ARN.", "input": { "ruleIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123" }, "output": { "ruleId": "abc123", "ruleArn": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123", "ruleName": "block-known-bad-ips", "firewallType": "WAF", "ruleType": "INSPECTION", "ruleDescription": "Blocks requests from known malicious IP addresses", "configuration": {}, "status": "ACTIVE", "version": "1", "updateToken": "c1d2e3f4-4a5b-4c6d-9e7f-8a9b0c1d2e3f", "isSnapshot": false, "hasPublishedVersion": true } }, { "title": "Get a specific version of a rule", "documentation": "Retrieves a specific immutable version (snapshot) of a rule using a version-qualified ARN. The response has isSnapshot set to true. Omitting the version qualifier returns the current published rule instead.", "input": { "ruleIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123:3" }, "output": { "ruleId": "abc123", "ruleArn": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123:3", "ruleName": "block-known-bad-ips", "firewallType": "WAF", "ruleType": "INSPECTION", "ruleDescription": "Blocks requests from known malicious IP addresses", "configuration": {}, "status": "ACTIVE", "version": "3", "isSnapshot": true } } ], "smithy.api#http": { "uri": "/rules/{ruleIdentifier}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#GetRuleInput": { "type": "structure", "members": { "ruleIdentifier": { "target": "com.amazonaws.networksecuritymanager#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Rule" } ] } }, "com.amazonaws.networksecuritymanager#GetRuleOutput": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.networksecuritymanager#RuleId", "traits": { "smithy.api#documentation": "The service-generated id of the rule.
", "smithy.api#required": {} } }, "ruleArn": { "target": "com.amazonaws.networksecuritymanager#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ruleIdentifier" } }, "ruleName": { "target": "com.amazonaws.networksecuritymanager#RuleName", "traits": { "smithy.api#documentation": "The name of the rule.
", "smithy.api#required": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType", "traits": { "smithy.api#documentation": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
A description of the rule.
" } }, "configuration": { "target": "com.amazonaws.networksecuritymanager#JsonDocument", "traits": { "smithy.api#documentation": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#GetScope": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#GetScopeInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#GetScopeOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve a scope", "resources": { "required": { "scope": {}, "scope-snapshot": {} } } }, "smithy.api#documentation": "Retrieves the details of the specified scope.
", "smithy.api#examples": [ { "title": "Get a scope", "documentation": "Retrieves the current published version of a scope by its base ARN.", "input": { "scopeIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123" }, "output": { "scopeId": "abc123", "scopeArn": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123", "scopeName": "production-web-apps", "scopeDescription": "Scope covering all production web application resources", "scopeConfiguration": { "accountFilter": { "includeAll": {} }, "resourceScopes": {} }, "status": "ACTIVE", "version": "1", "updateToken": "b0c4d1e2-3f4a-4b5c-8d6e-7f8a9b0c1d2e", "isSnapshot": false, "hasPublishedVersion": true } } ], "smithy.api#http": { "uri": "/scopes/{scopeIdentifier}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#GetScopeInput": { "type": "structure", "members": { "scopeIdentifier": { "target": "com.amazonaws.networksecuritymanager#ScopeIdentifier", "traits": { "smithy.api#documentation": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Scope" } ] } }, "com.amazonaws.networksecuritymanager#GetScopeOutput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networksecuritymanager#ScopeId", "traits": { "smithy.api#documentation": "The service-generated id of the scope.
", "smithy.api#required": {} } }, "scopeArn": { "target": "com.amazonaws.networksecuritymanager#ScopeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "scopeIdentifier" } }, "scopeName": { "target": "com.amazonaws.networksecuritymanager#ScopeName", "traits": { "smithy.api#documentation": "The name of the scope.
", "smithy.api#required": {} } }, "scopeDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the scope.
" } }, "scopeConfiguration": { "target": "com.amazonaws.networksecuritymanager#ScopeConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines which accounts and resources are in scope.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#GetTemplate": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#GetTemplateInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#GetTemplateOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to retrieve a template", "resources": { "required": { "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Retrieves the details of the specified template.
", "smithy.api#examples": [ { "title": "Get a template", "documentation": "Retrieves the current published version of a template by its base ARN, including its associated rules.", "input": { "templateIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789" }, "output": { "templateId": "xyz789", "templateArn": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789", "templateName": "standard-waf-template", "templateDescription": "Standard WAF template with baseline rule groups", "status": "ACTIVE", "version": "1", "associatedRuleList": [ { "ruleArn": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123" } ], "updateToken": "d2e3f4a5-5b6c-4d7e-8f9a-9b0c1d2e3f4a", "isSnapshot": false, "hasPublishedVersion": true, "firewallType": "WAF" } } ], "smithy.api#http": { "uri": "/templates/{templateIdentifier}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#GetTemplateInput": { "type": "structure", "members": { "templateIdentifier": { "target": "com.amazonaws.networksecuritymanager#TemplateIdentifier", "traits": { "smithy.api#documentation": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Template" } ] } }, "com.amazonaws.networksecuritymanager#GetTemplateOutput": { "type": "structure", "members": { "templateId": { "target": "com.amazonaws.networksecuritymanager#TemplateId", "traits": { "smithy.api#documentation": "The service-generated id of the template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.networksecuritymanager#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "templateIdentifier" } }, "templateName": { "target": "com.amazonaws.networksecuritymanager#TemplateName", "traits": { "smithy.api#documentation": "The name of the template.
", "smithy.api#required": {} } }, "templateDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the template.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "associatedRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedRuleList", "traits": { "smithy.api#documentation": "The rules associated with the template.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#TemplateFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#HasPublishedVersion": { "type": "boolean" }, "com.amazonaws.networksecuritymanager#IdempotencyToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "com.amazonaws.networksecuritymanager#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request processing failed because of an internal error in the service. This is a retryable error.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.networksecuritymanager#InvalidFirewallReasons": { "type": "structure", "members": { "incorrectSingleValueConfigurations": { "target": "com.amazonaws.networksecuritymanager#ConfigurationIssueList", "traits": { "smithy.api#documentation": "Single-value configuration settings whose values do not match the expected values.
" } }, "missingAppendableConfigurationValues": { "target": "com.amazonaws.networksecuritymanager#ConfigurationIssueList", "traits": { "smithy.api#documentation": "Appendable configuration values that are expected but missing.
" } }, "unexpectedAppendableConfigurationValues": { "target": "com.amazonaws.networksecuritymanager#ConfigurationIssueList", "traits": { "smithy.api#documentation": "Appendable configuration values that are present but not expected.
" } }, "incorrectAppendableConfigurationOrder": { "target": "com.amazonaws.networksecuritymanager#ConfigurationIssueList", "traits": { "smithy.api#documentation": "Appendable configuration values that are present but in the wrong order.
" } }, "missingMergeableConfigurationValues": { "target": "com.amazonaws.networksecuritymanager#ConfigurationIssueList", "traits": { "smithy.api#documentation": "Mergeable configuration values that are expected but missing.
" } }, "unexpectedMergeableConfigurationValues": { "target": "com.amazonaws.networksecuritymanager#ConfigurationIssueList", "traits": { "smithy.api#documentation": "Mergeable configuration values that are present but not expected.
" } } }, "traits": { "smithy.api#documentation": "Details about the ways in which a firewall's configuration differs from the intended configuration.
" } }, "com.amazonaws.networksecuritymanager#IpAddressType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ipv4" } }, "DUALSTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dualstack" } }, "DUALSTACK_WITHOUT_PUBLIC_IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "dualstack-without-public-ipv4" } } } }, "com.amazonaws.networksecuritymanager#IsPublished": { "type": "boolean" }, "com.amazonaws.networksecuritymanager#IsSnapshot": { "type": "boolean" }, "com.amazonaws.networksecuritymanager#JsonDocument": { "type": "document" }, "com.amazonaws.networksecuritymanager#ListAdminAccounts": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListAdminAccountsRequest" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListAdminAccountsResponse" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list Network Security Manager administrator accounts" }, "smithy.api#documentation": "Lists the AWS Network Security Manager administrator accounts in the organization.
", "smithy.api#examples": [ { "title": "List administrator accounts", "documentation": "Lists the Network Security Manager administrator accounts for the organization.", "input": { "maxResults": 10 }, "output": { "adminAccounts": [ { "accountId": "234567890123", "priority": 2 } ] } } ], "smithy.api#http": { "uri": "/admin-accounts", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "adminAccounts" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListAdminAccountsNotOnboarded", "params": {}, "expect": { "failure": { "errorId": "com.amazonaws.networksecuritymanager#ValidationException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.networksecuritymanager#ListAdminAccountsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.networksecuritymanager#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#ListAdminAccountsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "adminAccounts": { "target": "com.amazonaws.networksecuritymanager#AdminAccountSummaryList", "traits": { "smithy.api#documentation": "The list of administrator accounts.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListAggregateResourceSynchronizationStatuses": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListAggregateResourceSynchronizationStatusesInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListAggregateResourceSynchronizationStatusesOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list aggregate resource synchronization statuses across the caller's deployments" }, "smithy.api#documentation": "Lists the aggregated synchronization statuses of resources across the deployments in your administrator account. You can filter the results by synchronization status and page through them.
", "smithy.api#examples": [ { "title": "List synchronization statuses across all deployments", "documentation": "Lists the aggregate synchronization status of resources across all deployments in the account.", "input": { "synchronizationStatus": "IN_SYNC", "maxResults": 10 }, "output": { "resourceSynchronizationStatuses": [ { "synchronizationStatus": "IN_SYNC", "accountId": "234567890123", "resourceArn": "arn:aws:elasticloadbalancing:us-east-1:234567890123:loadbalancer/app/my-alb/50dc6c495c0c9188", "resourceType": "AWS::ElasticLoadBalancingV2::LoadBalancer::application", "updatedAt": "2026-08-20T12:00:00Z", "evaluatedAt": "2026-08-20T12:00:00Z" } ] } } ], "smithy.api#http": { "uri": "/aggregate-sync-statuses", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "resourceSynchronizationStatuses" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListAggregateResourceSynchronizationStatusesInput": { "type": "structure", "members": { "synchronizationStatus": { "target": "com.amazonaws.networksecuritymanager#SynchronizationStatus", "traits": { "smithy.api#documentation": "Filters the results by synchronization status, such as IN_SYNC or OUT_OF_SYNC.
The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#ListAggregateResourceSynchronizationStatusesOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "resourceSynchronizationStatuses": { "target": "com.amazonaws.networksecuritymanager#ResourceSynchronizationStatusSummaryList", "traits": { "smithy.api#documentation": "The list of resource synchronization statuses.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListDeploymentSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListDeploymentSnapshotsInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListDeploymentSnapshotsOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the snapshots of a deployment", "resources": { "required": { "deployment": {} } } }, "smithy.api#documentation": "Lists the snapshots of the specified deployment.
", "smithy.api#examples": [ { "title": "List the snapshots of a deployment", "documentation": "Lists the immutable snapshots that have been created for a deployment.", "input": { "deploymentIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456", "maxResults": 10 }, "output": { "snapshots": [ { "deploymentId": "def456", "deploymentArn": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456:2", "deploymentName": "prod-us-east-1-deployment", "status": "ACTIVE", "version": "2", "updatedAt": "2026-08-20T12:00:00Z" } ] } } ], "smithy.api#http": { "uri": "/deployments/{deploymentIdentifier}/snapshots", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshots" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListDeploymentSnapshotsInput": { "type": "structure", "members": { "deploymentIdentifier": { "target": "com.amazonaws.networksecuritymanager#DeploymentIdentifier", "traits": { "smithy.api#documentation": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.networksecuritymanager#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Deployment" } ] } }, "com.amazonaws.networksecuritymanager#ListDeploymentSnapshotsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#notProperty": {} } }, "snapshots": { "target": "com.amazonaws.networksecuritymanager#DeploymentSummaryList", "traits": { "smithy.api#documentation": "The snapshots of the deployment.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListDeployments": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListDeploymentsInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListDeploymentsOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list deployments" }, "smithy.api#documentation": "Lists the deployments in the account. You can filter the results by status and page through them using maxResults and nextToken.
The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatusFilter", "traits": { "smithy.api#documentation": "Filters the results by status: ACTIVE, DRAFT, or DISABLED.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "deployments": { "target": "com.amazonaws.networksecuritymanager#DeploymentSummaryList", "traits": { "smithy.api#documentation": "The list of deployments.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListPolicies": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListPoliciesInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListPoliciesOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list policies" }, "smithy.api#documentation": "Lists the policies in the account. You can filter the results by status and page through them using maxResults and nextToken.
The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatusFilter", "traits": { "smithy.api#documentation": "Filters the results by status, either ACTIVE or DRAFT.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "policies": { "target": "com.amazonaws.networksecuritymanager#PolicySummaryList", "traits": { "smithy.api#documentation": "The list of policies.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListPolicySnapshots": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListPolicySnapshotsInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListPolicySnapshotsOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the snapshots of a policy", "resources": { "required": { "policy": {} } } }, "smithy.api#documentation": "Lists the snapshots of the specified policy.
", "smithy.api#examples": [ { "title": "List the snapshots of a policy", "documentation": "Lists the immutable snapshots that have been created for a policy.", "input": { "policyIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789", "maxResults": 10 }, "output": { "snapshots": [ { "policyId": "xyz789", "policyArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789:2", "policyName": "web-app-waf-policy", "status": "ACTIVE", "version": "2", "firewallType": "WAF", "priority": 2, "updatedAt": "2026-08-20T12:00:00Z" } ] } } ], "smithy.api#http": { "uri": "/policies/{policyIdentifier}/snapshots", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshots" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListPolicySnapshotsInput": { "type": "structure", "members": { "policyIdentifier": { "target": "com.amazonaws.networksecuritymanager#PolicyIdentifier", "traits": { "smithy.api#documentation": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.networksecuritymanager#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Policy" } ] } }, "com.amazonaws.networksecuritymanager#ListPolicySnapshotsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#notProperty": {} } }, "snapshots": { "target": "com.amazonaws.networksecuritymanager#PolicySummaryList", "traits": { "smithy.api#documentation": "The snapshots of the policy.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListResourceAssociations": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListResourceAssociationsInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListResourceAssociationsOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamAction": { "documentation": "Grants permission to list the associations of a Network Security Manager resource", "resources": { "required": { "deployment": {}, "deployment-snapshot": {}, "policy": {}, "policy-snapshot": {}, "rule": {}, "rule-snapshot": {}, "scope": {}, "scope-snapshot": {}, "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Lists the resources associated with the specified resource.
", "smithy.api#examples": [ { "title": "List what references a rule", "documentation": "Lists the resources that reference the given rule, such as the templates and policies it is associated with.", "input": { "resourceIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123", "maxResults": 10 }, "output": { "resourceAssociations": [ { "arn": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789", "resourceType": "Template" }, { "arn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789", "resourceType": "Policy" } ] } } ], "smithy.api#http": { "uri": "/resource-associations", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "resourceAssociations" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListResourceAssociationsInput": { "type": "structure", "members": { "resourceIdentifier": { "target": "com.amazonaws.networksecuritymanager#ResourceIdentifier", "traits": { "smithy.api#documentation": "The identifier of the resource to list associations for. This is the resource's Amazon Resource Name (ARN).
", "smithy.api#httpQuery": "resourceIdentifier", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.networksecuritymanager#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#ListResourceAssociationsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "resourceAssociations": { "target": "com.amazonaws.networksecuritymanager#ResourceAssociationList", "traits": { "smithy.api#documentation": "The list of resource associations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListResourceSynchronizationStatuses": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListResourceSynchronizationStatusesInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListResourceSynchronizationStatusesOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list resource synchronization statuses for a deployment", "resources": { "required": { "deployment": {}, "deployment-snapshot": {} } } }, "smithy.api#documentation": "Lists the synchronization statuses of the resources covered by the specified deployment. You can filter the results by synchronization status and page through them.
", "smithy.api#examples": [ { "title": "List out-of-sync resources for a deployment", "documentation": "Lists the resources tracked by a deployment that are out of sync, including the structured reason. Here a CloudFront distribution has no web ACL where the policy requires one.", "input": { "deploymentIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456", "synchronizationStatus": "OUT_OF_SYNC", "maxResults": 10 }, "output": { "resourceSynchronizationStatuses": [ { "synchronizationStatus": "OUT_OF_SYNC", "accountId": "123456789012", "resourceArn": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE", "deploymentArn": "arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456", "resourceType": "AWS::CloudFront::Distribution", "updatedAt": "2026-08-20T12:00:00Z", "outOfSyncReasons": { "reasons": { "WAF": { "missingFirewall": "No web ACL is associated with the resource" } } }, "evaluatedAt": "2026-08-20T12:00:00Z" } ] } } ], "smithy.api#http": { "uri": "/resource-sync-statuses", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "resourceSynchronizationStatuses" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListResourceSynchronizationStatusesInput": { "type": "structure", "members": { "deploymentIdentifier": { "target": "com.amazonaws.networksecuritymanager#DeploymentIdentifier", "traits": { "smithy.api#documentation": "The identifier of the deployment to list synchronization statuses for. This is the deployment's Amazon Resource Name (ARN).
", "smithy.api#httpQuery": "deploymentIdentifier", "smithy.api#required": {} } }, "synchronizationStatus": { "target": "com.amazonaws.networksecuritymanager#SynchronizationStatus", "traits": { "smithy.api#documentation": "Filters the results by synchronization status, such as IN_SYNC or OUT_OF_SYNC.
The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Deployment" } ] } }, "com.amazonaws.networksecuritymanager#ListResourceSynchronizationStatusesOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#notProperty": {} } }, "resourceSynchronizationStatuses": { "target": "com.amazonaws.networksecuritymanager#ResourceSynchronizationStatusSummaryList", "traits": { "smithy.api#documentation": "The list of resource synchronization statuses.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListRuleSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListRuleSnapshotsInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListRuleSnapshotsOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the snapshots of a rule", "resources": { "required": { "rule": {} } } }, "smithy.api#documentation": "Lists the snapshots of the specified rule.
", "smithy.api#examples": [ { "title": "List the snapshots of a rule", "documentation": "Lists the immutable snapshots that have been created for a rule.", "input": { "ruleIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123", "maxResults": 10 }, "output": { "snapshots": [ { "ruleId": "abc123", "ruleArn": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123:2", "ruleName": "block-known-bad-ips", "firewallType": "WAF", "ruleType": "INSPECTION", "status": "ACTIVE", "version": "2", "updatedAt": "2026-08-20T12:00:00Z" }, { "ruleId": "abc123", "ruleArn": "arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123:3", "ruleName": "block-known-bad-ips", "firewallType": "WAF", "ruleType": "INSPECTION", "status": "ACTIVE", "version": "3", "updatedAt": "2026-08-21T09:30:00Z" } ] } } ], "smithy.api#http": { "uri": "/rules/{ruleIdentifier}/snapshots", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshots" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListRuleSnapshotsInput": { "type": "structure", "members": { "ruleIdentifier": { "target": "com.amazonaws.networksecuritymanager#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.networksecuritymanager#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Rule" } ] } }, "com.amazonaws.networksecuritymanager#ListRuleSnapshotsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#notProperty": {} } }, "snapshots": { "target": "com.amazonaws.networksecuritymanager#RuleSummaryList", "traits": { "smithy.api#documentation": "The snapshots of the rule.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListRules": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListRulesInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListRulesOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list rules" }, "smithy.api#documentation": "Lists the rules in the account. You can filter the results by status and page through them using maxResults and nextToken.
The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatusFilter", "traits": { "smithy.api#documentation": "Filters the results by status, either ACTIVE or DRAFT.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "rules": { "target": "com.amazonaws.networksecuritymanager#RuleSummaryList", "traits": { "smithy.api#documentation": "The list of rules.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListScopeSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListScopeSnapshotsInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListScopeSnapshotsOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the snapshots of a scope", "resources": { "required": { "scope": {} } } }, "smithy.api#documentation": "Lists the snapshots of the specified scope.
", "smithy.api#examples": [ { "title": "List the snapshots of a scope", "documentation": "Lists the immutable snapshots that have been created for a scope.", "input": { "scopeIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123", "maxResults": 10 }, "output": { "snapshots": [ { "scopeId": "abc123", "scopeArn": "arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123:2", "scopeName": "production-web-apps", "status": "ACTIVE", "version": "2", "updatedAt": "2026-08-20T12:00:00Z" } ] } } ], "smithy.api#http": { "uri": "/scopes/{scopeIdentifier}/snapshots", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshots" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListScopeSnapshotsInput": { "type": "structure", "members": { "scopeIdentifier": { "target": "com.amazonaws.networksecuritymanager#ScopeIdentifier", "traits": { "smithy.api#documentation": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.networksecuritymanager#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Scope" } ] } }, "com.amazonaws.networksecuritymanager#ListScopeSnapshotsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#notProperty": {} } }, "snapshots": { "target": "com.amazonaws.networksecuritymanager#ScopeSummaryList", "traits": { "smithy.api#documentation": "The snapshots of the scope.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListScopes": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListScopesInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListScopesOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list scopes" }, "smithy.api#documentation": "Lists the scopes in the account. You can filter the results by status and page through them using maxResults and nextToken.
The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatusFilter", "traits": { "smithy.api#documentation": "Filters the results by status: ACTIVE, DRAFT, or DISABLED.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "scopes": { "target": "com.amazonaws.networksecuritymanager#ScopeSummaryList", "traits": { "smithy.api#documentation": "The list of scopes.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#iamAction": { "documentation": "Grants permission to list the tags of a Network Security Manager resource", "resources": { "optional": { "deployment": {}, "deployment-snapshot": {}, "policy": {}, "policy-snapshot": {}, "rule": {}, "rule-snapshot": {}, "scope": {}, "scope-snapshot": {}, "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Lists the tags associated with the specified resource.
", "smithy.api#examples": [ { "title": "List the tags on a resource", "documentation": "Lists the tags associated with a Network Security Manager resource.", "input": { "resourceArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789" }, "output": { "tags": { "Environment": "Production", "Team": "NetworkSecurity" } } } ], "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "GET", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.networksecuritymanager#Arn", "traits": { "smithy.api#documentation": "The ARN of the resource to list tags for. The ARN must not include a :DRAFT qualifier.
The tags associated with the resource. Each tag is a key-value pair.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListTemplateSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListTemplateSnapshotsInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListTemplateSnapshotsOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list the snapshots of a template", "resources": { "required": { "template": {} } } }, "smithy.api#documentation": "Lists the snapshots of the specified template.
", "smithy.api#examples": [ { "title": "List the snapshots of a template", "documentation": "Lists the immutable snapshots that have been created for a template.", "input": { "templateIdentifier": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789", "maxResults": 10 }, "output": { "snapshots": [ { "templateId": "xyz789", "templateArn": "arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789:2", "templateName": "standard-waf-template", "status": "ACTIVE", "version": "2", "firewallType": "WAF", "updatedAt": "2026-08-20T12:00:00Z" } ] } } ], "smithy.api#http": { "uri": "/templates/{templateIdentifier}/snapshots", "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshots" }, "smithy.api#readonly": {} } }, "com.amazonaws.networksecuritymanager#ListTemplateSnapshotsInput": { "type": "structure", "members": { "templateIdentifier": { "target": "com.amazonaws.networksecuritymanager#TemplateIdentifier", "traits": { "smithy.api#documentation": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.networksecuritymanager#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Template" } ] } }, "com.amazonaws.networksecuritymanager#ListTemplateSnapshotsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.networksecuritymanager#NextToken", "traits": { "smithy.api#documentation": "The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#notProperty": {} } }, "snapshots": { "target": "com.amazonaws.networksecuritymanager#TemplateSummaryList", "traits": { "smithy.api#documentation": "The snapshots of the template.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#ListTemplates": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#ListTemplatesInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#ListTemplatesOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list templates" }, "smithy.api#documentation": "Lists the templates in the account. You can filter the results by status and page through them using maxResults and nextToken.
The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
", "smithy.api#httpQuery": "nextToken" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatusFilter", "traits": { "smithy.api#documentation": "Filters the results by status, either ACTIVE or DRAFT.
The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.
" } }, "templates": { "target": "com.amazonaws.networksecuritymanager#TemplateSummaryList", "traits": { "smithy.api#documentation": "The list of templates.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.networksecuritymanager#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^[0-9A-Za-z:/+=_-]+$" } }, "com.amazonaws.networksecuritymanager#NotVisibleMarker": { "type": "structure", "members": { "reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason the details are not visible.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Indicates that details are not visible because of cross-account restrictions.
" } }, "com.amazonaws.networksecuritymanager#OrganizationalUnit": { "type": "string", "traits": { "smithy.api#length": { "max": 68 } } }, "com.amazonaws.networksecuritymanager#OrganizationalUnitId": { "type": "string", "traits": { "smithy.api#length": { "min": 16, "max": 68 }, "smithy.api#pattern": "^(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" } }, "com.amazonaws.networksecuritymanager#OrganizationalUnitIdList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#OrganizationalUnitId" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#OrganizationalUnitList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#OrganizationalUnit" }, "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.networksecuritymanager#OrganizationalUnitReference": { "type": "structure", "members": { "ouId": { "target": "com.amazonaws.networksecuritymanager#OrganizationalUnitId", "traits": { "smithy.api#documentation": "The ID of the AWS Organizations organizational unit (OU).
", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display name of the organizational unit.
" } } }, "traits": { "smithy.api#documentation": "A reference to an AWS Organizations organizational unit (OU), with optional display metadata.
" } }, "com.amazonaws.networksecuritymanager#OrganizationalUnitReferenceList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#OrganizationalUnitReference" }, "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.networksecuritymanager#OutOfSyncReasons": { "type": "map", "key": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType" }, "value": { "target": "com.amazonaws.networksecuritymanager#FirewallSyncReason" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.networksecuritymanager#OutOfSyncReasonsView": { "type": "union", "members": { "reasons": { "target": "com.amazonaws.networksecuritymanager#OutOfSyncReasons", "traits": { "smithy.api#documentation": "The out-of-sync reasons, keyed by firewall type.
" } }, "notVisible": { "target": "com.amazonaws.networksecuritymanager#NotVisibleMarker", "traits": { "smithy.api#documentation": "Indicates that the details are not visible because of cross-account restrictions.
" } } }, "traits": { "smithy.api#documentation": "The out-of-sync reasons for a resource, or a marker indicating that the details are not visible. Exactly one member is set.
" } }, "com.amazonaws.networksecuritymanager#PiccoloCustomerAPIService": { "type": "service", "version": "2025-10-30", "operations": [ { "target": "com.amazonaws.networksecuritymanager#DeleteAdminAccount" }, { "target": "com.amazonaws.networksecuritymanager#GenerateRuleConfiguration" }, { "target": "com.amazonaws.networksecuritymanager#GetAdminAccount" }, { "target": "com.amazonaws.networksecuritymanager#ListAdminAccounts" }, { "target": "com.amazonaws.networksecuritymanager#ListAggregateResourceSynchronizationStatuses" }, { "target": "com.amazonaws.networksecuritymanager#ListResourceAssociations" }, { "target": "com.amazonaws.networksecuritymanager#ListTagsForResource" }, { "target": "com.amazonaws.networksecuritymanager#PutAdminAccount" }, { "target": "com.amazonaws.networksecuritymanager#TagResource" }, { "target": "com.amazonaws.networksecuritymanager#UntagResource" } ], "resources": [ { "target": "com.amazonaws.networksecuritymanager#Deployment" }, { "target": "com.amazonaws.networksecuritymanager#Policy" }, { "target": "com.amazonaws.networksecuritymanager#Rule" }, { "target": "com.amazonaws.networksecuritymanager#Scope" }, { "target": "com.amazonaws.networksecuritymanager#Template" } ], "traits": { "aws.api#service": { "sdkId": "Network Security Manager", "arnNamespace": "network-security-manager", "endpointPrefix": "network-security-manager", "cloudTrailEventSource": "network-security-manager.amazonaws.com" }, "aws.api#tagEnabled": {}, "aws.auth#sigv4": { "name": "network-security-manager" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.iam#defineConditionKeys": { "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" }, "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by the tags associated with the resource", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" }, "aws:TagKeys": { "type": "ArrayOfString", "documentation": "Filters access by the tag keys that are passed in the request", "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", "IAMRole", "FederatedUser" ], "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id", "x-amazon-apigateway-service-name" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id" ] }, "smithy.api#documentation": "AWS Network Security Manager helps you centrally configure and deploy network security protections across your organization. Supported protections include AWS WAF and AWS Shield Advanced. This centralized approach reduces the overhead of managing protections individually across accounts and ensures consistent security at scale.
You define reusable rules and templates, then combine them into policies. Next, you select the accounts and resources to protect with scopes and roll the protections out with deployments. For example, you can define a set of AWS WAF rules and group them into a policy. Then deploy that policy across all accounts in your organization with a single deployment.
This API reference describes the operations and data types for AWS Network Security Manager.
For conceptual information, tutorials, and guidance on writing rule configurations, see the AWS Network Security Manager Developer Guide. For the default quotas that apply to your account, see Quotas. For the service endpoints available in each Region, see AWS Network Security Manager endpoints and quotas in the AWS General Reference.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.api#title": "AWS Network Security Manager Customer API", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://network-security-manager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://network-security-manager.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://network-security-manager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://network-security-manager.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://network-security-manager-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://network-security-manager.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://network-security-manager-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://network-security-manager.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://network-security-manager-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://network-security-manager.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.networksecuritymanager#Policy": { "type": "resource", "identifiers": { "policyIdentifier": { "target": "com.amazonaws.networksecuritymanager#PolicyIdentifier" } }, "properties": { "policyId": { "target": "com.amazonaws.networksecuritymanager#PolicyId" }, "policyName": { "target": "com.amazonaws.networksecuritymanager#PolicyName" }, "policyDescription": { "target": "com.amazonaws.networksecuritymanager#Description" }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus" }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion" }, "priority": { "target": "com.amazonaws.networksecuritymanager#Priority" }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken" }, "isSnapshot": { "target": "com.amazonaws.networksecuritymanager#IsSnapshot" }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion" }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType" }, "policyConfiguration": { "target": "com.amazonaws.networksecuritymanager#PolicyConfiguration" }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp" } }, "create": { "target": "com.amazonaws.networksecuritymanager#CreatePolicy" }, "read": { "target": "com.amazonaws.networksecuritymanager#GetPolicy" }, "update": { "target": "com.amazonaws.networksecuritymanager#UpdatePolicy" }, "delete": { "target": "com.amazonaws.networksecuritymanager#DeletePolicy" }, "list": { "target": "com.amazonaws.networksecuritymanager#ListPolicies" }, "operations": [ { "target": "com.amazonaws.networksecuritymanager#CreatePolicySnapshot" }, { "target": "com.amazonaws.networksecuritymanager#ListPolicySnapshots" } ], "traits": { "aws.api#arn": { "template": "{policyIdentifier}", "absolute": true }, "aws.api#taggable": {}, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "policy", "relativeDocumentation": "policy.html" }, "smithy.api#documentation": "Represents a policy that combines templates and rules with enforcement configuration" } }, "com.amazonaws.networksecuritymanager#PolicyArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::NetworkSecurityManager::Policy" }, "smithy.api#length": { "min": 20, "max": 1010 }, "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)$" } }, "com.amazonaws.networksecuritymanager#PolicyConfiguration": { "type": "structure", "members": { "remediationEnabled": { "target": "com.amazonaws.networksecuritymanager#RemediationEnabled", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether AWS Network Security Manager automatically remediates noncompliant resources. Default: false.
Specifies whether AWS Network Security Manager automatically removes the resources it created when they are no longer needed. Default: false.
AWS WAF-specific policy settings. This is populated only for AWS WAF policies.
" } } }, "traits": { "smithy.api#documentation": "Configuration settings that control a policy's behavior.
" } }, "com.amazonaws.networksecuritymanager#PolicyFirewallType": { "type": "enum", "members": { "WAF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WAF" } }, "SHIELD_ADVANCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHIELD_ADVANCED" } } } }, "com.amazonaws.networksecuritymanager#PolicyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]{1,64}$" } }, "com.amazonaws.networksecuritymanager#PolicyIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1010 } } }, "com.amazonaws.networksecuritymanager#PolicyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9 _.:/=+\\-@]*$" } }, "com.amazonaws.networksecuritymanager#PolicyReference": { "type": "structure", "members": { "policyIdentifier": { "target": "com.amazonaws.networksecuritymanager#PolicyIdentifier", "traits": { "smithy.api#documentation": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN), optionally version-qualified to pin a specific published version.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A reference to a policy in a create or update request.
", "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Policy" } ] } }, "com.amazonaws.networksecuritymanager#PolicyReferenceList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#PolicyReference" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.networksecuritymanager#PolicySummary": { "type": "structure", "members": { "policyId": { "target": "com.amazonaws.networksecuritymanager#PolicyId", "traits": { "smithy.api#documentation": "The service-generated id of the policy.
", "smithy.api#required": {} } }, "policyArn": { "target": "com.amazonaws.networksecuritymanager#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", "smithy.api#required": {} } }, "policyName": { "target": "com.amazonaws.networksecuritymanager#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
" } }, "priority": { "target": "com.amazonaws.networksecuritymanager#Priority", "traits": { "smithy.api#documentation": "The priority of the resource. A lower number indicates a higher priority.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a policy.
" } }, "com.amazonaws.networksecuritymanager#PolicySummaryList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#PolicySummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#Priority": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.networksecuritymanager#PutAdminAccount": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#PutAdminAccountRequest" }, "output": { "target": "com.amazonaws.networksecuritymanager#PutAdminAccountResponse" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceUnavailableException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to set a Network Security Manager administrator account" }, "smithy.api#documentation": "Sets the AWS account that serves as an AWS Network Security Manager administrator account, and optionally configures the scope of resources that the administrator can manage.
You can't set an administrator account again immediately after you remove it, or while the service creates its service-linked role. Retry the request after a few minutes.
", "smithy.api#examples": [ { "title": "Designate an administrator account", "documentation": "Designates an account as a Network Security Manager administrator, scoped to a specific organizational unit and the WAF firewall type.", "input": { "accountId": "234567890123", "priority": 2, "adminScope": { "scopeFilter": { "includeOnly": { "organizationalUnits": [ "ou-abcd-12345678" ] } }, "firewallTypeScope": { "allFirewallTypesEnabled": false, "firewallTypes": [ "WAF" ] } } }, "output": { "adminAccountDetails": { "adminAccount": "234567890123", "priority": 2, "adminScope": { "scopeFilter": { "includeOnly": { "organizationalUnits": [ { "ouId": "ou-abcd-12345678", "name": "Production" } ] } }, "firewallTypeScope": { "allFirewallTypesEnabled": false, "firewallTypes": [ "WAF" ] } }, "status": "ONBOARDED" } } } ], "smithy.api#http": { "uri": "/admin-account", "method": "PUT", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#PutAdminAccountRequest": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.networksecuritymanager#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID to set as the AWS Network Security Manager administrator account.
", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.networksecuritymanager#AdminPriority", "traits": { "smithy.api#documentation": "The priority to assign to the administrator account.
", "smithy.api#required": {} } }, "adminScope": { "target": "com.amazonaws.networksecuritymanager#AdminScopeInput", "traits": { "smithy.api#documentation": "The scope of accounts, organizational units, and firewall types that the administrator can manage.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#PutAdminAccountResponse": { "type": "structure", "members": { "adminAccountDetails": { "target": "com.amazonaws.networksecuritymanager#AdminAccountDetails", "traits": { "smithy.api#documentation": "The details of the administrator account that was set.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#RemediationEnabled": { "type": "boolean" }, "com.amazonaws.networksecuritymanager#RemediationIssueDetails": { "type": "structure", "members": { "issueType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of remediation issue.
" } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable description of the remediation issue.
" } }, "correctiveAction": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A recommended action for resolving the remediation issue.
" } } }, "traits": { "smithy.api#documentation": "Details about a remediation issue for a firewall type.
" } }, "com.amazonaws.networksecuritymanager#RemediationIssues": { "type": "map", "key": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType" }, "value": { "target": "com.amazonaws.networksecuritymanager#RemediationIssueDetails" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.networksecuritymanager#RemediationIssuesView": { "type": "union", "members": { "issues": { "target": "com.amazonaws.networksecuritymanager#RemediationIssues", "traits": { "smithy.api#documentation": "The remediation issues, keyed by firewall type.
" } }, "notVisible": { "target": "com.amazonaws.networksecuritymanager#NotVisibleMarker", "traits": { "smithy.api#documentation": "Indicates that the details are not visible because of cross-account restrictions.
" } } }, "traits": { "smithy.api#documentation": "Remediation issue details for a resource, or a marker indicating that the details are not visible. Exactly one member is set.
" } }, "com.amazonaws.networksecuritymanager#ResourceArnList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#Arn" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#ResourceAssociation": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.networksecuritymanager#Arn", "traits": { "smithy.api#documentation": "The ARN of the associated resource.
", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.networksecuritymanager#ServiceResourceType", "traits": { "smithy.api#documentation": "The type of the associated resource, such as Policy, Template, or Deployment.
Describes an association between a resource and another entity.
" } }, "com.amazonaws.networksecuritymanager#ResourceAssociationList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#ResourceAssociation" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#ResourceCriteria": { "type": "union", "members": { "tags": { "target": "com.amazonaws.networksecuritymanager#StringMap", "traits": { "smithy.api#documentation": "Tag key-value pairs used to match resources.
" } }, "albConfig": { "target": "com.amazonaws.networksecuritymanager#AlbConfiguration", "traits": { "smithy.api#documentation": "Filter criteria specific to Application Load Balancers.
" } } }, "traits": { "smithy.api#documentation": "A leaf condition that matches resources by tag or by resource-type-specific configuration.
" } }, "com.amazonaws.networksecuritymanager#ResourceIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1010 } } }, "com.amazonaws.networksecuritymanager#ResourceLogicalExpression": { "type": "union", "members": { "criteria": { "target": "com.amazonaws.networksecuritymanager#ResourceCriteria", "traits": { "smithy.api#documentation": "A leaf condition that matches resources by tag or by resource-type-specific configuration.
" } }, "and": { "target": "com.amazonaws.networksecuritymanager#ResourceLogicalExpressionList", "traits": { "smithy.api#documentation": "A list of subexpressions that must all match.
" } }, "or": { "target": "com.amazonaws.networksecuritymanager#ResourceLogicalExpressionList", "traits": { "smithy.api#documentation": "A list of subexpressions of which at least one must match.
" } }, "not": { "target": "com.amazonaws.networksecuritymanager#ResourceLogicalExpression", "traits": { "smithy.api#documentation": "A subexpression that must not match.
" } } }, "traits": { "smithy.api#documentation": "A logical expression that selects resources. Exactly one of criteria, and, or, or not is set.
The ID of the resource that could not be found.
" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource that could not be found.
" } } }, "traits": { "smithy.api#documentation": "The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.networksecuritymanager#ResourceScope": { "type": "structure", "members": { "includeAll": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Includes all resources of the resource type.
" } }, "include": { "target": "com.amazonaws.networksecuritymanager#ResourceSet", "traits": { "smithy.api#documentation": "Includes the resources that match the specified criteria or explicit ARNs.
" } }, "exclude": { "target": "com.amazonaws.networksecuritymanager#ResourceSet", "traits": { "smithy.api#documentation": "Excludes the resources that match the specified criteria or explicit ARNs.
" } } }, "traits": { "smithy.api#documentation": "Defines which resources of a given type are in scope. Exactly one of includeAll, include, or exclude is set.
An explicit list of resource ARNs.
" } }, "expression": { "target": "com.amazonaws.networksecuritymanager#ResourceLogicalExpression", "traits": { "smithy.api#documentation": "A logical expression that selects resources by combining criteria with AND, OR, and NOT operators.
" } } }, "traits": { "smithy.api#documentation": "A set of resources defined by explicit ARNs, a logical expression, or both.
" } }, "com.amazonaws.networksecuritymanager#ResourceSynchronizationStatusSummary": { "type": "structure", "members": { "synchronizationStatus": { "target": "com.amazonaws.networksecuritymanager#SynchronizationStatus", "traits": { "smithy.api#documentation": "The synchronization status of the resource, such as IN_SYNC or OUT_OF_SYNC.
The AWS account ID that owns the resource.
", "smithy.api#required": {} } }, "resourceArn": { "target": "com.amazonaws.networksecuritymanager#Arn", "traits": { "smithy.api#documentation": "The ARN of the resource whose synchronization status is reported.
", "smithy.api#required": {} } }, "deploymentArn": { "target": "com.amazonaws.networksecuritymanager#DeploymentArn", "traits": { "smithy.api#documentation": "The ARN of the deployment that the synchronization status is associated with. This is absent for aggregate (cross-deployment) statuses.
" } }, "resourceType": { "target": "com.amazonaws.networksecuritymanager#ResourceType", "traits": { "smithy.api#documentation": "The type of the resource, in AWS CloudFormation format.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
", "smithy.api#required": {} } }, "outOfSyncReasons": { "target": "com.amazonaws.networksecuritymanager#OutOfSyncReasonsView", "traits": { "smithy.api#documentation": "The reasons the resource is out of sync, keyed by firewall type. This is null when the resource is in sync.
" } }, "remediationIssues": { "target": "com.amazonaws.networksecuritymanager#RemediationIssuesView", "traits": { "smithy.api#documentation": "Details about remediation issues, keyed by firewall type. This is null when there are no remediation issues.
" } }, "evaluatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the synchronization status was last evaluated.
" } } }, "traits": { "smithy.api#documentation": "The synchronization status of a resource covered by a deployment.
", "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Deployment", "ids": { "deploymentIdentifier": "deploymentArn" } } ] } }, "com.amazonaws.networksecuritymanager#ResourceSynchronizationStatusSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#ResourceSynchronizationStatusSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#ResourceType": { "type": "enum", "members": { "APIGW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ApiGateway::Stage" } }, "CFD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::CloudFront::Distribution" } }, "EIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::EIP" } }, "ALB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ElasticLoadBalancingV2::LoadBalancer::application" } }, "CLB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ElasticLoadBalancing::LoadBalancer" } }, "WAF_V2_WEBACL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::WAFv2::WebACL" } }, "SHIELD_PROTECTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::Shield::Protection" } }, "SHIELDREGIONAL_PROTECTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ShieldRegional::Protection" } } } }, "com.amazonaws.networksecuritymanager#ResourcesCleanUp": { "type": "boolean" }, "com.amazonaws.networksecuritymanager#Rule": { "type": "resource", "identifiers": { "ruleIdentifier": { "target": "com.amazonaws.networksecuritymanager#RuleIdentifier" } }, "properties": { "ruleId": { "target": "com.amazonaws.networksecuritymanager#RuleId" }, "ruleName": { "target": "com.amazonaws.networksecuritymanager#RuleName" }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType" }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType" }, "ruleDescription": { "target": "com.amazonaws.networksecuritymanager#Description" }, "configuration": { "target": "com.amazonaws.networksecuritymanager#JsonDocument" }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus" }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion" }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken" }, "isSnapshot": { "target": "com.amazonaws.networksecuritymanager#IsSnapshot" }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion" }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp" } }, "create": { "target": "com.amazonaws.networksecuritymanager#CreateRule" }, "read": { "target": "com.amazonaws.networksecuritymanager#GetRule" }, "update": { "target": "com.amazonaws.networksecuritymanager#UpdateRule" }, "delete": { "target": "com.amazonaws.networksecuritymanager#DeleteRule" }, "list": { "target": "com.amazonaws.networksecuritymanager#ListRules" }, "operations": [ { "target": "com.amazonaws.networksecuritymanager#CreateRuleSnapshot" }, { "target": "com.amazonaws.networksecuritymanager#ListRuleSnapshots" } ], "traits": { "aws.api#arn": { "template": "{ruleIdentifier}", "absolute": true }, "aws.api#taggable": {}, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "rule", "relativeDocumentation": "rule.html" }, "smithy.api#documentation": "Represents a rule that defines a network security configuration to enforce" } }, "com.amazonaws.networksecuritymanager#RuleArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::NetworkSecurityManager::Rule" }, "smithy.api#length": { "min": 20, "max": 1010 }, "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)$" } }, "com.amazonaws.networksecuritymanager#RuleFirewallType": { "type": "enum", "members": { "WAF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WAF" } } } }, "com.amazonaws.networksecuritymanager#RuleId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]{1,64}$" } }, "com.amazonaws.networksecuritymanager#RuleIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1010 } } }, "com.amazonaws.networksecuritymanager#RuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9 _.:/=+\\-@]*$" } }, "com.amazonaws.networksecuritymanager#RuleReference": { "type": "structure", "members": { "ruleIdentifier": { "target": "com.amazonaws.networksecuritymanager#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A reference to a rule in a create or update request.
", "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Rule" } ] } }, "com.amazonaws.networksecuritymanager#RuleReferenceList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#RuleReference" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.networksecuritymanager#RuleSummary": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.networksecuritymanager#RuleId", "traits": { "smithy.api#documentation": "The service-generated id of the rule.
", "smithy.api#required": {} } }, "ruleArn": { "target": "com.amazonaws.networksecuritymanager#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
", "smithy.api#required": {} } }, "ruleName": { "target": "com.amazonaws.networksecuritymanager#RuleName", "traits": { "smithy.api#documentation": "The name of the rule.
", "smithy.api#required": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
" } }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType", "traits": { "smithy.api#documentation": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a rule.
" } }, "com.amazonaws.networksecuritymanager#RuleSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#RuleSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#RuleType": { "type": "enum", "members": { "CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONFIGURATION" } }, "INSPECTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSPECTION" } } } }, "com.amazonaws.networksecuritymanager#Scheme": { "type": "enum", "members": { "INTERNET_FACING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "internet-facing" } }, "INTERNAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "internal" } } } }, "com.amazonaws.networksecuritymanager#Scope": { "type": "resource", "identifiers": { "scopeIdentifier": { "target": "com.amazonaws.networksecuritymanager#ScopeIdentifier" } }, "properties": { "scopeId": { "target": "com.amazonaws.networksecuritymanager#ScopeId" }, "scopeName": { "target": "com.amazonaws.networksecuritymanager#ScopeName" }, "scopeDescription": { "target": "com.amazonaws.networksecuritymanager#Description" }, "scopeConfiguration": { "target": "com.amazonaws.networksecuritymanager#ScopeConfiguration" }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus" }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion" }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken" }, "isSnapshot": { "target": "com.amazonaws.networksecuritymanager#IsSnapshot" }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion" }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp" } }, "create": { "target": "com.amazonaws.networksecuritymanager#CreateScope" }, "read": { "target": "com.amazonaws.networksecuritymanager#GetScope" }, "update": { "target": "com.amazonaws.networksecuritymanager#UpdateScope" }, "delete": { "target": "com.amazonaws.networksecuritymanager#DeleteScope" }, "list": { "target": "com.amazonaws.networksecuritymanager#ListScopes" }, "operations": [ { "target": "com.amazonaws.networksecuritymanager#CreateScopeSnapshot" }, { "target": "com.amazonaws.networksecuritymanager#ListScopeSnapshots" } ], "traits": { "aws.api#arn": { "template": "{scopeIdentifier}", "absolute": true }, "aws.api#taggable": {}, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "scope", "relativeDocumentation": "scope.html" }, "smithy.api#documentation": "Represents a scope that selects the accounts and resources a deployment applies to" } }, "com.amazonaws.networksecuritymanager#ScopeArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::NetworkSecurityManager::Scope" }, "smithy.api#length": { "min": 20, "max": 1010 }, "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)$" } }, "com.amazonaws.networksecuritymanager#ScopeConfiguration": { "type": "structure", "members": { "accountFilter": { "target": "com.amazonaws.networksecuritymanager#AccountFilter", "traits": { "smithy.api#documentation": "The account filter that determines which accounts are in scope. When set, exactly one of includeAll, include, or exclude is set.
Organization administrators must include an account filter in every scope configuration. Single-account administrators must omit it: a scope without an account filter applies only to the administrator's own account. The presence of an account filter is fixed when the scope is created: an update can't add an account filter to a scope that was created without one, or remove the account filter from a scope that was created with one.
" } }, "resourceScopes": { "target": "com.amazonaws.networksecuritymanager#ResourceScopeMap", "traits": { "smithy.api#documentation": "The resource-level scoping configuration, keyed by resource type, that defines which resources within the selected accounts are in scope.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Defines which accounts and resources are in scope.
" } }, "com.amazonaws.networksecuritymanager#ScopeId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]{1,64}$" } }, "com.amazonaws.networksecuritymanager#ScopeIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1010 } } }, "com.amazonaws.networksecuritymanager#ScopeName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9 _.:/=+\\-@]*$" } }, "com.amazonaws.networksecuritymanager#ScopeReference": { "type": "structure", "members": { "scopeIdentifier": { "target": "com.amazonaws.networksecuritymanager#ScopeIdentifier", "traits": { "smithy.api#documentation": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A reference to a scope in a create or update request.
", "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Scope" } ] } }, "com.amazonaws.networksecuritymanager#ScopeReferenceList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#ScopeReference" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.networksecuritymanager#ScopeResourceType": { "type": "enum", "members": { "APIGW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ApiGateway::Stage" } }, "CFD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::CloudFront::Distribution" } }, "EIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::EIP" } }, "ALB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ElasticLoadBalancingV2::LoadBalancer::application" } }, "CLB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ElasticLoadBalancing::LoadBalancer" } } } }, "com.amazonaws.networksecuritymanager#ScopeSummary": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networksecuritymanager#ScopeId", "traits": { "smithy.api#documentation": "The service-generated id of the scope.
", "smithy.api#required": {} } }, "scopeArn": { "target": "com.amazonaws.networksecuritymanager#ScopeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {} } }, "scopeName": { "target": "com.amazonaws.networksecuritymanager#ScopeName", "traits": { "smithy.api#documentation": "The name of the scope.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable), ACTIVE (published, in use), or DISABLED (deactivated; changes cannot be published until the resource is re-enabled).
The version of the resource.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a scope.
" } }, "com.amazonaws.networksecuritymanager#ScopeSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#ScopeSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#SensitiveAccountEmail": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 64 }, "smithy.api#sensitive": {} } }, "com.amazonaws.networksecuritymanager#SensitiveAccountName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#sensitive": {} } }, "com.amazonaws.networksecuritymanager#SensitiveEmail": { "type": "string", "traits": { "smithy.api#length": { "max": 256 }, "smithy.api#sensitive": {} } }, "com.amazonaws.networksecuritymanager#SensitiveName": { "type": "string", "traits": { "smithy.api#length": { "max": 256 }, "smithy.api#sensitive": {} } }, "com.amazonaws.networksecuritymanager#SensitiveString": { "type": "string", "traits": { "smithy.api#length": { "max": 32768 }, "smithy.api#sensitive": {} } }, "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code that identifies the service quota that was exceeded.
" } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code for the AWS service that owns the quota that was exceeded.
" } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the resource associated with the quota that was exceeded.
" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource associated with the quota that was exceeded.
" } } }, "traits": { "smithy.api#documentation": "The request would exceed a service quota.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.networksecuritymanager#ServiceResourceType": { "type": "enum", "members": { "RULE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Rule" } }, "TEMPLATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Template" } }, "POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Policy" } }, "DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Deployment" } }, "SCOPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Scope" } } } }, "com.amazonaws.networksecuritymanager#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of seconds to wait before retrying the request.
" } } }, "traits": { "smithy.api#documentation": "The service is temporarily unavailable. This is a retryable error.
", "smithy.api#error": "server", "smithy.api#httpError": 503, "smithy.api#retryable": {} } }, "com.amazonaws.networksecuritymanager#StringMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#SynchronizationStatus": { "type": "enum", "members": { "IN_SYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_SYNC" } }, "OUT_OF_SYNC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OUT_OF_SYNC" } }, "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_APPLICABLE" } } } }, "com.amazonaws.networksecuritymanager#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.networksecuritymanager#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#TagKey" }, "traits": { "smithy.api#length": { "max": 200 } } }, "com.amazonaws.networksecuritymanager#TagMap": { "type": "map", "key": { "target": "com.amazonaws.networksecuritymanager#TagKey" }, "value": { "target": "com.amazonaws.networksecuritymanager#TagValue" }, "traits": { "smithy.api#length": { "max": 200 } } }, "com.amazonaws.networksecuritymanager#TagPolicyViolationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request violates a tag policy that is in effect for the account or organization.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.networksecuritymanager#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#TagResourceInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#TagPolicyViolationException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys", "aws:ResourceTag/${TagKey}" ], "aws.iam#iamAction": { "documentation": "Grants permission to add or overwrite tags on a Network Security Manager resource", "resources": { "optional": { "deployment": {}, "deployment-snapshot": {}, "policy": {}, "policy-snapshot": {}, "rule": {}, "rule-snapshot": {}, "scope": {}, "scope-snapshot": {}, "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Adds or overwrites the specified tags on the given resource.
", "smithy.api#examples": [ { "title": "Tag a resource", "documentation": "Adds tags to a Network Security Manager resource.", "input": { "resourceArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789", "tags": { "Environment": "Production", "Team": "NetworkSecurity" } } } ], "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.networksecuritymanager#Arn", "traits": { "smithy.api#documentation": "The ARN of the resource to tag. The ARN must not include a :DRAFT qualifier.
The tags to add to the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#TagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.networksecuritymanager#Template": { "type": "resource", "identifiers": { "templateIdentifier": { "target": "com.amazonaws.networksecuritymanager#TemplateIdentifier" } }, "properties": { "templateId": { "target": "com.amazonaws.networksecuritymanager#TemplateId" }, "templateName": { "target": "com.amazonaws.networksecuritymanager#TemplateName" }, "templateDescription": { "target": "com.amazonaws.networksecuritymanager#Description" }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus" }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion" }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken" }, "isSnapshot": { "target": "com.amazonaws.networksecuritymanager#IsSnapshot" }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion" }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#TemplateFirewallType" }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp" } }, "create": { "target": "com.amazonaws.networksecuritymanager#CreateTemplate" }, "read": { "target": "com.amazonaws.networksecuritymanager#GetTemplate" }, "update": { "target": "com.amazonaws.networksecuritymanager#UpdateTemplate" }, "delete": { "target": "com.amazonaws.networksecuritymanager#DeleteTemplate" }, "list": { "target": "com.amazonaws.networksecuritymanager#ListTemplates" }, "operations": [ { "target": "com.amazonaws.networksecuritymanager#CreateTemplateSnapshot" }, { "target": "com.amazonaws.networksecuritymanager#ListTemplateSnapshots" } ], "traits": { "aws.api#arn": { "template": "{templateIdentifier}", "absolute": true }, "aws.api#taggable": {}, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "template", "relativeDocumentation": "template.html" }, "smithy.api#documentation": "Represents a template that groups rules for reuse across policies" } }, "com.amazonaws.networksecuritymanager#TemplateAndRuleReferenceList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#TemplateOrRuleReference" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.networksecuritymanager#TemplateArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::NetworkSecurityManager::Template" }, "smithy.api#length": { "min": 20, "max": 1010 }, "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)$" } }, "com.amazonaws.networksecuritymanager#TemplateFirewallType": { "type": "enum", "members": { "WAF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WAF" } } } }, "com.amazonaws.networksecuritymanager#TemplateId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]{1,64}$" } }, "com.amazonaws.networksecuritymanager#TemplateIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1010 } } }, "com.amazonaws.networksecuritymanager#TemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9 _.:/=+\\-@]*$" } }, "com.amazonaws.networksecuritymanager#TemplateOrRuleReference": { "type": "union", "members": { "templateIdentifier": { "target": "com.amazonaws.networksecuritymanager#TemplateIdentifier", "traits": { "smithy.api#documentation": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "smithy.api#suppress": [ "MemberShouldReferenceResource" ] } }, "ruleIdentifier": { "target": "com.amazonaws.networksecuritymanager#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "smithy.api#suppress": [ "MemberShouldReferenceResource" ] } } }, "traits": { "smithy.api#documentation": "A reference to either a template or a rule in a create or update request. Set exactly one of templateIdentifier or ruleIdentifier.
The service-generated id of the template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.networksecuritymanager#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {} } }, "templateName": { "target": "com.amazonaws.networksecuritymanager#TemplateName", "traits": { "smithy.api#documentation": "The name of the template.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#TemplateFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a template.
" } }, "com.amazonaws.networksecuritymanager#TemplateSummaryList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#TemplateSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of seconds to wait before retrying the request.
" } } }, "traits": { "smithy.api#documentation": "The request was denied because of request throttling. Reduce your request rate and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.networksecuritymanager#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#UntagResourceInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#TagPolicyViolationException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#conditionKeys": [ "aws:TagKeys", "aws:ResourceTag/${TagKey}" ], "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from a Network Security Manager resource", "resources": { "optional": { "deployment": {}, "deployment-snapshot": {}, "policy": {}, "policy-snapshot": {}, "rule": {}, "rule-snapshot": {}, "scope": {}, "scope-snapshot": {}, "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Removes the specified tags from the given resource.
", "smithy.api#examples": [ { "title": "Remove tags from a resource", "documentation": "Removes the specified tag keys from a Network Security Manager resource.", "input": { "resourceArn": "arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789", "tagKeys": [ "Environment" ] } } ], "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.networksecuritymanager#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.networksecuritymanager#Arn", "traits": { "smithy.api#documentation": "The ARN of the resource to remove tags from. The ARN must not include a :DRAFT qualifier.
The keys of the tags to remove from the resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.networksecuritymanager#UntagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#UpdateDeployment": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#UpdateDeploymentInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#UpdateDeploymentOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a deployment", "resources": { "required": { "deployment": {} }, "optional": { "policy": {}, "policy-snapshot": {}, "scope": {}, "scope-snapshot": {} } } }, "smithy.api#documentation": "Updates the specified deployment. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the deployment as a draft.
The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
A description of the deployment.
" } }, "deploymentConfiguration": { "target": "com.amazonaws.networksecuritymanager#DeploymentConfiguration", "traits": { "smithy.api#documentation": "The configuration settings for the deployment.
" } }, "associatedPolicyList": { "target": "com.amazonaws.networksecuritymanager#PolicyReferenceList", "traits": { "smithy.api#documentation": "The policies associated with the deployment.
", "smithy.api#notProperty": {} } }, "associatedScopeList": { "target": "com.amazonaws.networksecuritymanager#ScopeReferenceList", "traits": { "smithy.api#documentation": "The scope associated with the deployment. A deployment has exactly one scope.
", "smithy.api#notProperty": {} } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {}, "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Deployment" } ] } }, "com.amazonaws.networksecuritymanager#UpdateDeploymentOutput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.networksecuritymanager#DeploymentId", "traits": { "smithy.api#documentation": "The service-generated id of the deployment.
", "smithy.api#required": {} } }, "deploymentArn": { "target": "com.amazonaws.networksecuritymanager#DeploymentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deployment.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "deploymentIdentifier" } }, "deploymentName": { "target": "com.amazonaws.networksecuritymanager#DeploymentName", "traits": { "smithy.api#documentation": "The name of the deployment.
", "smithy.api#required": {} } }, "deploymentDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the deployment.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The configuration settings for the deployment.
" } }, "associatedPolicyList": { "target": "com.amazonaws.networksecuritymanager#AssociatedPolicyList", "traits": { "smithy.api#documentation": "The policies associated with the deployment.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "associatedScopeList": { "target": "com.amazonaws.networksecuritymanager#AssociatedScopeList", "traits": { "smithy.api#documentation": "The scope associated with the deployment. A deployment has exactly one scope.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "deploymentCoverage": { "target": "com.amazonaws.networksecuritymanager#DeploymentCoverageList", "traits": { "smithy.api#documentation": "The coverage information for the deployment. For each firewall type, it shows which policies have that firewall type and which in-scope resource types the firewall type protects.
", "smithy.api#notProperty": {} } }, "warnings": { "target": "com.amazonaws.networksecuritymanager#DeploymentWarningList", "traits": { "smithy.api#documentation": "Warnings about potential issues, such as a policy that has no applicable resources in the deployment's scope.
", "smithy.api#notProperty": {} } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#UpdatePolicy": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#UpdatePolicyInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#UpdatePolicyOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a policy", "resources": { "required": { "policy": {} }, "optional": { "rule": {}, "rule-snapshot": {}, "template": {}, "template-snapshot": {} } } }, "smithy.api#documentation": "Updates the specified policy. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the policy as a draft.
The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
A description of the policy.
" } }, "priority": { "target": "com.amazonaws.networksecuritymanager#Priority", "traits": { "smithy.api#documentation": "The priority of the resource. A lower number indicates a higher priority.
" } }, "associatedTemplateAndRuleList": { "target": "com.amazonaws.networksecuritymanager#TemplateAndRuleReferenceList", "traits": { "smithy.api#documentation": "The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.
", "smithy.api#notProperty": {} } }, "policyConfiguration": { "target": "com.amazonaws.networksecuritymanager#PolicyConfiguration", "traits": { "smithy.api#documentation": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
" } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {}, "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Policy" } ] } }, "com.amazonaws.networksecuritymanager#UpdatePolicyOutput": { "type": "structure", "members": { "policyId": { "target": "com.amazonaws.networksecuritymanager#PolicyId", "traits": { "smithy.api#documentation": "The service-generated id of the policy.
", "smithy.api#required": {} } }, "policyArn": { "target": "com.amazonaws.networksecuritymanager#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "policyIdentifier" } }, "policyName": { "target": "com.amazonaws.networksecuritymanager#PolicyName", "traits": { "smithy.api#documentation": "The name of the policy.
", "smithy.api#required": {} } }, "policyDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the policy.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The priority of the resource. A lower number indicates a higher priority.
", "smithy.api#required": {} } }, "associatedTemplateAndRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedTemplateAndRuleList", "traits": { "smithy.api#documentation": "The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.networksecuritymanager#EntityVersion", "traits": { "smithy.api#documentation": "The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#PolicyFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "policyConfiguration": { "target": "com.amazonaws.networksecuritymanager#PolicyConfiguration", "traits": { "smithy.api#documentation": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#UpdateRule": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#UpdateRuleInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#UpdateRuleOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a rule", "resources": { "required": { "rule": {} } } }, "smithy.api#documentation": "Updates the specified rule. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the rule as a draft.
The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
A description of the rule.
" } }, "configuration": { "target": "com.amazonaws.networksecuritymanager#JsonDocument", "traits": { "smithy.api#documentation": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF INSPECTION rule, provide an AWS WAF rule group. For an AWS WAF CONFIGURATION rule, provide a single web ACL setting, such as DefaultAction or VisibilityConfig; use wafConfigDataType to declare which setting the document contains. For the schema of each setting and complete examples, see Writing rule configurations in the AWS Network Security Manager Developer Guide.
Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {}, "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Rule" } ] } }, "com.amazonaws.networksecuritymanager#UpdateRuleOutput": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.networksecuritymanager#RuleId", "traits": { "smithy.api#documentation": "The service-generated id of the rule.
", "smithy.api#required": {} } }, "ruleArn": { "target": "com.amazonaws.networksecuritymanager#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ruleIdentifier" } }, "ruleName": { "target": "com.amazonaws.networksecuritymanager#RuleName", "traits": { "smithy.api#documentation": "The name of the rule.
", "smithy.api#required": {} } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#RuleFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "ruleType": { "target": "com.amazonaws.networksecuritymanager#RuleType", "traits": { "smithy.api#documentation": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
A description of the rule.
" } }, "configuration": { "target": "com.amazonaws.networksecuritymanager#JsonDocument", "traits": { "smithy.api#documentation": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#UpdateScope": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#UpdateScopeInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#UpdateScopeOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a scope", "resources": { "required": { "scope": {} } } }, "smithy.api#documentation": "Updates the specified scope. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the scope as a draft.
The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
A description of the scope.
" } }, "scopeConfiguration": { "target": "com.amazonaws.networksecuritymanager#ScopeConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.
A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.
" } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {}, "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Scope" } ] } }, "com.amazonaws.networksecuritymanager#UpdateScopeOutput": { "type": "structure", "members": { "scopeId": { "target": "com.amazonaws.networksecuritymanager#ScopeId", "traits": { "smithy.api#documentation": "The service-generated id of the scope.
", "smithy.api#required": {} } }, "scopeArn": { "target": "com.amazonaws.networksecuritymanager#ScopeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scope.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "scopeIdentifier" } }, "scopeName": { "target": "com.amazonaws.networksecuritymanager#ScopeName", "traits": { "smithy.api#documentation": "The name of the scope.
", "smithy.api#required": {} } }, "scopeDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the scope.
" } }, "scopeConfiguration": { "target": "com.amazonaws.networksecuritymanager#ScopeConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines which accounts and resources are in scope.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#UpdateTemplate": { "type": "operation", "input": { "target": "com.amazonaws.networksecuritymanager#UpdateTemplateInput" }, "output": { "target": "com.amazonaws.networksecuritymanager#UpdateTemplateOutput" }, "errors": [ { "target": "com.amazonaws.networksecuritymanager#AccessDeniedException" }, { "target": "com.amazonaws.networksecuritymanager#ConflictException" }, { "target": "com.amazonaws.networksecuritymanager#InternalServerException" }, { "target": "com.amazonaws.networksecuritymanager#ResourceNotFoundException" }, { "target": "com.amazonaws.networksecuritymanager#ServiceQuotaExceededException" }, { "target": "com.amazonaws.networksecuritymanager#ThrottlingException" }, { "target": "com.amazonaws.networksecuritymanager#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to update a template", "resources": { "required": { "template": {} }, "optional": { "rule": {}, "rule-snapshot": {} } } }, "smithy.api#documentation": "Updates the specified template. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the template as a draft.
The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
A description of the template.
" } }, "associatedRuleList": { "target": "com.amazonaws.networksecuritymanager#RuleReferenceList", "traits": { "smithy.api#documentation": "The rules associated with the template.
", "smithy.api#notProperty": {} } }, "isPublished": { "target": "com.amazonaws.networksecuritymanager#IsPublished", "traits": { "smithy.api#documentation": "Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
", "smithy.api#idempotencyToken": {}, "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.networksecuritymanager#Template" } ] } }, "com.amazonaws.networksecuritymanager#UpdateTemplateOutput": { "type": "structure", "members": { "templateId": { "target": "com.amazonaws.networksecuritymanager#TemplateId", "traits": { "smithy.api#documentation": "The service-generated id of the template.
", "smithy.api#required": {} } }, "templateArn": { "target": "com.amazonaws.networksecuritymanager#TemplateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "templateIdentifier" } }, "templateName": { "target": "com.amazonaws.networksecuritymanager#TemplateName", "traits": { "smithy.api#documentation": "The name of the template.
", "smithy.api#required": {} } }, "templateDescription": { "target": "com.amazonaws.networksecuritymanager#Description", "traits": { "smithy.api#documentation": "A description of the template.
" } }, "status": { "target": "com.amazonaws.networksecuritymanager#EntityStatus", "traits": { "smithy.api#documentation": "The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The version of the resource.
", "smithy.api#required": {} } }, "associatedRuleList": { "target": "com.amazonaws.networksecuritymanager#AssociatedRuleList", "traits": { "smithy.api#documentation": "The rules associated with the template.
", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "updateToken": { "target": "com.amazonaws.networksecuritymanager#UpdateToken", "traits": { "smithy.api#documentation": "A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
Specifies whether the resource is a snapshot of a published version.
" } }, "hasPublishedVersion": { "target": "com.amazonaws.networksecuritymanager#HasPublishedVersion", "traits": { "smithy.api#documentation": "Specifies whether a published version of the resource exists.
" } }, "firewallType": { "target": "com.amazonaws.networksecuritymanager#TemplateFirewallType", "traits": { "smithy.api#documentation": "The firewall type associated with the resource.
", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.networksecuritymanager#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the resource was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.networksecuritymanager#UpdateToken": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$" } }, "com.amazonaws.networksecuritymanager#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.networksecuritymanager#ValidationExceptionReason", "traits": { "smithy.api#documentation": "The reason that the request failed validation.
" } }, "fieldList": { "target": "com.amazonaws.networksecuritymanager#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "The list of request fields that failed validation, if any.
" } } }, "traits": { "smithy.api#documentation": "The request failed validation. For details, see the reason and fieldList members of the response.
The name of the field that failed validation.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the validation error for the field.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a single request field that failed validation.
" } }, "com.amazonaws.networksecuritymanager#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.networksecuritymanager#ValidationExceptionField" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.networksecuritymanager#ValidationExceptionReason": { "type": "enum", "members": { "ACCOUNT_NOT_ONBOARDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_NOT_ONBOARDED" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } } }, "com.amazonaws.networksecuritymanager#WAFConfigDataType": { "type": "enum", "members": { "DEFAULT_ACTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DefaultAction" } }, "VISIBILITY_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VisibilityConfig" } }, "CAPTCHA_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CaptchaConfig" } }, "CHALLENGE_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ChallengeConfig" } }, "CUSTOM_RESPONSE_BODIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomResponseBodies" } }, "LOGGING_CONFIGURATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LoggingConfiguration" } }, "DATA_PROTECTION_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DataProtectionConfig" } }, "ASSOCIATION_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AssociationConfig" } }, "ON_SOURCE_DDOS_PROTECTION_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OnSourceDDoSProtectionConfig" } }, "TOKEN_DOMAINS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TokenDomains" } } } }, "com.amazonaws.networksecuritymanager#WAFConflictResolutionOptions": { "type": "enum", "members": { "MERGE_WHERE_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MERGE_WHERE_APPLICABLE" } } } }, "com.amazonaws.networksecuritymanager#WafConfig": { "type": "structure", "members": { "existingCustomerWebACLResolution": { "target": "com.amazonaws.networksecuritymanager#ExistingCustomerWebACLResolution", "traits": { "smithy.api#documentation": "Determines how AWS Network Security Manager handles remediation when a resource already has a customer-created web ACL. Required for AWS WAF policies.
", "smithy.api#required": {} } }, "conflictResolution": { "target": "com.amazonaws.networksecuritymanager#WAFConflictResolutionOptions", "traits": { "smithy.api#documentation": "The conflict-resolution strategy for AWS WAF policies. Required for AWS WAF policies.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "AWS WAF-specific policy configuration settings.
" } } } }