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.
", "operations": { "CreateDeployment": "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.
Creates a snapshot of the current published version of the specified deployment.
", "CreatePolicy": "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.
Creates a snapshot of the current published version of the specified policy.
", "CreateRule": "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.
Creates a snapshot of the current published version of the specified rule. A snapshot is an immutable, versioned copy that other resources can reference.
", "CreateScope": "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.
Creates a snapshot of the current published version of the specified scope.
", "CreateTemplate": "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.
Creates a snapshot of the current published version of the specified template.
", "DeleteAdminAccount": "Removes the specified AWS Network Security Manager administrator account.
", "DeleteDeployment": "Deletes the specified deployment.
", "DeletePolicy": "Deletes the specified policy.
", "DeleteRule": "Deletes the specified rule.
", "DeleteScope": "Deletes the specified scope.
", "DeleteTemplate": "Deletes the specified template.
", "GenerateRuleConfiguration": "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.
", "GetAdminAccount": "Retrieves the details of the specified AWS Network Security Manager administrator account.
", "GetDeployment": "Retrieves the details of the specified deployment, including coverage information and any warnings.
", "GetPolicy": "Retrieves the details of the specified policy.
", "GetRule": "Retrieves the details of the specified rule.
", "GetScope": "Retrieves the details of the specified scope.
", "GetTemplate": "Retrieves the details of the specified template.
", "ListAdminAccounts": "Lists the AWS Network Security Manager administrator accounts in the organization.
", "ListAggregateResourceSynchronizationStatuses": "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.
", "ListDeploymentSnapshots": "Lists the snapshots of the specified deployment.
", "ListDeployments": "Lists the deployments in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the policies in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified policy.
", "ListResourceAssociations": "Lists the resources associated with the specified resource.
", "ListResourceSynchronizationStatuses": "Lists the synchronization statuses of the resources covered by the specified deployment. You can filter the results by synchronization status and page through them.
", "ListRuleSnapshots": "Lists the snapshots of the specified rule.
", "ListRules": "Lists the rules in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the snapshots of the specified scope.
", "ListScopes": "Lists the scopes in the account. You can filter the results by status and page through them using maxResults and nextToken.
Lists the tags associated with the specified resource.
", "ListTemplateSnapshots": "Lists the snapshots of the specified template.
", "ListTemplates": "Lists the templates in the account. You can filter the results by status and page through them using maxResults and nextToken.
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.
", "TagResource": "Adds or overwrites the specified tags on the given resource.
", "UntagResource": "Removes the specified tags from the given resource.
", "UpdateDeployment": "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.
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.
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.
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.
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.
You do not have sufficient permissions to perform this action.
", "refs": {} }, "AccountFilter": { "base": "Determines which accounts are in scope. Exactly one of includeAll, include, or exclude is set.
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.
" } }, "AccountId": { "base": null, "refs": { "AccountIdList$member": null, "AccountList$member": null, "AccountReference$accountId": "The AWS account ID.
", "AdminAccountDetails$adminAccount": "The AWS account ID of the administrator account.
", "AdminAccountSummary$accountId": "The AWS account ID.
", "DeleteAdminAccountRequest$accountId": "The AWS account ID of the administrator account to remove.
", "GetAdminAccountRequest$accountId": "The AWS account ID of the administrator account to retrieve.
", "PutAdminAccountRequest$accountId": "The AWS account ID to set as the AWS Network Security Manager administrator account.
", "ResourceSynchronizationStatusSummary$accountId": "The AWS account ID that owns the resource.
" } }, "AccountIdList": { "base": null, "refs": { "AdminScopeSelectionInput$accounts": "The AWS accounts in the selection.
" } }, "AccountList": { "base": null, "refs": { "AccountSet$accountIds": "The list of AWS account IDs.
" } }, "AccountReference": { "base": "A reference to an AWS account, with optional display metadata.
", "refs": { "AccountReferenceList$member": null } }, "AccountReferenceList": { "base": null, "refs": { "AdminScopeSelection$accounts": "The AWS accounts in the selection.
" } }, "AccountSet": { "base": "A set of AWS accounts and organizational units.
", "refs": { "AccountFilter$include": "Includes only the specified accounts and organizational units.
", "AccountFilter$exclude": "Excludes the specified accounts and organizational units. All others are in scope.
" } }, "AdminAccountDetails": { "base": "The details of an AWS Network Security Manager administrator account.
", "refs": { "GetAdminAccountResponse$adminAccountDetails": "The details of the administrator account.
", "PutAdminAccountResponse$adminAccountDetails": "The details of the administrator account that was set.
" } }, "AdminAccountStatus": { "base": null, "refs": { "AdminAccountDetails$status": "The status of the administrator account, either ONBOARDED or OFFBOARDED.
Summary information about an AWS Network Security Manager administrator account.
", "refs": { "AdminAccountSummaryList$member": null } }, "AdminAccountSummaryList": { "base": null, "refs": { "ListAdminAccountsResponse$adminAccounts": "The list of administrator accounts.
" } }, "AdminFirewallTypeScope": { "base": "Defines the firewall types that an administrator can create and manage.
", "refs": { "AdminScope$firewallTypeScope": "The firewall types that the administrator can create and manage.
", "AdminScopeInput$firewallTypeScope": "The firewall types that the administrator can create and manage.
" } }, "AdminPriority": { "base": null, "refs": { "AdminAccountDetails$priority": "The priority assigned to the administrator account.
", "AdminAccountSummary$priority": "The priority assigned to the administrator account.
", "PutAdminAccountRequest$priority": "The priority to assign to the administrator account.
" } }, "AdminScope": { "base": "Defines the accounts, organizational units, and firewall types that an administrator can manage.
", "refs": { "AdminAccountDetails$adminScope": "The administrative scope, which defines the accounts, organizational units, and firewall types that the administrator can manage.
" } }, "AdminScopeFilter": { "base": "Determines which accounts and organizational units are in an administrator's scope. This is the reference form, which includes display metadata.
", "refs": { "AdminScope$scopeFilter": "The filter that determines which accounts and organizational units are in the administrator's scope.
" } }, "AdminScopeFilterInput": { "base": "Determines which accounts and organizational units are in an administrator's scope. This is the input form, which uses account and organizational unit IDs.
", "refs": { "AdminScopeInput$scopeFilter": "The filter that determines which accounts and organizational units are in the administrator's scope.
" } }, "AdminScopeInput": { "base": "The administrative scope configuration provided on input, using account and organizational unit IDs.
", "refs": { "PutAdminAccountRequest$adminScope": "The scope of accounts, organizational units, and firewall types that the administrator can manage.
" } }, "AdminScopeSelection": { "base": "A selection of accounts and organizational units. This is the reference form, which includes display metadata.
", "refs": { "AdminScopeFilter$includeOnly": "Only the specified accounts and organizational units are in the administrator's scope.
", "AdminScopeFilter$excludeOnly": "The accounts and organizational units to exclude from the administrator's scope. All others are in scope.
" } }, "AdminScopeSelectionInput": { "base": "A selection of accounts and organizational units. This is the input form, which uses account and organizational unit IDs.
", "refs": { "AdminScopeFilterInput$includeOnly": "Only the specified accounts and organizational units are in the administrator's scope.
", "AdminScopeFilterInput$excludeOnly": "The accounts and organizational units to exclude from the administrator's scope. All others are in scope.
" } }, "AlbConfiguration": { "base": "Filter criteria specific to Application Load Balancers.
", "refs": { "ResourceCriteria$albConfig": "Filter criteria specific to Application Load Balancers.
" } }, "Arn": { "base": null, "refs": { "ListTagsForResourceInput$resourceArn": "The ARN of the resource to list tags for. The ARN must not include a :DRAFT qualifier.
The ARN of the associated resource.
", "ResourceSynchronizationStatusSummary$resourceArn": "The ARN of the resource whose synchronization status is reported.
", "TagResourceInput$resourceArn": "The ARN of the resource to tag. The ARN must not include a :DRAFT qualifier.
The ARN of the resource to remove tags from. The ARN must not include a :DRAFT qualifier.
An association between a deployment and a policy, as returned in outputs. The corresponding request structure is PolicyReference.
The policies associated with the deployment.
", "CreateDeploymentSnapshotOutput$associatedPolicyList": "The policies associated with the deployment.
", "GetDeploymentOutput$associatedPolicyList": "The policies associated with the deployment.
", "UpdateDeploymentOutput$associatedPolicyList": "The policies associated with the deployment.
" } }, "AssociatedRule": { "base": "An association between a template and a rule, as returned in outputs. The corresponding request structure is RuleReference.
The rules associated with the template.
", "CreateTemplateSnapshotOutput$associatedRuleList": "The rules associated with the template.
", "GetTemplateOutput$associatedRuleList": "The rules associated with the template.
", "UpdateTemplateOutput$associatedRuleList": "The rules associated with the template.
" } }, "AssociatedScope": { "base": "An association between a deployment and a scope, as returned in outputs. The corresponding request structure is ScopeReference.
The scope associated with the deployment. A deployment has exactly one scope.
", "CreateDeploymentSnapshotOutput$associatedScopeList": "The scope associated with the deployment. A deployment has exactly one scope.
", "GetDeploymentOutput$associatedScopeList": "The scope associated with the deployment. A deployment has exactly one scope.
", "UpdateDeploymentOutput$associatedScopeList": "The scope associated with the deployment. A deployment has exactly one scope.
" } }, "AssociatedTemplateAndRuleList": { "base": null, "refs": { "CreatePolicyOutput$associatedTemplateAndRuleList": "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.
", "CreatePolicySnapshotOutput$associatedTemplateAndRuleList": "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.
", "GetPolicyOutput$associatedTemplateAndRuleList": "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.
", "UpdatePolicyOutput$associatedTemplateAndRuleList": "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.
" } }, "AssociatedTemplateOrRule": { "base": "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.
Specifies whether the administrator can manage all firewall types, except for third-party firewall types.
", "ResourceScope$includeAll": "Includes all resources of the resource type.
" } }, "ConfigurationIssue": { "base": "Describes a single configuration value that does not match the intended configuration.
", "refs": { "ConfigurationIssueList$member": null } }, "ConfigurationIssueList": { "base": null, "refs": { "InvalidFirewallReasons$incorrectSingleValueConfigurations": "Single-value configuration settings whose values do not match the expected values.
", "InvalidFirewallReasons$missingAppendableConfigurationValues": "Appendable configuration values that are expected but missing.
", "InvalidFirewallReasons$unexpectedAppendableConfigurationValues": "Appendable configuration values that are present but not expected.
", "InvalidFirewallReasons$incorrectAppendableConfigurationOrder": "Appendable configuration values that are present but in the wrong order.
", "InvalidFirewallReasons$missingMergeableConfigurationValues": "Mergeable configuration values that are expected but missing.
", "InvalidFirewallReasons$unexpectedMergeableConfigurationValues": "Mergeable configuration values that are present but not expected.
" } }, "ConflictException": { "base": "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.
", "refs": {} }, "CreateDeploymentInput": { "base": null, "refs": {} }, "CreateDeploymentOutput": { "base": null, "refs": {} }, "CreateDeploymentSnapshotInput": { "base": null, "refs": {} }, "CreateDeploymentSnapshotOutput": { "base": null, "refs": {} }, "CreatePolicyInput": { "base": null, "refs": {} }, "CreatePolicyOutput": { "base": null, "refs": {} }, "CreatePolicySnapshotInput": { "base": null, "refs": {} }, "CreatePolicySnapshotOutput": { "base": null, "refs": {} }, "CreateRuleInput": { "base": null, "refs": {} }, "CreateRuleOutput": { "base": null, "refs": {} }, "CreateRuleSnapshotInput": { "base": null, "refs": {} }, "CreateRuleSnapshotOutput": { "base": null, "refs": {} }, "CreateScopeInput": { "base": null, "refs": {} }, "CreateScopeOutput": { "base": null, "refs": {} }, "CreateScopeSnapshotInput": { "base": null, "refs": {} }, "CreateScopeSnapshotOutput": { "base": null, "refs": {} }, "CreateTemplateInput": { "base": null, "refs": {} }, "CreateTemplateOutput": { "base": null, "refs": {} }, "CreateTemplateSnapshotInput": { "base": null, "refs": {} }, "CreateTemplateSnapshotOutput": { "base": null, "refs": {} }, "DateTimestamp": { "base": null, "refs": { "CreateDeploymentOutput$updatedAt": "The time when the resource was last updated.
", "CreateDeploymentSnapshotOutput$updatedAt": "The time when the snapshot was created.
", "CreatePolicyOutput$updatedAt": "The time when the resource was last updated.
", "CreatePolicySnapshotOutput$updatedAt": "The time when the snapshot was created.
", "CreateRuleOutput$updatedAt": "The time when the resource was last updated.
", "CreateRuleSnapshotOutput$updatedAt": "The time when the snapshot was created.
", "CreateScopeOutput$updatedAt": "The time when the resource was last updated.
", "CreateScopeSnapshotOutput$updatedAt": "The time when the snapshot was created.
", "CreateTemplateOutput$updatedAt": "The time when the resource was last updated.
", "CreateTemplateSnapshotOutput$updatedAt": "The time when the snapshot was created.
", "DeploymentSummary$updatedAt": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
", "GetDeploymentOutput$updatedAt": "The time when the resource was last updated.
", "GetPolicyOutput$updatedAt": "The time when the resource was last updated.
", "GetRuleOutput$updatedAt": "The time when the resource was last updated.
", "GetScopeOutput$updatedAt": "The time when the resource was last updated.
", "GetTemplateOutput$updatedAt": "The time when the resource was last updated.
", "PolicySummary$updatedAt": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
", "ResourceSynchronizationStatusSummary$updatedAt": "The time when the resource was last updated.
", "ResourceSynchronizationStatusSummary$evaluatedAt": "The time when the synchronization status was last evaluated.
", "RuleSummary$updatedAt": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
", "ScopeSummary$updatedAt": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
", "TemplateSummary$updatedAt": "The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.
", "UpdateDeploymentOutput$updatedAt": "The time when the resource was last updated.
", "UpdatePolicyOutput$updatedAt": "The time when the resource was last updated.
", "UpdateRuleOutput$updatedAt": "The time when the resource was last updated.
", "UpdateScopeOutput$updatedAt": "The time when the resource was last updated.
", "UpdateTemplateOutput$updatedAt": "The time when the resource was last updated.
" } }, "DeleteAdminAccountRequest": { "base": null, "refs": {} }, "DeleteDeploymentInput": { "base": null, "refs": {} }, "DeletePolicyInput": { "base": null, "refs": {} }, "DeleteRuleInput": { "base": null, "refs": {} }, "DeleteScopeInput": { "base": null, "refs": {} }, "DeleteTemplateInput": { "base": null, "refs": {} }, "DeploymentArn": { "base": null, "refs": { "CreateDeploymentOutput$deploymentArn": "The Amazon Resource Name (ARN) of the deployment.
", "CreateDeploymentSnapshotOutput$deploymentArn": "The Amazon Resource Name (ARN) of the deployment.
", "DeploymentSummary$deploymentArn": "The Amazon Resource Name (ARN) of the deployment.
", "GetDeploymentOutput$deploymentArn": "The Amazon Resource Name (ARN) of the deployment.
", "ResourceSynchronizationStatusSummary$deploymentArn": "The ARN of the deployment that the synchronization status is associated with. This is absent for aggregate (cross-deployment) statuses.
", "UpdateDeploymentOutput$deploymentArn": "The Amazon Resource Name (ARN) of the deployment.
" } }, "DeploymentConfiguration": { "base": "Configuration settings that control a deployment's behavior.
", "refs": { "CreateDeploymentInput$deploymentConfiguration": "The configuration settings for the deployment.
", "CreateDeploymentOutput$deploymentConfiguration": "The configuration settings for the deployment.
", "CreateDeploymentSnapshotOutput$deploymentConfiguration": "The configuration settings for the deployment.
", "GetDeploymentOutput$deploymentConfiguration": "The configuration settings for the deployment.
", "UpdateDeploymentInput$deploymentConfiguration": "The configuration settings for the deployment.
", "UpdateDeploymentOutput$deploymentConfiguration": "The configuration settings for the deployment.
" } }, "DeploymentCoverageEntry": { "base": "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.
", "refs": { "DeploymentCoverageList$member": null } }, "DeploymentCoverageList": { "base": null, "refs": { "CreateDeploymentOutput$deploymentCoverage": "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.
", "GetDeploymentOutput$deploymentCoverage": "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.
", "UpdateDeploymentOutput$deploymentCoverage": "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.
" } }, "DeploymentId": { "base": null, "refs": { "CreateDeploymentOutput$deploymentId": "The service-generated id of the deployment.
", "CreateDeploymentSnapshotOutput$deploymentId": "The service-generated id of the deployment.
", "DeploymentSummary$deploymentId": "The service-generated id of the deployment.
", "GetDeploymentOutput$deploymentId": "The service-generated id of the deployment.
", "UpdateDeploymentOutput$deploymentId": "The service-generated id of the deployment.
" } }, "DeploymentIdentifier": { "base": null, "refs": { "CreateDeploymentSnapshotInput$deploymentIdentifier": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "DeleteDeploymentInput$deploymentIdentifier": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "GetDeploymentInput$deploymentIdentifier": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "ListDeploymentSnapshotsInput$deploymentIdentifier": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
", "ListResourceSynchronizationStatusesInput$deploymentIdentifier": "The identifier of the deployment to list synchronization statuses for. This is the deployment's Amazon Resource Name (ARN).
", "UpdateDeploymentInput$deploymentIdentifier": "The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).
" } }, "DeploymentName": { "base": null, "refs": { "CreateDeploymentInput$deploymentName": "The name of the deployment.
", "CreateDeploymentOutput$deploymentName": "The name of the deployment.
", "CreateDeploymentSnapshotOutput$deploymentName": "The name of the deployment.
", "DeploymentSummary$deploymentName": "The name of the deployment.
", "GetDeploymentOutput$deploymentName": "The name of the deployment.
", "UpdateDeploymentOutput$deploymentName": "The name of the deployment.
" } }, "DeploymentPolicyArnList": { "base": null, "refs": { "DeploymentCoverageEntry$policyArns": "The Amazon Resource Names (ARNs) of the deployment's policies that have this firewall type.
" } }, "DeploymentResourceTypeList": { "base": null, "refs": { "DeploymentCoverageEntry$inScopeResourceTypes": "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.
" } }, "DeploymentSummary": { "base": "Summary information about a deployment.
", "refs": { "DeploymentSummaryList$member": null } }, "DeploymentSummaryList": { "base": null, "refs": { "ListDeploymentSnapshotsOutput$snapshots": "The snapshots of the deployment.
", "ListDeploymentsOutput$deployments": "The list of deployments.
" } }, "DeploymentWarningEntry": { "base": "A warning about a potential issue with a deployment.
", "refs": { "DeploymentWarningList$member": null } }, "DeploymentWarningList": { "base": null, "refs": { "CreateDeploymentOutput$warnings": "Warnings about potential issues, such as a policy that has no applicable resources in the deployment's scope.
", "GetDeploymentOutput$warnings": "Warnings about potential issues, such as a policy that has no applicable resources in the deployment's scope.
", "UpdateDeploymentOutput$warnings": "Warnings about potential issues, such as a policy that has no applicable resources in the deployment's scope.
" } }, "Description": { "base": null, "refs": { "CreateDeploymentInput$deploymentDescription": "A description of the deployment.
", "CreateDeploymentOutput$deploymentDescription": "A description of the deployment.
", "CreateDeploymentSnapshotOutput$deploymentDescription": "A description of the deployment.
", "CreatePolicyInput$policyDescription": "A description of the policy.
", "CreatePolicyOutput$policyDescription": "A description of the policy.
", "CreatePolicySnapshotOutput$policyDescription": "A description of the policy.
", "CreateRuleInput$ruleDescription": "A description of the rule.
", "CreateRuleOutput$ruleDescription": "A description of the rule.
", "CreateRuleSnapshotOutput$ruleDescription": "A description of the rule.
", "CreateScopeInput$scopeDescription": "A description of the scope.
", "CreateScopeOutput$scopeDescription": "A description of the scope.
", "CreateScopeSnapshotOutput$scopeDescription": "A description of the scope.
", "CreateTemplateInput$templateDescription": "A description of the template.
", "CreateTemplateOutput$templateDescription": "A description of the template.
", "CreateTemplateSnapshotOutput$templateDescription": "A description of the template.
", "GetDeploymentOutput$deploymentDescription": "A description of the deployment.
", "GetPolicyOutput$policyDescription": "A description of the policy.
", "GetRuleOutput$ruleDescription": "A description of the rule.
", "GetScopeOutput$scopeDescription": "A description of the scope.
", "GetTemplateOutput$templateDescription": "A description of the template.
", "UpdateDeploymentInput$deploymentDescription": "A description of the deployment.
", "UpdateDeploymentOutput$deploymentDescription": "A description of the deployment.
", "UpdatePolicyInput$policyDescription": "A description of the policy.
", "UpdatePolicyOutput$policyDescription": "A description of the policy.
", "UpdateRuleInput$ruleDescription": "A description of the rule.
", "UpdateRuleOutput$ruleDescription": "A description of the rule.
", "UpdateScopeInput$scopeDescription": "A description of the scope.
", "UpdateScopeOutput$scopeDescription": "A description of the scope.
", "UpdateTemplateInput$templateDescription": "A description of the template.
", "UpdateTemplateOutput$templateDescription": "A description of the template.
" } }, "EnableCrossAccountVisibility": { "base": null, "refs": { "DeploymentConfiguration$enableCrossAccountVisibility": "Specifies whether aggregate synchronization status details for the resources covered by this deployment are visible across accounts. Default: false.
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
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 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 current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
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 current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
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 current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
Filters the results by status: ACTIVE, DRAFT, or DISABLED.
Filters the results by status, either ACTIVE or DRAFT.
Filters the results by status, either ACTIVE or DRAFT.
Filters the results by status: ACTIVE, DRAFT, or DISABLED.
Filters the results by status, either ACTIVE or DRAFT.
The version of the resource.
", "CreateDeploymentSnapshotOutput$version": "The version of the resource.
", "CreatePolicyOutput$version": "The version of the resource.
", "CreatePolicySnapshotOutput$version": "The version of the resource.
", "CreateRuleOutput$version": "The version of the resource.
", "CreateRuleSnapshotOutput$version": "The version of the resource.
", "CreateScopeOutput$version": "The version of the resource.
", "CreateScopeSnapshotOutput$version": "The version of the resource.
", "CreateTemplateOutput$version": "The version of the resource.
", "CreateTemplateSnapshotOutput$version": "The version of the resource.
", "DeploymentSummary$version": "The version of the resource.
", "GetDeploymentOutput$version": "The version of the resource.
", "GetPolicyOutput$version": "The version of the resource.
", "GetRuleOutput$version": "The version of the resource.
", "GetScopeOutput$version": "The version of the resource.
", "GetTemplateOutput$version": "The version of the resource.
", "PolicySummary$version": "The version of the resource.
", "RuleSummary$version": "The version of the resource.
", "ScopeSummary$version": "The version of the resource.
", "TemplateSummary$version": "The version of the resource.
", "UpdateDeploymentOutput$version": "The version of the resource.
", "UpdatePolicyOutput$version": "The version of the resource.
", "UpdateRuleOutput$version": "The version of the resource.
", "UpdateScopeOutput$version": "The version of the resource.
", "UpdateTemplateOutput$version": "The version of the resource.
" } }, "ExistingCustomerWebACLResolution": { "base": null, "refs": { "WafConfig$existingCustomerWebACLResolution": "Determines how AWS Network Security Manager handles remediation when a resource already has a customer-created web ACL. Required for AWS WAF policies.
" } }, "FirewallSyncReason": { "base": "Describes why a firewall is out of sync. Exactly one of missingFirewall or invalidFirewall is set.
The list of firewall types that the administrator can manage.
" } }, "GenerateRuleConfigurationRequest": { "base": null, "refs": {} }, "GenerateRuleConfigurationRequestCurrentConfigurationString": { "base": null, "refs": { "GenerateRuleConfigurationRequest$currentConfiguration": "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.
" } }, "GenerateRuleConfigurationRequestPromptString": { "base": null, "refs": { "GenerateRuleConfigurationRequest$prompt": "A natural-language description of the configuration that you want to generate.
" } }, "GenerateRuleConfigurationResponse": { "base": null, "refs": {} }, "GenerateRuleConfigurationResponseConfigurationString": { "base": null, "refs": { "GenerateRuleConfigurationResponse$configuration": "The generated configuration, as a JSON string. You can use this value in the configuration field of a rule.
Specifies whether a published version of the resource exists.
", "CreateDeploymentSnapshotOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreatePolicyOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreatePolicySnapshotOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreateRuleOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreateRuleSnapshotOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreateScopeOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreateScopeSnapshotOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreateTemplateOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "CreateTemplateSnapshotOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "DeploymentSummary$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "GetDeploymentOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "GetPolicyOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "GetRuleOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "GetScopeOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "GetTemplateOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "PolicySummary$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "RuleSummary$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "ScopeSummary$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "TemplateSummary$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "UpdateDeploymentOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "UpdatePolicyOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "UpdateRuleOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "UpdateScopeOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
", "UpdateTemplateOutput$hasPublishedVersion": "Specifies whether a published version of the resource exists.
" } }, "IdempotencyToken": { "base": null, "refs": { "CreateDeploymentInput$clientToken": "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.
", "CreateDeploymentSnapshotInput$clientToken": "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.
", "CreatePolicyInput$clientToken": "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.
", "CreatePolicySnapshotInput$clientToken": "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.
", "CreateRuleInput$clientToken": "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.
", "CreateRuleSnapshotInput$clientToken": "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.
", "CreateScopeInput$clientToken": "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.
", "CreateScopeSnapshotInput$clientToken": "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.
", "CreateTemplateInput$clientToken": "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.
", "CreateTemplateSnapshotInput$clientToken": "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.
", "GenerateRuleConfigurationRequest$clientToken": "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.
", "UpdateDeploymentInput$clientToken": "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.
", "UpdatePolicyInput$clientToken": "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.
", "UpdateRuleInput$clientToken": "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.
", "UpdateScopeInput$clientToken": "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.
", "UpdateTemplateInput$clientToken": "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.
" } }, "Integer": { "base": null, "refs": { "ServiceUnavailableException$retryAfterSeconds": "The number of seconds to wait before retrying the request.
", "ThrottlingException$retryAfterSeconds": "The number of seconds to wait before retrying the request.
" } }, "InternalServerException": { "base": "The request processing failed because of an internal error in the service. This is a retryable error.
", "refs": {} }, "InvalidFirewallReasons": { "base": "Details about the ways in which a firewall's configuration differs from the intended configuration.
", "refs": { "FirewallSyncReason$invalidFirewall": "Details about a firewall whose configuration does not match the intended configuration.
" } }, "IpAddressType": { "base": null, "refs": { "AlbConfiguration$ipAddressType": "The IP address type of the Application Load Balancer.
" } }, "IsPublished": { "base": null, "refs": { "CreateDeploymentInput$isPublished": "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.
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.
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.
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.
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.
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).
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).
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).
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).
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).
Specifies whether the resource is a snapshot of a published version.
", "CreateDeploymentSnapshotOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreatePolicyOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreatePolicySnapshotOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreateRuleOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreateRuleSnapshotOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreateScopeOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreateScopeSnapshotOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreateTemplateOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "CreateTemplateSnapshotOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "GetDeploymentOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "GetPolicyOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "GetRuleOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "GetScopeOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "GetTemplateOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "UpdateDeploymentOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "UpdatePolicyOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "UpdateRuleOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "UpdateScopeOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
", "UpdateTemplateOutput$isSnapshot": "Specifies whether the resource is a snapshot of a published version.
" } }, "JsonDocument": { "base": null, "refs": { "CreateRuleInput$configuration": "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.
The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
", "CreateRuleSnapshotOutput$configuration": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
", "GetRuleOutput$configuration": "The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
", "UpdateRuleInput$configuration": "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.
The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.
" } }, "ListAdminAccountsRequest": { "base": null, "refs": {} }, "ListAdminAccountsResponse": { "base": null, "refs": {} }, "ListAggregateResourceSynchronizationStatusesInput": { "base": null, "refs": {} }, "ListAggregateResourceSynchronizationStatusesOutput": { "base": null, "refs": {} }, "ListDeploymentSnapshotsInput": { "base": null, "refs": {} }, "ListDeploymentSnapshotsOutput": { "base": null, "refs": {} }, "ListDeploymentsInput": { "base": null, "refs": {} }, "ListDeploymentsOutput": { "base": null, "refs": {} }, "ListPoliciesInput": { "base": null, "refs": {} }, "ListPoliciesOutput": { "base": null, "refs": {} }, "ListPolicySnapshotsInput": { "base": null, "refs": {} }, "ListPolicySnapshotsOutput": { "base": null, "refs": {} }, "ListResourceAssociationsInput": { "base": null, "refs": {} }, "ListResourceAssociationsOutput": { "base": null, "refs": {} }, "ListResourceSynchronizationStatusesInput": { "base": null, "refs": {} }, "ListResourceSynchronizationStatusesOutput": { "base": null, "refs": {} }, "ListRuleSnapshotsInput": { "base": null, "refs": {} }, "ListRuleSnapshotsOutput": { "base": null, "refs": {} }, "ListRulesInput": { "base": null, "refs": {} }, "ListRulesOutput": { "base": null, "refs": {} }, "ListScopeSnapshotsInput": { "base": null, "refs": {} }, "ListScopeSnapshotsOutput": { "base": null, "refs": {} }, "ListScopesInput": { "base": null, "refs": {} }, "ListScopesOutput": { "base": null, "refs": {} }, "ListTagsForResourceInput": { "base": null, "refs": {} }, "ListTagsForResourceOutput": { "base": null, "refs": {} }, "ListTemplateSnapshotsInput": { "base": null, "refs": {} }, "ListTemplateSnapshotsOutput": { "base": null, "refs": {} }, "ListTemplatesInput": { "base": null, "refs": {} }, "ListTemplatesOutput": { "base": null, "refs": {} }, "MaxResults": { "base": null, "refs": { "ListAdminAccountsRequest$maxResults": "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 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 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 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 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 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 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 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 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 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 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 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 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 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.
", "ListAdminAccountsResponse$nextToken": "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.
", "ListAggregateResourceSynchronizationStatusesInput$nextToken": "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.
", "ListAggregateResourceSynchronizationStatusesOutput$nextToken": "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.
", "ListDeploymentSnapshotsInput$nextToken": "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.
", "ListDeploymentSnapshotsOutput$nextToken": "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.
", "ListDeploymentsInput$nextToken": "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.
", "ListDeploymentsOutput$nextToken": "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.
", "ListPoliciesInput$nextToken": "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.
", "ListPoliciesOutput$nextToken": "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.
", "ListPolicySnapshotsInput$nextToken": "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.
", "ListPolicySnapshotsOutput$nextToken": "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.
", "ListResourceAssociationsInput$nextToken": "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.
", "ListResourceAssociationsOutput$nextToken": "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.
", "ListResourceSynchronizationStatusesInput$nextToken": "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.
", "ListResourceSynchronizationStatusesOutput$nextToken": "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.
", "ListRuleSnapshotsInput$nextToken": "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.
", "ListRuleSnapshotsOutput$nextToken": "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.
", "ListRulesInput$nextToken": "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.
", "ListRulesOutput$nextToken": "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.
", "ListScopeSnapshotsInput$nextToken": "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.
", "ListScopeSnapshotsOutput$nextToken": "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.
", "ListScopesInput$nextToken": "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.
", "ListScopesOutput$nextToken": "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.
", "ListTemplateSnapshotsInput$nextToken": "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.
", "ListTemplateSnapshotsOutput$nextToken": "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.
", "ListTemplatesInput$nextToken": "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.
", "ListTemplatesOutput$nextToken": "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.
" } }, "NotVisibleMarker": { "base": "Indicates that details are not visible because of cross-account restrictions.
", "refs": { "OutOfSyncReasonsView$notVisible": "Indicates that the details are not visible because of cross-account restrictions.
", "RemediationIssuesView$notVisible": "Indicates that the details are not visible because of cross-account restrictions.
" } }, "OrganizationalUnit": { "base": null, "refs": { "OrganizationalUnitList$member": null } }, "OrganizationalUnitId": { "base": null, "refs": { "OrganizationalUnitIdList$member": null, "OrganizationalUnitReference$ouId": "The ID of the AWS Organizations organizational unit (OU).
" } }, "OrganizationalUnitIdList": { "base": null, "refs": { "AdminScopeSelectionInput$organizationalUnits": "The AWS Organizations organizational units (OUs) in the selection.
" } }, "OrganizationalUnitList": { "base": null, "refs": { "AccountSet$organizationalUnits": "The AWS Organizations organizational units (OUs) in the selection.
" } }, "OrganizationalUnitReference": { "base": "A reference to an AWS Organizations organizational unit (OU), with optional display metadata.
", "refs": { "OrganizationalUnitReferenceList$member": null } }, "OrganizationalUnitReferenceList": { "base": null, "refs": { "AdminScopeSelection$organizationalUnits": "The AWS Organizations organizational units (OUs) in the selection.
" } }, "OutOfSyncReasons": { "base": null, "refs": { "OutOfSyncReasonsView$reasons": "The out-of-sync reasons, keyed by firewall type.
" } }, "OutOfSyncReasonsView": { "base": "The out-of-sync reasons for a resource, or a marker indicating that the details are not visible. Exactly one member is set.
", "refs": { "ResourceSynchronizationStatusSummary$outOfSyncReasons": "The reasons the resource is out of sync, keyed by firewall type. This is null when the resource is in sync.
" } }, "PolicyArn": { "base": null, "refs": { "AssociatedPolicy$policyArn": "The ARN of the associated policy, including its version qualifier when a specific published version is pinned (for example, ...:policy:abc123:3).
The Amazon Resource Name (ARN) of the policy.
", "CreatePolicySnapshotOutput$policyArn": "The Amazon Resource Name (ARN) of the policy.
", "DeploymentPolicyArnList$member": null, "DeploymentWarningEntry$policyArn": "The ARN of the policy that the warning relates to.
", "GetPolicyOutput$policyArn": "The Amazon Resource Name (ARN) of the policy.
", "PolicySummary$policyArn": "The Amazon Resource Name (ARN) of the policy.
", "UpdatePolicyOutput$policyArn": "The Amazon Resource Name (ARN) of the policy.
" } }, "PolicyConfiguration": { "base": "Configuration settings that control a policy's behavior.
", "refs": { "CreatePolicyInput$policyConfiguration": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
", "CreatePolicyOutput$policyConfiguration": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
", "CreatePolicySnapshotOutput$policyConfiguration": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
", "GetPolicyOutput$policyConfiguration": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
", "UpdatePolicyInput$policyConfiguration": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
", "UpdatePolicyOutput$policyConfiguration": "The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.
" } }, "PolicyFirewallType": { "base": null, "refs": { "CreatePolicyInput$firewallType": "The firewall type associated with the resource.
", "CreatePolicyOutput$firewallType": "The firewall type associated with the resource.
", "CreatePolicySnapshotOutput$firewallType": "The firewall type associated with the resource.
", "DeploymentCoverageEntry$firewallType": "The firewall type that the policies in this entry share.
", "FirewallTypeList$member": null, "GetPolicyOutput$firewallType": "The firewall type associated with the resource.
", "OutOfSyncReasons$key": null, "PolicySummary$firewallType": "The firewall type associated with the resource.
", "RemediationIssues$key": null, "UpdatePolicyOutput$firewallType": "The firewall type associated with the resource.
" } }, "PolicyId": { "base": null, "refs": { "CreatePolicyOutput$policyId": "The service-generated id of the policy.
", "CreatePolicySnapshotOutput$policyId": "The service-generated id of the policy.
", "GetPolicyOutput$policyId": "The service-generated id of the policy.
", "PolicySummary$policyId": "The service-generated id of the policy.
", "UpdatePolicyOutput$policyId": "The service-generated id of the policy.
" } }, "PolicyIdentifier": { "base": null, "refs": { "CreatePolicySnapshotInput$policyIdentifier": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "DeletePolicyInput$policyIdentifier": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "GetPolicyInput$policyIdentifier": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "ListPolicySnapshotsInput$policyIdentifier": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
", "PolicyReference$policyIdentifier": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN), optionally version-qualified to pin a specific published version.
", "UpdatePolicyInput$policyIdentifier": "The identifier of the policy. This is the policy's Amazon Resource Name (ARN).
" } }, "PolicyName": { "base": null, "refs": { "CreatePolicyInput$policyName": "The name of the policy.
", "CreatePolicyOutput$policyName": "The name of the policy.
", "CreatePolicySnapshotOutput$policyName": "The name of the policy.
", "GetPolicyOutput$policyName": "The name of the policy.
", "PolicySummary$policyName": "The name of the policy.
", "UpdatePolicyOutput$policyName": "The name of the policy.
" } }, "PolicyReference": { "base": "A reference to a policy in a create or update request.
", "refs": { "PolicyReferenceList$member": null } }, "PolicyReferenceList": { "base": null, "refs": { "CreateDeploymentInput$associatedPolicyList": "The policies associated with the deployment.
", "UpdateDeploymentInput$associatedPolicyList": "The policies associated with the deployment.
" } }, "PolicySummary": { "base": "Summary information about a policy.
", "refs": { "PolicySummaryList$member": null } }, "PolicySummaryList": { "base": null, "refs": { "ListPoliciesOutput$policies": "The list of policies.
", "ListPolicySnapshotsOutput$snapshots": "The snapshots of the policy.
" } }, "Priority": { "base": null, "refs": { "CreatePolicyInput$priority": "The priority of the resource. A lower number indicates a higher priority.
", "CreatePolicyOutput$priority": "The priority of the resource. A lower number indicates a higher priority.
", "CreatePolicySnapshotOutput$priority": "The priority of the resource. A lower number indicates a higher priority.
", "GetPolicyOutput$priority": "The priority of the resource. A lower number indicates a higher priority.
", "PolicySummary$priority": "The priority of the resource. A lower number indicates a higher priority.
", "UpdatePolicyInput$priority": "The priority of the resource. A lower number indicates a higher priority.
", "UpdatePolicyOutput$priority": "The priority of the resource. A lower number indicates a higher priority.
" } }, "PutAdminAccountRequest": { "base": null, "refs": {} }, "PutAdminAccountResponse": { "base": null, "refs": {} }, "RemediationEnabled": { "base": null, "refs": { "PolicyConfiguration$remediationEnabled": "Specifies whether AWS Network Security Manager automatically remediates noncompliant resources. Default: false.
Details about a remediation issue for a firewall type.
", "refs": { "RemediationIssues$value": null } }, "RemediationIssues": { "base": null, "refs": { "RemediationIssuesView$issues": "The remediation issues, keyed by firewall type.
" } }, "RemediationIssuesView": { "base": "Remediation issue details for a resource, or a marker indicating that the details are not visible. Exactly one member is set.
", "refs": { "ResourceSynchronizationStatusSummary$remediationIssues": "Details about remediation issues, keyed by firewall type. This is null when there are no remediation issues.
" } }, "ResourceArnList": { "base": null, "refs": { "ResourceSet$explicitArns": "An explicit list of resource ARNs.
" } }, "ResourceAssociation": { "base": "Describes an association between a resource and another entity.
", "refs": { "ResourceAssociationList$member": null } }, "ResourceAssociationList": { "base": null, "refs": { "ListResourceAssociationsOutput$resourceAssociations": "The list of resource associations.
" } }, "ResourceCriteria": { "base": "A leaf condition that matches resources by tag or by resource-type-specific configuration.
", "refs": { "ResourceLogicalExpression$criteria": "A leaf condition that matches resources by tag or by resource-type-specific configuration.
" } }, "ResourceIdentifier": { "base": null, "refs": { "ListResourceAssociationsInput$resourceIdentifier": "The identifier of the resource to list associations for. This is the resource's Amazon Resource Name (ARN).
" } }, "ResourceLogicalExpression": { "base": "A logical expression that selects resources. Exactly one of criteria, and, or, or not is set.
A subexpression that must not match.
", "ResourceLogicalExpressionList$member": null, "ResourceSet$expression": "A logical expression that selects resources by combining criteria with AND, OR, and NOT operators.
" } }, "ResourceLogicalExpressionList": { "base": null, "refs": { "ResourceLogicalExpression$and": "A list of subexpressions that must all match.
", "ResourceLogicalExpression$or": "A list of subexpressions of which at least one must match.
" } }, "ResourceNotFoundException": { "base": "The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.
", "refs": {} }, "ResourceScope": { "base": "Defines which resources of a given type are in scope. Exactly one of includeAll, include, or exclude is set.
The resource-level scoping configuration, keyed by resource type, that defines which resources within the selected accounts are in scope.
" } }, "ResourceSet": { "base": "A set of resources defined by explicit ARNs, a logical expression, or both.
", "refs": { "ResourceScope$include": "Includes the resources that match the specified criteria or explicit ARNs.
", "ResourceScope$exclude": "Excludes the resources that match the specified criteria or explicit ARNs.
" } }, "ResourceSynchronizationStatusSummary": { "base": "The synchronization status of a resource covered by a deployment.
", "refs": { "ResourceSynchronizationStatusSummaryList$member": null } }, "ResourceSynchronizationStatusSummaryList": { "base": null, "refs": { "ListAggregateResourceSynchronizationStatusesOutput$resourceSynchronizationStatuses": "The list of resource synchronization statuses.
", "ListResourceSynchronizationStatusesOutput$resourceSynchronizationStatuses": "The list of resource synchronization statuses.
" } }, "ResourceType": { "base": null, "refs": { "ResourceSynchronizationStatusSummary$resourceType": "The type of the resource, in AWS CloudFormation format.
" } }, "ResourcesCleanUp": { "base": null, "refs": { "PolicyConfiguration$resourcesCleanUp": "Specifies whether AWS Network Security Manager automatically removes the resources it created when they are no longer needed. Default: false.
The ARN of the associated rule.
", "AssociatedTemplateOrRule$ruleArn": "The ARN of the associated rule.
", "CreateRuleOutput$ruleArn": "The Amazon Resource Name (ARN) of the rule.
", "CreateRuleSnapshotOutput$ruleArn": "The Amazon Resource Name (ARN) of the rule.
", "GetRuleOutput$ruleArn": "The Amazon Resource Name (ARN) of the rule.
", "RuleSummary$ruleArn": "The Amazon Resource Name (ARN) of the rule.
", "UpdateRuleOutput$ruleArn": "The Amazon Resource Name (ARN) of the rule.
" } }, "RuleFirewallType": { "base": null, "refs": { "CreateRuleInput$firewallType": "The firewall type associated with the resource.
", "CreateRuleOutput$firewallType": "The firewall type associated with the resource.
", "CreateRuleSnapshotOutput$firewallType": "The firewall type associated with the resource.
", "GenerateRuleConfigurationRequest$ruleFirewallType": "The firewall type of the rule.
", "GetRuleOutput$firewallType": "The firewall type associated with the resource.
", "RuleSummary$firewallType": "The firewall type associated with the resource.
", "UpdateRuleOutput$firewallType": "The firewall type associated with the resource.
" } }, "RuleId": { "base": null, "refs": { "CreateRuleOutput$ruleId": "The service-generated id of the rule.
", "CreateRuleSnapshotOutput$ruleId": "The service-generated id of the rule.
", "GetRuleOutput$ruleId": "The service-generated id of the rule.
", "RuleSummary$ruleId": "The service-generated id of the rule.
", "UpdateRuleOutput$ruleId": "The service-generated id of the rule.
" } }, "RuleIdentifier": { "base": null, "refs": { "CreateRuleSnapshotInput$ruleIdentifier": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "DeleteRuleInput$ruleIdentifier": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "GetRuleInput$ruleIdentifier": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "ListRuleSnapshotsInput$ruleIdentifier": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "RuleReference$ruleIdentifier": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "TemplateOrRuleReference$ruleIdentifier": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
", "UpdateRuleInput$ruleIdentifier": "The identifier of the rule. This is the rule's Amazon Resource Name (ARN).
" } }, "RuleName": { "base": null, "refs": { "CreateRuleInput$ruleName": "The name of the rule.
", "CreateRuleOutput$ruleName": "The name of the rule.
", "CreateRuleSnapshotOutput$ruleName": "The name of the rule.
", "GetRuleOutput$ruleName": "The name of the rule.
", "RuleSummary$ruleName": "The name of the rule.
", "UpdateRuleOutput$ruleName": "The name of the rule.
" } }, "RuleReference": { "base": "A reference to a rule in a create or update request.
", "refs": { "RuleReferenceList$member": null } }, "RuleReferenceList": { "base": null, "refs": { "CreateTemplateInput$associatedRuleList": "The rules associated with the template.
", "UpdateTemplateInput$associatedRuleList": "The rules associated with the template.
" } }, "RuleSummary": { "base": "Summary information about a rule.
", "refs": { "RuleSummaryList$member": null } }, "RuleSummaryList": { "base": null, "refs": { "ListRuleSnapshotsOutput$snapshots": "The snapshots of the rule.
", "ListRulesOutput$rules": "The list of rules.
" } }, "RuleType": { "base": null, "refs": { "CreateRuleInput$ruleType": "The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
The scheme of the Application Load Balancer, either internet-facing or internal.
The ARN of the associated scope.
", "CreateScopeOutput$scopeArn": "The Amazon Resource Name (ARN) of the scope.
", "CreateScopeSnapshotOutput$scopeArn": "The Amazon Resource Name (ARN) of the scope.
", "GetScopeOutput$scopeArn": "The Amazon Resource Name (ARN) of the scope.
", "ScopeSummary$scopeArn": "The Amazon Resource Name (ARN) of the scope.
", "UpdateScopeOutput$scopeArn": "The Amazon Resource Name (ARN) of the scope.
" } }, "ScopeConfiguration": { "base": "Defines which accounts and resources are in scope.
", "refs": { "CreateScopeInput$scopeConfiguration": "The configuration that defines which accounts and resources are in scope.
", "CreateScopeOutput$scopeConfiguration": "The configuration that defines which accounts and resources are in scope.
", "CreateScopeSnapshotOutput$scopeConfiguration": "The configuration that defines which accounts and resources are in scope.
", "GetScopeOutput$scopeConfiguration": "The configuration that defines which accounts and resources are in scope.
", "UpdateScopeInput$scopeConfiguration": "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.
", "UpdateScopeOutput$scopeConfiguration": "The configuration that defines which accounts and resources are in scope.
" } }, "ScopeId": { "base": null, "refs": { "CreateScopeOutput$scopeId": "The service-generated id of the scope.
", "CreateScopeSnapshotOutput$scopeId": "The service-generated id of the scope.
", "GetScopeOutput$scopeId": "The service-generated id of the scope.
", "ScopeSummary$scopeId": "The service-generated id of the scope.
", "UpdateScopeOutput$scopeId": "The service-generated id of the scope.
" } }, "ScopeIdentifier": { "base": null, "refs": { "CreateScopeSnapshotInput$scopeIdentifier": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "DeleteScopeInput$scopeIdentifier": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "GetScopeInput$scopeIdentifier": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "ListScopeSnapshotsInput$scopeIdentifier": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "ScopeReference$scopeIdentifier": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
", "UpdateScopeInput$scopeIdentifier": "The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
" } }, "ScopeName": { "base": null, "refs": { "CreateScopeInput$scopeName": "The name of the scope.
", "CreateScopeOutput$scopeName": "The name of the scope.
", "CreateScopeSnapshotOutput$scopeName": "The name of the scope.
", "GetScopeOutput$scopeName": "The name of the scope.
", "ScopeSummary$scopeName": "The name of the scope.
", "UpdateScopeOutput$scopeName": "The name of the scope.
" } }, "ScopeReference": { "base": "A reference to a scope in a create or update request.
", "refs": { "ScopeReferenceList$member": null } }, "ScopeReferenceList": { "base": null, "refs": { "CreateDeploymentInput$associatedScopeList": "The scope associated with the deployment. A deployment has exactly one scope.
", "UpdateDeploymentInput$associatedScopeList": "The scope associated with the deployment. A deployment has exactly one scope.
" } }, "ScopeResourceType": { "base": null, "refs": { "DeploymentResourceTypeList$member": null, "ResourceScopeMap$key": null } }, "ScopeSummary": { "base": "Summary information about a scope.
", "refs": { "ScopeSummaryList$member": null } }, "ScopeSummaryList": { "base": null, "refs": { "ListScopeSnapshotsOutput$snapshots": "The snapshots of the scope.
", "ListScopesOutput$scopes": "The list of scopes.
" } }, "SensitiveAccountEmail": { "base": null, "refs": { "AccountReference$email": "The email address associated with the account.
" } }, "SensitiveAccountName": { "base": null, "refs": { "AccountReference$name": "The display name of the account.
" } }, "SensitiveEmail": { "base": null, "refs": { "AdminAccountSummary$email": "The email address associated with the account.
" } }, "SensitiveName": { "base": null, "refs": { "AdminAccountSummary$name": "The name of the administrator account.
" } }, "ServiceQuotaExceededException": { "base": "The request would exceed a service quota.
", "refs": {} }, "ServiceResourceType": { "base": null, "refs": { "ResourceAssociation$resourceType": "The type of the associated resource, such as Policy, Template, or Deployment.
The service is temporarily unavailable. This is a retryable error.
", "refs": {} }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "ConfigurationIssue$configurationName": "The name of the configuration setting that is in conflict.
", "ConfigurationIssue$expectedValue": "The configuration value that AWS Network Security Manager expected.
", "ConfigurationIssue$actualValue": "The configuration value that was found on the resource.
", "ConflictException$message": null, "ConflictException$resourceId": "The ID of the resource that is in conflict with the request.
", "ConflictException$resourceType": "The type of the resource that is in conflict with the request.
", "DeploymentWarningEntry$code": "A code that identifies the type of warning.
", "DeploymentWarningEntry$message": "A human-readable description of the warning.
", "FirewallSyncReason$missingFirewall": "Indicates that an expected firewall is missing. The value describes the missing firewall.
", "GenerateRuleConfigurationResponse$description": "Reserved for a future human-readable description of the generated configuration. This field is currently not populated.
", "InternalServerException$message": null, "NotVisibleMarker$reason": "The reason the details are not visible.
", "OrganizationalUnitReference$name": "The display name of the organizational unit.
", "RemediationIssueDetails$issueType": "The type of remediation issue.
", "RemediationIssueDetails$message": "A human-readable description of the remediation issue.
", "RemediationIssueDetails$correctiveAction": "A recommended action for resolving the remediation issue.
", "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "The ID of the resource that could not be found.
", "ResourceNotFoundException$resourceType": "The type of the resource that could not be found.
", "ServiceQuotaExceededException$message": null, "ServiceQuotaExceededException$quotaCode": "The code that identifies the service quota that was exceeded.
", "ServiceQuotaExceededException$serviceCode": "The code for the AWS service that owns the quota that was exceeded.
", "ServiceQuotaExceededException$resourceId": "The ID of the resource associated with the quota that was exceeded.
", "ServiceQuotaExceededException$resourceType": "The type of the resource associated with the quota that was exceeded.
", "ServiceUnavailableException$message": null, "StringMap$key": null, "StringMap$value": null, "TagPolicyViolationException$message": null, "ThrottlingException$message": null, "ValidationException$message": null, "ValidationExceptionField$name": "The name of the field that failed validation.
", "ValidationExceptionField$message": "A message describing the validation error for the field.
" } }, "StringMap": { "base": null, "refs": { "ResourceCriteria$tags": "Tag key-value pairs used to match resources.
" } }, "SynchronizationStatus": { "base": null, "refs": { "ListAggregateResourceSynchronizationStatusesInput$synchronizationStatus": "Filters the results by synchronization status, such as IN_SYNC or OUT_OF_SYNC.
Filters the results by synchronization status, such as IN_SYNC or OUT_OF_SYNC.
The synchronization status of the resource, such as IN_SYNC or OUT_OF_SYNC.
The keys of the tags to remove from the resource.
" } }, "TagMap": { "base": null, "refs": { "CreateDeploymentInput$tags": "The tags to add to the resource when it is created.
", "CreateDeploymentSnapshotInput$tags": "The tags to add to the snapshot when it is created.
", "CreatePolicyInput$tags": "The tags to add to the resource when it is created.
", "CreatePolicySnapshotInput$tags": "The tags to add to the snapshot when it is created.
", "CreateRuleInput$tags": "The tags to add to the resource when it is created.
", "CreateRuleSnapshotInput$tags": "The tags to add to the snapshot when it is created.
", "CreateScopeInput$tags": "The tags to add to the resource when it is created.
", "CreateScopeSnapshotInput$tags": "The tags to add to the snapshot when it is created.
", "CreateTemplateInput$tags": "The tags to add to the resource when it is created.
", "CreateTemplateSnapshotInput$tags": "The tags to add to the snapshot when it is created.
", "ListTagsForResourceOutput$tags": "The tags associated with the resource. Each tag is a key-value pair.
", "TagResourceInput$tags": "The tags to add to the resource.
" } }, "TagPolicyViolationException": { "base": "The request violates a tag policy that is in effect for the account or organization.
", "refs": {} }, "TagResourceInput": { "base": null, "refs": {} }, "TagResourceOutput": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "TagMap$value": null } }, "TemplateAndRuleReferenceList": { "base": null, "refs": { "CreatePolicyInput$associatedTemplateAndRuleList": "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.
", "UpdatePolicyInput$associatedTemplateAndRuleList": "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.
" } }, "TemplateArn": { "base": null, "refs": { "AssociatedTemplateOrRule$templateArn": "The ARN of the associated template.
", "CreateTemplateOutput$templateArn": "The Amazon Resource Name (ARN) of the template.
", "CreateTemplateSnapshotOutput$templateArn": "The Amazon Resource Name (ARN) of the template.
", "GetTemplateOutput$templateArn": "The Amazon Resource Name (ARN) of the template.
", "TemplateSummary$templateArn": "The Amazon Resource Name (ARN) of the template.
", "UpdateTemplateOutput$templateArn": "The Amazon Resource Name (ARN) of the template.
" } }, "TemplateFirewallType": { "base": null, "refs": { "CreateTemplateInput$firewallType": "The firewall type associated with the resource.
", "CreateTemplateOutput$firewallType": "The firewall type associated with the resource.
", "CreateTemplateSnapshotOutput$firewallType": "The firewall type associated with the resource.
", "GetTemplateOutput$firewallType": "The firewall type associated with the resource.
", "TemplateSummary$firewallType": "The firewall type associated with the resource.
", "UpdateTemplateOutput$firewallType": "The firewall type associated with the resource.
" } }, "TemplateId": { "base": null, "refs": { "CreateTemplateOutput$templateId": "The service-generated id of the template.
", "CreateTemplateSnapshotOutput$templateId": "The service-generated id of the template.
", "GetTemplateOutput$templateId": "The service-generated id of the template.
", "TemplateSummary$templateId": "The service-generated id of the template.
", "UpdateTemplateOutput$templateId": "The service-generated id of the template.
" } }, "TemplateIdentifier": { "base": null, "refs": { "CreateTemplateSnapshotInput$templateIdentifier": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "DeleteTemplateInput$templateIdentifier": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "GetTemplateInput$templateIdentifier": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "ListTemplateSnapshotsInput$templateIdentifier": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "TemplateOrRuleReference$templateIdentifier": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
", "UpdateTemplateInput$templateIdentifier": "The identifier of the template. This is the template's Amazon Resource Name (ARN).
" } }, "TemplateName": { "base": null, "refs": { "CreateTemplateInput$templateName": "The name of the template.
", "CreateTemplateOutput$templateName": "The name of the template.
", "CreateTemplateSnapshotOutput$templateName": "The name of the template.
", "GetTemplateOutput$templateName": "The name of the template.
", "TemplateSummary$templateName": "The name of the template.
", "UpdateTemplateOutput$templateName": "The name of the template.
" } }, "TemplateOrRuleReference": { "base": "A reference to either a template or a rule in a create or update request. Set exactly one of templateIdentifier or ruleIdentifier.
Summary information about a template.
", "refs": { "TemplateSummaryList$member": null } }, "TemplateSummaryList": { "base": null, "refs": { "ListTemplateSnapshotsOutput$snapshots": "The snapshots of the template.
", "ListTemplatesOutput$templates": "The list of templates.
" } }, "ThrottlingException": { "base": "The request was denied because of request throttling. Reduce your request rate and try again.
", "refs": {} }, "Unit": { "base": null, "refs": { "AccountFilter$includeAll": "Includes all accounts. No account filtering is applied.
", "AdminScopeFilter$includeAll": "All accounts and organizational units are in scope.
", "AdminScopeFilterInput$includeAll": "All accounts and organizational units are in scope.
" } }, "UntagResourceInput": { "base": null, "refs": {} }, "UntagResourceOutput": { "base": null, "refs": {} }, "UpdateDeploymentInput": { "base": null, "refs": {} }, "UpdateDeploymentOutput": { "base": null, "refs": {} }, "UpdatePolicyInput": { "base": null, "refs": {} }, "UpdatePolicyOutput": { "base": null, "refs": {} }, "UpdateRuleInput": { "base": null, "refs": {} }, "UpdateRuleOutput": { "base": null, "refs": {} }, "UpdateScopeInput": { "base": null, "refs": {} }, "UpdateScopeOutput": { "base": null, "refs": {} }, "UpdateTemplateInput": { "base": null, "refs": {} }, "UpdateTemplateOutput": { "base": null, "refs": {} }, "UpdateToken": { "base": null, "refs": { "CreateDeploymentOutput$updateToken": "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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 request failed validation. For details, see the reason and fieldList members of the response.
Describes a single request field that failed validation.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "The list of request fields that failed validation, if any.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The reason that the request failed validation.
" } }, "WAFConfigDataType": { "base": null, "refs": { "GenerateRuleConfigurationRequest$wafConfigDataType": "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.
" } }, "WAFConflictResolutionOptions": { "base": null, "refs": { "WafConfig$conflictResolution": "The conflict-resolution strategy for AWS WAF policies. Required for AWS WAF policies.
" } }, "WafConfig": { "base": "AWS WAF-specific policy configuration settings.
", "refs": { "PolicyConfiguration$wafConfig": "AWS WAF-specific policy settings. This is populated only for AWS WAF policies.
" } } } }