AWS CLI Command Reference

[ aws . network-security-manager ]

update-policyÂķ

DescriptionÂķ

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.

See also: AWS API Documentation

SynopsisÂķ

  update-policy
--policy-identifier <value>
--update-token <value>
[--policy-description <value>]
[--priority <value>]
[--associated-template-and-rule-list <value>]
[--policy-configuration <value>]
--is-published | --no-is-published
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

OptionsÂķ

--policy-identifier (string) [required]

The identifier of the policy. This is the policy’s Amazon Resource Name (ARN).

Constraints:

  • min: 1
  • max: 1010

--update-token (string) [required]

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.

Constraints:

  • min: 36
  • max: 36
  • pattern: ([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})

--policy-description (string)

A description of the policy.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9 _.:/=+\-@]*

--priority (integer)

The priority of the resource. A lower number indicates a higher priority.

Constraints:

  • min: 1

--associated-template-and-rule-list (list)

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.

Constraints:

  • min: 0
  • max: 100

(tagged union structure)

A reference to either a template or a rule in a create or update request. Set exactly one of templateIdentifier or ruleIdentifier .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: templateIdentifier, ruleIdentifier.

templateIdentifier -> (string)

The identifier of the template. This is the template’s Amazon Resource Name (ARN).

Constraints:

  • min: 1
  • max: 1010

ruleIdentifier -> (string)

The identifier of the rule. This is the rule’s Amazon Resource Name (ARN).

Constraints:

  • min: 1
  • max: 1010

Shorthand Syntax:

templateIdentifier=string,ruleIdentifier=string ...

JSON Syntax:

[
  {
    "templateIdentifier": "string",
    "ruleIdentifier": "string"
  }
  ...
]

--policy-configuration (structure)

The configuration settings that control the policy’s behavior, including remediation and firewall-type-specific settings.

remediationEnabled -> (boolean) [required]

Specifies whether AWS Network Security Manager automatically remediates noncompliant resources. Default: false .

resourcesCleanUp -> (boolean) [required]

Specifies whether AWS Network Security Manager automatically removes the resources it created when they are no longer needed. Default: false .

wafConfig -> (structure)

AWS WAF-specific policy settings. This is populated only for AWS WAF policies.

existingCustomerWebACLResolution -> (string) [required]

Determines how AWS Network Security Manager handles remediation when a resource already has a customer-created web ACL. Required for AWS WAF policies.

Possible values:

  • RETROFIT
  • OVERRIDE_ASSOCIATION
  • NO_REMEDIATION

conflictResolution -> (string) [required]

The conflict-resolution strategy for AWS WAF policies. Required for AWS WAF policies.

Possible values:

  • MERGE_WHERE_APPLICABLE

Shorthand Syntax:

remediationEnabled=boolean,resourcesCleanUp=boolean,wafConfig={existingCustomerWebACLResolution=string,conflictResolution=string}

JSON Syntax:

{
  "remediationEnabled": true|false,
  "resourcesCleanUp": true|false,
  "wafConfig": {
    "existingCustomerWebACLResolution": "RETROFIT"|"OVERRIDE_ASSOCIATION"|"NO_REMEDIATION",
    "conflictResolution": "MERGE_WHERE_APPLICABLE"
  }
}

--is-published | --no-is-published (boolean) [required]

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 ).

--client-token (string)

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.

Constraints:

  • min: 1
  • max: 64
  • pattern: [\x21-\x7E]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global OptionsÂķ

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

OutputÂķ

policyId -> (string)

The service-generated id of the policy.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]{1,64}

policyArn -> (string)

The Amazon Resource Name (ARN) of the policy.

Constraints:

  • min: 20
  • max: 1010
  • pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

policyName -> (string)

The name of the policy.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9][a-zA-Z0-9 _.:/=+\-@]*

policyDescription -> (string)

A description of the policy.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9 _.:/=+\-@]*

status -> (string)

The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

Possible values:

  • DRAFT
  • ACTIVE
  • DISABLED

priority -> (integer)

The priority of the resource. A lower number indicates a higher priority.

Constraints:

  • min: 1

associatedTemplateAndRuleList -> (list)

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.

Constraints:

  • min: 0
  • max: 100

(tagged union structure)

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 .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: templateArn, ruleArn.

templateArn -> (string)

The ARN of the associated template.

Constraints:

  • min: 20
  • max: 1010
  • pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

ruleArn -> (string)

The ARN of the associated rule.

Constraints:

  • min: 20
  • max: 1010
  • pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

version -> (string)

The version of the resource.

Constraints:

  • min: 1
  • max: 10
  • pattern: [1-9][0-9]*

updateToken -> (string)

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.

Constraints:

  • min: 36
  • max: 36
  • pattern: ([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})

isSnapshot -> (boolean)

Specifies whether the resource is a snapshot of a published version.

hasPublishedVersion -> (boolean)

Specifies whether a published version of the resource exists.

firewallType -> (string)

The firewall type associated with the resource.

Possible values:

  • WAF
  • SHIELD_ADVANCED

policyConfiguration -> (structure)

The configuration settings that control the policy’s behavior, including remediation and firewall-type-specific settings.

remediationEnabled -> (boolean) [required]

Specifies whether AWS Network Security Manager automatically remediates noncompliant resources. Default: false .

resourcesCleanUp -> (boolean) [required]

Specifies whether AWS Network Security Manager automatically removes the resources it created when they are no longer needed. Default: false .

wafConfig -> (structure)

AWS WAF-specific policy settings. This is populated only for AWS WAF policies.

existingCustomerWebACLResolution -> (string) [required]

Determines how AWS Network Security Manager handles remediation when a resource already has a customer-created web ACL. Required for AWS WAF policies.

Possible values:

  • RETROFIT
  • OVERRIDE_ASSOCIATION
  • NO_REMEDIATION

conflictResolution -> (string) [required]

The conflict-resolution strategy for AWS WAF policies. Required for AWS WAF policies.

Possible values:

  • MERGE_WHERE_APPLICABLE

updatedAt -> (timestamp)

The time when the resource was last updated.
© Copyright 2026, Amazon Web Services. Created using Sphinx.