Bedrock / Client / export_automated_reasoning_policy_version

export_automated_reasoning_policy_version

Bedrock.Client.export_automated_reasoning_policy_version(**kwargs)

Exports the policy definition for an Automated Reasoning policy version. Returns the complete policy definition including rules, variables, and custom variable types in a structured format.

See also: AWS API Documentation

Request Syntax

response = client.export_automated_reasoning_policy_version(
    policyArn='string'
)

Parameters:

policyArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the Automated Reasoning policy to export. Can be either the unversioned ARN for the draft policy or a versioned ARN for a specific policy version.

Return type:

dict

Returns:

Response Syntax

{
    'policyDefinition': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –

  • policyDefinition (dict) –

    The exported policy definition containing the formal logic rules, variables, and custom variable 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.

      • (dict) –

        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.

          • (dict) –

            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.

      • (dict) –

        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.

      • (dict) –

        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.

Exceptions

• Bedrock.Client.exceptions.ResourceNotFoundException

• Bedrock.Client.exceptions.AccessDeniedException

• Bedrock.Client.exceptions.ValidationException

• Bedrock.Client.exceptions.InternalServerException

• Bedrock.Client.exceptions.ThrottlingException