get-automated-reasoning-policy-build-workflow-result-assets¶
Description¶
Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.
See also: AWS API Documentation
Synopsis¶
get-automated-reasoning-policy-build-workflow-result-assets
--policy-arn <value>
--build-workflow-id <value>
--asset-type <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 whose build workflow assets you want to retrieve.
--build-workflow-id (string)
The unique identifier of the build workflow whose result assets you want to retrieve.
--asset-type (string)
The type of asset to retrieve (e.g., BUILD_LOG, QUALITY_REPORT, POLICY_DEFINITION).
Possible values:
BUILD_LOGQUALITY_REPORTPOLICY_DEFINITION
--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 Automated Reasoning policy.
buildWorkflowId -> (string)
The unique identifier of the build workflow.
buildWorkflowAssets -> (tagged union structure)
The requested build workflow asset. This is a union type that returns only one of the available asset types (logs, reports, or generated artifacts) based on the specific asset type requested in the API call.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:policyDefinition,qualityReport,buildLog.policyDefinition -> (structure)
Contains the formal logic rules, variables, and custom variable types that define an Automated Reasoning policy. The policy definition specifies the constraints used to validate foundation model responses for accuracy and logical consistency.
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.qualityReport -> (structure)
A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.
typeCount -> (integer)
The total number of custom types defined in the policy.variableCount -> (integer)
The total number of variables defined in the policy.ruleCount -> (integer)
The total number of rules defined in the policy.unusedTypes -> (list)
A list of custom types that are defined but not referenced by any variables or rules, suggesting they may be unnecessary.
(string)
unusedTypeValues -> (list)
A list of type values that are defined but never used in any rules, indicating potential cleanup opportunities.
(structure)
Associates a type name with a specific value name, used for referencing type values in rules and other policy elements.
typeName -> (string)
The name of the custom type that contains the referenced value.valueName -> (string)
The name of the specific value within the type.unusedVariables -> (list)
A list of variables that are defined but not referenced by any rules, suggesting they may be unnecessary.
(string)
conflictingRules -> (list)
A list of rules that may conflict with each other, potentially leading to inconsistent policy behavior.
(string)
disjointRuleSets -> (list)
Groups of rules that operate on completely separate sets of variables, indicating the policy may be addressing multiple unrelated concerns.
(structure)
Represents a set of rules that operate on completely separate variables, indicating they address different concerns or domains within the policy.
variables -> (list)
The set of variables that are used by the rules in this disjoint set.
(string)
rules -> (list)
The list of rules that form this disjoint set, all operating on the same set of variables.
(string)
buildLog -> (structure)
The complete build log containing detailed information about each step in the policy generation process.
entries -> (list)
A list of log entries documenting each step in the policy build process, including timestamps, status, and detailed messages.
(structure)
Represents a single entry in the policy build log, containing information about a specific step or event in the build process.
annotation -> (tagged union structure)
The annotation or operation that was being processed when this log entry was created.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:addType,updateType,deleteType,addVariable,updateVariable,deleteVariable,addRule,updateRule,deleteRule,addRuleFromNaturalLanguage,updateFromRulesFeedback,updateFromScenarioFeedback,ingestContent.addType -> (structure)
An operation to add a new custom type to the policy, defining a set of possible values for policy variables.
name -> (string)
The name of the new custom type. This name will be used to reference the type in variable definitions and rules.description -> (string)
A description of what the custom type represents and how it should be used in the policy.values -> (list)
The list of possible values that variables of this type can take, each with its own description and identifier.
(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.updateType -> (structure)
An operation to modify an existing custom type in the policy, such as changing its name, description, or allowed values.
name -> (string)
The current name of the custom type to update.newName -> (string)
The new name for the custom type, if you want to rename it. If not provided, the name remains unchanged.description -> (string)
The new description for the custom type, replacing the previous description.values -> (list)
The updated list of values for the custom type, which can include additions, modifications, or removals.
(tagged union structure)
An annotation for managing values within custom types, including adding, updating, or removing specific type values.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:addTypeValue,updateTypeValue,deleteTypeValue.addTypeValue -> (structure)
An operation to add a new value to an existing custom type.
value -> (string)
The identifier or name of the new value to add to the type.description -> (string)
A description of what this new type value represents and when it should be used.updateTypeValue -> (structure)
An operation to modify an existing value within a custom type.
value -> (string)
The current identifier or name of the type value to update.newValue -> (string)
The new identifier or name for the type value, if you want to rename it.description -> (string)
The new description for the type value, replacing the previous description.deleteTypeValue -> (structure)
An operation to remove a value from an existing custom type.
value -> (string)
The identifier or name of the value to remove from the type.deleteType -> (structure)
An operation to remove a custom type from the policy. The type must not be referenced by any variables or rules.
name -> (string)
The name of the custom type to delete from the policy. The type must not be referenced by any variables or rules.addVariable -> (structure)
An operation to add a new variable to the policy, which can be used in rule expressions to represent dynamic values.
name -> (string)
The name of the new variable. This name will be used to reference the variable in rule expressions.type -> (string)
The type of the variable, which can be a built-in type (like string or number) or a custom type defined in the policy.description -> (string)
A description of what the variable represents and how it should be used in rules.updateVariable -> (structure)
An operation to modify an existing variable in the policy, such as changing its name, type, or description.
name -> (string)
The current name of the variable to update.newName -> (string)
The new name for the variable, if you want to rename it. If not provided, the name remains unchanged.description -> (string)
The new description for the variable, replacing the previous description.deleteVariable -> (structure)
An operation to remove a variable from the policy. The variable must not be referenced by any rules.
name -> (string)
The name of the variable to delete from the policy. The variable must not be referenced by any rules.addRule -> (structure)
An operation to add a new logical rule to the policy using formal mathematical expressions.
expression -> (string)
The formal logical expression that defines the rule, using mathematical notation and referencing policy variables and types.updateRule -> (structure)
An operation to modify an existing rule in the policy, such as changing its logical expression or conditions.
ruleId -> (string)
The unique identifier of the rule to update.expression -> (string)
The new formal logical expression for the rule, replacing the previous expression.deleteRule -> (structure)
An operation to remove a rule from the policy.
ruleId -> (string)
The unique identifier of the rule to delete from the policy.addRuleFromNaturalLanguage -> (structure)
An operation to add a new rule by converting natural language descriptions into formal logical expressions.
naturalLanguage -> (string)
The natural language description of the rule that should be converted into a formal logical expression.updateFromRulesFeedback -> (structure)
An operation to update the policy based on feedback about how specific rules performed during testing or validation.
ruleIds -> (list)
The list of rule identifiers that the feedback applies to.
(string)
feedback -> (string)
The feedback information about rule performance, including suggestions for improvements or corrections.updateFromScenarioFeedback -> (structure)
An operation to update the policy based on feedback about how it performed on specific test scenarios.
ruleIds -> (list)
The list of rule identifiers that were involved in the scenario being evaluated.
(string)
scenarioExpression -> (string)
The logical expression that defines the test scenario that generated this feedback.feedback -> (string)
The feedback information about scenario performance, including any issues or improvements identified.ingestContent -> (structure)
An operation to process and incorporate new content into the policy, extracting additional rules and concepts.
content -> (string)
The new content to be analyzed and incorporated into the policy, such as additional documents or rule descriptions.status -> (string)
The status of the build step (e.g., SUCCESS, FAILED, IN_PROGRESS).buildSteps -> (list)
Detailed information about the specific build steps that were executed, including any sub-operations or transformations.
(structure)
Represents a single step in the policy build process, containing context about what was being processed and any messages or results.
context -> (tagged union structure)
Contextual information about what was being processed during this build step, such as the type of operation or the source material being analyzed.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:planning,mutation.planning -> (structure)
Indicates that this build step was part of the planning phase, where the system determines what operations to perform.mutation -> (tagged union structure)
Indicates that this build step involved modifying the policy structure, such as adding or updating rules, variables, or types.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:addType,updateType,deleteType,addVariable,updateVariable,deleteVariable,addRule,updateRule,deleteRule.addType -> (structure)
A mutation to add a new custom type to the policy.
type -> (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.updateType -> (structure)
A mutation to modify an existing custom type in the policy.
type -> (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.deleteType -> (structure)
A mutation to remove a custom type from the policy.
name -> (string)
The name of the custom type to delete.addVariable -> (structure)
A mutation to add a new variable to the policy.
variable -> (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.updateVariable -> (structure)
A mutation to modify an existing variable in the policy.
variable -> (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.deleteVariable -> (structure)
A mutation to remove a variable from the policy.
name -> (string)
The name of the variable to delete.addRule -> (structure)
A mutation to add a new rule to the policy.
rule -> (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.updateRule -> (structure)
A mutation to modify an existing rule in the policy.
rule -> (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.deleteRule -> (structure)
A mutation to remove a rule from the policy.
id -> (string)
The unique identifier of the rule to delete.priorElement -> (tagged union structure)
Reference to the previous element or step in the build process, helping to trace the sequence of operations.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:policyDefinitionVariable,policyDefinitionType,policyDefinitionRule.policyDefinitionVariable -> (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.policyDefinitionType -> (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.policyDefinitionRule -> (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.messages -> (list)
A list of messages generated during this build step, including informational messages, warnings, and error details.
(structure)
Represents a message generated during a build step, providing information about what happened or any issues encountered.
message -> (string)
The content of the message, describing what occurred during the build step.messageType -> (string)
The type of message (e.g., INFO, WARNING, ERROR) indicating its severity and purpose.