update-automated-reasoning-policy¶

Description¶

Updates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version.

Synopsis¶

  update-automated-reasoning-policy
--policy-arn <value>
--policy-definition <value>
[--name <value>]
[--description <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]

Options¶

--policy-arn (string)

The Amazon Resource Name (ARN) of the Automated Reasoning policy to update. This must be the ARN of a draft policy.

--policy-definition (structure)

The updated policy definition containing the formal logic rules, variables, and types.

version -> (string)

The version of the policy definition format.

types -> (list)

The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.

(structure)

Represents a custom user-defined viarble type in an Automated Reasoning policy. Types are enum-based and provide additional context beyond predefined variable types.

name -> (string)

The name of the custom type.

description -> (string)

The description of what the custom type represents.

values -> (list)

The possible values for this enum-based type, each with its own description.

(structure)

Represents a single value within a custom type definition, including its identifier and description.

value -> (string)

The actual value or identifier for this type value.

description -> (string)

A human-readable description explaining what this type value represents and when it should be used.

rules -> (list)

The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.

(structure)

Represents a formal logic rule in an Automated Reasoning policy. For example, rules can be expressed as if-then statements that define logical constraints.

id -> (string)

The unique identifier of the rule within the policy.

expression -> (string)

The formal logic expression of the rule.

alternateExpression -> (string)

The human-readable form of the rule expression, often in natural language or simplified notation.

variables -> (list)

The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.

(structure)

Represents a variable in an Automated Reasoning policy. Variables represent concepts that can have values assigned during natural language translation.

name -> (string)

The name of the variable. Use descriptive names that clearly indicate the concept being represented.

type -> (string)

The data type of the variable. Valid types include bool, int, real, enum, and custom types that you can provide.

description -> (string)

The description of the variable that explains what it represents and how users might refer to it. Clear and comprehensive descriptions are essential for accurate natural language translation.

JSON Syntax:

{
  "version": "string",
  "types": [
    {
      "name": "string",
      "description": "string",
      "values": [
        {
          "value": "string",
          "description": "string"
        }
        ...
      ]
    }
    ...
  ],
  "rules": [
    {
      "id": "string",
      "expression": "string",
      "alternateExpression": "string"
    }
    ...
  ],
  "variables": [
    {
      "name": "string",
      "type": "string",
      "description": "string"
    }
    ...
  ]
}

--name (string)

The updated name for the Automated Reasoning policy.

--description (string)

The updated description for the Automated Reasoning policy.

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

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

Output¶

policyArn -> (string)

The Amazon Resource Name (ARN) of the updated policy.

name -> (string)

The updated name of the policy.

definitionHash -> (string)

The hash of the updated policy definition.

updatedAt -> (timestamp)

The timestamp when the policy was last updated.

Table of Contents

Feedback

User Guide